hub.c 149.0 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * USB hub driver.
 *
 * (C) Copyright 1999 Linus Torvalds
 * (C) Copyright 1999 Johannes Erdfelt
 * (C) Copyright 1999 Gregory P. Smith
 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
 *
 */

#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/completion.h>
#include <linux/sched.h>
#include <linux/list.h>
#include <linux/slab.h>
#include <linux/ioctl.h>
#include <linux/usb.h>
#include <linux/usbdevice_fs.h>
22
#include <linux/usb/hcd.h>
23
#include <linux/usb/otg.h>
24
#include <linux/usb/quirks.h>
25
#include <linux/kthread.h>
26
#include <linux/mutex.h>
27
#include <linux/freezer.h>
28
#include <linux/random.h>
L
Linus Torvalds 已提交
29 30 31 32

#include <asm/uaccess.h>
#include <asm/byteorder.h>

33
#include "hub.h"
L
Linus Torvalds 已提交
34

35 36 37 38 39 40 41
/* if we are in debug mode, always announce new devices */
#ifdef DEBUG
#ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
#define CONFIG_USB_ANNOUNCE_NEW_DEVICES
#endif
#endif

42 43 44
#define USB_VENDOR_GENESYS_LOGIC		0x05e3
#define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND	0x01

J
John Youn 已提交
45 46
static inline int hub_is_superspeed(struct usb_device *hdev)
{
47
	return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
J
John Youn 已提交
48
}
49

50
/* Protect struct usb_device->state and ->children members
51
 * Note: Both are also protected by ->dev.sem, except that ->state can
L
Linus Torvalds 已提交
52 53 54 55 56 57 58 59 60 61
 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
static DEFINE_SPINLOCK(device_state_lock);

/* khubd's worklist and its lock */
static DEFINE_SPINLOCK(hub_event_lock);
static LIST_HEAD(hub_event_list);	/* List of hubs needing servicing */

/* Wakes up khubd */
static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);

62
static struct task_struct *khubd_task;
L
Linus Torvalds 已提交
63 64

/* cycle leds on hubs that aren't blinking for attention */
65
static bool blinkenlights = 0;
L
Linus Torvalds 已提交
66 67 68
module_param (blinkenlights, bool, S_IRUGO);
MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");

69 70 71 72 73 74 75
/*
 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
 * 10 seconds to send reply for the initial 64-byte descriptor request.
 */
/* define initial 64-byte descriptor request timeout in milliseconds */
static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
76 77 78
MODULE_PARM_DESC(initial_descriptor_timeout,
		"initial 64-byte descriptor request timeout in milliseconds "
		"(default 5000 - 5.0 seconds)");
79

L
Linus Torvalds 已提交
80 81 82 83 84 85 86 87 88 89 90 91 92 93
/*
 * As of 2.6.10 we introduce a new USB device initialization scheme which
 * closely resembles the way Windows works.  Hopefully it will be compatible
 * with a wider range of devices than the old scheme.  However some previously
 * working devices may start giving rise to "device not accepting address"
 * errors; if that happens the user can try the old scheme by adjusting the
 * following module parameters.
 *
 * For maximum flexibility there are two boolean parameters to control the
 * hub driver's behavior.  On the first initialization attempt, if the
 * "old_scheme_first" parameter is set then the old scheme will be used,
 * otherwise the new scheme is used.  If that fails and "use_both_schemes"
 * is set, then the driver will make another attempt, using the other scheme.
 */
94
static bool old_scheme_first = 0;
L
Linus Torvalds 已提交
95 96 97 98
module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(old_scheme_first,
		 "start with the old device initialization scheme");

99
static bool use_both_schemes = 1;
L
Linus Torvalds 已提交
100 101 102 103 104
module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(use_both_schemes,
		"try the other device initialization scheme if the "
		"first one fails");

105 106 107 108 109 110
/* Mutual exclusion for EHCI CF initialization.  This interferes with
 * port reset on some companion controllers.
 */
DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);

111 112 113 114
#define HUB_DEBOUNCE_TIMEOUT	1500
#define HUB_DEBOUNCE_STEP	  25
#define HUB_DEBOUNCE_STABLE	 100

115 116
static int usb_reset_and_verify_device(struct usb_device *udev);

117
static inline char *portspeed(struct usb_hub *hub, int portstatus)
L
Linus Torvalds 已提交
118
{
119 120
	if (hub_is_superspeed(hub->hdev))
		return "5.0 Gb/s";
121
	if (portstatus & USB_PORT_STAT_HIGH_SPEED)
L
Linus Torvalds 已提交
122
    		return "480 Mb/s";
123
	else if (portstatus & USB_PORT_STAT_LOW_SPEED)
L
Linus Torvalds 已提交
124 125 126 127 128 129
		return "1.5 Mb/s";
	else
		return "12 Mb/s";
}

/* Note that hdev or one of its children must be locked! */
130
static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
L
Linus Torvalds 已提交
131
{
132
	if (!hdev || !hdev->actconfig || !hdev->maxchild)
133
		return NULL;
L
Linus Torvalds 已提交
134 135 136
	return usb_get_intfdata(hdev->actconfig->interface[0]);
}

137 138 139 140 141 142 143 144 145 146 147 148
static int usb_device_supports_lpm(struct usb_device *udev)
{
	/* USB 2.1 (and greater) devices indicate LPM support through
	 * their USB 2.0 Extended Capabilities BOS descriptor.
	 */
	if (udev->speed == USB_SPEED_HIGH) {
		if (udev->bos->ext_cap &&
			(USB_LPM_SUPPORT &
			 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
			return 1;
		return 0;
	}
149 150 151 152 153 154 155 156 157 158 159 160 161 162

	/* All USB 3.0 must support LPM, but we need their max exit latency
	 * information from the SuperSpeed Extended Capabilities BOS descriptor.
	 */
	if (!udev->bos->ss_cap) {
		dev_warn(&udev->dev, "No LPM exit latency info found.  "
				"Power management will be impacted.\n");
		return 0;
	}
	if (udev->parent->lpm_capable)
		return 1;

	dev_warn(&udev->dev, "Parent hub missing LPM exit latency info.  "
			"Power management will be impacted.\n");
163 164 165
	return 0;
}

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
/*
 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
 * either U1 or U2.
 */
static void usb_set_lpm_mel(struct usb_device *udev,
		struct usb3_lpm_parameters *udev_lpm_params,
		unsigned int udev_exit_latency,
		struct usb_hub *hub,
		struct usb3_lpm_parameters *hub_lpm_params,
		unsigned int hub_exit_latency)
{
	unsigned int total_mel;
	unsigned int device_mel;
	unsigned int hub_mel;

	/*
	 * Calculate the time it takes to transition all links from the roothub
	 * to the parent hub into U0.  The parent hub must then decode the
	 * packet (hub header decode latency) to figure out which port it was
	 * bound for.
	 *
	 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
	 * means 0.1us).  Multiply that by 100 to get nanoseconds.
	 */
	total_mel = hub_lpm_params->mel +
		(hub->descriptor->u.ss.bHubHdrDecLat * 100);

	/*
	 * How long will it take to transition the downstream hub's port into
	 * U0?  The greater of either the hub exit latency or the device exit
	 * latency.
	 *
	 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
	 * Multiply that by 1000 to get nanoseconds.
	 */
	device_mel = udev_exit_latency * 1000;
	hub_mel = hub_exit_latency * 1000;
	if (device_mel > hub_mel)
		total_mel += device_mel;
	else
		total_mel += hub_mel;

	udev_lpm_params->mel = total_mel;
}

/*
 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
 * a transition from either U1 or U2.
 */
static void usb_set_lpm_pel(struct usb_device *udev,
		struct usb3_lpm_parameters *udev_lpm_params,
		unsigned int udev_exit_latency,
		struct usb_hub *hub,
		struct usb3_lpm_parameters *hub_lpm_params,
		unsigned int hub_exit_latency,
		unsigned int port_to_port_exit_latency)
{
	unsigned int first_link_pel;
	unsigned int hub_pel;

	/*
	 * First, the device sends an LFPS to transition the link between the
	 * device and the parent hub into U0.  The exit latency is the bigger of
	 * the device exit latency or the hub exit latency.
	 */
	if (udev_exit_latency > hub_exit_latency)
		first_link_pel = udev_exit_latency * 1000;
	else
		first_link_pel = hub_exit_latency * 1000;

	/*
	 * When the hub starts to receive the LFPS, there is a slight delay for
	 * it to figure out that one of the ports is sending an LFPS.  Then it
	 * will forward the LFPS to its upstream link.  The exit latency is the
	 * delay, plus the PEL that we calculated for this hub.
	 */
	hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;

	/*
	 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
	 * is the greater of the two exit latencies.
	 */
	if (first_link_pel > hub_pel)
		udev_lpm_params->pel = first_link_pel;
	else
		udev_lpm_params->pel = hub_pel;
}

/*
 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
 * when a device initiates a transition to U0, until when it will receive the
 * first packet from the host controller.
 *
 * Section C.1.5.1 describes the four components to this:
 *  - t1: device PEL
 *  - t2: time for the ERDY to make it from the device to the host.
 *  - t3: a host-specific delay to process the ERDY.
 *  - t4: time for the packet to make it from the host to the device.
 *
 * t3 is specific to both the xHCI host and the platform the host is integrated
 * into.  The Intel HW folks have said it's negligible, FIXME if a different
 * vendor says otherwise.
 */
static void usb_set_lpm_sel(struct usb_device *udev,
		struct usb3_lpm_parameters *udev_lpm_params)
{
	struct usb_device *parent;
	unsigned int num_hubs;
	unsigned int total_sel;

	/* t1 = device PEL */
	total_sel = udev_lpm_params->pel;
	/* How many external hubs are in between the device & the root port. */
	for (parent = udev->parent, num_hubs = 0; parent->parent;
			parent = parent->parent)
		num_hubs++;
	/* t2 = 2.1us + 250ns * (num_hubs - 1) */
	if (num_hubs > 0)
		total_sel += 2100 + 250 * (num_hubs - 1);

	/* t4 = 250ns * num_hubs */
	total_sel += 250 * num_hubs;

	udev_lpm_params->sel = total_sel;
}

static void usb_set_lpm_parameters(struct usb_device *udev)
{
	struct usb_hub *hub;
	unsigned int port_to_port_delay;
	unsigned int udev_u1_del;
	unsigned int udev_u2_del;
	unsigned int hub_u1_del;
	unsigned int hub_u2_del;

	if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
		return;

	hub = hdev_to_hub(udev->parent);
	/* It doesn't take time to transition the roothub into U0, since it
	 * doesn't have an upstream link.
	 */
	if (!hub)
		return;

	udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
	udev_u2_del = udev->bos->ss_cap->bU2DevExitLat;
	hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
	hub_u2_del = udev->parent->bos->ss_cap->bU2DevExitLat;

	usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
			hub, &udev->parent->u1_params, hub_u1_del);

	usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
			hub, &udev->parent->u2_params, hub_u2_del);

	/*
	 * Appendix C, section C.2.2.2, says that there is a slight delay from
	 * when the parent hub notices the downstream port is trying to
	 * transition to U0 to when the hub initiates a U0 transition on its
	 * upstream port.  The section says the delays are tPort2PortU1EL and
	 * tPort2PortU2EL, but it doesn't define what they are.
	 *
	 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
	 * about the same delays.  Use the maximum delay calculations from those
	 * sections.  For U1, it's tHubPort2PortExitLat, which is 1us max.  For
	 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat.  I
	 * assume the device exit latencies they are talking about are the hub
	 * exit latencies.
	 *
	 * What do we do if the U2 exit latency is less than the U1 exit
	 * latency?  It's possible, although not likely...
	 */
	port_to_port_delay = 1;

	usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
			hub, &udev->parent->u1_params, hub_u1_del,
			port_to_port_delay);

	if (hub_u2_del > hub_u1_del)
		port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
	else
		port_to_port_delay = 1 + hub_u1_del;

	usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
			hub, &udev->parent->u2_params, hub_u2_del,
			port_to_port_delay);

	/* Now that we've got PEL, calculate SEL. */
	usb_set_lpm_sel(udev, &udev->u1_params);
	usb_set_lpm_sel(udev, &udev->u2_params);
}

L
Linus Torvalds 已提交
359
/* USB 2.0 spec Section 11.24.4.5 */
J
John Youn 已提交
360
static int get_hub_descriptor(struct usb_device *hdev, void *data)
L
Linus Torvalds 已提交
361
{
J
John Youn 已提交
362 363 364 365 366 367 368 369 370 371
	int i, ret, size;
	unsigned dtype;

	if (hub_is_superspeed(hdev)) {
		dtype = USB_DT_SS_HUB;
		size = USB_DT_SS_HUB_SIZE;
	} else {
		dtype = USB_DT_HUB;
		size = sizeof(struct usb_hub_descriptor);
	}
L
Linus Torvalds 已提交
372 373 374 375

	for (i = 0; i < 3; i++) {
		ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
			USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
J
John Youn 已提交
376
			dtype << 8, 0, data, size,
L
Linus Torvalds 已提交
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
			USB_CTRL_GET_TIMEOUT);
		if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
			return ret;
	}
	return -EINVAL;
}

/*
 * USB 2.0 spec Section 11.24.2.1
 */
static int clear_hub_feature(struct usb_device *hdev, int feature)
{
	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
		USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
}

/*
 * USB 2.0 spec Section 11.24.2.2
 */
static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
{
	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
		USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
		NULL, 0, 1000);
}

/*
 * USB 2.0 spec Section 11.24.2.13
 */
static int set_port_feature(struct usb_device *hdev, int port1, int feature)
{
	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
		USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
		NULL, 0, 1000);
}

/*
 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
 * for info about using port indicators
 */
static void set_port_led(
	struct usb_hub *hub,
	int port1,
	int selector
)
{
	int status = set_port_feature(hub->hdev, (selector << 8) | port1,
			USB_PORT_FEAT_INDICATOR);
	if (status < 0)
		dev_dbg (hub->intfdev,
			"port %d indicator %s status %d\n",
			port1,
			({ char *s; switch (selector) {
			case HUB_LED_AMBER: s = "amber"; break;
			case HUB_LED_GREEN: s = "green"; break;
			case HUB_LED_OFF: s = "off"; break;
			case HUB_LED_AUTO: s = "auto"; break;
			default: s = "??"; break;
			}; s; }),
			status);
}

#define	LED_CYCLE_PERIOD	((2*HZ)/3)

D
David Howells 已提交
441
static void led_work (struct work_struct *work)
L
Linus Torvalds 已提交
442
{
D
David Howells 已提交
443 444
	struct usb_hub		*hub =
		container_of(work, struct usb_hub, leds.work);
L
Linus Torvalds 已提交
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
	struct usb_device	*hdev = hub->hdev;
	unsigned		i;
	unsigned		changed = 0;
	int			cursor = -1;

	if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
		return;

	for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
		unsigned	selector, mode;

		/* 30%-50% duty cycle */

		switch (hub->indicator[i]) {
		/* cycle marker */
		case INDICATOR_CYCLE:
			cursor = i;
			selector = HUB_LED_AUTO;
			mode = INDICATOR_AUTO;
			break;
		/* blinking green = sw attention */
		case INDICATOR_GREEN_BLINK:
			selector = HUB_LED_GREEN;
			mode = INDICATOR_GREEN_BLINK_OFF;
			break;
		case INDICATOR_GREEN_BLINK_OFF:
			selector = HUB_LED_OFF;
			mode = INDICATOR_GREEN_BLINK;
			break;
		/* blinking amber = hw attention */
		case INDICATOR_AMBER_BLINK:
			selector = HUB_LED_AMBER;
			mode = INDICATOR_AMBER_BLINK_OFF;
			break;
		case INDICATOR_AMBER_BLINK_OFF:
			selector = HUB_LED_OFF;
			mode = INDICATOR_AMBER_BLINK;
			break;
		/* blink green/amber = reserved */
		case INDICATOR_ALT_BLINK:
			selector = HUB_LED_GREEN;
			mode = INDICATOR_ALT_BLINK_OFF;
			break;
		case INDICATOR_ALT_BLINK_OFF:
			selector = HUB_LED_AMBER;
			mode = INDICATOR_ALT_BLINK;
			break;
		default:
			continue;
		}
		if (selector != HUB_LED_AUTO)
			changed = 1;
		set_port_led(hub, i + 1, selector);
		hub->indicator[i] = mode;
	}
	if (!changed && blinkenlights) {
		cursor++;
		cursor %= hub->descriptor->bNbrPorts;
		set_port_led(hub, cursor + 1, HUB_LED_GREEN);
		hub->indicator[cursor] = INDICATOR_CYCLE;
		changed++;
	}
	if (changed)
		schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
}

/* use a short timeout for hub/port status fetches */
#define	USB_STS_TIMEOUT		1000
#define	USB_STS_RETRIES		5

/*
 * USB 2.0 spec Section 11.24.2.6
 */
static int get_hub_status(struct usb_device *hdev,
		struct usb_hub_status *data)
{
	int i, status = -ETIMEDOUT;

523 524
	for (i = 0; i < USB_STS_RETRIES &&
			(status == -ETIMEDOUT || status == -EPIPE); i++) {
L
Linus Torvalds 已提交
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
		status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
			data, sizeof(*data), USB_STS_TIMEOUT);
	}
	return status;
}

/*
 * USB 2.0 spec Section 11.24.2.7
 */
static int get_port_status(struct usb_device *hdev, int port1,
		struct usb_port_status *data)
{
	int i, status = -ETIMEDOUT;

540 541
	for (i = 0; i < USB_STS_RETRIES &&
			(status == -ETIMEDOUT || status == -EPIPE); i++) {
L
Linus Torvalds 已提交
542 543 544 545 546 547 548
		status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
			data, sizeof(*data), USB_STS_TIMEOUT);
	}
	return status;
}

A
Alan Stern 已提交
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
static int hub_port_status(struct usb_hub *hub, int port1,
		u16 *status, u16 *change)
{
	int ret;

	mutex_lock(&hub->status_mutex);
	ret = get_port_status(hub->hdev, port1, &hub->status->port);
	if (ret < 4) {
		dev_err(hub->intfdev,
			"%s failed (err = %d)\n", __func__, ret);
		if (ret >= 0)
			ret = -EIO;
	} else {
		*status = le16_to_cpu(hub->status->port.wPortStatus);
		*change = le16_to_cpu(hub->status->port.wPortChange);
J
John Youn 已提交
564

A
Alan Stern 已提交
565 566 567 568 569 570
		ret = 0;
	}
	mutex_unlock(&hub->status_mutex);
	return ret;
}

L
Linus Torvalds 已提交
571 572 573 574 575
static void kick_khubd(struct usb_hub *hub)
{
	unsigned long	flags;

	spin_lock_irqsave(&hub_event_lock, flags);
576
	if (!hub->disconnected && list_empty(&hub->event_list)) {
L
Linus Torvalds 已提交
577
		list_add_tail(&hub->event_list, &hub_event_list);
578 579 580 581

		/* Suppress autosuspend until khubd runs */
		usb_autopm_get_interface_no_resume(
				to_usb_interface(hub->intfdev));
L
Linus Torvalds 已提交
582 583 584 585 586 587 588
		wake_up(&khubd_wait);
	}
	spin_unlock_irqrestore(&hub_event_lock, flags);
}

void usb_kick_khubd(struct usb_device *hdev)
{
589 590 591 592
	struct usb_hub *hub = hdev_to_hub(hdev);

	if (hub)
		kick_khubd(hub);
L
Linus Torvalds 已提交
593 594
}

595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
/*
 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
 * Notification, which indicates it had initiated remote wakeup.
 *
 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
 * device initiates resume, so the USB core will not receive notice of the
 * resume through the normal hub interrupt URB.
 */
void usb_wakeup_notification(struct usb_device *hdev,
		unsigned int portnum)
{
	struct usb_hub *hub;

	if (!hdev)
		return;

	hub = hdev_to_hub(hdev);
	if (hub) {
		set_bit(portnum, hub->wakeup_bits);
		kick_khubd(hub);
	}
}
EXPORT_SYMBOL_GPL(usb_wakeup_notification);
L
Linus Torvalds 已提交
618 619

/* completion function, fires on port status changes and various faults */
620
static void hub_irq(struct urb *urb)
L
Linus Torvalds 已提交
621
{
622
	struct usb_hub *hub = urb->context;
623
	int status = urb->status;
624
	unsigned i;
L
Linus Torvalds 已提交
625 626
	unsigned long bits;

627
	switch (status) {
L
Linus Torvalds 已提交
628 629 630 631 632 633 634
	case -ENOENT:		/* synchronous unlink */
	case -ECONNRESET:	/* async unlink */
	case -ESHUTDOWN:	/* hardware going away */
		return;

	default:		/* presumably an error */
		/* Cause a hub reset after 10 consecutive errors */
635
		dev_dbg (hub->intfdev, "transfer --> %d\n", status);
L
Linus Torvalds 已提交
636 637
		if ((++hub->nerrors < 10) || hub->error)
			goto resubmit;
638
		hub->error = status;
L
Linus Torvalds 已提交
639
		/* FALL THROUGH */
640

L
Linus Torvalds 已提交
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
	/* let khubd handle things */
	case 0:			/* we got data:  port status changed */
		bits = 0;
		for (i = 0; i < urb->actual_length; ++i)
			bits |= ((unsigned long) ((*hub->buffer)[i]))
					<< (i*8);
		hub->event_bits[0] = bits;
		break;
	}

	hub->nerrors = 0;

	/* Something happened, let khubd figure it out */
	kick_khubd(hub);

resubmit:
	if (hub->quiescing)
		return;

	if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
			&& status != -ENODEV && status != -EPERM)
		dev_err (hub->intfdev, "resubmit --> %d\n", status);
}

/* USB 2.0 spec Section 11.24.2.3 */
static inline int
hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
{
669
	return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
L
Linus Torvalds 已提交
670 671 672 673 674 675 676 677 678 679
			       HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
			       tt, NULL, 0, 1000);
}

/*
 * enumeration blocks khubd for a long time. we use keventd instead, since
 * long blocking there is the exception, not the rule.  accordingly, HCDs
 * talking to TTs must queue control transfers (not just bulk and iso), so
 * both can talk to the same hub concurrently.
 */
680
static void hub_tt_work(struct work_struct *work)
L
Linus Torvalds 已提交
681
{
D
David Howells 已提交
682
	struct usb_hub		*hub =
683
		container_of(work, struct usb_hub, tt.clear_work);
L
Linus Torvalds 已提交
684 685 686
	unsigned long		flags;

	spin_lock_irqsave (&hub->tt.lock, flags);
687
	while (!list_empty(&hub->tt.clear_list)) {
688
		struct list_head	*next;
L
Linus Torvalds 已提交
689 690
		struct usb_tt_clear	*clear;
		struct usb_device	*hdev = hub->hdev;
691
		const struct hc_driver	*drv;
L
Linus Torvalds 已提交
692 693
		int			status;

694 695
		next = hub->tt.clear_list.next;
		clear = list_entry (next, struct usb_tt_clear, clear_list);
L
Linus Torvalds 已提交
696 697 698 699 700 701 702 703 704
		list_del (&clear->clear_list);

		/* drop lock so HCD can concurrently report other TT errors */
		spin_unlock_irqrestore (&hub->tt.lock, flags);
		status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
		if (status)
			dev_err (&hdev->dev,
				"clear tt %d (%04x) error %d\n",
				clear->tt, clear->devinfo, status);
705 706 707 708 709 710

		/* Tell the HCD, even if the operation failed */
		drv = clear->hcd->driver;
		if (drv->clear_tt_buffer_complete)
			(drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);

711
		kfree(clear);
712
		spin_lock_irqsave(&hub->tt.lock, flags);
L
Linus Torvalds 已提交
713 714 715 716 717
	}
	spin_unlock_irqrestore (&hub->tt.lock, flags);
}

/**
718 719
 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
 * @urb: an URB associated with the failed or incomplete split transaction
L
Linus Torvalds 已提交
720 721 722 723 724 725 726 727 728
 *
 * High speed HCDs use this to tell the hub driver that some split control or
 * bulk transaction failed in a way that requires clearing internal state of
 * a transaction translator.  This is normally detected (and reported) from
 * interrupt context.
 *
 * It may not be possible for that hub to handle additional full (or low)
 * speed transactions until that state is fully cleared out.
 */
729
int usb_hub_clear_tt_buffer(struct urb *urb)
L
Linus Torvalds 已提交
730
{
731 732
	struct usb_device	*udev = urb->dev;
	int			pipe = urb->pipe;
L
Linus Torvalds 已提交
733 734 735 736 737 738 739 740
	struct usb_tt		*tt = udev->tt;
	unsigned long		flags;
	struct usb_tt_clear	*clear;

	/* we've got to cope with an arbitrary number of pending TT clears,
	 * since each TT has "at least two" buffers that can need it (and
	 * there can be many TTs per hub).  even if they're uncommon.
	 */
741
	if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
L
Linus Torvalds 已提交
742 743
		dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
		/* FIXME recover somehow ... RESET_TT? */
744
		return -ENOMEM;
L
Linus Torvalds 已提交
745 746 747 748 749 750 751 752 753 754 755
	}

	/* info that CLEAR_TT_BUFFER needs */
	clear->tt = tt->multi ? udev->ttport : 1;
	clear->devinfo = usb_pipeendpoint (pipe);
	clear->devinfo |= udev->devnum << 4;
	clear->devinfo |= usb_pipecontrol (pipe)
			? (USB_ENDPOINT_XFER_CONTROL << 11)
			: (USB_ENDPOINT_XFER_BULK << 11);
	if (usb_pipein (pipe))
		clear->devinfo |= 1 << 15;
756 757 758 759 760

	/* info for completion callback */
	clear->hcd = bus_to_hcd(udev->bus);
	clear->ep = urb->ep;

L
Linus Torvalds 已提交
761 762 763
	/* tell keventd to clear state for this TT */
	spin_lock_irqsave (&tt->lock, flags);
	list_add_tail (&clear->clear_list, &tt->clear_list);
764
	schedule_work(&tt->clear_work);
L
Linus Torvalds 已提交
765
	spin_unlock_irqrestore (&tt->lock, flags);
766
	return 0;
L
Linus Torvalds 已提交
767
}
768
EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
L
Linus Torvalds 已提交
769

770 771 772 773
/* If do_delay is false, return the number of milliseconds the caller
 * needs to delay.
 */
static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
L
Linus Torvalds 已提交
774 775
{
	int port1;
776
	unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
777
	unsigned delay;
778 779 780 781 782 783 784 785 786 787
	u16 wHubCharacteristics =
			le16_to_cpu(hub->descriptor->wHubCharacteristics);

	/* Enable power on each port.  Some hubs have reserved values
	 * of LPSM (> 2) in their descriptors, even though they are
	 * USB 2.0 hubs.  Some hubs do not implement port-power switching
	 * but only emulate it.  In all cases, the ports won't work
	 * unless we send these messages to the hub.
	 */
	if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
L
Linus Torvalds 已提交
788
		dev_dbg(hub->intfdev, "enabling power on all ports\n");
789 790 791 792
	else
		dev_dbg(hub->intfdev, "trying to enable port power on "
				"non-switchable hub\n");
	for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
793
		set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
L
Linus Torvalds 已提交
794

795
	/* Wait at least 100 msec for power to become stable */
796 797 798 799
	delay = max(pgood_delay, (unsigned) 100);
	if (do_delay)
		msleep(delay);
	return delay;
L
Linus Torvalds 已提交
800 801 802 803 804 805 806
}

static int hub_hub_status(struct usb_hub *hub,
		u16 *status, u16 *change)
{
	int ret;

807
	mutex_lock(&hub->status_mutex);
L
Linus Torvalds 已提交
808 809 810
	ret = get_hub_status(hub->hdev, &hub->status->hub);
	if (ret < 0)
		dev_err (hub->intfdev,
811
			"%s failed (err = %d)\n", __func__, ret);
L
Linus Torvalds 已提交
812 813 814 815 816
	else {
		*status = le16_to_cpu(hub->status->hub.wHubStatus);
		*change = le16_to_cpu(hub->status->hub.wHubChange); 
		ret = 0;
	}
817
	mutex_unlock(&hub->status_mutex);
L
Linus Torvalds 已提交
818 819 820
	return ret;
}

821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
static int hub_set_port_link_state(struct usb_hub *hub, int port1,
			unsigned int link_status)
{
	return set_port_feature(hub->hdev,
			port1 | (link_status << 3),
			USB_PORT_FEAT_LINK_STATE);
}

/*
 * If USB 3.0 ports are placed into the Disabled state, they will no longer
 * detect any device connects or disconnects.  This is generally not what the
 * USB core wants, since it expects a disabled port to produce a port status
 * change event when a new device connects.
 *
 * Instead, set the link state to Disabled, wait for the link to settle into
 * that state, clear any change bits, and then put the port into the RxDetect
 * state.
 */
static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
{
	int ret;
	int total_time;
	u16 portchange, portstatus;

	if (!hub_is_superspeed(hub->hdev))
		return -EINVAL;

	ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
	if (ret) {
		dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
				port1, ret);
		return ret;
	}

	/* Wait for the link to enter the disabled state. */
	for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
		ret = hub_port_status(hub, port1, &portstatus, &portchange);
		if (ret < 0)
			return ret;

		if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
				USB_SS_PORT_LS_SS_DISABLED)
			break;
		if (total_time >= HUB_DEBOUNCE_TIMEOUT)
			break;
		msleep(HUB_DEBOUNCE_STEP);
	}
	if (total_time >= HUB_DEBOUNCE_TIMEOUT)
		dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
				port1, total_time);

	return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
}

875 876 877
static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
{
	struct usb_device *hdev = hub->hdev;
A
Alan Stern 已提交
878
	int ret = 0;
879

880 881
	if (hub->ports[port1 - 1]->child && set_state)
		usb_set_device_state(hub->ports[port1 - 1]->child,
882
				USB_STATE_NOTATTACHED);
883 884 885 886 887 888 889
	if (!hub->error) {
		if (hub_is_superspeed(hub->hdev))
			ret = hub_usb3_port_disable(hub, port1);
		else
			ret = clear_port_feature(hdev, port1,
					USB_PORT_FEAT_ENABLE);
	}
890 891
	if (ret)
		dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
A
Alan Stern 已提交
892
				port1, ret);
893 894 895
	return ret;
}

A
Alan Stern 已提交
896
/*
897
 * Disable a port and mark a logical connect-change event, so that some
A
Alan Stern 已提交
898 899 900 901 902 903 904
 * time later khubd will disconnect() any existing usb_device on the port
 * and will re-enumerate if there actually is a device attached.
 */
static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
{
	dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
	hub_port_disable(hub, port1, 1);
905

A
Alan Stern 已提交
906 907 908 909 910 911 912 913 914 915 916 917 918
	/* FIXME let caller ask to power down the port:
	 *  - some devices won't enumerate without a VBUS power cycle
	 *  - SRP saves power that way
	 *  - ... new call, TBD ...
	 * That's easy if this hub can switch power per-port, and
	 * khubd reactivates the port later (timer, SRP, etc).
	 * Powerdown must be optional, because of reset/DFU.
	 */

	set_bit(port1, hub->change_bits);
 	kick_khubd(hub);
}

919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
/**
 * usb_remove_device - disable a device's port on its parent hub
 * @udev: device to be disabled and removed
 * Context: @udev locked, must be able to sleep.
 *
 * After @udev's port has been disabled, khubd is notified and it will
 * see that the device has been disconnected.  When the device is
 * physically unplugged and something is plugged in, the events will
 * be received and processed normally.
 */
int usb_remove_device(struct usb_device *udev)
{
	struct usb_hub *hub;
	struct usb_interface *intf;

	if (!udev->parent)	/* Can't remove a root hub */
		return -EINVAL;
	hub = hdev_to_hub(udev->parent);
	intf = to_usb_interface(hub->intfdev);

	usb_autopm_get_interface(intf);
	set_bit(udev->portnum, hub->removed_bits);
	hub_port_logical_disconnect(hub, udev->portnum);
	usb_autopm_put_interface(intf);
	return 0;
}

A
Alan Stern 已提交
946
enum hub_activation_type {
947
	HUB_INIT, HUB_INIT2, HUB_INIT3,		/* INITs must come first */
948
	HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
A
Alan Stern 已提交
949
};
950

951 952 953
static void hub_init_func2(struct work_struct *ws);
static void hub_init_func3(struct work_struct *ws);

954
static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
955 956
{
	struct usb_device *hdev = hub->hdev;
957 958
	struct usb_hcd *hcd;
	int ret;
959
	int port1;
960
	int status;
961
	bool need_debounce_delay = false;
962 963 964 965 966 967 968
	unsigned delay;

	/* Continue a partial initialization */
	if (type == HUB_INIT2)
		goto init2;
	if (type == HUB_INIT3)
		goto init3;
969

970 971 972 973 974 975 976 977
	/* The superspeed hub except for root hub has to use Hub Depth
	 * value as an offset into the route string to locate the bits
	 * it uses to determine the downstream port number. So hub driver
	 * should send a set hub depth request to superspeed hub after
	 * the superspeed hub is set configuration in initialization or
	 * reset procedure.
	 *
	 * After a resume, port power should still be on.
978 979
	 * For any other type of activation, turn it on.
	 */
980
	if (type != HUB_RESUME) {
981 982 983 984 985 986 987 988 989
		if (hdev->parent && hub_is_superspeed(hdev)) {
			ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
					HUB_SET_DEPTH, USB_RT_HUB,
					hdev->level - 1, 0, NULL, 0,
					USB_CTRL_SET_TIMEOUT);
			if (ret < 0)
				dev_err(hub->intfdev,
						"set hub depth failed\n");
		}
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007

		/* Speed up system boot by using a delayed_work for the
		 * hub's initial power-up delays.  This is pretty awkward
		 * and the implementation looks like a home-brewed sort of
		 * setjmp/longjmp, but it saves at least 100 ms for each
		 * root hub (assuming usbcore is compiled into the kernel
		 * rather than as a module).  It adds up.
		 *
		 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
		 * because for those activation types the ports have to be
		 * operational when we return.  In theory this could be done
		 * for HUB_POST_RESET, but it's easier not to.
		 */
		if (type == HUB_INIT) {
			delay = hub_power_on(hub, false);
			PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
			schedule_delayed_work(&hub->init_work,
					msecs_to_jiffies(delay));
1008 1009

			/* Suppress autosuspend until init is done */
1010 1011
			usb_autopm_get_interface_no_resume(
					to_usb_interface(hub->intfdev));
1012
			return;		/* Continues at init2: below */
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
		} else if (type == HUB_RESET_RESUME) {
			/* The internal host controller state for the hub device
			 * may be gone after a host power loss on system resume.
			 * Update the device's info so the HW knows it's a hub.
			 */
			hcd = bus_to_hcd(hdev->bus);
			if (hcd->driver->update_hub_device) {
				ret = hcd->driver->update_hub_device(hcd, hdev,
						&hub->tt, GFP_NOIO);
				if (ret < 0) {
					dev_err(hub->intfdev, "Host not "
							"accepting hub info "
							"update.\n");
					dev_err(hub->intfdev, "LS/FS devices "
							"and hubs may not work "
							"under this hub\n.");
				}
			}
			hub_power_on(hub, true);
1032 1033 1034 1035 1036
		} else {
			hub_power_on(hub, true);
		}
	}
 init2:
1037

A
Alan Stern 已提交
1038 1039
	/* Check each port and set hub->change_bits to let khubd know
	 * which ports need attention.
1040 1041
	 */
	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1042
		struct usb_device *udev = hub->ports[port1 - 1]->child;
1043 1044
		u16 portstatus, portchange;

A
Alan Stern 已提交
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
		portstatus = portchange = 0;
		status = hub_port_status(hub, port1, &portstatus, &portchange);
		if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
			dev_dbg(hub->intfdev,
					"port %d: status %04x change %04x\n",
					port1, portstatus, portchange);

		/* After anything other than HUB_RESUME (i.e., initialization
		 * or any sort of reset), every port should be disabled.
		 * Unconnected ports should likewise be disabled (paranoia),
		 * and so should ports for which we have no usb_device.
		 */
		if ((portstatus & USB_PORT_STAT_ENABLE) && (
				type != HUB_RESUME ||
				!(portstatus & USB_PORT_STAT_CONNECTION) ||
				!udev ||
				udev->state == USB_STATE_NOTATTACHED)) {
1062 1063 1064 1065 1066
			/*
			 * USB3 protocol ports will automatically transition
			 * to Enabled state when detect an USB3.0 device attach.
			 * Do not disable USB3 protocol ports.
			 */
1067
			if (!hub_is_superspeed(hdev)) {
1068 1069 1070
				clear_port_feature(hdev, port1,
						   USB_PORT_FEAT_ENABLE);
				portstatus &= ~USB_PORT_STAT_ENABLE;
1071 1072 1073
			} else {
				/* Pretend that power was lost for USB3 devs */
				portstatus &= ~USB_PORT_STAT_ENABLE;
1074
			}
1075 1076
		}

1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
		/* Clear status-change flags; we'll debounce later */
		if (portchange & USB_PORT_STAT_C_CONNECTION) {
			need_debounce_delay = true;
			clear_port_feature(hub->hdev, port1,
					USB_PORT_FEAT_C_CONNECTION);
		}
		if (portchange & USB_PORT_STAT_C_ENABLE) {
			need_debounce_delay = true;
			clear_port_feature(hub->hdev, port1,
					USB_PORT_FEAT_C_ENABLE);
		}
1088 1089 1090 1091 1092 1093
		if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
				hub_is_superspeed(hub->hdev)) {
			need_debounce_delay = true;
			clear_port_feature(hub->hdev, port1,
					USB_PORT_FEAT_C_BH_PORT_RESET);
		}
1094 1095 1096 1097 1098 1099 1100
		/* We can forget about a "removed" device when there's a
		 * physical disconnect or the connect status changes.
		 */
		if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
				(portchange & USB_PORT_STAT_C_CONNECTION))
			clear_bit(port1, hub->removed_bits);

A
Alan Stern 已提交
1101 1102 1103 1104 1105 1106 1107 1108
		if (!udev || udev->state == USB_STATE_NOTATTACHED) {
			/* Tell khubd to disconnect the device or
			 * check for a new connection
			 */
			if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
				set_bit(port1, hub->change_bits);

		} else if (portstatus & USB_PORT_STAT_ENABLE) {
1109 1110 1111
			bool port_resumed = (portstatus &
					USB_PORT_STAT_LINK_STATE) ==
				USB_SS_PORT_LS_U0;
A
Alan Stern 已提交
1112 1113 1114
			/* The power session apparently survived the resume.
			 * If there was an overcurrent or suspend change
			 * (i.e., remote wakeup request), have khubd
1115 1116 1117 1118
			 * take care of it.  Look at the port link state
			 * for USB 3.0 hubs, since they don't have a suspend
			 * change bit, and they don't set the port link change
			 * bit on device-initiated resume.
A
Alan Stern 已提交
1119
			 */
1120 1121
			if (portchange || (hub_is_superspeed(hub->hdev) &&
						port_resumed))
A
Alan Stern 已提交
1122
				set_bit(port1, hub->change_bits);
1123

A
Alan Stern 已提交
1124 1125
		} else if (udev->persist_enabled) {
#ifdef CONFIG_PM
1126
			udev->reset_resume = 1;
A
Alan Stern 已提交
1127
#endif
1128 1129
			set_bit(port1, hub->change_bits);

A
Alan Stern 已提交
1130 1131 1132 1133
		} else {
			/* The power session is gone; tell khubd */
			usb_set_device_state(udev, USB_STATE_NOTATTACHED);
			set_bit(port1, hub->change_bits);
1134 1135 1136
		}
	}

1137 1138 1139 1140 1141 1142 1143 1144
	/* If no port-status-change flags were set, we don't need any
	 * debouncing.  If flags were set we can try to debounce the
	 * ports all at once right now, instead of letting khubd do them
	 * one at a time later on.
	 *
	 * If any port-status changes do occur during this delay, khubd
	 * will see them later and handle them normally.
	 */
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
	if (need_debounce_delay) {
		delay = HUB_DEBOUNCE_STABLE;

		/* Don't do a long sleep inside a workqueue routine */
		if (type == HUB_INIT2) {
			PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
			schedule_delayed_work(&hub->init_work,
					msecs_to_jiffies(delay));
			return;		/* Continues at init3: below */
		} else {
			msleep(delay);
		}
	}
 init3:
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
	hub->quiescing = 0;

	status = usb_submit_urb(hub->urb, GFP_NOIO);
	if (status < 0)
		dev_err(hub->intfdev, "activate --> %d\n", status);
	if (hub->has_indicators && blinkenlights)
		schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);

	/* Scan all ports that need attention */
	kick_khubd(hub);
1169 1170 1171 1172

	/* Allow autosuspend if it was suppressed */
	if (type <= HUB_INIT3)
		usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1173 1174
}

1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
/* Implement the continuations for the delays above */
static void hub_init_func2(struct work_struct *ws)
{
	struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);

	hub_activate(hub, HUB_INIT2);
}

static void hub_init_func3(struct work_struct *ws)
{
	struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);

	hub_activate(hub, HUB_INIT3);
}

1190 1191 1192 1193 1194 1195 1196 1197 1198
enum hub_quiescing_type {
	HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
};

static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
{
	struct usb_device *hdev = hub->hdev;
	int i;

1199 1200
	cancel_delayed_work_sync(&hub->init_work);

1201 1202 1203 1204 1205 1206
	/* khubd and related activity won't re-trigger */
	hub->quiescing = 1;

	if (type != HUB_SUSPEND) {
		/* Disconnect all the children */
		for (i = 0; i < hdev->maxchild; ++i) {
1207 1208
			if (hub->ports[i]->child)
				usb_disconnect(&hub->ports[i]->child);
1209 1210 1211 1212 1213 1214 1215 1216
		}
	}

	/* Stop khubd and related activity */
	usb_kill_urb(hub->urb);
	if (hub->has_indicators)
		cancel_delayed_work_sync(&hub->leds);
	if (hub->tt.hub)
1217
		flush_work(&hub->tt.clear_work);
1218 1219
}

A
Alan Stern 已提交
1220 1221 1222 1223 1224
/* caller has locked the hub device */
static int hub_pre_reset(struct usb_interface *intf)
{
	struct usb_hub *hub = usb_get_intfdata(intf);

1225
	hub_quiesce(hub, HUB_PRE_RESET);
A
Alan Stern 已提交
1226
	return 0;
1227 1228 1229
}

/* caller has locked the hub device */
A
Alan Stern 已提交
1230
static int hub_post_reset(struct usb_interface *intf)
1231
{
1232 1233
	struct usb_hub *hub = usb_get_intfdata(intf);

1234
	hub_activate(hub, HUB_POST_RESET);
A
Alan Stern 已提交
1235
	return 0;
1236 1237
}

L
Linus Torvalds 已提交
1238 1239 1240
static int hub_configure(struct usb_hub *hub,
	struct usb_endpoint_descriptor *endpoint)
{
1241
	struct usb_hcd *hcd;
L
Linus Torvalds 已提交
1242 1243 1244
	struct usb_device *hdev = hub->hdev;
	struct device *hub_dev = hub->intfdev;
	u16 hubstatus, hubchange;
1245
	u16 wHubCharacteristics;
L
Linus Torvalds 已提交
1246
	unsigned int pipe;
L
Lan Tianyu 已提交
1247
	int maxp, ret, i;
1248
	char *message = "out of memory";
1249 1250
	unsigned unit_load;
	unsigned full_load;
L
Linus Torvalds 已提交
1251

1252
	hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
L
Linus Torvalds 已提交
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
	if (!hub->buffer) {
		ret = -ENOMEM;
		goto fail;
	}

	hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
	if (!hub->status) {
		ret = -ENOMEM;
		goto fail;
	}
1263
	mutex_init(&hub->status_mutex);
L
Linus Torvalds 已提交
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274

	hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
	if (!hub->descriptor) {
		ret = -ENOMEM;
		goto fail;
	}

	/* Request the entire hub descriptor.
	 * hub->descriptor can handle USB_MAXCHILDREN ports,
	 * but the hub can/will return fewer bytes here.
	 */
J
John Youn 已提交
1275
	ret = get_hub_descriptor(hdev, hub->descriptor);
L
Linus Torvalds 已提交
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288
	if (ret < 0) {
		message = "can't read hub descriptor";
		goto fail;
	} else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
		message = "hub has too many ports!";
		ret = -ENODEV;
		goto fail;
	}

	hdev->maxchild = hub->descriptor->bNbrPorts;
	dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
		(hdev->maxchild == 1) ? "" : "s");

L
Lan Tianyu 已提交
1289 1290
	hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
			     GFP_KERNEL);
1291
	if (!hub->ports) {
1292 1293 1294 1295
		ret = -ENOMEM;
		goto fail;
	}

1296
	wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1297 1298 1299 1300 1301 1302 1303
	if (hub_is_superspeed(hdev)) {
		unit_load = 150;
		full_load = 900;
	} else {
		unit_load = 100;
		full_load = 500;
	}
L
Linus Torvalds 已提交
1304

J
John Youn 已提交
1305 1306 1307
	/* FIXME for USB 3.0, skip for now */
	if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
			!(hub_is_superspeed(hdev))) {
L
Linus Torvalds 已提交
1308 1309 1310 1311
		int	i;
		char	portstr [USB_MAXCHILDREN + 1];

		for (i = 0; i < hdev->maxchild; i++)
J
John Youn 已提交
1312
			portstr[i] = hub->descriptor->u.hs.DeviceRemovable
L
Linus Torvalds 已提交
1313 1314 1315 1316 1317 1318 1319
				    [((i + 1) / 8)] & (1 << ((i + 1) % 8))
				? 'F' : 'R';
		portstr[hdev->maxchild] = 0;
		dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
	} else
		dev_dbg(hub_dev, "standalone hub\n");

1320
	switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
	case HUB_CHAR_COMMON_LPSM:
		dev_dbg(hub_dev, "ganged power switching\n");
		break;
	case HUB_CHAR_INDV_PORT_LPSM:
		dev_dbg(hub_dev, "individual port power switching\n");
		break;
	case HUB_CHAR_NO_LPSM:
	case HUB_CHAR_LPSM:
		dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
		break;
L
Linus Torvalds 已提交
1331 1332
	}

1333
	switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
	case HUB_CHAR_COMMON_OCPM:
		dev_dbg(hub_dev, "global over-current protection\n");
		break;
	case HUB_CHAR_INDV_PORT_OCPM:
		dev_dbg(hub_dev, "individual port over-current protection\n");
		break;
	case HUB_CHAR_NO_OCPM:
	case HUB_CHAR_OCPM:
		dev_dbg(hub_dev, "no over-current protection\n");
		break;
L
Linus Torvalds 已提交
1344 1345 1346 1347
	}

	spin_lock_init (&hub->tt.lock);
	INIT_LIST_HEAD (&hub->tt.clear_list);
1348
	INIT_WORK(&hub->tt.clear_work, hub_tt_work);
L
Linus Torvalds 已提交
1349
	switch (hdev->descriptor.bDeviceProtocol) {
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
	case USB_HUB_PR_FS:
		break;
	case USB_HUB_PR_HS_SINGLE_TT:
		dev_dbg(hub_dev, "Single TT\n");
		hub->tt.hub = hdev;
		break;
	case USB_HUB_PR_HS_MULTI_TT:
		ret = usb_set_interface(hdev, 0, 1);
		if (ret == 0) {
			dev_dbg(hub_dev, "TT per port\n");
			hub->tt.multi = 1;
		} else
			dev_err(hub_dev, "Using single TT (err %d)\n",
				ret);
		hub->tt.hub = hdev;
		break;
	case USB_HUB_PR_SS:
		/* USB 3.0 hubs don't have a TT */
		break;
	default:
		dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
			hdev->descriptor.bDeviceProtocol);
		break;
L
Linus Torvalds 已提交
1373 1374
	}

1375
	/* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1376
	switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1377 1378 1379 1380 1381 1382 1383
		case HUB_TTTT_8_BITS:
			if (hdev->descriptor.bDeviceProtocol != 0) {
				hub->tt.think_time = 666;
				dev_dbg(hub_dev, "TT requires at most %d "
						"FS bit times (%d ns)\n",
					8, hub->tt.think_time);
			}
L
Linus Torvalds 已提交
1384
			break;
1385 1386 1387 1388 1389
		case HUB_TTTT_16_BITS:
			hub->tt.think_time = 666 * 2;
			dev_dbg(hub_dev, "TT requires at most %d "
					"FS bit times (%d ns)\n",
				16, hub->tt.think_time);
L
Linus Torvalds 已提交
1390
			break;
1391 1392 1393 1394 1395
		case HUB_TTTT_24_BITS:
			hub->tt.think_time = 666 * 3;
			dev_dbg(hub_dev, "TT requires at most %d "
					"FS bit times (%d ns)\n",
				24, hub->tt.think_time);
L
Linus Torvalds 已提交
1396
			break;
1397 1398 1399 1400 1401
		case HUB_TTTT_32_BITS:
			hub->tt.think_time = 666 * 4;
			dev_dbg(hub_dev, "TT requires at most %d "
					"FS bit times (%d ns)\n",
				32, hub->tt.think_time);
L
Linus Torvalds 已提交
1402 1403 1404 1405
			break;
	}

	/* probe() zeroes hub->indicator[] */
1406
	if (wHubCharacteristics & HUB_CHAR_PORTIND) {
L
Linus Torvalds 已提交
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
		hub->has_indicators = 1;
		dev_dbg(hub_dev, "Port indicators are supported\n");
	}

	dev_dbg(hub_dev, "power on to power good time: %dms\n",
		hub->descriptor->bPwrOn2PwrGood * 2);

	/* power budgeting mostly matters with bus-powered hubs,
	 * and battery-powered root hubs (may provide just 8 mA).
	 */
	ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1418
	if (ret < 2) {
L
Linus Torvalds 已提交
1419 1420 1421
		message = "can't get hub status";
		goto fail;
	}
1422
	le16_to_cpus(&hubstatus);
1423
	hcd = bus_to_hcd(hdev->bus);
1424
	if (hdev == hdev->bus->root_hub) {
1425 1426 1427 1428 1429 1430
		if (hcd->power_budget > 0)
			hdev->bus_mA = hcd->power_budget;
		else
			hdev->bus_mA = full_load * hdev->maxchild;
		if (hdev->bus_mA >= full_load)
			hub->mA_per_port = full_load;
1431 1432 1433 1434
		else {
			hub->mA_per_port = hdev->bus_mA;
			hub->limited_power = 1;
		}
1435
	} else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1436 1437 1438
		int remaining = hdev->bus_mA -
			hub->descriptor->bHubContrCurrent;

L
Linus Torvalds 已提交
1439 1440
		dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
			hub->descriptor->bHubContrCurrent);
1441 1442
		hub->limited_power = 1;

1443 1444
		if (remaining < hdev->maxchild * unit_load)
			dev_warn(hub_dev,
1445 1446
					"insufficient power available "
					"to use all downstream ports\n");
1447 1448
		hub->mA_per_port = unit_load;	/* 7.2.1 */

1449 1450 1451
	} else {	/* Self-powered external hub */
		/* FIXME: What about battery-powered external hubs that
		 * provide less current per port? */
1452
		hub->mA_per_port = full_load;
1453
	}
1454
	if (hub->mA_per_port < full_load)
1455 1456
		dev_dbg(hub_dev, "%umA bus power budget for each child\n",
				hub->mA_per_port);
L
Linus Torvalds 已提交
1457

1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
	/* Update the HCD's internal representation of this hub before khubd
	 * starts getting port status changes for devices under the hub.
	 */
	if (hcd->driver->update_hub_device) {
		ret = hcd->driver->update_hub_device(hcd, hdev,
				&hub->tt, GFP_KERNEL);
		if (ret < 0) {
			message = "can't update HCD hub info";
			goto fail;
		}
	}

L
Linus Torvalds 已提交
1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
	ret = hub_hub_status(hub, &hubstatus, &hubchange);
	if (ret < 0) {
		message = "can't get hub status";
		goto fail;
	}

	/* local power status reports aren't always correct */
	if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
		dev_dbg(hub_dev, "local power source is %s\n",
			(hubstatus & HUB_STATUS_LOCAL_POWER)
			? "lost (inactive)" : "good");

1482
	if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
L
Linus Torvalds 已提交
1483 1484 1485
		dev_dbg(hub_dev, "%sover-current condition exists\n",
			(hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");

1486 1487 1488 1489 1490 1491
	/* set up the interrupt endpoint
	 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
	 * bytes as USB2.0[11.12.3] says because some hubs are known
	 * to send more data (and thus cause overflow). For root hubs,
	 * maxpktsize is defined in hcd.c's fake endpoint descriptors
	 * to be big enough for at least USB_MAXCHILDREN ports. */
L
Linus Torvalds 已提交
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
	pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
	maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));

	if (maxp > sizeof(*hub->buffer))
		maxp = sizeof(*hub->buffer);

	hub->urb = usb_alloc_urb(0, GFP_KERNEL);
	if (!hub->urb) {
		ret = -ENOMEM;
		goto fail;
	}

	usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
		hub, endpoint->bInterval);

	/* maybe cycle the hub leds */
	if (hub->has_indicators && blinkenlights)
		hub->indicator [0] = INDICATOR_CYCLE;

L
Lan Tianyu 已提交
1511 1512 1513 1514 1515
	for (i = 0; i < hdev->maxchild; i++)
		if (usb_hub_create_port_device(hub, i + 1) < 0)
			dev_err(hub->intfdev,
				"couldn't create port%d device.\n", i + 1);

1516 1517
	usb_hub_adjust_deviceremovable(hdev, hub->descriptor);

1518
	hub_activate(hub, HUB_INIT);
L
Linus Torvalds 已提交
1519 1520 1521 1522 1523 1524 1525 1526 1527
	return 0;

fail:
	dev_err (hub_dev, "config failed, %s (err %d)\n",
			message, ret);
	/* hub_disconnect() frees urb and descriptor */
	return ret;
}

1528 1529 1530 1531 1532 1533 1534 1535
static void hub_release(struct kref *kref)
{
	struct usb_hub *hub = container_of(kref, struct usb_hub, kref);

	usb_put_intf(to_usb_interface(hub->intfdev));
	kfree(hub);
}

L
Linus Torvalds 已提交
1536 1537 1538 1539
static unsigned highspeed_hubs;

static void hub_disconnect(struct usb_interface *intf)
{
1540
	struct usb_hub *hub = usb_get_intfdata(intf);
1541
	struct usb_device *hdev = interface_to_usbdev(intf);
L
Lan Tianyu 已提交
1542 1543
	int i;

1544 1545
	/* Take the hub off the event list and don't let it be added again */
	spin_lock_irq(&hub_event_lock);
1546 1547 1548 1549
	if (!list_empty(&hub->event_list)) {
		list_del_init(&hub->event_list);
		usb_autopm_put_interface_no_suspend(intf);
	}
1550 1551
	hub->disconnected = 1;
	spin_unlock_irq(&hub_event_lock);
L
Linus Torvalds 已提交
1552

1553 1554
	/* Disconnect all children and quiesce the hub */
	hub->error = 0;
1555
	hub_quiesce(hub, HUB_DISCONNECT);
1556

1557
	usb_set_intfdata (intf, NULL);
1558 1559 1560

	for (i = 0; i < hdev->maxchild; i++)
		usb_hub_remove_port_device(hub, i + 1);
1561
	hub->hdev->maxchild = 0;
L
Linus Torvalds 已提交
1562

1563
	if (hub->hdev->speed == USB_SPEED_HIGH)
L
Linus Torvalds 已提交
1564 1565 1566
		highspeed_hubs--;

	usb_free_urb(hub->urb);
L
Lan Tianyu 已提交
1567
	kfree(hub->ports);
1568 1569
	kfree(hub->descriptor);
	kfree(hub->status);
1570
	kfree(hub->buffer);
L
Linus Torvalds 已提交
1571

1572
	kref_put(&hub->kref, hub_release);
L
Linus Torvalds 已提交
1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584
}

static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
	struct usb_host_interface *desc;
	struct usb_endpoint_descriptor *endpoint;
	struct usb_device *hdev;
	struct usb_hub *hub;

	desc = intf->cur_altsetting;
	hdev = interface_to_usbdev(intf);

1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619
	/*
	 * Set default autosuspend delay as 0 to speedup bus suspend,
	 * based on the below considerations:
	 *
	 * - Unlike other drivers, the hub driver does not rely on the
	 *   autosuspend delay to provide enough time to handle a wakeup
	 *   event, and the submitted status URB is just to check future
	 *   change on hub downstream ports, so it is safe to do it.
	 *
	 * - The patch might cause one or more auto supend/resume for
	 *   below very rare devices when they are plugged into hub
	 *   first time:
	 *
	 *   	devices having trouble initializing, and disconnect
	 *   	themselves from the bus and then reconnect a second
	 *   	or so later
	 *
	 *   	devices just for downloading firmware, and disconnects
	 *   	themselves after completing it
	 *
	 *   For these quite rare devices, their drivers may change the
	 *   autosuspend delay of their parent hub in the probe() to one
	 *   appropriate value to avoid the subtle problem if someone
	 *   does care it.
	 *
	 * - The patch may cause one or more auto suspend/resume on
	 *   hub during running 'lsusb', but it is probably too
	 *   infrequent to worry about.
	 *
	 * - Change autosuspend delay of hub can avoid unnecessary auto
	 *   suspend timer for hub, also may decrease power consumption
	 *   of USB bus.
	 */
	pm_runtime_set_autosuspend_delay(&hdev->dev, 0);

1620 1621
	/* Hubs have proper suspend/resume support. */
	usb_enable_autosuspend(hdev);
1622

1623
	if (hdev->level == MAX_TOPO_LEVEL) {
1624 1625
		dev_err(&intf->dev,
			"Unsupported bus topology: hub nested too deep\n");
1626 1627 1628
		return -E2BIG;
	}

1629 1630 1631 1632 1633 1634 1635
#ifdef	CONFIG_USB_OTG_BLACKLIST_HUB
	if (hdev->parent) {
		dev_warn(&intf->dev, "ignoring external hub\n");
		return -ENODEV;
	}
#endif

L
Linus Torvalds 已提交
1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
	/* Some hubs have a subclass of 1, which AFAICT according to the */
	/*  specs is not defined, but it works */
	if ((desc->desc.bInterfaceSubClass != 0) &&
	    (desc->desc.bInterfaceSubClass != 1)) {
descriptor_error:
		dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
		return -EIO;
	}

	/* Multiple endpoints? What kind of mutant ninja-hub is this? */
	if (desc->desc.bNumEndpoints != 1)
		goto descriptor_error;

	endpoint = &desc->endpoint[0].desc;

1651 1652
	/* If it's not an interrupt in endpoint, we'd better punt! */
	if (!usb_endpoint_is_int_in(endpoint))
L
Linus Torvalds 已提交
1653 1654 1655 1656 1657
		goto descriptor_error;

	/* We found a hub */
	dev_info (&intf->dev, "USB hub found\n");

1658
	hub = kzalloc(sizeof(*hub), GFP_KERNEL);
L
Linus Torvalds 已提交
1659 1660 1661 1662 1663
	if (!hub) {
		dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
		return -ENOMEM;
	}

1664
	kref_init(&hub->kref);
L
Linus Torvalds 已提交
1665 1666 1667
	INIT_LIST_HEAD(&hub->event_list);
	hub->intfdev = &intf->dev;
	hub->hdev = hdev;
D
David Howells 已提交
1668
	INIT_DELAYED_WORK(&hub->leds, led_work);
1669
	INIT_DELAYED_WORK(&hub->init_work, NULL);
1670
	usb_get_intf(intf);
L
Linus Torvalds 已提交
1671 1672

	usb_set_intfdata (intf, hub);
1673
	intf->needs_remote_wakeup = 1;
L
Linus Torvalds 已提交
1674 1675 1676 1677

	if (hdev->speed == USB_SPEED_HIGH)
		highspeed_hubs++;

1678 1679 1680
	if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
		hub->quirk_check_port_auto_suspend = 1;

L
Linus Torvalds 已提交
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
	if (hub_configure(hub, endpoint) >= 0)
		return 0;

	hub_disconnect (intf);
	return -ENODEV;
}

static int
hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
{
	struct usb_device *hdev = interface_to_usbdev (intf);
1692
	struct usb_hub *hub = hdev_to_hub(hdev);
L
Linus Torvalds 已提交
1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705

	/* assert ifno == 0 (part of hub spec) */
	switch (code) {
	case USBDEVFS_HUB_PORTINFO: {
		struct usbdevfs_hub_portinfo *info = user_data;
		int i;

		spin_lock_irq(&device_state_lock);
		if (hdev->devnum <= 0)
			info->nports = 0;
		else {
			info->nports = hdev->maxchild;
			for (i = 0; i < info->nports; i++) {
1706
				if (hub->ports[i]->child == NULL)
L
Linus Torvalds 已提交
1707 1708 1709
					info->port[i] = 0;
				else
					info->port[i] =
1710
						hub->ports[i]->child->devnum;
L
Linus Torvalds 已提交
1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722
			}
		}
		spin_unlock_irq(&device_state_lock);

		return info->nports + 1;
		}

	default:
		return -ENOSYS;
	}
}

1723 1724 1725 1726 1727
/*
 * Allow user programs to claim ports on a hub.  When a device is attached
 * to one of these "claimed" ports, the program will "own" the device.
 */
static int find_port_owner(struct usb_device *hdev, unsigned port1,
1728
		struct dev_state ***ppowner)
1729 1730 1731 1732 1733 1734 1735 1736 1737
{
	if (hdev->state == USB_STATE_NOTATTACHED)
		return -ENODEV;
	if (port1 == 0 || port1 > hdev->maxchild)
		return -EINVAL;

	/* This assumes that devices not managed by the hub driver
	 * will always have maxchild equal to 0.
	 */
L
Lan Tianyu 已提交
1738
	*ppowner = &(hdev_to_hub(hdev)->ports[port1 - 1]->port_owner);
1739 1740 1741 1742
	return 0;
}

/* In the following three functions, the caller must hold hdev's lock */
1743 1744
int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
		       struct dev_state *owner)
1745 1746
{
	int rc;
1747
	struct dev_state **powner;
1748 1749 1750 1751 1752 1753 1754 1755 1756 1757

	rc = find_port_owner(hdev, port1, &powner);
	if (rc)
		return rc;
	if (*powner)
		return -EBUSY;
	*powner = owner;
	return rc;
}

1758 1759
int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
			 struct dev_state *owner)
1760 1761
{
	int rc;
1762
	struct dev_state **powner;
1763 1764 1765 1766 1767 1768 1769 1770 1771 1772

	rc = find_port_owner(hdev, port1, &powner);
	if (rc)
		return rc;
	if (*powner != owner)
		return -ENOENT;
	*powner = NULL;
	return rc;
}

1773
void usb_hub_release_all_ports(struct usb_device *hdev, struct dev_state *owner)
1774
{
L
Lan Tianyu 已提交
1775
	struct usb_hub *hub = hdev_to_hub(hdev);
1776 1777
	int n;

L
Lan Tianyu 已提交
1778 1779 1780
	for (n = 0; n < hdev->maxchild; n++) {
		if (hub->ports[n]->port_owner == owner)
			hub->ports[n]->port_owner = NULL;
1781
	}
L
Lan Tianyu 已提交
1782

1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
}

/* The caller must hold udev's lock */
bool usb_device_is_owned(struct usb_device *udev)
{
	struct usb_hub *hub;

	if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
		return false;
	hub = hdev_to_hub(udev->parent);
L
Lan Tianyu 已提交
1793
	return !!hub->ports[udev->portnum - 1]->port_owner;
1794 1795
}

L
Linus Torvalds 已提交
1796 1797
static void recursively_mark_NOTATTACHED(struct usb_device *udev)
{
1798
	struct usb_hub *hub = hdev_to_hub(udev);
L
Linus Torvalds 已提交
1799 1800 1801
	int i;

	for (i = 0; i < udev->maxchild; ++i) {
1802 1803
		if (hub->ports[i]->child)
			recursively_mark_NOTATTACHED(hub->ports[i]->child);
L
Linus Torvalds 已提交
1804
	}
1805
	if (udev->state == USB_STATE_SUSPENDED)
S
Sarah Sharp 已提交
1806
		udev->active_duration -= jiffies;
L
Linus Torvalds 已提交
1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834
	udev->state = USB_STATE_NOTATTACHED;
}

/**
 * usb_set_device_state - change a device's current state (usbcore, hcds)
 * @udev: pointer to device whose state should be changed
 * @new_state: new state value to be stored
 *
 * udev->state is _not_ fully protected by the device lock.  Although
 * most transitions are made only while holding the lock, the state can
 * can change to USB_STATE_NOTATTACHED at almost any time.  This
 * is so that devices can be marked as disconnected as soon as possible,
 * without having to wait for any semaphores to be released.  As a result,
 * all changes to any device's state must be protected by the
 * device_state_lock spinlock.
 *
 * Once a device has been added to the device tree, all changes to its state
 * should be made using this routine.  The state should _not_ be set directly.
 *
 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
 * Otherwise udev->state is set to new_state, and if new_state is
 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
 * to USB_STATE_NOTATTACHED.
 */
void usb_set_device_state(struct usb_device *udev,
		enum usb_device_state new_state)
{
	unsigned long flags;
1835
	int wakeup = -1;
L
Linus Torvalds 已提交
1836 1837 1838 1839

	spin_lock_irqsave(&device_state_lock, flags);
	if (udev->state == USB_STATE_NOTATTACHED)
		;	/* do nothing */
D
David Brownell 已提交
1840
	else if (new_state != USB_STATE_NOTATTACHED) {
1841 1842 1843 1844 1845

		/* root hub wakeup capabilities are managed out-of-band
		 * and may involve silicon errata ... ignore them here.
		 */
		if (udev->parent) {
1846 1847 1848 1849
			if (udev->state == USB_STATE_SUSPENDED
					|| new_state == USB_STATE_SUSPENDED)
				;	/* No change to wakeup settings */
			else if (new_state == USB_STATE_CONFIGURED)
1850 1851
				wakeup = udev->actconfig->desc.bmAttributes
					 & USB_CONFIG_ATT_WAKEUP;
1852
			else
1853
				wakeup = 0;
1854
		}
S
Sarah Sharp 已提交
1855 1856 1857 1858 1859 1860
		if (udev->state == USB_STATE_SUSPENDED &&
			new_state != USB_STATE_SUSPENDED)
			udev->active_duration -= jiffies;
		else if (new_state == USB_STATE_SUSPENDED &&
				udev->state != USB_STATE_SUSPENDED)
			udev->active_duration += jiffies;
1861
		udev->state = new_state;
D
David Brownell 已提交
1862
	} else
L
Linus Torvalds 已提交
1863 1864
		recursively_mark_NOTATTACHED(udev);
	spin_unlock_irqrestore(&device_state_lock, flags);
1865 1866
	if (wakeup >= 0)
		device_set_wakeup_capable(&udev->dev, wakeup);
L
Linus Torvalds 已提交
1867
}
1868
EXPORT_SYMBOL_GPL(usb_set_device_state);
L
Linus Torvalds 已提交
1869

1870
/*
1871 1872 1873 1874 1875 1876 1877
 * Choose a device number.
 *
 * Device numbers are used as filenames in usbfs.  On USB-1.1 and
 * USB-2.0 buses they are also used as device addresses, however on
 * USB-3.0 buses the address is assigned by the controller hardware
 * and it usually is not the same as the device number.
 *
1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892
 * WUSB devices are simple: they have no hubs behind, so the mapping
 * device <-> virtual port number becomes 1:1. Why? to simplify the
 * life of the device connection logic in
 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
 * handshake we need to assign a temporary address in the unauthorized
 * space. For simplicity we use the first virtual port number found to
 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
 * and that becomes it's address [X < 128] or its unauthorized address
 * [X | 0x80].
 *
 * We add 1 as an offset to the one-based USB-stack port number
 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
 * 0 is reserved by USB for default address; (b) Linux's USB stack
 * uses always #1 for the root hub of the controller. So USB stack's
 * port #1, which is wusb virtual-port #0 has address #2.
1893 1894 1895 1896 1897
 *
 * Devices connected under xHCI are not as simple.  The host controller
 * supports virtualization, so the hardware assigns device addresses and
 * the HCD must setup data structures before issuing a set address
 * command to the hardware.
1898
 */
1899
static void choose_devnum(struct usb_device *udev)
L
Linus Torvalds 已提交
1900 1901 1902 1903 1904
{
	int		devnum;
	struct usb_bus	*bus = udev->bus;

	/* If khubd ever becomes multithreaded, this will need a lock */
1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917
	if (udev->wusb) {
		devnum = udev->portnum + 1;
		BUG_ON(test_bit(devnum, bus->devmap.devicemap));
	} else {
		/* Try to allocate the next devnum beginning at
		 * bus->devnum_next. */
		devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
					    bus->devnum_next);
		if (devnum >= 128)
			devnum = find_next_zero_bit(bus->devmap.devicemap,
						    128, 1);
		bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
	}
L
Linus Torvalds 已提交
1918 1919 1920 1921 1922 1923
	if (devnum < 128) {
		set_bit(devnum, bus->devmap.devicemap);
		udev->devnum = devnum;
	}
}

1924
static void release_devnum(struct usb_device *udev)
L
Linus Torvalds 已提交
1925 1926 1927 1928 1929 1930 1931
{
	if (udev->devnum > 0) {
		clear_bit(udev->devnum, udev->bus->devmap.devicemap);
		udev->devnum = -1;
	}
}

1932
static void update_devnum(struct usb_device *udev, int devnum)
1933 1934 1935 1936 1937 1938
{
	/* The address for a WUSB device is managed by wusbcore. */
	if (!udev->wusb)
		udev->devnum = devnum;
}

1939 1940 1941 1942 1943 1944 1945 1946 1947
static void hub_free_dev(struct usb_device *udev)
{
	struct usb_hcd *hcd = bus_to_hcd(udev->bus);

	/* Root hubs aren't real devices, so don't free HCD resources */
	if (hcd->driver->free_dev && udev->parent)
		hcd->driver->free_dev(hcd, udev);
}

L
Linus Torvalds 已提交
1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966
/**
 * usb_disconnect - disconnect a device (usbcore-internal)
 * @pdev: pointer to device being disconnected
 * Context: !in_interrupt ()
 *
 * Something got disconnected. Get rid of it and all of its children.
 *
 * If *pdev is a normal device then the parent hub must already be locked.
 * If *pdev is a root hub then this routine will acquire the
 * usb_bus_list_lock on behalf of the caller.
 *
 * Only hub drivers (including virtual root hub drivers for host
 * controllers) should ever call this.
 *
 * This call is synchronous, and may not be used in an interrupt context.
 */
void usb_disconnect(struct usb_device **pdev)
{
	struct usb_device	*udev = *pdev;
1967
	struct usb_hub		*hub = hdev_to_hub(udev);
L
Linus Torvalds 已提交
1968 1969 1970 1971
	int			i;

	/* mark the device as inactive, so any further urb submissions for
	 * this device (and any of its children) will fail immediately.
L
Lucas De Marchi 已提交
1972
	 * this quiesces everything except pending urbs.
L
Linus Torvalds 已提交
1973 1974
	 */
	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1975 1976
	dev_info(&udev->dev, "USB disconnect, device number %d\n",
			udev->devnum);
L
Linus Torvalds 已提交
1977

1978 1979
	usb_lock_device(udev);

L
Linus Torvalds 已提交
1980
	/* Free up all the children before we remove this device */
1981
	for (i = 0; i < udev->maxchild; i++) {
1982 1983
		if (hub->ports[i]->child)
			usb_disconnect(&hub->ports[i]->child);
L
Linus Torvalds 已提交
1984 1985 1986 1987 1988 1989
	}

	/* deallocate hcd/hardware state ... nuking all pending urbs and
	 * cleaning up all state associated with the current configuration
	 * so that the hardware is now fully quiesced.
	 */
1990
	dev_dbg (&udev->dev, "unregistering device\n");
L
Linus Torvalds 已提交
1991
	usb_disable_device(udev, 0);
1992
	usb_hcd_synchronize_unlinks(udev);
L
Linus Torvalds 已提交
1993

1994 1995 1996 1997 1998 1999 2000 2001
	if (udev->parent) {
		struct usb_port	*port_dev =
			hdev_to_hub(udev->parent)->ports[udev->portnum - 1];

		sysfs_remove_link(&udev->dev.kobj, "port");
		sysfs_remove_link(&port_dev->dev.kobj, "device");
	}

A
Alan Stern 已提交
2002
	usb_remove_ep_devs(&udev->ep0);
2003 2004 2005
	usb_unlock_device(udev);

	/* Unregister the device.  The device driver is responsible
A
Alan Stern 已提交
2006 2007
	 * for de-configuring the device and invoking the remove-device
	 * notifier chain (used by usbfs and possibly others).
2008 2009
	 */
	device_del(&udev->dev);
2010

2011
	/* Free the device number and delete the parent's children[]
L
Linus Torvalds 已提交
2012 2013
	 * (or root_hub) pointer.
	 */
2014
	release_devnum(udev);
L
Linus Torvalds 已提交
2015 2016 2017 2018 2019 2020

	/* Avoid races with recursively_mark_NOTATTACHED() */
	spin_lock_irq(&device_state_lock);
	*pdev = NULL;
	spin_unlock_irq(&device_state_lock);

2021 2022
	hub_free_dev(udev);

2023
	put_device(&udev->dev);
L
Linus Torvalds 已提交
2024 2025
}

2026
#ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
L
Linus Torvalds 已提交
2027 2028 2029 2030
static void show_string(struct usb_device *udev, char *id, char *string)
{
	if (!string)
		return;
2031
	dev_info(&udev->dev, "%s: %s\n", id, string);
L
Linus Torvalds 已提交
2032 2033
}

2034 2035 2036 2037 2038
static void announce_device(struct usb_device *udev)
{
	dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
		le16_to_cpu(udev->descriptor.idVendor),
		le16_to_cpu(udev->descriptor.idProduct));
2039 2040
	dev_info(&udev->dev,
		"New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2041 2042 2043 2044 2045 2046 2047
		udev->descriptor.iManufacturer,
		udev->descriptor.iProduct,
		udev->descriptor.iSerialNumber);
	show_string(udev, "Product", udev->product);
	show_string(udev, "Manufacturer", udev->manufacturer);
	show_string(udev, "SerialNumber", udev->serial);
}
L
Linus Torvalds 已提交
2048
#else
2049
static inline void announce_device(struct usb_device *udev) { }
L
Linus Torvalds 已提交
2050 2051 2052 2053 2054 2055
#endif

#ifdef	CONFIG_USB_OTG
#include "otg_whitelist.h"
#endif

2056
/**
A
Alan Stern 已提交
2057
 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2058 2059
 * @udev: newly addressed device (in ADDRESS state)
 *
A
Alan Stern 已提交
2060
 * Finish enumeration for On-The-Go devices
2061
 */
A
Alan Stern 已提交
2062
static int usb_enumerate_device_otg(struct usb_device *udev)
L
Linus Torvalds 已提交
2063
{
2064
	int err = 0;
L
Linus Torvalds 已提交
2065 2066 2067 2068 2069 2070 2071 2072 2073 2074

#ifdef	CONFIG_USB_OTG
	/*
	 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
	 * to wake us after we've powered off VBUS; and HNP, switching roles
	 * "host" to "peripheral".  The OTG descriptor helps figure this out.
	 */
	if (!udev->bus->is_b_host
			&& udev->config
			&& udev->parent == udev->bus->root_hub) {
F
Felipe Balbi 已提交
2075
		struct usb_otg_descriptor	*desc = NULL;
L
Linus Torvalds 已提交
2076 2077 2078 2079 2080 2081 2082
		struct usb_bus			*bus = udev->bus;

		/* descriptor may appear anywhere in config */
		if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
					le16_to_cpu(udev->config[0].desc.wTotalLength),
					USB_DT_OTG, (void **) &desc) == 0) {
			if (desc->bmAttributes & USB_OTG_HNP) {
2083
				unsigned		port1 = udev->portnum;
D
David Brownell 已提交
2084

L
Linus Torvalds 已提交
2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104
				dev_info(&udev->dev,
					"Dual-Role OTG device on %sHNP port\n",
					(port1 == bus->otg_port)
						? "" : "non-");

				/* enable HNP before suspend, it's simpler */
				if (port1 == bus->otg_port)
					bus->b_hnp_enable = 1;
				err = usb_control_msg(udev,
					usb_sndctrlpipe(udev, 0),
					USB_REQ_SET_FEATURE, 0,
					bus->b_hnp_enable
						? USB_DEVICE_B_HNP_ENABLE
						: USB_DEVICE_A_ALT_HNP_SUPPORT,
					0, NULL, 0, USB_CTRL_SET_TIMEOUT);
				if (err < 0) {
					/* OTG MESSAGE: report errors here,
					 * customize to match your product.
					 */
					dev_info(&udev->dev,
2105
						"can't set HNP mode: %d\n",
L
Linus Torvalds 已提交
2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118
						err);
					bus->b_hnp_enable = 0;
				}
			}
		}
	}

	if (!is_targeted(udev)) {

		/* Maybe it can talk to us, though we can't talk to it.
		 * (Includes HNP test device.)
		 */
		if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2119
			err = usb_port_suspend(udev, PMSG_SUSPEND);
L
Linus Torvalds 已提交
2120 2121 2122
			if (err < 0)
				dev_dbg(&udev->dev, "HNP fail, %d\n", err);
		}
2123
		err = -ENOTSUPP;
L
Linus Torvalds 已提交
2124 2125
		goto fail;
	}
2126
fail:
L
Linus Torvalds 已提交
2127
#endif
2128 2129 2130 2131 2132
	return err;
}


/**
A
Alan Stern 已提交
2133
 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2134 2135 2136 2137 2138 2139 2140 2141 2142 2143
 * @udev: newly addressed device (in ADDRESS state)
 *
 * This is only called by usb_new_device() and usb_authorize_device()
 * and FIXME -- all comments that apply to them apply here wrt to
 * environment.
 *
 * If the device is WUSB and not authorized, we don't attempt to read
 * the string descriptors, as they will be errored out by the device
 * until it has been authorized.
 */
A
Alan Stern 已提交
2144
static int usb_enumerate_device(struct usb_device *udev)
2145 2146
{
	int err;
L
Linus Torvalds 已提交
2147

2148 2149 2150 2151 2152
	if (udev->config == NULL) {
		err = usb_get_configuration(udev);
		if (err < 0) {
			dev_err(&udev->dev, "can't read configurations, error %d\n",
				err);
2153
			return err;
2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
		}
	}
	if (udev->wusb == 1 && udev->authorized == 0) {
		udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
		udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
		udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
	}
	else {
		/* read the standard strings and cache them if present */
		udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
		udev->manufacturer = usb_cache_string(udev,
						      udev->descriptor.iManufacturer);
		udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
	}
A
Alan Stern 已提交
2168
	err = usb_enumerate_device_otg(udev);
2169 2170 2171 2172 2173 2174
	if (err < 0)
		return err;

	usb_detect_interface_quirks(udev);

	return 0;
2175 2176
}

2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195
static void set_usb_port_removable(struct usb_device *udev)
{
	struct usb_device *hdev = udev->parent;
	struct usb_hub *hub;
	u8 port = udev->portnum;
	u16 wHubCharacteristics;
	bool removable = true;

	if (!hdev)
		return;

	hub = hdev_to_hub(udev->parent);

	wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);

	if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
		return;

	if (hub_is_superspeed(hdev)) {
2196 2197
		if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
				& (1 << port))
2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208
			removable = false;
	} else {
		if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
			removable = false;
	}

	if (removable)
		udev->removable = USB_DEVICE_REMOVABLE;
	else
		udev->removable = USB_DEVICE_FIXED;
}
2209 2210 2211 2212 2213

/**
 * usb_new_device - perform initial device setup (usbcore-internal)
 * @udev: newly addressed device (in ADDRESS state)
 *
A
Alan Stern 已提交
2214 2215
 * This is called with devices which have been detected but not fully
 * enumerated.  The device descriptor is available, but not descriptors
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233
 * for any device configuration.  The caller must have locked either
 * the parent hub (if udev is a normal device) or else the
 * usb_bus_list_lock (if udev is a root hub).  The parent's pointer to
 * udev has already been installed, but udev is not yet visible through
 * sysfs or other filesystem code.
 *
 * It will return if the device is configured properly or not.  Zero if
 * the interface was registered with the driver core; else a negative
 * errno value.
 *
 * This call is synchronous, and may not be used in an interrupt context.
 *
 * Only the hub driver or root-hub registrar should ever call this.
 */
int usb_new_device(struct usb_device *udev)
{
	int err;

2234 2235 2236 2237 2238 2239 2240 2241
	if (udev->parent) {
		/* Initialize non-root-hub device wakeup to disabled;
		 * device (un)configuration controls wakeup capable
		 * sysfs power/wakeup controls wakeup enabled/disabled
		 */
		device_init_wakeup(&udev->dev, 0);
	}

2242 2243
	/* Tell the runtime-PM framework the device is active */
	pm_runtime_set_active(&udev->dev);
2244
	pm_runtime_get_noresume(&udev->dev);
2245
	pm_runtime_use_autosuspend(&udev->dev);
2246 2247
	pm_runtime_enable(&udev->dev);

2248 2249 2250 2251 2252
	/* By default, forbid autosuspend for all devices.  It will be
	 * allowed for hubs during binding.
	 */
	usb_disable_autosuspend(udev);

A
Alan Stern 已提交
2253
	err = usb_enumerate_device(udev);	/* Read descriptors */
2254 2255
	if (err < 0)
		goto fail;
2256 2257 2258
	dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
			udev->devnum, udev->bus->busnum,
			(((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2259 2260 2261 2262
	/* export the usbdev device-node for libusb */
	udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
			(((udev->bus->busnum-1) * 128) + (udev->devnum-1)));

A
Alan Stern 已提交
2263 2264
	/* Tell the world! */
	announce_device(udev);
2265

2266 2267 2268 2269 2270 2271 2272 2273
	if (udev->serial)
		add_device_randomness(udev->serial, strlen(udev->serial));
	if (udev->product)
		add_device_randomness(udev->product, strlen(udev->product));
	if (udev->manufacturer)
		add_device_randomness(udev->manufacturer,
				      strlen(udev->manufacturer));

2274
	device_enable_async_suspend(&udev->dev);
2275 2276 2277 2278 2279 2280 2281 2282 2283

	/*
	 * check whether the hub marks this port as non-removable. Do it
	 * now so that platform-specific data can override it in
	 * device_add()
	 */
	if (udev->parent)
		set_usb_port_removable(udev);

2284
	/* Register the device.  The device driver is responsible
A
Alan Stern 已提交
2285 2286
	 * for configuring the device and invoking the add-device
	 * notifier chain (used by usbfs and possibly others).
2287
	 */
2288
	err = device_add(&udev->dev);
L
Linus Torvalds 已提交
2289 2290 2291 2292
	if (err) {
		dev_err(&udev->dev, "can't device_add, error %d\n", err);
		goto fail;
	}
2293

2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311
	/* Create link files between child device and usb port device. */
	if (udev->parent) {
		struct usb_port *port_dev =
			hdev_to_hub(udev->parent)->ports[udev->portnum - 1];

		err = sysfs_create_link(&udev->dev.kobj,
				&port_dev->dev.kobj, "port");
		if (err)
			goto fail;

		err = sysfs_create_link(&port_dev->dev.kobj,
				&udev->dev.kobj, "device");
		if (err) {
			sysfs_remove_link(&udev->dev.kobj, "port");
			goto fail;
		}
	}

A
Alan Stern 已提交
2312
	(void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2313 2314
	usb_mark_last_busy(udev);
	pm_runtime_put_sync_autosuspend(&udev->dev);
2315
	return err;
L
Linus Torvalds 已提交
2316 2317 2318

fail:
	usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2319 2320
	pm_runtime_disable(&udev->dev);
	pm_runtime_set_suspended(&udev->dev);
2321
	return err;
L
Linus Torvalds 已提交
2322 2323
}

2324 2325

/**
R
Randy Dunlap 已提交
2326 2327 2328 2329 2330
 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
 * @usb_dev: USB device
 *
 * Move the USB device to a very basic state where interfaces are disabled
 * and the device is in fact unconfigured and unusable.
2331 2332 2333 2334 2335 2336 2337 2338 2339
 *
 * We share a lock (that we have) with device_del(), so we need to
 * defer its call.
 */
int usb_deauthorize_device(struct usb_device *usb_dev)
{
	usb_lock_device(usb_dev);
	if (usb_dev->authorized == 0)
		goto out_unauthorized;
2340

2341 2342
	usb_dev->authorized = 0;
	usb_set_configuration(usb_dev, -1);
2343 2344

	kfree(usb_dev->product);
2345
	usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2346
	kfree(usb_dev->manufacturer);
2347
	usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2348
	kfree(usb_dev->serial);
2349
	usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2350 2351

	usb_destroy_configuration(usb_dev);
2352
	usb_dev->descriptor.bNumConfigurations = 0;
2353

2354 2355 2356 2357 2358 2359 2360 2361 2362
out_unauthorized:
	usb_unlock_device(usb_dev);
	return 0;
}


int usb_authorize_device(struct usb_device *usb_dev)
{
	int result = 0, c;
2363

2364 2365 2366
	usb_lock_device(usb_dev);
	if (usb_dev->authorized == 1)
		goto out_authorized;
2367

2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379
	result = usb_autoresume_device(usb_dev);
	if (result < 0) {
		dev_err(&usb_dev->dev,
			"can't autoresume for authorization: %d\n", result);
		goto error_autoresume;
	}
	result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
	if (result < 0) {
		dev_err(&usb_dev->dev, "can't re-read device descriptor for "
			"authorization: %d\n", result);
		goto error_device_descriptor;
	}
2380 2381 2382 2383 2384 2385 2386 2387

	kfree(usb_dev->product);
	usb_dev->product = NULL;
	kfree(usb_dev->manufacturer);
	usb_dev->manufacturer = NULL;
	kfree(usb_dev->serial);
	usb_dev->serial = NULL;

2388
	usb_dev->authorized = 1;
A
Alan Stern 已提交
2389
	result = usb_enumerate_device(usb_dev);
2390
	if (result < 0)
A
Alan Stern 已提交
2391
		goto error_enumerate;
2392 2393 2394
	/* Choose and set the configuration.  This registers the interfaces
	 * with the driver core and lets interface drivers bind to them.
	 */
2395
	c = usb_choose_configuration(usb_dev);
2396 2397 2398 2399 2400 2401 2402 2403 2404 2405
	if (c >= 0) {
		result = usb_set_configuration(usb_dev, c);
		if (result) {
			dev_err(&usb_dev->dev,
				"can't set config #%d, error %d\n", c, result);
			/* This need not be fatal.  The user can try to
			 * set other configurations. */
		}
	}
	dev_info(&usb_dev->dev, "authorized to connect\n");
2406

A
Alan Stern 已提交
2407
error_enumerate:
2408
error_device_descriptor:
2409
	usb_autosuspend_device(usb_dev);
2410 2411 2412 2413 2414 2415 2416
error_autoresume:
out_authorized:
	usb_unlock_device(usb_dev);	// complements locktree
	return result;
}


2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427
/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
static unsigned hub_is_wusb(struct usb_hub *hub)
{
	struct usb_hcd *hcd;
	if (hub->hdev->parent != NULL)  /* not a root hub? */
		return 0;
	hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
	return hcd->wireless;
}


L
Linus Torvalds 已提交
2428 2429 2430 2431
#define PORT_RESET_TRIES	5
#define SET_ADDRESS_TRIES	2
#define GET_DESCRIPTOR_TRIES	2
#define SET_CONFIG_TRIES	(2 * (use_both_schemes + 1))
2432
#define USE_NEW_SCHEME(i)	((i) / 2 == (int)old_scheme_first)
L
Linus Torvalds 已提交
2433 2434 2435

#define HUB_ROOT_RESET_TIME	50	/* times are in msec */
#define HUB_SHORT_RESET_TIME	10
A
Andiry Xu 已提交
2436
#define HUB_BH_RESET_TIME	50
L
Linus Torvalds 已提交
2437
#define HUB_LONG_RESET_TIME	200
S
Sarah Sharp 已提交
2438
#define HUB_RESET_TIMEOUT	800
L
Linus Torvalds 已提交
2439

2440 2441 2442
static int hub_port_reset(struct usb_hub *hub, int port1,
			struct usb_device *udev, unsigned int delay, bool warm);

2443 2444 2445 2446
/* Is a USB 3.0 port in the Inactive or Complinance Mode state?
 * Port worm reset is required to recover
 */
static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2447 2448
{
	return hub_is_superspeed(hub->hdev) &&
2449 2450 2451 2452
		(((portstatus & USB_PORT_STAT_LINK_STATE) ==
		  USB_SS_PORT_LS_SS_INACTIVE) ||
		 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
		  USB_SS_PORT_LS_COMP_MOD)) ;
2453 2454
}

L
Linus Torvalds 已提交
2455
static int hub_port_wait_reset(struct usb_hub *hub, int port1,
A
Andiry Xu 已提交
2456
			struct usb_device *udev, unsigned int delay, bool warm)
L
Linus Torvalds 已提交
2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472
{
	int delay_time, ret;
	u16 portstatus;
	u16 portchange;

	for (delay_time = 0;
			delay_time < HUB_RESET_TIMEOUT;
			delay_time += delay) {
		/* wait to give the device a chance to reset */
		msleep(delay);

		/* read and decode port status */
		ret = hub_port_status(hub, port1, &portstatus, &portchange);
		if (ret < 0)
			return ret;

2473
		/* The port state is unknown until the reset completes. */
S
Sarah Sharp 已提交
2474 2475
		if (!(portstatus & USB_PORT_STAT_RESET))
			break;
L
Linus Torvalds 已提交
2476 2477 2478 2479 2480 2481

		/* switch to the long delay after two short delay failures */
		if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
			delay = HUB_LONG_RESET_TIME;

		dev_dbg (hub->intfdev,
A
Andiry Xu 已提交
2482 2483
			"port %d not %sreset yet, waiting %dms\n",
			port1, warm ? "warm " : "", delay);
L
Linus Torvalds 已提交
2484 2485
	}

S
Sarah Sharp 已提交
2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520
	if ((portstatus & USB_PORT_STAT_RESET))
		return -EBUSY;

	if (hub_port_warm_reset_required(hub, portstatus))
		return -ENOTCONN;

	/* Device went away? */
	if (!(portstatus & USB_PORT_STAT_CONNECTION))
		return -ENOTCONN;

	/* bomb out completely if the connection bounced.  A USB 3.0
	 * connection may bounce if multiple warm resets were issued,
	 * but the device may have successfully re-connected. Ignore it.
	 */
	if (!hub_is_superspeed(hub->hdev) &&
			(portchange & USB_PORT_STAT_C_CONNECTION))
		return -ENOTCONN;

	if (!(portstatus & USB_PORT_STAT_ENABLE))
		return -EBUSY;

	if (!udev)
		return 0;

	if (hub_is_wusb(hub))
		udev->speed = USB_SPEED_WIRELESS;
	else if (hub_is_superspeed(hub->hdev))
		udev->speed = USB_SPEED_SUPER;
	else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
		udev->speed = USB_SPEED_HIGH;
	else if (portstatus & USB_PORT_STAT_LOW_SPEED)
		udev->speed = USB_SPEED_LOW;
	else
		udev->speed = USB_SPEED_FULL;
	return 0;
L
Linus Torvalds 已提交
2521 2522
}

A
Andiry Xu 已提交
2523
static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2524
			struct usb_device *udev, int *status)
A
Andiry Xu 已提交
2525 2526 2527
{
	switch (*status) {
	case 0:
2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538
		/* TRSTRCY = 10 ms; plus some extra */
		msleep(10 + 40);
		if (udev) {
			struct usb_hcd *hcd = bus_to_hcd(udev->bus);

			update_devnum(udev, 0);
			/* The xHC may think the device is already reset,
			 * so ignore the status.
			 */
			if (hcd->driver->reset_device)
				hcd->driver->reset_device(hcd, udev);
A
Andiry Xu 已提交
2539 2540 2541 2542 2543 2544
		}
		/* FALL THROUGH */
	case -ENOTCONN:
	case -ENODEV:
		clear_port_feature(hub->hdev,
				port1, USB_PORT_FEAT_C_RESET);
2545
		if (hub_is_superspeed(hub->hdev)) {
A
Andiry Xu 已提交
2546 2547 2548 2549
			clear_port_feature(hub->hdev, port1,
					USB_PORT_FEAT_C_BH_PORT_RESET);
			clear_port_feature(hub->hdev, port1,
					USB_PORT_FEAT_C_PORT_LINK_STATE);
2550 2551
			clear_port_feature(hub->hdev, port1,
					USB_PORT_FEAT_C_CONNECTION);
2552
		}
2553
		if (udev)
A
Andiry Xu 已提交
2554 2555 2556 2557 2558 2559 2560 2561
			usb_set_device_state(udev, *status
					? USB_STATE_NOTATTACHED
					: USB_STATE_DEFAULT);
		break;
	}
}

/* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
L
Linus Torvalds 已提交
2562
static int hub_port_reset(struct usb_hub *hub, int port1,
A
Andiry Xu 已提交
2563
			struct usb_device *udev, unsigned int delay, bool warm)
L
Linus Torvalds 已提交
2564 2565
{
	int i, status;
2566
	u16 portchange, portstatus;
L
Linus Torvalds 已提交
2567

2568 2569
	if (!hub_is_superspeed(hub->hdev)) {
		if (warm) {
A
Andiry Xu 已提交
2570 2571 2572 2573
			dev_err(hub->intfdev, "only USB3 hub support "
						"warm reset\n");
			return -EINVAL;
		}
2574 2575 2576 2577
		/* Block EHCI CF initialization during the port reset.
		 * Some companion controllers don't like it when they mix.
		 */
		down_read(&ehci_cf_port_reset_rwsem);
2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589
	} else if (!warm) {
		/*
		 * If the caller hasn't explicitly requested a warm reset,
		 * double check and see if one is needed.
		 */
		status = hub_port_status(hub, port1,
					&portstatus, &portchange);
		if (status < 0)
			goto done;

		if (hub_port_warm_reset_required(hub, portstatus))
			warm = true;
A
Andiry Xu 已提交
2590
	}
2591

L
Linus Torvalds 已提交
2592 2593
	/* Reset the port */
	for (i = 0; i < PORT_RESET_TRIES; i++) {
A
Andiry Xu 已提交
2594 2595 2596 2597
		status = set_port_feature(hub->hdev, port1, (warm ?
					USB_PORT_FEAT_BH_PORT_RESET :
					USB_PORT_FEAT_RESET));
		if (status) {
L
Linus Torvalds 已提交
2598
			dev_err(hub->intfdev,
A
Andiry Xu 已提交
2599 2600 2601 2602 2603
					"cannot %sreset port %d (err = %d)\n",
					warm ? "warm " : "", port1, status);
		} else {
			status = hub_port_wait_reset(hub, port1, udev, delay,
								warm);
2604
			if (status && status != -ENOTCONN)
L
Linus Torvalds 已提交
2605 2606 2607 2608 2609
				dev_dbg(hub->intfdev,
						"port_wait_reset: err = %d\n",
						status);
		}

2610
		/* Check for disconnect or reset */
A
Andiry Xu 已提交
2611
		if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636
			hub_port_finish_reset(hub, port1, udev, &status);

			if (!hub_is_superspeed(hub->hdev))
				goto done;

			/*
			 * If a USB 3.0 device migrates from reset to an error
			 * state, re-issue the warm reset.
			 */
			if (hub_port_status(hub, port1,
					&portstatus, &portchange) < 0)
				goto done;

			if (!hub_port_warm_reset_required(hub, portstatus))
				goto done;

			/*
			 * If the port is in SS.Inactive or Compliance Mode, the
			 * hot or warm reset failed.  Try another warm reset.
			 */
			if (!warm) {
				dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
						port1);
				warm = true;
			}
L
Linus Torvalds 已提交
2637 2638 2639
		}

		dev_dbg (hub->intfdev,
A
Andiry Xu 已提交
2640 2641
			"port %d not enabled, trying %sreset again...\n",
			port1, warm ? "warm " : "");
L
Linus Torvalds 已提交
2642 2643 2644 2645 2646 2647 2648
		delay = HUB_LONG_RESET_TIME;
	}

	dev_err (hub->intfdev,
		"Cannot enable port %i.  Maybe the USB cable is bad?\n",
		port1);

A
Andiry Xu 已提交
2649
done:
2650
	if (!hub_is_superspeed(hub->hdev))
A
Andiry Xu 已提交
2651
		up_read(&ehci_cf_port_reset_rwsem);
2652

A
Andiry Xu 已提交
2653
	return status;
2654 2655
}

2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671
/* Check if a port is power on */
static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
{
	int ret = 0;

	if (hub_is_superspeed(hub->hdev)) {
		if (portstatus & USB_SS_PORT_STAT_POWER)
			ret = 1;
	} else {
		if (portstatus & USB_PORT_STAT_POWER)
			ret = 1;
	}

	return ret;
}

A
Alan Stern 已提交
2672
#ifdef	CONFIG_PM
L
Linus Torvalds 已提交
2673

2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689
/* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
{
	int ret = 0;

	if (hub_is_superspeed(hub->hdev)) {
		if ((portstatus & USB_PORT_STAT_LINK_STATE)
				== USB_SS_PORT_LS_U3)
			ret = 1;
	} else {
		if (portstatus & USB_PORT_STAT_SUSPEND)
			ret = 1;
	}

	return ret;
}
2690 2691 2692 2693 2694 2695 2696 2697 2698

/* Determine whether the device on a port is ready for a normal resume,
 * is ready for a reset-resume, or should be disconnected.
 */
static int check_port_resume_type(struct usb_device *udev,
		struct usb_hub *hub, int port1,
		int status, unsigned portchange, unsigned portstatus)
{
	/* Is the device still present? */
2699 2700 2701
	if (status || port_is_suspended(hub, portstatus) ||
			!port_is_power_on(hub, portstatus) ||
			!(portstatus & USB_PORT_STAT_CONNECTION)) {
2702 2703 2704 2705
		if (status >= 0)
			status = -ENODEV;
	}

2706 2707 2708 2709 2710 2711 2712 2713 2714
	/* Can't do a normal resume if the port isn't enabled,
	 * so try a reset-resume instead.
	 */
	else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
		if (udev->persist_enabled)
			udev->reset_resume = 1;
		else
			status = -ENODEV;
	}
2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733

	if (status) {
		dev_dbg(hub->intfdev,
				"port %d status %04x.%04x after resume, %d\n",
				port1, portchange, portstatus, status);
	} else if (udev->reset_resume) {

		/* Late port handoff can set status-change bits */
		if (portchange & USB_PORT_STAT_C_CONNECTION)
			clear_port_feature(hub->hdev, port1,
					USB_PORT_FEAT_C_CONNECTION);
		if (portchange & USB_PORT_STAT_C_ENABLE)
			clear_port_feature(hub->hdev, port1,
					USB_PORT_FEAT_C_ENABLE);
	}

	return status;
}

2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777
int usb_disable_ltm(struct usb_device *udev)
{
	struct usb_hcd *hcd = bus_to_hcd(udev->bus);

	/* Check if the roothub and device supports LTM. */
	if (!usb_device_supports_ltm(hcd->self.root_hub) ||
			!usb_device_supports_ltm(udev))
		return 0;

	/* Clear Feature LTM Enable can only be sent if the device is
	 * configured.
	 */
	if (!udev->actconfig)
		return 0;

	return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
			USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
			USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
			USB_CTRL_SET_TIMEOUT);
}
EXPORT_SYMBOL_GPL(usb_disable_ltm);

void usb_enable_ltm(struct usb_device *udev)
{
	struct usb_hcd *hcd = bus_to_hcd(udev->bus);

	/* Check if the roothub and device supports LTM. */
	if (!usb_device_supports_ltm(hcd->self.root_hub) ||
			!usb_device_supports_ltm(udev))
		return;

	/* Set Feature LTM Enable can only be sent if the device is
	 * configured.
	 */
	if (!udev->actconfig)
		return;

	usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
			USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
			USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
			USB_CTRL_SET_TIMEOUT);
}
EXPORT_SYMBOL_GPL(usb_enable_ltm);

L
Linus Torvalds 已提交
2778 2779 2780
#ifdef	CONFIG_USB_SUSPEND

/*
A
Alan Stern 已提交
2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793
 * usb_port_suspend - suspend a usb device's upstream port
 * @udev: device that's no longer in active use, not a root hub
 * Context: must be able to sleep; device not locked; pm locks held
 *
 * Suspends a USB device that isn't in active use, conserving power.
 * Devices may wake out of a suspend, if anything important happens,
 * using the remote wakeup mechanism.  They may also be taken out of
 * suspend by the host, using usb_port_resume().  It's also routine
 * to disconnect devices while they are suspended.
 *
 * This only affects the USB hardware for a device; its interfaces
 * (and, for hubs, child devices) must already have been suspended.
 *
L
Linus Torvalds 已提交
2794 2795 2796 2797 2798 2799 2800 2801
 * Selective port suspend reduces power; most suspended devices draw
 * less than 500 uA.  It's also used in OTG, along with remote wakeup.
 * All devices below the suspended port are also suspended.
 *
 * Devices leave suspend state when the host wakes them up.  Some devices
 * also support "remote wakeup", where the device can activate the USB
 * tree above them to deliver data, such as a keypress or packet.  In
 * some cases, this wakes the USB host.
A
Alan Stern 已提交
2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824
 *
 * Suspending OTG devices may trigger HNP, if that's been enabled
 * between a pair of dual-role devices.  That will change roles, such
 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
 *
 * Devices on USB hub ports have only one "suspend" state, corresponding
 * to ACPI D2, "may cause the device to lose some context".
 * State transitions include:
 *
 *   - suspend, resume ... when the VBUS power link stays live
 *   - suspend, disconnect ... VBUS lost
 *
 * Once VBUS drop breaks the circuit, the port it's using has to go through
 * normal re-enumeration procedures, starting with enabling VBUS power.
 * Other than re-initializing the hub (plug/unplug, except for root hubs),
 * Linux (2.6) currently has NO mechanisms to initiate that:  no khubd
 * timer, no SRP, no requests through sysfs.
 *
 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
 * the root hub for their bus goes into global suspend ... so we don't
 * (falsely) update the device power state to say it suspended.
 *
 * Returns 0 on success, else negative errno.
L
Linus Torvalds 已提交
2825
 */
A
Alan Stern 已提交
2826
int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
L
Linus Torvalds 已提交
2827
{
A
Alan Stern 已提交
2828 2829 2830
	struct usb_hub	*hub = hdev_to_hub(udev->parent);
	int		port1 = udev->portnum;
	int		status;
L
Linus Torvalds 已提交
2831 2832 2833 2834 2835 2836 2837

	/* enable remote wakeup when appropriate; this lets the device
	 * wake up the upstream hub (including maybe the root hub).
	 *
	 * NOTE:  OTG devices may issue remote wakeup (or SRP) even when
	 * we don't explicitly enable it here.
	 */
2838
	if (udev->do_remote_wakeup) {
2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854
		if (!hub_is_superspeed(hub->hdev)) {
			status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
					USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
					USB_DEVICE_REMOTE_WAKEUP, 0,
					NULL, 0,
					USB_CTRL_SET_TIMEOUT);
		} else {
			/* Assume there's only one function on the USB 3.0
			 * device and enable remote wake for the first
			 * interface. FIXME if the interface association
			 * descriptor shows there's more than one function.
			 */
			status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
					USB_REQ_SET_FEATURE,
					USB_RECIP_INTERFACE,
					USB_INTRF_FUNC_SUSPEND,
2855 2856
					USB_INTRF_FUNC_SUSPEND_RW |
					USB_INTRF_FUNC_SUSPEND_LP,
2857 2858 2859
					NULL, 0,
					USB_CTRL_SET_TIMEOUT);
		}
2860
		if (status) {
A
Alan Stern 已提交
2861 2862
			dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
					status);
2863
			/* bail if autosuspend is requested */
2864
			if (PMSG_IS_AUTO(msg))
2865 2866
				return status;
		}
L
Linus Torvalds 已提交
2867 2868
	}

A
Andiry Xu 已提交
2869 2870 2871 2872
	/* disable USB2 hardware LPM */
	if (udev->usb2_hw_lpm_enabled == 1)
		usb_set_usb2_hardware_lpm(udev, 0);

2873 2874 2875 2876 2877
	if (usb_disable_ltm(udev)) {
		dev_err(&udev->dev, "%s Failed to disable LTM before suspend\n.",
				__func__);
		return -ENOMEM;
	}
2878 2879 2880 2881 2882 2883
	if (usb_unlocked_disable_lpm(udev)) {
		dev_err(&udev->dev, "%s Failed to disable LPM before suspend\n.",
				__func__);
		return -ENOMEM;
	}

L
Linus Torvalds 已提交
2884
	/* see 7.1.7.6 */
2885
	if (hub_is_superspeed(hub->hdev))
2886
		status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
2887 2888 2889
	else
		status = set_port_feature(hub->hdev, port1,
						USB_PORT_FEAT_SUSPEND);
L
Linus Torvalds 已提交
2890
	if (status) {
A
Alan Stern 已提交
2891 2892
		dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
				port1, status);
L
Linus Torvalds 已提交
2893
		/* paranoia:  "should not happen" */
2894 2895
		if (udev->do_remote_wakeup)
			(void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
L
Linus Torvalds 已提交
2896 2897 2898 2899
				USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
				USB_DEVICE_REMOTE_WAKEUP, 0,
				NULL, 0,
				USB_CTRL_SET_TIMEOUT);
2900

2901 2902 2903 2904
		/* Try to enable USB2 hardware LPM again */
		if (udev->usb2_hw_lpm_capable == 1)
			usb_set_usb2_hardware_lpm(udev, 1);

2905 2906
		/* Try to enable USB3 LTM and LPM again */
		usb_enable_ltm(udev);
2907 2908
		usb_unlocked_enable_lpm(udev);

2909
		/* System sleep transitions should never fail */
2910
		if (!PMSG_IS_AUTO(msg))
2911
			status = 0;
L
Linus Torvalds 已提交
2912 2913
	} else {
		/* device has up to 10 msec to fully suspend */
2914 2915 2916
		dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
				(PMSG_IS_AUTO(msg) ? "auto-" : ""),
				udev->do_remote_wakeup);
L
Linus Torvalds 已提交
2917
		usb_set_device_state(udev, USB_STATE_SUSPENDED);
A
Alan Stern 已提交
2918
		udev->port_is_suspended = 1;
L
Linus Torvalds 已提交
2919 2920
		msleep(10);
	}
2921
	usb_mark_last_busy(hub->hdev);
L
Linus Torvalds 已提交
2922 2923 2924 2925
	return status;
}

/*
2926 2927
 * If the USB "suspend" state is in use (rather than "global suspend"),
 * many devices will be individually taken out of suspend state using
2928
 * special "resume" signaling.  This routine kicks in shortly after
L
Linus Torvalds 已提交
2929 2930 2931
 * hardware resume signaling is finished, either because of selective
 * resume (by host) or remote wakeup (by device) ... now see what changed
 * in the tree that's rooted at this device.
2932 2933 2934
 *
 * If @udev->reset_resume is set then the device is reset before the
 * status check is done.
L
Linus Torvalds 已提交
2935
 */
2936
static int finish_port_resume(struct usb_device *udev)
L
Linus Torvalds 已提交
2937
{
2938
	int	status = 0;
2939
	u16	devstatus = 0;
L
Linus Torvalds 已提交
2940 2941

	/* caller owns the udev device lock */
2942 2943
	dev_dbg(&udev->dev, "%s\n",
		udev->reset_resume ? "finish reset-resume" : "finish resume");
L
Linus Torvalds 已提交
2944 2945 2946 2947 2948 2949 2950 2951 2952 2953

	/* usb ch9 identifies four variants of SUSPENDED, based on what
	 * state the device resumes to.  Linux currently won't see the
	 * first two on the host side; they'd be inside hub_port_init()
	 * during many timeouts, but khubd can't suspend until later.
	 */
	usb_set_device_state(udev, udev->actconfig
			? USB_STATE_CONFIGURED
			: USB_STATE_ADDRESS);

2954 2955 2956 2957 2958 2959
	/* 10.5.4.5 says not to reset a suspended port if the attached
	 * device is enabled for remote wakeup.  Hence the reset
	 * operation is carried out here, after the port has been
	 * resumed.
	 */
	if (udev->reset_resume)
2960
 retry_reset_resume:
2961
		status = usb_reset_and_verify_device(udev);
2962

L
Linus Torvalds 已提交
2963 2964 2965 2966
 	/* 10.5.4.5 says be sure devices in the tree are still there.
 	 * For now let's assume the device didn't go crazy on resume,
	 * and device drivers will know about any resume quirks.
	 */
2967
	if (status == 0) {
2968
		devstatus = 0;
2969 2970
		status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
		if (status >= 0)
2971
			status = (status > 0 ? 0 : -ENODEV);
2972 2973 2974 2975 2976 2977 2978

		/* If a normal resume failed, try doing a reset-resume */
		if (status && !udev->reset_resume && udev->persist_enabled) {
			dev_dbg(&udev->dev, "retry with reset-resume\n");
			udev->reset_resume = 1;
			goto retry_reset_resume;
		}
2979
	}
2980

A
Alan Stern 已提交
2981 2982 2983
	if (status) {
		dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
				status);
2984 2985 2986 2987 2988 2989 2990
	/*
	 * There are a few quirky devices which violate the standard
	 * by claiming to have remote wakeup enabled after a reset,
	 * which crash if the feature is cleared, hence check for
	 * udev->reset_resume
	 */
	} else if (udev->actconfig && !udev->reset_resume) {
L
Linus Torvalds 已提交
2991
		le16_to_cpus(&devstatus);
2992
		if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
L
Linus Torvalds 已提交
2993 2994 2995 2996 2997 2998 2999
			status = usb_control_msg(udev,
					usb_sndctrlpipe(udev, 0),
					USB_REQ_CLEAR_FEATURE,
						USB_RECIP_DEVICE,
					USB_DEVICE_REMOTE_WAKEUP, 0,
					NULL, 0,
					USB_CTRL_SET_TIMEOUT);
3000
			if (status)
3001 3002 3003
				dev_dbg(&udev->dev,
					"disable remote wakeup, status %d\n",
					status);
3004
		}
L
Linus Torvalds 已提交
3005 3006 3007 3008 3009
		status = 0;
	}
	return status;
}

A
Alan Stern 已提交
3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020
/*
 * usb_port_resume - re-activate a suspended usb device's upstream port
 * @udev: device to re-activate, not a root hub
 * Context: must be able to sleep; device not locked; pm locks held
 *
 * This will re-activate the suspended device, increasing power usage
 * while letting drivers communicate again with its endpoints.
 * USB resume explicitly guarantees that the power session between
 * the host and the device is the same as it was when the device
 * suspended.
 *
3021 3022
 * If @udev->reset_resume is set then this routine won't check that the
 * port is still enabled.  Furthermore, finish_port_resume() above will
3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033
 * reset @udev.  The end result is that a broken power session can be
 * recovered and @udev will appear to persist across a loss of VBUS power.
 *
 * For example, if a host controller doesn't maintain VBUS suspend current
 * during a system sleep or is reset when the system wakes up, all the USB
 * power sessions below it will be broken.  This is especially troublesome
 * for mass-storage devices containing mounted filesystems, since the
 * device will appear to have disconnected and all the memory mappings
 * to it will be lost.  Using the USB_PERSIST facility, the device can be
 * made to appear as if it had not disconnected.
 *
3034
 * This facility can be dangerous.  Although usb_reset_and_verify_device() makes
3035
 * every effort to insure that the same device is present after the
3036 3037 3038 3039 3040 3041
 * reset as before, it cannot provide a 100% guarantee.  Furthermore it's
 * quite possible for a device to remain unaltered but its media to be
 * changed.  If the user replaces a flash memory card while the system is
 * asleep, he will have only himself to blame when the filesystem on the
 * new card is corrupted and the system crashes.
 *
A
Alan Stern 已提交
3042 3043
 * Returns 0 on success, else negative errno.
 */
A
Alan Stern 已提交
3044
int usb_port_resume(struct usb_device *udev, pm_message_t msg)
L
Linus Torvalds 已提交
3045
{
A
Alan Stern 已提交
3046 3047 3048 3049
	struct usb_hub	*hub = hdev_to_hub(udev->parent);
	int		port1 = udev->portnum;
	int		status;
	u16		portchange, portstatus;
3050 3051 3052

	/* Skip the initial Clear-Suspend step for a remote wakeup */
	status = hub_port_status(hub, port1, &portstatus, &portchange);
3053
	if (status == 0 && !port_is_suspended(hub, portstatus))
3054
		goto SuspendCleared;
L
Linus Torvalds 已提交
3055 3056 3057

	// dev_dbg(hub->intfdev, "resume port %d\n", port1);

3058 3059
	set_bit(port1, hub->busy_bits);

L
Linus Torvalds 已提交
3060
	/* see 7.1.7.7; affects power usage, but not budgeting */
3061
	if (hub_is_superspeed(hub->hdev))
3062
		status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3063 3064 3065
	else
		status = clear_port_feature(hub->hdev,
				port1, USB_PORT_FEAT_SUSPEND);
L
Linus Torvalds 已提交
3066
	if (status) {
A
Alan Stern 已提交
3067 3068
		dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
				port1, status);
L
Linus Torvalds 已提交
3069 3070
	} else {
		/* drive resume for at least 20 msec */
3071
		dev_dbg(&udev->dev, "usb %sresume\n",
3072
				(PMSG_IS_AUTO(msg) ? "auto-" : ""));
L
Linus Torvalds 已提交
3073 3074 3075 3076 3077 3078
		msleep(25);

		/* Virtual root hubs can trigger on GET_PORT_STATUS to
		 * stop resume signaling.  Then finish the resume
		 * sequence.
		 */
3079
		status = hub_port_status(hub, port1, &portstatus, &portchange);
3080

3081 3082 3083 3084
		/* TRSMRCY = 10 msec */
		msleep(10);
	}

3085
 SuspendCleared:
3086
	if (status == 0) {
A
Alan Stern 已提交
3087
		udev->port_is_suspended = 0;
3088 3089 3090 3091 3092 3093 3094 3095 3096
		if (hub_is_superspeed(hub->hdev)) {
			if (portchange & USB_PORT_STAT_C_LINK_STATE)
				clear_port_feature(hub->hdev, port1,
					USB_PORT_FEAT_C_PORT_LINK_STATE);
		} else {
			if (portchange & USB_PORT_STAT_C_SUSPEND)
				clear_port_feature(hub->hdev, port1,
						USB_PORT_FEAT_C_SUSPEND);
		}
L
Linus Torvalds 已提交
3097 3098
	}

3099 3100
	clear_bit(port1, hub->busy_bits);

3101 3102
	status = check_port_resume_type(udev,
			hub, port1, status, portchange, portstatus);
3103 3104 3105 3106 3107
	if (status == 0)
		status = finish_port_resume(udev);
	if (status < 0) {
		dev_dbg(&udev->dev, "can't resume, status %d\n", status);
		hub_port_logical_disconnect(hub, port1);
A
Andiry Xu 已提交
3108 3109 3110 3111
	} else  {
		/* Try to enable USB2 hardware LPM */
		if (udev->usb2_hw_lpm_capable == 1)
			usb_set_usb2_hardware_lpm(udev, 1);
3112

3113 3114
		/* Try to enable USB3 LTM and LPM */
		usb_enable_ltm(udev);
3115
		usb_unlocked_enable_lpm(udev);
3116
	}
A
Andiry Xu 已提交
3117

L
Linus Torvalds 已提交
3118 3119 3120
	return status;
}

3121
/* caller has locked udev */
3122
int usb_remote_wakeup(struct usb_device *udev)
L
Linus Torvalds 已提交
3123 3124 3125 3126
{
	int	status = 0;

	if (udev->state == USB_STATE_SUSPENDED) {
3127
		dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3128 3129 3130 3131 3132
		status = usb_autoresume_device(udev);
		if (status == 0) {
			/* Let the drivers do their thing, then... */
			usb_autosuspend_device(udev);
		}
L
Linus Torvalds 已提交
3133 3134 3135 3136
	}
	return status;
}

A
Alan Stern 已提交
3137 3138 3139 3140
#else	/* CONFIG_USB_SUSPEND */

/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */

A
Alan Stern 已提交
3141
int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
A
Alan Stern 已提交
3142 3143 3144 3145
{
	return 0;
}

3146 3147
/* However we may need to do a reset-resume */

A
Alan Stern 已提交
3148
int usb_port_resume(struct usb_device *udev, pm_message_t msg)
A
Alan Stern 已提交
3149
{
3150 3151 3152 3153 3154 3155 3156 3157
	struct usb_hub	*hub = hdev_to_hub(udev->parent);
	int		port1 = udev->portnum;
	int		status;
	u16		portchange, portstatus;

	status = hub_port_status(hub, port1, &portstatus, &portchange);
	status = check_port_resume_type(udev,
			hub, port1, status, portchange, portstatus);
3158

3159 3160 3161 3162
	if (status) {
		dev_dbg(&udev->dev, "can't resume, status %d\n", status);
		hub_port_logical_disconnect(hub, port1);
	} else if (udev->reset_resume) {
3163
		dev_dbg(&udev->dev, "reset-resume\n");
3164
		status = usb_reset_and_verify_device(udev);
3165 3166
	}
	return status;
A
Alan Stern 已提交
3167 3168 3169 3170
}

#endif

3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185
static int check_ports_changed(struct usb_hub *hub)
{
	int port1;

	for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
		u16 portstatus, portchange;
		int status;

		status = hub_port_status(hub, port1, &portstatus, &portchange);
		if (!status && portchange)
			return 1;
	}
	return 0;
}

D
David Brownell 已提交
3186
static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
L
Linus Torvalds 已提交
3187 3188 3189 3190
{
	struct usb_hub		*hub = usb_get_intfdata (intf);
	struct usb_device	*hdev = hub->hdev;
	unsigned		port1;
3191
	int			status;
L
Linus Torvalds 已提交
3192

3193
	/* Warn if children aren't already suspended */
L
Linus Torvalds 已提交
3194 3195 3196
	for (port1 = 1; port1 <= hdev->maxchild; port1++) {
		struct usb_device	*udev;

3197
		udev = hub->ports[port1 - 1]->child;
3198
		if (udev && udev->can_submit) {
3199
			dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
3200
			if (PMSG_IS_AUTO(msg))
3201
				return -EBUSY;
3202
		}
L
Linus Torvalds 已提交
3203
	}
3204 3205 3206 3207 3208 3209 3210 3211 3212 3213

	if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
		/* check if there are changes pending on hub ports */
		if (check_ports_changed(hub)) {
			if (PMSG_IS_AUTO(msg))
				return -EBUSY;
			pm_wakeup_event(&hdev->dev, 2000);
		}
	}

3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224
	if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
		/* Enable hub to send remote wakeup for all ports. */
		for (port1 = 1; port1 <= hdev->maxchild; port1++) {
			status = set_port_feature(hdev,
					port1 |
					USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
					USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
					USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
					USB_PORT_FEAT_REMOTE_WAKE_MASK);
		}
	}
L
Linus Torvalds 已提交
3225

3226
	dev_dbg(&intf->dev, "%s\n", __func__);
3227

3228
	/* stop khubd and related activity */
3229
	hub_quiesce(hub, HUB_SUSPEND);
3230
	return 0;
L
Linus Torvalds 已提交
3231 3232 3233 3234
}

static int hub_resume(struct usb_interface *intf)
{
3235
	struct usb_hub *hub = usb_get_intfdata(intf);
3236

3237
	dev_dbg(&intf->dev, "%s\n", __func__);
3238
	hub_activate(hub, HUB_RESUME);
L
Linus Torvalds 已提交
3239 3240 3241
	return 0;
}

3242
static int hub_reset_resume(struct usb_interface *intf)
A
Alan Stern 已提交
3243
{
3244
	struct usb_hub *hub = usb_get_intfdata(intf);
A
Alan Stern 已提交
3245

3246
	dev_dbg(&intf->dev, "%s\n", __func__);
3247
	hub_activate(hub, HUB_RESET_RESUME);
A
Alan Stern 已提交
3248 3249 3250
	return 0;
}

3251 3252 3253 3254 3255 3256
/**
 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
 * @rhdev: struct usb_device for the root hub
 *
 * The USB host controller driver calls this function when its root hub
 * is resumed and Vbus power has been interrupted or the controller
3257 3258 3259 3260
 * has been reset.  The routine marks @rhdev as having lost power.
 * When the hub driver is resumed it will take notice and carry out
 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
 * the others will be disconnected.
3261 3262 3263 3264 3265 3266 3267 3268
 */
void usb_root_hub_lost_power(struct usb_device *rhdev)
{
	dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
	rhdev->reset_resume = 1;
}
EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);

3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313
static const char * const usb3_lpm_names[]  = {
	"U0",
	"U1",
	"U2",
	"U3",
};

/*
 * Send a Set SEL control transfer to the device, prior to enabling
 * device-initiated U1 or U2.  This lets the device know the exit latencies from
 * the time the device initiates a U1 or U2 exit, to the time it will receive a
 * packet from the host.
 *
 * This function will fail if the SEL or PEL values for udev are greater than
 * the maximum allowed values for the link state to be enabled.
 */
static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
{
	struct usb_set_sel_req *sel_values;
	unsigned long long u1_sel;
	unsigned long long u1_pel;
	unsigned long long u2_sel;
	unsigned long long u2_pel;
	int ret;

	/* Convert SEL and PEL stored in ns to us */
	u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
	u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
	u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
	u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);

	/*
	 * Make sure that the calculated SEL and PEL values for the link
	 * state we're enabling aren't bigger than the max SEL/PEL
	 * value that will fit in the SET SEL control transfer.
	 * Otherwise the device would get an incorrect idea of the exit
	 * latency for the link state, and could start a device-initiated
	 * U1/U2 when the exit latencies are too high.
	 */
	if ((state == USB3_LPM_U1 &&
				(u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
				 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
			(state == USB3_LPM_U2 &&
			 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
			  u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3314
		dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475
				usb3_lpm_names[state], u1_sel, u1_pel);
		return -EINVAL;
	}

	/*
	 * If we're enabling device-initiated LPM for one link state,
	 * but the other link state has a too high SEL or PEL value,
	 * just set those values to the max in the Set SEL request.
	 */
	if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
		u1_sel = USB3_LPM_MAX_U1_SEL_PEL;

	if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
		u1_pel = USB3_LPM_MAX_U1_SEL_PEL;

	if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
		u2_sel = USB3_LPM_MAX_U2_SEL_PEL;

	if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
		u2_pel = USB3_LPM_MAX_U2_SEL_PEL;

	/*
	 * usb_enable_lpm() can be called as part of a failed device reset,
	 * which may be initiated by an error path of a mass storage driver.
	 * Therefore, use GFP_NOIO.
	 */
	sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
	if (!sel_values)
		return -ENOMEM;

	sel_values->u1_sel = u1_sel;
	sel_values->u1_pel = u1_pel;
	sel_values->u2_sel = cpu_to_le16(u2_sel);
	sel_values->u2_pel = cpu_to_le16(u2_pel);

	ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
			USB_REQ_SET_SEL,
			USB_RECIP_DEVICE,
			0, 0,
			sel_values, sizeof *(sel_values),
			USB_CTRL_SET_TIMEOUT);
	kfree(sel_values);
	return ret;
}

/*
 * Enable or disable device-initiated U1 or U2 transitions.
 */
static int usb_set_device_initiated_lpm(struct usb_device *udev,
		enum usb3_link_state state, bool enable)
{
	int ret;
	int feature;

	switch (state) {
	case USB3_LPM_U1:
		feature = USB_DEVICE_U1_ENABLE;
		break;
	case USB3_LPM_U2:
		feature = USB_DEVICE_U2_ENABLE;
		break;
	default:
		dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
				__func__, enable ? "enable" : "disable");
		return -EINVAL;
	}

	if (udev->state != USB_STATE_CONFIGURED) {
		dev_dbg(&udev->dev, "%s: Can't %s %s state "
				"for unconfigured device.\n",
				__func__, enable ? "enable" : "disable",
				usb3_lpm_names[state]);
		return 0;
	}

	if (enable) {
		/*
		 * Now send the control transfer to enable device-initiated LPM
		 * for either U1 or U2.
		 */
		ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
				USB_REQ_SET_FEATURE,
				USB_RECIP_DEVICE,
				feature,
				0, NULL, 0,
				USB_CTRL_SET_TIMEOUT);
	} else {
		ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
				USB_REQ_CLEAR_FEATURE,
				USB_RECIP_DEVICE,
				feature,
				0, NULL, 0,
				USB_CTRL_SET_TIMEOUT);
	}
	if (ret < 0) {
		dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
				enable ? "Enable" : "Disable",
				usb3_lpm_names[state]);
		return -EBUSY;
	}
	return 0;
}

static int usb_set_lpm_timeout(struct usb_device *udev,
		enum usb3_link_state state, int timeout)
{
	int ret;
	int feature;

	switch (state) {
	case USB3_LPM_U1:
		feature = USB_PORT_FEAT_U1_TIMEOUT;
		break;
	case USB3_LPM_U2:
		feature = USB_PORT_FEAT_U2_TIMEOUT;
		break;
	default:
		dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
				__func__);
		return -EINVAL;
	}

	if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
			timeout != USB3_LPM_DEVICE_INITIATED) {
		dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
				"which is a reserved value.\n",
				usb3_lpm_names[state], timeout);
		return -EINVAL;
	}

	ret = set_port_feature(udev->parent,
			USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
			feature);
	if (ret < 0) {
		dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
				"error code %i\n", usb3_lpm_names[state],
				timeout, ret);
		return -EBUSY;
	}
	if (state == USB3_LPM_U1)
		udev->u1_params.timeout = timeout;
	else
		udev->u2_params.timeout = timeout;
	return 0;
}

/*
 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
 * U1/U2 entry.
 *
 * We will attempt to enable U1 or U2, but there are no guarantees that the
 * control transfers to set the hub timeout or enable device-initiated U1/U2
 * will be successful.
 *
 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
 * driver know about it.  If that call fails, it should be harmless, and just
 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
 */
static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
		enum usb3_link_state state)
{
3476
	int timeout, ret;
3477 3478 3479 3480 3481 3482 3483 3484 3485 3486
	__u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
	__le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;

	/* If the device says it doesn't have *any* exit latency to come out of
	 * U1 or U2, it's probably lying.  Assume it doesn't implement that link
	 * state.
	 */
	if ((state == USB3_LPM_U1 && u1_mel == 0) ||
			(state == USB3_LPM_U2 && u2_mel == 0))
		return;
3487

3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498
	/*
	 * First, let the device know about the exit latencies
	 * associated with the link state we're about to enable.
	 */
	ret = usb_req_set_sel(udev, state);
	if (ret < 0) {
		dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
				usb3_lpm_names[state]);
		return;
	}

3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595
	/* We allow the host controller to set the U1/U2 timeout internally
	 * first, so that it can change its schedule to account for the
	 * additional latency to send data to a device in a lower power
	 * link state.
	 */
	timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);

	/* xHCI host controller doesn't want to enable this LPM state. */
	if (timeout == 0)
		return;

	if (timeout < 0) {
		dev_warn(&udev->dev, "Could not enable %s link state, "
				"xHCI error %i.\n", usb3_lpm_names[state],
				timeout);
		return;
	}

	if (usb_set_lpm_timeout(udev, state, timeout))
		/* If we can't set the parent hub U1/U2 timeout,
		 * device-initiated LPM won't be allowed either, so let the xHCI
		 * host know that this link state won't be enabled.
		 */
		hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);

	/* Only a configured device will accept the Set Feature U1/U2_ENABLE */
	else if (udev->actconfig)
		usb_set_device_initiated_lpm(udev, state, true);

}

/*
 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
 * U1/U2 entry.
 *
 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
 * If zero is returned, the parent will not allow the link to go into U1/U2.
 *
 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
 * it won't have an effect on the bus link state because the parent hub will
 * still disallow device-initiated U1/U2 entry.
 *
 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
 * possible.  The result will be slightly more bus bandwidth will be taken up
 * (to account for U1/U2 exit latency), but it should be harmless.
 */
static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
		enum usb3_link_state state)
{
	int feature;

	switch (state) {
	case USB3_LPM_U1:
		feature = USB_PORT_FEAT_U1_TIMEOUT;
		break;
	case USB3_LPM_U2:
		feature = USB_PORT_FEAT_U2_TIMEOUT;
		break;
	default:
		dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
				__func__);
		return -EINVAL;
	}

	if (usb_set_lpm_timeout(udev, state, 0))
		return -EBUSY;

	usb_set_device_initiated_lpm(udev, state, false);

	if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
		dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
				"bus schedule bandwidth may be impacted.\n",
				usb3_lpm_names[state]);
	return 0;
}

/*
 * Disable hub-initiated and device-initiated U1 and U2 entry.
 * Caller must own the bandwidth_mutex.
 *
 * This will call usb_enable_lpm() on failure, which will decrement
 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
 */
int usb_disable_lpm(struct usb_device *udev)
{
	struct usb_hcd *hcd;

	if (!udev || !udev->parent ||
			udev->speed != USB_SPEED_SUPER ||
			!udev->lpm_capable)
		return 0;

	hcd = bus_to_hcd(udev->bus);
	if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
		return 0;

	udev->lpm_disable_count++;
3596
	if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678
		return 0;

	/* If LPM is enabled, attempt to disable it. */
	if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
		goto enable_lpm;
	if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
		goto enable_lpm;

	return 0;

enable_lpm:
	usb_enable_lpm(udev);
	return -EBUSY;
}
EXPORT_SYMBOL_GPL(usb_disable_lpm);

/* Grab the bandwidth_mutex before calling usb_disable_lpm() */
int usb_unlocked_disable_lpm(struct usb_device *udev)
{
	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
	int ret;

	if (!hcd)
		return -EINVAL;

	mutex_lock(hcd->bandwidth_mutex);
	ret = usb_disable_lpm(udev);
	mutex_unlock(hcd->bandwidth_mutex);

	return ret;
}
EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);

/*
 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry.  The
 * xHCI host policy may prevent U1 or U2 from being enabled.
 *
 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
 * until the lpm_disable_count drops to zero.  Caller must own the
 * bandwidth_mutex.
 */
void usb_enable_lpm(struct usb_device *udev)
{
	struct usb_hcd *hcd;

	if (!udev || !udev->parent ||
			udev->speed != USB_SPEED_SUPER ||
			!udev->lpm_capable)
		return;

	udev->lpm_disable_count--;
	hcd = bus_to_hcd(udev->bus);
	/* Double check that we can both enable and disable LPM.
	 * Device must be configured to accept set feature U1/U2 timeout.
	 */
	if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
			!hcd->driver->disable_usb3_lpm_timeout)
		return;

	if (udev->lpm_disable_count > 0)
		return;

	usb_enable_link_state(hcd, udev, USB3_LPM_U1);
	usb_enable_link_state(hcd, udev, USB3_LPM_U2);
}
EXPORT_SYMBOL_GPL(usb_enable_lpm);

/* Grab the bandwidth_mutex before calling usb_enable_lpm() */
void usb_unlocked_enable_lpm(struct usb_device *udev)
{
	struct usb_hcd *hcd = bus_to_hcd(udev->bus);

	if (!hcd)
		return;

	mutex_lock(hcd->bandwidth_mutex);
	usb_enable_lpm(udev);
	mutex_unlock(hcd->bandwidth_mutex);
}
EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);


A
Alan Stern 已提交
3679 3680
#else	/* CONFIG_PM */

A
Alan Stern 已提交
3681 3682 3683
#define hub_suspend		NULL
#define hub_resume		NULL
#define hub_reset_resume	NULL
3684 3685 3686 3687 3688

int usb_disable_lpm(struct usb_device *udev)
{
	return 0;
}
3689
EXPORT_SYMBOL_GPL(usb_disable_lpm);
3690 3691

void usb_enable_lpm(struct usb_device *udev) { }
3692
EXPORT_SYMBOL_GPL(usb_enable_lpm);
3693 3694 3695 3696 3697

int usb_unlocked_disable_lpm(struct usb_device *udev)
{
	return 0;
}
3698
EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3699 3700

void usb_unlocked_enable_lpm(struct usb_device *udev) { }
3701
EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3702 3703 3704 3705 3706 3707 3708 3709 3710

int usb_disable_ltm(struct usb_device *udev)
{
	return 0;
}
EXPORT_SYMBOL_GPL(usb_disable_ltm);

void usb_enable_ltm(struct usb_device *udev) { }
EXPORT_SYMBOL_GPL(usb_enable_ltm);
A
Alan Stern 已提交
3711 3712
#endif

L
Linus Torvalds 已提交
3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769

/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
 *
 * Between connect detection and reset signaling there must be a delay
 * of 100ms at least for debounce and power-settling.  The corresponding
 * timer shall restart whenever the downstream port detects a disconnect.
 * 
 * Apparently there are some bluetooth and irda-dongles and a number of
 * low-speed devices for which this debounce period may last over a second.
 * Not covered by the spec - but easy to deal with.
 *
 * This implementation uses a 1500ms total debounce timeout; if the
 * connection isn't stable by then it returns -ETIMEDOUT.  It checks
 * every 25ms for transient disconnects.  When the port status has been
 * unchanged for 100ms it returns the port status.
 */
static int hub_port_debounce(struct usb_hub *hub, int port1)
{
	int ret;
	int total_time, stable_time = 0;
	u16 portchange, portstatus;
	unsigned connection = 0xffff;

	for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
		ret = hub_port_status(hub, port1, &portstatus, &portchange);
		if (ret < 0)
			return ret;

		if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
		     (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
			stable_time += HUB_DEBOUNCE_STEP;
			if (stable_time >= HUB_DEBOUNCE_STABLE)
				break;
		} else {
			stable_time = 0;
			connection = portstatus & USB_PORT_STAT_CONNECTION;
		}

		if (portchange & USB_PORT_STAT_C_CONNECTION) {
			clear_port_feature(hub->hdev, port1,
					USB_PORT_FEAT_C_CONNECTION);
		}

		if (total_time >= HUB_DEBOUNCE_TIMEOUT)
			break;
		msleep(HUB_DEBOUNCE_STEP);
	}

	dev_dbg (hub->intfdev,
		"debounce: port %d: total %dms stable %dms status 0x%x\n",
		port1, total_time, stable_time, portstatus);

	if (stable_time < HUB_DEBOUNCE_STABLE)
		return -ETIMEDOUT;
	return portstatus;
}

3770
void usb_ep0_reinit(struct usb_device *udev)
L
Linus Torvalds 已提交
3771
{
3772 3773
	usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
	usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
3774
	usb_enable_endpoint(udev, &udev->ep0, true);
L
Linus Torvalds 已提交
3775
}
3776
EXPORT_SYMBOL_GPL(usb_ep0_reinit);
L
Linus Torvalds 已提交
3777 3778 3779 3780

#define usb_sndaddr0pipe()	(PIPE_CONTROL << 30)
#define usb_rcvaddr0pipe()	((PIPE_CONTROL << 30) | USB_DIR_IN)

3781
static int hub_set_address(struct usb_device *udev, int devnum)
L
Linus Torvalds 已提交
3782 3783
{
	int retval;
3784
	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
L
Linus Torvalds 已提交
3785

3786 3787 3788 3789 3790
	/*
	 * The host controller will choose the device address,
	 * instead of the core having chosen it earlier
	 */
	if (!hcd->driver->address_device && devnum <= 1)
L
Linus Torvalds 已提交
3791 3792 3793 3794 3795
		return -EINVAL;
	if (udev->state == USB_STATE_ADDRESS)
		return 0;
	if (udev->state != USB_STATE_DEFAULT)
		return -EINVAL;
3796
	if (hcd->driver->address_device)
3797
		retval = hcd->driver->address_device(hcd, udev);
3798
	else
3799 3800 3801
		retval = usb_control_msg(udev, usb_sndaddr0pipe(),
				USB_REQ_SET_ADDRESS, 0, devnum, 0,
				NULL, 0, USB_CTRL_SET_TIMEOUT);
L
Linus Torvalds 已提交
3802
	if (retval == 0) {
3803
		update_devnum(udev, devnum);
3804
		/* Device now using proper address. */
L
Linus Torvalds 已提交
3805
		usb_set_device_state(udev, USB_STATE_ADDRESS);
3806
		usb_ep0_reinit(udev);
L
Linus Torvalds 已提交
3807 3808 3809 3810 3811 3812 3813 3814 3815
	}
	return retval;
}

/* Reset device, (re)assign address, get device descriptor.
 * Device connection must be stable, no more debouncing needed.
 * Returns device in USB_STATE_ADDRESS, except on error.
 *
 * If this is called for an already-existing device (as part of
3816
 * usb_reset_and_verify_device), the caller must own the device lock.  For a
L
Linus Torvalds 已提交
3817 3818 3819 3820 3821 3822 3823
 * newly detected device that is not accessible through any global
 * pointers, it's not necessary to lock the device.
 */
static int
hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
		int retry_counter)
{
3824
	static DEFINE_MUTEX(usb_address0_mutex);
L
Linus Torvalds 已提交
3825 3826

	struct usb_device	*hdev = hub->hdev;
3827
	struct usb_hcd		*hcd = bus_to_hcd(hdev->bus);
L
Linus Torvalds 已提交
3828 3829 3830
	int			i, j, retval;
	unsigned		delay = HUB_SHORT_RESET_TIME;
	enum usb_device_speed	oldspeed = udev->speed;
3831
	const char		*speed;
3832
	int			devnum = udev->devnum;
L
Linus Torvalds 已提交
3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847

	/* root hub ports have a slightly longer reset period
	 * (from USB 2.0 spec, section 7.1.7.5)
	 */
	if (!hdev->parent) {
		delay = HUB_ROOT_RESET_TIME;
		if (port1 == hdev->bus->otg_port)
			hdev->bus->b_hnp_enable = 0;
	}

	/* Some low speed devices have problems with the quick delay, so */
	/*  be a bit pessimistic with those devices. RHbug #23670 */
	if (oldspeed == USB_SPEED_LOW)
		delay = HUB_LONG_RESET_TIME;

3848
	mutex_lock(&usb_address0_mutex);
L
Linus Torvalds 已提交
3849

3850 3851
	/* Reset the device; full speed may morph to high speed */
	/* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
A
Andiry Xu 已提交
3852
	retval = hub_port_reset(hub, port1, udev, delay, false);
3853 3854 3855 3856
	if (retval < 0)		/* error or disconnect */
		goto fail;
	/* success, speed is known */

L
Linus Torvalds 已提交
3857 3858 3859 3860 3861 3862 3863
	retval = -ENODEV;

	if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
		dev_dbg(&udev->dev, "device reset changed speed!\n");
		goto fail;
	}
	oldspeed = udev->speed;
3864

L
Linus Torvalds 已提交
3865 3866
	/* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
	 * it's fixed size except for full speed devices.
3867 3868
	 * For Wireless USB devices, ep0 max packet is always 512 (tho
	 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
L
Linus Torvalds 已提交
3869 3870
	 */
	switch (udev->speed) {
3871
	case USB_SPEED_SUPER:
3872
	case USB_SPEED_WIRELESS:	/* fixed at 512 */
3873
		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
3874
		break;
L
Linus Torvalds 已提交
3875
	case USB_SPEED_HIGH:		/* fixed at 64 */
3876
		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
L
Linus Torvalds 已提交
3877 3878 3879 3880 3881 3882
		break;
	case USB_SPEED_FULL:		/* 8, 16, 32, or 64 */
		/* to determine the ep0 maxpacket size, try to read
		 * the device descriptor to get bMaxPacketSize0 and
		 * then correct our initial guess.
		 */
3883
		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
L
Linus Torvalds 已提交
3884 3885
		break;
	case USB_SPEED_LOW:		/* fixed at 8 */
3886
		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
L
Linus Torvalds 已提交
3887 3888 3889 3890
		break;
	default:
		goto fail;
	}
3891 3892 3893 3894 3895 3896

	if (udev->speed == USB_SPEED_WIRELESS)
		speed = "variable speed Wireless";
	else
		speed = usb_speed_string(udev->speed);

3897 3898
	if (udev->speed != USB_SPEED_SUPER)
		dev_info(&udev->dev,
3899 3900
				"%s %s USB device number %d using %s\n",
				(udev->config) ? "reset" : "new", speed,
3901
				devnum, udev->bus->controller->driver->name);
L
Linus Torvalds 已提交
3902 3903 3904 3905 3906 3907 3908

	/* Set up TT records, if needed  */
	if (hdev->tt) {
		udev->tt = hdev->tt;
		udev->ttport = hdev->ttport;
	} else if (udev->speed != USB_SPEED_HIGH
			&& hdev->speed == USB_SPEED_HIGH) {
3909 3910 3911 3912 3913
		if (!hub->tt.hub) {
			dev_err(&udev->dev, "parent hub has no TT\n");
			retval = -EINVAL;
			goto fail;
		}
L
Linus Torvalds 已提交
3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930
		udev->tt = &hub->tt;
		udev->ttport = port1;
	}
 
	/* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
	 * Because device hardware and firmware is sometimes buggy in
	 * this area, and this is how Linux has done it for ages.
	 * Change it cautiously.
	 *
	 * NOTE:  If USE_NEW_SCHEME() is true we will start by issuing
	 * a 64-byte GET_DESCRIPTOR request.  This is what Windows does,
	 * so it may help with some non-standards-compliant devices.
	 * Otherwise we start with SET_ADDRESS and then try to read the
	 * first 8 bytes of the device descriptor to get the ep0 maxpacket
	 * value.
	 */
	for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
3931
		if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
L
Linus Torvalds 已提交
3932 3933 3934 3935 3936 3937 3938 3939 3940 3941
			struct usb_device_descriptor *buf;
			int r = 0;

#define GET_DESCRIPTOR_BUFSIZE	64
			buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
			if (!buf) {
				retval = -ENOMEM;
				continue;
			}

3942 3943 3944
			/* Retry on all errors; some devices are flakey.
			 * 255 is for WUSB devices, we actually need to use
			 * 512 (WUSB1.0[4.8.1]).
L
Linus Torvalds 已提交
3945 3946 3947 3948 3949 3950 3951
			 */
			for (j = 0; j < 3; ++j) {
				buf->bMaxPacketSize0 = 0;
				r = usb_control_msg(udev, usb_rcvaddr0pipe(),
					USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
					USB_DT_DEVICE << 8, 0,
					buf, GET_DESCRIPTOR_BUFSIZE,
3952
					initial_descriptor_timeout);
L
Linus Torvalds 已提交
3953
				switch (buf->bMaxPacketSize0) {
3954
				case 8: case 16: case 32: case 64: case 255:
L
Linus Torvalds 已提交
3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972
					if (buf->bDescriptorType ==
							USB_DT_DEVICE) {
						r = 0;
						break;
					}
					/* FALL THROUGH */
				default:
					if (r == 0)
						r = -EPROTO;
					break;
				}
				if (r == 0)
					break;
			}
			udev->descriptor.bMaxPacketSize0 =
					buf->bMaxPacketSize0;
			kfree(buf);

A
Andiry Xu 已提交
3973
			retval = hub_port_reset(hub, port1, udev, delay, false);
L
Linus Torvalds 已提交
3974 3975 3976 3977 3978 3979 3980 3981 3982
			if (retval < 0)		/* error or disconnect */
				goto fail;
			if (oldspeed != udev->speed) {
				dev_dbg(&udev->dev,
					"device reset changed speed!\n");
				retval = -ENODEV;
				goto fail;
			}
			if (r) {
3983 3984 3985
				dev_err(&udev->dev,
					"device descriptor read/64, error %d\n",
					r);
L
Linus Torvalds 已提交
3986 3987 3988 3989 3990 3991
				retval = -EMSGSIZE;
				continue;
			}
#undef GET_DESCRIPTOR_BUFSIZE
		}

3992 3993 3994 3995 3996
 		/*
 		 * If device is WUSB, we already assigned an
 		 * unauthorized address in the Connect Ack sequence;
 		 * authorization will assign the final address.
 		 */
3997
		if (udev->wusb == 0) {
3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009
			for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
				retval = hub_set_address(udev, devnum);
				if (retval >= 0)
					break;
				msleep(200);
			}
			if (retval < 0) {
				dev_err(&udev->dev,
					"device not accepting address %d, error %d\n",
					devnum, retval);
				goto fail;
			}
4010 4011 4012
			if (udev->speed == USB_SPEED_SUPER) {
				devnum = udev->devnum;
				dev_info(&udev->dev,
4013
						"%s SuperSpeed USB device number %d using %s\n",
4014
						(udev->config) ? "reset" : "new",
4015
						devnum, udev->bus->controller->driver->name);
4016
			}
4017 4018 4019 4020 4021 4022

			/* cope with hardware quirkiness:
			 *  - let SET_ADDRESS settle, some device hardware wants it
			 *  - read ep0 maxpacket even for high and low speed,
			 */
			msleep(10);
4023
			if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
L
Linus Torvalds 已提交
4024
				break;
4025
  		}
L
Linus Torvalds 已提交
4026 4027 4028

		retval = usb_get_device_descriptor(udev, 8);
		if (retval < 8) {
4029 4030 4031
			dev_err(&udev->dev,
					"device descriptor read/8, error %d\n",
					retval);
L
Linus Torvalds 已提交
4032 4033 4034 4035 4036 4037 4038 4039 4040 4041
			if (retval >= 0)
				retval = -EMSGSIZE;
		} else {
			retval = 0;
			break;
		}
	}
	if (retval)
		goto fail;

4042
	if (hcd->phy && !hdev->parent)
4043
		usb_phy_notify_connect(hcd->phy, udev->speed);
4044

4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060
	/*
	 * Some superspeed devices have finished the link training process
	 * and attached to a superspeed hub port, but the device descriptor
	 * got from those devices show they aren't superspeed devices. Warm
	 * reset the port attached by the devices can fix them.
	 */
	if ((udev->speed == USB_SPEED_SUPER) &&
			(le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
		dev_err(&udev->dev, "got a wrong device descriptor, "
				"warm reset device\n");
		hub_port_reset(hub, port1, udev,
				HUB_BH_RESET_TIME, true);
		retval = -EINVAL;
		goto fail;
	}

4061 4062 4063 4064 4065
	if (udev->descriptor.bMaxPacketSize0 == 0xff ||
			udev->speed == USB_SPEED_SUPER)
		i = 512;
	else
		i = udev->descriptor.bMaxPacketSize0;
4066
	if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4067
		if (udev->speed == USB_SPEED_LOW ||
L
Linus Torvalds 已提交
4068
				!(i == 8 || i == 16 || i == 32 || i == 64)) {
4069
			dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
L
Linus Torvalds 已提交
4070 4071 4072
			retval = -EMSGSIZE;
			goto fail;
		}
4073 4074 4075 4076
		if (udev->speed == USB_SPEED_FULL)
			dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
		else
			dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
L
Linus Torvalds 已提交
4077
		udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4078
		usb_ep0_reinit(udev);
L
Linus Torvalds 已提交
4079 4080 4081 4082
	}
  
	retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
	if (retval < (signed)sizeof(udev->descriptor)) {
4083 4084
		dev_err(&udev->dev, "device descriptor read/all, error %d\n",
			retval);
L
Linus Torvalds 已提交
4085 4086 4087 4088 4089
		if (retval >= 0)
			retval = -ENOMSG;
		goto fail;
	}

4090 4091
	if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
		retval = usb_get_bos_descriptor(udev);
4092
		if (!retval) {
4093
			udev->lpm_capable = usb_device_supports_lpm(udev);
4094 4095
			usb_set_lpm_parameters(udev);
		}
4096
	}
A
Andiry Xu 已提交
4097

L
Linus Torvalds 已提交
4098
	retval = 0;
4099 4100 4101
	/* notify HCD that we have a device connected and addressed */
	if (hcd->driver->update_device)
		hcd->driver->update_device(hcd, udev);
L
Linus Torvalds 已提交
4102
fail:
4103
	if (retval) {
L
Linus Torvalds 已提交
4104
		hub_port_disable(hub, port1, 0);
4105
		update_devnum(udev, devnum);	/* for disconnect processing */
4106
	}
4107
	mutex_unlock(&usb_address0_mutex);
L
Linus Torvalds 已提交
4108 4109 4110 4111 4112 4113 4114 4115 4116
	return retval;
}

static void
check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
{
	struct usb_qualifier_descriptor	*qual;
	int				status;

4117
	qual = kmalloc (sizeof *qual, GFP_KERNEL);
L
Linus Torvalds 已提交
4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128
	if (qual == NULL)
		return;

	status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
			qual, sizeof *qual);
	if (status == sizeof *qual) {
		dev_info(&udev->dev, "not running at top speed; "
			"connect to a high speed hub\n");
		/* hub LEDs are probably harder to miss than syslog */
		if (hub->has_indicators) {
			hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
D
David Howells 已提交
4129
			schedule_delayed_work (&hub->leds, 0);
L
Linus Torvalds 已提交
4130 4131
		}
	}
4132
	kfree(qual);
L
Linus Torvalds 已提交
4133 4134 4135 4136 4137 4138 4139
}

static unsigned
hub_power_remaining (struct usb_hub *hub)
{
	struct usb_device *hdev = hub->hdev;
	int remaining;
4140
	int port1;
L
Linus Torvalds 已提交
4141

4142
	if (!hub->limited_power)
L
Linus Torvalds 已提交
4143 4144
		return 0;

4145 4146
	remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
	for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4147
		struct usb_device	*udev = hub->ports[port1 - 1]->child;
4148
		int			delta;
4149
		unsigned		unit_load;
L
Linus Torvalds 已提交
4150 4151 4152

		if (!udev)
			continue;
4153 4154 4155 4156
		if (hub_is_superspeed(udev))
			unit_load = 150;
		else
			unit_load = 100;
L
Linus Torvalds 已提交
4157

4158 4159 4160 4161
		/*
		 * Unconfigured devices may not use more than one unit load,
		 * or 8mA for OTG ports
		 */
L
Linus Torvalds 已提交
4162
		if (udev->actconfig)
4163
			delta = usb_get_max_power(udev, udev->actconfig);
4164
		else if (port1 != udev->bus->otg_port || hdev->parent)
4165
			delta = unit_load;
L
Linus Torvalds 已提交
4166
		else
4167 4168
			delta = 8;
		if (delta > hub->mA_per_port)
4169 4170 4171
			dev_warn(&udev->dev,
				 "%dmA is over %umA budget for port %d!\n",
				 delta, hub->mA_per_port, port1);
L
Linus Torvalds 已提交
4172 4173 4174
		remaining -= delta;
	}
	if (remaining < 0) {
4175 4176
		dev_warn(hub->intfdev, "%dmA over power budget!\n",
			- remaining);
L
Linus Torvalds 已提交
4177 4178 4179 4180 4181 4182 4183 4184 4185
		remaining = 0;
	}
	return remaining;
}

/* Handle physical or logical connection change events.
 * This routine is called when:
 * 	a port connection-change occurs;
 *	a port enable-change occurs (often caused by EMI);
4186
 *	usb_reset_and_verify_device() encounters changed descriptors (as from
L
Linus Torvalds 已提交
4187 4188 4189 4190 4191 4192 4193 4194
 *		a firmware download)
 * caller already locked the hub
 */
static void hub_port_connect_change(struct usb_hub *hub, int port1,
					u16 portstatus, u16 portchange)
{
	struct usb_device *hdev = hub->hdev;
	struct device *hub_dev = hub->intfdev;
4195
	struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
A
Alan Stern 已提交
4196 4197
	unsigned wHubCharacteristics =
			le16_to_cpu(hub->descriptor->wHubCharacteristics);
4198
	struct usb_device *udev;
L
Linus Torvalds 已提交
4199
	int status, i;
4200
	unsigned unit_load;
A
Alan Stern 已提交
4201

L
Linus Torvalds 已提交
4202 4203
	dev_dbg (hub_dev,
		"port %d, status %04x, change %04x, %s\n",
4204
		port1, portstatus, portchange, portspeed(hub, portstatus));
L
Linus Torvalds 已提交
4205 4206 4207 4208 4209 4210 4211 4212 4213

	if (hub->has_indicators) {
		set_port_led(hub, port1, HUB_LED_AUTO);
		hub->indicator[port1-1] = INDICATOR_AUTO;
	}

#ifdef	CONFIG_USB_OTG
	/* during HNP, don't repeat the debounce */
	if (hdev->bus->is_b_host)
A
Alan Stern 已提交
4214 4215
		portchange &= ~(USB_PORT_STAT_C_CONNECTION |
				USB_PORT_STAT_C_ENABLE);
L
Linus Torvalds 已提交
4216 4217
#endif

4218
	/* Try to resuscitate an existing device */
4219
	udev = hub->ports[port1 - 1]->child;
4220 4221 4222 4223 4224 4225 4226
	if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
			udev->state != USB_STATE_NOTATTACHED) {
		usb_lock_device(udev);
		if (portstatus & USB_PORT_STAT_ENABLE) {
			status = 0;		/* Nothing to do */

#ifdef CONFIG_USB_SUSPEND
4227 4228
		} else if (udev->state == USB_STATE_SUSPENDED &&
				udev->persist_enabled) {
4229 4230 4231
			/* For a suspended device, treat this as a
			 * remote wakeup event.
			 */
4232
			status = usb_remote_wakeup(udev);
4233 4234 4235
#endif

		} else {
4236
			status = -ENODEV;	/* Don't resuscitate */
4237 4238 4239 4240 4241 4242 4243 4244 4245
		}
		usb_unlock_device(udev);

		if (status == 0) {
			clear_bit(port1, hub->change_bits);
			return;
		}
	}

A
Alan Stern 已提交
4246
	/* Disconnect any existing devices under this port */
4247 4248 4249
	if (udev) {
		if (hcd->phy && !hdev->parent &&
				!(portstatus & USB_PORT_STAT_CONNECTION))
4250
			usb_phy_notify_disconnect(hcd->phy, udev->speed);
4251
		usb_disconnect(&hub->ports[port1 - 1]->child);
4252
	}
A
Alan Stern 已提交
4253 4254
	clear_bit(port1, hub->change_bits);

4255 4256 4257 4258 4259 4260 4261
	/* We can forget about a "removed" device when there's a physical
	 * disconnect or the connect status changes.
	 */
	if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
			(portchange & USB_PORT_STAT_C_CONNECTION))
		clear_bit(port1, hub->removed_bits);

4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274
	if (portchange & (USB_PORT_STAT_C_CONNECTION |
				USB_PORT_STAT_C_ENABLE)) {
		status = hub_port_debounce(hub, port1);
		if (status < 0) {
			if (printk_ratelimit())
				dev_err(hub_dev, "connect-debounce failed, "
						"port %d disabled\n", port1);
			portstatus &= ~USB_PORT_STAT_CONNECTION;
		} else {
			portstatus = status;
		}
	}

4275 4276 4277 4278 4279
	/* Return now if debouncing failed or nothing is connected or
	 * the device was "removed".
	 */
	if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
			test_bit(port1, hub->removed_bits)) {
L
Linus Torvalds 已提交
4280 4281

		/* maybe switch power back on (e.g. root hub was reset) */
4282
		if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
4283
				&& !port_is_power_on(hub, portstatus))
L
Linus Torvalds 已提交
4284
			set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4285

L
Linus Torvalds 已提交
4286 4287 4288 4289
		if (portstatus & USB_PORT_STAT_ENABLE)
  			goto done;
		return;
	}
4290 4291 4292 4293
	if (hub_is_superspeed(hub->hdev))
		unit_load = 150;
	else
		unit_load = 100;
L
Linus Torvalds 已提交
4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308

	for (i = 0; i < SET_CONFIG_TRIES; i++) {

		/* reallocate for each attempt, since references
		 * to the previous one can escape in various ways
		 */
		udev = usb_alloc_dev(hdev, hdev->bus, port1);
		if (!udev) {
			dev_err (hub_dev,
				"couldn't allocate port %d usb_device\n",
				port1);
			goto done;
		}

		usb_set_device_state(udev, USB_STATE_POWERED);
4309
 		udev->bus_mA = hub->mA_per_port;
4310
		udev->level = hdev->level + 1;
4311
		udev->wusb = hub_is_wusb(hub);
4312

4313 4314
		/* Only USB 3.0 devices are connected to SuperSpeed hubs. */
		if (hub_is_superspeed(hub->hdev))
4315 4316 4317 4318
			udev->speed = USB_SPEED_SUPER;
		else
			udev->speed = USB_SPEED_UNKNOWN;

4319
		choose_devnum(udev);
4320 4321 4322
		if (udev->devnum <= 0) {
			status = -ENOTCONN;	/* Don't retry */
			goto loop;
4323 4324
		}

4325
		/* reset (non-USB 3.0 devices) and get descriptor */
L
Linus Torvalds 已提交
4326 4327 4328 4329
		status = hub_port_init(hub, udev, port1, i);
		if (status < 0)
			goto loop;

4330 4331 4332 4333
		usb_detect_quirks(udev);
		if (udev->quirks & USB_QUIRK_DELAY_INIT)
			msleep(1000);

L
Linus Torvalds 已提交
4334 4335 4336 4337 4338 4339 4340
		/* consecutive bus-powered hubs aren't reliable; they can
		 * violate the voltage drop budget.  if the new child has
		 * a "powered" LED, users should notice we didn't enable it
		 * (without reading syslog), even without per-port LEDs
		 * on the parent.
		 */
		if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4341
				&& udev->bus_mA <= unit_load) {
L
Linus Torvalds 已提交
4342 4343 4344 4345
			u16	devstat;

			status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
					&devstat);
4346
			if (status < 2) {
L
Linus Torvalds 已提交
4347 4348 4349
				dev_dbg(&udev->dev, "get status %d ?\n", status);
				goto loop_disable;
			}
4350
			le16_to_cpus(&devstat);
L
Linus Torvalds 已提交
4351 4352 4353 4354 4355 4356 4357
			if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
				dev_err(&udev->dev,
					"can't connect bus-powered hub "
					"to this port\n");
				if (hub->has_indicators) {
					hub->indicator[port1-1] =
						INDICATOR_AMBER_BLINK;
D
David Howells 已提交
4358
					schedule_delayed_work (&hub->leds, 0);
L
Linus Torvalds 已提交
4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370
				}
				status = -ENOTCONN;	/* Don't retry */
				goto loop_disable;
			}
		}
 
		/* check for devices running slower than they could */
		if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
				&& udev->speed == USB_SPEED_FULL
				&& highspeed_hubs != 0)
			check_highspeed (hub, udev, port1);

4371
		/* Store the parent's children[] pointer.  At this point
L
Linus Torvalds 已提交
4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384
		 * udev becomes globally accessible, although presumably
		 * no one will look at it until hdev is unlocked.
		 */
		status = 0;

		/* We mustn't add new devices if the parent hub has
		 * been disconnected; we would race with the
		 * recursively_mark_NOTATTACHED() routine.
		 */
		spin_lock_irq(&device_state_lock);
		if (hdev->state == USB_STATE_NOTATTACHED)
			status = -ENOTCONN;
		else
4385
			hub->ports[port1 - 1]->child = udev;
L
Linus Torvalds 已提交
4386 4387 4388 4389 4390 4391 4392
		spin_unlock_irq(&device_state_lock);

		/* Run it through the hoops (find a driver, etc) */
		if (!status) {
			status = usb_new_device(udev);
			if (status) {
				spin_lock_irq(&device_state_lock);
4393
				hub->ports[port1 - 1]->child = NULL;
L
Linus Torvalds 已提交
4394 4395 4396 4397 4398 4399 4400 4401 4402
				spin_unlock_irq(&device_state_lock);
			}
		}

		if (status)
			goto loop_disable;

		status = hub_power_remaining(hub);
		if (status)
4403
			dev_dbg(hub_dev, "%dmA power budget left\n", status);
L
Linus Torvalds 已提交
4404 4405 4406 4407 4408 4409

		return;

loop_disable:
		hub_port_disable(hub, port1, 1);
loop:
4410
		usb_ep0_reinit(udev);
4411
		release_devnum(udev);
4412
		hub_free_dev(udev);
L
Linus Torvalds 已提交
4413
		usb_put_dev(udev);
4414
		if ((status == -ENOTCONN) || (status == -ENOTSUPP))
L
Linus Torvalds 已提交
4415 4416
			break;
	}
4417 4418 4419 4420 4421
	if (hub->hdev->parent ||
			!hcd->driver->port_handed_over ||
			!(hcd->driver->port_handed_over)(hcd, port1))
		dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
				port1);
L
Linus Torvalds 已提交
4422 4423 4424
 
done:
	hub_port_disable(hub, port1, 1);
4425 4426
	if (hcd->driver->relinquish_port && !hub->hdev->parent)
		hcd->driver->relinquish_port(hcd, port1);
L
Linus Torvalds 已提交
4427 4428
}

4429 4430
/* Returns 1 if there was a remote wakeup and a connect status change. */
static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4431
		u16 portstatus, u16 portchange)
4432 4433 4434 4435 4436 4437 4438
{
	struct usb_device *hdev;
	struct usb_device *udev;
	int connect_change = 0;
	int ret;

	hdev = hub->hdev;
4439
	udev = hub->ports[port - 1]->child;
4440 4441 4442 4443 4444 4445
	if (!hub_is_superspeed(hdev)) {
		if (!(portchange & USB_PORT_STAT_C_SUSPEND))
			return 0;
		clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
	} else {
		if (!udev || udev->state != USB_STATE_SUSPENDED ||
4446 4447
				 (portstatus & USB_PORT_STAT_LINK_STATE) !=
				 USB_SS_PORT_LS_U0)
4448 4449 4450
			return 0;
	}

4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468
	if (udev) {
		/* TRSMRCY = 10 msec */
		msleep(10);

		usb_lock_device(udev);
		ret = usb_remote_wakeup(udev);
		usb_unlock_device(udev);
		if (ret < 0)
			connect_change = 1;
	} else {
		ret = -ENODEV;
		hub_port_disable(hub, port, 1);
	}
	dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
			port, ret);
	return connect_change;
}

L
Linus Torvalds 已提交
4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480
static void hub_events(void)
{
	struct list_head *tmp;
	struct usb_device *hdev;
	struct usb_interface *intf;
	struct usb_hub *hub;
	struct device *hub_dev;
	u16 hubstatus;
	u16 hubchange;
	u16 portstatus;
	u16 portchange;
	int i, ret;
4481
	int connect_change, wakeup_change;
L
Linus Torvalds 已提交
4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501

	/*
	 *  We restart the list every time to avoid a deadlock with
	 * deleting hubs downstream from this one. This should be
	 * safe since we delete the hub from the event list.
	 * Not the most efficient, but avoids deadlocks.
	 */
	while (1) {

		/* Grab the first entry at the beginning of the list */
		spin_lock_irq(&hub_event_lock);
		if (list_empty(&hub_event_list)) {
			spin_unlock_irq(&hub_event_lock);
			break;
		}

		tmp = hub_event_list.next;
		list_del_init(tmp);

		hub = list_entry(tmp, struct usb_hub, event_list);
4502 4503
		kref_get(&hub->kref);
		spin_unlock_irq(&hub_event_lock);
L
Linus Torvalds 已提交
4504

4505 4506 4507
		hdev = hub->hdev;
		hub_dev = hub->intfdev;
		intf = to_usb_interface(hub_dev);
4508
		dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
L
Linus Torvalds 已提交
4509 4510 4511 4512 4513
				hdev->state, hub->descriptor
					? hub->descriptor->bNbrPorts
					: 0,
				/* NOTE: expects max 15 ports... */
				(u16) hub->change_bits[0],
4514
				(u16) hub->event_bits[0]);
L
Linus Torvalds 已提交
4515 4516 4517

		/* Lock the device, then check to see if we were
		 * disconnected while waiting for the lock to succeed. */
4518
		usb_lock_device(hdev);
4519
		if (unlikely(hub->disconnected))
4520
			goto loop_disconnected;
L
Linus Torvalds 已提交
4521 4522 4523

		/* If the hub has died, clean up after it */
		if (hdev->state == USB_STATE_NOTATTACHED) {
4524
			hub->error = -ENODEV;
4525
			hub_quiesce(hub, HUB_DISCONNECT);
L
Linus Torvalds 已提交
4526 4527 4528
			goto loop;
		}

4529 4530 4531 4532 4533 4534
		/* Autoresume */
		ret = usb_autopm_get_interface(intf);
		if (ret) {
			dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
			goto loop;
		}
4535

4536
		/* If this is an inactive hub, do nothing */
L
Linus Torvalds 已提交
4537
		if (hub->quiescing)
4538
			goto loop_autopm;
L
Linus Torvalds 已提交
4539 4540 4541 4542 4543

		if (hub->error) {
			dev_dbg (hub_dev, "resetting for error %d\n",
				hub->error);

4544
			ret = usb_reset_device(hdev);
L
Linus Torvalds 已提交
4545 4546 4547
			if (ret) {
				dev_dbg (hub_dev,
					"error resetting hub: %d\n", ret);
4548
				goto loop_autopm;
L
Linus Torvalds 已提交
4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559
			}

			hub->nerrors = 0;
			hub->error = 0;
		}

		/* deal with port status changes */
		for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
			if (test_bit(i, hub->busy_bits))
				continue;
			connect_change = test_bit(i, hub->change_bits);
4560
			wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
L
Linus Torvalds 已提交
4561
			if (!test_and_clear_bit(i, hub->event_bits) &&
4562
					!connect_change && !wakeup_change)
L
Linus Torvalds 已提交
4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592
				continue;

			ret = hub_port_status(hub, i,
					&portstatus, &portchange);
			if (ret < 0)
				continue;

			if (portchange & USB_PORT_STAT_C_CONNECTION) {
				clear_port_feature(hdev, i,
					USB_PORT_FEAT_C_CONNECTION);
				connect_change = 1;
			}

			if (portchange & USB_PORT_STAT_C_ENABLE) {
				if (!connect_change)
					dev_dbg (hub_dev,
						"port %d enable change, "
						"status %08x\n",
						i, portstatus);
				clear_port_feature(hdev, i,
					USB_PORT_FEAT_C_ENABLE);

				/*
				 * EM interference sometimes causes badly
				 * shielded USB devices to be shutdown by
				 * the hub, this hack enables them again.
				 * Works at least with mouse driver. 
				 */
				if (!(portstatus & USB_PORT_STAT_ENABLE)
				    && !connect_change
4593
				    && hub->ports[i - 1]->child) {
L
Linus Torvalds 已提交
4594 4595 4596 4597 4598 4599 4600 4601 4602
					dev_err (hub_dev,
					    "port %i "
					    "disabled by hub (EMI?), "
					    "re-enabling...\n",
						i);
					connect_change = 1;
				}
			}

4603 4604
			if (hub_handle_remote_wakeup(hub, i,
						portstatus, portchange))
4605
				connect_change = 1;
4606

L
Linus Torvalds 已提交
4607
			if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4608 4609 4610 4611 4612
				u16 status = 0;
				u16 unused;

				dev_dbg(hub_dev, "over-current change on port "
					"%d\n", i);
L
Linus Torvalds 已提交
4613 4614
				clear_port_feature(hdev, i,
					USB_PORT_FEAT_C_OVER_CURRENT);
4615
				msleep(100);	/* Cool down */
4616
				hub_power_on(hub, true);
4617 4618 4619 4620
				hub_port_status(hub, i, &status, &unused);
				if (status & USB_PORT_STAT_OVERCURRENT)
					dev_err(hub_dev, "over-current "
						"condition on port %d\n", i);
L
Linus Torvalds 已提交
4621 4622 4623 4624 4625 4626 4627 4628 4629
			}

			if (portchange & USB_PORT_STAT_C_RESET) {
				dev_dbg (hub_dev,
					"reset change on port %d\n",
					i);
				clear_port_feature(hdev, i,
					USB_PORT_FEAT_C_RESET);
			}
4630 4631 4632 4633 4634 4635 4636 4637
			if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
					hub_is_superspeed(hub->hdev)) {
				dev_dbg(hub_dev,
					"warm reset change on port %d\n",
					i);
				clear_port_feature(hdev, i,
					USB_PORT_FEAT_C_BH_PORT_RESET);
			}
J
John Youn 已提交
4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648
			if (portchange & USB_PORT_STAT_C_LINK_STATE) {
				clear_port_feature(hub->hdev, i,
						USB_PORT_FEAT_C_PORT_LINK_STATE);
			}
			if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
				dev_warn(hub_dev,
					"config error on port %d\n",
					i);
				clear_port_feature(hub->hdev, i,
						USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
			}
L
Linus Torvalds 已提交
4649

4650 4651 4652
			/* Warm reset a USB3 protocol port if it's in
			 * SS.Inactive state.
			 */
4653
			if (hub_port_warm_reset_required(hub, portstatus)) {
4654
				int status;
4655 4656
				struct usb_device *udev =
					hub->ports[i - 1]->child;
4657

4658
				dev_dbg(hub_dev, "warm reset port %d\n", i);
4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669
				if (!udev) {
					status = hub_port_reset(hub, i,
							NULL, HUB_BH_RESET_TIME,
							true);
					if (status < 0)
						hub_port_disable(hub, i, 1);
				} else {
					usb_lock_device(udev);
					status = usb_reset_device(udev);
					usb_unlock_device(udev);
				}
4670
				connect_change = 0;
4671 4672
			}

L
Linus Torvalds 已提交
4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686
			if (connect_change)
				hub_port_connect_change(hub, i,
						portstatus, portchange);
		} /* end for i */

		/* deal with hub status changes */
		if (test_and_clear_bit(0, hub->event_bits) == 0)
			;	/* do nothing */
		else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
			dev_err (hub_dev, "get_hub_status failed\n");
		else {
			if (hubchange & HUB_CHANGE_LOCAL_POWER) {
				dev_dbg (hub_dev, "power change\n");
				clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
4687 4688 4689
				if (hubstatus & HUB_STATUS_LOCAL_POWER)
					/* FIXME: Is this always true? */
					hub->limited_power = 1;
4690 4691
				else
					hub->limited_power = 0;
L
Linus Torvalds 已提交
4692 4693
			}
			if (hubchange & HUB_CHANGE_OVERCURRENT) {
4694 4695 4696 4697
				u16 status = 0;
				u16 unused;

				dev_dbg(hub_dev, "over-current change\n");
L
Linus Torvalds 已提交
4698
				clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
4699
				msleep(500);	/* Cool down */
4700
                        	hub_power_on(hub, true);
4701 4702 4703 4704
				hub_hub_status(hub, &status, &unused);
				if (status & HUB_STATUS_OVERCURRENT)
					dev_err(hub_dev, "over-current "
						"condition\n");
L
Linus Torvalds 已提交
4705 4706 4707
			}
		}

4708 4709 4710 4711 4712 4713 4714 4715
 loop_autopm:
		/* Balance the usb_autopm_get_interface() above */
		usb_autopm_put_interface_no_suspend(intf);
 loop:
		/* Balance the usb_autopm_get_interface_no_resume() in
		 * kick_khubd() and allow autosuspend.
		 */
		usb_autopm_put_interface(intf);
4716
 loop_disconnected:
L
Linus Torvalds 已提交
4717
		usb_unlock_device(hdev);
4718
		kref_put(&hub->kref, hub_release);
L
Linus Torvalds 已提交
4719 4720 4721 4722 4723 4724

        } /* end while (1) */
}

static int hub_thread(void *__unused)
{
4725 4726 4727 4728 4729
	/* khubd needs to be freezable to avoid intefering with USB-PERSIST
	 * port handover.  Otherwise it might see that a full-speed device
	 * was gone before the EHCI controller had handed its port over to
	 * the companion full-speed controller.
	 */
4730
	set_freezable();
4731

L
Linus Torvalds 已提交
4732 4733
	do {
		hub_events();
4734
		wait_event_freezable(khubd_wait,
4735 4736 4737
				!list_empty(&hub_event_list) ||
				kthread_should_stop());
	} while (!kthread_should_stop() || !list_empty(&hub_event_list));
L
Linus Torvalds 已提交
4738

4739 4740
	pr_debug("%s: khubd exiting\n", usbcore_name);
	return 0;
L
Linus Torvalds 已提交
4741 4742
}

4743
static const struct usb_device_id hub_id_table[] = {
4744 4745 4746 4747 4748
    { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
	           | USB_DEVICE_ID_MATCH_INT_CLASS,
      .idVendor = USB_VENDOR_GENESYS_LOGIC,
      .bInterfaceClass = USB_CLASS_HUB,
      .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
L
Linus Torvalds 已提交
4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763
    { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
      .bDeviceClass = USB_CLASS_HUB},
    { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
      .bInterfaceClass = USB_CLASS_HUB},
    { }						/* Terminating entry */
};

MODULE_DEVICE_TABLE (usb, hub_id_table);

static struct usb_driver hub_driver = {
	.name =		"hub",
	.probe =	hub_probe,
	.disconnect =	hub_disconnect,
	.suspend =	hub_suspend,
	.resume =	hub_resume,
A
Alan Stern 已提交
4764
	.reset_resume =	hub_reset_resume,
4765 4766
	.pre_reset =	hub_pre_reset,
	.post_reset =	hub_post_reset,
4767
	.unlocked_ioctl = hub_ioctl,
L
Linus Torvalds 已提交
4768
	.id_table =	hub_id_table,
4769
	.supports_autosuspend =	1,
L
Linus Torvalds 已提交
4770 4771 4772 4773 4774 4775 4776 4777 4778 4779
};

int usb_hub_init(void)
{
	if (usb_register(&hub_driver) < 0) {
		printk(KERN_ERR "%s: can't register hub driver\n",
			usbcore_name);
		return -1;
	}

4780 4781
	khubd_task = kthread_run(hub_thread, NULL, "khubd");
	if (!IS_ERR(khubd_task))
L
Linus Torvalds 已提交
4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792
		return 0;

	/* Fall through if kernel_thread failed */
	usb_deregister(&hub_driver);
	printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);

	return -1;
}

void usb_hub_cleanup(void)
{
4793
	kthread_stop(khubd_task);
L
Linus Torvalds 已提交
4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804

	/*
	 * Hub resources are freed for us by usb_deregister. It calls
	 * usb_driver_purge on every device which in turn calls that
	 * devices disconnect function if it is using this driver.
	 * The hub_disconnect function takes care of releasing the
	 * individual hub resources. -greg
	 */
	usb_deregister(&hub_driver);
} /* usb_hub_cleanup() */

4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827
static int descriptors_changed(struct usb_device *udev,
		struct usb_device_descriptor *old_device_descriptor)
{
	int		changed = 0;
	unsigned	index;
	unsigned	serial_len = 0;
	unsigned	len;
	unsigned	old_length;
	int		length;
	char		*buf;

	if (memcmp(&udev->descriptor, old_device_descriptor,
			sizeof(*old_device_descriptor)) != 0)
		return 1;

	/* Since the idVendor, idProduct, and bcdDevice values in the
	 * device descriptor haven't changed, we will assume the
	 * Manufacturer and Product strings haven't changed either.
	 * But the SerialNumber string could be different (e.g., a
	 * different flash card of the same brand).
	 */
	if (udev->serial)
		serial_len = strlen(udev->serial) + 1;
L
Linus Torvalds 已提交
4828

4829
	len = serial_len;
L
Linus Torvalds 已提交
4830
	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4831 4832
		old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
		len = max(len, old_length);
L
Linus Torvalds 已提交
4833
	}
4834

O
Oliver Neukum 已提交
4835
	buf = kmalloc(len, GFP_NOIO);
L
Linus Torvalds 已提交
4836 4837 4838 4839 4840 4841
	if (buf == NULL) {
		dev_err(&udev->dev, "no mem to re-read configs after reset\n");
		/* assume the worst */
		return 1;
	}
	for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
4842
		old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
L
Linus Torvalds 已提交
4843 4844
		length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
				old_length);
4845
		if (length != old_length) {
L
Linus Torvalds 已提交
4846 4847
			dev_dbg(&udev->dev, "config index %d, error %d\n",
					index, length);
4848
			changed = 1;
L
Linus Torvalds 已提交
4849 4850 4851 4852 4853
			break;
		}
		if (memcmp (buf, udev->rawdescriptors[index], old_length)
				!= 0) {
			dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
4854 4855 4856 4857
				index,
				((struct usb_config_descriptor *) buf)->
					bConfigurationValue);
			changed = 1;
L
Linus Torvalds 已提交
4858 4859 4860
			break;
		}
	}
4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874

	if (!changed && serial_len) {
		length = usb_string(udev, udev->descriptor.iSerialNumber,
				buf, serial_len);
		if (length + 1 != serial_len) {
			dev_dbg(&udev->dev, "serial string error %d\n",
					length);
			changed = 1;
		} else if (memcmp(buf, udev->serial, length) != 0) {
			dev_dbg(&udev->dev, "serial string changed\n");
			changed = 1;
		}
	}

L
Linus Torvalds 已提交
4875
	kfree(buf);
4876
	return changed;
L
Linus Torvalds 已提交
4877 4878 4879
}

/**
4880
 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
L
Linus Torvalds 已提交
4881 4882
 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
 *
4883 4884
 * WARNING - don't use this routine to reset a composite device
 * (one with multiple interfaces owned by separate drivers)!
4885
 * Use usb_reset_device() instead.
L
Linus Torvalds 已提交
4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902
 *
 * Do a port reset, reassign the device's address, and establish its
 * former operating configuration.  If the reset fails, or the device's
 * descriptors change from their values before the reset, or the original
 * configuration and altsettings cannot be restored, a flag will be set
 * telling khubd to pretend the device has been disconnected and then
 * re-connected.  All drivers will be unbound, and the device will be
 * re-enumerated and probed all over again.
 *
 * Returns 0 if the reset succeeded, -ENODEV if the device has been
 * flagged for logical disconnection, or some other negative error code
 * if the reset wasn't even attempted.
 *
 * The caller must own the device lock.  For example, it's safe to use
 * this from a driver probe() routine after downloading new firmware.
 * For calls that might not occur during probe(), drivers should lock
 * the device using usb_lock_device_for_reset().
A
Alan Stern 已提交
4903 4904 4905 4906 4907
 *
 * Locking exception: This routine may also be called from within an
 * autoresume handler.  Such usage won't conflict with other tasks
 * holding the device lock because these tasks should always call
 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
L
Linus Torvalds 已提交
4908
 */
4909
static int usb_reset_and_verify_device(struct usb_device *udev)
L
Linus Torvalds 已提交
4910 4911 4912
{
	struct usb_device		*parent_hdev = udev->parent;
	struct usb_hub			*parent_hub;
4913
	struct usb_hcd			*hcd = bus_to_hcd(udev->bus);
L
Linus Torvalds 已提交
4914
	struct usb_device_descriptor	descriptor = udev->descriptor;
4915 4916
	int 				i, ret = 0;
	int				port1 = udev->portnum;
L
Linus Torvalds 已提交
4917 4918 4919 4920 4921 4922 4923 4924 4925

	if (udev->state == USB_STATE_NOTATTACHED ||
			udev->state == USB_STATE_SUSPENDED) {
		dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
				udev->state);
		return -EINVAL;
	}

	if (!parent_hdev) {
4926
		/* this requires hcd-specific logic; see ohci_restart() */
4927
		dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
L
Linus Torvalds 已提交
4928 4929 4930 4931
		return -EISDIR;
	}
	parent_hub = hdev_to_hub(parent_hdev);

4932 4933 4934 4935
	/* Disable LPM and LTM while we reset the device and reinstall the alt
	 * settings.  Device-initiated LPM settings, and system exit latency
	 * settings are cleared when the device is reset, so we have to set
	 * them up again.
4936 4937 4938 4939 4940 4941
	 */
	ret = usb_unlocked_disable_lpm(udev);
	if (ret) {
		dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
		goto re_enumerate;
	}
4942 4943 4944 4945 4946 4947
	ret = usb_disable_ltm(udev);
	if (ret) {
		dev_err(&udev->dev, "%s Failed to disable LTM\n.",
				__func__);
		goto re_enumerate;
	}
4948

L
Linus Torvalds 已提交
4949 4950 4951 4952 4953
	set_bit(port1, parent_hub->busy_bits);
	for (i = 0; i < SET_CONFIG_TRIES; ++i) {

		/* ep0 maxpacket size may change; let the HCD know about it.
		 * Other endpoints will be handled by re-enumeration. */
4954
		usb_ep0_reinit(udev);
L
Linus Torvalds 已提交
4955
		ret = hub_port_init(parent_hub, udev, port1, i);
4956
		if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
L
Linus Torvalds 已提交
4957 4958 4959
			break;
	}
	clear_bit(port1, parent_hub->busy_bits);
4960

L
Linus Torvalds 已提交
4961 4962 4963 4964
	if (ret < 0)
		goto re_enumerate;
 
	/* Device might have changed firmware (DFU or similar) */
4965
	if (descriptors_changed(udev, &descriptor)) {
L
Linus Torvalds 已提交
4966 4967 4968 4969
		dev_info(&udev->dev, "device firmware changed\n");
		udev->descriptor = descriptor;	/* for disconnect() calls */
		goto re_enumerate;
  	}
4970 4971

	/* Restore the device's previous configuration */
L
Linus Torvalds 已提交
4972 4973
	if (!udev->actconfig)
		goto done;
4974

4975
	mutex_lock(hcd->bandwidth_mutex);
4976 4977 4978 4979 4980
	ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
	if (ret < 0) {
		dev_warn(&udev->dev,
				"Busted HC?  Not enough HCD resources for "
				"old configuration.\n");
4981
		mutex_unlock(hcd->bandwidth_mutex);
4982 4983
		goto re_enumerate;
	}
L
Linus Torvalds 已提交
4984 4985 4986 4987 4988 4989 4990 4991
	ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
			USB_REQ_SET_CONFIGURATION, 0,
			udev->actconfig->desc.bConfigurationValue, 0,
			NULL, 0, USB_CTRL_SET_TIMEOUT);
	if (ret < 0) {
		dev_err(&udev->dev,
			"can't restore configuration #%d (error=%d)\n",
			udev->actconfig->desc.bConfigurationValue, ret);
4992
		mutex_unlock(hcd->bandwidth_mutex);
L
Linus Torvalds 已提交
4993 4994
		goto re_enumerate;
  	}
4995
	mutex_unlock(hcd->bandwidth_mutex);
L
Linus Torvalds 已提交
4996 4997
	usb_set_device_state(udev, USB_STATE_CONFIGURED);

4998 4999 5000 5001 5002 5003
	/* Put interfaces back into the same altsettings as before.
	 * Don't bother to send the Set-Interface request for interfaces
	 * that were already in altsetting 0; besides being unnecessary,
	 * many devices can't handle it.  Instead just reset the host-side
	 * endpoint state.
	 */
L
Linus Torvalds 已提交
5004
	for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5005 5006
		struct usb_host_config *config = udev->actconfig;
		struct usb_interface *intf = config->interface[i];
L
Linus Torvalds 已提交
5007 5008 5009
		struct usb_interface_descriptor *desc;

		desc = &intf->cur_altsetting->desc;
5010 5011 5012 5013 5014
		if (desc->bAlternateSetting == 0) {
			usb_disable_interface(udev, intf, true);
			usb_enable_interface(udev, intf, true);
			ret = 0;
		} else {
5015 5016 5017
			/* Let the bandwidth allocation function know that this
			 * device has been reset, and it will have to use
			 * alternate setting 0 as the current alternate setting.
5018
			 */
5019
			intf->resetting_device = 1;
5020 5021
			ret = usb_set_interface(udev, desc->bInterfaceNumber,
					desc->bAlternateSetting);
5022
			intf->resetting_device = 0;
5023
		}
L
Linus Torvalds 已提交
5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034
		if (ret < 0) {
			dev_err(&udev->dev, "failed to restore interface %d "
				"altsetting %d (error=%d)\n",
				desc->bInterfaceNumber,
				desc->bAlternateSetting,
				ret);
			goto re_enumerate;
		}
	}

done:
5035
	/* Now that the alt settings are re-installed, enable LTM and LPM. */
5036
	usb_unlocked_enable_lpm(udev);
5037
	usb_enable_ltm(udev);
L
Linus Torvalds 已提交
5038 5039 5040
	return 0;
 
re_enumerate:
5041
	/* LPM state doesn't matter when we're about to destroy the device. */
L
Linus Torvalds 已提交
5042 5043 5044
	hub_port_logical_disconnect(parent_hub, port1);
	return -ENODEV;
}
5045 5046

/**
5047
 * usb_reset_device - warn interface drivers and perform a USB port reset
5048 5049 5050 5051 5052 5053
 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
 *
 * Warns all drivers bound to registered interfaces (using their pre_reset
 * method), performs the port reset, and then lets the drivers know that
 * the reset is over (using their post_reset method).
 *
5054
 * Return value is the same as for usb_reset_and_verify_device().
5055 5056 5057 5058 5059
 *
 * The caller must own the device lock.  For example, it's safe to use
 * this from a driver probe() routine after downloading new firmware.
 * For calls that might not occur during probe(), drivers should lock
 * the device using usb_lock_device_for_reset().
5060 5061 5062 5063 5064
 *
 * If an interface is currently being probed or disconnected, we assume
 * its driver knows how to handle resets.  For all other interfaces,
 * if the driver doesn't have pre_reset and post_reset methods then
 * we attempt to unbind it and rebind afterward.
5065
 */
5066
int usb_reset_device(struct usb_device *udev)
5067 5068
{
	int ret;
5069
	int i;
5070 5071 5072 5073 5074 5075 5076 5077 5078
	struct usb_host_config *config = udev->actconfig;

	if (udev->state == USB_STATE_NOTATTACHED ||
			udev->state == USB_STATE_SUSPENDED) {
		dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
				udev->state);
		return -EINVAL;
	}

5079
	/* Prevent autosuspend during the reset */
5080
	usb_autoresume_device(udev);
5081

5082 5083
	if (config) {
		for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5084 5085
			struct usb_interface *cintf = config->interface[i];
			struct usb_driver *drv;
5086
			int unbind = 0;
5087 5088

			if (cintf->dev.driver) {
5089
				drv = to_usb_driver(cintf->dev.driver);
5090 5091 5092 5093 5094 5095 5096
				if (drv->pre_reset && drv->post_reset)
					unbind = (drv->pre_reset)(cintf);
				else if (cintf->condition ==
						USB_INTERFACE_BOUND)
					unbind = 1;
				if (unbind)
					usb_forced_unbind_intf(cintf);
5097 5098 5099 5100
			}
		}
	}

5101
	ret = usb_reset_and_verify_device(udev);
5102 5103 5104

	if (config) {
		for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5105 5106
			struct usb_interface *cintf = config->interface[i];
			struct usb_driver *drv;
5107
			int rebind = cintf->needs_binding;
5108

5109
			if (!rebind && cintf->dev.driver) {
5110 5111
				drv = to_usb_driver(cintf->dev.driver);
				if (drv->post_reset)
5112 5113 5114 5115
					rebind = (drv->post_reset)(cintf);
				else if (cintf->condition ==
						USB_INTERFACE_BOUND)
					rebind = 1;
5116
			}
5117
			if (ret == 0 && rebind)
5118
				usb_rebind_intf(cintf);
5119 5120 5121
		}
	}

5122
	usb_autosuspend_device(udev);
5123 5124
	return ret;
}
5125
EXPORT_SYMBOL_GPL(usb_reset_device);
5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168


/**
 * usb_queue_reset_device - Reset a USB device from an atomic context
 * @iface: USB interface belonging to the device to reset
 *
 * This function can be used to reset a USB device from an atomic
 * context, where usb_reset_device() won't work (as it blocks).
 *
 * Doing a reset via this method is functionally equivalent to calling
 * usb_reset_device(), except for the fact that it is delayed to a
 * workqueue. This means that any drivers bound to other interfaces
 * might be unbound, as well as users from usbfs in user space.
 *
 * Corner cases:
 *
 * - Scheduling two resets at the same time from two different drivers
 *   attached to two different interfaces of the same device is
 *   possible; depending on how the driver attached to each interface
 *   handles ->pre_reset(), the second reset might happen or not.
 *
 * - If a driver is unbound and it had a pending reset, the reset will
 *   be cancelled.
 *
 * - This function can be called during .probe() or .disconnect()
 *   times. On return from .disconnect(), any pending resets will be
 *   cancelled.
 *
 * There is no no need to lock/unlock the @reset_ws as schedule_work()
 * does its own.
 *
 * NOTE: We don't do any reference count tracking because it is not
 *     needed. The lifecycle of the work_struct is tied to the
 *     usb_interface. Before destroying the interface we cancel the
 *     work_struct, so the fact that work_struct is queued and or
 *     running means the interface (and thus, the device) exist and
 *     are referenced.
 */
void usb_queue_reset_device(struct usb_interface *iface)
{
	schedule_work(&iface->reset_ws);
}
EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192

/**
 * usb_hub_find_child - Get the pointer of child device
 * attached to the port which is specified by @port1.
 * @hdev: USB device belonging to the usb hub
 * @port1: port num to indicate which port the child device
 *	is attached to.
 *
 * USB drivers call this function to get hub's child device
 * pointer.
 *
 * Return NULL if input param is invalid and
 * child's usb_device pointer if non-NULL.
 */
struct usb_device *usb_hub_find_child(struct usb_device *hdev,
		int port1)
{
	struct usb_hub *hub = hdev_to_hub(hdev);

	if (port1 < 1 || port1 > hdev->maxchild)
		return NULL;
	return hub->ports[port1 - 1]->child;
}
EXPORT_SYMBOL_GPL(usb_hub_find_child);
5193

5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223
/**
 * usb_set_hub_port_connect_type - set hub port connect type.
 * @hdev: USB device belonging to the usb hub
 * @port1: port num of the port
 * @type: connect type of the port
 */
void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
	enum usb_port_connect_type type)
{
	struct usb_hub *hub = hdev_to_hub(hdev);

	hub->ports[port1 - 1]->connect_type = type;
}

/**
 * usb_get_hub_port_connect_type - Get the port's connect type
 * @hdev: USB device belonging to the usb hub
 * @port1: port num of the port
 *
 * Return connect type of the port and if input params are
 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
 */
enum usb_port_connect_type
usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
{
	struct usb_hub *hub = hdev_to_hub(hdev);

	return hub->ports[port1 - 1]->connect_type;
}

5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264
void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
		struct usb_hub_descriptor *desc)
{
	enum usb_port_connect_type connect_type;
	int i;

	if (!hub_is_superspeed(hdev)) {
		for (i = 1; i <= hdev->maxchild; i++) {
			connect_type = usb_get_hub_port_connect_type(hdev, i);

			if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
				u8 mask = 1 << (i%8);

				if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
					dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
						i);
					desc->u.hs.DeviceRemovable[i/8]	|= mask;
				}
			}
		}
	} else {
		u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);

		for (i = 1; i <= hdev->maxchild; i++) {
			connect_type = usb_get_hub_port_connect_type(hdev, i);

			if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
				u16 mask = 1 << i;

				if (!(port_removable & mask)) {
					dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
						i);
					port_removable |= mask;
				}
			}
		}

		desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
	}
}

5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281
#ifdef CONFIG_ACPI
/**
 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
 * @hdev: USB device belonging to the usb hub
 * @port1: port num of the port
 *
 * Return port's acpi handle if successful, NULL if params are
 * invaild.
 */
acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
	int port1)
{
	struct usb_hub *hub = hdev_to_hub(hdev);

	return DEVICE_ACPI_HANDLE(&hub->ports[port1 - 1]->dev);
}
#endif