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/slab.h>
27 #include <linux/export.h>
28 #include <linux/usb.h>
29 #include <linux/usb/quirks.h>
30 #include <linux/usb/hcd.h>
38 * Adds a new dynamic USBdevice ID to this driver,
39 * and cause the driver to probe for all devices again.
41 ssize_t
usb_store_new_id(struct usb_dynids
*dynids
,
42 struct device_driver
*driver
,
43 const char *buf
, size_t count
)
45 struct usb_dynid
*dynid
;
48 unsigned int bInterfaceClass
= 0;
52 fields
= sscanf(buf
, "%x %x %x", &idVendor
, &idProduct
,
57 dynid
= kzalloc(sizeof(*dynid
), GFP_KERNEL
);
61 INIT_LIST_HEAD(&dynid
->node
);
62 dynid
->id
.idVendor
= idVendor
;
63 dynid
->id
.idProduct
= idProduct
;
64 dynid
->id
.match_flags
= USB_DEVICE_ID_MATCH_DEVICE
;
66 dynid
->id
.bInterfaceClass
= (u8
)bInterfaceClass
;
67 dynid
->id
.match_flags
|= USB_DEVICE_ID_MATCH_INT_CLASS
;
70 spin_lock(&dynids
->lock
);
71 list_add_tail(&dynid
->node
, &dynids
->list
);
72 spin_unlock(&dynids
->lock
);
74 retval
= driver_attach(driver
);
80 EXPORT_SYMBOL_GPL(usb_store_new_id
);
82 ssize_t
usb_show_dynids(struct usb_dynids
*dynids
, char *buf
)
84 struct usb_dynid
*dynid
;
87 list_for_each_entry(dynid
, &dynids
->list
, node
)
88 if (dynid
->id
.bInterfaceClass
!= 0)
89 count
+= scnprintf(&buf
[count
], PAGE_SIZE
- count
, "%04x %04x %02x\n",
90 dynid
->id
.idVendor
, dynid
->id
.idProduct
,
91 dynid
->id
.bInterfaceClass
);
93 count
+= scnprintf(&buf
[count
], PAGE_SIZE
- count
, "%04x %04x\n",
94 dynid
->id
.idVendor
, dynid
->id
.idProduct
);
97 EXPORT_SYMBOL_GPL(usb_show_dynids
);
99 static ssize_t
show_dynids(struct device_driver
*driver
, char *buf
)
101 struct usb_driver
*usb_drv
= to_usb_driver(driver
);
103 return usb_show_dynids(&usb_drv
->dynids
, buf
);
106 static ssize_t
store_new_id(struct device_driver
*driver
,
107 const char *buf
, size_t count
)
109 struct usb_driver
*usb_drv
= to_usb_driver(driver
);
111 return usb_store_new_id(&usb_drv
->dynids
, driver
, buf
, count
);
113 static DRIVER_ATTR(new_id
, S_IRUGO
| S_IWUSR
, show_dynids
, store_new_id
);
116 * store_remove_id - remove a USB device ID from this driver
117 * @driver: target device driver
118 * @buf: buffer for scanning device ID data
121 * Removes a dynamic usb device ID from this driver.
124 store_remove_id(struct device_driver
*driver
, const char *buf
, size_t count
)
126 struct usb_dynid
*dynid
, *n
;
127 struct usb_driver
*usb_driver
= to_usb_driver(driver
);
133 fields
= sscanf(buf
, "%x %x", &idVendor
, &idProduct
);
137 spin_lock(&usb_driver
->dynids
.lock
);
138 list_for_each_entry_safe(dynid
, n
, &usb_driver
->dynids
.list
, node
) {
139 struct usb_device_id
*id
= &dynid
->id
;
140 if ((id
->idVendor
== idVendor
) &&
141 (id
->idProduct
== idProduct
)) {
142 list_del(&dynid
->node
);
148 spin_unlock(&usb_driver
->dynids
.lock
);
154 static DRIVER_ATTR(remove_id
, S_IRUGO
| S_IWUSR
, show_dynids
, store_remove_id
);
156 static int usb_create_newid_files(struct usb_driver
*usb_drv
)
160 if (usb_drv
->no_dynamic_id
)
163 if (usb_drv
->probe
!= NULL
) {
164 error
= driver_create_file(&usb_drv
->drvwrap
.driver
,
165 &driver_attr_new_id
);
167 error
= driver_create_file(&usb_drv
->drvwrap
.driver
,
168 &driver_attr_remove_id
);
170 driver_remove_file(&usb_drv
->drvwrap
.driver
,
171 &driver_attr_new_id
);
178 static void usb_remove_newid_files(struct usb_driver
*usb_drv
)
180 if (usb_drv
->no_dynamic_id
)
183 if (usb_drv
->probe
!= NULL
) {
184 driver_remove_file(&usb_drv
->drvwrap
.driver
,
185 &driver_attr_remove_id
);
186 driver_remove_file(&usb_drv
->drvwrap
.driver
,
187 &driver_attr_new_id
);
191 static void usb_free_dynids(struct usb_driver
*usb_drv
)
193 struct usb_dynid
*dynid
, *n
;
195 spin_lock(&usb_drv
->dynids
.lock
);
196 list_for_each_entry_safe(dynid
, n
, &usb_drv
->dynids
.list
, node
) {
197 list_del(&dynid
->node
);
200 spin_unlock(&usb_drv
->dynids
.lock
);
203 static inline int usb_create_newid_files(struct usb_driver
*usb_drv
)
208 static void usb_remove_newid_files(struct usb_driver
*usb_drv
)
212 static inline void usb_free_dynids(struct usb_driver
*usb_drv
)
217 static const struct usb_device_id
*usb_match_dynamic_id(struct usb_interface
*intf
,
218 struct usb_driver
*drv
)
220 struct usb_dynid
*dynid
;
222 spin_lock(&drv
->dynids
.lock
);
223 list_for_each_entry(dynid
, &drv
->dynids
.list
, node
) {
224 if (usb_match_one_id(intf
, &dynid
->id
)) {
225 spin_unlock(&drv
->dynids
.lock
);
229 spin_unlock(&drv
->dynids
.lock
);
234 /* called from driver core with dev locked */
235 static int usb_probe_device(struct device
*dev
)
237 struct usb_device_driver
*udriver
= to_usb_device_driver(dev
->driver
);
238 struct usb_device
*udev
= to_usb_device(dev
);
241 dev_dbg(dev
, "%s\n", __func__
);
243 /* TODO: Add real matching code */
245 /* The device should always appear to be in use
246 * unless the driver suports autosuspend.
248 if (!udriver
->supports_autosuspend
)
249 error
= usb_autoresume_device(udev
);
252 error
= udriver
->probe(udev
);
256 /* called from driver core with dev locked */
257 static int usb_unbind_device(struct device
*dev
)
259 struct usb_device
*udev
= to_usb_device(dev
);
260 struct usb_device_driver
*udriver
= to_usb_device_driver(dev
->driver
);
262 udriver
->disconnect(udev
);
263 if (!udriver
->supports_autosuspend
)
264 usb_autosuspend_device(udev
);
269 * Cancel any pending scheduled resets
271 * [see usb_queue_reset_device()]
273 * Called after unconfiguring / when releasing interfaces. See
274 * comments in __usb_queue_reset_device() regarding
275 * udev->reset_running.
277 static void usb_cancel_queued_reset(struct usb_interface
*iface
)
279 if (iface
->reset_running
== 0)
280 cancel_work_sync(&iface
->reset_ws
);
283 /* called from driver core with dev locked */
284 static int usb_probe_interface(struct device
*dev
)
286 struct usb_driver
*driver
= to_usb_driver(dev
->driver
);
287 struct usb_interface
*intf
= to_usb_interface(dev
);
288 struct usb_device
*udev
= interface_to_usbdev(intf
);
289 const struct usb_device_id
*id
;
291 int lpm_disable_error
;
293 dev_dbg(dev
, "%s\n", __func__
);
295 intf
->needs_binding
= 0;
297 if (usb_device_is_owned(udev
))
300 if (udev
->authorized
== 0) {
301 dev_err(&intf
->dev
, "Device is not authorized for usage\n");
305 id
= usb_match_id(intf
, driver
->id_table
);
307 id
= usb_match_dynamic_id(intf
, driver
);
311 dev_dbg(dev
, "%s - got id\n", __func__
);
313 error
= usb_autoresume_device(udev
);
317 intf
->condition
= USB_INTERFACE_BINDING
;
319 /* Probed interfaces are initially active. They are
320 * runtime-PM-enabled only if the driver has autosuspend support.
321 * They are sensitive to their children's power states.
323 pm_runtime_set_active(dev
);
324 pm_suspend_ignore_children(dev
, false);
325 if (driver
->supports_autosuspend
)
326 pm_runtime_enable(dev
);
328 /* If the new driver doesn't allow hub-initiated LPM, and we can't
329 * disable hub-initiated LPM, then fail the probe.
331 * Otherwise, leaving LPM enabled should be harmless, because the
332 * endpoint intervals should remain the same, and the U1/U2 timeouts
333 * should remain the same.
335 * If we need to install alt setting 0 before probe, or another alt
336 * setting during probe, that should also be fine. usb_set_interface()
337 * will attempt to disable LPM, and fail if it can't disable it.
339 lpm_disable_error
= usb_unlocked_disable_lpm(udev
);
340 if (lpm_disable_error
&& driver
->disable_hub_initiated_lpm
) {
341 dev_err(&intf
->dev
, "%s Failed to disable LPM for driver %s\n.",
342 __func__
, driver
->name
);
343 error
= lpm_disable_error
;
347 /* Carry out a deferred switch to altsetting 0 */
348 if (intf
->needs_altsetting0
) {
349 error
= usb_set_interface(udev
, intf
->altsetting
[0].
350 desc
.bInterfaceNumber
, 0);
353 intf
->needs_altsetting0
= 0;
356 error
= driver
->probe(intf
, id
);
360 intf
->condition
= USB_INTERFACE_BOUND
;
362 /* If the LPM disable succeeded, balance the ref counts. */
363 if (!lpm_disable_error
)
364 usb_unlocked_enable_lpm(udev
);
366 usb_autosuspend_device(udev
);
370 usb_set_intfdata(intf
, NULL
);
371 intf
->needs_remote_wakeup
= 0;
372 intf
->condition
= USB_INTERFACE_UNBOUND
;
373 usb_cancel_queued_reset(intf
);
375 /* Unbound interfaces are always runtime-PM-disabled and -suspended */
376 if (driver
->supports_autosuspend
)
377 pm_runtime_disable(dev
);
378 pm_runtime_set_suspended(dev
);
380 usb_autosuspend_device(udev
);
384 /* called from driver core with dev locked */
385 static int usb_unbind_interface(struct device
*dev
)
387 struct usb_driver
*driver
= to_usb_driver(dev
->driver
);
388 struct usb_interface
*intf
= to_usb_interface(dev
);
389 struct usb_device
*udev
;
390 int error
, r
, lpm_disable_error
;
392 intf
->condition
= USB_INTERFACE_UNBINDING
;
394 /* Autoresume for set_interface call below */
395 udev
= interface_to_usbdev(intf
);
396 error
= usb_autoresume_device(udev
);
398 /* Hub-initiated LPM policy may change, so attempt to disable LPM until
399 * the driver is unbound. If LPM isn't disabled, that's fine because it
400 * wouldn't be enabled unless all the bound interfaces supported
403 lpm_disable_error
= usb_unlocked_disable_lpm(udev
);
405 /* Terminate all URBs for this interface unless the driver
406 * supports "soft" unbinding.
408 if (!driver
->soft_unbind
)
409 usb_disable_interface(udev
, intf
, false);
411 driver
->disconnect(intf
);
412 usb_cancel_queued_reset(intf
);
414 /* Reset other interface state.
415 * We cannot do a Set-Interface if the device is suspended or
416 * if it is prepared for a system sleep (since installing a new
417 * altsetting means creating new endpoint device entries).
418 * When either of these happens, defer the Set-Interface.
420 if (intf
->cur_altsetting
->desc
.bAlternateSetting
== 0) {
421 /* Already in altsetting 0 so skip Set-Interface.
422 * Just re-enable it without affecting the endpoint toggles.
424 usb_enable_interface(udev
, intf
, false);
425 } else if (!error
&& !intf
->dev
.power
.is_prepared
) {
426 r
= usb_set_interface(udev
, intf
->altsetting
[0].
427 desc
.bInterfaceNumber
, 0);
429 intf
->needs_altsetting0
= 1;
431 intf
->needs_altsetting0
= 1;
433 usb_set_intfdata(intf
, NULL
);
435 intf
->condition
= USB_INTERFACE_UNBOUND
;
436 intf
->needs_remote_wakeup
= 0;
438 /* Attempt to re-enable USB3 LPM, if the disable succeeded. */
439 if (!lpm_disable_error
)
440 usb_unlocked_enable_lpm(udev
);
442 /* Unbound interfaces are always runtime-PM-disabled and -suspended */
443 if (driver
->supports_autosuspend
)
444 pm_runtime_disable(dev
);
445 pm_runtime_set_suspended(dev
);
447 /* Undo any residual pm_autopm_get_interface_* calls */
448 for (r
= atomic_read(&intf
->pm_usage_cnt
); r
> 0; --r
)
449 usb_autopm_put_interface_no_suspend(intf
);
450 atomic_set(&intf
->pm_usage_cnt
, 0);
453 usb_autosuspend_device(udev
);
459 * usb_driver_claim_interface - bind a driver to an interface
460 * @driver: the driver to be bound
461 * @iface: the interface to which it will be bound; must be in the
462 * usb device's active configuration
463 * @priv: driver data associated with that interface
465 * This is used by usb device drivers that need to claim more than one
466 * interface on a device when probing (audio and acm are current examples).
467 * No device driver should directly modify internal usb_interface or
468 * usb_device structure members.
470 * Few drivers should need to use this routine, since the most natural
471 * way to bind to an interface is to return the private data from
472 * the driver's probe() method.
474 * Callers must own the device lock, so driver probe() entries don't need
475 * extra locking, but other call contexts may need to explicitly claim that
478 int usb_driver_claim_interface(struct usb_driver
*driver
,
479 struct usb_interface
*iface
, void *priv
)
481 struct device
*dev
= &iface
->dev
;
482 struct usb_device
*udev
;
484 int lpm_disable_error
;
489 udev
= interface_to_usbdev(iface
);
491 dev
->driver
= &driver
->drvwrap
.driver
;
492 usb_set_intfdata(iface
, priv
);
493 iface
->needs_binding
= 0;
495 iface
->condition
= USB_INTERFACE_BOUND
;
497 /* Disable LPM until this driver is bound. */
498 lpm_disable_error
= usb_unlocked_disable_lpm(udev
);
499 if (lpm_disable_error
&& driver
->disable_hub_initiated_lpm
) {
500 dev_err(&iface
->dev
, "%s Failed to disable LPM for driver %s\n.",
501 __func__
, driver
->name
);
505 /* Claimed interfaces are initially inactive (suspended) and
506 * runtime-PM-enabled, but only if the driver has autosuspend
507 * support. Otherwise they are marked active, to prevent the
508 * device from being autosuspended, but left disabled. In either
509 * case they are sensitive to their children's power states.
511 pm_suspend_ignore_children(dev
, false);
512 if (driver
->supports_autosuspend
)
513 pm_runtime_enable(dev
);
515 pm_runtime_set_active(dev
);
517 /* if interface was already added, bind now; else let
518 * the future device_add() bind it, bypassing probe()
520 if (device_is_registered(dev
))
521 retval
= device_bind_driver(dev
);
523 /* Attempt to re-enable USB3 LPM, if the disable was successful. */
524 if (!lpm_disable_error
)
525 usb_unlocked_enable_lpm(udev
);
529 EXPORT_SYMBOL_GPL(usb_driver_claim_interface
);
532 * usb_driver_release_interface - unbind a driver from an interface
533 * @driver: the driver to be unbound
534 * @iface: the interface from which it will be unbound
536 * This can be used by drivers to release an interface without waiting
537 * for their disconnect() methods to be called. In typical cases this
538 * also causes the driver disconnect() method to be called.
540 * This call is synchronous, and may not be used in an interrupt context.
541 * Callers must own the device lock, so driver disconnect() entries don't
542 * need extra locking, but other call contexts may need to explicitly claim
545 void usb_driver_release_interface(struct usb_driver
*driver
,
546 struct usb_interface
*iface
)
548 struct device
*dev
= &iface
->dev
;
550 /* this should never happen, don't release something that's not ours */
551 if (!dev
->driver
|| dev
->driver
!= &driver
->drvwrap
.driver
)
554 /* don't release from within disconnect() */
555 if (iface
->condition
!= USB_INTERFACE_BOUND
)
557 iface
->condition
= USB_INTERFACE_UNBINDING
;
559 /* Release via the driver core only if the interface
560 * has already been registered
562 if (device_is_registered(dev
)) {
563 device_release_driver(dev
);
566 usb_unbind_interface(dev
);
571 EXPORT_SYMBOL_GPL(usb_driver_release_interface
);
573 /* returns 0 if no match, 1 if match */
574 int usb_match_device(struct usb_device
*dev
, const struct usb_device_id
*id
)
576 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_VENDOR
) &&
577 id
->idVendor
!= le16_to_cpu(dev
->descriptor
.idVendor
))
580 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_PRODUCT
) &&
581 id
->idProduct
!= le16_to_cpu(dev
->descriptor
.idProduct
))
584 /* No need to test id->bcdDevice_lo != 0, since 0 is never
585 greater than any unsigned number. */
586 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_LO
) &&
587 (id
->bcdDevice_lo
> le16_to_cpu(dev
->descriptor
.bcdDevice
)))
590 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_HI
) &&
591 (id
->bcdDevice_hi
< le16_to_cpu(dev
->descriptor
.bcdDevice
)))
594 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_CLASS
) &&
595 (id
->bDeviceClass
!= dev
->descriptor
.bDeviceClass
))
598 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_SUBCLASS
) &&
599 (id
->bDeviceSubClass
!= dev
->descriptor
.bDeviceSubClass
))
602 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_PROTOCOL
) &&
603 (id
->bDeviceProtocol
!= dev
->descriptor
.bDeviceProtocol
))
609 /* returns 0 if no match, 1 if match */
610 int usb_match_one_id_intf(struct usb_device
*dev
,
611 struct usb_host_interface
*intf
,
612 const struct usb_device_id
*id
)
614 /* The interface class, subclass, protocol and number should never be
615 * checked for a match if the device class is Vendor Specific,
616 * unless the match record specifies the Vendor ID. */
617 if (dev
->descriptor
.bDeviceClass
== USB_CLASS_VENDOR_SPEC
&&
618 !(id
->match_flags
& USB_DEVICE_ID_MATCH_VENDOR
) &&
619 (id
->match_flags
& (USB_DEVICE_ID_MATCH_INT_CLASS
|
620 USB_DEVICE_ID_MATCH_INT_SUBCLASS
|
621 USB_DEVICE_ID_MATCH_INT_PROTOCOL
|
622 USB_DEVICE_ID_MATCH_INT_NUMBER
)))
625 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_CLASS
) &&
626 (id
->bInterfaceClass
!= intf
->desc
.bInterfaceClass
))
629 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_SUBCLASS
) &&
630 (id
->bInterfaceSubClass
!= intf
->desc
.bInterfaceSubClass
))
633 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_PROTOCOL
) &&
634 (id
->bInterfaceProtocol
!= intf
->desc
.bInterfaceProtocol
))
637 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_NUMBER
) &&
638 (id
->bInterfaceNumber
!= intf
->desc
.bInterfaceNumber
))
644 /* returns 0 if no match, 1 if match */
645 int usb_match_one_id(struct usb_interface
*interface
,
646 const struct usb_device_id
*id
)
648 struct usb_host_interface
*intf
;
649 struct usb_device
*dev
;
651 /* proc_connectinfo in devio.c may call us with id == NULL. */
655 intf
= interface
->cur_altsetting
;
656 dev
= interface_to_usbdev(interface
);
658 if (!usb_match_device(dev
, id
))
661 return usb_match_one_id_intf(dev
, intf
, id
);
663 EXPORT_SYMBOL_GPL(usb_match_one_id
);
666 * usb_match_id - find first usb_device_id matching device or interface
667 * @interface: the interface of interest
668 * @id: array of usb_device_id structures, terminated by zero entry
670 * usb_match_id searches an array of usb_device_id's and returns
671 * the first one matching the device or interface, or null.
672 * This is used when binding (or rebinding) a driver to an interface.
673 * Most USB device drivers will use this indirectly, through the usb core,
674 * but some layered driver frameworks use it directly.
675 * These device tables are exported with MODULE_DEVICE_TABLE, through
676 * modutils, to support the driver loading functionality of USB hotplugging.
680 * The "match_flags" element in a usb_device_id controls which
681 * members are used. If the corresponding bit is set, the
682 * value in the device_id must match its corresponding member
683 * in the device or interface descriptor, or else the device_id
686 * "driver_info" is normally used only by device drivers,
687 * but you can create a wildcard "matches anything" usb_device_id
688 * as a driver's "modules.usbmap" entry if you provide an id with
689 * only a nonzero "driver_info" field. If you do this, the USB device
690 * driver's probe() routine should use additional intelligence to
691 * decide whether to bind to the specified interface.
693 * What Makes Good usb_device_id Tables:
695 * The match algorithm is very simple, so that intelligence in
696 * driver selection must come from smart driver id records.
697 * Unless you have good reasons to use another selection policy,
698 * provide match elements only in related groups, and order match
699 * specifiers from specific to general. Use the macros provided
700 * for that purpose if you can.
702 * The most specific match specifiers use device descriptor
703 * data. These are commonly used with product-specific matches;
704 * the USB_DEVICE macro lets you provide vendor and product IDs,
705 * and you can also match against ranges of product revisions.
706 * These are widely used for devices with application or vendor
707 * specific bDeviceClass values.
709 * Matches based on device class/subclass/protocol specifications
710 * are slightly more general; use the USB_DEVICE_INFO macro, or
711 * its siblings. These are used with single-function devices
712 * where bDeviceClass doesn't specify that each interface has
715 * Matches based on interface class/subclass/protocol are the
716 * most general; they let drivers bind to any interface on a
717 * multiple-function device. Use the USB_INTERFACE_INFO
718 * macro, or its siblings, to match class-per-interface style
719 * devices (as recorded in bInterfaceClass).
721 * Note that an entry created by USB_INTERFACE_INFO won't match
722 * any interface if the device class is set to Vendor-Specific.
723 * This is deliberate; according to the USB spec the meanings of
724 * the interface class/subclass/protocol for these devices are also
725 * vendor-specific, and hence matching against a standard product
726 * class wouldn't work anyway. If you really want to use an
727 * interface-based match for such a device, create a match record
728 * that also specifies the vendor ID. (Unforunately there isn't a
729 * standard macro for creating records like this.)
731 * Within those groups, remember that not all combinations are
732 * meaningful. For example, don't give a product version range
733 * without vendor and product IDs; or specify a protocol without
734 * its associated class and subclass.
736 const struct usb_device_id
*usb_match_id(struct usb_interface
*interface
,
737 const struct usb_device_id
*id
)
739 /* proc_connectinfo in devio.c may call us with id == NULL. */
743 /* It is important to check that id->driver_info is nonzero,
744 since an entry that is all zeroes except for a nonzero
745 id->driver_info is the way to create an entry that
746 indicates that the driver want to examine every
747 device and interface. */
748 for (; id
->idVendor
|| id
->idProduct
|| id
->bDeviceClass
||
749 id
->bInterfaceClass
|| id
->driver_info
; id
++) {
750 if (usb_match_one_id(interface
, id
))
756 EXPORT_SYMBOL_GPL(usb_match_id
);
758 static int usb_device_match(struct device
*dev
, struct device_driver
*drv
)
760 /* devices and interfaces are handled separately */
761 if (is_usb_device(dev
)) {
763 /* interface drivers never match devices */
764 if (!is_usb_device_driver(drv
))
767 /* TODO: Add real matching code */
770 } else if (is_usb_interface(dev
)) {
771 struct usb_interface
*intf
;
772 struct usb_driver
*usb_drv
;
773 const struct usb_device_id
*id
;
775 /* device drivers never match interfaces */
776 if (is_usb_device_driver(drv
))
779 intf
= to_usb_interface(dev
);
780 usb_drv
= to_usb_driver(drv
);
782 id
= usb_match_id(intf
, usb_drv
->id_table
);
786 id
= usb_match_dynamic_id(intf
, usb_drv
);
794 #ifdef CONFIG_HOTPLUG
795 static int usb_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
797 struct usb_device
*usb_dev
;
799 if (is_usb_device(dev
)) {
800 usb_dev
= to_usb_device(dev
);
801 } else if (is_usb_interface(dev
)) {
802 struct usb_interface
*intf
= to_usb_interface(dev
);
804 usb_dev
= interface_to_usbdev(intf
);
809 if (usb_dev
->devnum
< 0) {
810 /* driver is often null here; dev_dbg() would oops */
811 pr_debug("usb %s: already deleted?\n", dev_name(dev
));
815 pr_debug("usb %s: bus removed?\n", dev_name(dev
));
819 /* per-device configurations are common */
820 if (add_uevent_var(env
, "PRODUCT=%x/%x/%x",
821 le16_to_cpu(usb_dev
->descriptor
.idVendor
),
822 le16_to_cpu(usb_dev
->descriptor
.idProduct
),
823 le16_to_cpu(usb_dev
->descriptor
.bcdDevice
)))
826 /* class-based driver binding models */
827 if (add_uevent_var(env
, "TYPE=%d/%d/%d",
828 usb_dev
->descriptor
.bDeviceClass
,
829 usb_dev
->descriptor
.bDeviceSubClass
,
830 usb_dev
->descriptor
.bDeviceProtocol
))
838 static int usb_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
842 #endif /* CONFIG_HOTPLUG */
845 * usb_register_device_driver - register a USB device (not interface) driver
846 * @new_udriver: USB operations for the device driver
847 * @owner: module owner of this driver.
849 * Registers a USB device driver with the USB core. The list of
850 * unattached devices will be rescanned whenever a new driver is
851 * added, allowing the new driver to attach to any recognized devices.
852 * Returns a negative error code on failure and 0 on success.
854 int usb_register_device_driver(struct usb_device_driver
*new_udriver
,
855 struct module
*owner
)
862 new_udriver
->drvwrap
.for_devices
= 1;
863 new_udriver
->drvwrap
.driver
.name
= (char *) new_udriver
->name
;
864 new_udriver
->drvwrap
.driver
.bus
= &usb_bus_type
;
865 new_udriver
->drvwrap
.driver
.probe
= usb_probe_device
;
866 new_udriver
->drvwrap
.driver
.remove
= usb_unbind_device
;
867 new_udriver
->drvwrap
.driver
.owner
= owner
;
869 retval
= driver_register(&new_udriver
->drvwrap
.driver
);
872 pr_info("%s: registered new device driver %s\n",
873 usbcore_name
, new_udriver
->name
);
875 printk(KERN_ERR
"%s: error %d registering device "
877 usbcore_name
, retval
, new_udriver
->name
);
881 EXPORT_SYMBOL_GPL(usb_register_device_driver
);
884 * usb_deregister_device_driver - unregister a USB device (not interface) driver
885 * @udriver: USB operations of the device driver to unregister
886 * Context: must be able to sleep
888 * Unlinks the specified driver from the internal USB driver list.
890 void usb_deregister_device_driver(struct usb_device_driver
*udriver
)
892 pr_info("%s: deregistering device driver %s\n",
893 usbcore_name
, udriver
->name
);
895 driver_unregister(&udriver
->drvwrap
.driver
);
897 EXPORT_SYMBOL_GPL(usb_deregister_device_driver
);
900 * usb_register_driver - register a USB interface driver
901 * @new_driver: USB operations for the interface driver
902 * @owner: module owner of this driver.
903 * @mod_name: module name string
905 * Registers a USB interface driver with the USB core. The list of
906 * unattached interfaces will be rescanned whenever a new driver is
907 * added, allowing the new driver to attach to any recognized interfaces.
908 * Returns a negative error code on failure and 0 on success.
910 * NOTE: if you want your driver to use the USB major number, you must call
911 * usb_register_dev() to enable that functionality. This function no longer
912 * takes care of that.
914 int usb_register_driver(struct usb_driver
*new_driver
, struct module
*owner
,
915 const char *mod_name
)
922 new_driver
->drvwrap
.for_devices
= 0;
923 new_driver
->drvwrap
.driver
.name
= (char *) new_driver
->name
;
924 new_driver
->drvwrap
.driver
.bus
= &usb_bus_type
;
925 new_driver
->drvwrap
.driver
.probe
= usb_probe_interface
;
926 new_driver
->drvwrap
.driver
.remove
= usb_unbind_interface
;
927 new_driver
->drvwrap
.driver
.owner
= owner
;
928 new_driver
->drvwrap
.driver
.mod_name
= mod_name
;
929 spin_lock_init(&new_driver
->dynids
.lock
);
930 INIT_LIST_HEAD(&new_driver
->dynids
.list
);
932 retval
= driver_register(&new_driver
->drvwrap
.driver
);
936 retval
= usb_create_newid_files(new_driver
);
940 pr_info("%s: registered new interface driver %s\n",
941 usbcore_name
, new_driver
->name
);
947 driver_unregister(&new_driver
->drvwrap
.driver
);
949 printk(KERN_ERR
"%s: error %d registering interface "
951 usbcore_name
, retval
, new_driver
->name
);
954 EXPORT_SYMBOL_GPL(usb_register_driver
);
957 * usb_deregister - unregister a USB interface driver
958 * @driver: USB operations of the interface driver to unregister
959 * Context: must be able to sleep
961 * Unlinks the specified driver from the internal USB driver list.
963 * NOTE: If you called usb_register_dev(), you still need to call
964 * usb_deregister_dev() to clean up your driver's allocated minor numbers,
965 * this * call will no longer do it for you.
967 void usb_deregister(struct usb_driver
*driver
)
969 pr_info("%s: deregistering interface driver %s\n",
970 usbcore_name
, driver
->name
);
972 usb_remove_newid_files(driver
);
973 driver_unregister(&driver
->drvwrap
.driver
);
974 usb_free_dynids(driver
);
976 EXPORT_SYMBOL_GPL(usb_deregister
);
978 /* Forced unbinding of a USB interface driver, either because
979 * it doesn't support pre_reset/post_reset/reset_resume or
980 * because it doesn't support suspend/resume.
982 * The caller must hold @intf's device's lock, but not its pm_mutex
983 * and not @intf->dev.sem.
985 void usb_forced_unbind_intf(struct usb_interface
*intf
)
987 struct usb_driver
*driver
= to_usb_driver(intf
->dev
.driver
);
989 dev_dbg(&intf
->dev
, "forced unbind\n");
990 usb_driver_release_interface(driver
, intf
);
992 /* Mark the interface for later rebinding */
993 intf
->needs_binding
= 1;
996 /* Delayed forced unbinding of a USB interface driver and scan
999 * The caller must hold @intf's device's lock, but not its pm_mutex
1000 * and not @intf->dev.sem.
1002 * Note: Rebinds will be skipped if a system sleep transition is in
1003 * progress and the PM "complete" callback hasn't occurred yet.
1005 void usb_rebind_intf(struct usb_interface
*intf
)
1009 /* Delayed unbind of an existing driver */
1010 if (intf
->dev
.driver
)
1011 usb_forced_unbind_intf(intf
);
1013 /* Try to rebind the interface */
1014 if (!intf
->dev
.power
.is_prepared
) {
1015 intf
->needs_binding
= 0;
1016 rc
= device_attach(&intf
->dev
);
1018 dev_warn(&intf
->dev
, "rebind failed: %d\n", rc
);
1024 /* Unbind drivers for @udev's interfaces that don't support suspend/resume
1025 * There is no check for reset_resume here because it can be determined
1026 * only during resume whether reset_resume is needed.
1028 * The caller must hold @udev's device lock.
1030 static void unbind_no_pm_drivers_interfaces(struct usb_device
*udev
)
1032 struct usb_host_config
*config
;
1034 struct usb_interface
*intf
;
1035 struct usb_driver
*drv
;
1037 config
= udev
->actconfig
;
1039 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
1040 intf
= config
->interface
[i
];
1042 if (intf
->dev
.driver
) {
1043 drv
= to_usb_driver(intf
->dev
.driver
);
1044 if (!drv
->suspend
|| !drv
->resume
)
1045 usb_forced_unbind_intf(intf
);
1051 /* Unbind drivers for @udev's interfaces that failed to support reset-resume.
1052 * These interfaces have the needs_binding flag set by usb_resume_interface().
1054 * The caller must hold @udev's device lock.
1056 static void unbind_no_reset_resume_drivers_interfaces(struct usb_device
*udev
)
1058 struct usb_host_config
*config
;
1060 struct usb_interface
*intf
;
1062 config
= udev
->actconfig
;
1064 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
1065 intf
= config
->interface
[i
];
1066 if (intf
->dev
.driver
&& intf
->needs_binding
)
1067 usb_forced_unbind_intf(intf
);
1072 static void do_rebind_interfaces(struct usb_device
*udev
)
1074 struct usb_host_config
*config
;
1076 struct usb_interface
*intf
;
1078 config
= udev
->actconfig
;
1080 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
1081 intf
= config
->interface
[i
];
1082 if (intf
->needs_binding
)
1083 usb_rebind_intf(intf
);
1088 static int usb_suspend_device(struct usb_device
*udev
, pm_message_t msg
)
1090 struct usb_device_driver
*udriver
;
1093 if (udev
->state
== USB_STATE_NOTATTACHED
||
1094 udev
->state
== USB_STATE_SUSPENDED
)
1097 /* For devices that don't have a driver, we do a generic suspend. */
1098 if (udev
->dev
.driver
)
1099 udriver
= to_usb_device_driver(udev
->dev
.driver
);
1101 udev
->do_remote_wakeup
= 0;
1102 udriver
= &usb_generic_driver
;
1104 status
= udriver
->suspend(udev
, msg
);
1107 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1111 static int usb_resume_device(struct usb_device
*udev
, pm_message_t msg
)
1113 struct usb_device_driver
*udriver
;
1116 if (udev
->state
== USB_STATE_NOTATTACHED
)
1119 /* Can't resume it if it doesn't have a driver. */
1120 if (udev
->dev
.driver
== NULL
) {
1125 /* Non-root devices on a full/low-speed bus must wait for their
1126 * companion high-speed root hub, in case a handoff is needed.
1128 if (!PMSG_IS_AUTO(msg
) && udev
->parent
&& udev
->bus
->hs_companion
)
1129 device_pm_wait_for_dev(&udev
->dev
,
1130 &udev
->bus
->hs_companion
->root_hub
->dev
);
1132 if (udev
->quirks
& USB_QUIRK_RESET_RESUME
)
1133 udev
->reset_resume
= 1;
1135 udriver
= to_usb_device_driver(udev
->dev
.driver
);
1136 status
= udriver
->resume(udev
, msg
);
1139 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1143 static int usb_suspend_interface(struct usb_device
*udev
,
1144 struct usb_interface
*intf
, pm_message_t msg
)
1146 struct usb_driver
*driver
;
1149 if (udev
->state
== USB_STATE_NOTATTACHED
||
1150 intf
->condition
== USB_INTERFACE_UNBOUND
)
1152 driver
= to_usb_driver(intf
->dev
.driver
);
1154 /* at this time we know the driver supports suspend */
1155 status
= driver
->suspend(intf
, msg
);
1156 if (status
&& !PMSG_IS_AUTO(msg
))
1157 dev_err(&intf
->dev
, "suspend error %d\n", status
);
1160 dev_vdbg(&intf
->dev
, "%s: status %d\n", __func__
, status
);
1164 static int usb_resume_interface(struct usb_device
*udev
,
1165 struct usb_interface
*intf
, pm_message_t msg
, int reset_resume
)
1167 struct usb_driver
*driver
;
1170 if (udev
->state
== USB_STATE_NOTATTACHED
)
1173 /* Don't let autoresume interfere with unbinding */
1174 if (intf
->condition
== USB_INTERFACE_UNBINDING
)
1177 /* Can't resume it if it doesn't have a driver. */
1178 if (intf
->condition
== USB_INTERFACE_UNBOUND
) {
1180 /* Carry out a deferred switch to altsetting 0 */
1181 if (intf
->needs_altsetting0
&& !intf
->dev
.power
.is_prepared
) {
1182 usb_set_interface(udev
, intf
->altsetting
[0].
1183 desc
.bInterfaceNumber
, 0);
1184 intf
->needs_altsetting0
= 0;
1189 /* Don't resume if the interface is marked for rebinding */
1190 if (intf
->needs_binding
)
1192 driver
= to_usb_driver(intf
->dev
.driver
);
1195 if (driver
->reset_resume
) {
1196 status
= driver
->reset_resume(intf
);
1198 dev_err(&intf
->dev
, "%s error %d\n",
1199 "reset_resume", status
);
1201 intf
->needs_binding
= 1;
1202 dev_warn(&intf
->dev
, "no %s for driver %s?\n",
1203 "reset_resume", driver
->name
);
1206 status
= driver
->resume(intf
);
1208 dev_err(&intf
->dev
, "resume error %d\n", status
);
1212 dev_vdbg(&intf
->dev
, "%s: status %d\n", __func__
, status
);
1214 /* Later we will unbind the driver and/or reprobe, if necessary */
1219 * usb_suspend_both - suspend a USB device and its interfaces
1220 * @udev: the usb_device to suspend
1221 * @msg: Power Management message describing this state transition
1223 * This is the central routine for suspending USB devices. It calls the
1224 * suspend methods for all the interface drivers in @udev and then calls
1225 * the suspend method for @udev itself. If an error occurs at any stage,
1226 * all the interfaces which were suspended are resumed so that they remain
1227 * in the same state as the device.
1229 * Autosuspend requests originating from a child device or an interface
1230 * driver may be made without the protection of @udev's device lock, but
1231 * all other suspend calls will hold the lock. Usbcore will insure that
1232 * method calls do not arrive during bind, unbind, or reset operations.
1233 * However drivers must be prepared to handle suspend calls arriving at
1234 * unpredictable times.
1236 * This routine can run only in process context.
1238 static int usb_suspend_both(struct usb_device
*udev
, pm_message_t msg
)
1242 struct usb_interface
*intf
;
1244 if (udev
->state
== USB_STATE_NOTATTACHED
||
1245 udev
->state
== USB_STATE_SUSPENDED
)
1248 /* Suspend all the interfaces and then udev itself */
1249 if (udev
->actconfig
) {
1250 n
= udev
->actconfig
->desc
.bNumInterfaces
;
1251 for (i
= n
- 1; i
>= 0; --i
) {
1252 intf
= udev
->actconfig
->interface
[i
];
1253 status
= usb_suspend_interface(udev
, intf
, msg
);
1255 /* Ignore errors during system sleep transitions */
1256 if (!PMSG_IS_AUTO(msg
))
1263 status
= usb_suspend_device(udev
, msg
);
1266 * Ignore errors from non-root-hub devices during
1267 * system sleep transitions. For the most part,
1268 * these devices should go to low power anyway when
1269 * the entire bus is suspended.
1271 if (udev
->parent
&& !PMSG_IS_AUTO(msg
))
1275 /* If the suspend failed, resume interfaces that did get suspended */
1277 msg
.event
^= (PM_EVENT_SUSPEND
| PM_EVENT_RESUME
);
1279 intf
= udev
->actconfig
->interface
[i
];
1280 usb_resume_interface(udev
, intf
, msg
, 0);
1283 /* If the suspend succeeded then prevent any more URB submissions
1284 * and flush any outstanding URBs.
1287 udev
->can_submit
= 0;
1288 for (i
= 0; i
< 16; ++i
) {
1289 usb_hcd_flush_endpoint(udev
, udev
->ep_out
[i
]);
1290 usb_hcd_flush_endpoint(udev
, udev
->ep_in
[i
]);
1295 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1300 * usb_resume_both - resume a USB device and its interfaces
1301 * @udev: the usb_device to resume
1302 * @msg: Power Management message describing this state transition
1304 * This is the central routine for resuming USB devices. It calls the
1305 * the resume method for @udev and then calls the resume methods for all
1306 * the interface drivers in @udev.
1308 * Autoresume requests originating from a child device or an interface
1309 * driver may be made without the protection of @udev's device lock, but
1310 * all other resume calls will hold the lock. Usbcore will insure that
1311 * method calls do not arrive during bind, unbind, or reset operations.
1312 * However drivers must be prepared to handle resume calls arriving at
1313 * unpredictable times.
1315 * This routine can run only in process context.
1317 static int usb_resume_both(struct usb_device
*udev
, pm_message_t msg
)
1321 struct usb_interface
*intf
;
1323 if (udev
->state
== USB_STATE_NOTATTACHED
) {
1327 udev
->can_submit
= 1;
1329 /* Resume the device */
1330 if (udev
->state
== USB_STATE_SUSPENDED
|| udev
->reset_resume
)
1331 status
= usb_resume_device(udev
, msg
);
1333 /* Resume the interfaces */
1334 if (status
== 0 && udev
->actconfig
) {
1335 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
1336 intf
= udev
->actconfig
->interface
[i
];
1337 usb_resume_interface(udev
, intf
, msg
,
1338 udev
->reset_resume
);
1341 usb_mark_last_busy(udev
);
1344 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1346 udev
->reset_resume
= 0;
1350 static void choose_wakeup(struct usb_device
*udev
, pm_message_t msg
)
1354 /* Remote wakeup is needed only when we actually go to sleep.
1355 * For things like FREEZE and QUIESCE, if the device is already
1356 * autosuspended then its current wakeup setting is okay.
1358 if (msg
.event
== PM_EVENT_FREEZE
|| msg
.event
== PM_EVENT_QUIESCE
) {
1359 if (udev
->state
!= USB_STATE_SUSPENDED
)
1360 udev
->do_remote_wakeup
= 0;
1364 /* Enable remote wakeup if it is allowed, even if no interface drivers
1367 w
= device_may_wakeup(&udev
->dev
);
1369 /* If the device is autosuspended with the wrong wakeup setting,
1370 * autoresume now so the setting can be changed.
1372 if (udev
->state
== USB_STATE_SUSPENDED
&& w
!= udev
->do_remote_wakeup
)
1373 pm_runtime_resume(&udev
->dev
);
1374 udev
->do_remote_wakeup
= w
;
1377 /* The device lock is held by the PM core */
1378 int usb_suspend(struct device
*dev
, pm_message_t msg
)
1380 struct usb_device
*udev
= to_usb_device(dev
);
1382 unbind_no_pm_drivers_interfaces(udev
);
1384 /* From now on we are sure all drivers support suspend/resume
1385 * but not necessarily reset_resume()
1386 * so we may still need to unbind and rebind upon resume
1388 choose_wakeup(udev
, msg
);
1389 return usb_suspend_both(udev
, msg
);
1392 /* The device lock is held by the PM core */
1393 int usb_resume_complete(struct device
*dev
)
1395 struct usb_device
*udev
= to_usb_device(dev
);
1397 /* For PM complete calls, all we do is rebind interfaces
1398 * whose needs_binding flag is set
1400 if (udev
->state
!= USB_STATE_NOTATTACHED
)
1401 do_rebind_interfaces(udev
);
1405 /* The device lock is held by the PM core */
1406 int usb_resume(struct device
*dev
, pm_message_t msg
)
1408 struct usb_device
*udev
= to_usb_device(dev
);
1411 /* For all calls, take the device back to full power and
1412 * tell the PM core in case it was autosuspended previously.
1413 * Unbind the interfaces that will need rebinding later,
1414 * because they fail to support reset_resume.
1415 * (This can't be done in usb_resume_interface()
1416 * above because it doesn't own the right set of locks.)
1418 status
= usb_resume_both(udev
, msg
);
1420 pm_runtime_disable(dev
);
1421 pm_runtime_set_active(dev
);
1422 pm_runtime_enable(dev
);
1423 unbind_no_reset_resume_drivers_interfaces(udev
);
1426 /* Avoid PM error messages for devices disconnected while suspended
1427 * as we'll display regular disconnect messages just a bit later.
1429 if (status
== -ENODEV
|| status
== -ESHUTDOWN
)
1434 #endif /* CONFIG_PM */
1436 #ifdef CONFIG_USB_SUSPEND
1439 * usb_enable_autosuspend - allow a USB device to be autosuspended
1440 * @udev: the USB device which may be autosuspended
1442 * This routine allows @udev to be autosuspended. An autosuspend won't
1443 * take place until the autosuspend_delay has elapsed and all the other
1444 * necessary conditions are satisfied.
1446 * The caller must hold @udev's device lock.
1448 void usb_enable_autosuspend(struct usb_device
*udev
)
1450 pm_runtime_allow(&udev
->dev
);
1452 EXPORT_SYMBOL_GPL(usb_enable_autosuspend
);
1455 * usb_disable_autosuspend - prevent a USB device from being autosuspended
1456 * @udev: the USB device which may not be autosuspended
1458 * This routine prevents @udev from being autosuspended and wakes it up
1459 * if it is already autosuspended.
1461 * The caller must hold @udev's device lock.
1463 void usb_disable_autosuspend(struct usb_device
*udev
)
1465 pm_runtime_forbid(&udev
->dev
);
1467 EXPORT_SYMBOL_GPL(usb_disable_autosuspend
);
1470 * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
1471 * @udev: the usb_device to autosuspend
1473 * This routine should be called when a core subsystem is finished using
1474 * @udev and wants to allow it to autosuspend. Examples would be when
1475 * @udev's device file in usbfs is closed or after a configuration change.
1477 * @udev's usage counter is decremented; if it drops to 0 and all the
1478 * interfaces are inactive then a delayed autosuspend will be attempted.
1479 * The attempt may fail (see autosuspend_check()).
1481 * The caller must hold @udev's device lock.
1483 * This routine can run only in process context.
1485 void usb_autosuspend_device(struct usb_device
*udev
)
1489 usb_mark_last_busy(udev
);
1490 status
= pm_runtime_put_sync_autosuspend(&udev
->dev
);
1491 dev_vdbg(&udev
->dev
, "%s: cnt %d -> %d\n",
1492 __func__
, atomic_read(&udev
->dev
.power
.usage_count
),
1497 * usb_autoresume_device - immediately autoresume a USB device and its interfaces
1498 * @udev: the usb_device to autoresume
1500 * This routine should be called when a core subsystem wants to use @udev
1501 * and needs to guarantee that it is not suspended. No autosuspend will
1502 * occur until usb_autosuspend_device() is called. (Note that this will
1503 * not prevent suspend events originating in the PM core.) Examples would
1504 * be when @udev's device file in usbfs is opened or when a remote-wakeup
1505 * request is received.
1507 * @udev's usage counter is incremented to prevent subsequent autosuspends.
1508 * However if the autoresume fails then the usage counter is re-decremented.
1510 * The caller must hold @udev's device lock.
1512 * This routine can run only in process context.
1514 int usb_autoresume_device(struct usb_device
*udev
)
1518 status
= pm_runtime_get_sync(&udev
->dev
);
1520 pm_runtime_put_sync(&udev
->dev
);
1521 dev_vdbg(&udev
->dev
, "%s: cnt %d -> %d\n",
1522 __func__
, atomic_read(&udev
->dev
.power
.usage_count
),
1530 * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
1531 * @intf: the usb_interface whose counter should be decremented
1533 * This routine should be called by an interface driver when it is
1534 * finished using @intf and wants to allow it to autosuspend. A typical
1535 * example would be a character-device driver when its device file is
1538 * The routine decrements @intf's usage counter. When the counter reaches
1539 * 0, a delayed autosuspend request for @intf's device is attempted. The
1540 * attempt may fail (see autosuspend_check()).
1542 * This routine can run only in process context.
1544 void usb_autopm_put_interface(struct usb_interface
*intf
)
1546 struct usb_device
*udev
= interface_to_usbdev(intf
);
1549 usb_mark_last_busy(udev
);
1550 atomic_dec(&intf
->pm_usage_cnt
);
1551 status
= pm_runtime_put_sync(&intf
->dev
);
1552 dev_vdbg(&intf
->dev
, "%s: cnt %d -> %d\n",
1553 __func__
, atomic_read(&intf
->dev
.power
.usage_count
),
1556 EXPORT_SYMBOL_GPL(usb_autopm_put_interface
);
1559 * usb_autopm_put_interface_async - decrement a USB interface's PM-usage counter
1560 * @intf: the usb_interface whose counter should be decremented
1562 * This routine does much the same thing as usb_autopm_put_interface():
1563 * It decrements @intf's usage counter and schedules a delayed
1564 * autosuspend request if the counter is <= 0. The difference is that it
1565 * does not perform any synchronization; callers should hold a private
1566 * lock and handle all synchronization issues themselves.
1568 * Typically a driver would call this routine during an URB's completion
1569 * handler, if no more URBs were pending.
1571 * This routine can run in atomic context.
1573 void usb_autopm_put_interface_async(struct usb_interface
*intf
)
1575 struct usb_device
*udev
= interface_to_usbdev(intf
);
1578 usb_mark_last_busy(udev
);
1579 atomic_dec(&intf
->pm_usage_cnt
);
1580 status
= pm_runtime_put(&intf
->dev
);
1581 dev_vdbg(&intf
->dev
, "%s: cnt %d -> %d\n",
1582 __func__
, atomic_read(&intf
->dev
.power
.usage_count
),
1585 EXPORT_SYMBOL_GPL(usb_autopm_put_interface_async
);
1588 * usb_autopm_put_interface_no_suspend - decrement a USB interface's PM-usage counter
1589 * @intf: the usb_interface whose counter should be decremented
1591 * This routine decrements @intf's usage counter but does not carry out an
1594 * This routine can run in atomic context.
1596 void usb_autopm_put_interface_no_suspend(struct usb_interface
*intf
)
1598 struct usb_device
*udev
= interface_to_usbdev(intf
);
1600 usb_mark_last_busy(udev
);
1601 atomic_dec(&intf
->pm_usage_cnt
);
1602 pm_runtime_put_noidle(&intf
->dev
);
1604 EXPORT_SYMBOL_GPL(usb_autopm_put_interface_no_suspend
);
1607 * usb_autopm_get_interface - increment a USB interface's PM-usage counter
1608 * @intf: the usb_interface whose counter should be incremented
1610 * This routine should be called by an interface driver when it wants to
1611 * use @intf and needs to guarantee that it is not suspended. In addition,
1612 * the routine prevents @intf from being autosuspended subsequently. (Note
1613 * that this will not prevent suspend events originating in the PM core.)
1614 * This prevention will persist until usb_autopm_put_interface() is called
1615 * or @intf is unbound. A typical example would be a character-device
1616 * driver when its device file is opened.
1618 * @intf's usage counter is incremented to prevent subsequent autosuspends.
1619 * However if the autoresume fails then the counter is re-decremented.
1621 * This routine can run only in process context.
1623 int usb_autopm_get_interface(struct usb_interface
*intf
)
1627 status
= pm_runtime_get_sync(&intf
->dev
);
1629 pm_runtime_put_sync(&intf
->dev
);
1631 atomic_inc(&intf
->pm_usage_cnt
);
1632 dev_vdbg(&intf
->dev
, "%s: cnt %d -> %d\n",
1633 __func__
, atomic_read(&intf
->dev
.power
.usage_count
),
1639 EXPORT_SYMBOL_GPL(usb_autopm_get_interface
);
1642 * usb_autopm_get_interface_async - increment a USB interface's PM-usage counter
1643 * @intf: the usb_interface whose counter should be incremented
1645 * This routine does much the same thing as
1646 * usb_autopm_get_interface(): It increments @intf's usage counter and
1647 * queues an autoresume request if the device is suspended. The
1648 * differences are that it does not perform any synchronization (callers
1649 * should hold a private lock and handle all synchronization issues
1650 * themselves), and it does not autoresume the device directly (it only
1651 * queues a request). After a successful call, the device may not yet be
1654 * This routine can run in atomic context.
1656 int usb_autopm_get_interface_async(struct usb_interface
*intf
)
1660 status
= pm_runtime_get(&intf
->dev
);
1661 if (status
< 0 && status
!= -EINPROGRESS
)
1662 pm_runtime_put_noidle(&intf
->dev
);
1664 atomic_inc(&intf
->pm_usage_cnt
);
1665 dev_vdbg(&intf
->dev
, "%s: cnt %d -> %d\n",
1666 __func__
, atomic_read(&intf
->dev
.power
.usage_count
),
1668 if (status
> 0 || status
== -EINPROGRESS
)
1672 EXPORT_SYMBOL_GPL(usb_autopm_get_interface_async
);
1675 * usb_autopm_get_interface_no_resume - increment a USB interface's PM-usage counter
1676 * @intf: the usb_interface whose counter should be incremented
1678 * This routine increments @intf's usage counter but does not carry out an
1681 * This routine can run in atomic context.
1683 void usb_autopm_get_interface_no_resume(struct usb_interface
*intf
)
1685 struct usb_device
*udev
= interface_to_usbdev(intf
);
1687 usb_mark_last_busy(udev
);
1688 atomic_inc(&intf
->pm_usage_cnt
);
1689 pm_runtime_get_noresume(&intf
->dev
);
1691 EXPORT_SYMBOL_GPL(usb_autopm_get_interface_no_resume
);
1693 /* Internal routine to check whether we may autosuspend a device. */
1694 static int autosuspend_check(struct usb_device
*udev
)
1697 struct usb_interface
*intf
;
1699 /* Fail if autosuspend is disabled, or any interfaces are in use, or
1700 * any interface drivers require remote wakeup but it isn't available.
1703 if (udev
->actconfig
) {
1704 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
1705 intf
= udev
->actconfig
->interface
[i
];
1707 /* We don't need to check interfaces that are
1708 * disabled for runtime PM. Either they are unbound
1709 * or else their drivers don't support autosuspend
1710 * and so they are permanently active.
1712 if (intf
->dev
.power
.disable_depth
)
1714 if (atomic_read(&intf
->dev
.power
.usage_count
) > 0)
1716 w
|= intf
->needs_remote_wakeup
;
1718 /* Don't allow autosuspend if the device will need
1719 * a reset-resume and any of its interface drivers
1720 * doesn't include support or needs remote wakeup.
1722 if (udev
->quirks
& USB_QUIRK_RESET_RESUME
) {
1723 struct usb_driver
*driver
;
1725 driver
= to_usb_driver(intf
->dev
.driver
);
1726 if (!driver
->reset_resume
||
1727 intf
->needs_remote_wakeup
)
1732 if (w
&& !device_can_wakeup(&udev
->dev
)) {
1733 dev_dbg(&udev
->dev
, "remote wakeup needed for autosuspend\n");
1736 udev
->do_remote_wakeup
= w
;
1740 int usb_runtime_suspend(struct device
*dev
)
1742 struct usb_device
*udev
= to_usb_device(dev
);
1745 /* A USB device can be suspended if it passes the various autosuspend
1746 * checks. Runtime suspend for a USB device means suspending all the
1747 * interfaces and then the device itself.
1749 if (autosuspend_check(udev
) != 0)
1752 status
= usb_suspend_both(udev
, PMSG_AUTO_SUSPEND
);
1754 /* Allow a retry if autosuspend failed temporarily */
1755 if (status
== -EAGAIN
|| status
== -EBUSY
)
1756 usb_mark_last_busy(udev
);
1758 /* The PM core reacts badly unless the return code is 0,
1759 * -EAGAIN, or -EBUSY, so always return -EBUSY on an error.
1766 int usb_runtime_resume(struct device
*dev
)
1768 struct usb_device
*udev
= to_usb_device(dev
);
1771 /* Runtime resume for a USB device means resuming both the device
1772 * and all its interfaces.
1774 status
= usb_resume_both(udev
, PMSG_AUTO_RESUME
);
1778 int usb_runtime_idle(struct device
*dev
)
1780 struct usb_device
*udev
= to_usb_device(dev
);
1782 /* An idle USB device can be suspended if it passes the various
1783 * autosuspend checks.
1785 if (autosuspend_check(udev
) == 0)
1786 pm_runtime_autosuspend(dev
);
1790 int usb_set_usb2_hardware_lpm(struct usb_device
*udev
, int enable
)
1792 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
1795 if (hcd
->driver
->set_usb2_hw_lpm
) {
1796 ret
= hcd
->driver
->set_usb2_hw_lpm(hcd
, udev
, enable
);
1798 udev
->usb2_hw_lpm_enabled
= enable
;
1804 #endif /* CONFIG_USB_SUSPEND */
1806 struct bus_type usb_bus_type
= {
1808 .match
= usb_device_match
,
1809 .uevent
= usb_uevent
,