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 const struct usb_device_id
*id_table
,
41 struct device_driver
*driver
,
42 const char *buf
, size_t count
)
44 struct usb_dynid
*dynid
;
47 unsigned int bInterfaceClass
= 0;
48 u32 refVendor
, refProduct
;
52 fields
= sscanf(buf
, "%x %x %x %x %x", &idVendor
, &idProduct
,
53 &bInterfaceClass
, &refVendor
, &refProduct
);
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
;
65 if (fields
> 2 && bInterfaceClass
) {
66 if (bInterfaceClass
> 255) {
71 dynid
->id
.bInterfaceClass
= (u8
)bInterfaceClass
;
72 dynid
->id
.match_flags
|= USB_DEVICE_ID_MATCH_INT_CLASS
;
76 const struct usb_device_id
*id
= id_table
;
83 for (; id
->match_flags
; id
++)
84 if (id
->idVendor
== refVendor
&& id
->idProduct
== refProduct
)
87 if (id
->match_flags
) {
88 dynid
->id
.driver_info
= id
->driver_info
;
95 spin_lock(&dynids
->lock
);
96 list_add_tail(&dynid
->node
, &dynids
->list
);
97 spin_unlock(&dynids
->lock
);
99 retval
= driver_attach(driver
);
109 EXPORT_SYMBOL_GPL(usb_store_new_id
);
111 ssize_t
usb_show_dynids(struct usb_dynids
*dynids
, char *buf
)
113 struct usb_dynid
*dynid
;
116 list_for_each_entry(dynid
, &dynids
->list
, node
)
117 if (dynid
->id
.bInterfaceClass
!= 0)
118 count
+= scnprintf(&buf
[count
], PAGE_SIZE
- count
, "%04x %04x %02x\n",
119 dynid
->id
.idVendor
, dynid
->id
.idProduct
,
120 dynid
->id
.bInterfaceClass
);
122 count
+= scnprintf(&buf
[count
], PAGE_SIZE
- count
, "%04x %04x\n",
123 dynid
->id
.idVendor
, dynid
->id
.idProduct
);
126 EXPORT_SYMBOL_GPL(usb_show_dynids
);
128 static ssize_t
new_id_show(struct device_driver
*driver
, char *buf
)
130 struct usb_driver
*usb_drv
= to_usb_driver(driver
);
132 return usb_show_dynids(&usb_drv
->dynids
, buf
);
135 static ssize_t
new_id_store(struct device_driver
*driver
,
136 const char *buf
, size_t count
)
138 struct usb_driver
*usb_drv
= to_usb_driver(driver
);
140 return usb_store_new_id(&usb_drv
->dynids
, usb_drv
->id_table
, driver
, buf
, count
);
142 static DRIVER_ATTR_RW(new_id
);
145 * Remove a USB device ID from this driver
147 static ssize_t
remove_id_store(struct device_driver
*driver
, const char *buf
,
150 struct usb_dynid
*dynid
, *n
;
151 struct usb_driver
*usb_driver
= to_usb_driver(driver
);
156 fields
= sscanf(buf
, "%x %x", &idVendor
, &idProduct
);
160 spin_lock(&usb_driver
->dynids
.lock
);
161 list_for_each_entry_safe(dynid
, n
, &usb_driver
->dynids
.list
, node
) {
162 struct usb_device_id
*id
= &dynid
->id
;
164 if ((id
->idVendor
== idVendor
) &&
165 (id
->idProduct
== idProduct
)) {
166 list_del(&dynid
->node
);
171 spin_unlock(&usb_driver
->dynids
.lock
);
175 static ssize_t
remove_id_show(struct device_driver
*driver
, char *buf
)
177 return new_id_show(driver
, buf
);
179 static DRIVER_ATTR_RW(remove_id
);
181 static int usb_create_newid_files(struct usb_driver
*usb_drv
)
185 if (usb_drv
->no_dynamic_id
)
188 if (usb_drv
->probe
!= NULL
) {
189 error
= driver_create_file(&usb_drv
->drvwrap
.driver
,
190 &driver_attr_new_id
);
192 error
= driver_create_file(&usb_drv
->drvwrap
.driver
,
193 &driver_attr_remove_id
);
195 driver_remove_file(&usb_drv
->drvwrap
.driver
,
196 &driver_attr_new_id
);
203 static void usb_remove_newid_files(struct usb_driver
*usb_drv
)
205 if (usb_drv
->no_dynamic_id
)
208 if (usb_drv
->probe
!= NULL
) {
209 driver_remove_file(&usb_drv
->drvwrap
.driver
,
210 &driver_attr_remove_id
);
211 driver_remove_file(&usb_drv
->drvwrap
.driver
,
212 &driver_attr_new_id
);
216 static void usb_free_dynids(struct usb_driver
*usb_drv
)
218 struct usb_dynid
*dynid
, *n
;
220 spin_lock(&usb_drv
->dynids
.lock
);
221 list_for_each_entry_safe(dynid
, n
, &usb_drv
->dynids
.list
, node
) {
222 list_del(&dynid
->node
);
225 spin_unlock(&usb_drv
->dynids
.lock
);
228 static const struct usb_device_id
*usb_match_dynamic_id(struct usb_interface
*intf
,
229 struct usb_driver
*drv
)
231 struct usb_dynid
*dynid
;
233 spin_lock(&drv
->dynids
.lock
);
234 list_for_each_entry(dynid
, &drv
->dynids
.list
, node
) {
235 if (usb_match_one_id(intf
, &dynid
->id
)) {
236 spin_unlock(&drv
->dynids
.lock
);
240 spin_unlock(&drv
->dynids
.lock
);
245 /* called from driver core with dev locked */
246 static int usb_probe_device(struct device
*dev
)
248 struct usb_device_driver
*udriver
= to_usb_device_driver(dev
->driver
);
249 struct usb_device
*udev
= to_usb_device(dev
);
252 dev_dbg(dev
, "%s\n", __func__
);
254 /* TODO: Add real matching code */
256 /* The device should always appear to be in use
257 * unless the driver supports autosuspend.
259 if (!udriver
->supports_autosuspend
)
260 error
= usb_autoresume_device(udev
);
263 error
= udriver
->probe(udev
);
267 /* called from driver core with dev locked */
268 static int usb_unbind_device(struct device
*dev
)
270 struct usb_device
*udev
= to_usb_device(dev
);
271 struct usb_device_driver
*udriver
= to_usb_device_driver(dev
->driver
);
273 udriver
->disconnect(udev
);
274 if (!udriver
->supports_autosuspend
)
275 usb_autosuspend_device(udev
);
279 /* called from driver core with dev locked */
280 static int usb_probe_interface(struct device
*dev
)
282 struct usb_driver
*driver
= to_usb_driver(dev
->driver
);
283 struct usb_interface
*intf
= to_usb_interface(dev
);
284 struct usb_device
*udev
= interface_to_usbdev(intf
);
285 const struct usb_device_id
*id
;
287 int lpm_disable_error
;
289 dev_dbg(dev
, "%s\n", __func__
);
291 intf
->needs_binding
= 0;
293 if (usb_device_is_owned(udev
))
296 if (udev
->authorized
== 0) {
297 dev_err(&intf
->dev
, "Device is not authorized for usage\n");
299 } else if (intf
->authorized
== 0) {
300 dev_err(&intf
->dev
, "Interface %d is not authorized for usage\n",
301 intf
->altsetting
->desc
.bInterfaceNumber
);
305 id
= usb_match_dynamic_id(intf
, driver
);
307 id
= usb_match_id(intf
, driver
->id_table
);
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
;
374 /* If the LPM disable succeeded, balance the ref counts. */
375 if (!lpm_disable_error
)
376 usb_unlocked_enable_lpm(udev
);
378 /* Unbound interfaces are always runtime-PM-disabled and -suspended */
379 if (driver
->supports_autosuspend
)
380 pm_runtime_disable(dev
);
381 pm_runtime_set_suspended(dev
);
383 usb_autosuspend_device(udev
);
387 /* called from driver core with dev locked */
388 static int usb_unbind_interface(struct device
*dev
)
390 struct usb_driver
*driver
= to_usb_driver(dev
->driver
);
391 struct usb_interface
*intf
= to_usb_interface(dev
);
392 struct usb_host_endpoint
*ep
, **eps
= NULL
;
393 struct usb_device
*udev
;
394 int i
, j
, error
, r
, lpm_disable_error
;
396 intf
->condition
= USB_INTERFACE_UNBINDING
;
398 /* Autoresume for set_interface call below */
399 udev
= interface_to_usbdev(intf
);
400 error
= usb_autoresume_device(udev
);
402 /* Hub-initiated LPM policy may change, so attempt to disable LPM until
403 * the driver is unbound. If LPM isn't disabled, that's fine because it
404 * wouldn't be enabled unless all the bound interfaces supported
407 lpm_disable_error
= usb_unlocked_disable_lpm(udev
);
410 * Terminate all URBs for this interface unless the driver
411 * supports "soft" unbinding and the device is still present.
413 if (!driver
->soft_unbind
|| udev
->state
== USB_STATE_NOTATTACHED
)
414 usb_disable_interface(udev
, intf
, false);
416 driver
->disconnect(intf
);
419 for (i
= 0, j
= 0; i
< intf
->cur_altsetting
->desc
.bNumEndpoints
; i
++) {
420 ep
= &intf
->cur_altsetting
->endpoint
[i
];
421 if (ep
->streams
== 0)
424 eps
= kmalloc(USB_MAXENDPOINTS
* sizeof(void *),
427 dev_warn(dev
, "oom, leaking streams\n");
434 usb_free_streams(intf
, eps
, j
, GFP_KERNEL
);
438 /* Reset other interface state.
439 * We cannot do a Set-Interface if the device is suspended or
440 * if it is prepared for a system sleep (since installing a new
441 * altsetting means creating new endpoint device entries).
442 * When either of these happens, defer the Set-Interface.
444 if (intf
->cur_altsetting
->desc
.bAlternateSetting
== 0) {
445 /* Already in altsetting 0 so skip Set-Interface.
446 * Just re-enable it without affecting the endpoint toggles.
448 usb_enable_interface(udev
, intf
, false);
449 } else if (!error
&& !intf
->dev
.power
.is_prepared
) {
450 r
= usb_set_interface(udev
, intf
->altsetting
[0].
451 desc
.bInterfaceNumber
, 0);
453 intf
->needs_altsetting0
= 1;
455 intf
->needs_altsetting0
= 1;
457 usb_set_intfdata(intf
, NULL
);
459 intf
->condition
= USB_INTERFACE_UNBOUND
;
460 intf
->needs_remote_wakeup
= 0;
462 /* Attempt to re-enable USB3 LPM, if the disable succeeded. */
463 if (!lpm_disable_error
)
464 usb_unlocked_enable_lpm(udev
);
466 /* Unbound interfaces are always runtime-PM-disabled and -suspended */
467 if (driver
->supports_autosuspend
)
468 pm_runtime_disable(dev
);
469 pm_runtime_set_suspended(dev
);
471 /* Undo any residual pm_autopm_get_interface_* calls */
472 for (r
= atomic_read(&intf
->pm_usage_cnt
); r
> 0; --r
)
473 usb_autopm_put_interface_no_suspend(intf
);
474 atomic_set(&intf
->pm_usage_cnt
, 0);
477 usb_autosuspend_device(udev
);
483 * usb_driver_claim_interface - bind a driver to an interface
484 * @driver: the driver to be bound
485 * @iface: the interface to which it will be bound; must be in the
486 * usb device's active configuration
487 * @priv: driver data associated with that interface
489 * This is used by usb device drivers that need to claim more than one
490 * interface on a device when probing (audio and acm are current examples).
491 * No device driver should directly modify internal usb_interface or
492 * usb_device structure members.
494 * Few drivers should need to use this routine, since the most natural
495 * way to bind to an interface is to return the private data from
496 * the driver's probe() method.
498 * Callers must own the device lock, so driver probe() entries don't need
499 * extra locking, but other call contexts may need to explicitly claim that
502 * Return: 0 on success.
504 int usb_driver_claim_interface(struct usb_driver
*driver
,
505 struct usb_interface
*iface
, void *priv
)
507 struct device
*dev
= &iface
->dev
;
508 struct usb_device
*udev
;
510 int lpm_disable_error
;
515 /* reject claim if not iterface is not authorized */
516 if (!iface
->authorized
)
519 udev
= interface_to_usbdev(iface
);
521 dev
->driver
= &driver
->drvwrap
.driver
;
522 usb_set_intfdata(iface
, priv
);
523 iface
->needs_binding
= 0;
525 iface
->condition
= USB_INTERFACE_BOUND
;
527 /* Disable LPM until this driver is bound. */
528 lpm_disable_error
= usb_unlocked_disable_lpm(udev
);
529 if (lpm_disable_error
&& driver
->disable_hub_initiated_lpm
) {
530 dev_err(&iface
->dev
, "%s Failed to disable LPM for driver %s\n.",
531 __func__
, driver
->name
);
535 /* Claimed interfaces are initially inactive (suspended) and
536 * runtime-PM-enabled, but only if the driver has autosuspend
537 * support. Otherwise they are marked active, to prevent the
538 * device from being autosuspended, but left disabled. In either
539 * case they are sensitive to their children's power states.
541 pm_suspend_ignore_children(dev
, false);
542 if (driver
->supports_autosuspend
)
543 pm_runtime_enable(dev
);
545 pm_runtime_set_active(dev
);
547 /* if interface was already added, bind now; else let
548 * the future device_add() bind it, bypassing probe()
550 if (device_is_registered(dev
))
551 retval
= device_bind_driver(dev
);
553 /* Attempt to re-enable USB3 LPM, if the disable was successful. */
554 if (!lpm_disable_error
)
555 usb_unlocked_enable_lpm(udev
);
559 EXPORT_SYMBOL_GPL(usb_driver_claim_interface
);
562 * usb_driver_release_interface - unbind a driver from an interface
563 * @driver: the driver to be unbound
564 * @iface: the interface from which it will be unbound
566 * This can be used by drivers to release an interface without waiting
567 * for their disconnect() methods to be called. In typical cases this
568 * also causes the driver disconnect() method to be called.
570 * This call is synchronous, and may not be used in an interrupt context.
571 * Callers must own the device lock, so driver disconnect() entries don't
572 * need extra locking, but other call contexts may need to explicitly claim
575 void usb_driver_release_interface(struct usb_driver
*driver
,
576 struct usb_interface
*iface
)
578 struct device
*dev
= &iface
->dev
;
580 /* this should never happen, don't release something that's not ours */
581 if (!dev
->driver
|| dev
->driver
!= &driver
->drvwrap
.driver
)
584 /* don't release from within disconnect() */
585 if (iface
->condition
!= USB_INTERFACE_BOUND
)
587 iface
->condition
= USB_INTERFACE_UNBINDING
;
589 /* Release via the driver core only if the interface
590 * has already been registered
592 if (device_is_registered(dev
)) {
593 device_release_driver(dev
);
596 usb_unbind_interface(dev
);
601 EXPORT_SYMBOL_GPL(usb_driver_release_interface
);
603 /* returns 0 if no match, 1 if match */
604 int usb_match_device(struct usb_device
*dev
, const struct usb_device_id
*id
)
606 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_VENDOR
) &&
607 id
->idVendor
!= le16_to_cpu(dev
->descriptor
.idVendor
))
610 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_PRODUCT
) &&
611 id
->idProduct
!= le16_to_cpu(dev
->descriptor
.idProduct
))
614 /* No need to test id->bcdDevice_lo != 0, since 0 is never
615 greater than any unsigned number. */
616 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_LO
) &&
617 (id
->bcdDevice_lo
> le16_to_cpu(dev
->descriptor
.bcdDevice
)))
620 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_HI
) &&
621 (id
->bcdDevice_hi
< le16_to_cpu(dev
->descriptor
.bcdDevice
)))
624 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_CLASS
) &&
625 (id
->bDeviceClass
!= dev
->descriptor
.bDeviceClass
))
628 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_SUBCLASS
) &&
629 (id
->bDeviceSubClass
!= dev
->descriptor
.bDeviceSubClass
))
632 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_PROTOCOL
) &&
633 (id
->bDeviceProtocol
!= dev
->descriptor
.bDeviceProtocol
))
639 /* returns 0 if no match, 1 if match */
640 int usb_match_one_id_intf(struct usb_device
*dev
,
641 struct usb_host_interface
*intf
,
642 const struct usb_device_id
*id
)
644 /* The interface class, subclass, protocol and number should never be
645 * checked for a match if the device class is Vendor Specific,
646 * unless the match record specifies the Vendor ID. */
647 if (dev
->descriptor
.bDeviceClass
== USB_CLASS_VENDOR_SPEC
&&
648 !(id
->match_flags
& USB_DEVICE_ID_MATCH_VENDOR
) &&
649 (id
->match_flags
& (USB_DEVICE_ID_MATCH_INT_CLASS
|
650 USB_DEVICE_ID_MATCH_INT_SUBCLASS
|
651 USB_DEVICE_ID_MATCH_INT_PROTOCOL
|
652 USB_DEVICE_ID_MATCH_INT_NUMBER
)))
655 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_CLASS
) &&
656 (id
->bInterfaceClass
!= intf
->desc
.bInterfaceClass
))
659 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_SUBCLASS
) &&
660 (id
->bInterfaceSubClass
!= intf
->desc
.bInterfaceSubClass
))
663 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_PROTOCOL
) &&
664 (id
->bInterfaceProtocol
!= intf
->desc
.bInterfaceProtocol
))
667 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_NUMBER
) &&
668 (id
->bInterfaceNumber
!= intf
->desc
.bInterfaceNumber
))
674 /* returns 0 if no match, 1 if match */
675 int usb_match_one_id(struct usb_interface
*interface
,
676 const struct usb_device_id
*id
)
678 struct usb_host_interface
*intf
;
679 struct usb_device
*dev
;
681 /* proc_connectinfo in devio.c may call us with id == NULL. */
685 intf
= interface
->cur_altsetting
;
686 dev
= interface_to_usbdev(interface
);
688 if (!usb_match_device(dev
, id
))
691 return usb_match_one_id_intf(dev
, intf
, id
);
693 EXPORT_SYMBOL_GPL(usb_match_one_id
);
696 * usb_match_id - find first usb_device_id matching device or interface
697 * @interface: the interface of interest
698 * @id: array of usb_device_id structures, terminated by zero entry
700 * usb_match_id searches an array of usb_device_id's and returns
701 * the first one matching the device or interface, or null.
702 * This is used when binding (or rebinding) a driver to an interface.
703 * Most USB device drivers will use this indirectly, through the usb core,
704 * but some layered driver frameworks use it directly.
705 * These device tables are exported with MODULE_DEVICE_TABLE, through
706 * modutils, to support the driver loading functionality of USB hotplugging.
708 * Return: The first matching usb_device_id, or %NULL.
712 * The "match_flags" element in a usb_device_id controls which
713 * members are used. If the corresponding bit is set, the
714 * value in the device_id must match its corresponding member
715 * in the device or interface descriptor, or else the device_id
718 * "driver_info" is normally used only by device drivers,
719 * but you can create a wildcard "matches anything" usb_device_id
720 * as a driver's "modules.usbmap" entry if you provide an id with
721 * only a nonzero "driver_info" field. If you do this, the USB device
722 * driver's probe() routine should use additional intelligence to
723 * decide whether to bind to the specified interface.
725 * What Makes Good usb_device_id Tables:
727 * The match algorithm is very simple, so that intelligence in
728 * driver selection must come from smart driver id records.
729 * Unless you have good reasons to use another selection policy,
730 * provide match elements only in related groups, and order match
731 * specifiers from specific to general. Use the macros provided
732 * for that purpose if you can.
734 * The most specific match specifiers use device descriptor
735 * data. These are commonly used with product-specific matches;
736 * the USB_DEVICE macro lets you provide vendor and product IDs,
737 * and you can also match against ranges of product revisions.
738 * These are widely used for devices with application or vendor
739 * specific bDeviceClass values.
741 * Matches based on device class/subclass/protocol specifications
742 * are slightly more general; use the USB_DEVICE_INFO macro, or
743 * its siblings. These are used with single-function devices
744 * where bDeviceClass doesn't specify that each interface has
747 * Matches based on interface class/subclass/protocol are the
748 * most general; they let drivers bind to any interface on a
749 * multiple-function device. Use the USB_INTERFACE_INFO
750 * macro, or its siblings, to match class-per-interface style
751 * devices (as recorded in bInterfaceClass).
753 * Note that an entry created by USB_INTERFACE_INFO won't match
754 * any interface if the device class is set to Vendor-Specific.
755 * This is deliberate; according to the USB spec the meanings of
756 * the interface class/subclass/protocol for these devices are also
757 * vendor-specific, and hence matching against a standard product
758 * class wouldn't work anyway. If you really want to use an
759 * interface-based match for such a device, create a match record
760 * that also specifies the vendor ID. (Unforunately there isn't a
761 * standard macro for creating records like this.)
763 * Within those groups, remember that not all combinations are
764 * meaningful. For example, don't give a product version range
765 * without vendor and product IDs; or specify a protocol without
766 * its associated class and subclass.
768 const struct usb_device_id
*usb_match_id(struct usb_interface
*interface
,
769 const struct usb_device_id
*id
)
771 /* proc_connectinfo in devio.c may call us with id == NULL. */
775 /* It is important to check that id->driver_info is nonzero,
776 since an entry that is all zeroes except for a nonzero
777 id->driver_info is the way to create an entry that
778 indicates that the driver want to examine every
779 device and interface. */
780 for (; id
->idVendor
|| id
->idProduct
|| id
->bDeviceClass
||
781 id
->bInterfaceClass
|| id
->driver_info
; id
++) {
782 if (usb_match_one_id(interface
, id
))
788 EXPORT_SYMBOL_GPL(usb_match_id
);
790 static int usb_device_match(struct device
*dev
, struct device_driver
*drv
)
792 /* devices and interfaces are handled separately */
793 if (is_usb_device(dev
)) {
795 /* interface drivers never match devices */
796 if (!is_usb_device_driver(drv
))
799 /* TODO: Add real matching code */
802 } else if (is_usb_interface(dev
)) {
803 struct usb_interface
*intf
;
804 struct usb_driver
*usb_drv
;
805 const struct usb_device_id
*id
;
807 /* device drivers never match interfaces */
808 if (is_usb_device_driver(drv
))
811 intf
= to_usb_interface(dev
);
812 usb_drv
= to_usb_driver(drv
);
814 id
= usb_match_id(intf
, usb_drv
->id_table
);
818 id
= usb_match_dynamic_id(intf
, usb_drv
);
826 static int usb_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
828 struct usb_device
*usb_dev
;
830 if (is_usb_device(dev
)) {
831 usb_dev
= to_usb_device(dev
);
832 } else if (is_usb_interface(dev
)) {
833 struct usb_interface
*intf
= to_usb_interface(dev
);
835 usb_dev
= interface_to_usbdev(intf
);
840 if (usb_dev
->devnum
< 0) {
841 /* driver is often null here; dev_dbg() would oops */
842 pr_debug("usb %s: already deleted?\n", dev_name(dev
));
846 pr_debug("usb %s: bus removed?\n", dev_name(dev
));
850 /* per-device configurations are common */
851 if (add_uevent_var(env
, "PRODUCT=%x/%x/%x",
852 le16_to_cpu(usb_dev
->descriptor
.idVendor
),
853 le16_to_cpu(usb_dev
->descriptor
.idProduct
),
854 le16_to_cpu(usb_dev
->descriptor
.bcdDevice
)))
857 /* class-based driver binding models */
858 if (add_uevent_var(env
, "TYPE=%d/%d/%d",
859 usb_dev
->descriptor
.bDeviceClass
,
860 usb_dev
->descriptor
.bDeviceSubClass
,
861 usb_dev
->descriptor
.bDeviceProtocol
))
868 * usb_register_device_driver - register a USB device (not interface) driver
869 * @new_udriver: USB operations for the device driver
870 * @owner: module owner of this driver.
872 * Registers a USB device driver with the USB core. The list of
873 * unattached devices will be rescanned whenever a new driver is
874 * added, allowing the new driver to attach to any recognized devices.
876 * Return: A negative error code on failure and 0 on success.
878 int usb_register_device_driver(struct usb_device_driver
*new_udriver
,
879 struct module
*owner
)
886 new_udriver
->drvwrap
.for_devices
= 1;
887 new_udriver
->drvwrap
.driver
.name
= new_udriver
->name
;
888 new_udriver
->drvwrap
.driver
.bus
= &usb_bus_type
;
889 new_udriver
->drvwrap
.driver
.probe
= usb_probe_device
;
890 new_udriver
->drvwrap
.driver
.remove
= usb_unbind_device
;
891 new_udriver
->drvwrap
.driver
.owner
= owner
;
893 retval
= driver_register(&new_udriver
->drvwrap
.driver
);
896 pr_info("%s: registered new device driver %s\n",
897 usbcore_name
, new_udriver
->name
);
899 printk(KERN_ERR
"%s: error %d registering device "
901 usbcore_name
, retval
, new_udriver
->name
);
905 EXPORT_SYMBOL_GPL(usb_register_device_driver
);
908 * usb_deregister_device_driver - unregister a USB device (not interface) driver
909 * @udriver: USB operations of the device driver to unregister
910 * Context: must be able to sleep
912 * Unlinks the specified driver from the internal USB driver list.
914 void usb_deregister_device_driver(struct usb_device_driver
*udriver
)
916 pr_info("%s: deregistering device driver %s\n",
917 usbcore_name
, udriver
->name
);
919 driver_unregister(&udriver
->drvwrap
.driver
);
921 EXPORT_SYMBOL_GPL(usb_deregister_device_driver
);
924 * usb_register_driver - register a USB interface driver
925 * @new_driver: USB operations for the interface driver
926 * @owner: module owner of this driver.
927 * @mod_name: module name string
929 * Registers a USB interface driver with the USB core. The list of
930 * unattached interfaces will be rescanned whenever a new driver is
931 * added, allowing the new driver to attach to any recognized interfaces.
933 * Return: A negative error code on failure and 0 on success.
935 * NOTE: if you want your driver to use the USB major number, you must call
936 * usb_register_dev() to enable that functionality. This function no longer
937 * takes care of that.
939 int usb_register_driver(struct usb_driver
*new_driver
, struct module
*owner
,
940 const char *mod_name
)
947 new_driver
->drvwrap
.for_devices
= 0;
948 new_driver
->drvwrap
.driver
.name
= new_driver
->name
;
949 new_driver
->drvwrap
.driver
.bus
= &usb_bus_type
;
950 new_driver
->drvwrap
.driver
.probe
= usb_probe_interface
;
951 new_driver
->drvwrap
.driver
.remove
= usb_unbind_interface
;
952 new_driver
->drvwrap
.driver
.owner
= owner
;
953 new_driver
->drvwrap
.driver
.mod_name
= mod_name
;
954 spin_lock_init(&new_driver
->dynids
.lock
);
955 INIT_LIST_HEAD(&new_driver
->dynids
.list
);
957 retval
= driver_register(&new_driver
->drvwrap
.driver
);
961 retval
= usb_create_newid_files(new_driver
);
965 pr_info("%s: registered new interface driver %s\n",
966 usbcore_name
, new_driver
->name
);
972 driver_unregister(&new_driver
->drvwrap
.driver
);
974 printk(KERN_ERR
"%s: error %d registering interface "
976 usbcore_name
, retval
, new_driver
->name
);
979 EXPORT_SYMBOL_GPL(usb_register_driver
);
982 * usb_deregister - unregister a USB interface driver
983 * @driver: USB operations of the interface driver to unregister
984 * Context: must be able to sleep
986 * Unlinks the specified driver from the internal USB driver list.
988 * NOTE: If you called usb_register_dev(), you still need to call
989 * usb_deregister_dev() to clean up your driver's allocated minor numbers,
990 * this * call will no longer do it for you.
992 void usb_deregister(struct usb_driver
*driver
)
994 pr_info("%s: deregistering interface driver %s\n",
995 usbcore_name
, driver
->name
);
997 usb_remove_newid_files(driver
);
998 driver_unregister(&driver
->drvwrap
.driver
);
999 usb_free_dynids(driver
);
1001 EXPORT_SYMBOL_GPL(usb_deregister
);
1003 /* Forced unbinding of a USB interface driver, either because
1004 * it doesn't support pre_reset/post_reset/reset_resume or
1005 * because it doesn't support suspend/resume.
1007 * The caller must hold @intf's device's lock, but not @intf's lock.
1009 void usb_forced_unbind_intf(struct usb_interface
*intf
)
1011 struct usb_driver
*driver
= to_usb_driver(intf
->dev
.driver
);
1013 dev_dbg(&intf
->dev
, "forced unbind\n");
1014 usb_driver_release_interface(driver
, intf
);
1016 /* Mark the interface for later rebinding */
1017 intf
->needs_binding
= 1;
1021 * Unbind drivers for @udev's marked interfaces. These interfaces have
1022 * the needs_binding flag set, for example by usb_resume_interface().
1024 * The caller must hold @udev's device lock.
1026 static void unbind_marked_interfaces(struct usb_device
*udev
)
1028 struct usb_host_config
*config
;
1030 struct usb_interface
*intf
;
1032 config
= udev
->actconfig
;
1034 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
1035 intf
= config
->interface
[i
];
1036 if (intf
->dev
.driver
&& intf
->needs_binding
)
1037 usb_forced_unbind_intf(intf
);
1042 /* Delayed forced unbinding of a USB interface driver and scan
1045 * The caller must hold @intf's device's lock, but not @intf's lock.
1047 * Note: Rebinds will be skipped if a system sleep transition is in
1048 * progress and the PM "complete" callback hasn't occurred yet.
1050 static void usb_rebind_intf(struct usb_interface
*intf
)
1054 /* Delayed unbind of an existing driver */
1055 if (intf
->dev
.driver
)
1056 usb_forced_unbind_intf(intf
);
1058 /* Try to rebind the interface */
1059 if (!intf
->dev
.power
.is_prepared
) {
1060 intf
->needs_binding
= 0;
1061 rc
= device_attach(&intf
->dev
);
1063 dev_warn(&intf
->dev
, "rebind failed: %d\n", rc
);
1068 * Rebind drivers to @udev's marked interfaces. These interfaces have
1069 * the needs_binding flag set.
1071 * The caller must hold @udev's device lock.
1073 static void rebind_marked_interfaces(struct usb_device
*udev
)
1075 struct usb_host_config
*config
;
1077 struct usb_interface
*intf
;
1079 config
= udev
->actconfig
;
1081 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
1082 intf
= config
->interface
[i
];
1083 if (intf
->needs_binding
)
1084 usb_rebind_intf(intf
);
1090 * Unbind all of @udev's marked interfaces and then rebind all of them.
1091 * This ordering is necessary because some drivers claim several interfaces
1092 * when they are first probed.
1094 * The caller must hold @udev's device lock.
1096 void usb_unbind_and_rebind_marked_interfaces(struct usb_device
*udev
)
1098 unbind_marked_interfaces(udev
);
1099 rebind_marked_interfaces(udev
);
1104 /* Unbind drivers for @udev's interfaces that don't support suspend/resume
1105 * There is no check for reset_resume here because it can be determined
1106 * only during resume whether reset_resume is needed.
1108 * The caller must hold @udev's device lock.
1110 static void unbind_no_pm_drivers_interfaces(struct usb_device
*udev
)
1112 struct usb_host_config
*config
;
1114 struct usb_interface
*intf
;
1115 struct usb_driver
*drv
;
1117 config
= udev
->actconfig
;
1119 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
1120 intf
= config
->interface
[i
];
1122 if (intf
->dev
.driver
) {
1123 drv
= to_usb_driver(intf
->dev
.driver
);
1124 if (!drv
->suspend
|| !drv
->resume
)
1125 usb_forced_unbind_intf(intf
);
1131 static int usb_suspend_device(struct usb_device
*udev
, pm_message_t msg
)
1133 struct usb_device_driver
*udriver
;
1136 if (udev
->state
== USB_STATE_NOTATTACHED
||
1137 udev
->state
== USB_STATE_SUSPENDED
)
1140 /* For devices that don't have a driver, we do a generic suspend. */
1141 if (udev
->dev
.driver
)
1142 udriver
= to_usb_device_driver(udev
->dev
.driver
);
1144 udev
->do_remote_wakeup
= 0;
1145 udriver
= &usb_generic_driver
;
1147 status
= udriver
->suspend(udev
, msg
);
1150 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1154 static int usb_resume_device(struct usb_device
*udev
, pm_message_t msg
)
1156 struct usb_device_driver
*udriver
;
1159 if (udev
->state
== USB_STATE_NOTATTACHED
)
1162 /* Can't resume it if it doesn't have a driver. */
1163 if (udev
->dev
.driver
== NULL
) {
1168 /* Non-root devices on a full/low-speed bus must wait for their
1169 * companion high-speed root hub, in case a handoff is needed.
1171 if (!PMSG_IS_AUTO(msg
) && udev
->parent
&& udev
->bus
->hs_companion
)
1172 device_pm_wait_for_dev(&udev
->dev
,
1173 &udev
->bus
->hs_companion
->root_hub
->dev
);
1175 if (udev
->quirks
& USB_QUIRK_RESET_RESUME
)
1176 udev
->reset_resume
= 1;
1178 udriver
= to_usb_device_driver(udev
->dev
.driver
);
1179 status
= udriver
->resume(udev
, msg
);
1182 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1186 static int usb_suspend_interface(struct usb_device
*udev
,
1187 struct usb_interface
*intf
, pm_message_t msg
)
1189 struct usb_driver
*driver
;
1192 if (udev
->state
== USB_STATE_NOTATTACHED
||
1193 intf
->condition
== USB_INTERFACE_UNBOUND
)
1195 driver
= to_usb_driver(intf
->dev
.driver
);
1197 /* at this time we know the driver supports suspend */
1198 status
= driver
->suspend(intf
, msg
);
1199 if (status
&& !PMSG_IS_AUTO(msg
))
1200 dev_err(&intf
->dev
, "suspend error %d\n", status
);
1203 dev_vdbg(&intf
->dev
, "%s: status %d\n", __func__
, status
);
1207 static int usb_resume_interface(struct usb_device
*udev
,
1208 struct usb_interface
*intf
, pm_message_t msg
, int reset_resume
)
1210 struct usb_driver
*driver
;
1213 if (udev
->state
== USB_STATE_NOTATTACHED
)
1216 /* Don't let autoresume interfere with unbinding */
1217 if (intf
->condition
== USB_INTERFACE_UNBINDING
)
1220 /* Can't resume it if it doesn't have a driver. */
1221 if (intf
->condition
== USB_INTERFACE_UNBOUND
) {
1223 /* Carry out a deferred switch to altsetting 0 */
1224 if (intf
->needs_altsetting0
&& !intf
->dev
.power
.is_prepared
) {
1225 usb_set_interface(udev
, intf
->altsetting
[0].
1226 desc
.bInterfaceNumber
, 0);
1227 intf
->needs_altsetting0
= 0;
1232 /* Don't resume if the interface is marked for rebinding */
1233 if (intf
->needs_binding
)
1235 driver
= to_usb_driver(intf
->dev
.driver
);
1238 if (driver
->reset_resume
) {
1239 status
= driver
->reset_resume(intf
);
1241 dev_err(&intf
->dev
, "%s error %d\n",
1242 "reset_resume", status
);
1244 intf
->needs_binding
= 1;
1245 dev_dbg(&intf
->dev
, "no reset_resume for driver %s?\n",
1249 status
= driver
->resume(intf
);
1251 dev_err(&intf
->dev
, "resume error %d\n", status
);
1255 dev_vdbg(&intf
->dev
, "%s: status %d\n", __func__
, status
);
1257 /* Later we will unbind the driver and/or reprobe, if necessary */
1262 * usb_suspend_both - suspend a USB device and its interfaces
1263 * @udev: the usb_device to suspend
1264 * @msg: Power Management message describing this state transition
1266 * This is the central routine for suspending USB devices. It calls the
1267 * suspend methods for all the interface drivers in @udev and then calls
1268 * the suspend method for @udev itself. When the routine is called in
1269 * autosuspend, if an error occurs at any stage, all the interfaces
1270 * which were suspended are resumed so that they remain in the same
1271 * state as the device, but when called from system sleep, all error
1272 * from suspend methods of interfaces and the non-root-hub device itself
1273 * are simply ignored, so all suspended interfaces are only resumed
1274 * to the device's state when @udev is root-hub and its suspend method
1277 * Autosuspend requests originating from a child device or an interface
1278 * driver may be made without the protection of @udev's device lock, but
1279 * all other suspend calls will hold the lock. Usbcore will insure that
1280 * method calls do not arrive during bind, unbind, or reset operations.
1281 * However drivers must be prepared to handle suspend calls arriving at
1282 * unpredictable times.
1284 * This routine can run only in process context.
1286 * Return: 0 if the suspend succeeded.
1288 static int usb_suspend_both(struct usb_device
*udev
, pm_message_t msg
)
1292 struct usb_interface
*intf
;
1294 if (udev
->state
== USB_STATE_NOTATTACHED
||
1295 udev
->state
== USB_STATE_SUSPENDED
)
1298 /* Suspend all the interfaces and then udev itself */
1299 if (udev
->actconfig
) {
1300 n
= udev
->actconfig
->desc
.bNumInterfaces
;
1301 for (i
= n
- 1; i
>= 0; --i
) {
1302 intf
= udev
->actconfig
->interface
[i
];
1303 status
= usb_suspend_interface(udev
, intf
, msg
);
1305 /* Ignore errors during system sleep transitions */
1306 if (!PMSG_IS_AUTO(msg
))
1313 status
= usb_suspend_device(udev
, msg
);
1316 * Ignore errors from non-root-hub devices during
1317 * system sleep transitions. For the most part,
1318 * these devices should go to low power anyway when
1319 * the entire bus is suspended.
1321 if (udev
->parent
&& !PMSG_IS_AUTO(msg
))
1325 /* If the suspend failed, resume interfaces that did get suspended */
1327 if (udev
->actconfig
) {
1328 msg
.event
^= (PM_EVENT_SUSPEND
| PM_EVENT_RESUME
);
1330 intf
= udev
->actconfig
->interface
[i
];
1331 usb_resume_interface(udev
, intf
, msg
, 0);
1335 /* If the suspend succeeded then prevent any more URB submissions
1336 * and flush any outstanding URBs.
1339 udev
->can_submit
= 0;
1340 for (i
= 0; i
< 16; ++i
) {
1341 usb_hcd_flush_endpoint(udev
, udev
->ep_out
[i
]);
1342 usb_hcd_flush_endpoint(udev
, udev
->ep_in
[i
]);
1347 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1352 * usb_resume_both - resume a USB device and its interfaces
1353 * @udev: the usb_device to resume
1354 * @msg: Power Management message describing this state transition
1356 * This is the central routine for resuming USB devices. It calls the
1357 * the resume method for @udev and then calls the resume methods for all
1358 * the interface drivers in @udev.
1360 * Autoresume requests originating from a child device or an interface
1361 * driver may be made without the protection of @udev's device lock, but
1362 * all other resume calls will hold the lock. Usbcore will insure that
1363 * method calls do not arrive during bind, unbind, or reset operations.
1364 * However drivers must be prepared to handle resume calls arriving at
1365 * unpredictable times.
1367 * This routine can run only in process context.
1369 * Return: 0 on success.
1371 static int usb_resume_both(struct usb_device
*udev
, pm_message_t msg
)
1375 struct usb_interface
*intf
;
1377 if (udev
->state
== USB_STATE_NOTATTACHED
) {
1381 udev
->can_submit
= 1;
1383 /* Resume the device */
1384 if (udev
->state
== USB_STATE_SUSPENDED
|| udev
->reset_resume
)
1385 status
= usb_resume_device(udev
, msg
);
1387 /* Resume the interfaces */
1388 if (status
== 0 && udev
->actconfig
) {
1389 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
1390 intf
= udev
->actconfig
->interface
[i
];
1391 usb_resume_interface(udev
, intf
, msg
,
1392 udev
->reset_resume
);
1395 usb_mark_last_busy(udev
);
1398 dev_vdbg(&udev
->dev
, "%s: status %d\n", __func__
, status
);
1400 udev
->reset_resume
= 0;
1404 static void choose_wakeup(struct usb_device
*udev
, pm_message_t msg
)
1408 /* Remote wakeup is needed only when we actually go to sleep.
1409 * For things like FREEZE and QUIESCE, if the device is already
1410 * autosuspended then its current wakeup setting is okay.
1412 if (msg
.event
== PM_EVENT_FREEZE
|| msg
.event
== PM_EVENT_QUIESCE
) {
1413 if (udev
->state
!= USB_STATE_SUSPENDED
)
1414 udev
->do_remote_wakeup
= 0;
1418 /* Enable remote wakeup if it is allowed, even if no interface drivers
1421 w
= device_may_wakeup(&udev
->dev
);
1423 /* If the device is autosuspended with the wrong wakeup setting,
1424 * autoresume now so the setting can be changed.
1426 if (udev
->state
== USB_STATE_SUSPENDED
&& w
!= udev
->do_remote_wakeup
)
1427 pm_runtime_resume(&udev
->dev
);
1428 udev
->do_remote_wakeup
= w
;
1431 /* The device lock is held by the PM core */
1432 int usb_suspend(struct device
*dev
, pm_message_t msg
)
1434 struct usb_device
*udev
= to_usb_device(dev
);
1436 unbind_no_pm_drivers_interfaces(udev
);
1438 /* From now on we are sure all drivers support suspend/resume
1439 * but not necessarily reset_resume()
1440 * so we may still need to unbind and rebind upon resume
1442 choose_wakeup(udev
, msg
);
1443 return usb_suspend_both(udev
, msg
);
1446 /* The device lock is held by the PM core */
1447 int usb_resume_complete(struct device
*dev
)
1449 struct usb_device
*udev
= to_usb_device(dev
);
1451 /* For PM complete calls, all we do is rebind interfaces
1452 * whose needs_binding flag is set
1454 if (udev
->state
!= USB_STATE_NOTATTACHED
)
1455 rebind_marked_interfaces(udev
);
1459 /* The device lock is held by the PM core */
1460 int usb_resume(struct device
*dev
, pm_message_t msg
)
1462 struct usb_device
*udev
= to_usb_device(dev
);
1465 /* For all calls, take the device back to full power and
1466 * tell the PM core in case it was autosuspended previously.
1467 * Unbind the interfaces that will need rebinding later,
1468 * because they fail to support reset_resume.
1469 * (This can't be done in usb_resume_interface()
1470 * above because it doesn't own the right set of locks.)
1472 status
= usb_resume_both(udev
, msg
);
1474 pm_runtime_disable(dev
);
1475 pm_runtime_set_active(dev
);
1476 pm_runtime_enable(dev
);
1477 unbind_marked_interfaces(udev
);
1480 /* Avoid PM error messages for devices disconnected while suspended
1481 * as we'll display regular disconnect messages just a bit later.
1483 if (status
== -ENODEV
|| status
== -ESHUTDOWN
)
1489 * usb_enable_autosuspend - allow a USB device to be autosuspended
1490 * @udev: the USB device which may be autosuspended
1492 * This routine allows @udev to be autosuspended. An autosuspend won't
1493 * take place until the autosuspend_delay has elapsed and all the other
1494 * necessary conditions are satisfied.
1496 * The caller must hold @udev's device lock.
1498 void usb_enable_autosuspend(struct usb_device
*udev
)
1500 pm_runtime_allow(&udev
->dev
);
1502 EXPORT_SYMBOL_GPL(usb_enable_autosuspend
);
1505 * usb_disable_autosuspend - prevent a USB device from being autosuspended
1506 * @udev: the USB device which may not be autosuspended
1508 * This routine prevents @udev from being autosuspended and wakes it up
1509 * if it is already autosuspended.
1511 * The caller must hold @udev's device lock.
1513 void usb_disable_autosuspend(struct usb_device
*udev
)
1515 pm_runtime_forbid(&udev
->dev
);
1517 EXPORT_SYMBOL_GPL(usb_disable_autosuspend
);
1520 * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
1521 * @udev: the usb_device to autosuspend
1523 * This routine should be called when a core subsystem is finished using
1524 * @udev and wants to allow it to autosuspend. Examples would be when
1525 * @udev's device file in usbfs is closed or after a configuration change.
1527 * @udev's usage counter is decremented; if it drops to 0 and all the
1528 * interfaces are inactive then a delayed autosuspend will be attempted.
1529 * The attempt may fail (see autosuspend_check()).
1531 * The caller must hold @udev's device lock.
1533 * This routine can run only in process context.
1535 void usb_autosuspend_device(struct usb_device
*udev
)
1539 usb_mark_last_busy(udev
);
1540 status
= pm_runtime_put_sync_autosuspend(&udev
->dev
);
1541 dev_vdbg(&udev
->dev
, "%s: cnt %d -> %d\n",
1542 __func__
, atomic_read(&udev
->dev
.power
.usage_count
),
1547 * usb_autoresume_device - immediately autoresume a USB device and its interfaces
1548 * @udev: the usb_device to autoresume
1550 * This routine should be called when a core subsystem wants to use @udev
1551 * and needs to guarantee that it is not suspended. No autosuspend will
1552 * occur until usb_autosuspend_device() is called. (Note that this will
1553 * not prevent suspend events originating in the PM core.) Examples would
1554 * be when @udev's device file in usbfs is opened or when a remote-wakeup
1555 * request is received.
1557 * @udev's usage counter is incremented to prevent subsequent autosuspends.
1558 * However if the autoresume fails then the usage counter is re-decremented.
1560 * The caller must hold @udev's device lock.
1562 * This routine can run only in process context.
1564 * Return: 0 on success. A negative error code otherwise.
1566 int usb_autoresume_device(struct usb_device
*udev
)
1570 status
= pm_runtime_get_sync(&udev
->dev
);
1572 pm_runtime_put_sync(&udev
->dev
);
1573 dev_vdbg(&udev
->dev
, "%s: cnt %d -> %d\n",
1574 __func__
, atomic_read(&udev
->dev
.power
.usage_count
),
1582 * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
1583 * @intf: the usb_interface whose counter should be decremented
1585 * This routine should be called by an interface driver when it is
1586 * finished using @intf and wants to allow it to autosuspend. A typical
1587 * example would be a character-device driver when its device file is
1590 * The routine decrements @intf's usage counter. When the counter reaches
1591 * 0, a delayed autosuspend request for @intf's device is attempted. The
1592 * attempt may fail (see autosuspend_check()).
1594 * This routine can run only in process context.
1596 void usb_autopm_put_interface(struct usb_interface
*intf
)
1598 struct usb_device
*udev
= interface_to_usbdev(intf
);
1601 usb_mark_last_busy(udev
);
1602 atomic_dec(&intf
->pm_usage_cnt
);
1603 status
= pm_runtime_put_sync(&intf
->dev
);
1604 dev_vdbg(&intf
->dev
, "%s: cnt %d -> %d\n",
1605 __func__
, atomic_read(&intf
->dev
.power
.usage_count
),
1608 EXPORT_SYMBOL_GPL(usb_autopm_put_interface
);
1611 * usb_autopm_put_interface_async - decrement a USB interface's PM-usage counter
1612 * @intf: the usb_interface whose counter should be decremented
1614 * This routine does much the same thing as usb_autopm_put_interface():
1615 * It decrements @intf's usage counter and schedules a delayed
1616 * autosuspend request if the counter is <= 0. The difference is that it
1617 * does not perform any synchronization; callers should hold a private
1618 * lock and handle all synchronization issues themselves.
1620 * Typically a driver would call this routine during an URB's completion
1621 * handler, if no more URBs were pending.
1623 * This routine can run in atomic context.
1625 void usb_autopm_put_interface_async(struct usb_interface
*intf
)
1627 struct usb_device
*udev
= interface_to_usbdev(intf
);
1630 usb_mark_last_busy(udev
);
1631 atomic_dec(&intf
->pm_usage_cnt
);
1632 status
= pm_runtime_put(&intf
->dev
);
1633 dev_vdbg(&intf
->dev
, "%s: cnt %d -> %d\n",
1634 __func__
, atomic_read(&intf
->dev
.power
.usage_count
),
1637 EXPORT_SYMBOL_GPL(usb_autopm_put_interface_async
);
1640 * usb_autopm_put_interface_no_suspend - decrement a USB interface's PM-usage counter
1641 * @intf: the usb_interface whose counter should be decremented
1643 * This routine decrements @intf's usage counter but does not carry out an
1646 * This routine can run in atomic context.
1648 void usb_autopm_put_interface_no_suspend(struct usb_interface
*intf
)
1650 struct usb_device
*udev
= interface_to_usbdev(intf
);
1652 usb_mark_last_busy(udev
);
1653 atomic_dec(&intf
->pm_usage_cnt
);
1654 pm_runtime_put_noidle(&intf
->dev
);
1656 EXPORT_SYMBOL_GPL(usb_autopm_put_interface_no_suspend
);
1659 * usb_autopm_get_interface - increment a USB interface's PM-usage counter
1660 * @intf: the usb_interface whose counter should be incremented
1662 * This routine should be called by an interface driver when it wants to
1663 * use @intf and needs to guarantee that it is not suspended. In addition,
1664 * the routine prevents @intf from being autosuspended subsequently. (Note
1665 * that this will not prevent suspend events originating in the PM core.)
1666 * This prevention will persist until usb_autopm_put_interface() is called
1667 * or @intf is unbound. A typical example would be a character-device
1668 * driver when its device file is opened.
1670 * @intf's usage counter is incremented to prevent subsequent autosuspends.
1671 * However if the autoresume fails then the counter is re-decremented.
1673 * This routine can run only in process context.
1675 * Return: 0 on success.
1677 int usb_autopm_get_interface(struct usb_interface
*intf
)
1681 status
= pm_runtime_get_sync(&intf
->dev
);
1683 pm_runtime_put_sync(&intf
->dev
);
1685 atomic_inc(&intf
->pm_usage_cnt
);
1686 dev_vdbg(&intf
->dev
, "%s: cnt %d -> %d\n",
1687 __func__
, atomic_read(&intf
->dev
.power
.usage_count
),
1693 EXPORT_SYMBOL_GPL(usb_autopm_get_interface
);
1696 * usb_autopm_get_interface_async - increment a USB interface's PM-usage counter
1697 * @intf: the usb_interface whose counter should be incremented
1699 * This routine does much the same thing as
1700 * usb_autopm_get_interface(): It increments @intf's usage counter and
1701 * queues an autoresume request if the device is suspended. The
1702 * differences are that it does not perform any synchronization (callers
1703 * should hold a private lock and handle all synchronization issues
1704 * themselves), and it does not autoresume the device directly (it only
1705 * queues a request). After a successful call, the device may not yet be
1708 * This routine can run in atomic context.
1710 * Return: 0 on success. A negative error code otherwise.
1712 int usb_autopm_get_interface_async(struct usb_interface
*intf
)
1716 status
= pm_runtime_get(&intf
->dev
);
1717 if (status
< 0 && status
!= -EINPROGRESS
)
1718 pm_runtime_put_noidle(&intf
->dev
);
1720 atomic_inc(&intf
->pm_usage_cnt
);
1721 dev_vdbg(&intf
->dev
, "%s: cnt %d -> %d\n",
1722 __func__
, atomic_read(&intf
->dev
.power
.usage_count
),
1724 if (status
> 0 || status
== -EINPROGRESS
)
1728 EXPORT_SYMBOL_GPL(usb_autopm_get_interface_async
);
1731 * usb_autopm_get_interface_no_resume - increment a USB interface's PM-usage counter
1732 * @intf: the usb_interface whose counter should be incremented
1734 * This routine increments @intf's usage counter but does not carry out an
1737 * This routine can run in atomic context.
1739 void usb_autopm_get_interface_no_resume(struct usb_interface
*intf
)
1741 struct usb_device
*udev
= interface_to_usbdev(intf
);
1743 usb_mark_last_busy(udev
);
1744 atomic_inc(&intf
->pm_usage_cnt
);
1745 pm_runtime_get_noresume(&intf
->dev
);
1747 EXPORT_SYMBOL_GPL(usb_autopm_get_interface_no_resume
);
1749 /* Internal routine to check whether we may autosuspend a device. */
1750 static int autosuspend_check(struct usb_device
*udev
)
1753 struct usb_interface
*intf
;
1755 /* Fail if autosuspend is disabled, or any interfaces are in use, or
1756 * any interface drivers require remote wakeup but it isn't available.
1759 if (udev
->actconfig
) {
1760 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
1761 intf
= udev
->actconfig
->interface
[i
];
1763 /* We don't need to check interfaces that are
1764 * disabled for runtime PM. Either they are unbound
1765 * or else their drivers don't support autosuspend
1766 * and so they are permanently active.
1768 if (intf
->dev
.power
.disable_depth
)
1770 if (atomic_read(&intf
->dev
.power
.usage_count
) > 0)
1772 w
|= intf
->needs_remote_wakeup
;
1774 /* Don't allow autosuspend if the device will need
1775 * a reset-resume and any of its interface drivers
1776 * doesn't include support or needs remote wakeup.
1778 if (udev
->quirks
& USB_QUIRK_RESET_RESUME
) {
1779 struct usb_driver
*driver
;
1781 driver
= to_usb_driver(intf
->dev
.driver
);
1782 if (!driver
->reset_resume
||
1783 intf
->needs_remote_wakeup
)
1788 if (w
&& !device_can_wakeup(&udev
->dev
)) {
1789 dev_dbg(&udev
->dev
, "remote wakeup needed for autosuspend\n");
1794 * If the device is a direct child of the root hub and the HCD
1795 * doesn't handle wakeup requests, don't allow autosuspend when
1798 if (w
&& udev
->parent
== udev
->bus
->root_hub
&&
1799 bus_to_hcd(udev
->bus
)->cant_recv_wakeups
) {
1800 dev_dbg(&udev
->dev
, "HCD doesn't handle wakeup requests\n");
1804 udev
->do_remote_wakeup
= w
;
1808 int usb_runtime_suspend(struct device
*dev
)
1810 struct usb_device
*udev
= to_usb_device(dev
);
1813 /* A USB device can be suspended if it passes the various autosuspend
1814 * checks. Runtime suspend for a USB device means suspending all the
1815 * interfaces and then the device itself.
1817 if (autosuspend_check(udev
) != 0)
1820 status
= usb_suspend_both(udev
, PMSG_AUTO_SUSPEND
);
1822 /* Allow a retry if autosuspend failed temporarily */
1823 if (status
== -EAGAIN
|| status
== -EBUSY
)
1824 usb_mark_last_busy(udev
);
1827 * The PM core reacts badly unless the return code is 0,
1828 * -EAGAIN, or -EBUSY, so always return -EBUSY on an error
1829 * (except for root hubs, because they don't suspend through
1830 * an upstream port like other USB devices).
1832 if (status
!= 0 && udev
->parent
)
1837 int usb_runtime_resume(struct device
*dev
)
1839 struct usb_device
*udev
= to_usb_device(dev
);
1842 /* Runtime resume for a USB device means resuming both the device
1843 * and all its interfaces.
1845 status
= usb_resume_both(udev
, PMSG_AUTO_RESUME
);
1849 int usb_runtime_idle(struct device
*dev
)
1851 struct usb_device
*udev
= to_usb_device(dev
);
1853 /* An idle USB device can be suspended if it passes the various
1854 * autosuspend checks.
1856 if (autosuspend_check(udev
) == 0)
1857 pm_runtime_autosuspend(dev
);
1858 /* Tell the core not to suspend it, though. */
1862 int usb_set_usb2_hardware_lpm(struct usb_device
*udev
, int enable
)
1864 struct usb_hcd
*hcd
= bus_to_hcd(udev
->bus
);
1867 if (enable
&& !udev
->usb2_hw_lpm_allowed
)
1870 if (hcd
->driver
->set_usb2_hw_lpm
) {
1871 ret
= hcd
->driver
->set_usb2_hw_lpm(hcd
, udev
, enable
);
1873 udev
->usb2_hw_lpm_enabled
= enable
;
1879 #endif /* CONFIG_PM */
1881 struct bus_type usb_bus_type
= {
1883 .match
= usb_device_match
,
1884 .uevent
= usb_uevent
,