USB: simplify hub_restart() logic
[linux-2.6.git] / drivers / usb / core / driver.c
blobbf1585b203cab4a94ba0cf6999774431090143cb
1 /*
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
21 * real drivers.
25 #include <linux/device.h>
26 #include <linux/usb.h>
27 #include <linux/usb/quirks.h>
28 #include <linux/workqueue.h>
29 #include "hcd.h"
30 #include "usb.h"
33 #ifdef CONFIG_HOTPLUG
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;
44 u32 idVendor = 0;
45 u32 idProduct = 0;
46 int fields = 0;
47 int retval = 0;
49 fields = sscanf(buf, "%x %x", &idVendor, &idProduct);
50 if (fields < 2)
51 return -EINVAL;
53 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
54 if (!dynid)
55 return -ENOMEM;
57 INIT_LIST_HEAD(&dynid->node);
58 dynid->id.idVendor = idVendor;
59 dynid->id.idProduct = idProduct;
60 dynid->id.match_flags = USB_DEVICE_ID_MATCH_DEVICE;
62 spin_lock(&dynids->lock);
63 list_add_tail(&dynid->node, &dynids->list);
64 spin_unlock(&dynids->lock);
66 if (get_driver(driver)) {
67 retval = driver_attach(driver);
68 put_driver(driver);
71 if (retval)
72 return retval;
73 return count;
75 EXPORT_SYMBOL_GPL(usb_store_new_id);
77 static ssize_t store_new_id(struct device_driver *driver,
78 const char *buf, size_t count)
80 struct usb_driver *usb_drv = to_usb_driver(driver);
82 return usb_store_new_id(&usb_drv->dynids, driver, buf, count);
84 static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
86 static int usb_create_newid_file(struct usb_driver *usb_drv)
88 int error = 0;
90 if (usb_drv->no_dynamic_id)
91 goto exit;
93 if (usb_drv->probe != NULL)
94 error = driver_create_file(&usb_drv->drvwrap.driver,
95 &driver_attr_new_id);
96 exit:
97 return error;
100 static void usb_remove_newid_file(struct usb_driver *usb_drv)
102 if (usb_drv->no_dynamic_id)
103 return;
105 if (usb_drv->probe != NULL)
106 driver_remove_file(&usb_drv->drvwrap.driver,
107 &driver_attr_new_id);
110 static void usb_free_dynids(struct usb_driver *usb_drv)
112 struct usb_dynid *dynid, *n;
114 spin_lock(&usb_drv->dynids.lock);
115 list_for_each_entry_safe(dynid, n, &usb_drv->dynids.list, node) {
116 list_del(&dynid->node);
117 kfree(dynid);
119 spin_unlock(&usb_drv->dynids.lock);
121 #else
122 static inline int usb_create_newid_file(struct usb_driver *usb_drv)
124 return 0;
127 static void usb_remove_newid_file(struct usb_driver *usb_drv)
131 static inline void usb_free_dynids(struct usb_driver *usb_drv)
134 #endif
136 static const struct usb_device_id *usb_match_dynamic_id(struct usb_interface *intf,
137 struct usb_driver *drv)
139 struct usb_dynid *dynid;
141 spin_lock(&drv->dynids.lock);
142 list_for_each_entry(dynid, &drv->dynids.list, node) {
143 if (usb_match_one_id(intf, &dynid->id)) {
144 spin_unlock(&drv->dynids.lock);
145 return &dynid->id;
148 spin_unlock(&drv->dynids.lock);
149 return NULL;
153 /* called from driver core with dev locked */
154 static int usb_probe_device(struct device *dev)
156 struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
157 struct usb_device *udev;
158 int error = -ENODEV;
160 dev_dbg(dev, "%s\n", __func__);
162 if (!is_usb_device(dev)) /* Sanity check */
163 return error;
165 udev = to_usb_device(dev);
167 /* TODO: Add real matching code */
169 /* The device should always appear to be in use
170 * unless the driver suports autosuspend.
172 udev->pm_usage_cnt = !(udriver->supports_autosuspend);
174 error = udriver->probe(udev);
175 return error;
178 /* called from driver core with dev locked */
179 static int usb_unbind_device(struct device *dev)
181 struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
183 udriver->disconnect(to_usb_device(dev));
184 return 0;
188 /* called from driver core with dev locked */
189 static int usb_probe_interface(struct device *dev)
191 struct usb_driver *driver = to_usb_driver(dev->driver);
192 struct usb_interface *intf;
193 struct usb_device *udev;
194 const struct usb_device_id *id;
195 int error = -ENODEV;
197 dev_dbg(dev, "%s\n", __func__);
199 if (is_usb_device(dev)) /* Sanity check */
200 return error;
202 intf = to_usb_interface(dev);
203 udev = interface_to_usbdev(intf);
205 if (udev->authorized == 0) {
206 dev_err(&intf->dev, "Device is not authorized for usage\n");
207 return -ENODEV;
210 id = usb_match_id(intf, driver->id_table);
211 if (!id)
212 id = usb_match_dynamic_id(intf, driver);
213 if (id) {
214 dev_dbg(dev, "%s - got id\n", __func__);
216 error = usb_autoresume_device(udev);
217 if (error)
218 return error;
220 /* Interface "power state" doesn't correspond to any hardware
221 * state whatsoever. We use it to record when it's bound to
222 * a driver that may start I/0: it's not frozen/quiesced.
224 mark_active(intf);
225 intf->condition = USB_INTERFACE_BINDING;
227 /* The interface should always appear to be in use
228 * unless the driver suports autosuspend.
230 intf->pm_usage_cnt = !(driver->supports_autosuspend);
232 error = driver->probe(intf, id);
233 if (error) {
234 mark_quiesced(intf);
235 intf->needs_remote_wakeup = 0;
236 intf->condition = USB_INTERFACE_UNBOUND;
237 } else
238 intf->condition = USB_INTERFACE_BOUND;
240 usb_autosuspend_device(udev);
243 return error;
246 /* called from driver core with dev locked */
247 static int usb_unbind_interface(struct device *dev)
249 struct usb_driver *driver = to_usb_driver(dev->driver);
250 struct usb_interface *intf = to_usb_interface(dev);
251 struct usb_device *udev;
252 int error;
254 intf->condition = USB_INTERFACE_UNBINDING;
256 /* Autoresume for set_interface call below */
257 udev = interface_to_usbdev(intf);
258 error = usb_autoresume_device(udev);
260 /* release all urbs for this interface */
261 usb_disable_interface(interface_to_usbdev(intf), intf);
263 driver->disconnect(intf);
265 /* reset other interface state */
266 usb_set_interface(interface_to_usbdev(intf),
267 intf->altsetting[0].desc.bInterfaceNumber,
269 usb_set_intfdata(intf, NULL);
271 intf->condition = USB_INTERFACE_UNBOUND;
272 mark_quiesced(intf);
273 intf->needs_remote_wakeup = 0;
275 if (!error)
276 usb_autosuspend_device(udev);
278 return 0;
282 * usb_driver_claim_interface - bind a driver to an interface
283 * @driver: the driver to be bound
284 * @iface: the interface to which it will be bound; must be in the
285 * usb device's active configuration
286 * @priv: driver data associated with that interface
288 * This is used by usb device drivers that need to claim more than one
289 * interface on a device when probing (audio and acm are current examples).
290 * No device driver should directly modify internal usb_interface or
291 * usb_device structure members.
293 * Few drivers should need to use this routine, since the most natural
294 * way to bind to an interface is to return the private data from
295 * the driver's probe() method.
297 * Callers must own the device lock, so driver probe() entries don't need
298 * extra locking, but other call contexts may need to explicitly claim that
299 * lock.
301 int usb_driver_claim_interface(struct usb_driver *driver,
302 struct usb_interface *iface, void *priv)
304 struct device *dev = &iface->dev;
305 struct usb_device *udev = interface_to_usbdev(iface);
306 int retval = 0;
308 if (dev->driver)
309 return -EBUSY;
311 dev->driver = &driver->drvwrap.driver;
312 usb_set_intfdata(iface, priv);
314 usb_pm_lock(udev);
315 iface->condition = USB_INTERFACE_BOUND;
316 mark_active(iface);
317 iface->pm_usage_cnt = !(driver->supports_autosuspend);
318 usb_pm_unlock(udev);
320 /* if interface was already added, bind now; else let
321 * the future device_add() bind it, bypassing probe()
323 if (device_is_registered(dev))
324 retval = device_bind_driver(dev);
326 return retval;
328 EXPORT_SYMBOL_GPL(usb_driver_claim_interface);
331 * usb_driver_release_interface - unbind a driver from an interface
332 * @driver: the driver to be unbound
333 * @iface: the interface from which it will be unbound
335 * This can be used by drivers to release an interface without waiting
336 * for their disconnect() methods to be called. In typical cases this
337 * also causes the driver disconnect() method to be called.
339 * This call is synchronous, and may not be used in an interrupt context.
340 * Callers must own the device lock, so driver disconnect() entries don't
341 * need extra locking, but other call contexts may need to explicitly claim
342 * that lock.
344 void usb_driver_release_interface(struct usb_driver *driver,
345 struct usb_interface *iface)
347 struct device *dev = &iface->dev;
348 struct usb_device *udev = interface_to_usbdev(iface);
350 /* this should never happen, don't release something that's not ours */
351 if (!dev->driver || dev->driver != &driver->drvwrap.driver)
352 return;
354 /* don't release from within disconnect() */
355 if (iface->condition != USB_INTERFACE_BOUND)
356 return;
358 /* don't release if the interface hasn't been added yet */
359 if (device_is_registered(dev)) {
360 iface->condition = USB_INTERFACE_UNBINDING;
361 device_release_driver(dev);
364 dev->driver = NULL;
365 usb_set_intfdata(iface, NULL);
367 usb_pm_lock(udev);
368 iface->condition = USB_INTERFACE_UNBOUND;
369 mark_quiesced(iface);
370 iface->needs_remote_wakeup = 0;
371 usb_pm_unlock(udev);
373 EXPORT_SYMBOL_GPL(usb_driver_release_interface);
375 /* returns 0 if no match, 1 if match */
376 int usb_match_device(struct usb_device *dev, const struct usb_device_id *id)
378 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
379 id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
380 return 0;
382 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
383 id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
384 return 0;
386 /* No need to test id->bcdDevice_lo != 0, since 0 is never
387 greater than any unsigned number. */
388 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
389 (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice)))
390 return 0;
392 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
393 (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
394 return 0;
396 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
397 (id->bDeviceClass != dev->descriptor.bDeviceClass))
398 return 0;
400 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
401 (id->bDeviceSubClass != dev->descriptor.bDeviceSubClass))
402 return 0;
404 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
405 (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
406 return 0;
408 return 1;
411 /* returns 0 if no match, 1 if match */
412 int usb_match_one_id(struct usb_interface *interface,
413 const struct usb_device_id *id)
415 struct usb_host_interface *intf;
416 struct usb_device *dev;
418 /* proc_connectinfo in devio.c may call us with id == NULL. */
419 if (id == NULL)
420 return 0;
422 intf = interface->cur_altsetting;
423 dev = interface_to_usbdev(interface);
425 if (!usb_match_device(dev, id))
426 return 0;
428 /* The interface class, subclass, and protocol should never be
429 * checked for a match if the device class is Vendor Specific,
430 * unless the match record specifies the Vendor ID. */
431 if (dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC &&
432 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
433 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
434 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
435 USB_DEVICE_ID_MATCH_INT_PROTOCOL)))
436 return 0;
438 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
439 (id->bInterfaceClass != intf->desc.bInterfaceClass))
440 return 0;
442 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
443 (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
444 return 0;
446 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
447 (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
448 return 0;
450 return 1;
452 EXPORT_SYMBOL_GPL(usb_match_one_id);
455 * usb_match_id - find first usb_device_id matching device or interface
456 * @interface: the interface of interest
457 * @id: array of usb_device_id structures, terminated by zero entry
459 * usb_match_id searches an array of usb_device_id's and returns
460 * the first one matching the device or interface, or null.
461 * This is used when binding (or rebinding) a driver to an interface.
462 * Most USB device drivers will use this indirectly, through the usb core,
463 * but some layered driver frameworks use it directly.
464 * These device tables are exported with MODULE_DEVICE_TABLE, through
465 * modutils, to support the driver loading functionality of USB hotplugging.
467 * What Matches:
469 * The "match_flags" element in a usb_device_id controls which
470 * members are used. If the corresponding bit is set, the
471 * value in the device_id must match its corresponding member
472 * in the device or interface descriptor, or else the device_id
473 * does not match.
475 * "driver_info" is normally used only by device drivers,
476 * but you can create a wildcard "matches anything" usb_device_id
477 * as a driver's "modules.usbmap" entry if you provide an id with
478 * only a nonzero "driver_info" field. If you do this, the USB device
479 * driver's probe() routine should use additional intelligence to
480 * decide whether to bind to the specified interface.
482 * What Makes Good usb_device_id Tables:
484 * The match algorithm is very simple, so that intelligence in
485 * driver selection must come from smart driver id records.
486 * Unless you have good reasons to use another selection policy,
487 * provide match elements only in related groups, and order match
488 * specifiers from specific to general. Use the macros provided
489 * for that purpose if you can.
491 * The most specific match specifiers use device descriptor
492 * data. These are commonly used with product-specific matches;
493 * the USB_DEVICE macro lets you provide vendor and product IDs,
494 * and you can also match against ranges of product revisions.
495 * These are widely used for devices with application or vendor
496 * specific bDeviceClass values.
498 * Matches based on device class/subclass/protocol specifications
499 * are slightly more general; use the USB_DEVICE_INFO macro, or
500 * its siblings. These are used with single-function devices
501 * where bDeviceClass doesn't specify that each interface has
502 * its own class.
504 * Matches based on interface class/subclass/protocol are the
505 * most general; they let drivers bind to any interface on a
506 * multiple-function device. Use the USB_INTERFACE_INFO
507 * macro, or its siblings, to match class-per-interface style
508 * devices (as recorded in bInterfaceClass).
510 * Note that an entry created by USB_INTERFACE_INFO won't match
511 * any interface if the device class is set to Vendor-Specific.
512 * This is deliberate; according to the USB spec the meanings of
513 * the interface class/subclass/protocol for these devices are also
514 * vendor-specific, and hence matching against a standard product
515 * class wouldn't work anyway. If you really want to use an
516 * interface-based match for such a device, create a match record
517 * that also specifies the vendor ID. (Unforunately there isn't a
518 * standard macro for creating records like this.)
520 * Within those groups, remember that not all combinations are
521 * meaningful. For example, don't give a product version range
522 * without vendor and product IDs; or specify a protocol without
523 * its associated class and subclass.
525 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
526 const struct usb_device_id *id)
528 /* proc_connectinfo in devio.c may call us with id == NULL. */
529 if (id == NULL)
530 return NULL;
532 /* It is important to check that id->driver_info is nonzero,
533 since an entry that is all zeroes except for a nonzero
534 id->driver_info is the way to create an entry that
535 indicates that the driver want to examine every
536 device and interface. */
537 for (; id->idVendor || id->idProduct || id->bDeviceClass ||
538 id->bInterfaceClass || id->driver_info; id++) {
539 if (usb_match_one_id(interface, id))
540 return id;
543 return NULL;
545 EXPORT_SYMBOL_GPL(usb_match_id);
547 static int usb_device_match(struct device *dev, struct device_driver *drv)
549 /* devices and interfaces are handled separately */
550 if (is_usb_device(dev)) {
552 /* interface drivers never match devices */
553 if (!is_usb_device_driver(drv))
554 return 0;
556 /* TODO: Add real matching code */
557 return 1;
559 } else {
560 struct usb_interface *intf;
561 struct usb_driver *usb_drv;
562 const struct usb_device_id *id;
564 /* device drivers never match interfaces */
565 if (is_usb_device_driver(drv))
566 return 0;
568 intf = to_usb_interface(dev);
569 usb_drv = to_usb_driver(drv);
571 id = usb_match_id(intf, usb_drv->id_table);
572 if (id)
573 return 1;
575 id = usb_match_dynamic_id(intf, usb_drv);
576 if (id)
577 return 1;
580 return 0;
583 #ifdef CONFIG_HOTPLUG
584 static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
586 struct usb_device *usb_dev;
588 /* driver is often null here; dev_dbg() would oops */
589 pr_debug("usb %s: uevent\n", dev_name(dev));
591 if (is_usb_device(dev))
592 usb_dev = to_usb_device(dev);
593 else {
594 struct usb_interface *intf = to_usb_interface(dev);
595 usb_dev = interface_to_usbdev(intf);
598 if (usb_dev->devnum < 0) {
599 pr_debug("usb %s: already deleted?\n", dev_name(dev));
600 return -ENODEV;
602 if (!usb_dev->bus) {
603 pr_debug("usb %s: bus removed?\n", dev_name(dev));
604 return -ENODEV;
607 #ifdef CONFIG_USB_DEVICEFS
608 /* If this is available, userspace programs can directly read
609 * all the device descriptors we don't tell them about. Or
610 * act as usermode drivers.
612 if (add_uevent_var(env, "DEVICE=/proc/bus/usb/%03d/%03d",
613 usb_dev->bus->busnum, usb_dev->devnum))
614 return -ENOMEM;
615 #endif
617 /* per-device configurations are common */
618 if (add_uevent_var(env, "PRODUCT=%x/%x/%x",
619 le16_to_cpu(usb_dev->descriptor.idVendor),
620 le16_to_cpu(usb_dev->descriptor.idProduct),
621 le16_to_cpu(usb_dev->descriptor.bcdDevice)))
622 return -ENOMEM;
624 /* class-based driver binding models */
625 if (add_uevent_var(env, "TYPE=%d/%d/%d",
626 usb_dev->descriptor.bDeviceClass,
627 usb_dev->descriptor.bDeviceSubClass,
628 usb_dev->descriptor.bDeviceProtocol))
629 return -ENOMEM;
631 return 0;
634 #else
636 static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
638 return -ENODEV;
640 #endif /* CONFIG_HOTPLUG */
643 * usb_register_device_driver - register a USB device (not interface) driver
644 * @new_udriver: USB operations for the device driver
645 * @owner: module owner of this driver.
647 * Registers a USB device driver with the USB core. The list of
648 * unattached devices will be rescanned whenever a new driver is
649 * added, allowing the new driver to attach to any recognized devices.
650 * Returns a negative error code on failure and 0 on success.
652 int usb_register_device_driver(struct usb_device_driver *new_udriver,
653 struct module *owner)
655 int retval = 0;
657 if (usb_disabled())
658 return -ENODEV;
660 new_udriver->drvwrap.for_devices = 1;
661 new_udriver->drvwrap.driver.name = (char *) new_udriver->name;
662 new_udriver->drvwrap.driver.bus = &usb_bus_type;
663 new_udriver->drvwrap.driver.probe = usb_probe_device;
664 new_udriver->drvwrap.driver.remove = usb_unbind_device;
665 new_udriver->drvwrap.driver.owner = owner;
667 retval = driver_register(&new_udriver->drvwrap.driver);
669 if (!retval) {
670 pr_info("%s: registered new device driver %s\n",
671 usbcore_name, new_udriver->name);
672 usbfs_update_special();
673 } else {
674 printk(KERN_ERR "%s: error %d registering device "
675 " driver %s\n",
676 usbcore_name, retval, new_udriver->name);
679 return retval;
681 EXPORT_SYMBOL_GPL(usb_register_device_driver);
684 * usb_deregister_device_driver - unregister a USB device (not interface) driver
685 * @udriver: USB operations of the device driver to unregister
686 * Context: must be able to sleep
688 * Unlinks the specified driver from the internal USB driver list.
690 void usb_deregister_device_driver(struct usb_device_driver *udriver)
692 pr_info("%s: deregistering device driver %s\n",
693 usbcore_name, udriver->name);
695 driver_unregister(&udriver->drvwrap.driver);
696 usbfs_update_special();
698 EXPORT_SYMBOL_GPL(usb_deregister_device_driver);
701 * usb_register_driver - register a USB interface driver
702 * @new_driver: USB operations for the interface driver
703 * @owner: module owner of this driver.
704 * @mod_name: module name string
706 * Registers a USB interface driver with the USB core. The list of
707 * unattached interfaces will be rescanned whenever a new driver is
708 * added, allowing the new driver to attach to any recognized interfaces.
709 * Returns a negative error code on failure and 0 on success.
711 * NOTE: if you want your driver to use the USB major number, you must call
712 * usb_register_dev() to enable that functionality. This function no longer
713 * takes care of that.
715 int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
716 const char *mod_name)
718 int retval = 0;
720 if (usb_disabled())
721 return -ENODEV;
723 new_driver->drvwrap.for_devices = 0;
724 new_driver->drvwrap.driver.name = (char *) new_driver->name;
725 new_driver->drvwrap.driver.bus = &usb_bus_type;
726 new_driver->drvwrap.driver.probe = usb_probe_interface;
727 new_driver->drvwrap.driver.remove = usb_unbind_interface;
728 new_driver->drvwrap.driver.owner = owner;
729 new_driver->drvwrap.driver.mod_name = mod_name;
730 spin_lock_init(&new_driver->dynids.lock);
731 INIT_LIST_HEAD(&new_driver->dynids.list);
733 retval = driver_register(&new_driver->drvwrap.driver);
735 if (!retval) {
736 pr_info("%s: registered new interface driver %s\n",
737 usbcore_name, new_driver->name);
738 usbfs_update_special();
739 usb_create_newid_file(new_driver);
740 } else {
741 printk(KERN_ERR "%s: error %d registering interface "
742 " driver %s\n",
743 usbcore_name, retval, new_driver->name);
746 return retval;
748 EXPORT_SYMBOL_GPL(usb_register_driver);
751 * usb_deregister - unregister a USB interface driver
752 * @driver: USB operations of the interface driver to unregister
753 * Context: must be able to sleep
755 * Unlinks the specified driver from the internal USB driver list.
757 * NOTE: If you called usb_register_dev(), you still need to call
758 * usb_deregister_dev() to clean up your driver's allocated minor numbers,
759 * this * call will no longer do it for you.
761 void usb_deregister(struct usb_driver *driver)
763 pr_info("%s: deregistering interface driver %s\n",
764 usbcore_name, driver->name);
766 usb_remove_newid_file(driver);
767 usb_free_dynids(driver);
768 driver_unregister(&driver->drvwrap.driver);
770 usbfs_update_special();
772 EXPORT_SYMBOL_GPL(usb_deregister);
774 #ifdef CONFIG_PM
776 /* Caller has locked udev's pm_mutex */
777 static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
779 struct usb_device_driver *udriver;
780 int status = 0;
782 if (udev->state == USB_STATE_NOTATTACHED ||
783 udev->state == USB_STATE_SUSPENDED)
784 goto done;
786 /* For devices that don't have a driver, we do a generic suspend. */
787 if (udev->dev.driver)
788 udriver = to_usb_device_driver(udev->dev.driver);
789 else {
790 udev->do_remote_wakeup = 0;
791 udriver = &usb_generic_driver;
793 status = udriver->suspend(udev, msg);
795 done:
796 dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
797 return status;
800 /* Caller has locked udev's pm_mutex */
801 static int usb_resume_device(struct usb_device *udev)
803 struct usb_device_driver *udriver;
804 int status = 0;
806 if (udev->state == USB_STATE_NOTATTACHED)
807 goto done;
809 /* Can't resume it if it doesn't have a driver. */
810 if (udev->dev.driver == NULL) {
811 status = -ENOTCONN;
812 goto done;
815 if (udev->quirks & USB_QUIRK_RESET_RESUME)
816 udev->reset_resume = 1;
818 udriver = to_usb_device_driver(udev->dev.driver);
819 status = udriver->resume(udev);
821 done:
822 dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
823 if (status == 0)
824 udev->autoresume_disabled = 0;
825 return status;
828 /* Caller has locked intf's usb_device's pm mutex */
829 static int usb_suspend_interface(struct usb_interface *intf, pm_message_t msg)
831 struct usb_driver *driver;
832 int status = 0;
834 /* with no hardware, USB interfaces only use FREEZE and ON states */
835 if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
836 !is_active(intf))
837 goto done;
839 if (intf->condition == USB_INTERFACE_UNBOUND) /* This can't happen */
840 goto done;
841 driver = to_usb_driver(intf->dev.driver);
843 if (driver->suspend && driver->resume) {
844 status = driver->suspend(intf, msg);
845 if (status == 0)
846 mark_quiesced(intf);
847 else if (!interface_to_usbdev(intf)->auto_pm)
848 dev_err(&intf->dev, "%s error %d\n",
849 "suspend", status);
850 } else {
852 * FIXME else if there's no suspend method, disconnect...
853 * Not possible if auto_pm is set...
855 dev_warn(&intf->dev, "no suspend for driver %s?\n",
856 driver->name);
857 mark_quiesced(intf);
860 done:
861 dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
862 return status;
865 /* Caller has locked intf's usb_device's pm_mutex */
866 static int usb_resume_interface(struct usb_interface *intf, int reset_resume)
868 struct usb_driver *driver;
869 int status = 0;
871 if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
872 is_active(intf))
873 goto done;
875 /* Don't let autoresume interfere with unbinding */
876 if (intf->condition == USB_INTERFACE_UNBINDING)
877 goto done;
879 /* Can't resume it if it doesn't have a driver. */
880 if (intf->condition == USB_INTERFACE_UNBOUND) {
881 status = -ENOTCONN;
882 goto done;
884 driver = to_usb_driver(intf->dev.driver);
886 if (reset_resume) {
887 if (driver->reset_resume) {
888 status = driver->reset_resume(intf);
889 if (status)
890 dev_err(&intf->dev, "%s error %d\n",
891 "reset_resume", status);
892 } else {
893 /* status = -EOPNOTSUPP; */
894 dev_warn(&intf->dev, "no %s for driver %s?\n",
895 "reset_resume", driver->name);
897 } else {
898 if (driver->resume) {
899 status = driver->resume(intf);
900 if (status)
901 dev_err(&intf->dev, "%s error %d\n",
902 "resume", status);
903 } else {
904 /* status = -EOPNOTSUPP; */
905 dev_warn(&intf->dev, "no %s for driver %s?\n",
906 "resume", driver->name);
910 done:
911 dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
912 if (status == 0)
913 mark_active(intf);
915 /* FIXME: Unbind the driver and reprobe if the resume failed
916 * (not possible if auto_pm is set) */
917 return status;
920 #ifdef CONFIG_USB_SUSPEND
922 /* Internal routine to check whether we may autosuspend a device. */
923 static int autosuspend_check(struct usb_device *udev, int reschedule)
925 int i;
926 struct usb_interface *intf;
927 unsigned long suspend_time, j;
929 /* For autosuspend, fail fast if anything is in use or autosuspend
930 * is disabled. Also fail if any interfaces require remote wakeup
931 * but it isn't available.
933 if (udev->pm_usage_cnt > 0)
934 return -EBUSY;
935 if (udev->autosuspend_delay < 0 || udev->autosuspend_disabled)
936 return -EPERM;
938 suspend_time = udev->last_busy + udev->autosuspend_delay;
939 if (udev->actconfig) {
940 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
941 intf = udev->actconfig->interface[i];
942 if (!is_active(intf))
943 continue;
944 if (intf->pm_usage_cnt > 0)
945 return -EBUSY;
946 if (intf->needs_remote_wakeup &&
947 !udev->do_remote_wakeup) {
948 dev_dbg(&udev->dev, "remote wakeup needed "
949 "for autosuspend\n");
950 return -EOPNOTSUPP;
953 /* Don't allow autosuspend if the device will need
954 * a reset-resume and any of its interface drivers
955 * doesn't include support.
957 if (udev->quirks & USB_QUIRK_RESET_RESUME) {
958 struct usb_driver *driver;
960 driver = to_usb_driver(intf->dev.driver);
961 if (!driver->reset_resume)
962 return -EOPNOTSUPP;
967 /* If everything is okay but the device hasn't been idle for long
968 * enough, queue a delayed autosuspend request. If the device
969 * _has_ been idle for long enough and the reschedule flag is set,
970 * likewise queue a delayed (1 second) autosuspend request.
972 j = jiffies;
973 if (time_before(j, suspend_time))
974 reschedule = 1;
975 else
976 suspend_time = j + HZ;
977 if (reschedule) {
978 if (!timer_pending(&udev->autosuspend.timer)) {
979 queue_delayed_work(ksuspend_usb_wq, &udev->autosuspend,
980 round_jiffies_relative(suspend_time - j));
982 return -EAGAIN;
984 return 0;
987 #else
989 static inline int autosuspend_check(struct usb_device *udev, int reschedule)
991 return 0;
994 #endif /* CONFIG_USB_SUSPEND */
997 * usb_suspend_both - suspend a USB device and its interfaces
998 * @udev: the usb_device to suspend
999 * @msg: Power Management message describing this state transition
1001 * This is the central routine for suspending USB devices. It calls the
1002 * suspend methods for all the interface drivers in @udev and then calls
1003 * the suspend method for @udev itself. If an error occurs at any stage,
1004 * all the interfaces which were suspended are resumed so that they remain
1005 * in the same state as the device.
1007 * If an autosuspend is in progress (@udev->auto_pm is set), the routine
1008 * checks first to make sure that neither the device itself or any of its
1009 * active interfaces is in use (pm_usage_cnt is greater than 0). If they
1010 * are, the autosuspend fails.
1012 * If the suspend succeeds, the routine recursively queues an autosuspend
1013 * request for @udev's parent device, thereby propagating the change up
1014 * the device tree. If all of the parent's children are now suspended,
1015 * the parent will autosuspend in turn.
1017 * The suspend method calls are subject to mutual exclusion under control
1018 * of @udev's pm_mutex. Many of these calls are also under the protection
1019 * of @udev's device lock (including all requests originating outside the
1020 * USB subsystem), but autosuspend requests generated by a child device or
1021 * interface driver may not be. Usbcore will insure that the method calls
1022 * do not arrive during bind, unbind, or reset operations. However, drivers
1023 * must be prepared to handle suspend calls arriving at unpredictable times.
1024 * The only way to block such calls is to do an autoresume (preventing
1025 * autosuspends) while holding @udev's device lock (preventing outside
1026 * suspends).
1028 * The caller must hold @udev->pm_mutex.
1030 * This routine can run only in process context.
1032 static int usb_suspend_both(struct usb_device *udev, pm_message_t msg)
1034 int status = 0;
1035 int i = 0;
1036 struct usb_interface *intf;
1037 struct usb_device *parent = udev->parent;
1039 if (udev->state == USB_STATE_NOTATTACHED ||
1040 udev->state == USB_STATE_SUSPENDED)
1041 goto done;
1043 udev->do_remote_wakeup = device_may_wakeup(&udev->dev);
1045 if (udev->auto_pm) {
1046 status = autosuspend_check(udev, 0);
1047 if (status < 0)
1048 goto done;
1051 /* Suspend all the interfaces and then udev itself */
1052 if (udev->actconfig) {
1053 for (; i < udev->actconfig->desc.bNumInterfaces; i++) {
1054 intf = udev->actconfig->interface[i];
1055 status = usb_suspend_interface(intf, msg);
1056 if (status != 0)
1057 break;
1060 if (status == 0)
1061 status = usb_suspend_device(udev, msg);
1063 /* If the suspend failed, resume interfaces that did get suspended */
1064 if (status != 0) {
1065 while (--i >= 0) {
1066 intf = udev->actconfig->interface[i];
1067 usb_resume_interface(intf, 0);
1070 /* Try another autosuspend when the interfaces aren't busy */
1071 if (udev->auto_pm)
1072 autosuspend_check(udev, status == -EBUSY);
1074 /* If the suspend succeeded then prevent any more URB submissions,
1075 * flush any outstanding URBs, and propagate the suspend up the tree.
1077 } else {
1078 cancel_delayed_work(&udev->autosuspend);
1079 udev->can_submit = 0;
1080 for (i = 0; i < 16; ++i) {
1081 usb_hcd_flush_endpoint(udev, udev->ep_out[i]);
1082 usb_hcd_flush_endpoint(udev, udev->ep_in[i]);
1085 /* If this is just a FREEZE or a PRETHAW, udev might
1086 * not really be suspended. Only true suspends get
1087 * propagated up the device tree.
1089 if (parent && udev->state == USB_STATE_SUSPENDED)
1090 usb_autosuspend_device(parent);
1093 done:
1094 dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1095 return status;
1099 * usb_resume_both - resume a USB device and its interfaces
1100 * @udev: the usb_device to resume
1102 * This is the central routine for resuming USB devices. It calls the
1103 * the resume method for @udev and then calls the resume methods for all
1104 * the interface drivers in @udev.
1106 * Before starting the resume, the routine calls itself recursively for
1107 * the parent device of @udev, thereby propagating the change up the device
1108 * tree and assuring that @udev will be able to resume. If the parent is
1109 * unable to resume successfully, the routine fails.
1111 * The resume method calls are subject to mutual exclusion under control
1112 * of @udev's pm_mutex. Many of these calls are also under the protection
1113 * of @udev's device lock (including all requests originating outside the
1114 * USB subsystem), but autoresume requests generated by a child device or
1115 * interface driver may not be. Usbcore will insure that the method calls
1116 * do not arrive during bind, unbind, or reset operations. However, drivers
1117 * must be prepared to handle resume calls arriving at unpredictable times.
1118 * The only way to block such calls is to do an autoresume (preventing
1119 * other autoresumes) while holding @udev's device lock (preventing outside
1120 * resumes).
1122 * The caller must hold @udev->pm_mutex.
1124 * This routine can run only in process context.
1126 static int usb_resume_both(struct usb_device *udev)
1128 int status = 0;
1129 int i;
1130 struct usb_interface *intf;
1131 struct usb_device *parent = udev->parent;
1133 cancel_delayed_work(&udev->autosuspend);
1134 if (udev->state == USB_STATE_NOTATTACHED) {
1135 status = -ENODEV;
1136 goto done;
1138 udev->can_submit = 1;
1140 /* Propagate the resume up the tree, if necessary */
1141 if (udev->state == USB_STATE_SUSPENDED) {
1142 if (udev->auto_pm && udev->autoresume_disabled) {
1143 status = -EPERM;
1144 goto done;
1146 if (parent) {
1147 status = usb_autoresume_device(parent);
1148 if (status == 0) {
1149 status = usb_resume_device(udev);
1150 if (status || udev->state ==
1151 USB_STATE_NOTATTACHED) {
1152 usb_autosuspend_device(parent);
1154 /* It's possible usb_resume_device()
1155 * failed after the port was
1156 * unsuspended, causing udev to be
1157 * logically disconnected. We don't
1158 * want usb_disconnect() to autosuspend
1159 * the parent again, so tell it that
1160 * udev disconnected while still
1161 * suspended. */
1162 if (udev->state ==
1163 USB_STATE_NOTATTACHED)
1164 udev->discon_suspended = 1;
1167 } else {
1169 /* We can't progagate beyond the USB subsystem,
1170 * so if a root hub's controller is suspended
1171 * then we're stuck. */
1172 status = usb_resume_device(udev);
1174 } else if (udev->reset_resume)
1175 status = usb_resume_device(udev);
1177 if (status == 0 && udev->actconfig) {
1178 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1179 intf = udev->actconfig->interface[i];
1180 usb_resume_interface(intf, udev->reset_resume);
1184 done:
1185 dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1186 if (!status)
1187 udev->reset_resume = 0;
1188 return status;
1191 #ifdef CONFIG_USB_SUSPEND
1193 /* Internal routine to adjust a device's usage counter and change
1194 * its autosuspend state.
1196 static int usb_autopm_do_device(struct usb_device *udev, int inc_usage_cnt)
1198 int status = 0;
1200 usb_pm_lock(udev);
1201 udev->auto_pm = 1;
1202 udev->pm_usage_cnt += inc_usage_cnt;
1203 WARN_ON(udev->pm_usage_cnt < 0);
1204 if (inc_usage_cnt)
1205 udev->last_busy = jiffies;
1206 if (inc_usage_cnt >= 0 && udev->pm_usage_cnt > 0) {
1207 if (udev->state == USB_STATE_SUSPENDED)
1208 status = usb_resume_both(udev);
1209 if (status != 0)
1210 udev->pm_usage_cnt -= inc_usage_cnt;
1211 else if (inc_usage_cnt)
1212 udev->last_busy = jiffies;
1213 } else if (inc_usage_cnt <= 0 && udev->pm_usage_cnt <= 0) {
1214 status = usb_suspend_both(udev, PMSG_SUSPEND);
1216 usb_pm_unlock(udev);
1217 return status;
1220 /* usb_autosuspend_work - callback routine to autosuspend a USB device */
1221 void usb_autosuspend_work(struct work_struct *work)
1223 struct usb_device *udev =
1224 container_of(work, struct usb_device, autosuspend.work);
1226 usb_autopm_do_device(udev, 0);
1230 * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
1231 * @udev: the usb_device to autosuspend
1233 * This routine should be called when a core subsystem is finished using
1234 * @udev and wants to allow it to autosuspend. Examples would be when
1235 * @udev's device file in usbfs is closed or after a configuration change.
1237 * @udev's usage counter is decremented. If it or any of the usage counters
1238 * for an active interface is greater than 0, no autosuspend request will be
1239 * queued. (If an interface driver does not support autosuspend then its
1240 * usage counter is permanently positive.) Furthermore, if an interface
1241 * driver requires remote-wakeup capability during autosuspend but remote
1242 * wakeup is disabled, the autosuspend will fail.
1244 * Often the caller will hold @udev's device lock, but this is not
1245 * necessary.
1247 * This routine can run only in process context.
1249 void usb_autosuspend_device(struct usb_device *udev)
1251 int status;
1253 status = usb_autopm_do_device(udev, -1);
1254 dev_vdbg(&udev->dev, "%s: cnt %d\n",
1255 __func__, udev->pm_usage_cnt);
1259 * usb_try_autosuspend_device - attempt an autosuspend of a USB device and its interfaces
1260 * @udev: the usb_device to autosuspend
1262 * This routine should be called when a core subsystem thinks @udev may
1263 * be ready to autosuspend.
1265 * @udev's usage counter left unchanged. If it or any of the usage counters
1266 * for an active interface is greater than 0, or autosuspend is not allowed
1267 * for any other reason, no autosuspend request will be queued.
1269 * This routine can run only in process context.
1271 void usb_try_autosuspend_device(struct usb_device *udev)
1273 usb_autopm_do_device(udev, 0);
1274 dev_vdbg(&udev->dev, "%s: cnt %d\n",
1275 __func__, udev->pm_usage_cnt);
1279 * usb_autoresume_device - immediately autoresume a USB device and its interfaces
1280 * @udev: the usb_device to autoresume
1282 * This routine should be called when a core subsystem wants to use @udev
1283 * and needs to guarantee that it is not suspended. No autosuspend will
1284 * occur until usb_autosuspend_device is called. (Note that this will not
1285 * prevent suspend events originating in the PM core.) Examples would be
1286 * when @udev's device file in usbfs is opened or when a remote-wakeup
1287 * request is received.
1289 * @udev's usage counter is incremented to prevent subsequent autosuspends.
1290 * However if the autoresume fails then the usage counter is re-decremented.
1292 * Often the caller will hold @udev's device lock, but this is not
1293 * necessary (and attempting it might cause deadlock).
1295 * This routine can run only in process context.
1297 int usb_autoresume_device(struct usb_device *udev)
1299 int status;
1301 status = usb_autopm_do_device(udev, 1);
1302 dev_vdbg(&udev->dev, "%s: status %d cnt %d\n",
1303 __func__, status, udev->pm_usage_cnt);
1304 return status;
1307 /* Internal routine to adjust an interface's usage counter and change
1308 * its device's autosuspend state.
1310 static int usb_autopm_do_interface(struct usb_interface *intf,
1311 int inc_usage_cnt)
1313 struct usb_device *udev = interface_to_usbdev(intf);
1314 int status = 0;
1316 usb_pm_lock(udev);
1317 if (intf->condition == USB_INTERFACE_UNBOUND)
1318 status = -ENODEV;
1319 else {
1320 udev->auto_pm = 1;
1321 intf->pm_usage_cnt += inc_usage_cnt;
1322 udev->last_busy = jiffies;
1323 if (inc_usage_cnt >= 0 && intf->pm_usage_cnt > 0) {
1324 if (udev->state == USB_STATE_SUSPENDED)
1325 status = usb_resume_both(udev);
1326 if (status != 0)
1327 intf->pm_usage_cnt -= inc_usage_cnt;
1328 else
1329 udev->last_busy = jiffies;
1330 } else if (inc_usage_cnt <= 0 && intf->pm_usage_cnt <= 0) {
1331 status = usb_suspend_both(udev, PMSG_SUSPEND);
1334 usb_pm_unlock(udev);
1335 return status;
1339 * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
1340 * @intf: the usb_interface whose counter should be decremented
1342 * This routine should be called by an interface driver when it is
1343 * finished using @intf and wants to allow it to autosuspend. A typical
1344 * example would be a character-device driver when its device file is
1345 * closed.
1347 * The routine decrements @intf's usage counter. When the counter reaches
1348 * 0, a delayed autosuspend request for @intf's device is queued. When
1349 * the delay expires, if @intf->pm_usage_cnt is still <= 0 along with all
1350 * the other usage counters for the sibling interfaces and @intf's
1351 * usb_device, the device and all its interfaces will be autosuspended.
1353 * Note that @intf->pm_usage_cnt is owned by the interface driver. The
1354 * core will not change its value other than the increment and decrement
1355 * in usb_autopm_get_interface and usb_autopm_put_interface. The driver
1356 * may use this simple counter-oriented discipline or may set the value
1357 * any way it likes.
1359 * If the driver has set @intf->needs_remote_wakeup then autosuspend will
1360 * take place only if the device's remote-wakeup facility is enabled.
1362 * Suspend method calls queued by this routine can arrive at any time
1363 * while @intf is resumed and its usage counter is equal to 0. They are
1364 * not protected by the usb_device's lock but only by its pm_mutex.
1365 * Drivers must provide their own synchronization.
1367 * This routine can run only in process context.
1369 void usb_autopm_put_interface(struct usb_interface *intf)
1371 int status;
1373 status = usb_autopm_do_interface(intf, -1);
1374 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1375 __func__, status, intf->pm_usage_cnt);
1377 EXPORT_SYMBOL_GPL(usb_autopm_put_interface);
1380 * usb_autopm_get_interface - increment a USB interface's PM-usage counter
1381 * @intf: the usb_interface whose counter should be incremented
1383 * This routine should be called by an interface driver when it wants to
1384 * use @intf and needs to guarantee that it is not suspended. In addition,
1385 * the routine prevents @intf from being autosuspended subsequently. (Note
1386 * that this will not prevent suspend events originating in the PM core.)
1387 * This prevention will persist until usb_autopm_put_interface() is called
1388 * or @intf is unbound. A typical example would be a character-device
1389 * driver when its device file is opened.
1392 * The routine increments @intf's usage counter. (However if the
1393 * autoresume fails then the counter is re-decremented.) So long as the
1394 * counter is greater than 0, autosuspend will not be allowed for @intf
1395 * or its usb_device. When the driver is finished using @intf it should
1396 * call usb_autopm_put_interface() to decrement the usage counter and
1397 * queue a delayed autosuspend request (if the counter is <= 0).
1400 * Note that @intf->pm_usage_cnt is owned by the interface driver. The
1401 * core will not change its value other than the increment and decrement
1402 * in usb_autopm_get_interface and usb_autopm_put_interface. The driver
1403 * may use this simple counter-oriented discipline or may set the value
1404 * any way it likes.
1406 * Resume method calls generated by this routine can arrive at any time
1407 * while @intf is suspended. They are not protected by the usb_device's
1408 * lock but only by its pm_mutex. Drivers must provide their own
1409 * synchronization.
1411 * This routine can run only in process context.
1413 int usb_autopm_get_interface(struct usb_interface *intf)
1415 int status;
1417 status = usb_autopm_do_interface(intf, 1);
1418 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1419 __func__, status, intf->pm_usage_cnt);
1420 return status;
1422 EXPORT_SYMBOL_GPL(usb_autopm_get_interface);
1425 * usb_autopm_set_interface - set a USB interface's autosuspend state
1426 * @intf: the usb_interface whose state should be set
1428 * This routine sets the autosuspend state of @intf's device according
1429 * to @intf's usage counter, which the caller must have set previously.
1430 * If the counter is <= 0, the device is autosuspended (if it isn't
1431 * already suspended and if nothing else prevents the autosuspend). If
1432 * the counter is > 0, the device is autoresumed (if it isn't already
1433 * awake).
1435 int usb_autopm_set_interface(struct usb_interface *intf)
1437 int status;
1439 status = usb_autopm_do_interface(intf, 0);
1440 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1441 __func__, status, intf->pm_usage_cnt);
1442 return status;
1444 EXPORT_SYMBOL_GPL(usb_autopm_set_interface);
1446 #else
1448 void usb_autosuspend_work(struct work_struct *work)
1451 #endif /* CONFIG_USB_SUSPEND */
1454 * usb_external_suspend_device - external suspend of a USB device and its interfaces
1455 * @udev: the usb_device to suspend
1456 * @msg: Power Management message describing this state transition
1458 * This routine handles external suspend requests: ones not generated
1459 * internally by a USB driver (autosuspend) but rather coming from the user
1460 * (via sysfs) or the PM core (system sleep). The suspend will be carried
1461 * out regardless of @udev's usage counter or those of its interfaces,
1462 * and regardless of whether or not remote wakeup is enabled. Of course,
1463 * interface drivers still have the option of failing the suspend (if
1464 * there are unsuspended children, for example).
1466 * The caller must hold @udev's device lock.
1468 int usb_external_suspend_device(struct usb_device *udev, pm_message_t msg)
1470 int status;
1472 usb_pm_lock(udev);
1473 udev->auto_pm = 0;
1474 status = usb_suspend_both(udev, msg);
1475 usb_pm_unlock(udev);
1476 return status;
1480 * usb_external_resume_device - external resume of a USB device and its interfaces
1481 * @udev: the usb_device to resume
1483 * This routine handles external resume requests: ones not generated
1484 * internally by a USB driver (autoresume) but rather coming from the user
1485 * (via sysfs), the PM core (system resume), or the device itself (remote
1486 * wakeup). @udev's usage counter is unaffected.
1488 * The caller must hold @udev's device lock.
1490 int usb_external_resume_device(struct usb_device *udev)
1492 int status;
1494 usb_pm_lock(udev);
1495 udev->auto_pm = 0;
1496 status = usb_resume_both(udev);
1497 udev->last_busy = jiffies;
1498 usb_pm_unlock(udev);
1500 /* Now that the device is awake, we can start trying to autosuspend
1501 * it again. */
1502 if (status == 0)
1503 usb_try_autosuspend_device(udev);
1504 return status;
1507 static int usb_suspend(struct device *dev, pm_message_t message)
1509 struct usb_device *udev;
1511 if (!is_usb_device(dev)) /* Ignore PM for interfaces */
1512 return 0;
1513 udev = to_usb_device(dev);
1515 /* If udev is already suspended, we can skip this suspend and
1516 * we should also skip the upcoming system resume. High-speed
1517 * root hubs are an exception; they need to resume whenever the
1518 * system wakes up in order for USB-PERSIST port handover to work
1519 * properly.
1521 if (udev->state == USB_STATE_SUSPENDED) {
1522 if (udev->parent || udev->speed != USB_SPEED_HIGH)
1523 udev->skip_sys_resume = 1;
1524 return 0;
1527 udev->skip_sys_resume = 0;
1528 return usb_external_suspend_device(udev, message);
1531 static int usb_resume(struct device *dev)
1533 struct usb_device *udev;
1535 if (!is_usb_device(dev)) /* Ignore PM for interfaces */
1536 return 0;
1537 udev = to_usb_device(dev);
1539 /* If udev->skip_sys_resume is set then udev was already suspended
1540 * when the system suspend started, so we don't want to resume
1541 * udev during this system wakeup. However a reset-resume counts
1542 * as a wakeup event, so allow a reset-resume to occur if remote
1543 * wakeup is enabled. */
1544 if (udev->skip_sys_resume) {
1545 if (!(udev->reset_resume && udev->do_remote_wakeup))
1546 return -EHOSTUNREACH;
1548 return usb_external_resume_device(udev);
1551 #else
1553 #define usb_suspend NULL
1554 #define usb_resume NULL
1556 #endif /* CONFIG_PM */
1558 struct bus_type usb_bus_type = {
1559 .name = "usb",
1560 .match = usb_device_match,
1561 .uevent = usb_uevent,
1562 .suspend = usb_suspend,
1563 .resume = usb_resume,