driver.c 49.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/*
 * drivers/usb/driver.c - most of the driver model stuff for usb
 *
 * (C) Copyright 2005 Greg Kroah-Hartman <gregkh@suse.de>
 *
 * based on drivers/usb/usb.c which had the following copyrights:
 *	(C) Copyright Linus Torvalds 1999
 *	(C) Copyright Johannes Erdfelt 1999-2001
 *	(C) Copyright Andreas Gal 1999
 *	(C) Copyright Gregory P. Smith 1999
 *	(C) Copyright Deti Fliegl 1999 (new USB architecture)
 *	(C) Copyright Randy Dunlap 2000
 *	(C) Copyright David Brownell 2000-2004
 *	(C) Copyright Yggdrasil Computing, Inc. 2000
 *		(usb_device_id matching changes by Adam J. Richter)
 *	(C) Copyright Greg Kroah-Hartman 2002-2003
 *
 * NOTE! This is not actually a driver at all, rather this is
 * just a collection of helper routines that implement the
20 21
 * matching, probing, releasing, suspending and resuming for
 * real drivers.
22 23 24 25
 *
 */

#include <linux/device.h>
26
#include <linux/slab.h>
27
#include <linux/export.h>
28
#include <linux/usb.h>
A
Alan Stern 已提交
29
#include <linux/usb/quirks.h>
30 31
#include <linux/usb/hcd.h>

32 33
#include "usb.h"

A
Alan Stern 已提交
34

35 36 37 38 39 40
#ifdef CONFIG_HOTPLUG

/*
 * Adds a new dynamic USBdevice ID to this driver,
 * and cause the driver to probe for all devices again.
 */
41 42 43
ssize_t usb_store_new_id(struct usb_dynids *dynids,
			 struct device_driver *driver,
			 const char *buf, size_t count)
44 45 46 47
{
	struct usb_dynid *dynid;
	u32 idVendor = 0;
	u32 idProduct = 0;
48
	unsigned int bInterfaceClass = 0;
49
	int fields = 0;
50
	int retval = 0;
51

52 53
	fields = sscanf(buf, "%x %x %x", &idVendor, &idProduct,
					&bInterfaceClass);
54 55 56 57 58 59 60 61 62 63 64
	if (fields < 2)
		return -EINVAL;

	dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
	if (!dynid)
		return -ENOMEM;

	INIT_LIST_HEAD(&dynid->node);
	dynid->id.idVendor = idVendor;
	dynid->id.idProduct = idProduct;
	dynid->id.match_flags = USB_DEVICE_ID_MATCH_DEVICE;
65 66 67 68
	if (fields == 3) {
		dynid->id.bInterfaceClass = (u8)bInterfaceClass;
		dynid->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS;
	}
69

70
	spin_lock(&dynids->lock);
71
	list_add_tail(&dynid->node, &dynids->list);
72
	spin_unlock(&dynids->lock);
73

74
	retval = driver_attach(driver);
75

76 77
	if (retval)
		return retval;
78 79
	return count;
}
80 81 82 83 84 85 86 87 88
EXPORT_SYMBOL_GPL(usb_store_new_id);

static ssize_t store_new_id(struct device_driver *driver,
			    const char *buf, size_t count)
{
	struct usb_driver *usb_drv = to_usb_driver(driver);

	return usb_store_new_id(&usb_drv->dynids, driver, buf, count);
}
89 90
static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);

91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
/**
 * store_remove_id - remove a USB device ID from this driver
 * @driver: target device driver
 * @buf: buffer for scanning device ID data
 * @count: input size
 *
 * Removes a dynamic usb device ID from this driver.
 */
static ssize_t
store_remove_id(struct device_driver *driver, const char *buf, size_t count)
{
	struct usb_dynid *dynid, *n;
	struct usb_driver *usb_driver = to_usb_driver(driver);
	u32 idVendor = 0;
	u32 idProduct = 0;
	int fields = 0;
	int retval = 0;

	fields = sscanf(buf, "%x %x", &idVendor, &idProduct);
	if (fields < 2)
		return -EINVAL;

	spin_lock(&usb_driver->dynids.lock);
	list_for_each_entry_safe(dynid, n, &usb_driver->dynids.list, node) {
		struct usb_device_id *id = &dynid->id;
		if ((id->idVendor == idVendor) &&
		    (id->idProduct == idProduct)) {
			list_del(&dynid->node);
			kfree(dynid);
			retval = 0;
			break;
		}
	}
	spin_unlock(&usb_driver->dynids.lock);

	if (retval)
		return retval;
	return count;
}
static DRIVER_ATTR(remove_id, S_IWUSR, NULL, store_remove_id);

132 133 134 135
static int usb_create_newid_file(struct usb_driver *usb_drv)
{
	int error = 0;

136 137 138
	if (usb_drv->no_dynamic_id)
		goto exit;

139
	if (usb_drv->probe != NULL)
140 141
		error = driver_create_file(&usb_drv->drvwrap.driver,
					   &driver_attr_new_id);
142
exit:
143 144 145
	return error;
}

146 147 148 149 150 151
static void usb_remove_newid_file(struct usb_driver *usb_drv)
{
	if (usb_drv->no_dynamic_id)
		return;

	if (usb_drv->probe != NULL)
152 153
		driver_remove_file(&usb_drv->drvwrap.driver,
				   &driver_attr_new_id);
154 155
}

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
static int
usb_create_removeid_file(struct usb_driver *drv)
{
	int error = 0;
	if (drv->probe != NULL)
		error = driver_create_file(&drv->drvwrap.driver,
				&driver_attr_remove_id);
	return error;
}

static void usb_remove_removeid_file(struct usb_driver *drv)
{
	driver_remove_file(&drv->drvwrap.driver, &driver_attr_remove_id);
}

171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
static void usb_free_dynids(struct usb_driver *usb_drv)
{
	struct usb_dynid *dynid, *n;

	spin_lock(&usb_drv->dynids.lock);
	list_for_each_entry_safe(dynid, n, &usb_drv->dynids.list, node) {
		list_del(&dynid->node);
		kfree(dynid);
	}
	spin_unlock(&usb_drv->dynids.lock);
}
#else
static inline int usb_create_newid_file(struct usb_driver *usb_drv)
{
	return 0;
}

188 189 190 191
static void usb_remove_newid_file(struct usb_driver *usb_drv)
{
}

192 193 194 195 196 197 198 199 200 201
static int
usb_create_removeid_file(struct usb_driver *drv)
{
	return 0;
}

static void usb_remove_removeid_file(struct usb_driver *drv)
{
}

202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
static inline void usb_free_dynids(struct usb_driver *usb_drv)
{
}
#endif

static const struct usb_device_id *usb_match_dynamic_id(struct usb_interface *intf,
							struct usb_driver *drv)
{
	struct usb_dynid *dynid;

	spin_lock(&drv->dynids.lock);
	list_for_each_entry(dynid, &drv->dynids.list, node) {
		if (usb_match_one_id(intf, &dynid->id)) {
			spin_unlock(&drv->dynids.lock);
			return &dynid->id;
		}
	}
	spin_unlock(&drv->dynids.lock);
	return NULL;
}


224 225 226 227
/* called from driver core with dev locked */
static int usb_probe_device(struct device *dev)
{
	struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
228
	struct usb_device *udev = to_usb_device(dev);
229
	int error = 0;
230

231
	dev_dbg(dev, "%s\n", __func__);
232 233 234

	/* TODO: Add real matching code */

235 236 237
	/* The device should always appear to be in use
	 * unless the driver suports autosuspend.
	 */
238 239
	if (!udriver->supports_autosuspend)
		error = usb_autoresume_device(udev);
240

241 242
	if (!error)
		error = udriver->probe(udev);
243 244 245 246 247 248
	return error;
}

/* called from driver core with dev locked */
static int usb_unbind_device(struct device *dev)
{
249
	struct usb_device *udev = to_usb_device(dev);
250 251
	struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);

252 253 254
	udriver->disconnect(udev);
	if (!udriver->supports_autosuspend)
		usb_autosuspend_device(udev);
255 256 257
	return 0;
}

258 259 260 261 262 263 264 265 266 267 268 269 270 271
/*
 * Cancel any pending scheduled resets
 *
 * [see usb_queue_reset_device()]
 *
 * Called after unconfiguring / when releasing interfaces. See
 * comments in __usb_queue_reset_device() regarding
 * udev->reset_running.
 */
static void usb_cancel_queued_reset(struct usb_interface *iface)
{
	if (iface->reset_running == 0)
		cancel_work_sync(&iface->reset_ws);
}
272 273

/* called from driver core with dev locked */
274 275
static int usb_probe_interface(struct device *dev)
{
276
	struct usb_driver *driver = to_usb_driver(dev->driver);
277 278
	struct usb_interface *intf = to_usb_interface(dev);
	struct usb_device *udev = interface_to_usbdev(intf);
279 280 281
	const struct usb_device_id *id;
	int error = -ENODEV;

282
	dev_dbg(dev, "%s\n", __func__);
283

284
	intf->needs_binding = 0;
285

286
	if (usb_device_is_owned(udev))
287
		return error;
288

289 290
	if (udev->authorized == 0) {
		dev_err(&intf->dev, "Device is not authorized for usage\n");
291
		return error;
292
	}
293

294
	id = usb_match_id(intf, driver->id_table);
295 296
	if (!id)
		id = usb_match_dynamic_id(intf, driver);
297 298
	if (!id)
		return error;
299

300 301 302 303 304 305 306
	dev_dbg(dev, "%s - got id\n", __func__);

	error = usb_autoresume_device(udev);
	if (error)
		return error;

	intf->condition = USB_INTERFACE_BINDING;
307

308
	/* Probed interfaces are initially active.  They are
309 310
	 * runtime-PM-enabled only if the driver has autosuspend support.
	 * They are sensitive to their children's power states.
311
	 */
312 313 314 315
	pm_runtime_set_active(dev);
	pm_suspend_ignore_children(dev, false);
	if (driver->supports_autosuspend)
		pm_runtime_enable(dev);
316 317 318 319 320 321 322 323

	/* Carry out a deferred switch to altsetting 0 */
	if (intf->needs_altsetting0) {
		error = usb_set_interface(udev, intf->altsetting[0].
				desc.bInterfaceNumber, 0);
		if (error < 0)
			goto err;
		intf->needs_altsetting0 = 0;
324 325
	}

326 327 328 329 330 331
	error = driver->probe(intf, id);
	if (error)
		goto err;

	intf->condition = USB_INTERFACE_BOUND;
	usb_autosuspend_device(udev);
332
	return error;
333

334
 err:
335 336 337
	intf->needs_remote_wakeup = 0;
	intf->condition = USB_INTERFACE_UNBOUND;
	usb_cancel_queued_reset(intf);
338 339

	/* Unbound interfaces are always runtime-PM-disabled and -suspended */
340 341
	if (driver->supports_autosuspend)
		pm_runtime_disable(dev);
342 343
	pm_runtime_set_suspended(dev);

344 345
	usb_autosuspend_device(udev);
	return error;
346 347
}

348
/* called from driver core with dev locked */
349 350
static int usb_unbind_interface(struct device *dev)
{
351
	struct usb_driver *driver = to_usb_driver(dev->driver);
352
	struct usb_interface *intf = to_usb_interface(dev);
353
	struct usb_device *udev;
354
	int error, r;
355 356 357

	intf->condition = USB_INTERFACE_UNBINDING;

358 359
	/* Autoresume for set_interface call below */
	udev = interface_to_usbdev(intf);
360
	error = usb_autoresume_device(udev);
361

A
Alan Stern 已提交
362 363 364 365
	/* Terminate all URBs for this interface unless the driver
	 * supports "soft" unbinding.
	 */
	if (!driver->soft_unbind)
366
		usb_disable_interface(udev, intf, false);
367

368
	driver->disconnect(intf);
369
	usb_cancel_queued_reset(intf);
370

371 372 373 374 375 376
	/* Reset other interface state.
	 * We cannot do a Set-Interface if the device is suspended or
	 * if it is prepared for a system sleep (since installing a new
	 * altsetting means creating new endpoint device entries).
	 * When either of these happens, defer the Set-Interface.
	 */
377 378 379 380 381
	if (intf->cur_altsetting->desc.bAlternateSetting == 0) {
		/* Already in altsetting 0 so skip Set-Interface.
		 * Just re-enable it without affecting the endpoint toggles.
		 */
		usb_enable_interface(udev, intf, false);
382
	} else if (!error && !intf->dev.power.is_prepared) {
383
		r = usb_set_interface(udev, intf->altsetting[0].
384
				desc.bInterfaceNumber, 0);
385 386 387
		if (r < 0)
			intf->needs_altsetting0 = 1;
	} else {
388
		intf->needs_altsetting0 = 1;
389
	}
390
	usb_set_intfdata(intf, NULL);
391

392
	intf->condition = USB_INTERFACE_UNBOUND;
393 394
	intf->needs_remote_wakeup = 0;

395
	/* Unbound interfaces are always runtime-PM-disabled and -suspended */
396 397
	if (driver->supports_autosuspend)
		pm_runtime_disable(dev);
398 399 400 401 402 403 404
	pm_runtime_set_suspended(dev);

	/* Undo any residual pm_autopm_get_interface_* calls */
	for (r = atomic_read(&intf->pm_usage_cnt); r > 0; --r)
		usb_autopm_put_interface_no_suspend(intf);
	atomic_set(&intf->pm_usage_cnt, 0);

405
	if (!error)
406
		usb_autosuspend_device(udev);
407 408 409 410

	return 0;
}

411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
/**
 * usb_driver_claim_interface - bind a driver to an interface
 * @driver: the driver to be bound
 * @iface: the interface to which it will be bound; must be in the
 *	usb device's active configuration
 * @priv: driver data associated with that interface
 *
 * This is used by usb device drivers that need to claim more than one
 * interface on a device when probing (audio and acm are current examples).
 * No device driver should directly modify internal usb_interface or
 * usb_device structure members.
 *
 * Few drivers should need to use this routine, since the most natural
 * way to bind to an interface is to return the private data from
 * the driver's probe() method.
 *
427 428 429
 * Callers must own the device lock, so driver probe() entries don't need
 * extra locking, but other call contexts may need to explicitly claim that
 * lock.
430 431
 */
int usb_driver_claim_interface(struct usb_driver *driver,
432
				struct usb_interface *iface, void *priv)
433 434
{
	struct device *dev = &iface->dev;
435
	int retval = 0;
436 437 438 439

	if (dev->driver)
		return -EBUSY;

440
	dev->driver = &driver->drvwrap.driver;
441
	usb_set_intfdata(iface, priv);
442
	iface->needs_binding = 0;
443

444
	iface->condition = USB_INTERFACE_BOUND;
445

446 447 448 449 450
	/* Claimed interfaces are initially inactive (suspended) and
	 * runtime-PM-enabled, but only if the driver has autosuspend
	 * support.  Otherwise they are marked active, to prevent the
	 * device from being autosuspended, but left disabled.  In either
	 * case they are sensitive to their children's power states.
451 452 453 454
	 */
	pm_suspend_ignore_children(dev, false);
	if (driver->supports_autosuspend)
		pm_runtime_enable(dev);
455 456
	else
		pm_runtime_set_active(dev);
457 458 459 460 461

	/* if interface was already added, bind now; else let
	 * the future device_add() bind it, bypassing probe()
	 */
	if (device_is_registered(dev))
462
		retval = device_bind_driver(dev);
463

464
	return retval;
465
}
466
EXPORT_SYMBOL_GPL(usb_driver_claim_interface);
467 468 469 470 471 472 473 474 475 476 477

/**
 * usb_driver_release_interface - unbind a driver from an interface
 * @driver: the driver to be unbound
 * @iface: the interface from which it will be unbound
 *
 * This can be used by drivers to release an interface without waiting
 * for their disconnect() methods to be called.  In typical cases this
 * also causes the driver disconnect() method to be called.
 *
 * This call is synchronous, and may not be used in an interrupt context.
478 479 480
 * Callers must own the device lock, so driver disconnect() entries don't
 * need extra locking, but other call contexts may need to explicitly claim
 * that lock.
481 482 483 484 485 486 487
 */
void usb_driver_release_interface(struct usb_driver *driver,
					struct usb_interface *iface)
{
	struct device *dev = &iface->dev;

	/* this should never happen, don't release something that's not ours */
488
	if (!dev->driver || dev->driver != &driver->drvwrap.driver)
489 490 491 492 493
		return;

	/* don't release from within disconnect() */
	if (iface->condition != USB_INTERFACE_BOUND)
		return;
494
	iface->condition = USB_INTERFACE_UNBINDING;
495

496 497 498
	/* Release via the driver core only if the interface
	 * has already been registered
	 */
499 500
	if (device_is_registered(dev)) {
		device_release_driver(dev);
501
	} else {
502
		device_lock(dev);
503 504
		usb_unbind_interface(dev);
		dev->driver = NULL;
505
		device_unlock(dev);
506 507
	}
}
508
EXPORT_SYMBOL_GPL(usb_driver_release_interface);
509

510
/* returns 0 if no match, 1 if match */
511
int usb_match_device(struct usb_device *dev, const struct usb_device_id *id)
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
{
	if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
	    id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
	    id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
		return 0;

	/* No need to test id->bcdDevice_lo != 0, since 0 is never
	   greater than any unsigned number. */
	if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
	    (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice)))
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
	    (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
	    (id->bDeviceClass != dev->descriptor.bDeviceClass))
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
536
	    (id->bDeviceSubClass != dev->descriptor.bDeviceSubClass))
537 538 539 540 541 542
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
	    (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
		return 0;

543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
	return 1;
}

/* returns 0 if no match, 1 if match */
int usb_match_one_id(struct usb_interface *interface,
		     const struct usb_device_id *id)
{
	struct usb_host_interface *intf;
	struct usb_device *dev;

	/* proc_connectinfo in devio.c may call us with id == NULL. */
	if (id == NULL)
		return 0;

	intf = interface->cur_altsetting;
	dev = interface_to_usbdev(interface);

	if (!usb_match_device(dev, id))
		return 0;

563 564 565 566 567 568 569 570 571 572
	/* The interface class, subclass, and protocol should never be
	 * checked for a match if the device class is Vendor Specific,
	 * unless the match record specifies the Vendor ID. */
	if (dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC &&
			!(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
			(id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
				USB_DEVICE_ID_MATCH_INT_SUBCLASS |
				USB_DEVICE_ID_MATCH_INT_PROTOCOL)))
		return 0;

573 574 575 576 577 578 579 580 581 582 583 584 585 586
	if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
	    (id->bInterfaceClass != intf->desc.bInterfaceClass))
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
	    (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
	    (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
		return 0;

	return 1;
}
587 588
EXPORT_SYMBOL_GPL(usb_match_one_id);

589 590 591 592 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 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
/**
 * usb_match_id - find first usb_device_id matching device or interface
 * @interface: the interface of interest
 * @id: array of usb_device_id structures, terminated by zero entry
 *
 * usb_match_id searches an array of usb_device_id's and returns
 * the first one matching the device or interface, or null.
 * This is used when binding (or rebinding) a driver to an interface.
 * Most USB device drivers will use this indirectly, through the usb core,
 * but some layered driver frameworks use it directly.
 * These device tables are exported with MODULE_DEVICE_TABLE, through
 * modutils, to support the driver loading functionality of USB hotplugging.
 *
 * What Matches:
 *
 * The "match_flags" element in a usb_device_id controls which
 * members are used.  If the corresponding bit is set, the
 * value in the device_id must match its corresponding member
 * in the device or interface descriptor, or else the device_id
 * does not match.
 *
 * "driver_info" is normally used only by device drivers,
 * but you can create a wildcard "matches anything" usb_device_id
 * as a driver's "modules.usbmap" entry if you provide an id with
 * only a nonzero "driver_info" field.  If you do this, the USB device
 * driver's probe() routine should use additional intelligence to
 * decide whether to bind to the specified interface.
 *
 * What Makes Good usb_device_id Tables:
 *
 * The match algorithm is very simple, so that intelligence in
 * driver selection must come from smart driver id records.
 * Unless you have good reasons to use another selection policy,
 * provide match elements only in related groups, and order match
 * specifiers from specific to general.  Use the macros provided
 * for that purpose if you can.
 *
 * The most specific match specifiers use device descriptor
 * data.  These are commonly used with product-specific matches;
 * the USB_DEVICE macro lets you provide vendor and product IDs,
 * and you can also match against ranges of product revisions.
 * These are widely used for devices with application or vendor
 * specific bDeviceClass values.
 *
 * Matches based on device class/subclass/protocol specifications
 * are slightly more general; use the USB_DEVICE_INFO macro, or
 * its siblings.  These are used with single-function devices
 * where bDeviceClass doesn't specify that each interface has
 * its own class.
 *
 * Matches based on interface class/subclass/protocol are the
 * most general; they let drivers bind to any interface on a
 * multiple-function device.  Use the USB_INTERFACE_INFO
 * macro, or its siblings, to match class-per-interface style
643 644 645 646 647 648 649 650 651 652 653
 * devices (as recorded in bInterfaceClass).
 *
 * Note that an entry created by USB_INTERFACE_INFO won't match
 * any interface if the device class is set to Vendor-Specific.
 * This is deliberate; according to the USB spec the meanings of
 * the interface class/subclass/protocol for these devices are also
 * vendor-specific, and hence matching against a standard product
 * class wouldn't work anyway.  If you really want to use an
 * interface-based match for such a device, create a match record
 * that also specifies the vendor ID.  (Unforunately there isn't a
 * standard macro for creating records like this.)
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
 *
 * Within those groups, remember that not all combinations are
 * meaningful.  For example, don't give a product version range
 * without vendor and product IDs; or specify a protocol without
 * its associated class and subclass.
 */
const struct usb_device_id *usb_match_id(struct usb_interface *interface,
					 const struct usb_device_id *id)
{
	/* proc_connectinfo in devio.c may call us with id == NULL. */
	if (id == NULL)
		return NULL;

	/* It is important to check that id->driver_info is nonzero,
	   since an entry that is all zeroes except for a nonzero
	   id->driver_info is the way to create an entry that
	   indicates that the driver want to examine every
	   device and interface. */
672 673
	for (; id->idVendor || id->idProduct || id->bDeviceClass ||
	       id->bInterfaceClass || id->driver_info; id++) {
674 675
		if (usb_match_one_id(interface, id))
			return id;
676 677 678 679
	}

	return NULL;
}
680
EXPORT_SYMBOL_GPL(usb_match_id);
681

682
static int usb_device_match(struct device *dev, struct device_driver *drv)
683
{
684 685
	/* devices and interfaces are handled separately */
	if (is_usb_device(dev)) {
686

687 688 689
		/* interface drivers never match devices */
		if (!is_usb_device_driver(drv))
			return 0;
690

691
		/* TODO: Add real matching code */
692 693
		return 1;

694
	} else if (is_usb_interface(dev)) {
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
		struct usb_interface *intf;
		struct usb_driver *usb_drv;
		const struct usb_device_id *id;

		/* device drivers never match interfaces */
		if (is_usb_device_driver(drv))
			return 0;

		intf = to_usb_interface(dev);
		usb_drv = to_usb_driver(drv);

		id = usb_match_id(intf, usb_drv->id_table);
		if (id)
			return 1;

		id = usb_match_dynamic_id(intf, usb_drv);
		if (id)
			return 1;
	}

715 716 717
	return 0;
}

718
#ifdef	CONFIG_HOTPLUG
719
static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
720 721 722
{
	struct usb_device *usb_dev;

723
	if (is_usb_device(dev)) {
724
		usb_dev = to_usb_device(dev);
725
	} else if (is_usb_interface(dev)) {
726
		struct usb_interface *intf = to_usb_interface(dev);
727

728
		usb_dev = interface_to_usbdev(intf);
729 730
	} else {
		return 0;
731
	}
732 733

	if (usb_dev->devnum < 0) {
734
		/* driver is often null here; dev_dbg() would oops */
735
		pr_debug("usb %s: already deleted?\n", dev_name(dev));
736 737 738
		return -ENODEV;
	}
	if (!usb_dev->bus) {
739
		pr_debug("usb %s: bus removed?\n", dev_name(dev));
740 741 742 743 744 745
		return -ENODEV;
	}

#ifdef	CONFIG_USB_DEVICEFS
	/* If this is available, userspace programs can directly read
	 * all the device descriptors we don't tell them about.  Or
746
	 * act as usermode drivers.
747
	 */
748
	if (add_uevent_var(env, "DEVICE=/proc/bus/usb/%03d/%03d",
749 750 751 752 753
			   usb_dev->bus->busnum, usb_dev->devnum))
		return -ENOMEM;
#endif

	/* per-device configurations are common */
754
	if (add_uevent_var(env, "PRODUCT=%x/%x/%x",
755 756 757 758 759 760
			   le16_to_cpu(usb_dev->descriptor.idVendor),
			   le16_to_cpu(usb_dev->descriptor.idProduct),
			   le16_to_cpu(usb_dev->descriptor.bcdDevice)))
		return -ENOMEM;

	/* class-based driver binding models */
761
	if (add_uevent_var(env, "TYPE=%d/%d/%d",
762 763 764 765 766 767 768 769 770 771
			   usb_dev->descriptor.bDeviceClass,
			   usb_dev->descriptor.bDeviceSubClass,
			   usb_dev->descriptor.bDeviceProtocol))
		return -ENOMEM;

	return 0;
}

#else

772
static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
773 774 775 776 777
{
	return -ENODEV;
}
#endif	/* CONFIG_HOTPLUG */

778
/**
779 780
 * usb_register_device_driver - register a USB device (not interface) driver
 * @new_udriver: USB operations for the device driver
781
 * @owner: module owner of this driver.
782
 *
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
 * Registers a USB device driver with the USB core.  The list of
 * unattached devices will be rescanned whenever a new driver is
 * added, allowing the new driver to attach to any recognized devices.
 * Returns a negative error code on failure and 0 on success.
 */
int usb_register_device_driver(struct usb_device_driver *new_udriver,
		struct module *owner)
{
	int retval = 0;

	if (usb_disabled())
		return -ENODEV;

	new_udriver->drvwrap.for_devices = 1;
	new_udriver->drvwrap.driver.name = (char *) new_udriver->name;
	new_udriver->drvwrap.driver.bus = &usb_bus_type;
	new_udriver->drvwrap.driver.probe = usb_probe_device;
	new_udriver->drvwrap.driver.remove = usb_unbind_device;
	new_udriver->drvwrap.driver.owner = owner;

	retval = driver_register(&new_udriver->drvwrap.driver);

	if (!retval) {
		pr_info("%s: registered new device driver %s\n",
			usbcore_name, new_udriver->name);
		usbfs_update_special();
	} else {
		printk(KERN_ERR "%s: error %d registering device "
			"	driver %s\n",
			usbcore_name, retval, new_udriver->name);
	}

	return retval;
}
EXPORT_SYMBOL_GPL(usb_register_device_driver);

/**
 * usb_deregister_device_driver - unregister a USB device (not interface) driver
 * @udriver: USB operations of the device driver to unregister
 * Context: must be able to sleep
 *
 * Unlinks the specified driver from the internal USB driver list.
 */
void usb_deregister_device_driver(struct usb_device_driver *udriver)
{
	pr_info("%s: deregistering device driver %s\n",
			usbcore_name, udriver->name);

	driver_unregister(&udriver->drvwrap.driver);
	usbfs_update_special();
}
EXPORT_SYMBOL_GPL(usb_deregister_device_driver);

/**
 * usb_register_driver - register a USB interface driver
 * @new_driver: USB operations for the interface driver
 * @owner: module owner of this driver.
R
Randy Dunlap 已提交
840
 * @mod_name: module name string
841 842 843 844
 *
 * Registers a USB interface driver with the USB core.  The list of
 * unattached interfaces will be rescanned whenever a new driver is
 * added, allowing the new driver to attach to any recognized interfaces.
845 846 847 848 849 850
 * Returns a negative error code on failure and 0 on success.
 *
 * NOTE: if you want your driver to use the USB major number, you must call
 * usb_register_dev() to enable that functionality.  This function no longer
 * takes care of that.
 */
851 852
int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
			const char *mod_name)
853 854 855 856 857 858
{
	int retval = 0;

	if (usb_disabled())
		return -ENODEV;

859 860 861 862 863 864
	new_driver->drvwrap.for_devices = 0;
	new_driver->drvwrap.driver.name = (char *) new_driver->name;
	new_driver->drvwrap.driver.bus = &usb_bus_type;
	new_driver->drvwrap.driver.probe = usb_probe_interface;
	new_driver->drvwrap.driver.remove = usb_unbind_interface;
	new_driver->drvwrap.driver.owner = owner;
865
	new_driver->drvwrap.driver.mod_name = mod_name;
866 867
	spin_lock_init(&new_driver->dynids.lock);
	INIT_LIST_HEAD(&new_driver->dynids.list);
868

869
	retval = driver_register(&new_driver->drvwrap.driver);
870 871
	if (retval)
		goto out;
872

873 874 875 876 877 878 879 880 881 882 883
	usbfs_update_special();

	retval = usb_create_newid_file(new_driver);
	if (retval)
		goto out_newid;

	retval = usb_create_removeid_file(new_driver);
	if (retval)
		goto out_removeid;

	pr_info("%s: registered new interface driver %s\n",
884 885
			usbcore_name, new_driver->name);

886
out:
887
	return retval;
888 889 890 891 892 893 894 895 896 897

out_removeid:
	usb_remove_newid_file(new_driver);
out_newid:
	driver_unregister(&new_driver->drvwrap.driver);

	printk(KERN_ERR "%s: error %d registering interface "
			"	driver %s\n",
			usbcore_name, retval, new_driver->name);
	goto out;
898
}
899
EXPORT_SYMBOL_GPL(usb_register_driver);
900 901

/**
902 903
 * usb_deregister - unregister a USB interface driver
 * @driver: USB operations of the interface driver to unregister
904 905 906 907 908 909 910 911 912 913
 * Context: must be able to sleep
 *
 * Unlinks the specified driver from the internal USB driver list.
 *
 * NOTE: If you called usb_register_dev(), you still need to call
 * usb_deregister_dev() to clean up your driver's allocated minor numbers,
 * this * call will no longer do it for you.
 */
void usb_deregister(struct usb_driver *driver)
{
914 915
	pr_info("%s: deregistering interface driver %s\n",
			usbcore_name, driver->name);
916

917
	usb_remove_removeid_file(driver);
918
	usb_remove_newid_file(driver);
919
	usb_free_dynids(driver);
920
	driver_unregister(&driver->drvwrap.driver);
921 922 923

	usbfs_update_special();
}
924
EXPORT_SYMBOL_GPL(usb_deregister);
925

926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
/* Forced unbinding of a USB interface driver, either because
 * it doesn't support pre_reset/post_reset/reset_resume or
 * because it doesn't support suspend/resume.
 *
 * The caller must hold @intf's device's lock, but not its pm_mutex
 * and not @intf->dev.sem.
 */
void usb_forced_unbind_intf(struct usb_interface *intf)
{
	struct usb_driver *driver = to_usb_driver(intf->dev.driver);

	dev_dbg(&intf->dev, "forced unbind\n");
	usb_driver_release_interface(driver, intf);

	/* Mark the interface for later rebinding */
	intf->needs_binding = 1;
}

/* Delayed forced unbinding of a USB interface driver and scan
 * for rebinding.
 *
 * The caller must hold @intf's device's lock, but not its pm_mutex
 * and not @intf->dev.sem.
 *
950 951
 * Note: Rebinds will be skipped if a system sleep transition is in
 * progress and the PM "complete" callback hasn't occurred yet.
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
 */
void usb_rebind_intf(struct usb_interface *intf)
{
	int rc;

	/* Delayed unbind of an existing driver */
	if (intf->dev.driver) {
		struct usb_driver *driver =
				to_usb_driver(intf->dev.driver);

		dev_dbg(&intf->dev, "forced unbind\n");
		usb_driver_release_interface(driver, intf);
	}

	/* Try to rebind the interface */
967
	if (!intf->dev.power.is_prepared) {
968 969 970 971 972
		intf->needs_binding = 0;
		rc = device_attach(&intf->dev);
		if (rc < 0)
			dev_warn(&intf->dev, "rebind failed: %d\n", rc);
	}
973 974
}

A
Alan Stern 已提交
975 976
#ifdef CONFIG_PM

977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
#define DO_UNBIND	0
#define DO_REBIND	1

/* Unbind drivers for @udev's interfaces that don't support suspend/resume,
 * or rebind interfaces that have been unbound, according to @action.
 *
 * The caller must hold @udev's device lock.
 */
static void do_unbind_rebind(struct usb_device *udev, int action)
{
	struct usb_host_config	*config;
	int			i;
	struct usb_interface	*intf;
	struct usb_driver	*drv;

	config = udev->actconfig;
	if (config) {
		for (i = 0; i < config->desc.bNumInterfaces; ++i) {
			intf = config->interface[i];
			switch (action) {
			case DO_UNBIND:
				if (intf->dev.driver) {
					drv = to_usb_driver(intf->dev.driver);
					if (!drv->suspend || !drv->resume)
						usb_forced_unbind_intf(intf);
				}
				break;
			case DO_REBIND:
1005
				if (intf->needs_binding)
1006 1007 1008 1009 1010 1011 1012
					usb_rebind_intf(intf);
				break;
			}
		}
	}
}

1013
static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
1014
{
1015
	struct usb_device_driver	*udriver;
1016
	int				status = 0;
1017

1018 1019 1020 1021
	if (udev->state == USB_STATE_NOTATTACHED ||
			udev->state == USB_STATE_SUSPENDED)
		goto done;

1022 1023 1024 1025
	/* For devices that don't have a driver, we do a generic suspend. */
	if (udev->dev.driver)
		udriver = to_usb_device_driver(udev->dev.driver);
	else {
1026
		udev->do_remote_wakeup = 0;
1027
		udriver = &usb_generic_driver;
1028
	}
1029 1030
	status = udriver->suspend(udev, msg);

A
Alan Stern 已提交
1031
 done:
1032
	dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1033
	return status;
1034 1035
}

A
Alan Stern 已提交
1036
static int usb_resume_device(struct usb_device *udev, pm_message_t msg)
1037 1038
{
	struct usb_device_driver	*udriver;
1039
	int				status = 0;
1040

A
Alan Stern 已提交
1041 1042
	if (udev->state == USB_STATE_NOTATTACHED)
		goto done;
1043

1044 1045 1046
	/* Can't resume it if it doesn't have a driver. */
	if (udev->dev.driver == NULL) {
		status = -ENOTCONN;
1047
		goto done;
1048 1049
	}

1050 1051 1052
	/* Non-root devices on a full/low-speed bus must wait for their
	 * companion high-speed root hub, in case a handoff is needed.
	 */
1053
	if (!PMSG_IS_AUTO(msg) && udev->parent && udev->bus->hs_companion)
1054 1055 1056
		device_pm_wait_for_dev(&udev->dev,
				&udev->bus->hs_companion->root_hub->dev);

A
Alan Stern 已提交
1057 1058 1059
	if (udev->quirks & USB_QUIRK_RESET_RESUME)
		udev->reset_resume = 1;

1060
	udriver = to_usb_device_driver(udev->dev.driver);
A
Alan Stern 已提交
1061
	status = udriver->resume(udev, msg);
1062

A
Alan Stern 已提交
1063
 done:
1064
	dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1065
	return status;
1066 1067
}

1068 1069
static int usb_suspend_interface(struct usb_device *udev,
		struct usb_interface *intf, pm_message_t msg)
1070 1071
{
	struct usb_driver	*driver;
1072
	int			status = 0;
1073

1074 1075
	if (udev->state == USB_STATE_NOTATTACHED ||
			intf->condition == USB_INTERFACE_UNBOUND)
1076
		goto done;
1077
	driver = to_usb_driver(intf->dev.driver);
1078

1079 1080 1081 1082
	/* at this time we know the driver supports suspend */
	status = driver->suspend(intf, msg);
	if (status && !PMSG_IS_AUTO(msg))
		dev_err(&intf->dev, "suspend error %d\n", status);
1083

A
Alan Stern 已提交
1084
 done:
1085
	dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
1086 1087 1088
	return status;
}

1089
static int usb_resume_interface(struct usb_device *udev,
A
Alan Stern 已提交
1090
		struct usb_interface *intf, pm_message_t msg, int reset_resume)
1091
{
1092
	struct usb_driver	*driver;
1093
	int			status = 0;
1094

1095
	if (udev->state == USB_STATE_NOTATTACHED)
1096
		goto done;
1097

1098 1099 1100 1101
	/* Don't let autoresume interfere with unbinding */
	if (intf->condition == USB_INTERFACE_UNBINDING)
		goto done;

1102
	/* Can't resume it if it doesn't have a driver. */
1103 1104 1105
	if (intf->condition == USB_INTERFACE_UNBOUND) {

		/* Carry out a deferred switch to altsetting 0 */
1106
		if (intf->needs_altsetting0 && !intf->dev.power.is_prepared) {
1107 1108 1109 1110
			usb_set_interface(udev, intf->altsetting[0].
					desc.bInterfaceNumber, 0);
			intf->needs_altsetting0 = 0;
		}
1111
		goto done;
1112
	}
1113 1114 1115

	/* Don't resume if the interface is marked for rebinding */
	if (intf->needs_binding)
1116
		goto done;
1117
	driver = to_usb_driver(intf->dev.driver);
1118

A
Alan Stern 已提交
1119 1120 1121 1122 1123 1124 1125
	if (reset_resume) {
		if (driver->reset_resume) {
			status = driver->reset_resume(intf);
			if (status)
				dev_err(&intf->dev, "%s error %d\n",
						"reset_resume", status);
		} else {
1126
			intf->needs_binding = 1;
A
Alan Stern 已提交
1127 1128 1129 1130
			dev_warn(&intf->dev, "no %s for driver %s?\n",
					"reset_resume", driver->name);
		}
	} else {
1131 1132 1133
		status = driver->resume(intf);
		if (status)
			dev_err(&intf->dev, "resume error %d\n", status);
A
Alan Stern 已提交
1134
	}
1135 1136

done:
1137
	dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
A
Alan Stern 已提交
1138

1139
	/* Later we will unbind the driver and/or reprobe, if necessary */
1140
	return status;
1141 1142
}

1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
/**
 * usb_suspend_both - suspend a USB device and its interfaces
 * @udev: the usb_device to suspend
 * @msg: Power Management message describing this state transition
 *
 * This is the central routine for suspending USB devices.  It calls the
 * suspend methods for all the interface drivers in @udev and then calls
 * the suspend method for @udev itself.  If an error occurs at any stage,
 * all the interfaces which were suspended are resumed so that they remain
 * in the same state as the device.
 *
1154 1155 1156 1157 1158 1159
 * Autosuspend requests originating from a child device or an interface
 * driver may be made without the protection of @udev's device lock, but
 * all other suspend calls will hold the lock.  Usbcore will insure that
 * method calls do not arrive during bind, unbind, or reset operations.
 * However drivers must be prepared to handle suspend calls arriving at
 * unpredictable times.
1160 1161 1162
 *
 * This routine can run only in process context.
 */
A
Alan Stern 已提交
1163
static int usb_suspend_both(struct usb_device *udev, pm_message_t msg)
1164 1165
{
	int			status = 0;
1166
	int			i = 0, n = 0;
1167
	struct usb_interface	*intf;
1168

1169 1170 1171
	if (udev->state == USB_STATE_NOTATTACHED ||
			udev->state == USB_STATE_SUSPENDED)
		goto done;
1172

1173
	/* Suspend all the interfaces and then udev itself */
1174
	if (udev->actconfig) {
1175 1176
		n = udev->actconfig->desc.bNumInterfaces;
		for (i = n - 1; i >= 0; --i) {
1177
			intf = udev->actconfig->interface[i];
1178
			status = usb_suspend_interface(udev, intf, msg);
1179 1180

			/* Ignore errors during system sleep transitions */
1181
			if (!PMSG_IS_AUTO(msg))
1182
				status = 0;
1183 1184 1185 1186
			if (status != 0)
				break;
		}
	}
1187
	if (status == 0) {
1188
		status = usb_suspend_device(udev, msg);
1189

1190
		/* Again, ignore errors during system sleep transitions */
1191
		if (!PMSG_IS_AUTO(msg))
1192 1193 1194
			status = 0;
	}

1195 1196
	/* If the suspend failed, resume interfaces that did get suspended */
	if (status != 0) {
1197
		msg.event ^= (PM_EVENT_SUSPEND | PM_EVENT_RESUME);
1198
		while (++i < n) {
1199
			intf = udev->actconfig->interface[i];
1200
			usb_resume_interface(udev, intf, msg, 0);
1201
		}
1202

1203 1204
	/* If the suspend succeeded then prevent any more URB submissions
	 * and flush any outstanding URBs.
1205
	 */
A
Alan Stern 已提交
1206
	} else {
1207 1208 1209 1210 1211
		udev->can_submit = 0;
		for (i = 0; i < 16; ++i) {
			usb_hcd_flush_endpoint(udev, udev->ep_out[i]);
			usb_hcd_flush_endpoint(udev, udev->ep_in[i]);
		}
A
Alan Stern 已提交
1212
	}
1213

1214
 done:
1215
	dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1216 1217 1218
	return status;
}

1219 1220 1221
/**
 * usb_resume_both - resume a USB device and its interfaces
 * @udev: the usb_device to resume
A
Alan Stern 已提交
1222
 * @msg: Power Management message describing this state transition
1223 1224 1225 1226 1227
 *
 * This is the central routine for resuming USB devices.  It calls the
 * the resume method for @udev and then calls the resume methods for all
 * the interface drivers in @udev.
 *
1228 1229 1230 1231 1232 1233
 * Autoresume requests originating from a child device or an interface
 * driver may be made without the protection of @udev's device lock, but
 * all other resume calls will hold the lock.  Usbcore will insure that
 * method calls do not arrive during bind, unbind, or reset operations.
 * However drivers must be prepared to handle resume calls arriving at
 * unpredictable times.
1234 1235 1236
 *
 * This routine can run only in process context.
 */
A
Alan Stern 已提交
1237
static int usb_resume_both(struct usb_device *udev, pm_message_t msg)
1238
{
1239
	int			status = 0;
1240 1241
	int			i;
	struct usb_interface	*intf;
1242

1243 1244 1245 1246
	if (udev->state == USB_STATE_NOTATTACHED) {
		status = -ENODEV;
		goto done;
	}
1247
	udev->can_submit = 1;
1248

1249 1250
	/* Resume the device */
	if (udev->state == USB_STATE_SUSPENDED || udev->reset_resume)
A
Alan Stern 已提交
1251
		status = usb_resume_device(udev, msg);
1252

1253
	/* Resume the interfaces */
1254 1255 1256
	if (status == 0 && udev->actconfig) {
		for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
			intf = udev->actconfig->interface[i];
A
Alan Stern 已提交
1257 1258
			usb_resume_interface(udev, intf, msg,
					udev->reset_resume);
1259 1260
		}
	}
1261
	usb_mark_last_busy(udev);
1262

1263
 done:
1264
	dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
A
Alan Stern 已提交
1265 1266
	if (!status)
		udev->reset_resume = 0;
1267 1268 1269
	return status;
}

1270 1271
static void choose_wakeup(struct usb_device *udev, pm_message_t msg)
{
1272
	int	w;
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283

	/* Remote wakeup is needed only when we actually go to sleep.
	 * For things like FREEZE and QUIESCE, if the device is already
	 * autosuspended then its current wakeup setting is okay.
	 */
	if (msg.event == PM_EVENT_FREEZE || msg.event == PM_EVENT_QUIESCE) {
		if (udev->state != USB_STATE_SUSPENDED)
			udev->do_remote_wakeup = 0;
		return;
	}

1284
	/* Enable remote wakeup if it is allowed, even if no interface drivers
1285 1286
	 * actually want it.
	 */
1287
	w = device_may_wakeup(&udev->dev);
1288 1289 1290 1291 1292 1293 1294 1295 1296

	/* If the device is autosuspended with the wrong wakeup setting,
	 * autoresume now so the setting can be changed.
	 */
	if (udev->state == USB_STATE_SUSPENDED && w != udev->do_remote_wakeup)
		pm_runtime_resume(&udev->dev);
	udev->do_remote_wakeup = w;
}

1297
/* The device lock is held by the PM core */
1298 1299
int usb_suspend(struct device *dev, pm_message_t msg)
{
1300
	struct usb_device	*udev = to_usb_device(dev);
1301

1302
	do_unbind_rebind(udev, DO_UNBIND);
1303
	choose_wakeup(udev, msg);
1304
	return usb_suspend_both(udev, msg);
1305 1306
}

1307
/* The device lock is held by the PM core */
1308 1309
int usb_resume(struct device *dev, pm_message_t msg)
{
1310
	struct usb_device	*udev = to_usb_device(dev);
1311 1312
	int			status;

1313 1314 1315 1316 1317
	/* For PM complete calls, all we do is rebind interfaces */
	if (msg.event == PM_EVENT_ON) {
		if (udev->state != USB_STATE_NOTATTACHED)
			do_unbind_rebind(udev, DO_REBIND);
		status = 0;
1318

1319 1320
	/* For all other calls, take the device back to full power and
	 * tell the PM core in case it was autosuspended previously.
1321
	 * Unbind the interfaces that will need rebinding later.
1322
	 */
1323 1324 1325 1326 1327 1328
	} else {
		status = usb_resume_both(udev, msg);
		if (status == 0) {
			pm_runtime_disable(dev);
			pm_runtime_set_active(dev);
			pm_runtime_enable(dev);
1329
			do_unbind_rebind(udev, DO_REBIND);
1330 1331
		}
	}
1332 1333 1334 1335

	/* Avoid PM error messages for devices disconnected while suspended
	 * as we'll display regular disconnect messages just a bit later.
	 */
1336
	if (status == -ENODEV || status == -ESHUTDOWN)
1337
		status = 0;
1338 1339 1340 1341 1342
	return status;
}

#endif /* CONFIG_PM */

1343 1344
#ifdef CONFIG_USB_SUSPEND

1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
/**
 * usb_enable_autosuspend - allow a USB device to be autosuspended
 * @udev: the USB device which may be autosuspended
 *
 * This routine allows @udev to be autosuspended.  An autosuspend won't
 * take place until the autosuspend_delay has elapsed and all the other
 * necessary conditions are satisfied.
 *
 * The caller must hold @udev's device lock.
 */
1355
void usb_enable_autosuspend(struct usb_device *udev)
1356
{
1357
	pm_runtime_allow(&udev->dev);
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
}
EXPORT_SYMBOL_GPL(usb_enable_autosuspend);

/**
 * usb_disable_autosuspend - prevent a USB device from being autosuspended
 * @udev: the USB device which may not be autosuspended
 *
 * This routine prevents @udev from being autosuspended and wakes it up
 * if it is already autosuspended.
 *
 * The caller must hold @udev's device lock.
 */
1370
void usb_disable_autosuspend(struct usb_device *udev)
1371
{
1372
	pm_runtime_forbid(&udev->dev);
1373 1374 1375
}
EXPORT_SYMBOL_GPL(usb_disable_autosuspend);

1376 1377
/**
 * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
1378
 * @udev: the usb_device to autosuspend
1379 1380 1381 1382 1383
 *
 * This routine should be called when a core subsystem is finished using
 * @udev and wants to allow it to autosuspend.  Examples would be when
 * @udev's device file in usbfs is closed or after a configuration change.
 *
1384 1385 1386
 * @udev's usage counter is decremented; if it drops to 0 and all the
 * interfaces are inactive then a delayed autosuspend will be attempted.
 * The attempt may fail (see autosuspend_check()).
1387
 *
1388
 * The caller must hold @udev's device lock.
1389 1390 1391
 *
 * This routine can run only in process context.
 */
1392
void usb_autosuspend_device(struct usb_device *udev)
1393
{
1394 1395
	int	status;

1396
	usb_mark_last_busy(udev);
1397
	status = pm_runtime_put_sync_autosuspend(&udev->dev);
1398 1399 1400
	dev_vdbg(&udev->dev, "%s: cnt %d -> %d\n",
			__func__, atomic_read(&udev->dev.power.usage_count),
			status);
1401 1402 1403 1404
}

/**
 * usb_autoresume_device - immediately autoresume a USB device and its interfaces
1405
 * @udev: the usb_device to autoresume
1406 1407
 *
 * This routine should be called when a core subsystem wants to use @udev
1408
 * and needs to guarantee that it is not suspended.  No autosuspend will
1409 1410 1411
 * occur until usb_autosuspend_device() is called.  (Note that this will
 * not prevent suspend events originating in the PM core.)  Examples would
 * be when @udev's device file in usbfs is opened or when a remote-wakeup
1412
 * request is received.
1413
 *
1414 1415
 * @udev's usage counter is incremented to prevent subsequent autosuspends.
 * However if the autoresume fails then the usage counter is re-decremented.
1416
 *
1417
 * The caller must hold @udev's device lock.
1418 1419 1420
 *
 * This routine can run only in process context.
 */
1421
int usb_autoresume_device(struct usb_device *udev)
1422 1423 1424
{
	int	status;

1425 1426 1427 1428 1429 1430 1431 1432
	status = pm_runtime_get_sync(&udev->dev);
	if (status < 0)
		pm_runtime_put_sync(&udev->dev);
	dev_vdbg(&udev->dev, "%s: cnt %d -> %d\n",
			__func__, atomic_read(&udev->dev.power.usage_count),
			status);
	if (status > 0)
		status = 0;
A
Alan Stern 已提交
1433 1434 1435
	return status;
}

1436 1437
/**
 * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
1438
 * @intf: the usb_interface whose counter should be decremented
1439 1440 1441 1442 1443 1444 1445
 *
 * This routine should be called by an interface driver when it is
 * finished using @intf and wants to allow it to autosuspend.  A typical
 * example would be a character-device driver when its device file is
 * closed.
 *
 * The routine decrements @intf's usage counter.  When the counter reaches
1446 1447
 * 0, a delayed autosuspend request for @intf's device is attempted.  The
 * attempt may fail (see autosuspend_check()).
1448 1449 1450 1451 1452
 *
 * This routine can run only in process context.
 */
void usb_autopm_put_interface(struct usb_interface *intf)
{
1453 1454
	struct usb_device	*udev = interface_to_usbdev(intf);
	int			status;
1455

1456
	usb_mark_last_busy(udev);
1457 1458 1459 1460 1461
	atomic_dec(&intf->pm_usage_cnt);
	status = pm_runtime_put_sync(&intf->dev);
	dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
			__func__, atomic_read(&intf->dev.power.usage_count),
			status);
1462 1463 1464
}
EXPORT_SYMBOL_GPL(usb_autopm_put_interface);

1465 1466 1467 1468
/**
 * usb_autopm_put_interface_async - decrement a USB interface's PM-usage counter
 * @intf: the usb_interface whose counter should be decremented
 *
1469 1470 1471 1472 1473
 * This routine does much the same thing as usb_autopm_put_interface():
 * It decrements @intf's usage counter and schedules a delayed
 * autosuspend request if the counter is <= 0.  The difference is that it
 * does not perform any synchronization; callers should hold a private
 * lock and handle all synchronization issues themselves.
1474 1475 1476 1477 1478 1479 1480 1481 1482
 *
 * Typically a driver would call this routine during an URB's completion
 * handler, if no more URBs were pending.
 *
 * This routine can run in atomic context.
 */
void usb_autopm_put_interface_async(struct usb_interface *intf)
{
	struct usb_device	*udev = interface_to_usbdev(intf);
1483
	int			status;
1484

1485
	usb_mark_last_busy(udev);
1486
	atomic_dec(&intf->pm_usage_cnt);
1487
	status = pm_runtime_put(&intf->dev);
1488 1489 1490
	dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
			__func__, atomic_read(&intf->dev.power.usage_count),
			status);
1491 1492 1493
}
EXPORT_SYMBOL_GPL(usb_autopm_put_interface_async);

1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506
/**
 * usb_autopm_put_interface_no_suspend - decrement a USB interface's PM-usage counter
 * @intf: the usb_interface whose counter should be decremented
 *
 * This routine decrements @intf's usage counter but does not carry out an
 * autosuspend.
 *
 * This routine can run in atomic context.
 */
void usb_autopm_put_interface_no_suspend(struct usb_interface *intf)
{
	struct usb_device	*udev = interface_to_usbdev(intf);

1507
	usb_mark_last_busy(udev);
1508 1509 1510 1511 1512
	atomic_dec(&intf->pm_usage_cnt);
	pm_runtime_put_noidle(&intf->dev);
}
EXPORT_SYMBOL_GPL(usb_autopm_put_interface_no_suspend);

1513 1514
/**
 * usb_autopm_get_interface - increment a USB interface's PM-usage counter
1515
 * @intf: the usb_interface whose counter should be incremented
1516 1517 1518 1519 1520 1521 1522 1523 1524
 *
 * This routine should be called by an interface driver when it wants to
 * use @intf and needs to guarantee that it is not suspended.  In addition,
 * the routine prevents @intf from being autosuspended subsequently.  (Note
 * that this will not prevent suspend events originating in the PM core.)
 * This prevention will persist until usb_autopm_put_interface() is called
 * or @intf is unbound.  A typical example would be a character-device
 * driver when its device file is opened.
 *
1525 1526
 * @intf's usage counter is incremented to prevent subsequent autosuspends.
 * However if the autoresume fails then the counter is re-decremented.
1527 1528 1529 1530 1531
 *
 * This routine can run only in process context.
 */
int usb_autopm_get_interface(struct usb_interface *intf)
{
A
Alan Stern 已提交
1532
	int	status;
1533

1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
	status = pm_runtime_get_sync(&intf->dev);
	if (status < 0)
		pm_runtime_put_sync(&intf->dev);
	else
		atomic_inc(&intf->pm_usage_cnt);
	dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
			__func__, atomic_read(&intf->dev.power.usage_count),
			status);
	if (status > 0)
		status = 0;
1544 1545
	return status;
}
1546 1547
EXPORT_SYMBOL_GPL(usb_autopm_get_interface);

1548 1549 1550 1551 1552
/**
 * usb_autopm_get_interface_async - increment a USB interface's PM-usage counter
 * @intf: the usb_interface whose counter should be incremented
 *
 * This routine does much the same thing as
1553 1554 1555 1556 1557 1558 1559
 * usb_autopm_get_interface(): It increments @intf's usage counter and
 * queues an autoresume request if the device is suspended.  The
 * differences are that it does not perform any synchronization (callers
 * should hold a private lock and handle all synchronization issues
 * themselves), and it does not autoresume the device directly (it only
 * queues a request).  After a successful call, the device may not yet be
 * resumed.
1560 1561 1562 1563 1564
 *
 * This routine can run in atomic context.
 */
int usb_autopm_get_interface_async(struct usb_interface *intf)
{
1565
	int	status;
1566

1567
	status = pm_runtime_get(&intf->dev);
1568 1569 1570
	if (status < 0 && status != -EINPROGRESS)
		pm_runtime_put_noidle(&intf->dev);
	else
A
Alan Stern 已提交
1571
		atomic_inc(&intf->pm_usage_cnt);
1572 1573 1574
	dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
			__func__, atomic_read(&intf->dev.power.usage_count),
			status);
1575
	if (status > 0 || status == -EINPROGRESS)
1576
		status = 0;
1577 1578 1579 1580
	return status;
}
EXPORT_SYMBOL_GPL(usb_autopm_get_interface_async);

1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593
/**
 * usb_autopm_get_interface_no_resume - increment a USB interface's PM-usage counter
 * @intf: the usb_interface whose counter should be incremented
 *
 * This routine increments @intf's usage counter but does not carry out an
 * autoresume.
 *
 * This routine can run in atomic context.
 */
void usb_autopm_get_interface_no_resume(struct usb_interface *intf)
{
	struct usb_device	*udev = interface_to_usbdev(intf);

1594
	usb_mark_last_busy(udev);
1595 1596 1597 1598 1599 1600 1601 1602
	atomic_inc(&intf->pm_usage_cnt);
	pm_runtime_get_noresume(&intf->dev);
}
EXPORT_SYMBOL_GPL(usb_autopm_get_interface_no_resume);

/* Internal routine to check whether we may autosuspend a device. */
static int autosuspend_check(struct usb_device *udev)
{
1603
	int			w, i;
1604 1605 1606 1607 1608
	struct usb_interface	*intf;

	/* Fail if autosuspend is disabled, or any interfaces are in use, or
	 * any interface drivers require remote wakeup but it isn't available.
	 */
1609
	w = 0;
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
	if (udev->actconfig) {
		for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
			intf = udev->actconfig->interface[i];

			/* We don't need to check interfaces that are
			 * disabled for runtime PM.  Either they are unbound
			 * or else their drivers don't support autosuspend
			 * and so they are permanently active.
			 */
			if (intf->dev.power.disable_depth)
				continue;
			if (atomic_read(&intf->dev.power.usage_count) > 0)
				return -EBUSY;
1623
			w |= intf->needs_remote_wakeup;
1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638

			/* Don't allow autosuspend if the device will need
			 * a reset-resume and any of its interface drivers
			 * doesn't include support or needs remote wakeup.
			 */
			if (udev->quirks & USB_QUIRK_RESET_RESUME) {
				struct usb_driver *driver;

				driver = to_usb_driver(intf->dev.driver);
				if (!driver->reset_resume ||
						intf->needs_remote_wakeup)
					return -EOPNOTSUPP;
			}
		}
	}
1639 1640 1641 1642 1643
	if (w && !device_can_wakeup(&udev->dev)) {
		dev_dbg(&udev->dev, "remote wakeup needed for autosuspend\n");
		return -EOPNOTSUPP;
	}
	udev->do_remote_wakeup = w;
1644 1645 1646
	return 0;
}

1647
int usb_runtime_suspend(struct device *dev)
1648
{
1649 1650
	struct usb_device	*udev = to_usb_device(dev);
	int			status;
A
Alan Stern 已提交
1651

1652 1653 1654 1655
	/* A USB device can be suspended if it passes the various autosuspend
	 * checks.  Runtime suspend for a USB device means suspending all the
	 * interfaces and then the device itself.
	 */
1656 1657
	if (autosuspend_check(udev) != 0)
		return -EAGAIN;
1658

1659
	status = usb_suspend_both(udev, PMSG_AUTO_SUSPEND);
1660 1661 1662 1663 1664

	/* Allow a retry if autosuspend failed temporarily */
	if (status == -EAGAIN || status == -EBUSY)
		usb_mark_last_busy(udev);

1665 1666 1667 1668 1669
	/* The PM core reacts badly unless the return code is 0,
	 * -EAGAIN, or -EBUSY, so always return -EBUSY on an error.
	 */
	if (status != 0)
		return -EBUSY;
1670 1671 1672
	return status;
}

1673
int usb_runtime_resume(struct device *dev)
1674
{
1675 1676 1677
	struct usb_device	*udev = to_usb_device(dev);
	int			status;

1678 1679 1680
	/* Runtime resume for a USB device means resuming both the device
	 * and all its interfaces.
	 */
1681 1682
	status = usb_resume_both(udev, PMSG_AUTO_RESUME);
	return status;
1683 1684
}

1685
int usb_runtime_idle(struct device *dev)
1686
{
1687 1688
	struct usb_device	*udev = to_usb_device(dev);

1689
	/* An idle USB device can be suspended if it passes the various
1690
	 * autosuspend checks.
1691
	 */
1692
	if (autosuspend_check(udev) == 0)
1693
		pm_runtime_autosuspend(dev);
1694 1695 1696
	return 0;
}

A
Andiry Xu 已提交
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
int usb_set_usb2_hardware_lpm(struct usb_device *udev, int enable)
{
	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
	int ret = -EPERM;

	if (hcd->driver->set_usb2_hw_lpm) {
		ret = hcd->driver->set_usb2_hw_lpm(hcd, udev, enable);
		if (!ret)
			udev->usb2_hw_lpm_enabled = enable;
	}

	return ret;
}

1711
#endif /* CONFIG_USB_SUSPEND */
1712

1713 1714 1715 1716 1717
struct bus_type usb_bus_type = {
	.name =		"usb",
	.match =	usb_device_match,
	.uevent =	usb_uevent,
};