2 * drivers/usb/driver.c - most of the driver model stuff for usb
4 * (C) Copyright 2005 Greg Kroah-Hartman <gregkh@suse.de>
6 * based on drivers/usb/usb.c which had the following copyrights:
7 * (C) Copyright Linus Torvalds 1999
8 * (C) Copyright Johannes Erdfelt 1999-2001
9 * (C) Copyright Andreas Gal 1999
10 * (C) Copyright Gregory P. Smith 1999
11 * (C) Copyright Deti Fliegl 1999 (new USB architecture)
12 * (C) Copyright Randy Dunlap 2000
13 * (C) Copyright David Brownell 2000-2004
14 * (C) Copyright Yggdrasil Computing, Inc. 2000
15 * (usb_device_id matching changes by Adam J. Richter)
16 * (C) Copyright Greg Kroah-Hartman 2002-2003
18 * NOTE! This is not actually a driver at all, rather this is
19 * just a collection of helper routines that implement the
20 * matching, probing, releasing, suspending and resuming for
25 #include <linux/device.h>
26 #include <linux/usb.h>
27 #include <linux/usb/quirks.h>
28 #include <linux/workqueue.h>
36 * Adds a new dynamic USBdevice ID to this driver,
37 * and cause the driver to probe for all devices again.
39 ssize_t
usb_store_new_id(struct usb_dynids
*dynids
,
40 struct device_driver
*driver
,
41 const char *buf
, size_t count
)
43 struct usb_dynid
*dynid
;
49 fields
= sscanf(buf
, "%x %x", &idVendor
, &idProduct
);
53 dynid
= kzalloc(sizeof(*dynid
), GFP_KERNEL
);
57 INIT_LIST_HEAD(&dynid
->node
);
58 dynid
->id
.idVendor
= idVendor
;
59 dynid
->id
.idProduct
= idProduct
;
60 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
);
66 if (get_driver(driver
)) {
67 retval
= driver_attach(driver
);
75 EXPORT_SYMBOL_GPL(usb_store_new_id
);
77 static ssize_t
store_new_id(struct device_driver
*driver
,
78 const char *buf
, size_t count
)
80 struct usb_driver
*usb_drv
= to_usb_driver(driver
);
82 return usb_store_new_id(&usb_drv
->dynids
, driver
, buf
, count
);
84 static DRIVER_ATTR(new_id
, S_IWUSR
, NULL
, store_new_id
);
86 static int usb_create_newid_file(struct usb_driver
*usb_drv
)
90 if (usb_drv
->no_dynamic_id
)
93 if (usb_drv
->probe
!= NULL
)
94 error
= driver_create_file(&usb_drv
->drvwrap
.driver
,
100 static void usb_remove_newid_file(struct usb_driver
*usb_drv
)
102 if (usb_drv
->no_dynamic_id
)
105 if (usb_drv
->probe
!= NULL
)
106 driver_remove_file(&usb_drv
->drvwrap
.driver
,
107 &driver_attr_new_id
);
110 static void usb_free_dynids(struct usb_driver
*usb_drv
)
112 struct usb_dynid
*dynid
, *n
;
114 spin_lock(&usb_drv
->dynids
.lock
);
115 list_for_each_entry_safe(dynid
, n
, &usb_drv
->dynids
.list
, node
) {
116 list_del(&dynid
->node
);
119 spin_unlock(&usb_drv
->dynids
.lock
);
122 static inline int usb_create_newid_file(struct usb_driver
*usb_drv
)
127 static void usb_remove_newid_file(struct usb_driver
*usb_drv
)
131 static inline void usb_free_dynids(struct usb_driver
*usb_drv
)
136 static const struct usb_device_id
*usb_match_dynamic_id(struct usb_interface
*intf
,
137 struct usb_driver
*drv
)
139 struct usb_dynid
*dynid
;
141 spin_lock(&drv
->dynids
.lock
);
142 list_for_each_entry(dynid
, &drv
->dynids
.list
, node
) {
143 if (usb_match_one_id(intf
, &dynid
->id
)) {
144 spin_unlock(&drv
->dynids
.lock
);
148 spin_unlock(&drv
->dynids
.lock
);
153 /* called from driver core with dev locked */
154 static int usb_probe_device(struct device
*dev
)
156 struct usb_device_driver
*udriver
= to_usb_device_driver(dev
->driver
);
157 struct usb_device
*udev
= to_usb_device(dev
);
160 dev_dbg(dev
, "%s\n", __func__
);
162 /* TODO: Add real matching code */
164 /* The device should always appear to be in use
165 * unless the driver suports autosuspend.
167 udev
->pm_usage_cnt
= !(udriver
->supports_autosuspend
);
169 error
= udriver
->probe(udev
);
173 /* called from driver core with dev locked */
174 static int usb_unbind_device(struct device
*dev
)
176 struct usb_device_driver
*udriver
= to_usb_device_driver(dev
->driver
);
178 udriver
->disconnect(to_usb_device(dev
));
183 * Cancel any pending scheduled resets
185 * [see usb_queue_reset_device()]
187 * Called after unconfiguring / when releasing interfaces. See
188 * comments in __usb_queue_reset_device() regarding
189 * udev->reset_running.
191 static void usb_cancel_queued_reset(struct usb_interface
*iface
)
193 if (iface
->reset_running
== 0)
194 cancel_work_sync(&iface
->reset_ws
);
197 /* called from driver core with dev locked */
198 static int usb_probe_interface(struct device
*dev
)
200 struct usb_driver
*driver
= to_usb_driver(dev
->driver
);
201 struct usb_interface
*intf
= to_usb_interface(dev
);
202 struct usb_device
*udev
= interface_to_usbdev(intf
);
203 const struct usb_device_id
*id
;
206 dev_dbg(dev
, "%s\n", __func__
);
208 intf
->needs_binding
= 0;
210 if (udev
->authorized
== 0) {
211 dev_err(&intf
->dev
, "Device is not authorized for usage\n");
215 id
= usb_match_id(intf
, driver
->id_table
);
217 id
= usb_match_dynamic_id(intf
, driver
);
219 dev_dbg(dev
, "%s - got id\n", __func__
);
221 error
= usb_autoresume_device(udev
);
225 /* Interface "power state" doesn't correspond to any hardware
226 * state whatsoever. We use it to record when it's bound to
227 * a driver that may start I/0: it's not frozen/quiesced.
230 intf
->condition
= USB_INTERFACE_BINDING
;
232 /* The interface should always appear to be in use
233 * unless the driver suports autosuspend.
235 intf
->pm_usage_cnt
= !(driver
->supports_autosuspend
);
237 /* Carry out a deferred switch to altsetting 0 */
238 if (intf
->needs_altsetting0
) {
239 usb_set_interface(udev
, intf
->altsetting
[0].
240 desc
.bInterfaceNumber
, 0);
241 intf
->needs_altsetting0
= 0;
244 error
= driver
->probe(intf
, id
);
247 intf
->needs_remote_wakeup
= 0;
248 intf
->condition
= USB_INTERFACE_UNBOUND
;
249 usb_cancel_queued_reset(intf
);
251 intf
->condition
= USB_INTERFACE_BOUND
;
253 usb_autosuspend_device(udev
);
259 /* called from driver core with dev locked */
260 static int usb_unbind_interface(struct device
*dev
)
262 struct usb_driver
*driver
= to_usb_driver(dev
->driver
);
263 struct usb_interface
*intf
= to_usb_interface(dev
);
264 struct usb_device
*udev
;
267 intf
->condition
= USB_INTERFACE_UNBINDING
;
269 /* Autoresume for set_interface call below */
270 udev
= interface_to_usbdev(intf
);
271 error
= usb_autoresume_device(udev
);
273 /* Terminate all URBs for this interface unless the driver
274 * supports "soft" unbinding.
276 if (!driver
->soft_unbind
)
277 usb_disable_interface(udev
, intf
, false);
279 driver
->disconnect(intf
);
280 usb_cancel_queued_reset(intf
);
282 /* Reset other interface state.
283 * We cannot do a Set-Interface if the device is suspended or
284 * if it is prepared for a system sleep (since installing a new
285 * altsetting means creating new endpoint device entries).
286 * When either of these happens, defer the Set-Interface.
288 if (intf
->cur_altsetting
->desc
.bAlternateSetting
== 0) {
289 /* Already in altsetting 0 so skip Set-Interface.
290 * Just re-enable it without affecting the endpoint toggles.
292 usb_enable_interface(udev
, intf
, false);
293 } else if (!error
&& intf
->dev
.power
.status
== DPM_ON
)
294 usb_set_interface(udev
, intf
->altsetting
[0].
295 desc
.bInterfaceNumber
, 0);
297 intf
->needs_altsetting0
= 1;
298 usb_set_intfdata(intf
, NULL
);
300 intf
->condition
= USB_INTERFACE_UNBOUND
;
302 intf
->needs_remote_wakeup
= 0;
305 usb_autosuspend_device(udev
);
311 * usb_driver_claim_interface - bind a driver to an interface
312 * @driver: the driver to be bound
313 * @iface: the interface to which it will be bound; must be in the
314 * usb device's active configuration
315 * @priv: driver data associated with that interface
317 * This is used by usb device drivers that need to claim more than one
318 * interface on a device when probing (audio and acm are current examples).
319 * No device driver should directly modify internal usb_interface or
320 * usb_device structure members.
322 * Few drivers should need to use this routine, since the most natural
323 * way to bind to an interface is to return the private data from
324 * the driver's probe() method.
326 * Callers must own the device lock, so driver probe() entries don't need
327 * extra locking, but other call contexts may need to explicitly claim that
330 int usb_driver_claim_interface(struct usb_driver
*driver
,
331 struct usb_interface
*iface
, void *priv
)
333 struct device
*dev
= &iface
->dev
;
334 struct usb_device
*udev
= interface_to_usbdev(iface
);
340 dev
->driver
= &driver
->drvwrap
.driver
;
341 usb_set_intfdata(iface
, priv
);
342 iface
->needs_binding
= 0;
345 iface
->condition
= USB_INTERFACE_BOUND
;
347 iface
->pm_usage_cnt
= !(driver
->supports_autosuspend
);
350 /* if interface was already added, bind now; else let
351 * the future device_add() bind it, bypassing probe()
353 if (device_is_registered(dev
))
354 retval
= device_bind_driver(dev
);
358 EXPORT_SYMBOL_GPL(usb_driver_claim_interface
);
361 * usb_driver_release_interface - unbind a driver from an interface
362 * @driver: the driver to be unbound
363 * @iface: the interface from which it will be unbound
365 * This can be used by drivers to release an interface without waiting
366 * for their disconnect() methods to be called. In typical cases this
367 * also causes the driver disconnect() method to be called.
369 * This call is synchronous, and may not be used in an interrupt context.
370 * Callers must own the device lock, so driver disconnect() entries don't
371 * need extra locking, but other call contexts may need to explicitly claim
374 void usb_driver_release_interface(struct usb_driver
*driver
,
375 struct usb_interface
*iface
)
377 struct device
*dev
= &iface
->dev
;
379 /* this should never happen, don't release something that's not ours */
380 if (!dev
->driver
|| dev
->driver
!= &driver
->drvwrap
.driver
)
383 /* don't release from within disconnect() */
384 if (iface
->condition
!= USB_INTERFACE_BOUND
)
386 iface
->condition
= USB_INTERFACE_UNBINDING
;
388 /* Release via the driver core only if the interface
389 * has already been registered
391 if (device_is_registered(dev
)) {
392 device_release_driver(dev
);
395 usb_unbind_interface(dev
);
400 EXPORT_SYMBOL_GPL(usb_driver_release_interface
);
402 /* returns 0 if no match, 1 if match */
403 int usb_match_device(struct usb_device
*dev
, const struct usb_device_id
*id
)
405 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_VENDOR
) &&
406 id
->idVendor
!= le16_to_cpu(dev
->descriptor
.idVendor
))
409 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_PRODUCT
) &&
410 id
->idProduct
!= le16_to_cpu(dev
->descriptor
.idProduct
))
413 /* No need to test id->bcdDevice_lo != 0, since 0 is never
414 greater than any unsigned number. */
415 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_LO
) &&
416 (id
->bcdDevice_lo
> le16_to_cpu(dev
->descriptor
.bcdDevice
)))
419 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_HI
) &&
420 (id
->bcdDevice_hi
< le16_to_cpu(dev
->descriptor
.bcdDevice
)))
423 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_CLASS
) &&
424 (id
->bDeviceClass
!= dev
->descriptor
.bDeviceClass
))
427 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_SUBCLASS
) &&
428 (id
->bDeviceSubClass
!= dev
->descriptor
.bDeviceSubClass
))
431 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_PROTOCOL
) &&
432 (id
->bDeviceProtocol
!= dev
->descriptor
.bDeviceProtocol
))
438 /* returns 0 if no match, 1 if match */
439 int usb_match_one_id(struct usb_interface
*interface
,
440 const struct usb_device_id
*id
)
442 struct usb_host_interface
*intf
;
443 struct usb_device
*dev
;
445 /* proc_connectinfo in devio.c may call us with id == NULL. */
449 intf
= interface
->cur_altsetting
;
450 dev
= interface_to_usbdev(interface
);
452 if (!usb_match_device(dev
, id
))
455 /* The interface class, subclass, and protocol should never be
456 * checked for a match if the device class is Vendor Specific,
457 * unless the match record specifies the Vendor ID. */
458 if (dev
->descriptor
.bDeviceClass
== USB_CLASS_VENDOR_SPEC
&&
459 !(id
->match_flags
& USB_DEVICE_ID_MATCH_VENDOR
) &&
460 (id
->match_flags
& (USB_DEVICE_ID_MATCH_INT_CLASS
|
461 USB_DEVICE_ID_MATCH_INT_SUBCLASS
|
462 USB_DEVICE_ID_MATCH_INT_PROTOCOL
)))
465 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_CLASS
) &&
466 (id
->bInterfaceClass
!= intf
->desc
.bInterfaceClass
))
469 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_SUBCLASS
) &&
470 (id
->bInterfaceSubClass
!= intf
->desc
.bInterfaceSubClass
))
473 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_PROTOCOL
) &&
474 (id
->bInterfaceProtocol
!= intf
->desc
.bInterfaceProtocol
))
479 EXPORT_SYMBOL_GPL(usb_match_one_id
);
482 * usb_match_id - find first usb_device_id matching device or interface
483 * @interface: the interface of interest
484 * @id: array of usb_device_id structures, terminated by zero entry
486 * usb_match_id searches an array of usb_device_id's and returns
487 * the first one matching the device or interface, or null.
488 * This is used when binding (or rebinding) a driver to an interface.
489 * Most USB device drivers will use this indirectly, through the usb core,
490 * but some layered driver frameworks use it directly.
491 * These device tables are exported with MODULE_DEVICE_TABLE, through
492 * modutils, to support the driver loading functionality of USB hotplugging.
496 * The "match_flags" element in a usb_device_id controls which
497 * members are used. If the corresponding bit is set, the
498 * value in the device_id must match its corresponding member
499 * in the device or interface descriptor, or else the device_id
502 * "driver_info" is normally used only by device drivers,
503 * but you can create a wildcard "matches anything" usb_device_id
504 * as a driver's "modules.usbmap" entry if you provide an id with
505 * only a nonzero "driver_info" field. If you do this, the USB device
506 * driver's probe() routine should use additional intelligence to
507 * decide whether to bind to the specified interface.
509 * What Makes Good usb_device_id Tables:
511 * The match algorithm is very simple, so that intelligence in
512 * driver selection must come from smart driver id records.
513 * Unless you have good reasons to use another selection policy,
514 * provide match elements only in related groups, and order match
515 * specifiers from specific to general. Use the macros provided
516 * for that purpose if you can.
518 * The most specific match specifiers use device descriptor
519 * data. These are commonly used with product-specific matches;
520 * the USB_DEVICE macro lets you provide vendor and product IDs,
521 * and you can also match against ranges of product revisions.
522 * These are widely used for devices with application or vendor
523 * specific bDeviceClass values.
525 * Matches based on device class/subclass/protocol specifications
526 * are slightly more general; use the USB_DEVICE_INFO macro, or
527 * its siblings. These are used with single-function devices
528 * where bDeviceClass doesn't specify that each interface has
531 * Matches based on interface class/subclass/protocol are the
532 * most general; they let drivers bind to any interface on a
533 * multiple-function device. Use the USB_INTERFACE_INFO
534 * macro, or its siblings, to match class-per-interface style
535 * devices (as recorded in bInterfaceClass).
537 * Note that an entry created by USB_INTERFACE_INFO won't match
538 * any interface if the device class is set to Vendor-Specific.
539 * This is deliberate; according to the USB spec the meanings of
540 * the interface class/subclass/protocol for these devices are also
541 * vendor-specific, and hence matching against a standard product
542 * class wouldn't work anyway. If you really want to use an
543 * interface-based match for such a device, create a match record
544 * that also specifies the vendor ID. (Unforunately there isn't a
545 * standard macro for creating records like this.)
547 * Within those groups, remember that not all combinations are
548 * meaningful. For example, don't give a product version range
549 * without vendor and product IDs; or specify a protocol without
550 * its associated class and subclass.
552 const struct usb_device_id
*usb_match_id(struct usb_interface
*interface
,
553 const struct usb_device_id
*id
)
555 /* proc_connectinfo in devio.c may call us with id == NULL. */
559 /* It is important to check that id->driver_info is nonzero,
560 since an entry that is all zeroes except for a nonzero
561 id->driver_info is the way to create an entry that
562 indicates that the driver want to examine every
563 device and interface. */
564 for (; id
->idVendor
|| id
->idProduct
|| id
->bDeviceClass
||
565 id
->bInterfaceClass
|| id
->driver_info
; id
++) {
566 if (usb_match_one_id(interface
, id
))
572 EXPORT_SYMBOL_GPL(usb_match_id
);
574 static int usb_device_match(struct device
*dev
, struct device_driver
*drv
)
576 /* devices and interfaces are handled separately */
577 if (is_usb_device(dev
)) {
579 /* interface drivers never match devices */
580 if (!is_usb_device_driver(drv
))
583 /* TODO: Add real matching code */
586 } else if (is_usb_interface(dev
)) {
587 struct usb_interface
*intf
;
588 struct usb_driver
*usb_drv
;
589 const struct usb_device_id
*id
;
591 /* device drivers never match interfaces */
592 if (is_usb_device_driver(drv
))
595 intf
= to_usb_interface(dev
);
596 usb_drv
= to_usb_driver(drv
);
598 id
= usb_match_id(intf
, usb_drv
->id_table
);
602 id
= usb_match_dynamic_id(intf
, usb_drv
);
610 #ifdef CONFIG_HOTPLUG
611 static int usb_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
613 struct usb_device
*usb_dev
;
615 /* driver is often null here; dev_dbg() would oops */
616 pr_debug("usb %s: uevent\n", dev_name(dev
));
618 if (is_usb_device(dev
)) {
619 usb_dev
= to_usb_device(dev
);
620 } else if (is_usb_interface(dev
)) {
621 struct usb_interface
*intf
= to_usb_interface(dev
);
623 usb_dev
= interface_to_usbdev(intf
);
628 if (usb_dev
->devnum
< 0) {
629 pr_debug("usb %s: already deleted?\n", dev_name(dev
));
633 pr_debug("usb %s: bus removed?\n", dev_name(dev
));
637 #ifdef CONFIG_USB_DEVICEFS
638 /* If this is available, userspace programs can directly read
639 * all the device descriptors we don't tell them about. Or
640 * act as usermode drivers.
642 if (add_uevent_var(env
, "DEVICE=/proc/bus/usb/%03d/%03d",
643 usb_dev
->bus
->busnum
, usb_dev
->devnum
))
647 /* per-device configurations are common */
648 if (add_uevent_var(env
, "PRODUCT=%x/%x/%x",
649 le16_to_cpu(usb_dev
->descriptor
.idVendor
),
650 le16_to_cpu(usb_dev
->descriptor
.idProduct
),
651 le16_to_cpu(usb_dev
->descriptor
.bcdDevice
)))
654 /* class-based driver binding models */
655 if (add_uevent_var(env
, "TYPE=%d/%d/%d",
656 usb_dev
->descriptor
.bDeviceClass
,
657 usb_dev
->descriptor
.bDeviceSubClass
,
658 usb_dev
->descriptor
.bDeviceProtocol
))
666 static int usb_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
670 #endif /* CONFIG_HOTPLUG */
673 * usb_register_device_driver - register a USB device (not interface) driver
674 * @new_udriver: USB operations for the device driver
675 * @owner: module owner of this driver.
677 * Registers a USB device driver with the USB core. The list of
678 * unattached devices will be rescanned whenever a new driver is
679 * added, allowing the new driver to attach to any recognized devices.
680 * Returns a negative error code on failure and 0 on success.
682 int usb_register_device_driver(struct usb_device_driver
*new_udriver
,
683 struct module
*owner
)
690 new_udriver
->drvwrap
.for_devices
= 1;
691 new_udriver
->drvwrap
.driver
.name
= (char *) new_udriver
->name
;
692 new_udriver
->drvwrap
.driver
.bus
= &usb_bus_type
;
693 new_udriver
->drvwrap
.driver
.probe
= usb_probe_device
;
694 new_udriver
->drvwrap
.driver
.remove
= usb_unbind_device
;
695 new_udriver
->drvwrap
.driver
.owner
= owner
;
697 retval
= driver_register(&new_udriver
->drvwrap
.driver
);
700 pr_info("%s: registered new device driver %s\n",
701 usbcore_name
, new_udriver
->name
);
702 usbfs_update_special();
704 printk(KERN_ERR
"%s: error %d registering device "
706 usbcore_name
, retval
, new_udriver
->name
);
711 EXPORT_SYMBOL_GPL(usb_register_device_driver
);
714 * usb_deregister_device_driver - unregister a USB device (not interface) driver
715 * @udriver: USB operations of the device driver to unregister
716 * Context: must be able to sleep
718 * Unlinks the specified driver from the internal USB driver list.
720 void usb_deregister_device_driver(struct usb_device_driver
*udriver
)
722 pr_info("%s: deregistering device driver %s\n",
723 usbcore_name
, udriver
->name
);
725 driver_unregister(&udriver
->drvwrap
.driver
);
726 usbfs_update_special();
728 EXPORT_SYMBOL_GPL(usb_deregister_device_driver
);
731 * usb_register_driver - register a USB interface driver
732 * @new_driver: USB operations for the interface driver
733 * @owner: module owner of this driver.
734 * @mod_name: module name string
736 * Registers a USB interface driver with the USB core. The list of
737 * unattached interfaces will be rescanned whenever a new driver is
738 * added, allowing the new driver to attach to any recognized interfaces.
739 * Returns a negative error code on failure and 0 on success.
741 * NOTE: if you want your driver to use the USB major number, you must call
742 * usb_register_dev() to enable that functionality. This function no longer
743 * takes care of that.
745 int usb_register_driver(struct usb_driver
*new_driver
, struct module
*owner
,
746 const char *mod_name
)
753 new_driver
->drvwrap
.for_devices
= 0;
754 new_driver
->drvwrap
.driver
.name
= (char *) new_driver
->name
;
755 new_driver
->drvwrap
.driver
.bus
= &usb_bus_type
;
756 new_driver
->drvwrap
.driver
.probe
= usb_probe_interface
;
757 new_driver
->drvwrap
.driver
.remove
= usb_unbind_interface
;
758 new_driver
->drvwrap
.driver
.owner
= owner
;
759 new_driver
->drvwrap
.driver
.mod_name
= mod_name
;
760 spin_lock_init(&new_driver
->dynids
.lock
);
761 INIT_LIST_HEAD(&new_driver
->dynids
.list
);
763 retval
= driver_register(&new_driver
->drvwrap
.driver
);
766 pr_info("%s: registered new interface driver %s\n",
767 usbcore_name
, new_driver
->name
);
768 usbfs_update_special();
769 usb_create_newid_file(new_driver
);
771 printk(KERN_ERR
"%s: error %d registering interface "
773 usbcore_name
, retval
, new_driver
->name
);
778 EXPORT_SYMBOL_GPL(usb_register_driver
);
781 * usb_deregister - unregister a USB interface driver
782 * @driver: USB operations of the interface driver to unregister
783 * Context: must be able to sleep
785 * Unlinks the specified driver from the internal USB driver list.
787 * NOTE: If you called usb_register_dev(), you still need to call
788 * usb_deregister_dev() to clean up your driver's allocated minor numbers,
789 * this * call will no longer do it for you.
791 void usb_deregister(struct usb_driver
*driver
)
793 pr_info("%s: deregistering interface driver %s\n",
794 usbcore_name
, driver
->name
);
796 usb_remove_newid_file(driver
);
797 usb_free_dynids(driver
);
798 driver_unregister(&driver
->drvwrap
.driver
);
800 usbfs_update_special();
802 EXPORT_SYMBOL_GPL(usb_deregister
);
804 /* Forced unbinding of a USB interface driver, either because
805 * it doesn't support pre_reset/post_reset/reset_resume or
806 * because it doesn't support suspend/resume.
808 * The caller must hold @intf's device's lock, but not its pm_mutex
809 * and not @intf->dev.sem.
811 void usb_forced_unbind_intf(struct usb_interface
*intf
)
813 struct usb_driver
*driver
= to_usb_driver(intf
->dev
.driver
);
815 dev_dbg(&intf
->dev
, "forced unbind\n");
816 usb_driver_release_interface(driver
, intf
);
818 /* Mark the interface for later rebinding */
819 intf
->needs_binding
= 1;
822 /* Delayed forced unbinding of a USB interface driver and scan
825 * The caller must hold @intf's device's lock, but not its pm_mutex
826 * and not @intf->dev.sem.
828 * Note: Rebinds will be skipped if a system sleep transition is in
829 * progress and the PM "complete" callback hasn't occurred yet.
831 void usb_rebind_intf(struct usb_interface
*intf
)
835 /* Delayed unbind of an existing driver */
836 if (intf
->dev
.driver
) {
837 struct usb_driver
*driver
=
838 to_usb_driver(intf
->dev
.driver
);
840 dev_dbg(&intf
->dev
, "forced unbind\n");
841 usb_driver_release_interface(driver
, intf
);
844 /* Try to rebind the interface */
845 if (intf
->dev
.power
.status
== DPM_ON
) {
846 intf
->needs_binding
= 0;
847 rc
= device_attach(&intf
->dev
);
849 dev_warn(&intf
->dev
, "rebind failed: %d\n", rc
);
858 /* Unbind drivers for @udev's interfaces that don't support suspend/resume,
859 * or rebind interfaces that have been unbound, according to @action.
861 * The caller must hold @udev's device lock.
863 static void do_unbind_rebind(struct usb_device
*udev
, int action
)
865 struct usb_host_config
*config
;
867 struct usb_interface
*intf
;
868 struct usb_driver
*drv
;
870 config
= udev
->actconfig
;
872 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
873 intf
= config
->interface
[i
];
876 if (intf
->dev
.driver
) {
877 drv
= to_usb_driver(intf
->dev
.driver
);
878 if (!drv
->suspend
|| !drv
->resume
)
879 usb_forced_unbind_intf(intf
);
883 if (intf
->needs_binding
)
884 usb_rebind_intf(intf
);
891 /* Caller has locked udev's pm_mutex */
892 static int usb_suspend_device(struct usb_device
*udev
, pm_message_t msg
)
894 struct usb_device_driver
*udriver
;
897 if (udev
->state
== USB_STATE_NOTATTACHED
||
898 udev
->state
== USB_STATE_SUSPENDED
)
901 /* For devices that don't have a driver, we do a generic suspend. */
902 if (udev
->dev
.driver
)
903 udriver
= to_usb_device_driver(udev
->dev
.driver
);
905 udev
->do_remote_wakeup
= 0;
906 udriver
= &usb_generic_driver
;
908 status
= udriver
->suspend(udev
, msg
);
911 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
915 /* Caller has locked udev's pm_mutex */
916 static int usb_resume_device(struct usb_device
*udev
, pm_message_t msg
)
918 struct usb_device_driver
*udriver
;
921 if (udev
->state
== USB_STATE_NOTATTACHED
)
924 /* Can't resume it if it doesn't have a driver. */
925 if (udev
->dev
.driver
== NULL
) {
930 if (udev
->quirks
& USB_QUIRK_RESET_RESUME
)
931 udev
->reset_resume
= 1;
933 udriver
= to_usb_device_driver(udev
->dev
.driver
);
934 status
= udriver
->resume(udev
, msg
);
937 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
939 udev
->autoresume_disabled
= 0;
943 /* Caller has locked intf's usb_device's pm mutex */
944 static int usb_suspend_interface(struct usb_device
*udev
,
945 struct usb_interface
*intf
, pm_message_t msg
)
947 struct usb_driver
*driver
;
950 /* with no hardware, USB interfaces only use FREEZE and ON states */
951 if (udev
->state
== USB_STATE_NOTATTACHED
|| !is_active(intf
))
954 /* This can happen; see usb_driver_release_interface() */
955 if (intf
->condition
== USB_INTERFACE_UNBOUND
)
957 driver
= to_usb_driver(intf
->dev
.driver
);
959 if (driver
->suspend
) {
960 status
= driver
->suspend(intf
, msg
);
963 else if (!(msg
.event
& PM_EVENT_AUTO
))
964 dev_err(&intf
->dev
, "%s error %d\n",
967 /* Later we will unbind the driver and reprobe */
968 intf
->needs_binding
= 1;
969 dev_warn(&intf
->dev
, "no %s for driver %s?\n",
970 "suspend", driver
->name
);
975 dev_vdbg(&intf
->dev
, "%s: status %d\n", __func__
, status
);
979 /* Caller has locked intf's usb_device's pm_mutex */
980 static int usb_resume_interface(struct usb_device
*udev
,
981 struct usb_interface
*intf
, pm_message_t msg
, int reset_resume
)
983 struct usb_driver
*driver
;
986 if (udev
->state
== USB_STATE_NOTATTACHED
|| is_active(intf
))
989 /* Don't let autoresume interfere with unbinding */
990 if (intf
->condition
== USB_INTERFACE_UNBINDING
)
993 /* Can't resume it if it doesn't have a driver. */
994 if (intf
->condition
== USB_INTERFACE_UNBOUND
) {
996 /* Carry out a deferred switch to altsetting 0 */
997 if (intf
->needs_altsetting0
&&
998 intf
->dev
.power
.status
== DPM_ON
) {
999 usb_set_interface(udev
, intf
->altsetting
[0].
1000 desc
.bInterfaceNumber
, 0);
1001 intf
->needs_altsetting0
= 0;
1006 /* Don't resume if the interface is marked for rebinding */
1007 if (intf
->needs_binding
)
1009 driver
= to_usb_driver(intf
->dev
.driver
);
1012 if (driver
->reset_resume
) {
1013 status
= driver
->reset_resume(intf
);
1015 dev_err(&intf
->dev
, "%s error %d\n",
1016 "reset_resume", status
);
1018 intf
->needs_binding
= 1;
1019 dev_warn(&intf
->dev
, "no %s for driver %s?\n",
1020 "reset_resume", driver
->name
);
1023 if (driver
->resume
) {
1024 status
= driver
->resume(intf
);
1026 dev_err(&intf
->dev
, "%s error %d\n",
1029 intf
->needs_binding
= 1;
1030 dev_warn(&intf
->dev
, "no %s for driver %s?\n",
1031 "resume", driver
->name
);
1036 dev_vdbg(&intf
->dev
, "%s: status %d\n", __func__
, status
);
1037 if (status
== 0 && intf
->condition
== USB_INTERFACE_BOUND
)
1040 /* Later we will unbind the driver and/or reprobe, if necessary */
1044 #ifdef CONFIG_USB_SUSPEND
1046 /* Internal routine to check whether we may autosuspend a device. */
1047 static int autosuspend_check(struct usb_device
*udev
, int reschedule
)
1050 struct usb_interface
*intf
;
1051 unsigned long suspend_time
, j
;
1053 /* For autosuspend, fail fast if anything is in use or autosuspend
1054 * is disabled. Also fail if any interfaces require remote wakeup
1055 * but it isn't available.
1057 if (udev
->pm_usage_cnt
> 0)
1059 if (udev
->autosuspend_delay
< 0 || udev
->autosuspend_disabled
)
1062 suspend_time
= udev
->last_busy
+ udev
->autosuspend_delay
;
1063 if (udev
->actconfig
) {
1064 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
1065 intf
= udev
->actconfig
->interface
[i
];
1066 if (!is_active(intf
))
1068 if (intf
->pm_usage_cnt
> 0)
1070 if (intf
->needs_remote_wakeup
&&
1071 !udev
->do_remote_wakeup
) {
1072 dev_dbg(&udev
->dev
, "remote wakeup needed "
1073 "for autosuspend\n");
1077 /* Don't allow autosuspend if the device will need
1078 * a reset-resume and any of its interface drivers
1079 * doesn't include support.
1081 if (udev
->quirks
& USB_QUIRK_RESET_RESUME
) {
1082 struct usb_driver
*driver
;
1084 driver
= to_usb_driver(intf
->dev
.driver
);
1085 if (!driver
->reset_resume
||
1086 intf
->needs_remote_wakeup
)
1092 /* If everything is okay but the device hasn't been idle for long
1093 * enough, queue a delayed autosuspend request. If the device
1094 * _has_ been idle for long enough and the reschedule flag is set,
1095 * likewise queue a delayed (1 second) autosuspend request.
1098 if (time_before(j
, suspend_time
))
1101 suspend_time
= j
+ HZ
;
1103 if (!timer_pending(&udev
->autosuspend
.timer
)) {
1104 queue_delayed_work(ksuspend_usb_wq
, &udev
->autosuspend
,
1105 round_jiffies_up_relative(suspend_time
- j
));
1114 static inline int autosuspend_check(struct usb_device
*udev
, int reschedule
)
1119 #endif /* CONFIG_USB_SUSPEND */
1122 * usb_suspend_both - suspend a USB device and its interfaces
1123 * @udev: the usb_device to suspend
1124 * @msg: Power Management message describing this state transition
1126 * This is the central routine for suspending USB devices. It calls the
1127 * suspend methods for all the interface drivers in @udev and then calls
1128 * the suspend method for @udev itself. If an error occurs at any stage,
1129 * all the interfaces which were suspended are resumed so that they remain
1130 * in the same state as the device.
1132 * If an autosuspend is in progress the routine checks first to make sure
1133 * that neither the device itself or any of its active interfaces is in use
1134 * (pm_usage_cnt is greater than 0). If they are, the autosuspend fails.
1136 * If the suspend succeeds, the routine recursively queues an autosuspend
1137 * request for @udev's parent device, thereby propagating the change up
1138 * the device tree. If all of the parent's children are now suspended,
1139 * the parent will autosuspend in turn.
1141 * The suspend method calls are subject to mutual exclusion under control
1142 * of @udev's pm_mutex. Many of these calls are also under the protection
1143 * of @udev's device lock (including all requests originating outside the
1144 * USB subsystem), but autosuspend requests generated by a child device or
1145 * interface driver may not be. Usbcore will insure that the method calls
1146 * do not arrive during bind, unbind, or reset operations. However, drivers
1147 * must be prepared to handle suspend calls arriving at unpredictable times.
1148 * The only way to block such calls is to do an autoresume (preventing
1149 * autosuspends) while holding @udev's device lock (preventing outside
1152 * The caller must hold @udev->pm_mutex.
1154 * This routine can run only in process context.
1156 static int usb_suspend_both(struct usb_device
*udev
, pm_message_t msg
)
1160 struct usb_interface
*intf
;
1161 struct usb_device
*parent
= udev
->parent
;
1163 if (udev
->state
== USB_STATE_NOTATTACHED
||
1164 udev
->state
== USB_STATE_SUSPENDED
)
1167 udev
->do_remote_wakeup
= device_may_wakeup(&udev
->dev
);
1169 if (msg
.event
& PM_EVENT_AUTO
) {
1170 status
= autosuspend_check(udev
, 0);
1175 /* Suspend all the interfaces and then udev itself */
1176 if (udev
->actconfig
) {
1177 for (; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
1178 intf
= udev
->actconfig
->interface
[i
];
1179 status
= usb_suspend_interface(udev
, intf
, msg
);
1185 status
= usb_suspend_device(udev
, msg
);
1187 /* If the suspend failed, resume interfaces that did get suspended */
1191 msg2
.event
= msg
.event
^ (PM_EVENT_SUSPEND
| PM_EVENT_RESUME
);
1193 intf
= udev
->actconfig
->interface
[i
];
1194 usb_resume_interface(udev
, intf
, msg2
, 0);
1197 /* Try another autosuspend when the interfaces aren't busy */
1198 if (msg
.event
& PM_EVENT_AUTO
)
1199 autosuspend_check(udev
, status
== -EBUSY
);
1201 /* If the suspend succeeded then prevent any more URB submissions,
1202 * flush any outstanding URBs, and propagate the suspend up the tree.
1205 cancel_delayed_work(&udev
->autosuspend
);
1206 udev
->can_submit
= 0;
1207 for (i
= 0; i
< 16; ++i
) {
1208 usb_hcd_flush_endpoint(udev
, udev
->ep_out
[i
]);
1209 usb_hcd_flush_endpoint(udev
, udev
->ep_in
[i
]);
1212 /* If this is just a FREEZE or a PRETHAW, udev might
1213 * not really be suspended. Only true suspends get
1214 * propagated up the device tree.
1216 if (parent
&& udev
->state
== USB_STATE_SUSPENDED
)
1217 usb_autosuspend_device(parent
);
1221 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1226 * usb_resume_both - resume a USB device and its interfaces
1227 * @udev: the usb_device to resume
1228 * @msg: Power Management message describing this state transition
1230 * This is the central routine for resuming USB devices. It calls the
1231 * the resume method for @udev and then calls the resume methods for all
1232 * the interface drivers in @udev.
1234 * Before starting the resume, the routine calls itself recursively for
1235 * the parent device of @udev, thereby propagating the change up the device
1236 * tree and assuring that @udev will be able to resume. If the parent is
1237 * unable to resume successfully, the routine fails.
1239 * The resume method calls are subject to mutual exclusion under control
1240 * of @udev's pm_mutex. Many of these calls are also under the protection
1241 * of @udev's device lock (including all requests originating outside the
1242 * USB subsystem), but autoresume requests generated by a child device or
1243 * interface driver may not be. Usbcore will insure that the method calls
1244 * do not arrive during bind, unbind, or reset operations. However, drivers
1245 * must be prepared to handle resume calls arriving at unpredictable times.
1246 * The only way to block such calls is to do an autoresume (preventing
1247 * other autoresumes) while holding @udev's device lock (preventing outside
1250 * The caller must hold @udev->pm_mutex.
1252 * This routine can run only in process context.
1254 static int usb_resume_both(struct usb_device
*udev
, pm_message_t msg
)
1258 struct usb_interface
*intf
;
1259 struct usb_device
*parent
= udev
->parent
;
1261 cancel_delayed_work(&udev
->autosuspend
);
1262 if (udev
->state
== USB_STATE_NOTATTACHED
) {
1266 udev
->can_submit
= 1;
1268 /* Propagate the resume up the tree, if necessary */
1269 if (udev
->state
== USB_STATE_SUSPENDED
) {
1270 if ((msg
.event
& PM_EVENT_AUTO
) &&
1271 udev
->autoresume_disabled
) {
1276 status
= usb_autoresume_device(parent
);
1278 status
= usb_resume_device(udev
, msg
);
1279 if (status
|| udev
->state
==
1280 USB_STATE_NOTATTACHED
) {
1281 usb_autosuspend_device(parent
);
1283 /* It's possible usb_resume_device()
1284 * failed after the port was
1285 * unsuspended, causing udev to be
1286 * logically disconnected. We don't
1287 * want usb_disconnect() to autosuspend
1288 * the parent again, so tell it that
1289 * udev disconnected while still
1292 USB_STATE_NOTATTACHED
)
1293 udev
->discon_suspended
= 1;
1298 /* We can't progagate beyond the USB subsystem,
1299 * so if a root hub's controller is suspended
1300 * then we're stuck. */
1301 status
= usb_resume_device(udev
, msg
);
1303 } else if (udev
->reset_resume
)
1304 status
= usb_resume_device(udev
, msg
);
1306 if (status
== 0 && udev
->actconfig
) {
1307 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
1308 intf
= udev
->actconfig
->interface
[i
];
1309 usb_resume_interface(udev
, intf
, msg
,
1310 udev
->reset_resume
);
1315 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1317 udev
->reset_resume
= 0;
1321 #ifdef CONFIG_USB_SUSPEND
1323 /* Internal routine to adjust a device's usage counter and change
1324 * its autosuspend state.
1326 static int usb_autopm_do_device(struct usb_device
*udev
, int inc_usage_cnt
)
1332 udev
->pm_usage_cnt
+= inc_usage_cnt
;
1333 WARN_ON(udev
->pm_usage_cnt
< 0);
1335 udev
->last_busy
= jiffies
;
1336 if (inc_usage_cnt
>= 0 && udev
->pm_usage_cnt
> 0) {
1337 if (udev
->state
== USB_STATE_SUSPENDED
)
1338 status
= usb_resume_both(udev
, PMSG_AUTO_RESUME
);
1340 udev
->pm_usage_cnt
-= inc_usage_cnt
;
1341 else if (inc_usage_cnt
)
1342 udev
->last_busy
= jiffies
;
1343 } else if (inc_usage_cnt
<= 0 && udev
->pm_usage_cnt
<= 0) {
1344 status
= usb_suspend_both(udev
, PMSG_AUTO_SUSPEND
);
1346 usb_pm_unlock(udev
);
1350 /* usb_autosuspend_work - callback routine to autosuspend a USB device */
1351 void usb_autosuspend_work(struct work_struct
*work
)
1353 struct usb_device
*udev
=
1354 container_of(work
, struct usb_device
, autosuspend
.work
);
1356 usb_autopm_do_device(udev
, 0);
1359 /* usb_autoresume_work - callback routine to autoresume a USB device */
1360 void usb_autoresume_work(struct work_struct
*work
)
1362 struct usb_device
*udev
=
1363 container_of(work
, struct usb_device
, autoresume
);
1365 /* Wake it up, let the drivers do their thing, and then put it
1368 if (usb_autopm_do_device(udev
, 1) == 0)
1369 usb_autopm_do_device(udev
, -1);
1373 * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
1374 * @udev: the usb_device to autosuspend
1376 * This routine should be called when a core subsystem is finished using
1377 * @udev and wants to allow it to autosuspend. Examples would be when
1378 * @udev's device file in usbfs is closed or after a configuration change.
1380 * @udev's usage counter is decremented. If it or any of the usage counters
1381 * for an active interface is greater than 0, no autosuspend request will be
1382 * queued. (If an interface driver does not support autosuspend then its
1383 * usage counter is permanently positive.) Furthermore, if an interface
1384 * driver requires remote-wakeup capability during autosuspend but remote
1385 * wakeup is disabled, the autosuspend will fail.
1387 * Often the caller will hold @udev's device lock, but this is not
1390 * This routine can run only in process context.
1392 void usb_autosuspend_device(struct usb_device
*udev
)
1396 status
= usb_autopm_do_device(udev
, -1);
1397 dev_vdbg(&udev
->dev
, "%s: cnt %d\n",
1398 __func__
, udev
->pm_usage_cnt
);
1402 * usb_try_autosuspend_device - attempt an autosuspend of a USB device and its interfaces
1403 * @udev: the usb_device to autosuspend
1405 * This routine should be called when a core subsystem thinks @udev may
1406 * be ready to autosuspend.
1408 * @udev's usage counter left unchanged. If it or any of the usage counters
1409 * for an active interface is greater than 0, or autosuspend is not allowed
1410 * for any other reason, no autosuspend request will be queued.
1412 * This routine can run only in process context.
1414 void usb_try_autosuspend_device(struct usb_device
*udev
)
1416 usb_autopm_do_device(udev
, 0);
1417 dev_vdbg(&udev
->dev
, "%s: cnt %d\n",
1418 __func__
, udev
->pm_usage_cnt
);
1422 * usb_autoresume_device - immediately autoresume a USB device and its interfaces
1423 * @udev: the usb_device to autoresume
1425 * This routine should be called when a core subsystem wants to use @udev
1426 * and needs to guarantee that it is not suspended. No autosuspend will
1427 * occur until usb_autosuspend_device is called. (Note that this will not
1428 * prevent suspend events originating in the PM core.) Examples would be
1429 * when @udev's device file in usbfs is opened or when a remote-wakeup
1430 * request is received.
1432 * @udev's usage counter is incremented to prevent subsequent autosuspends.
1433 * However if the autoresume fails then the usage counter is re-decremented.
1435 * Often the caller will hold @udev's device lock, but this is not
1436 * necessary (and attempting it might cause deadlock).
1438 * This routine can run only in process context.
1440 int usb_autoresume_device(struct usb_device
*udev
)
1444 status
= usb_autopm_do_device(udev
, 1);
1445 dev_vdbg(&udev
->dev
, "%s: status %d cnt %d\n",
1446 __func__
, status
, udev
->pm_usage_cnt
);
1450 /* Internal routine to adjust an interface's usage counter and change
1451 * its device's autosuspend state.
1453 static int usb_autopm_do_interface(struct usb_interface
*intf
,
1456 struct usb_device
*udev
= interface_to_usbdev(intf
);
1460 if (intf
->condition
== USB_INTERFACE_UNBOUND
)
1464 intf
->pm_usage_cnt
+= inc_usage_cnt
;
1465 udev
->last_busy
= jiffies
;
1466 if (inc_usage_cnt
>= 0 && intf
->pm_usage_cnt
> 0) {
1467 if (udev
->state
== USB_STATE_SUSPENDED
)
1468 status
= usb_resume_both(udev
,
1471 intf
->pm_usage_cnt
-= inc_usage_cnt
;
1473 udev
->last_busy
= jiffies
;
1474 } else if (inc_usage_cnt
<= 0 && intf
->pm_usage_cnt
<= 0) {
1475 status
= usb_suspend_both(udev
, PMSG_AUTO_SUSPEND
);
1478 usb_pm_unlock(udev
);
1483 * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
1484 * @intf: the usb_interface whose counter should be decremented
1486 * This routine should be called by an interface driver when it is
1487 * finished using @intf and wants to allow it to autosuspend. A typical
1488 * example would be a character-device driver when its device file is
1491 * The routine decrements @intf's usage counter. When the counter reaches
1492 * 0, a delayed autosuspend request for @intf's device is queued. When
1493 * the delay expires, if @intf->pm_usage_cnt is still <= 0 along with all
1494 * the other usage counters for the sibling interfaces and @intf's
1495 * usb_device, the device and all its interfaces will be autosuspended.
1497 * Note that @intf->pm_usage_cnt is owned by the interface driver. The
1498 * core will not change its value other than the increment and decrement
1499 * in usb_autopm_get_interface and usb_autopm_put_interface. The driver
1500 * may use this simple counter-oriented discipline or may set the value
1503 * If the driver has set @intf->needs_remote_wakeup then autosuspend will
1504 * take place only if the device's remote-wakeup facility is enabled.
1506 * Suspend method calls queued by this routine can arrive at any time
1507 * while @intf is resumed and its usage counter is equal to 0. They are
1508 * not protected by the usb_device's lock but only by its pm_mutex.
1509 * Drivers must provide their own synchronization.
1511 * This routine can run only in process context.
1513 void usb_autopm_put_interface(struct usb_interface
*intf
)
1517 status
= usb_autopm_do_interface(intf
, -1);
1518 dev_vdbg(&intf
->dev
, "%s: status %d cnt %d\n",
1519 __func__
, status
, intf
->pm_usage_cnt
);
1521 EXPORT_SYMBOL_GPL(usb_autopm_put_interface
);
1524 * usb_autopm_put_interface_async - decrement a USB interface's PM-usage counter
1525 * @intf: the usb_interface whose counter should be decremented
1527 * This routine does essentially the same thing as
1528 * usb_autopm_put_interface(): it decrements @intf's usage counter and
1529 * queues a delayed autosuspend request if the counter is <= 0. The
1530 * difference is that it does not acquire the device's pm_mutex;
1531 * callers must handle all synchronization issues themselves.
1533 * Typically a driver would call this routine during an URB's completion
1534 * handler, if no more URBs were pending.
1536 * This routine can run in atomic context.
1538 void usb_autopm_put_interface_async(struct usb_interface
*intf
)
1540 struct usb_device
*udev
= interface_to_usbdev(intf
);
1543 if (intf
->condition
== USB_INTERFACE_UNBOUND
) {
1546 udev
->last_busy
= jiffies
;
1547 --intf
->pm_usage_cnt
;
1548 if (udev
->autosuspend_disabled
|| udev
->autosuspend_delay
< 0)
1550 else if (intf
->pm_usage_cnt
<= 0 &&
1551 !timer_pending(&udev
->autosuspend
.timer
)) {
1552 queue_delayed_work(ksuspend_usb_wq
, &udev
->autosuspend
,
1553 round_jiffies_up_relative(
1554 udev
->autosuspend_delay
));
1557 dev_vdbg(&intf
->dev
, "%s: status %d cnt %d\n",
1558 __func__
, status
, intf
->pm_usage_cnt
);
1560 EXPORT_SYMBOL_GPL(usb_autopm_put_interface_async
);
1563 * usb_autopm_get_interface - increment a USB interface's PM-usage counter
1564 * @intf: the usb_interface whose counter should be incremented
1566 * This routine should be called by an interface driver when it wants to
1567 * use @intf and needs to guarantee that it is not suspended. In addition,
1568 * the routine prevents @intf from being autosuspended subsequently. (Note
1569 * that this will not prevent suspend events originating in the PM core.)
1570 * This prevention will persist until usb_autopm_put_interface() is called
1571 * or @intf is unbound. A typical example would be a character-device
1572 * driver when its device file is opened.
1575 * The routine increments @intf's usage counter. (However if the
1576 * autoresume fails then the counter is re-decremented.) So long as the
1577 * counter is greater than 0, autosuspend will not be allowed for @intf
1578 * or its usb_device. When the driver is finished using @intf it should
1579 * call usb_autopm_put_interface() to decrement the usage counter and
1580 * queue a delayed autosuspend request (if the counter is <= 0).
1583 * Note that @intf->pm_usage_cnt is owned by the interface driver. The
1584 * core will not change its value other than the increment and decrement
1585 * in usb_autopm_get_interface and usb_autopm_put_interface. The driver
1586 * may use this simple counter-oriented discipline or may set the value
1589 * Resume method calls generated by this routine can arrive at any time
1590 * while @intf is suspended. They are not protected by the usb_device's
1591 * lock but only by its pm_mutex. Drivers must provide their own
1594 * This routine can run only in process context.
1596 int usb_autopm_get_interface(struct usb_interface
*intf
)
1600 status
= usb_autopm_do_interface(intf
, 1);
1601 dev_vdbg(&intf
->dev
, "%s: status %d cnt %d\n",
1602 __func__
, status
, intf
->pm_usage_cnt
);
1605 EXPORT_SYMBOL_GPL(usb_autopm_get_interface
);
1608 * usb_autopm_get_interface_async - increment a USB interface's PM-usage counter
1609 * @intf: the usb_interface whose counter should be incremented
1611 * This routine does much the same thing as
1612 * usb_autopm_get_interface(): it increments @intf's usage counter and
1613 * queues an autoresume request if the result is > 0. The differences
1614 * are that it does not acquire the device's pm_mutex (callers must
1615 * handle all synchronization issues themselves), and it does not
1616 * autoresume the device directly (it only queues a request). After a
1617 * successful call, the device will generally not yet be resumed.
1619 * This routine can run in atomic context.
1621 int usb_autopm_get_interface_async(struct usb_interface
*intf
)
1623 struct usb_device
*udev
= interface_to_usbdev(intf
);
1626 if (intf
->condition
== USB_INTERFACE_UNBOUND
)
1628 else if (udev
->autoresume_disabled
)
1630 else if (++intf
->pm_usage_cnt
> 0 && udev
->state
== USB_STATE_SUSPENDED
)
1631 queue_work(ksuspend_usb_wq
, &udev
->autoresume
);
1632 dev_vdbg(&intf
->dev
, "%s: status %d cnt %d\n",
1633 __func__
, status
, intf
->pm_usage_cnt
);
1636 EXPORT_SYMBOL_GPL(usb_autopm_get_interface_async
);
1639 * usb_autopm_set_interface - set a USB interface's autosuspend state
1640 * @intf: the usb_interface whose state should be set
1642 * This routine sets the autosuspend state of @intf's device according
1643 * to @intf's usage counter, which the caller must have set previously.
1644 * If the counter is <= 0, the device is autosuspended (if it isn't
1645 * already suspended and if nothing else prevents the autosuspend). If
1646 * the counter is > 0, the device is autoresumed (if it isn't already
1649 int usb_autopm_set_interface(struct usb_interface
*intf
)
1653 status
= usb_autopm_do_interface(intf
, 0);
1654 dev_vdbg(&intf
->dev
, "%s: status %d cnt %d\n",
1655 __func__
, status
, intf
->pm_usage_cnt
);
1658 EXPORT_SYMBOL_GPL(usb_autopm_set_interface
);
1662 void usb_autosuspend_work(struct work_struct
*work
)
1665 void usb_autoresume_work(struct work_struct
*work
)
1668 #endif /* CONFIG_USB_SUSPEND */
1671 * usb_external_suspend_device - external suspend of a USB device and its interfaces
1672 * @udev: the usb_device to suspend
1673 * @msg: Power Management message describing this state transition
1675 * This routine handles external suspend requests: ones not generated
1676 * internally by a USB driver (autosuspend) but rather coming from the user
1677 * (via sysfs) or the PM core (system sleep). The suspend will be carried
1678 * out regardless of @udev's usage counter or those of its interfaces,
1679 * and regardless of whether or not remote wakeup is enabled. Of course,
1680 * interface drivers still have the option of failing the suspend (if
1681 * there are unsuspended children, for example).
1683 * The caller must hold @udev's device lock.
1685 int usb_external_suspend_device(struct usb_device
*udev
, pm_message_t msg
)
1689 do_unbind_rebind(udev
, DO_UNBIND
);
1692 status
= usb_suspend_both(udev
, msg
);
1693 usb_pm_unlock(udev
);
1698 * usb_external_resume_device - external resume of a USB device and its interfaces
1699 * @udev: the usb_device to resume
1700 * @msg: Power Management message describing this state transition
1702 * This routine handles external resume requests: ones not generated
1703 * internally by a USB driver (autoresume) but rather coming from the user
1704 * (via sysfs), the PM core (system resume), or the device itself (remote
1705 * wakeup). @udev's usage counter is unaffected.
1707 * The caller must hold @udev's device lock.
1709 int usb_external_resume_device(struct usb_device
*udev
, pm_message_t msg
)
1715 status
= usb_resume_both(udev
, msg
);
1716 udev
->last_busy
= jiffies
;
1717 usb_pm_unlock(udev
);
1719 do_unbind_rebind(udev
, DO_REBIND
);
1721 /* Now that the device is awake, we can start trying to autosuspend
1724 usb_try_autosuspend_device(udev
);
1728 int usb_suspend(struct device
*dev
, pm_message_t msg
)
1730 struct usb_device
*udev
;
1732 udev
= to_usb_device(dev
);
1734 /* If udev is already suspended, we can skip this suspend and
1735 * we should also skip the upcoming system resume. High-speed
1736 * root hubs are an exception; they need to resume whenever the
1737 * system wakes up in order for USB-PERSIST port handover to work
1740 if (udev
->state
== USB_STATE_SUSPENDED
) {
1741 if (udev
->parent
|| udev
->speed
!= USB_SPEED_HIGH
)
1742 udev
->skip_sys_resume
= 1;
1746 udev
->skip_sys_resume
= 0;
1747 return usb_external_suspend_device(udev
, msg
);
1750 int usb_resume(struct device
*dev
, pm_message_t msg
)
1752 struct usb_device
*udev
;
1755 udev
= to_usb_device(dev
);
1757 /* If udev->skip_sys_resume is set then udev was already suspended
1758 * when the system sleep started, so we don't want to resume it
1759 * during this system wakeup.
1761 if (udev
->skip_sys_resume
)
1763 status
= usb_external_resume_device(udev
, msg
);
1765 /* Avoid PM error messages for devices disconnected while suspended
1766 * as we'll display regular disconnect messages just a bit later.
1768 if (status
== -ENODEV
)
1773 #endif /* CONFIG_PM */
1775 struct bus_type usb_bus_type
= {
1777 .match
= usb_device_match
,
1778 .uevent
= usb_uevent
,