driver.c 49.4 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
#ifdef CONFIG_HOTPLUG

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

	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;

62
	spin_lock(&dynids->lock);
63
	list_add_tail(&dynid->node, &dynids->list);
64
	spin_unlock(&dynids->lock);
65 66

	if (get_driver(driver)) {
67
		retval = driver_attach(driver);
68 69 70
		put_driver(driver);
	}

71 72
	if (retval)
		return retval;
73 74
	return count;
}
75 76 77 78 79 80 81 82 83
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);
}
84 85 86 87 88 89
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;

90 91 92
	if (usb_drv->no_dynamic_id)
		goto exit;

93
	if (usb_drv->probe != NULL)
94 95
		error = driver_create_file(&usb_drv->drvwrap.driver,
					   &driver_attr_new_id);
96
exit:
97 98 99
	return error;
}

100 101 102 103 104 105
static void usb_remove_newid_file(struct usb_driver *usb_drv)
{
	if (usb_drv->no_dynamic_id)
		return;

	if (usb_drv->probe != NULL)
106 107
		driver_remove_file(&usb_drv->drvwrap.driver,
				   &driver_attr_new_id);
108 109
}

110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
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;
}

127 128 129 130
static void usb_remove_newid_file(struct usb_driver *usb_drv)
{
}

131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
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;
}


153 154 155 156 157 158 159
/* 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;

160
	dev_dbg(dev, "%s\n", __func__);
161 162 163 164 165 166 167 168

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

	udev = to_usb_device(dev);

	/* TODO: Add real matching code */

169 170 171 172 173
	/* The device should always appear to be in use
	 * unless the driver suports autosuspend.
	 */
	udev->pm_usage_cnt = !(udriver->supports_autosuspend);

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
	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 */
189 190
static int usb_probe_interface(struct device *dev)
{
191 192
	struct usb_driver *driver = to_usb_driver(dev->driver);
	struct usb_interface *intf;
193
	struct usb_device *udev;
194 195 196
	const struct usb_device_id *id;
	int error = -ENODEV;

197
	dev_dbg(dev, "%s\n", __func__);
198

199
	if (is_usb_device(dev))		/* Sanity check */
200
		return error;
201 202

	intf = to_usb_interface(dev);
203
	udev = interface_to_usbdev(intf);
204
	intf->needs_binding = 0;
205

206 207 208 209
	if (udev->authorized == 0) {
		dev_err(&intf->dev, "Device is not authorized for usage\n");
		return -ENODEV;
	}
210

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

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

221 222 223 224 225 226
		/* 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;
227 228 229 230 231 232

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

233 234 235 236 237 238 239
		/* Carry out a deferred switch to altsetting 0 */
		if (intf->needs_altsetting0) {
			usb_set_interface(udev, intf->altsetting[0].
					desc.bInterfaceNumber, 0);
			intf->needs_altsetting0 = 0;
		}

240 241 242
		error = driver->probe(intf, id);
		if (error) {
			mark_quiesced(intf);
243
			intf->needs_remote_wakeup = 0;
244 245 246
			intf->condition = USB_INTERFACE_UNBOUND;
		} else
			intf->condition = USB_INTERFACE_BOUND;
247

248
		usb_autosuspend_device(udev);
249 250 251 252 253
	}

	return error;
}

254
/* called from driver core with dev locked */
255 256
static int usb_unbind_interface(struct device *dev)
{
257
	struct usb_driver *driver = to_usb_driver(dev->driver);
258
	struct usb_interface *intf = to_usb_interface(dev);
259 260
	struct usb_device *udev;
	int error;
261 262 263

	intf->condition = USB_INTERFACE_UNBINDING;

264 265
	/* Autoresume for set_interface call below */
	udev = interface_to_usbdev(intf);
266
	error = usb_autoresume_device(udev);
267

A
Alan Stern 已提交
268 269 270 271 272
	/* Terminate all URBs for this interface unless the driver
	 * supports "soft" unbinding.
	 */
	if (!driver->soft_unbind)
		usb_disable_interface(udev, intf);
273

274
	driver->disconnect(intf);
275

276 277 278 279 280 281 282 283 284 285 286
	/* 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.
	 */
	if (!error && intf->dev.power.status == DPM_ON)
		usb_set_interface(udev, intf->altsetting[0].
				desc.bInterfaceNumber, 0);
	else
		intf->needs_altsetting0 = 1;
287
	usb_set_intfdata(intf, NULL);
288

289 290
	intf->condition = USB_INTERFACE_UNBOUND;
	mark_quiesced(intf);
291 292 293
	intf->needs_remote_wakeup = 0;

	if (!error)
294
		usb_autosuspend_device(udev);
295 296 297 298

	return 0;
}

299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
/**
 * 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.
 *
315 316 317
 * 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.
318 319
 */
int usb_driver_claim_interface(struct usb_driver *driver,
320
				struct usb_interface *iface, void *priv)
321 322
{
	struct device *dev = &iface->dev;
323
	struct usb_device *udev = interface_to_usbdev(iface);
324
	int retval = 0;
325 326 327 328

	if (dev->driver)
		return -EBUSY;

329
	dev->driver = &driver->drvwrap.driver;
330
	usb_set_intfdata(iface, priv);
331
	iface->needs_binding = 0;
332

333
	usb_pm_lock(udev);
334 335
	iface->condition = USB_INTERFACE_BOUND;
	mark_active(iface);
336
	iface->pm_usage_cnt = !(driver->supports_autosuspend);
337
	usb_pm_unlock(udev);
338 339 340 341 342

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

345
	return retval;
346
}
347
EXPORT_SYMBOL_GPL(usb_driver_claim_interface);
348 349 350 351 352 353 354 355 356 357 358

/**
 * 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.
359 360 361
 * 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.
362 363 364 365 366
 */
void usb_driver_release_interface(struct usb_driver *driver,
					struct usb_interface *iface)
{
	struct device *dev = &iface->dev;
367
	struct usb_device *udev = interface_to_usbdev(iface);
368 369

	/* this should never happen, don't release something that's not ours */
370
	if (!dev->driver || dev->driver != &driver->drvwrap.driver)
371 372 373 374 375 376 377 378 379 380 381 382 383 384
		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);
385

386
	usb_pm_lock(udev);
387 388
	iface->condition = USB_INTERFACE_UNBOUND;
	mark_quiesced(iface);
389
	iface->needs_remote_wakeup = 0;
390
	usb_pm_unlock(udev);
391
}
392
EXPORT_SYMBOL_GPL(usb_driver_release_interface);
393

394
/* returns 0 if no match, 1 if match */
395
int usb_match_device(struct usb_device *dev, const struct usb_device_id *id)
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
{
	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) &&
420
	    (id->bDeviceSubClass != dev->descriptor.bDeviceSubClass))
421 422 423 424 425 426
		return 0;

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

427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
	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;

447 448 449 450 451 452 453 454 455 456
	/* 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;

457 458 459 460 461 462 463 464 465 466 467 468 469 470
	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;
}
471 472
EXPORT_SYMBOL_GPL(usb_match_one_id);

473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
/**
 * 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
527 528 529 530 531 532 533 534 535 536 537
 * 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.)
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
 *
 * 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. */
556 557
	for (; id->idVendor || id->idProduct || id->bDeviceClass ||
	       id->bInterfaceClass || id->driver_info; id++) {
558 559
		if (usb_match_one_id(interface, id))
			return id;
560 561 562 563
	}

	return NULL;
}
564
EXPORT_SYMBOL_GPL(usb_match_id);
565

566
static int usb_device_match(struct device *dev, struct device_driver *drv)
567
{
568 569
	/* devices and interfaces are handled separately */
	if (is_usb_device(dev)) {
570

571 572 573
		/* interface drivers never match devices */
		if (!is_usb_device_driver(drv))
			return 0;
574

575
		/* TODO: Add real matching code */
576 577
		return 1;

578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
	} 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;
	}

599 600 601
	return 0;
}

602
#ifdef	CONFIG_HOTPLUG
603
static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
604 605 606 607
{
	struct usb_device *usb_dev;

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

610
	if (is_usb_device(dev))
611
		usb_dev = to_usb_device(dev);
612 613
	else {
		struct usb_interface *intf = to_usb_interface(dev);
614 615
		usb_dev = interface_to_usbdev(intf);
	}
616 617

	if (usb_dev->devnum < 0) {
618
		pr_debug("usb %s: already deleted?\n", dev_name(dev));
619 620 621
		return -ENODEV;
	}
	if (!usb_dev->bus) {
622
		pr_debug("usb %s: bus removed?\n", dev_name(dev));
623 624 625 626 627 628
		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
629
	 * act as usermode drivers.
630
	 */
631
	if (add_uevent_var(env, "DEVICE=/proc/bus/usb/%03d/%03d",
632 633 634 635 636
			   usb_dev->bus->busnum, usb_dev->devnum))
		return -ENOMEM;
#endif

	/* per-device configurations are common */
637
	if (add_uevent_var(env, "PRODUCT=%x/%x/%x",
638 639 640 641 642 643
			   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 */
644
	if (add_uevent_var(env, "TYPE=%d/%d/%d",
645 646 647 648 649 650 651 652 653 654
			   usb_dev->descriptor.bDeviceClass,
			   usb_dev->descriptor.bDeviceSubClass,
			   usb_dev->descriptor.bDeviceProtocol))
		return -ENOMEM;

	return 0;
}

#else

655
static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
656 657 658 659 660
{
	return -ENODEV;
}
#endif	/* CONFIG_HOTPLUG */

661
/**
662 663
 * usb_register_device_driver - register a USB device (not interface) driver
 * @new_udriver: USB operations for the device driver
664
 * @owner: module owner of this driver.
665
 *
666 667 668 669 670 671 672 673 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
 * 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 已提交
723
 * @mod_name: module name string
724 725 726 727
 *
 * 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.
728 729 730 731 732 733
 * 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.
 */
734 735
int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
			const char *mod_name)
736 737 738 739 740 741
{
	int retval = 0;

	if (usb_disabled())
		return -ENODEV;

742 743 744 745 746 747
	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;
748
	new_driver->drvwrap.driver.mod_name = mod_name;
749 750
	spin_lock_init(&new_driver->dynids.lock);
	INIT_LIST_HEAD(&new_driver->dynids.list);
751

752
	retval = driver_register(&new_driver->drvwrap.driver);
753 754

	if (!retval) {
755
		pr_info("%s: registered new interface driver %s\n",
756 757
			usbcore_name, new_driver->name);
		usbfs_update_special();
758
		usb_create_newid_file(new_driver);
759
	} else {
760 761
		printk(KERN_ERR "%s: error %d registering interface "
			"	driver %s\n",
762 763 764 765 766
			usbcore_name, retval, new_driver->name);
	}

	return retval;
}
767
EXPORT_SYMBOL_GPL(usb_register_driver);
768 769

/**
770 771
 * usb_deregister - unregister a USB interface driver
 * @driver: USB operations of the interface driver to unregister
772 773 774 775 776 777 778 779 780 781
 * 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)
{
782 783
	pr_info("%s: deregistering interface driver %s\n",
			usbcore_name, driver->name);
784

785
	usb_remove_newid_file(driver);
786
	usb_free_dynids(driver);
787
	driver_unregister(&driver->drvwrap.driver);
788 789 790

	usbfs_update_special();
}
791
EXPORT_SYMBOL_GPL(usb_deregister);
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
/* 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.
 *
817 818
 * Note: Rebinds will be skipped if a system sleep transition is in
 * progress and the PM "complete" callback hasn't occurred yet.
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
 */
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 */
834 835 836 837 838 839
	if (intf->dev.power.status == DPM_ON) {
		intf->needs_binding = 0;
		rc = device_attach(&intf->dev);
		if (rc < 0)
			dev_warn(&intf->dev, "rebind failed: %d\n", rc);
	}
840 841
}

A
Alan Stern 已提交
842 843
#ifdef CONFIG_PM

844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
#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:
872
				if (intf->needs_binding)
873 874 875 876 877 878 879
					usb_rebind_intf(intf);
				break;
			}
		}
	}
}

880
/* Caller has locked udev's pm_mutex */
881
static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
882
{
883
	struct usb_device_driver	*udriver;
884
	int				status = 0;
885

886 887 888 889
	if (udev->state == USB_STATE_NOTATTACHED ||
			udev->state == USB_STATE_SUSPENDED)
		goto done;

890 891 892 893
	/* 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 {
894
		udev->do_remote_wakeup = 0;
895
		udriver = &usb_generic_driver;
896
	}
897 898
	status = udriver->suspend(udev, msg);

A
Alan Stern 已提交
899
 done:
900
	dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
901
	return status;
902 903
}

904
/* Caller has locked udev's pm_mutex */
905
static int usb_resume_device(struct usb_device *udev)
906 907
{
	struct usb_device_driver	*udriver;
908
	int				status = 0;
909

A
Alan Stern 已提交
910 911
	if (udev->state == USB_STATE_NOTATTACHED)
		goto done;
912

913 914 915
	/* Can't resume it if it doesn't have a driver. */
	if (udev->dev.driver == NULL) {
		status = -ENOTCONN;
916
		goto done;
917 918
	}

A
Alan Stern 已提交
919 920 921
	if (udev->quirks & USB_QUIRK_RESET_RESUME)
		udev->reset_resume = 1;

922
	udriver = to_usb_device_driver(udev->dev.driver);
923 924
	status = udriver->resume(udev);

A
Alan Stern 已提交
925
 done:
926
	dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
A
Alan Stern 已提交
927
	if (status == 0)
928
		udev->autoresume_disabled = 0;
929
	return status;
930 931
}

932
/* Caller has locked intf's usb_device's pm mutex */
933 934
static int usb_suspend_interface(struct usb_device *udev,
		struct usb_interface *intf, pm_message_t msg)
935 936
{
	struct usb_driver	*driver;
937
	int			status = 0;
938

939
	/* with no hardware, USB interfaces only use FREEZE and ON states */
940
	if (udev->state == USB_STATE_NOTATTACHED || !is_active(intf))
941
		goto done;
942

943
	if (intf->condition == USB_INTERFACE_UNBOUND)	/* This can't happen */
944
		goto done;
945
	driver = to_usb_driver(intf->dev.driver);
946

947
	if (driver->suspend) {
948
		status = driver->suspend(intf, msg);
949 950
		if (status == 0)
			mark_quiesced(intf);
951
		else if (!udev->auto_pm)
952 953
			dev_err(&intf->dev, "%s error %d\n",
					"suspend", status);
954
	} else {
955 956 957 958
		/* Later we will unbind the driver and reprobe */
		intf->needs_binding = 1;
		dev_warn(&intf->dev, "no %s for driver %s?\n",
				"suspend", driver->name);
959 960
		mark_quiesced(intf);
	}
961

A
Alan Stern 已提交
962
 done:
963
	dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
964 965 966
	return status;
}

967
/* Caller has locked intf's usb_device's pm_mutex */
968 969
static int usb_resume_interface(struct usb_device *udev,
		struct usb_interface *intf, int reset_resume)
970
{
971
	struct usb_driver	*driver;
972
	int			status = 0;
973

974
	if (udev->state == USB_STATE_NOTATTACHED || is_active(intf))
975
		goto done;
976

977 978 979 980
	/* Don't let autoresume interfere with unbinding */
	if (intf->condition == USB_INTERFACE_UNBINDING)
		goto done;

981
	/* Can't resume it if it doesn't have a driver. */
982 983 984 985 986 987 988 989 990
	if (intf->condition == USB_INTERFACE_UNBOUND) {

		/* Carry out a deferred switch to altsetting 0 */
		if (intf->needs_altsetting0 &&
				intf->dev.power.status == DPM_ON) {
			usb_set_interface(udev, intf->altsetting[0].
					desc.bInterfaceNumber, 0);
			intf->needs_altsetting0 = 0;
		}
991
		goto done;
992
	}
993 994 995

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

A
Alan Stern 已提交
999 1000 1001 1002 1003 1004 1005
	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 {
1006
			intf->needs_binding = 1;
A
Alan Stern 已提交
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
			dev_warn(&intf->dev, "no %s for driver %s?\n",
					"reset_resume", driver->name);
		}
	} else {
		if (driver->resume) {
			status = driver->resume(intf);
			if (status)
				dev_err(&intf->dev, "%s error %d\n",
						"resume", status);
		} else {
1017
			intf->needs_binding = 1;
A
Alan Stern 已提交
1018 1019 1020 1021
			dev_warn(&intf->dev, "no %s for driver %s?\n",
					"resume", driver->name);
		}
	}
1022 1023

done:
1024
	dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
1025
	if (status == 0 && intf->condition == USB_INTERFACE_BOUND)
A
Alan Stern 已提交
1026
		mark_active(intf);
A
Alan Stern 已提交
1027

1028
	/* Later we will unbind the driver and/or reprobe, if necessary */
1029
	return status;
1030 1031
}

1032 1033
#ifdef	CONFIG_USB_SUSPEND

A
Alan Stern 已提交
1034
/* Internal routine to check whether we may autosuspend a device. */
1035
static int autosuspend_check(struct usb_device *udev, int reschedule)
A
Alan Stern 已提交
1036 1037 1038
{
	int			i;
	struct usb_interface	*intf;
1039
	unsigned long		suspend_time, j;
A
Alan Stern 已提交
1040

1041 1042 1043 1044
	/* 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 已提交
1045 1046
	if (udev->pm_usage_cnt > 0)
		return -EBUSY;
1047
	if (udev->autosuspend_delay < 0 || udev->autosuspend_disabled)
1048 1049
		return -EPERM;

1050
	suspend_time = udev->last_busy + udev->autosuspend_delay;
A
Alan Stern 已提交
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
	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;
			}
A
Alan Stern 已提交
1064 1065 1066 1067 1068 1069 1070 1071 1072

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

				driver = to_usb_driver(intf->dev.driver);
1073 1074
				if (!driver->reset_resume ||
				    intf->needs_remote_wakeup)
A
Alan Stern 已提交
1075 1076
					return -EOPNOTSUPP;
			}
A
Alan Stern 已提交
1077 1078
		}
	}
1079 1080

	/* If everything is okay but the device hasn't been idle for long
1081 1082 1083
	 * enough, queue a delayed autosuspend request.  If the device
	 * _has_ been idle for long enough and the reschedule flag is set,
	 * likewise queue a delayed (1 second) autosuspend request.
1084
	 */
1085 1086 1087 1088 1089 1090
	j = jiffies;
	if (time_before(j, suspend_time))
		reschedule = 1;
	else
		suspend_time = j + HZ;
	if (reschedule) {
1091
		if (!timer_pending(&udev->autosuspend.timer)) {
1092
			queue_delayed_work(ksuspend_usb_wq, &udev->autosuspend,
1093 1094
				round_jiffies_relative(suspend_time - j));
		}
1095 1096
		return -EAGAIN;
	}
A
Alan Stern 已提交
1097 1098 1099
	return 0;
}

1100 1101
#else

1102
static inline int autosuspend_check(struct usb_device *udev, int reschedule)
A
Alan Stern 已提交
1103 1104 1105
{
	return 0;
}
1106

1107
#endif	/* CONFIG_USB_SUSPEND */
1108

1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
/**
 * 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 已提交
1145
static int usb_suspend_both(struct usb_device *udev, pm_message_t msg)
1146 1147 1148 1149
{
	int			status = 0;
	int			i = 0;
	struct usb_interface	*intf;
1150 1151
	struct usb_device	*parent = udev->parent;

1152 1153 1154
	if (udev->state == USB_STATE_NOTATTACHED ||
			udev->state == USB_STATE_SUSPENDED)
		goto done;
1155

1156 1157 1158
	udev->do_remote_wakeup = device_may_wakeup(&udev->dev);

	if (udev->auto_pm) {
1159
		status = autosuspend_check(udev, 0);
A
Alan Stern 已提交
1160
		if (status < 0)
1161
			goto done;
1162 1163 1164
	}

	/* Suspend all the interfaces and then udev itself */
1165 1166 1167
	if (udev->actconfig) {
		for (; i < udev->actconfig->desc.bNumInterfaces; i++) {
			intf = udev->actconfig->interface[i];
1168
			status = usb_suspend_interface(udev, intf, msg);
1169 1170 1171 1172
			if (status != 0)
				break;
		}
	}
1173
	if (status == 0)
1174
		status = usb_suspend_device(udev, msg);
1175 1176 1177 1178 1179

	/* If the suspend failed, resume interfaces that did get suspended */
	if (status != 0) {
		while (--i >= 0) {
			intf = udev->actconfig->interface[i];
1180
			usb_resume_interface(udev, intf, 0);
1181
		}
1182

A
Alan Stern 已提交
1183 1184
		/* Try another autosuspend when the interfaces aren't busy */
		if (udev->auto_pm)
1185
			autosuspend_check(udev, status == -EBUSY);
A
Alan Stern 已提交
1186

1187 1188 1189
	/* If the suspend succeeded then prevent any more URB submissions,
	 * flush any outstanding URBs, and propagate the suspend up the tree.
	 */
A
Alan Stern 已提交
1190 1191
	} else {
		cancel_delayed_work(&udev->autosuspend);
1192 1193 1194 1195 1196
		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]);
		}
1197 1198 1199 1200 1201 1202

		/* If this is just a FREEZE or a PRETHAW, udev might
		 * not really be suspended.  Only true suspends get
		 * propagated up the device tree.
		 */
		if (parent && udev->state == USB_STATE_SUSPENDED)
A
Alan Stern 已提交
1203 1204
			usb_autosuspend_device(parent);
	}
1205

1206
 done:
1207
	dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1208 1209 1210
	return status;
}

1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
/**
 * 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 已提交
1239
static int usb_resume_both(struct usb_device *udev)
1240
{
1241
	int			status = 0;
1242 1243
	int			i;
	struct usb_interface	*intf;
1244 1245 1246
	struct usb_device	*parent = udev->parent;

	cancel_delayed_work(&udev->autosuspend);
1247 1248 1249 1250
	if (udev->state == USB_STATE_NOTATTACHED) {
		status = -ENODEV;
		goto done;
	}
1251
	udev->can_submit = 1;
1252

1253 1254
	/* Propagate the resume up the tree, if necessary */
	if (udev->state == USB_STATE_SUSPENDED) {
1255 1256 1257 1258
		if (udev->auto_pm && udev->autoresume_disabled) {
			status = -EPERM;
			goto done;
		}
1259
		if (parent) {
1260
			status = usb_autoresume_device(parent);
1261 1262
			if (status == 0) {
				status = usb_resume_device(udev);
A
Alan Stern 已提交
1263 1264
				if (status || udev->state ==
						USB_STATE_NOTATTACHED) {
1265
					usb_autosuspend_device(parent);
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279

					/* 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;
				}
			}
1280 1281 1282 1283 1284
		} else {

			/* We can't progagate beyond the USB subsystem,
			 * so if a root hub's controller is suspended
			 * then we're stuck. */
1285
			status = usb_resume_device(udev);
1286
		}
A
Alan Stern 已提交
1287
	} else if (udev->reset_resume)
1288
		status = usb_resume_device(udev);
1289

1290 1291 1292
	if (status == 0 && udev->actconfig) {
		for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
			intf = udev->actconfig->interface[i];
1293
			usb_resume_interface(udev, intf, udev->reset_resume);
1294 1295
		}
	}
1296

1297
 done:
1298
	dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
A
Alan Stern 已提交
1299 1300
	if (!status)
		udev->reset_resume = 0;
1301 1302 1303 1304 1305
	return status;
}

#ifdef CONFIG_USB_SUSPEND

1306 1307 1308 1309 1310 1311 1312 1313
/* 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);
1314
	udev->auto_pm = 1;
1315 1316
	udev->pm_usage_cnt += inc_usage_cnt;
	WARN_ON(udev->pm_usage_cnt < 0);
1317 1318
	if (inc_usage_cnt)
		udev->last_busy = jiffies;
1319
	if (inc_usage_cnt >= 0 && udev->pm_usage_cnt > 0) {
1320 1321
		if (udev->state == USB_STATE_SUSPENDED)
			status = usb_resume_both(udev);
1322 1323
		if (status != 0)
			udev->pm_usage_cnt -= inc_usage_cnt;
1324 1325 1326 1327 1328
		else if (inc_usage_cnt)
			udev->last_busy = jiffies;
	} else if (inc_usage_cnt <= 0 && udev->pm_usage_cnt <= 0) {
		status = usb_suspend_both(udev, PMSG_SUSPEND);
	}
1329 1330 1331 1332
	usb_pm_unlock(udev);
	return status;
}

1333 1334 1335 1336 1337 1338 1339 1340 1341
/* 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);
}

1342 1343
/**
 * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
1344
 * @udev: the usb_device to autosuspend
1345 1346 1347 1348 1349
 *
 * 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.
 *
1350 1351 1352 1353 1354 1355
 * @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.
1356 1357 1358 1359 1360 1361
 *
 * Often the caller will hold @udev's device lock, but this is not
 * necessary.
 *
 * This routine can run only in process context.
 */
1362
void usb_autosuspend_device(struct usb_device *udev)
1363
{
1364 1365 1366
	int	status;

	status = usb_autopm_do_device(udev, -1);
A
Alan Stern 已提交
1367
	dev_vdbg(&udev->dev, "%s: cnt %d\n",
1368
			__func__, udev->pm_usage_cnt);
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
}

/**
 * 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 已提交
1387
	dev_vdbg(&udev->dev, "%s: cnt %d\n",
1388
			__func__, udev->pm_usage_cnt);
1389 1390 1391 1392
}

/**
 * usb_autoresume_device - immediately autoresume a USB device and its interfaces
1393
 * @udev: the usb_device to autoresume
1394 1395
 *
 * This routine should be called when a core subsystem wants to use @udev
1396 1397 1398 1399 1400
 * 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.
1401
 *
1402 1403
 * @udev's usage counter is incremented to prevent subsequent autosuspends.
 * However if the autoresume fails then the usage counter is re-decremented.
1404 1405 1406 1407 1408 1409
 *
 * 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.
 */
1410
int usb_autoresume_device(struct usb_device *udev)
1411 1412 1413
{
	int	status;

1414
	status = usb_autopm_do_device(udev, 1);
A
Alan Stern 已提交
1415
	dev_vdbg(&udev->dev, "%s: status %d cnt %d\n",
1416
			__func__, status, udev->pm_usage_cnt);
1417 1418 1419
	return status;
}

A
Alan Stern 已提交
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
/* 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 {
1433
		udev->auto_pm = 1;
A
Alan Stern 已提交
1434
		intf->pm_usage_cnt += inc_usage_cnt;
1435
		udev->last_busy = jiffies;
A
Alan Stern 已提交
1436
		if (inc_usage_cnt >= 0 && intf->pm_usage_cnt > 0) {
1437 1438
			if (udev->state == USB_STATE_SUSPENDED)
				status = usb_resume_both(udev);
A
Alan Stern 已提交
1439 1440
			if (status != 0)
				intf->pm_usage_cnt -= inc_usage_cnt;
1441
			else
1442 1443 1444 1445
				udev->last_busy = jiffies;
		} else if (inc_usage_cnt <= 0 && intf->pm_usage_cnt <= 0) {
			status = usb_suspend_both(udev, PMSG_SUSPEND);
		}
A
Alan Stern 已提交
1446 1447 1448 1449 1450
	}
	usb_pm_unlock(udev);
	return status;
}

1451 1452
/**
 * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
1453
 * @intf: the usb_interface whose counter should be decremented
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483
 *
 * 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 已提交
1484
	int	status;
1485

A
Alan Stern 已提交
1486
	status = usb_autopm_do_interface(intf, -1);
A
Alan Stern 已提交
1487
	dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1488
			__func__, status, intf->pm_usage_cnt);
1489 1490 1491 1492 1493
}
EXPORT_SYMBOL_GPL(usb_autopm_put_interface);

/**
 * usb_autopm_get_interface - increment a USB interface's PM-usage counter
1494
 * @intf: the usb_interface whose counter should be incremented
1495 1496 1497 1498 1499 1500 1501 1502 1503
 *
 * 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.
 *
1504 1505 1506 1507 1508 1509 1510 1511
 *
 * 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).
 *
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527
 *
 * 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 已提交
1528
	int	status;
1529

A
Alan Stern 已提交
1530
	status = usb_autopm_do_interface(intf, 1);
A
Alan Stern 已提交
1531
	dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1532
			__func__, status, intf->pm_usage_cnt);
1533 1534
	return status;
}
1535 1536
EXPORT_SYMBOL_GPL(usb_autopm_get_interface);

1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
/**
 * 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 已提交
1553
	dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1554
			__func__, status, intf->pm_usage_cnt);
1555 1556 1557 1558
	return status;
}
EXPORT_SYMBOL_GPL(usb_autopm_set_interface);

A
Alan Stern 已提交
1559 1560 1561 1562 1563
#else

void usb_autosuspend_work(struct work_struct *work)
{}

1564
#endif /* CONFIG_USB_SUSPEND */
1565

1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581
/**
 * 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)
1582 1583 1584
{
	int	status;

1585
	do_unbind_rebind(udev, DO_UNBIND);
1586 1587 1588 1589
	usb_pm_lock(udev);
	udev->auto_pm = 0;
	status = usb_suspend_both(udev, msg);
	usb_pm_unlock(udev);
1590 1591 1592
	return status;
}

1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604
/**
 * 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)
1605 1606 1607
{
	int	status;

1608 1609 1610
	usb_pm_lock(udev);
	udev->auto_pm = 0;
	status = usb_resume_both(udev);
A
Alan Stern 已提交
1611
	udev->last_busy = jiffies;
1612
	usb_pm_unlock(udev);
1613 1614
	if (status == 0)
		do_unbind_rebind(udev, DO_REBIND);
1615

1616 1617 1618 1619
	/* Now that the device is awake, we can start trying to autosuspend
	 * it again. */
	if (status == 0)
		usb_try_autosuspend_device(udev);
1620 1621 1622
	return status;
}

1623
int usb_suspend(struct device *dev, pm_message_t message)
1624
{
1625 1626 1627 1628 1629
	struct usb_device	*udev;

	udev = to_usb_device(dev);

	/* If udev is already suspended, we can skip this suspend and
1630 1631 1632 1633 1634
	 * we should also skip the upcoming system resume.  High-speed
	 * root hubs are an exception; they need to resume whenever the
	 * system wakes up in order for USB-PERSIST port handover to work
	 * properly.
	 */
1635
	if (udev->state == USB_STATE_SUSPENDED) {
1636 1637
		if (udev->parent || udev->speed != USB_SPEED_HIGH)
			udev->skip_sys_resume = 1;
1638 1639 1640 1641 1642
		return 0;
	}

	udev->skip_sys_resume = 0;
	return usb_external_suspend_device(udev, message);
1643 1644
}

1645
int usb_resume(struct device *dev)
1646
{
1647 1648 1649
	struct usb_device	*udev;

	udev = to_usb_device(dev);
A
Alan Stern 已提交
1650

1651
	/* If udev->skip_sys_resume is set then udev was already suspended
1652 1653 1654 1655 1656
	 * when the system sleep started, so we don't want to resume it
	 * during this system wakeup.
	 */
	if (udev->skip_sys_resume)
		return 0;
1657
	return usb_external_resume_device(udev);
1658 1659
}

1660 1661 1662 1663 1664 1665 1666
#endif /* CONFIG_PM */

struct bus_type usb_bus_type = {
	.name =		"usb",
	.match =	usb_device_match,
	.uevent =	usb_uevent,
};