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>
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
;
46 unsigned int bInterfaceClass
= 0;
50 fields
= sscanf(buf
, "%x %x %x", &idVendor
, &idProduct
,
55 dynid
= kzalloc(sizeof(*dynid
), GFP_KERNEL
);
59 INIT_LIST_HEAD(&dynid
->node
);
60 dynid
->id
.idVendor
= idVendor
;
61 dynid
->id
.idProduct
= idProduct
;
62 dynid
->id
.match_flags
= USB_DEVICE_ID_MATCH_DEVICE
;
64 dynid
->id
.bInterfaceClass
= (u8
)bInterfaceClass
;
65 dynid
->id
.match_flags
|= USB_DEVICE_ID_MATCH_INT_CLASS
;
68 spin_lock(&dynids
->lock
);
69 list_add_tail(&dynid
->node
, &dynids
->list
);
70 spin_unlock(&dynids
->lock
);
72 retval
= driver_attach(driver
);
78 EXPORT_SYMBOL_GPL(usb_store_new_id
);
80 ssize_t
usb_show_dynids(struct usb_dynids
*dynids
, char *buf
)
82 struct usb_dynid
*dynid
;
85 list_for_each_entry(dynid
, &dynids
->list
, node
)
86 if (dynid
->id
.bInterfaceClass
!= 0)
87 count
+= scnprintf(&buf
[count
], PAGE_SIZE
- count
, "%04x %04x %02x\n",
88 dynid
->id
.idVendor
, dynid
->id
.idProduct
,
89 dynid
->id
.bInterfaceClass
);
91 count
+= scnprintf(&buf
[count
], PAGE_SIZE
- count
, "%04x %04x\n",
92 dynid
->id
.idVendor
, dynid
->id
.idProduct
);
95 EXPORT_SYMBOL_GPL(usb_show_dynids
);
97 static ssize_t
show_dynids(struct device_driver
*driver
, char *buf
)
99 struct usb_driver
*usb_drv
= to_usb_driver(driver
);
101 return usb_show_dynids(&usb_drv
->dynids
, buf
);
104 static ssize_t
store_new_id(struct device_driver
*driver
,
105 const char *buf
, size_t count
)
107 struct usb_driver
*usb_drv
= to_usb_driver(driver
);
109 return usb_store_new_id(&usb_drv
->dynids
, driver
, buf
, count
);
111 static DRIVER_ATTR(new_id
, S_IRUGO
| S_IWUSR
, show_dynids
, store_new_id
);
114 * store_remove_id - remove a USB device ID from this driver
115 * @driver: target device driver
116 * @buf: buffer for scanning device ID data
119 * Removes a dynamic usb device ID from this driver.
122 store_remove_id(struct device_driver
*driver
, const char *buf
, size_t count
)
124 struct usb_dynid
*dynid
, *n
;
125 struct usb_driver
*usb_driver
= to_usb_driver(driver
);
130 fields
= sscanf(buf
, "%x %x", &idVendor
, &idProduct
);
134 spin_lock(&usb_driver
->dynids
.lock
);
135 list_for_each_entry_safe(dynid
, n
, &usb_driver
->dynids
.list
, node
) {
136 struct usb_device_id
*id
= &dynid
->id
;
137 if ((id
->idVendor
== idVendor
) &&
138 (id
->idProduct
== idProduct
)) {
139 list_del(&dynid
->node
);
144 spin_unlock(&usb_driver
->dynids
.lock
);
147 static DRIVER_ATTR(remove_id
, S_IRUGO
| S_IWUSR
, show_dynids
, store_remove_id
);
149 static int usb_create_newid_files(struct usb_driver
*usb_drv
)
153 if (usb_drv
->no_dynamic_id
)
156 if (usb_drv
->probe
!= NULL
) {
157 error
= driver_create_file(&usb_drv
->drvwrap
.driver
,
158 &driver_attr_new_id
);
160 error
= driver_create_file(&usb_drv
->drvwrap
.driver
,
161 &driver_attr_remove_id
);
163 driver_remove_file(&usb_drv
->drvwrap
.driver
,
164 &driver_attr_new_id
);
171 static void usb_remove_newid_files(struct usb_driver
*usb_drv
)
173 if (usb_drv
->no_dynamic_id
)
176 if (usb_drv
->probe
!= NULL
) {
177 driver_remove_file(&usb_drv
->drvwrap
.driver
,
178 &driver_attr_remove_id
);
179 driver_remove_file(&usb_drv
->drvwrap
.driver
,
180 &driver_attr_new_id
);
184 static void usb_free_dynids(struct usb_driver
*usb_drv
)
186 struct usb_dynid
*dynid
, *n
;
188 spin_lock(&usb_drv
->dynids
.lock
);
189 list_for_each_entry_safe(dynid
, n
, &usb_drv
->dynids
.list
, node
) {
190 list_del(&dynid
->node
);
193 spin_unlock(&usb_drv
->dynids
.lock
);
196 static const struct usb_device_id
*usb_match_dynamic_id(struct usb_interface
*intf
,
197 struct usb_driver
*drv
)
199 struct usb_dynid
*dynid
;
201 spin_lock(&drv
->dynids
.lock
);
202 list_for_each_entry(dynid
, &drv
->dynids
.list
, node
) {
203 if (usb_match_one_id(intf
, &dynid
->id
)) {
204 spin_unlock(&drv
->dynids
.lock
);
208 spin_unlock(&drv
->dynids
.lock
);
213 /* called from driver core with dev locked */
214 static int usb_probe_device(struct device
*dev
)
216 struct usb_device_driver
*udriver
= to_usb_device_driver(dev
->driver
);
217 struct usb_device
*udev
= to_usb_device(dev
);
220 dev_dbg(dev
, "%s\n", __func__
);
222 /* TODO: Add real matching code */
224 /* The device should always appear to be in use
225 * unless the driver supports autosuspend.
227 if (!udriver
->supports_autosuspend
)
228 error
= usb_autoresume_device(udev
);
231 error
= udriver
->probe(udev
);
235 /* called from driver core with dev locked */
236 static int usb_unbind_device(struct device
*dev
)
238 struct usb_device
*udev
= to_usb_device(dev
);
239 struct usb_device_driver
*udriver
= to_usb_device_driver(dev
->driver
);
241 udriver
->disconnect(udev
);
242 if (!udriver
->supports_autosuspend
)
243 usb_autosuspend_device(udev
);
248 * Cancel any pending scheduled resets
250 * [see usb_queue_reset_device()]
252 * Called after unconfiguring / when releasing interfaces. See
253 * comments in __usb_queue_reset_device() regarding
254 * udev->reset_running.
256 static void usb_cancel_queued_reset(struct usb_interface
*iface
)
258 if (iface
->reset_running
== 0)
259 cancel_work_sync(&iface
->reset_ws
);
262 /* called from driver core with dev locked */
263 static int usb_probe_interface(struct device
*dev
)
265 struct usb_driver
*driver
= to_usb_driver(dev
->driver
);
266 struct usb_interface
*intf
= to_usb_interface(dev
);
267 struct usb_device
*udev
= interface_to_usbdev(intf
);
268 const struct usb_device_id
*id
;
270 int lpm_disable_error
;
272 dev_dbg(dev
, "%s\n", __func__
);
274 intf
->needs_binding
= 0;
276 if (usb_device_is_owned(udev
))
279 if (udev
->authorized
== 0) {
280 dev_err(&intf
->dev
, "Device is not authorized for usage\n");
284 id
= usb_match_id(intf
, driver
->id_table
);
286 id
= usb_match_dynamic_id(intf
, driver
);
290 dev_dbg(dev
, "%s - got id\n", __func__
);
292 error
= usb_autoresume_device(udev
);
296 intf
->condition
= USB_INTERFACE_BINDING
;
298 /* Probed interfaces are initially active. They are
299 * runtime-PM-enabled only if the driver has autosuspend support.
300 * They are sensitive to their children's power states.
302 pm_runtime_set_active(dev
);
303 pm_suspend_ignore_children(dev
, false);
304 if (driver
->supports_autosuspend
)
305 pm_runtime_enable(dev
);
307 /* If the new driver doesn't allow hub-initiated LPM, and we can't
308 * disable hub-initiated LPM, then fail the probe.
310 * Otherwise, leaving LPM enabled should be harmless, because the
311 * endpoint intervals should remain the same, and the U1/U2 timeouts
312 * should remain the same.
314 * If we need to install alt setting 0 before probe, or another alt
315 * setting during probe, that should also be fine. usb_set_interface()
316 * will attempt to disable LPM, and fail if it can't disable it.
318 lpm_disable_error
= usb_unlocked_disable_lpm(udev
);
319 if (lpm_disable_error
&& driver
->disable_hub_initiated_lpm
) {
320 dev_err(&intf
->dev
, "%s Failed to disable LPM for driver %s\n.",
321 __func__
, driver
->name
);
322 error
= lpm_disable_error
;
326 /* Carry out a deferred switch to altsetting 0 */
327 if (intf
->needs_altsetting0
) {
328 error
= usb_set_interface(udev
, intf
->altsetting
[0].
329 desc
.bInterfaceNumber
, 0);
332 intf
->needs_altsetting0
= 0;
335 error
= driver
->probe(intf
, id
);
339 intf
->condition
= USB_INTERFACE_BOUND
;
341 /* If the LPM disable succeeded, balance the ref counts. */
342 if (!lpm_disable_error
)
343 usb_unlocked_enable_lpm(udev
);
345 usb_autosuspend_device(udev
);
349 usb_set_intfdata(intf
, NULL
);
350 intf
->needs_remote_wakeup
= 0;
351 intf
->condition
= USB_INTERFACE_UNBOUND
;
352 usb_cancel_queued_reset(intf
);
354 /* If the LPM disable succeeded, balance the ref counts. */
355 if (!lpm_disable_error
)
356 usb_unlocked_enable_lpm(udev
);
358 /* Unbound interfaces are always runtime-PM-disabled and -suspended */
359 if (driver
->supports_autosuspend
)
360 pm_runtime_disable(dev
);
361 pm_runtime_set_suspended(dev
);
363 usb_autosuspend_device(udev
);
367 /* called from driver core with dev locked */
368 static int usb_unbind_interface(struct device
*dev
)
370 struct usb_driver
*driver
= to_usb_driver(dev
->driver
);
371 struct usb_interface
*intf
= to_usb_interface(dev
);
372 struct usb_device
*udev
;
373 int error
, r
, lpm_disable_error
;
375 intf
->condition
= USB_INTERFACE_UNBINDING
;
377 /* Autoresume for set_interface call below */
378 udev
= interface_to_usbdev(intf
);
379 error
= usb_autoresume_device(udev
);
381 /* Hub-initiated LPM policy may change, so attempt to disable LPM until
382 * the driver is unbound. If LPM isn't disabled, that's fine because it
383 * wouldn't be enabled unless all the bound interfaces supported
386 lpm_disable_error
= usb_unlocked_disable_lpm(udev
);
388 /* Terminate all URBs for this interface unless the driver
389 * supports "soft" unbinding.
391 if (!driver
->soft_unbind
)
392 usb_disable_interface(udev
, intf
, false);
394 driver
->disconnect(intf
);
395 usb_cancel_queued_reset(intf
);
397 /* Reset other interface state.
398 * We cannot do a Set-Interface if the device is suspended or
399 * if it is prepared for a system sleep (since installing a new
400 * altsetting means creating new endpoint device entries).
401 * When either of these happens, defer the Set-Interface.
403 if (intf
->cur_altsetting
->desc
.bAlternateSetting
== 0) {
404 /* Already in altsetting 0 so skip Set-Interface.
405 * Just re-enable it without affecting the endpoint toggles.
407 usb_enable_interface(udev
, intf
, false);
408 } else if (!error
&& !intf
->dev
.power
.is_prepared
) {
409 r
= usb_set_interface(udev
, intf
->altsetting
[0].
410 desc
.bInterfaceNumber
, 0);
412 intf
->needs_altsetting0
= 1;
414 intf
->needs_altsetting0
= 1;
416 usb_set_intfdata(intf
, NULL
);
418 intf
->condition
= USB_INTERFACE_UNBOUND
;
419 intf
->needs_remote_wakeup
= 0;
421 /* Attempt to re-enable USB3 LPM, if the disable succeeded. */
422 if (!lpm_disable_error
)
423 usb_unlocked_enable_lpm(udev
);
425 /* Unbound interfaces are always runtime-PM-disabled and -suspended */
426 if (driver
->supports_autosuspend
)
427 pm_runtime_disable(dev
);
428 pm_runtime_set_suspended(dev
);
430 /* Undo any residual pm_autopm_get_interface_* calls */
431 for (r
= atomic_read(&intf
->pm_usage_cnt
); r
> 0; --r
)
432 usb_autopm_put_interface_no_suspend(intf
);
433 atomic_set(&intf
->pm_usage_cnt
, 0);
436 usb_autosuspend_device(udev
);
442 * usb_driver_claim_interface - bind a driver to an interface
443 * @driver: the driver to be bound
444 * @iface: the interface to which it will be bound; must be in the
445 * usb device's active configuration
446 * @priv: driver data associated with that interface
448 * This is used by usb device drivers that need to claim more than one
449 * interface on a device when probing (audio and acm are current examples).
450 * No device driver should directly modify internal usb_interface or
451 * usb_device structure members.
453 * Few drivers should need to use this routine, since the most natural
454 * way to bind to an interface is to return the private data from
455 * the driver's probe() method.
457 * Callers must own the device lock, so driver probe() entries don't need
458 * extra locking, but other call contexts may need to explicitly claim that
461 int usb_driver_claim_interface(struct usb_driver
*driver
,
462 struct usb_interface
*iface
, void *priv
)
464 struct device
*dev
= &iface
->dev
;
465 struct usb_device
*udev
;
467 int lpm_disable_error
;
472 udev
= interface_to_usbdev(iface
);
474 dev
->driver
= &driver
->drvwrap
.driver
;
475 usb_set_intfdata(iface
, priv
);
476 iface
->needs_binding
= 0;
478 iface
->condition
= USB_INTERFACE_BOUND
;
480 /* Disable LPM until this driver is bound. */
481 lpm_disable_error
= usb_unlocked_disable_lpm(udev
);
482 if (lpm_disable_error
&& driver
->disable_hub_initiated_lpm
) {
483 dev_err(&iface
->dev
, "%s Failed to disable LPM for driver %s\n.",
484 __func__
, driver
->name
);
488 /* Claimed interfaces are initially inactive (suspended) and
489 * runtime-PM-enabled, but only if the driver has autosuspend
490 * support. Otherwise they are marked active, to prevent the
491 * device from being autosuspended, but left disabled. In either
492 * case they are sensitive to their children's power states.
494 pm_suspend_ignore_children(dev
, false);
495 if (driver
->supports_autosuspend
)
496 pm_runtime_enable(dev
);
498 pm_runtime_set_active(dev
);
500 /* if interface was already added, bind now; else let
501 * the future device_add() bind it, bypassing probe()
503 if (device_is_registered(dev
))
504 retval
= device_bind_driver(dev
);
506 /* Attempt to re-enable USB3 LPM, if the disable was successful. */
507 if (!lpm_disable_error
)
508 usb_unlocked_enable_lpm(udev
);
512 EXPORT_SYMBOL_GPL(usb_driver_claim_interface
);
515 * usb_driver_release_interface - unbind a driver from an interface
516 * @driver: the driver to be unbound
517 * @iface: the interface from which it will be unbound
519 * This can be used by drivers to release an interface without waiting
520 * for their disconnect() methods to be called. In typical cases this
521 * also causes the driver disconnect() method to be called.
523 * This call is synchronous, and may not be used in an interrupt context.
524 * Callers must own the device lock, so driver disconnect() entries don't
525 * need extra locking, but other call contexts may need to explicitly claim
528 void usb_driver_release_interface(struct usb_driver
*driver
,
529 struct usb_interface
*iface
)
531 struct device
*dev
= &iface
->dev
;
533 /* this should never happen, don't release something that's not ours */
534 if (!dev
->driver
|| dev
->driver
!= &driver
->drvwrap
.driver
)
537 /* don't release from within disconnect() */
538 if (iface
->condition
!= USB_INTERFACE_BOUND
)
540 iface
->condition
= USB_INTERFACE_UNBINDING
;
542 /* Release via the driver core only if the interface
543 * has already been registered
545 if (device_is_registered(dev
)) {
546 device_release_driver(dev
);
549 usb_unbind_interface(dev
);
554 EXPORT_SYMBOL_GPL(usb_driver_release_interface
);
556 /* returns 0 if no match, 1 if match */
557 int usb_match_device(struct usb_device
*dev
, const struct usb_device_id
*id
)
559 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_VENDOR
) &&
560 id
->idVendor
!= le16_to_cpu(dev
->descriptor
.idVendor
))
563 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_PRODUCT
) &&
564 id
->idProduct
!= le16_to_cpu(dev
->descriptor
.idProduct
))
567 /* No need to test id->bcdDevice_lo != 0, since 0 is never
568 greater than any unsigned number. */
569 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_LO
) &&
570 (id
->bcdDevice_lo
> le16_to_cpu(dev
->descriptor
.bcdDevice
)))
573 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_HI
) &&
574 (id
->bcdDevice_hi
< le16_to_cpu(dev
->descriptor
.bcdDevice
)))
577 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_CLASS
) &&
578 (id
->bDeviceClass
!= dev
->descriptor
.bDeviceClass
))
581 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_SUBCLASS
) &&
582 (id
->bDeviceSubClass
!= dev
->descriptor
.bDeviceSubClass
))
585 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_PROTOCOL
) &&
586 (id
->bDeviceProtocol
!= dev
->descriptor
.bDeviceProtocol
))
592 /* returns 0 if no match, 1 if match */
593 int usb_match_one_id_intf(struct usb_device
*dev
,
594 struct usb_host_interface
*intf
,
595 const struct usb_device_id
*id
)
597 /* The interface class, subclass, protocol and number should never be
598 * checked for a match if the device class is Vendor Specific,
599 * unless the match record specifies the Vendor ID. */
600 if (dev
->descriptor
.bDeviceClass
== USB_CLASS_VENDOR_SPEC
&&
601 !(id
->match_flags
& USB_DEVICE_ID_MATCH_VENDOR
) &&
602 (id
->match_flags
& (USB_DEVICE_ID_MATCH_INT_CLASS
|
603 USB_DEVICE_ID_MATCH_INT_SUBCLASS
|
604 USB_DEVICE_ID_MATCH_INT_PROTOCOL
|
605 USB_DEVICE_ID_MATCH_INT_NUMBER
)))
608 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_CLASS
) &&
609 (id
->bInterfaceClass
!= intf
->desc
.bInterfaceClass
))
612 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_SUBCLASS
) &&
613 (id
->bInterfaceSubClass
!= intf
->desc
.bInterfaceSubClass
))
616 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_PROTOCOL
) &&
617 (id
->bInterfaceProtocol
!= intf
->desc
.bInterfaceProtocol
))
620 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_NUMBER
) &&
621 (id
->bInterfaceNumber
!= intf
->desc
.bInterfaceNumber
))
627 /* returns 0 if no match, 1 if match */
628 int usb_match_one_id(struct usb_interface
*interface
,
629 const struct usb_device_id
*id
)
631 struct usb_host_interface
*intf
;
632 struct usb_device
*dev
;
634 /* proc_connectinfo in devio.c may call us with id == NULL. */
638 intf
= interface
->cur_altsetting
;
639 dev
= interface_to_usbdev(interface
);
641 if (!usb_match_device(dev
, id
))
644 return usb_match_one_id_intf(dev
, intf
, id
);
646 EXPORT_SYMBOL_GPL(usb_match_one_id
);
649 * usb_match_id - find first usb_device_id matching device or interface
650 * @interface: the interface of interest
651 * @id: array of usb_device_id structures, terminated by zero entry
653 * usb_match_id searches an array of usb_device_id's and returns
654 * the first one matching the device or interface, or null.
655 * This is used when binding (or rebinding) a driver to an interface.
656 * Most USB device drivers will use this indirectly, through the usb core,
657 * but some layered driver frameworks use it directly.
658 * These device tables are exported with MODULE_DEVICE_TABLE, through
659 * modutils, to support the driver loading functionality of USB hotplugging.
663 * The "match_flags" element in a usb_device_id controls which
664 * members are used. If the corresponding bit is set, the
665 * value in the device_id must match its corresponding member
666 * in the device or interface descriptor, or else the device_id
669 * "driver_info" is normally used only by device drivers,
670 * but you can create a wildcard "matches anything" usb_device_id
671 * as a driver's "modules.usbmap" entry if you provide an id with
672 * only a nonzero "driver_info" field. If you do this, the USB device
673 * driver's probe() routine should use additional intelligence to
674 * decide whether to bind to the specified interface.
676 * What Makes Good usb_device_id Tables:
678 * The match algorithm is very simple, so that intelligence in
679 * driver selection must come from smart driver id records.
680 * Unless you have good reasons to use another selection policy,
681 * provide match elements only in related groups, and order match
682 * specifiers from specific to general. Use the macros provided
683 * for that purpose if you can.
685 * The most specific match specifiers use device descriptor
686 * data. These are commonly used with product-specific matches;
687 * the USB_DEVICE macro lets you provide vendor and product IDs,
688 * and you can also match against ranges of product revisions.
689 * These are widely used for devices with application or vendor
690 * specific bDeviceClass values.
692 * Matches based on device class/subclass/protocol specifications
693 * are slightly more general; use the USB_DEVICE_INFO macro, or
694 * its siblings. These are used with single-function devices
695 * where bDeviceClass doesn't specify that each interface has
698 * Matches based on interface class/subclass/protocol are the
699 * most general; they let drivers bind to any interface on a
700 * multiple-function device. Use the USB_INTERFACE_INFO
701 * macro, or its siblings, to match class-per-interface style
702 * devices (as recorded in bInterfaceClass).
704 * Note that an entry created by USB_INTERFACE_INFO won't match
705 * any interface if the device class is set to Vendor-Specific.
706 * This is deliberate; according to the USB spec the meanings of
707 * the interface class/subclass/protocol for these devices are also
708 * vendor-specific, and hence matching against a standard product
709 * class wouldn't work anyway. If you really want to use an
710 * interface-based match for such a device, create a match record
711 * that also specifies the vendor ID. (Unforunately there isn't a
712 * standard macro for creating records like this.)
714 * Within those groups, remember that not all combinations are
715 * meaningful. For example, don't give a product version range
716 * without vendor and product IDs; or specify a protocol without
717 * its associated class and subclass.
719 const struct usb_device_id
*usb_match_id(struct usb_interface
*interface
,
720 const struct usb_device_id
*id
)
722 /* proc_connectinfo in devio.c may call us with id == NULL. */
726 /* It is important to check that id->driver_info is nonzero,
727 since an entry that is all zeroes except for a nonzero
728 id->driver_info is the way to create an entry that
729 indicates that the driver want to examine every
730 device and interface. */
731 for (; id
->idVendor
|| id
->idProduct
|| id
->bDeviceClass
||
732 id
->bInterfaceClass
|| id
->driver_info
; id
++) {
733 if (usb_match_one_id(interface
, id
))
739 EXPORT_SYMBOL_GPL(usb_match_id
);
741 static int usb_device_match(struct device
*dev
, struct device_driver
*drv
)
743 /* devices and interfaces are handled separately */
744 if (is_usb_device(dev
)) {
746 /* interface drivers never match devices */
747 if (!is_usb_device_driver(drv
))
750 /* TODO: Add real matching code */
753 } else if (is_usb_interface(dev
)) {
754 struct usb_interface
*intf
;
755 struct usb_driver
*usb_drv
;
756 const struct usb_device_id
*id
;
758 /* device drivers never match interfaces */
759 if (is_usb_device_driver(drv
))
762 intf
= to_usb_interface(dev
);
763 usb_drv
= to_usb_driver(drv
);
765 id
= usb_match_id(intf
, usb_drv
->id_table
);
769 id
= usb_match_dynamic_id(intf
, usb_drv
);
777 static int usb_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
779 struct usb_device
*usb_dev
;
781 if (is_usb_device(dev
)) {
782 usb_dev
= to_usb_device(dev
);
783 } else if (is_usb_interface(dev
)) {
784 struct usb_interface
*intf
= to_usb_interface(dev
);
786 usb_dev
= interface_to_usbdev(intf
);
791 if (usb_dev
->devnum
< 0) {
792 /* driver is often null here; dev_dbg() would oops */
793 pr_debug("usb %s: already deleted?\n", dev_name(dev
));
797 pr_debug("usb %s: bus removed?\n", dev_name(dev
));
801 /* per-device configurations are common */
802 if (add_uevent_var(env
, "PRODUCT=%x/%x/%x",
803 le16_to_cpu(usb_dev
->descriptor
.idVendor
),
804 le16_to_cpu(usb_dev
->descriptor
.idProduct
),
805 le16_to_cpu(usb_dev
->descriptor
.bcdDevice
)))
808 /* class-based driver binding models */
809 if (add_uevent_var(env
, "TYPE=%d/%d/%d",
810 usb_dev
->descriptor
.bDeviceClass
,
811 usb_dev
->descriptor
.bDeviceSubClass
,
812 usb_dev
->descriptor
.bDeviceProtocol
))
819 * usb_register_device_driver - register a USB device (not interface) driver
820 * @new_udriver: USB operations for the device driver
821 * @owner: module owner of this driver.
823 * Registers a USB device driver with the USB core. The list of
824 * unattached devices will be rescanned whenever a new driver is
825 * added, allowing the new driver to attach to any recognized devices.
826 * Returns a negative error code on failure and 0 on success.
828 int usb_register_device_driver(struct usb_device_driver
*new_udriver
,
829 struct module
*owner
)
836 new_udriver
->drvwrap
.for_devices
= 1;
837 new_udriver
->drvwrap
.driver
.name
= (char *) new_udriver
->name
;
838 new_udriver
->drvwrap
.driver
.bus
= &usb_bus_type
;
839 new_udriver
->drvwrap
.driver
.probe
= usb_probe_device
;
840 new_udriver
->drvwrap
.driver
.remove
= usb_unbind_device
;
841 new_udriver
->drvwrap
.driver
.owner
= owner
;
843 retval
= driver_register(&new_udriver
->drvwrap
.driver
);
846 pr_info("%s: registered new device driver %s\n",
847 usbcore_name
, new_udriver
->name
);
849 printk(KERN_ERR
"%s: error %d registering device "
851 usbcore_name
, retval
, new_udriver
->name
);
855 EXPORT_SYMBOL_GPL(usb_register_device_driver
);
858 * usb_deregister_device_driver - unregister a USB device (not interface) driver
859 * @udriver: USB operations of the device driver to unregister
860 * Context: must be able to sleep
862 * Unlinks the specified driver from the internal USB driver list.
864 void usb_deregister_device_driver(struct usb_device_driver
*udriver
)
866 pr_info("%s: deregistering device driver %s\n",
867 usbcore_name
, udriver
->name
);
869 driver_unregister(&udriver
->drvwrap
.driver
);
871 EXPORT_SYMBOL_GPL(usb_deregister_device_driver
);
874 * usb_register_driver - register a USB interface driver
875 * @new_driver: USB operations for the interface driver
876 * @owner: module owner of this driver.
877 * @mod_name: module name string
879 * Registers a USB interface driver with the USB core. The list of
880 * unattached interfaces will be rescanned whenever a new driver is
881 * added, allowing the new driver to attach to any recognized interfaces.
882 * Returns a negative error code on failure and 0 on success.
884 * NOTE: if you want your driver to use the USB major number, you must call
885 * usb_register_dev() to enable that functionality. This function no longer
886 * takes care of that.
888 int usb_register_driver(struct usb_driver
*new_driver
, struct module
*owner
,
889 const char *mod_name
)
896 new_driver
->drvwrap
.for_devices
= 0;
897 new_driver
->drvwrap
.driver
.name
= (char *) new_driver
->name
;
898 new_driver
->drvwrap
.driver
.bus
= &usb_bus_type
;
899 new_driver
->drvwrap
.driver
.probe
= usb_probe_interface
;
900 new_driver
->drvwrap
.driver
.remove
= usb_unbind_interface
;
901 new_driver
->drvwrap
.driver
.owner
= owner
;
902 new_driver
->drvwrap
.driver
.mod_name
= mod_name
;
903 spin_lock_init(&new_driver
->dynids
.lock
);
904 INIT_LIST_HEAD(&new_driver
->dynids
.list
);
906 retval
= driver_register(&new_driver
->drvwrap
.driver
);
910 retval
= usb_create_newid_files(new_driver
);
914 pr_info("%s: registered new interface driver %s\n",
915 usbcore_name
, new_driver
->name
);
921 driver_unregister(&new_driver
->drvwrap
.driver
);
923 printk(KERN_ERR
"%s: error %d registering interface "
925 usbcore_name
, retval
, new_driver
->name
);
928 EXPORT_SYMBOL_GPL(usb_register_driver
);
931 * usb_deregister - unregister a USB interface driver
932 * @driver: USB operations of the interface driver to unregister
933 * Context: must be able to sleep
935 * Unlinks the specified driver from the internal USB driver list.
937 * NOTE: If you called usb_register_dev(), you still need to call
938 * usb_deregister_dev() to clean up your driver's allocated minor numbers,
939 * this * call will no longer do it for you.
941 void usb_deregister(struct usb_driver
*driver
)
943 pr_info("%s: deregistering interface driver %s\n",
944 usbcore_name
, driver
->name
);
946 usb_remove_newid_files(driver
);
947 driver_unregister(&driver
->drvwrap
.driver
);
948 usb_free_dynids(driver
);
950 EXPORT_SYMBOL_GPL(usb_deregister
);
952 /* Forced unbinding of a USB interface driver, either because
953 * it doesn't support pre_reset/post_reset/reset_resume or
954 * because it doesn't support suspend/resume.
956 * The caller must hold @intf's device's lock, but not its pm_mutex
957 * and not @intf->dev.sem.
959 void usb_forced_unbind_intf(struct usb_interface
*intf
)
961 struct usb_driver
*driver
= to_usb_driver(intf
->dev
.driver
);
963 dev_dbg(&intf
->dev
, "forced unbind\n");
964 usb_driver_release_interface(driver
, intf
);
966 /* Mark the interface for later rebinding */
967 intf
->needs_binding
= 1;
970 /* Delayed forced unbinding of a USB interface driver and scan
973 * The caller must hold @intf's device's lock, but not its pm_mutex
974 * and not @intf->dev.sem.
976 * Note: Rebinds will be skipped if a system sleep transition is in
977 * progress and the PM "complete" callback hasn't occurred yet.
979 void usb_rebind_intf(struct usb_interface
*intf
)
983 /* Delayed unbind of an existing driver */
984 if (intf
->dev
.driver
)
985 usb_forced_unbind_intf(intf
);
987 /* Try to rebind the interface */
988 if (!intf
->dev
.power
.is_prepared
) {
989 intf
->needs_binding
= 0;
990 rc
= device_attach(&intf
->dev
);
992 dev_warn(&intf
->dev
, "rebind failed: %d\n", rc
);
998 /* Unbind drivers for @udev's interfaces that don't support suspend/resume
999 * There is no check for reset_resume here because it can be determined
1000 * only during resume whether reset_resume is needed.
1002 * The caller must hold @udev's device lock.
1004 static void unbind_no_pm_drivers_interfaces(struct usb_device
*udev
)
1006 struct usb_host_config
*config
;
1008 struct usb_interface
*intf
;
1009 struct usb_driver
*drv
;
1011 config
= udev
->actconfig
;
1013 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
1014 intf
= config
->interface
[i
];
1016 if (intf
->dev
.driver
) {
1017 drv
= to_usb_driver(intf
->dev
.driver
);
1018 if (!drv
->suspend
|| !drv
->resume
)
1019 usb_forced_unbind_intf(intf
);
1025 /* Unbind drivers for @udev's interfaces that failed to support reset-resume.
1026 * These interfaces have the needs_binding flag set by usb_resume_interface().
1028 * The caller must hold @udev's device lock.
1030 static void unbind_no_reset_resume_drivers_interfaces(struct usb_device
*udev
)
1032 struct usb_host_config
*config
;
1034 struct usb_interface
*intf
;
1036 config
= udev
->actconfig
;
1038 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
1039 intf
= config
->interface
[i
];
1040 if (intf
->dev
.driver
&& intf
->needs_binding
)
1041 usb_forced_unbind_intf(intf
);
1046 static void do_rebind_interfaces(struct usb_device
*udev
)
1048 struct usb_host_config
*config
;
1050 struct usb_interface
*intf
;
1052 config
= udev
->actconfig
;
1054 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
1055 intf
= config
->interface
[i
];
1056 if (intf
->needs_binding
)
1057 usb_rebind_intf(intf
);
1062 static int usb_suspend_device(struct usb_device
*udev
, pm_message_t msg
)
1064 struct usb_device_driver
*udriver
;
1067 if (udev
->state
== USB_STATE_NOTATTACHED
||
1068 udev
->state
== USB_STATE_SUSPENDED
)
1071 /* For devices that don't have a driver, we do a generic suspend. */
1072 if (udev
->dev
.driver
)
1073 udriver
= to_usb_device_driver(udev
->dev
.driver
);
1075 udev
->do_remote_wakeup
= 0;
1076 udriver
= &usb_generic_driver
;
1078 status
= udriver
->suspend(udev
, msg
);
1081 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1085 static int usb_resume_device(struct usb_device
*udev
, pm_message_t msg
)
1087 struct usb_device_driver
*udriver
;
1090 if (udev
->state
== USB_STATE_NOTATTACHED
)
1093 /* Can't resume it if it doesn't have a driver. */
1094 if (udev
->dev
.driver
== NULL
) {
1099 /* Non-root devices on a full/low-speed bus must wait for their
1100 * companion high-speed root hub, in case a handoff is needed.
1102 if (!PMSG_IS_AUTO(msg
) && udev
->parent
&& udev
->bus
->hs_companion
)
1103 device_pm_wait_for_dev(&udev
->dev
,
1104 &udev
->bus
->hs_companion
->root_hub
->dev
);
1106 if (udev
->quirks
& USB_QUIRK_RESET_RESUME
)
1107 udev
->reset_resume
= 1;
1109 udriver
= to_usb_device_driver(udev
->dev
.driver
);
1110 status
= udriver
->resume(udev
, msg
);
1113 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1117 static int usb_suspend_interface(struct usb_device
*udev
,
1118 struct usb_interface
*intf
, pm_message_t msg
)
1120 struct usb_driver
*driver
;
1123 if (udev
->state
== USB_STATE_NOTATTACHED
||
1124 intf
->condition
== USB_INTERFACE_UNBOUND
)
1126 driver
= to_usb_driver(intf
->dev
.driver
);
1128 /* at this time we know the driver supports suspend */
1129 status
= driver
->suspend(intf
, msg
);
1130 if (status
&& !PMSG_IS_AUTO(msg
))
1131 dev_err(&intf
->dev
, "suspend error %d\n", status
);
1134 dev_vdbg(&intf
->dev
, "%s: status %d\n", __func__
, status
);
1138 static int usb_resume_interface(struct usb_device
*udev
,
1139 struct usb_interface
*intf
, pm_message_t msg
, int reset_resume
)
1141 struct usb_driver
*driver
;
1144 if (udev
->state
== USB_STATE_NOTATTACHED
)
1147 /* Don't let autoresume interfere with unbinding */
1148 if (intf
->condition
== USB_INTERFACE_UNBINDING
)
1151 /* Can't resume it if it doesn't have a driver. */
1152 if (intf
->condition
== USB_INTERFACE_UNBOUND
) {
1154 /* Carry out a deferred switch to altsetting 0 */
1155 if (intf
->needs_altsetting0
&& !intf
->dev
.power
.is_prepared
) {
1156 usb_set_interface(udev
, intf
->altsetting
[0].
1157 desc
.bInterfaceNumber
, 0);
1158 intf
->needs_altsetting0
= 0;
1163 /* Don't resume if the interface is marked for rebinding */
1164 if (intf
->needs_binding
)
1166 driver
= to_usb_driver(intf
->dev
.driver
);
1169 if (driver
->reset_resume
) {
1170 status
= driver
->reset_resume(intf
);
1172 dev_err(&intf
->dev
, "%s error %d\n",
1173 "reset_resume", status
);
1175 intf
->needs_binding
= 1;
1176 dev_warn(&intf
->dev
, "no %s for driver %s?\n",
1177 "reset_resume", driver
->name
);
1180 status
= driver
->resume(intf
);
1182 dev_err(&intf
->dev
, "resume error %d\n", status
);
1186 dev_vdbg(&intf
->dev
, "%s: status %d\n", __func__
, status
);
1188 /* Later we will unbind the driver and/or reprobe, if necessary */
1193 * usb_suspend_both - suspend a USB device and its interfaces
1194 * @udev: the usb_device to suspend
1195 * @msg: Power Management message describing this state transition
1197 * This is the central routine for suspending USB devices. It calls the
1198 * suspend methods for all the interface drivers in @udev and then calls
1199 * the suspend method for @udev itself. When the routine is called in
1200 * autosuspend, if an error occurs at any stage, all the interfaces
1201 * which were suspended are resumed so that they remain in the same
1202 * state as the device, but when called from system sleep, all error
1203 * from suspend methods of interfaces and the non-root-hub device itself
1204 * are simply ignored, so all suspended interfaces are only resumed
1205 * to the device's state when @udev is root-hub and its suspend method
1208 * Autosuspend requests originating from a child device or an interface
1209 * driver may be made without the protection of @udev's device lock, but
1210 * all other suspend calls will hold the lock. Usbcore will insure that
1211 * method calls do not arrive during bind, unbind, or reset operations.
1212 * However drivers must be prepared to handle suspend calls arriving at
1213 * unpredictable times.
1215 * This routine can run only in process context.
1217 static int usb_suspend_both(struct usb_device
*udev
, pm_message_t msg
)
1221 struct usb_interface
*intf
;
1223 if (udev
->state
== USB_STATE_NOTATTACHED
||
1224 udev
->state
== USB_STATE_SUSPENDED
)
1227 /* Suspend all the interfaces and then udev itself */
1228 if (udev
->actconfig
) {
1229 n
= udev
->actconfig
->desc
.bNumInterfaces
;
1230 for (i
= n
- 1; i
>= 0; --i
) {
1231 intf
= udev
->actconfig
->interface
[i
];
1232 status
= usb_suspend_interface(udev
, intf
, msg
);
1234 /* Ignore errors during system sleep transitions */
1235 if (!PMSG_IS_AUTO(msg
))
1242 status
= usb_suspend_device(udev
, msg
);
1245 * Ignore errors from non-root-hub devices during
1246 * system sleep transitions. For the most part,
1247 * these devices should go to low power anyway when
1248 * the entire bus is suspended.
1250 if (udev
->parent
&& !PMSG_IS_AUTO(msg
))
1254 /* If the suspend failed, resume interfaces that did get suspended */
1256 if (udev
->actconfig
) {
1257 msg
.event
^= (PM_EVENT_SUSPEND
| PM_EVENT_RESUME
);
1259 intf
= udev
->actconfig
->interface
[i
];
1260 usb_resume_interface(udev
, intf
, msg
, 0);
1264 /* If the suspend succeeded then prevent any more URB submissions
1265 * and flush any outstanding URBs.
1268 udev
->can_submit
= 0;
1269 for (i
= 0; i
< 16; ++i
) {
1270 usb_hcd_flush_endpoint(udev
, udev
->ep_out
[i
]);
1271 usb_hcd_flush_endpoint(udev
, udev
->ep_in
[i
]);
1276 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1281 * usb_resume_both - resume a USB device and its interfaces
1282 * @udev: the usb_device to resume
1283 * @msg: Power Management message describing this state transition
1285 * This is the central routine for resuming USB devices. It calls the
1286 * the resume method for @udev and then calls the resume methods for all
1287 * the interface drivers in @udev.
1289 * Autoresume requests originating from a child device or an interface
1290 * driver may be made without the protection of @udev's device lock, but
1291 * all other resume calls will hold the lock. Usbcore will insure that
1292 * method calls do not arrive during bind, unbind, or reset operations.
1293 * However drivers must be prepared to handle resume calls arriving at
1294 * unpredictable times.
1296 * This routine can run only in process context.
1298 static int usb_resume_both(struct usb_device
*udev
, pm_message_t msg
)
1302 struct usb_interface
*intf
;
1304 if (udev
->state
== USB_STATE_NOTATTACHED
) {
1308 udev
->can_submit
= 1;
1310 /* Resume the device */
1311 if (udev
->state
== USB_STATE_SUSPENDED
|| udev
->reset_resume
)
1312 status
= usb_resume_device(udev
, msg
);
1314 /* Resume the interfaces */
1315 if (status
== 0 && udev
->actconfig
) {
1316 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
1317 intf
= udev
->actconfig
->interface
[i
];
1318 usb_resume_interface(udev
, intf
, msg
,
1319 udev
->reset_resume
);
1322 usb_mark_last_busy(udev
);
1325 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1327 udev
->reset_resume
= 0;
1331 static void choose_wakeup(struct usb_device
*udev
, pm_message_t msg
)
1335 /* Remote wakeup is needed only when we actually go to sleep.
1336 * For things like FREEZE and QUIESCE, if the device is already
1337 * autosuspended then its current wakeup setting is okay.
1339 if (msg
.event
== PM_EVENT_FREEZE
|| msg
.event
== PM_EVENT_QUIESCE
) {
1340 if (udev
->state
!= USB_STATE_SUSPENDED
)
1341 udev
->do_remote_wakeup
= 0;
1345 /* Enable remote wakeup if it is allowed, even if no interface drivers
1348 w
= device_may_wakeup(&udev
->dev
);
1350 /* If the device is autosuspended with the wrong wakeup setting,
1351 * autoresume now so the setting can be changed.
1353 if (udev
->state
== USB_STATE_SUSPENDED
&& w
!= udev
->do_remote_wakeup
)
1354 pm_runtime_resume(&udev
->dev
);
1355 udev
->do_remote_wakeup
= w
;
1358 /* The device lock is held by the PM core */
1359 int usb_suspend(struct device
*dev
, pm_message_t msg
)
1361 struct usb_device
*udev
= to_usb_device(dev
);
1363 unbind_no_pm_drivers_interfaces(udev
);
1365 /* From now on we are sure all drivers support suspend/resume
1366 * but not necessarily reset_resume()
1367 * so we may still need to unbind and rebind upon resume
1369 choose_wakeup(udev
, msg
);
1370 return usb_suspend_both(udev
, msg
);
1373 /* The device lock is held by the PM core */
1374 int usb_resume_complete(struct device
*dev
)
1376 struct usb_device
*udev
= to_usb_device(dev
);
1378 /* For PM complete calls, all we do is rebind interfaces
1379 * whose needs_binding flag is set
1381 if (udev
->state
!= USB_STATE_NOTATTACHED
)
1382 do_rebind_interfaces(udev
);
1386 /* The device lock is held by the PM core */
1387 int usb_resume(struct device
*dev
, pm_message_t msg
)
1389 struct usb_device
*udev
= to_usb_device(dev
);
1392 /* For all calls, take the device back to full power and
1393 * tell the PM core in case it was autosuspended previously.
1394 * Unbind the interfaces that will need rebinding later,
1395 * because they fail to support reset_resume.
1396 * (This can't be done in usb_resume_interface()
1397 * above because it doesn't own the right set of locks.)
1399 status
= usb_resume_both(udev
, msg
);
1401 pm_runtime_disable(dev
);
1402 pm_runtime_set_active(dev
);
1403 pm_runtime_enable(dev
);
1404 unbind_no_reset_resume_drivers_interfaces(udev
);
1407 /* Avoid PM error messages for devices disconnected while suspended
1408 * as we'll display regular disconnect messages just a bit later.
1410 if (status
== -ENODEV
|| status
== -ESHUTDOWN
)
1415 #endif /* CONFIG_PM */
1417 #ifdef CONFIG_PM_RUNTIME
1420 * usb_enable_autosuspend - allow a USB device to be autosuspended
1421 * @udev: the USB device which may be autosuspended
1423 * This routine allows @udev to be autosuspended. An autosuspend won't
1424 * take place until the autosuspend_delay has elapsed and all the other
1425 * necessary conditions are satisfied.
1427 * The caller must hold @udev's device lock.
1429 void usb_enable_autosuspend(struct usb_device
*udev
)
1431 pm_runtime_allow(&udev
->dev
);
1433 EXPORT_SYMBOL_GPL(usb_enable_autosuspend
);
1436 * usb_disable_autosuspend - prevent a USB device from being autosuspended
1437 * @udev: the USB device which may not be autosuspended
1439 * This routine prevents @udev from being autosuspended and wakes it up
1440 * if it is already autosuspended.
1442 * The caller must hold @udev's device lock.
1444 void usb_disable_autosuspend(struct usb_device
*udev
)
1446 pm_runtime_forbid(&udev
->dev
);
1448 EXPORT_SYMBOL_GPL(usb_disable_autosuspend
);
1451 * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
1452 * @udev: the usb_device to autosuspend
1454 * This routine should be called when a core subsystem is finished using
1455 * @udev and wants to allow it to autosuspend. Examples would be when
1456 * @udev's device file in usbfs is closed or after a configuration change.
1458 * @udev's usage counter is decremented; if it drops to 0 and all the
1459 * interfaces are inactive then a delayed autosuspend will be attempted.
1460 * The attempt may fail (see autosuspend_check()).
1462 * The caller must hold @udev's device lock.
1464 * This routine can run only in process context.
1466 void usb_autosuspend_device(struct usb_device
*udev
)
1470 usb_mark_last_busy(udev
);
1471 status
= pm_runtime_put_sync_autosuspend(&udev
->dev
);
1472 dev_vdbg(&udev
->dev
, "%s: cnt %d -> %d\n",
1473 __func__
, atomic_read(&udev
->dev
.power
.usage_count
),
1478 * usb_autoresume_device - immediately autoresume a USB device and its interfaces
1479 * @udev: the usb_device to autoresume
1481 * This routine should be called when a core subsystem wants to use @udev
1482 * and needs to guarantee that it is not suspended. No autosuspend will
1483 * occur until usb_autosuspend_device() is called. (Note that this will
1484 * not prevent suspend events originating in the PM core.) Examples would
1485 * be when @udev's device file in usbfs is opened or when a remote-wakeup
1486 * request is received.
1488 * @udev's usage counter is incremented to prevent subsequent autosuspends.
1489 * However if the autoresume fails then the usage counter is re-decremented.
1491 * The caller must hold @udev's device lock.
1493 * This routine can run only in process context.
1495 int usb_autoresume_device(struct usb_device
*udev
)
1499 status
= pm_runtime_get_sync(&udev
->dev
);
1501 pm_runtime_put_sync(&udev
->dev
);
1502 dev_vdbg(&udev
->dev
, "%s: cnt %d -> %d\n",
1503 __func__
, atomic_read(&udev
->dev
.power
.usage_count
),
1511 * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
1512 * @intf: the usb_interface whose counter should be decremented
1514 * This routine should be called by an interface driver when it is
1515 * finished using @intf and wants to allow it to autosuspend. A typical
1516 * example would be a character-device driver when its device file is
1519 * The routine decrements @intf's usage counter. When the counter reaches
1520 * 0, a delayed autosuspend request for @intf's device is attempted. The
1521 * attempt may fail (see autosuspend_check()).
1523 * This routine can run only in process context.
1525 void usb_autopm_put_interface(struct usb_interface
*intf
)
1527 struct usb_device
*udev
= interface_to_usbdev(intf
);
1530 usb_mark_last_busy(udev
);
1531 atomic_dec(&intf
->pm_usage_cnt
);
1532 status
= pm_runtime_put_sync(&intf
->dev
);
1533 dev_vdbg(&intf
->dev
, "%s: cnt %d -> %d\n",
1534 __func__
, atomic_read(&intf
->dev
.power
.usage_count
),
1537 EXPORT_SYMBOL_GPL(usb_autopm_put_interface
);
1540 * usb_autopm_put_interface_async - decrement a USB interface's PM-usage counter
1541 * @intf: the usb_interface whose counter should be decremented
1543 * This routine does much the same thing as usb_autopm_put_interface():
1544 * It decrements @intf's usage counter and schedules a delayed
1545 * autosuspend request if the counter is <= 0. The difference is that it
1546 * does not perform any synchronization; callers should hold a private
1547 * lock and handle all synchronization issues themselves.
1549 * Typically a driver would call this routine during an URB's completion
1550 * handler, if no more URBs were pending.
1552 * This routine can run in atomic context.
1554 void usb_autopm_put_interface_async(struct usb_interface
*intf
)
1556 struct usb_device
*udev
= interface_to_usbdev(intf
);
1559 usb_mark_last_busy(udev
);
1560 atomic_dec(&intf
->pm_usage_cnt
);
1561 status
= pm_runtime_put(&intf
->dev
);
1562 dev_vdbg(&intf
->dev
, "%s: cnt %d -> %d\n",
1563 __func__
, atomic_read(&intf
->dev
.power
.usage_count
),
1566 EXPORT_SYMBOL_GPL(usb_autopm_put_interface_async
);
1569 * usb_autopm_put_interface_no_suspend - decrement a USB interface's PM-usage counter
1570 * @intf: the usb_interface whose counter should be decremented
1572 * This routine decrements @intf's usage counter but does not carry out an
1575 * This routine can run in atomic context.
1577 void usb_autopm_put_interface_no_suspend(struct usb_interface
*intf
)
1579 struct usb_device
*udev
= interface_to_usbdev(intf
);
1581 usb_mark_last_busy(udev
);
1582 atomic_dec(&intf
->pm_usage_cnt
);
1583 pm_runtime_put_noidle(&intf
->dev
);
1585 EXPORT_SYMBOL_GPL(usb_autopm_put_interface_no_suspend
);
1588 * usb_autopm_get_interface - increment a USB interface's PM-usage counter
1589 * @intf: the usb_interface whose counter should be incremented
1591 * This routine should be called by an interface driver when it wants to
1592 * use @intf and needs to guarantee that it is not suspended. In addition,
1593 * the routine prevents @intf from being autosuspended subsequently. (Note
1594 * that this will not prevent suspend events originating in the PM core.)
1595 * This prevention will persist until usb_autopm_put_interface() is called
1596 * or @intf is unbound. A typical example would be a character-device
1597 * driver when its device file is opened.
1599 * @intf's usage counter is incremented to prevent subsequent autosuspends.
1600 * However if the autoresume fails then the counter is re-decremented.
1602 * This routine can run only in process context.
1604 int usb_autopm_get_interface(struct usb_interface
*intf
)
1608 status
= pm_runtime_get_sync(&intf
->dev
);
1610 pm_runtime_put_sync(&intf
->dev
);
1612 atomic_inc(&intf
->pm_usage_cnt
);
1613 dev_vdbg(&intf
->dev
, "%s: cnt %d -> %d\n",
1614 __func__
, atomic_read(&intf
->dev
.power
.usage_count
),
1620 EXPORT_SYMBOL_GPL(usb_autopm_get_interface
);
1623 * usb_autopm_get_interface_async - increment a USB interface's PM-usage counter
1624 * @intf: the usb_interface whose counter should be incremented
1626 * This routine does much the same thing as
1627 * usb_autopm_get_interface(): It increments @intf's usage counter and
1628 * queues an autoresume request if the device is suspended. The
1629 * differences are that it does not perform any synchronization (callers
1630 * should hold a private lock and handle all synchronization issues
1631 * themselves), and it does not autoresume the device directly (it only
1632 * queues a request). After a successful call, the device may not yet be
1635 * This routine can run in atomic context.
1637 int usb_autopm_get_interface_async(struct usb_interface
*intf
)
1641 status
= pm_runtime_get(&intf
->dev
);
1642 if (status
< 0 && status
!= -EINPROGRESS
)
1643 pm_runtime_put_noidle(&intf
->dev
);
1645 atomic_inc(&intf
->pm_usage_cnt
);
1646 dev_vdbg(&intf
->dev
, "%s: cnt %d -> %d\n",
1647 __func__
, atomic_read(&intf
->dev
.power
.usage_count
),
1649 if (status
> 0 || status
== -EINPROGRESS
)
1653 EXPORT_SYMBOL_GPL(usb_autopm_get_interface_async
);
1656 * usb_autopm_get_interface_no_resume - increment a USB interface's PM-usage counter
1657 * @intf: the usb_interface whose counter should be incremented
1659 * This routine increments @intf's usage counter but does not carry out an
1662 * This routine can run in atomic context.
1664 void usb_autopm_get_interface_no_resume(struct usb_interface
*intf
)
1666 struct usb_device
*udev
= interface_to_usbdev(intf
);
1668 usb_mark_last_busy(udev
);
1669 atomic_inc(&intf
->pm_usage_cnt
);
1670 pm_runtime_get_noresume(&intf
->dev
);
1672 EXPORT_SYMBOL_GPL(usb_autopm_get_interface_no_resume
);
1674 /* Internal routine to check whether we may autosuspend a device. */
1675 static int autosuspend_check(struct usb_device
*udev
)
1678 struct usb_interface
*intf
;
1680 /* Fail if autosuspend is disabled, or any interfaces are in use, or
1681 * any interface drivers require remote wakeup but it isn't available.
1684 if (udev
->actconfig
) {
1685 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
1686 intf
= udev
->actconfig
->interface
[i
];
1688 /* We don't need to check interfaces that are
1689 * disabled for runtime PM. Either they are unbound
1690 * or else their drivers don't support autosuspend
1691 * and so they are permanently active.
1693 if (intf
->dev
.power
.disable_depth
)
1695 if (atomic_read(&intf
->dev
.power
.usage_count
) > 0)
1697 w
|= intf
->needs_remote_wakeup
;
1699 /* Don't allow autosuspend if the device will need
1700 * a reset-resume and any of its interface drivers
1701 * doesn't include support or needs remote wakeup.
1703 if (udev
->quirks
& USB_QUIRK_RESET_RESUME
) {
1704 struct usb_driver
*driver
;
1706 driver
= to_usb_driver(intf
->dev
.driver
);
1707 if (!driver
->reset_resume
||
1708 intf
->needs_remote_wakeup
)
1713 if (w
&& !device_can_wakeup(&udev
->dev
)) {
1714 dev_dbg(&udev
->dev
, "remote wakeup needed for autosuspend\n");
1717 udev
->do_remote_wakeup
= w
;
1721 int usb_runtime_suspend(struct device
*dev
)
1723 struct usb_device
*udev
= to_usb_device(dev
);
1726 /* A USB device can be suspended if it passes the various autosuspend
1727 * checks. Runtime suspend for a USB device means suspending all the
1728 * interfaces and then the device itself.
1730 if (autosuspend_check(udev
) != 0)
1733 status
= usb_suspend_both(udev
, PMSG_AUTO_SUSPEND
);
1735 /* Allow a retry if autosuspend failed temporarily */
1736 if (status
== -EAGAIN
|| status
== -EBUSY
)
1737 usb_mark_last_busy(udev
);
1739 /* The PM core reacts badly unless the return code is 0,
1740 * -EAGAIN, or -EBUSY, so always return -EBUSY on an error.
1747 int usb_runtime_resume(struct device
*dev
)
1749 struct usb_device
*udev
= to_usb_device(dev
);
1752 /* Runtime resume for a USB device means resuming both the device
1753 * and all its interfaces.
1755 status
= usb_resume_both(udev
, PMSG_AUTO_RESUME
);
1759 int usb_runtime_idle(struct device
*dev
)
1761 struct usb_device
*udev
= to_usb_device(dev
);
1763 /* An idle USB device can be suspended if it passes the various
1764 * autosuspend checks.
1766 if (autosuspend_check(udev
) == 0)
1767 pm_runtime_autosuspend(dev
);
1768 /* Tell the core not to suspend it, though. */
1772 int usb_set_usb2_hardware_lpm(struct usb_device
*udev
, int enable
)
1774 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
1777 if (hcd
->driver
->set_usb2_hw_lpm
) {
1778 ret
= hcd
->driver
->set_usb2_hw_lpm(hcd
, udev
, enable
);
1780 udev
->usb2_hw_lpm_enabled
= enable
;
1786 #endif /* CONFIG_PM_RUNTIME */
1788 struct bus_type usb_bus_type
= {
1790 .match
= usb_device_match
,
1791 .uevent
= usb_uevent
,