driver.c 46.2 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 26
 *
 */

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

A
Alan Stern 已提交
32 33 34 35 36 37 38 39
#define VERBOSE_DEBUG	0

#if VERBOSE_DEBUG
#define dev_vdbg	dev_dbg
#else
#define dev_vdbg(dev, fmt, args...)	do { } while (0)
#endif

40 41 42 43 44 45
#ifdef CONFIG_HOTPLUG

/*
 * Adds a new dynamic USBdevice ID to this driver,
 * and cause the driver to probe for all devices again.
 */
46 47 48
ssize_t usb_store_new_id(struct usb_dynids *dynids,
			 struct device_driver *driver,
			 const char *buf, size_t count)
49 50 51 52 53
{
	struct usb_dynid *dynid;
	u32 idVendor = 0;
	u32 idProduct = 0;
	int fields = 0;
54
	int retval = 0;
55 56 57 58 59 60 61 62 63 64 65 66 67 68

	fields = sscanf(buf, "%x %x", &idVendor, &idProduct);
	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;

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

	if (get_driver(driver)) {
74
		retval = driver_attach(driver);
75 76 77
		put_driver(driver);
	}

78 79
	if (retval)
		return retval;
80 81
	return count;
}
82 83 84 85 86 87 88 89 90
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);
}
91 92 93 94 95 96
static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);

static int usb_create_newid_file(struct usb_driver *usb_drv)
{
	int error = 0;

97 98 99
	if (usb_drv->no_dynamic_id)
		goto exit;

100
	if (usb_drv->probe != NULL)
101
		error = sysfs_create_file(&usb_drv->drvwrap.driver.kobj,
102
					  &driver_attr_new_id.attr);
103
exit:
104 105 106
	return error;
}

107 108 109 110 111 112
static void usb_remove_newid_file(struct usb_driver *usb_drv)
{
	if (usb_drv->no_dynamic_id)
		return;

	if (usb_drv->probe != NULL)
113
		sysfs_remove_file(&usb_drv->drvwrap.driver.kobj,
114 115 116
				  &driver_attr_new_id.attr);
}

117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
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;
}

134 135 136 137
static void usb_remove_newid_file(struct usb_driver *usb_drv)
{
}

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
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;
}


160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
/* 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);
	struct usb_device *udev;
	int error = -ENODEV;

	dev_dbg(dev, "%s\n", __FUNCTION__);

	if (!is_usb_device(dev))	/* Sanity check */
		return error;

	udev = to_usb_device(dev);

	/* TODO: Add real matching code */

176 177 178 179 180
	/* The device should always appear to be in use
	 * unless the driver suports autosuspend.
	 */
	udev->pm_usage_cnt = !(udriver->supports_autosuspend);

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
	error = udriver->probe(udev);
	return error;
}

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

	udriver->disconnect(to_usb_device(dev));
	return 0;
}


/* called from driver core with dev locked */
196 197
static int usb_probe_interface(struct device *dev)
{
198 199
	struct usb_driver *driver = to_usb_driver(dev->driver);
	struct usb_interface *intf;
200
	struct usb_device *udev;
201 202 203 204 205
	const struct usb_device_id *id;
	int error = -ENODEV;

	dev_dbg(dev, "%s\n", __FUNCTION__);

206
	if (is_usb_device(dev))		/* Sanity check */
207
		return error;
208 209

	intf = to_usb_interface(dev);
210
	udev = interface_to_usbdev(intf);
211 212

	id = usb_match_id(intf, driver->id_table);
213 214
	if (!id)
		id = usb_match_dynamic_id(intf, driver);
215 216 217
	if (id) {
		dev_dbg(dev, "%s - got id\n", __FUNCTION__);

218
		error = usb_autoresume_device(udev);
219 220 221
		if (error)
			return error;

222 223 224 225 226 227
		/* Interface "power state" doesn't correspond to any hardware
		 * state whatsoever.  We use it to record when it's bound to
		 * a driver that may start I/0:  it's not frozen/quiesced.
		 */
		mark_active(intf);
		intf->condition = USB_INTERFACE_BINDING;
228 229 230 231 232 233

		/* The interface should always appear to be in use
		 * unless the driver suports autosuspend.
		 */
		intf->pm_usage_cnt = !(driver->supports_autosuspend);

234 235 236
		error = driver->probe(intf, id);
		if (error) {
			mark_quiesced(intf);
237
			intf->needs_remote_wakeup = 0;
238 239 240
			intf->condition = USB_INTERFACE_UNBOUND;
		} else
			intf->condition = USB_INTERFACE_BOUND;
241

242
		usb_autosuspend_device(udev);
243 244 245 246 247
	}

	return error;
}

248
/* called from driver core with dev locked */
249 250
static int usb_unbind_interface(struct device *dev)
{
251
	struct usb_driver *driver = to_usb_driver(dev->driver);
252
	struct usb_interface *intf = to_usb_interface(dev);
253 254
	struct usb_device *udev;
	int error;
255 256 257

	intf->condition = USB_INTERFACE_UNBINDING;

258 259
	/* Autoresume for set_interface call below */
	udev = interface_to_usbdev(intf);
260
	error = usb_autoresume_device(udev);
261

262 263 264
	/* release all urbs for this interface */
	usb_disable_interface(interface_to_usbdev(intf), intf);

265
	driver->disconnect(intf);
266 267 268 269 270 271

	/* reset other interface state */
	usb_set_interface(interface_to_usbdev(intf),
			intf->altsetting[0].desc.bInterfaceNumber,
			0);
	usb_set_intfdata(intf, NULL);
272

273 274
	intf->condition = USB_INTERFACE_UNBOUND;
	mark_quiesced(intf);
275 276 277
	intf->needs_remote_wakeup = 0;

	if (!error)
278
		usb_autosuspend_device(udev);
279 280 281 282

	return 0;
}

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
/**
 * 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.
 *
299 300 301
 * 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.
302 303 304 305 306
 */
int usb_driver_claim_interface(struct usb_driver *driver,
				struct usb_interface *iface, void* priv)
{
	struct device *dev = &iface->dev;
307
	struct usb_device *udev = interface_to_usbdev(iface);
308
	int retval = 0;
309 310 311 312

	if (dev->driver)
		return -EBUSY;

313
	dev->driver = &driver->drvwrap.driver;
314
	usb_set_intfdata(iface, priv);
315

316
	usb_pm_lock(udev);
317 318
	iface->condition = USB_INTERFACE_BOUND;
	mark_active(iface);
319
	iface->pm_usage_cnt = !(driver->supports_autosuspend);
320
	usb_pm_unlock(udev);
321 322 323 324 325

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

328
	return retval;
329 330 331 332 333 334 335 336 337 338 339 340 341
}
EXPORT_SYMBOL(usb_driver_claim_interface);

/**
 * 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.
342 343 344
 * 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.
345 346 347 348 349
 */
void usb_driver_release_interface(struct usb_driver *driver,
					struct usb_interface *iface)
{
	struct device *dev = &iface->dev;
350
	struct usb_device *udev = interface_to_usbdev(iface);
351 352

	/* this should never happen, don't release something that's not ours */
353
	if (!dev->driver || dev->driver != &driver->drvwrap.driver)
354 355 356 357 358 359 360 361 362 363 364 365 366 367
		return;

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

	/* don't release if the interface hasn't been added yet */
	if (device_is_registered(dev)) {
		iface->condition = USB_INTERFACE_UNBINDING;
		device_release_driver(dev);
	}

	dev->driver = NULL;
	usb_set_intfdata(iface, NULL);
368

369
	usb_pm_lock(udev);
370 371
	iface->condition = USB_INTERFACE_UNBOUND;
	mark_quiesced(iface);
372
	iface->needs_remote_wakeup = 0;
373
	usb_pm_unlock(udev);
374 375 376
}
EXPORT_SYMBOL(usb_driver_release_interface);

377
/* returns 0 if no match, 1 if match */
378
int usb_match_device(struct usb_device *dev, const struct usb_device_id *id)
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
{
	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) &&
	    (id->bDeviceSubClass!= dev->descriptor.bDeviceSubClass))
		return 0;

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

410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
	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;

430 431 432 433 434 435 436 437 438 439
	/* 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;

440 441 442 443 444 445 446 447 448 449 450 451 452 453
	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;
}
454 455
EXPORT_SYMBOL_GPL(usb_match_one_id);

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
/**
 * 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
510 511 512 513 514 515 516 517 518 519 520
 * 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.)
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
 *
 * 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. */
	for (; id->idVendor || id->bDeviceClass || id->bInterfaceClass ||
	       id->driver_info; id++) {
541 542
		if (usb_match_one_id(interface, id))
			return id;
543 544 545 546
	}

	return NULL;
}
547
EXPORT_SYMBOL_GPL_FUTURE(usb_match_id);
548

549
static int usb_device_match(struct device *dev, struct device_driver *drv)
550
{
551 552
	/* devices and interfaces are handled separately */
	if (is_usb_device(dev)) {
553

554 555 556
		/* interface drivers never match devices */
		if (!is_usb_device_driver(drv))
			return 0;
557

558
		/* TODO: Add real matching code */
559 560
		return 1;

561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
	} else {
		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;
	}

582 583 584
	return 0;
}

585 586 587 588 589 590 591 592 593 594 595 596 597 598
#ifdef	CONFIG_HOTPLUG
static int usb_uevent(struct device *dev, char **envp, int num_envp,
		      char *buffer, int buffer_size)
{
	struct usb_device *usb_dev;
	int i = 0;
	int length = 0;

	if (!dev)
		return -ENODEV;

	/* driver is often null here; dev_dbg() would oops */
	pr_debug ("usb %s: uevent\n", dev->bus_id);

599
	if (is_usb_device(dev))
600
		usb_dev = to_usb_device(dev);
601 602
	else {
		struct usb_interface *intf = to_usb_interface(dev);
603 604
		usb_dev = interface_to_usbdev(intf);
	}
605 606 607 608 609 610 611 612 613 614 615 616 617

	if (usb_dev->devnum < 0) {
		pr_debug ("usb %s: already deleted?\n", dev->bus_id);
		return -ENODEV;
	}
	if (!usb_dev->bus) {
		pr_debug ("usb %s: bus removed?\n", dev->bus_id);
		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
618
	 * act as usermode drivers.
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
	 */
	if (add_uevent_var(envp, num_envp, &i,
			   buffer, buffer_size, &length,
			   "DEVICE=/proc/bus/usb/%03d/%03d",
			   usb_dev->bus->busnum, usb_dev->devnum))
		return -ENOMEM;
#endif

	/* per-device configurations are common */
	if (add_uevent_var(envp, num_envp, &i,
			   buffer, buffer_size, &length,
			   "PRODUCT=%x/%x/%x",
			   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 */
	if (add_uevent_var(envp, num_envp, &i,
			   buffer, buffer_size, &length,
			   "TYPE=%d/%d/%d",
			   usb_dev->descriptor.bDeviceClass,
			   usb_dev->descriptor.bDeviceSubClass,
			   usb_dev->descriptor.bDeviceProtocol))
		return -ENOMEM;

645
	if (add_uevent_var(envp, num_envp, &i,
646
			   buffer, buffer_size, &length,
647 648 649
			   "BUSNUM=%03d",
			   usb_dev->bus->busnum))
		return -ENOMEM;
650

651
	if (add_uevent_var(envp, num_envp, &i,
652
			   buffer, buffer_size, &length,
653 654 655
			   "DEVNUM=%03d",
			   usb_dev->devnum))
		return -ENOMEM;
656 657 658 659 660 661 662 663

	envp[i] = NULL;
	return 0;
}

#else

static int usb_uevent(struct device *dev, char **envp,
664
		      int num_envp, char *buffer, int buffer_size)
665 666 667 668 669
{
	return -ENODEV;
}
#endif	/* CONFIG_HOTPLUG */

670
/**
671 672
 * usb_register_device_driver - register a USB device (not interface) driver
 * @new_udriver: USB operations for the device driver
673
 * @owner: module owner of this driver.
674
 *
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
 * 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 已提交
732
 * @mod_name: module name string
733 734 735 736
 *
 * 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.
737 738 739 740 741 742
 * 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.
 */
743 744
int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
			const char *mod_name)
745 746 747 748 749 750
{
	int retval = 0;

	if (usb_disabled())
		return -ENODEV;

751 752 753 754 755 756
	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;
757
	new_driver->drvwrap.driver.mod_name = mod_name;
758 759
	spin_lock_init(&new_driver->dynids.lock);
	INIT_LIST_HEAD(&new_driver->dynids.list);
760

761
	retval = driver_register(&new_driver->drvwrap.driver);
762 763

	if (!retval) {
764
		pr_info("%s: registered new interface driver %s\n",
765 766
			usbcore_name, new_driver->name);
		usbfs_update_special();
767
		usb_create_newid_file(new_driver);
768
	} else {
769 770
		printk(KERN_ERR "%s: error %d registering interface "
			"	driver %s\n",
771 772 773 774 775
			usbcore_name, retval, new_driver->name);
	}

	return retval;
}
776
EXPORT_SYMBOL_GPL_FUTURE(usb_register_driver);
777 778

/**
779 780
 * usb_deregister - unregister a USB interface driver
 * @driver: USB operations of the interface driver to unregister
781 782 783 784 785 786 787 788 789 790
 * 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)
{
791 792
	pr_info("%s: deregistering interface driver %s\n",
			usbcore_name, driver->name);
793

794
	usb_remove_newid_file(driver);
795
	usb_free_dynids(driver);
796
	driver_unregister(&driver->drvwrap.driver);
797 798 799

	usbfs_update_special();
}
800
EXPORT_SYMBOL_GPL_FUTURE(usb_deregister);
801 802 803

#ifdef CONFIG_PM

804
/* Caller has locked udev's pm_mutex */
805
static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
806
{
807
	struct usb_device_driver	*udriver;
808
	int				status = 0;
809

810 811 812 813
	if (udev->state == USB_STATE_NOTATTACHED ||
			udev->state == USB_STATE_SUSPENDED)
		goto done;

814 815 816 817
	/* 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 {
818
		udev->do_remote_wakeup = 0;
819
		udriver = &usb_generic_driver;
820
	}
821 822
	status = udriver->suspend(udev, msg);

A
Alan Stern 已提交
823 824
 done:
	dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
825 826 827
	if (status == 0)
		udev->dev.power.power_state.event = msg.event;
	return status;
828 829
}

830
/* Caller has locked udev's pm_mutex */
831
static int usb_resume_device(struct usb_device *udev)
832 833
{
	struct usb_device_driver	*udriver;
834
	int				status = 0;
835

A
Alan Stern 已提交
836 837 838
	if (udev->state == USB_STATE_NOTATTACHED)
		goto done;
	if (udev->state != USB_STATE_SUSPENDED && !udev->reset_resume)
839
		goto done;
840

841 842 843
	/* Can't resume it if it doesn't have a driver. */
	if (udev->dev.driver == NULL) {
		status = -ENOTCONN;
844
		goto done;
845 846
	}

A
Alan Stern 已提交
847 848 849
	if (udev->quirks & USB_QUIRK_RESET_RESUME)
		udev->reset_resume = 1;

850
	udriver = to_usb_device_driver(udev->dev.driver);
851 852
	status = udriver->resume(udev);

A
Alan Stern 已提交
853 854
 done:
	dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
855 856
	if (status == 0) {
		udev->autoresume_disabled = 0;
857
		udev->dev.power.power_state.event = PM_EVENT_ON;
858
	}
859
	return status;
860 861
}

862
/* Caller has locked intf's usb_device's pm mutex */
863
static int usb_suspend_interface(struct usb_interface *intf, pm_message_t msg)
864 865
{
	struct usb_driver	*driver;
866
	int			status = 0;
867

868 869 870
	/* with no hardware, USB interfaces only use FREEZE and ON states */
	if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
			!is_active(intf))
871
		goto done;
872

873
	if (intf->condition == USB_INTERFACE_UNBOUND)	/* This can't happen */
874
		goto done;
875
	driver = to_usb_driver(intf->dev.driver);
876 877

	if (driver->suspend && driver->resume) {
878
		status = driver->suspend(intf, msg);
879 880 881
		if (status == 0)
			mark_quiesced(intf);
		else if (!interface_to_usbdev(intf)->auto_pm)
882 883
			dev_err(&intf->dev, "%s error %d\n",
					"suspend", status);
884 885
	} else {
		// FIXME else if there's no suspend method, disconnect...
886
		// Not possible if auto_pm is set...
887 888
		dev_warn(&intf->dev, "no suspend for driver %s?\n",
				driver->name);
889 890
		mark_quiesced(intf);
	}
891

A
Alan Stern 已提交
892 893
 done:
	dev_vdbg(&intf->dev, "%s: status %d\n", __FUNCTION__, status);
894 895 896
	return status;
}

897
/* Caller has locked intf's usb_device's pm_mutex */
A
Alan Stern 已提交
898
static int usb_resume_interface(struct usb_interface *intf, int reset_resume)
899
{
900
	struct usb_driver	*driver;
901
	int			status = 0;
902

903 904
	if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
			is_active(intf))
905
		goto done;
906

907 908 909 910
	/* Don't let autoresume interfere with unbinding */
	if (intf->condition == USB_INTERFACE_UNBINDING)
		goto done;

911
	/* Can't resume it if it doesn't have a driver. */
912
	if (intf->condition == USB_INTERFACE_UNBOUND) {
913
		status = -ENOTCONN;
914
		goto done;
915
	}
916
	driver = to_usb_driver(intf->dev.driver);
917

A
Alan Stern 已提交
918 919 920
	if (reset_resume && driver->post_reset)
		driver->post_reset(intf, reset_resume);
	else if (driver->resume) {
921
		status = driver->resume(intf);
922
		if (status)
923 924
			dev_err(&intf->dev, "%s error %d\n",
					"resume", status);
A
Alan Stern 已提交
925
	} else
926 927
		dev_warn(&intf->dev, "no resume for driver %s?\n",
				driver->name);
928 929

done:
A
Alan Stern 已提交
930
	dev_vdbg(&intf->dev, "%s: status %d\n", __FUNCTION__, status);
A
Alan Stern 已提交
931 932
	if (status == 0)
		mark_active(intf);
933
	return status;
934 935
}

936 937
#ifdef	CONFIG_USB_SUSPEND

A
Alan Stern 已提交
938 939 940 941 942
/* Internal routine to check whether we may autosuspend a device. */
static int autosuspend_check(struct usb_device *udev)
{
	int			i;
	struct usb_interface	*intf;
943
	unsigned long		suspend_time;
A
Alan Stern 已提交
944

945 946 947 948
	/* For autosuspend, fail fast if anything is in use or autosuspend
	 * is disabled.  Also fail if any interfaces require remote wakeup
	 * but it isn't available.
	 */
A
Alan Stern 已提交
949 950 951
	udev->do_remote_wakeup = device_may_wakeup(&udev->dev);
	if (udev->pm_usage_cnt > 0)
		return -EBUSY;
952
	if (udev->autosuspend_delay < 0 || udev->autosuspend_disabled)
953 954
		return -EPERM;

955
	suspend_time = udev->last_busy + udev->autosuspend_delay;
A
Alan Stern 已提交
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
	if (udev->actconfig) {
		for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
			intf = udev->actconfig->interface[i];
			if (!is_active(intf))
				continue;
			if (intf->pm_usage_cnt > 0)
				return -EBUSY;
			if (intf->needs_remote_wakeup &&
					!udev->do_remote_wakeup) {
				dev_dbg(&udev->dev, "remote wakeup needed "
						"for autosuspend\n");
				return -EOPNOTSUPP;
			}
		}
	}
971 972 973 974

	/* If everything is okay but the device hasn't been idle for long
	 * enough, queue a delayed autosuspend request.
	 */
975 976 977 978 979 980 981 982 983
	if (time_after(suspend_time, jiffies)) {
		if (!timer_pending(&udev->autosuspend.timer)) {

			/* The value of jiffies may change between the
			 * time_after() comparison above and the subtraction
			 * below.  That's okay; the system behaves sanely
			 * when a timer is registered for the present moment
			 * or for the past.
			 */
984
			queue_delayed_work(ksuspend_usb_wq, &udev->autosuspend,
985 986
					suspend_time - jiffies);
			}
987 988
		return -EAGAIN;
	}
A
Alan Stern 已提交
989 990 991
	return 0;
}

992 993
#else

A
Alan Stern 已提交
994 995 996 997
static inline int autosuspend_check(struct usb_device *udev)
{
	return 0;
}
998

999
#endif	/* CONFIG_USB_SUSPEND */
1000

1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
/**
 * 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.
 *
 * If an autosuspend is in progress (@udev->auto_pm is set), the routine
 * checks first to make sure that neither the device itself or any of its
 * active interfaces is in use (pm_usage_cnt is greater than 0).  If they
 * are, the autosuspend fails.
 *
 * If the suspend succeeds, the routine recursively queues an autosuspend
 * request for @udev's parent device, thereby propagating the change up
 * the device tree.  If all of the parent's children are now suspended,
 * the parent will autosuspend in turn.
 *
 * The suspend method calls are subject to mutual exclusion under control
 * of @udev's pm_mutex.  Many of these calls are also under the protection
 * of @udev's device lock (including all requests originating outside the
 * USB subsystem), but autosuspend requests generated by a child device or
 * interface driver may not be.  Usbcore will insure that the method calls
 * do not arrive during bind, unbind, or reset operations.  However, drivers
 * must be prepared to handle suspend calls arriving at unpredictable times.
 * The only way to block such calls is to do an autoresume (preventing
 * autosuspends) while holding @udev's device lock (preventing outside
 * suspends).
 *
 * The caller must hold @udev->pm_mutex.
 *
 * This routine can run only in process context.
 */
A
Alan Stern 已提交
1037
static int usb_suspend_both(struct usb_device *udev, pm_message_t msg)
1038 1039 1040 1041
{
	int			status = 0;
	int			i = 0;
	struct usb_interface	*intf;
1042 1043
	struct usb_device	*parent = udev->parent;

1044 1045 1046
	if (udev->state == USB_STATE_NOTATTACHED ||
			udev->state == USB_STATE_SUSPENDED)
		goto done;
1047

1048 1049 1050
	udev->do_remote_wakeup = device_may_wakeup(&udev->dev);

	if (udev->auto_pm) {
A
Alan Stern 已提交
1051 1052
		status = autosuspend_check(udev);
		if (status < 0)
1053
			goto done;
1054 1055 1056
	}

	/* Suspend all the interfaces and then udev itself */
1057 1058 1059
	if (udev->actconfig) {
		for (; i < udev->actconfig->desc.bNumInterfaces; i++) {
			intf = udev->actconfig->interface[i];
1060
			status = usb_suspend_interface(intf, msg);
1061 1062 1063 1064
			if (status != 0)
				break;
		}
	}
1065 1066 1067 1068 1069 1070 1071
	if (status == 0) {

		/* Non-root devices don't need to do anything for FREEZE
		 * or PRETHAW. */
		if (udev->parent && (msg.event == PM_EVENT_FREEZE ||
				msg.event == PM_EVENT_PRETHAW))
			goto done;
1072
		status = usb_suspend_device(udev, msg);
1073
	}
1074 1075 1076 1077 1078

	/* If the suspend failed, resume interfaces that did get suspended */
	if (status != 0) {
		while (--i >= 0) {
			intf = udev->actconfig->interface[i];
A
Alan Stern 已提交
1079
			usb_resume_interface(intf, 0);
1080
		}
1081

A
Alan Stern 已提交
1082 1083 1084 1085
		/* Try another autosuspend when the interfaces aren't busy */
		if (udev->auto_pm)
			autosuspend_check(udev);

1086
	/* If the suspend succeeded, propagate it up the tree */
A
Alan Stern 已提交
1087 1088 1089 1090 1091
	} else {
		cancel_delayed_work(&udev->autosuspend);
		if (parent)
			usb_autosuspend_device(parent);
	}
1092

1093
 done:
A
Alan Stern 已提交
1094
	dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
1095 1096 1097
	return status;
}

1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
/**
 * usb_resume_both - resume a USB device and its interfaces
 * @udev: the usb_device to resume
 *
 * 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.
 *
 * Before starting the resume, the routine calls itself recursively for
 * the parent device of @udev, thereby propagating the change up the device
 * tree and assuring that @udev will be able to resume.  If the parent is
 * unable to resume successfully, the routine fails.
 *
 * The resume method calls are subject to mutual exclusion under control
 * of @udev's pm_mutex.  Many of these calls are also under the protection
 * of @udev's device lock (including all requests originating outside the
 * USB subsystem), but autoresume requests generated by a child device or
 * interface driver may not be.  Usbcore will insure that the method calls
 * do not arrive during bind, unbind, or reset operations.  However, drivers
 * must be prepared to handle resume calls arriving at unpredictable times.
 * The only way to block such calls is to do an autoresume (preventing
 * other autoresumes) while holding @udev's device lock (preventing outside
 * resumes).
 *
 * The caller must hold @udev->pm_mutex.
 *
 * This routine can run only in process context.
 */
A
Alan Stern 已提交
1126
static int usb_resume_both(struct usb_device *udev)
1127
{
1128
	int			status = 0;
1129 1130
	int			i;
	struct usb_interface	*intf;
1131 1132 1133
	struct usb_device	*parent = udev->parent;

	cancel_delayed_work(&udev->autosuspend);
1134 1135 1136 1137
	if (udev->state == USB_STATE_NOTATTACHED) {
		status = -ENODEV;
		goto done;
	}
1138

1139 1140
	/* Propagate the resume up the tree, if necessary */
	if (udev->state == USB_STATE_SUSPENDED) {
1141 1142 1143 1144
		if (udev->auto_pm && udev->autoresume_disabled) {
			status = -EPERM;
			goto done;
		}
1145
		if (parent) {
1146
			status = usb_autoresume_device(parent);
1147 1148 1149
			if (status == 0) {
				status = usb_resume_device(udev);
				if (status) {
1150
					usb_autosuspend_device(parent);
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164

					/* It's possible usb_resume_device()
					 * failed after the port was
					 * unsuspended, causing udev to be
					 * logically disconnected.  We don't
					 * want usb_disconnect() to autosuspend
					 * the parent again, so tell it that
					 * udev disconnected while still
					 * suspended. */
					if (udev->state ==
							USB_STATE_NOTATTACHED)
						udev->discon_suspended = 1;
				}
			}
1165 1166 1167 1168 1169 1170 1171 1172
		} else {

			/* We can't progagate beyond the USB subsystem,
			 * so if a root hub's controller is suspended
			 * then we're stuck. */
			if (udev->dev.parent->power.power_state.event !=
					PM_EVENT_ON)
				status = -EHOSTUNREACH;
1173 1174 1175
			else
				status = usb_resume_device(udev);
 		}
1176 1177
	} else {

A
Alan Stern 已提交
1178 1179
		/* Needed for setting udev->dev.power.power_state.event,
		 * for possible debugging message, and for reset_resume. */
1180
		status = usb_resume_device(udev);
1181 1182
	}

1183 1184 1185
	if (status == 0 && udev->actconfig) {
		for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
			intf = udev->actconfig->interface[i];
A
Alan Stern 已提交
1186
			usb_resume_interface(intf, udev->reset_resume);
1187 1188
		}
	}
1189

1190
 done:
A
Alan Stern 已提交
1191
	dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
A
Alan Stern 已提交
1192
	udev->reset_resume = 0;
1193 1194 1195 1196 1197
	return status;
}

#ifdef CONFIG_USB_SUSPEND

1198 1199 1200 1201 1202 1203 1204 1205
/* Internal routine to adjust a device's usage counter and change
 * its autosuspend state.
 */
static int usb_autopm_do_device(struct usb_device *udev, int inc_usage_cnt)
{
	int	status = 0;

	usb_pm_lock(udev);
1206
	udev->auto_pm = 1;
1207 1208 1209
	udev->pm_usage_cnt += inc_usage_cnt;
	WARN_ON(udev->pm_usage_cnt < 0);
	if (inc_usage_cnt >= 0 && udev->pm_usage_cnt > 0) {
1210 1211
		if (udev->state == USB_STATE_SUSPENDED)
			status = usb_resume_both(udev);
1212 1213
		if (status != 0)
			udev->pm_usage_cnt -= inc_usage_cnt;
1214 1215 1216 1217 1218 1219 1220
		else if (inc_usage_cnt)
			udev->last_busy = jiffies;
	} else if (inc_usage_cnt <= 0 && udev->pm_usage_cnt <= 0) {
		if (inc_usage_cnt)
			udev->last_busy = jiffies;
		status = usb_suspend_both(udev, PMSG_SUSPEND);
	}
1221 1222 1223 1224
	usb_pm_unlock(udev);
	return status;
}

1225 1226 1227 1228 1229 1230 1231 1232 1233
/* usb_autosuspend_work - callback routine to autosuspend a USB device */
void usb_autosuspend_work(struct work_struct *work)
{
	struct usb_device *udev =
		container_of(work, struct usb_device, autosuspend.work);

	usb_autopm_do_device(udev, 0);
}

1234 1235
/**
 * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
1236
 * @udev: the usb_device to autosuspend
1237 1238 1239 1240 1241
 *
 * 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.
 *
1242 1243 1244 1245 1246 1247
 * @udev's usage counter is decremented.  If it or any of the usage counters
 * for an active interface is greater than 0, no autosuspend request will be
 * queued.  (If an interface driver does not support autosuspend then its
 * usage counter is permanently positive.)  Furthermore, if an interface
 * driver requires remote-wakeup capability during autosuspend but remote
 * wakeup is disabled, the autosuspend will fail.
1248 1249 1250 1251 1252 1253
 *
 * Often the caller will hold @udev's device lock, but this is not
 * necessary.
 *
 * This routine can run only in process context.
 */
1254
void usb_autosuspend_device(struct usb_device *udev)
1255
{
1256 1257 1258
	int	status;

	status = usb_autopm_do_device(udev, -1);
A
Alan Stern 已提交
1259 1260
	dev_vdbg(&udev->dev, "%s: cnt %d\n",
			__FUNCTION__, udev->pm_usage_cnt);
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
}

/**
 * usb_try_autosuspend_device - attempt an autosuspend of a USB device and its interfaces
 * @udev: the usb_device to autosuspend
 *
 * This routine should be called when a core subsystem thinks @udev may
 * be ready to autosuspend.
 *
 * @udev's usage counter left unchanged.  If it or any of the usage counters
 * for an active interface is greater than 0, or autosuspend is not allowed
 * for any other reason, no autosuspend request will be queued.
 *
 * This routine can run only in process context.
 */
void usb_try_autosuspend_device(struct usb_device *udev)
{
	usb_autopm_do_device(udev, 0);
A
Alan Stern 已提交
1279 1280
	dev_vdbg(&udev->dev, "%s: cnt %d\n",
			__FUNCTION__, udev->pm_usage_cnt);
1281 1282 1283 1284
}

/**
 * usb_autoresume_device - immediately autoresume a USB device and its interfaces
1285
 * @udev: the usb_device to autoresume
1286 1287
 *
 * This routine should be called when a core subsystem wants to use @udev
1288 1289 1290 1291 1292
 * and needs to guarantee that it is not suspended.  No autosuspend will
 * 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
 * request is received.
1293
 *
1294 1295
 * @udev's usage counter is incremented to prevent subsequent autosuspends.
 * However if the autoresume fails then the usage counter is re-decremented.
1296 1297 1298 1299 1300 1301
 *
 * Often the caller will hold @udev's device lock, but this is not
 * necessary (and attempting it might cause deadlock).
 *
 * This routine can run only in process context.
 */
1302
int usb_autoresume_device(struct usb_device *udev)
1303 1304 1305
{
	int	status;

1306
	status = usb_autopm_do_device(udev, 1);
A
Alan Stern 已提交
1307 1308
	dev_vdbg(&udev->dev, "%s: status %d cnt %d\n",
			__FUNCTION__, status, udev->pm_usage_cnt);
1309 1310 1311
	return status;
}

A
Alan Stern 已提交
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
/* Internal routine to adjust an interface's usage counter and change
 * its device's autosuspend state.
 */
static int usb_autopm_do_interface(struct usb_interface *intf,
		int inc_usage_cnt)
{
	struct usb_device	*udev = interface_to_usbdev(intf);
	int			status = 0;

	usb_pm_lock(udev);
	if (intf->condition == USB_INTERFACE_UNBOUND)
		status = -ENODEV;
	else {
1325
		udev->auto_pm = 1;
A
Alan Stern 已提交
1326 1327
		intf->pm_usage_cnt += inc_usage_cnt;
		if (inc_usage_cnt >= 0 && intf->pm_usage_cnt > 0) {
1328 1329
			if (udev->state == USB_STATE_SUSPENDED)
				status = usb_resume_both(udev);
A
Alan Stern 已提交
1330 1331
			if (status != 0)
				intf->pm_usage_cnt -= inc_usage_cnt;
1332 1333 1334 1335 1336 1337 1338
			else if (inc_usage_cnt)
				udev->last_busy = jiffies;
		} else if (inc_usage_cnt <= 0 && intf->pm_usage_cnt <= 0) {
			if (inc_usage_cnt)
				udev->last_busy = jiffies;
			status = usb_suspend_both(udev, PMSG_SUSPEND);
		}
A
Alan Stern 已提交
1339 1340 1341 1342 1343
	}
	usb_pm_unlock(udev);
	return status;
}

1344 1345
/**
 * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
1346
 * @intf: the usb_interface whose counter should be decremented
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
 *
 * 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
 * 0, a delayed autosuspend request for @intf's device is queued.  When
 * the delay expires, if @intf->pm_usage_cnt is still <= 0 along with all
 * the other usage counters for the sibling interfaces and @intf's
 * usb_device, the device and all its interfaces will be autosuspended.
 *
 * Note that @intf->pm_usage_cnt is owned by the interface driver.  The
 * core will not change its value other than the increment and decrement
 * in usb_autopm_get_interface and usb_autopm_put_interface.  The driver
 * may use this simple counter-oriented discipline or may set the value
 * any way it likes.
 *
 * If the driver has set @intf->needs_remote_wakeup then autosuspend will
 * take place only if the device's remote-wakeup facility is enabled.
 *
 * Suspend method calls queued by this routine can arrive at any time
 * while @intf is resumed and its usage counter is equal to 0.  They are
 * not protected by the usb_device's lock but only by its pm_mutex.
 * Drivers must provide their own synchronization.
 *
 * This routine can run only in process context.
 */
void usb_autopm_put_interface(struct usb_interface *intf)
{
A
Alan Stern 已提交
1377
	int	status;
1378

A
Alan Stern 已提交
1379
	status = usb_autopm_do_interface(intf, -1);
A
Alan Stern 已提交
1380 1381
	dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
			__FUNCTION__, status, intf->pm_usage_cnt);
1382 1383 1384 1385 1386
}
EXPORT_SYMBOL_GPL(usb_autopm_put_interface);

/**
 * usb_autopm_get_interface - increment a USB interface's PM-usage counter
1387
 * @intf: the usb_interface whose counter should be incremented
1388 1389 1390 1391 1392 1393 1394 1395 1396
 *
 * 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.
 *
1397 1398 1399 1400 1401 1402 1403 1404
 *
 * The routine increments @intf's usage counter.  (However if the
 * autoresume fails then the counter is re-decremented.)  So long as the
 * counter is greater than 0, autosuspend will not be allowed for @intf
 * or its usb_device.  When the driver is finished using @intf it should
 * call usb_autopm_put_interface() to decrement the usage counter and
 * queue a delayed autosuspend request (if the counter is <= 0).
 *
1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
 *
 * Note that @intf->pm_usage_cnt is owned by the interface driver.  The
 * core will not change its value other than the increment and decrement
 * in usb_autopm_get_interface and usb_autopm_put_interface.  The driver
 * may use this simple counter-oriented discipline or may set the value
 * any way it likes.
 *
 * Resume method calls generated by this routine can arrive at any time
 * while @intf is suspended.  They are not protected by the usb_device's
 * lock but only by its pm_mutex.  Drivers must provide their own
 * synchronization.
 *
 * This routine can run only in process context.
 */
int usb_autopm_get_interface(struct usb_interface *intf)
{
A
Alan Stern 已提交
1421
	int	status;
1422

A
Alan Stern 已提交
1423
	status = usb_autopm_do_interface(intf, 1);
A
Alan Stern 已提交
1424 1425
	dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
			__FUNCTION__, status, intf->pm_usage_cnt);
1426 1427
	return status;
}
1428 1429
EXPORT_SYMBOL_GPL(usb_autopm_get_interface);

1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445
/**
 * usb_autopm_set_interface - set a USB interface's autosuspend state
 * @intf: the usb_interface whose state should be set
 *
 * This routine sets the autosuspend state of @intf's device according
 * to @intf's usage counter, which the caller must have set previously.
 * If the counter is <= 0, the device is autosuspended (if it isn't
 * already suspended and if nothing else prevents the autosuspend).  If
 * the counter is > 0, the device is autoresumed (if it isn't already
 * awake).
 */
int usb_autopm_set_interface(struct usb_interface *intf)
{
	int	status;

	status = usb_autopm_do_interface(intf, 0);
A
Alan Stern 已提交
1446 1447
	dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
			__FUNCTION__, status, intf->pm_usage_cnt);
1448 1449 1450 1451
	return status;
}
EXPORT_SYMBOL_GPL(usb_autopm_set_interface);

A
Alan Stern 已提交
1452 1453 1454 1455 1456
#else

void usb_autosuspend_work(struct work_struct *work)
{}

1457
#endif /* CONFIG_USB_SUSPEND */
1458

1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
/**
 * usb_external_suspend_device - external suspend of a USB device and its interfaces
 * @udev: the usb_device to suspend
 * @msg: Power Management message describing this state transition
 *
 * This routine handles external suspend requests: ones not generated
 * internally by a USB driver (autosuspend) but rather coming from the user
 * (via sysfs) or the PM core (system sleep).  The suspend will be carried
 * out regardless of @udev's usage counter or those of its interfaces,
 * and regardless of whether or not remote wakeup is enabled.  Of course,
 * interface drivers still have the option of failing the suspend (if
 * there are unsuspended children, for example).
 *
 * The caller must hold @udev's device lock.
 */
int usb_external_suspend_device(struct usb_device *udev, pm_message_t msg)
1475 1476 1477
{
	int	status;

1478 1479 1480 1481
	usb_pm_lock(udev);
	udev->auto_pm = 0;
	status = usb_suspend_both(udev, msg);
	usb_pm_unlock(udev);
1482 1483 1484
	return status;
}

1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496
/**
 * usb_external_resume_device - external resume of a USB device and its interfaces
 * @udev: the usb_device to resume
 *
 * This routine handles external resume requests: ones not generated
 * internally by a USB driver (autoresume) but rather coming from the user
 * (via sysfs), the PM core (system resume), or the device itself (remote
 * wakeup).  @udev's usage counter is unaffected.
 *
 * The caller must hold @udev's device lock.
 */
int usb_external_resume_device(struct usb_device *udev)
1497 1498 1499
{
	int	status;

1500 1501 1502
	usb_pm_lock(udev);
	udev->auto_pm = 0;
	status = usb_resume_both(udev);
A
Alan Stern 已提交
1503
	udev->last_busy = jiffies;
1504
	usb_pm_unlock(udev);
1505

1506 1507 1508 1509
	/* Now that the device is awake, we can start trying to autosuspend
	 * it again. */
	if (status == 0)
		usb_try_autosuspend_device(udev);
1510 1511 1512
	return status;
}

1513 1514 1515 1516 1517 1518 1519 1520 1521
static int usb_suspend(struct device *dev, pm_message_t message)
{
	if (!is_usb_device(dev))	/* Ignore PM for interfaces */
		return 0;
	return usb_external_suspend_device(to_usb_device(dev), message);
}

static int usb_resume(struct device *dev)
{
1522 1523
	struct usb_device	*udev;

1524 1525
	if (!is_usb_device(dev))	/* Ignore PM for interfaces */
		return 0;
1526
	udev = to_usb_device(dev);
A
Alan Stern 已提交
1527 1528 1529 1530 1531 1532 1533 1534 1535

	/* If autoresume is disabled then we also want to prevent resume
	 * during system wakeup.  However, a "persistent-device" reset-resume
	 * after power loss counts as a wakeup event.  So allow a
	 * reset-resume to occur if remote wakeup is enabled. */
	if (udev->autoresume_disabled) {
		if (!(udev->reset_resume && udev->do_remote_wakeup))
			return -EPERM;
	}
1536
	return usb_external_resume_device(udev);
1537 1538 1539 1540 1541 1542 1543
}

#else

#define usb_suspend	NULL
#define usb_resume	NULL

1544 1545 1546 1547 1548 1549
#endif /* CONFIG_PM */

struct bus_type usb_bus_type = {
	.name =		"usb",
	.match =	usb_device_match,
	.uevent =	usb_uevent,
1550 1551
	.suspend =	usb_suspend,
	.resume =	usb_resume,
1552
};