blob: ca43a6f824abd62d7acbb6549f18e8f82e7d3752 [file] [log] [blame]
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -08001/*
2 * drivers/usb/driver.c - most of the driver model stuff for usb
3 *
4 * (C) Copyright 2005 Greg Kroah-Hartman <gregkh@suse.de>
5 *
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
17 *
18 * NOTE! This is not actually a driver at all, rather this is
19 * just a collection of helper routines that implement the
Alan Stern36e56a32006-07-01 22:08:06 -040020 * matching, probing, releasing, suspending and resuming for
21 * real drivers.
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -080022 *
23 */
24
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -080025#include <linux/device.h>
26#include <linux/usb.h>
Alan Stern6bc6cff2007-05-04 11:53:03 -040027#include <linux/usb/quirks.h>
Alan Sternbd859282006-09-19 10:14:07 -040028#include <linux/workqueue.h>
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -080029#include "hcd.h"
30#include "usb.h"
31
Alan Stern20dfdad2007-05-22 11:50:17 -040032
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080033#ifdef CONFIG_HOTPLUG
34
35/*
36 * Adds a new dynamic USBdevice ID to this driver,
37 * and cause the driver to probe for all devices again.
38 */
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +010039ssize_t usb_store_new_id(struct usb_dynids *dynids,
40 struct device_driver *driver,
41 const char *buf, size_t count)
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080042{
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080043 struct usb_dynid *dynid;
44 u32 idVendor = 0;
45 u32 idProduct = 0;
46 int fields = 0;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -070047 int retval = 0;
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080048
49 fields = sscanf(buf, "%x %x", &idVendor, &idProduct);
50 if (fields < 2)
51 return -EINVAL;
52
53 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
54 if (!dynid)
55 return -ENOMEM;
56
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;
61
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +010062 spin_lock(&dynids->lock);
Nathael Pajanie5dd0112007-09-04 11:46:23 +020063 list_add_tail(&dynid->node, &dynids->list);
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +010064 spin_unlock(&dynids->lock);
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080065
66 if (get_driver(driver)) {
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -070067 retval = driver_attach(driver);
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080068 put_driver(driver);
69 }
70
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -070071 if (retval)
72 return retval;
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080073 return count;
74}
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +010075EXPORT_SYMBOL_GPL(usb_store_new_id);
76
77static ssize_t store_new_id(struct device_driver *driver,
78 const char *buf, size_t count)
79{
80 struct usb_driver *usb_drv = to_usb_driver(driver);
81
82 return usb_store_new_id(&usb_drv->dynids, driver, buf, count);
83}
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080084static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
85
86static int usb_create_newid_file(struct usb_driver *usb_drv)
87{
88 int error = 0;
89
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -080090 if (usb_drv->no_dynamic_id)
91 goto exit;
92
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080093 if (usb_drv->probe != NULL)
Alan Stern8bb54ab2006-07-01 22:08:49 -040094 error = sysfs_create_file(&usb_drv->drvwrap.driver.kobj,
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080095 &driver_attr_new_id.attr);
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -080096exit:
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080097 return error;
98}
99
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800100static void usb_remove_newid_file(struct usb_driver *usb_drv)
101{
102 if (usb_drv->no_dynamic_id)
103 return;
104
105 if (usb_drv->probe != NULL)
Alan Stern8bb54ab2006-07-01 22:08:49 -0400106 sysfs_remove_file(&usb_drv->drvwrap.driver.kobj,
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800107 &driver_attr_new_id.attr);
108}
109
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800110static void usb_free_dynids(struct usb_driver *usb_drv)
111{
112 struct usb_dynid *dynid, *n;
113
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);
118 }
119 spin_unlock(&usb_drv->dynids.lock);
120}
121#else
122static inline int usb_create_newid_file(struct usb_driver *usb_drv)
123{
124 return 0;
125}
126
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800127static void usb_remove_newid_file(struct usb_driver *usb_drv)
128{
129}
130
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800131static inline void usb_free_dynids(struct usb_driver *usb_drv)
132{
133}
134#endif
135
136static const struct usb_device_id *usb_match_dynamic_id(struct usb_interface *intf,
137 struct usb_driver *drv)
138{
139 struct usb_dynid *dynid;
140
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;
146 }
147 }
148 spin_unlock(&drv->dynids.lock);
149 return NULL;
150}
151
152
Alan Stern8bb54ab2006-07-01 22:08:49 -0400153/* called from driver core with dev locked */
154static int usb_probe_device(struct device *dev)
155{
156 struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
157 struct usb_device *udev;
158 int error = -ENODEV;
159
160 dev_dbg(dev, "%s\n", __FUNCTION__);
161
162 if (!is_usb_device(dev)) /* Sanity check */
163 return error;
164
165 udev = to_usb_device(dev);
166
Alan Stern8bb54ab2006-07-01 22:08:49 -0400167 /* TODO: Add real matching code */
168
Alan Stern645daaa2006-08-30 15:47:02 -0400169 /* The device should always appear to be in use
170 * unless the driver suports autosuspend.
171 */
172 udev->pm_usage_cnt = !(udriver->supports_autosuspend);
173
Alan Stern8bb54ab2006-07-01 22:08:49 -0400174 error = udriver->probe(udev);
175 return error;
176}
177
178/* called from driver core with dev locked */
179static int usb_unbind_device(struct device *dev)
180{
181 struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
182
183 udriver->disconnect(to_usb_device(dev));
184 return 0;
185}
186
187
188/* called from driver core with dev locked */
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800189static int usb_probe_interface(struct device *dev)
190{
Alan Stern8bb54ab2006-07-01 22:08:49 -0400191 struct usb_driver *driver = to_usb_driver(dev->driver);
192 struct usb_interface *intf;
Alan Stern645daaa2006-08-30 15:47:02 -0400193 struct usb_device *udev;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800194 const struct usb_device_id *id;
195 int error = -ENODEV;
196
197 dev_dbg(dev, "%s\n", __FUNCTION__);
198
Alan Stern8bb54ab2006-07-01 22:08:49 -0400199 if (is_usb_device(dev)) /* Sanity check */
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800200 return error;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400201
202 intf = to_usb_interface(dev);
Alan Stern645daaa2006-08-30 15:47:02 -0400203 udev = interface_to_usbdev(intf);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800204
Inaky Perez-Gonzalez72230ab2007-07-31 20:34:03 -0700205 if (udev->authorized == 0) {
206 dev_err(&intf->dev, "Device is not authorized for usage\n");
207 return -ENODEV;
208 }
209
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800210 id = usb_match_id(intf, driver->id_table);
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800211 if (!id)
212 id = usb_match_dynamic_id(intf, driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800213 if (id) {
214 dev_dbg(dev, "%s - got id\n", __FUNCTION__);
215
Alan Stern94fcda12006-11-20 11:38:46 -0500216 error = usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -0400217 if (error)
218 return error;
219
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800220 /* 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.
223 */
224 mark_active(intf);
225 intf->condition = USB_INTERFACE_BINDING;
Alan Stern645daaa2006-08-30 15:47:02 -0400226
227 /* The interface should always appear to be in use
228 * unless the driver suports autosuspend.
229 */
230 intf->pm_usage_cnt = !(driver->supports_autosuspend);
231
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800232 error = driver->probe(intf, id);
233 if (error) {
234 mark_quiesced(intf);
Alan Stern645daaa2006-08-30 15:47:02 -0400235 intf->needs_remote_wakeup = 0;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800236 intf->condition = USB_INTERFACE_UNBOUND;
237 } else
238 intf->condition = USB_INTERFACE_BOUND;
Alan Stern645daaa2006-08-30 15:47:02 -0400239
Alan Stern94fcda12006-11-20 11:38:46 -0500240 usb_autosuspend_device(udev);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800241 }
242
243 return error;
244}
245
Alan Stern8bb54ab2006-07-01 22:08:49 -0400246/* called from driver core with dev locked */
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800247static int usb_unbind_interface(struct device *dev)
248{
Alan Stern8bb54ab2006-07-01 22:08:49 -0400249 struct usb_driver *driver = to_usb_driver(dev->driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800250 struct usb_interface *intf = to_usb_interface(dev);
Alan Stern645daaa2006-08-30 15:47:02 -0400251 struct usb_device *udev;
252 int error;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800253
254 intf->condition = USB_INTERFACE_UNBINDING;
255
Alan Stern645daaa2006-08-30 15:47:02 -0400256 /* Autoresume for set_interface call below */
257 udev = interface_to_usbdev(intf);
Alan Stern94fcda12006-11-20 11:38:46 -0500258 error = usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -0400259
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800260 /* release all urbs for this interface */
261 usb_disable_interface(interface_to_usbdev(intf), intf);
262
Alan Stern8bb54ab2006-07-01 22:08:49 -0400263 driver->disconnect(intf);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800264
265 /* reset other interface state */
266 usb_set_interface(interface_to_usbdev(intf),
267 intf->altsetting[0].desc.bInterfaceNumber,
268 0);
269 usb_set_intfdata(intf, NULL);
Alan Stern645daaa2006-08-30 15:47:02 -0400270
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800271 intf->condition = USB_INTERFACE_UNBOUND;
272 mark_quiesced(intf);
Alan Stern645daaa2006-08-30 15:47:02 -0400273 intf->needs_remote_wakeup = 0;
274
275 if (!error)
Alan Stern94fcda12006-11-20 11:38:46 -0500276 usb_autosuspend_device(udev);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800277
278 return 0;
279}
280
Alan Stern36e56a32006-07-01 22:08:06 -0400281/**
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
287 *
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.
292 *
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.
296 *
Greg Kroah-Hartman341487a82007-04-09 11:52:31 -0400297 * 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.
Alan Stern36e56a32006-07-01 22:08:06 -0400300 */
301int usb_driver_claim_interface(struct usb_driver *driver,
302 struct usb_interface *iface, void* priv)
303{
304 struct device *dev = &iface->dev;
Alan Stern645daaa2006-08-30 15:47:02 -0400305 struct usb_device *udev = interface_to_usbdev(iface);
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700306 int retval = 0;
Alan Stern36e56a32006-07-01 22:08:06 -0400307
308 if (dev->driver)
309 return -EBUSY;
310
Alan Stern8bb54ab2006-07-01 22:08:49 -0400311 dev->driver = &driver->drvwrap.driver;
Alan Stern36e56a32006-07-01 22:08:06 -0400312 usb_set_intfdata(iface, priv);
Alan Stern645daaa2006-08-30 15:47:02 -0400313
Alan Sterne0318eb2006-09-26 14:50:20 -0400314 usb_pm_lock(udev);
Alan Stern36e56a32006-07-01 22:08:06 -0400315 iface->condition = USB_INTERFACE_BOUND;
316 mark_active(iface);
Alan Stern645daaa2006-08-30 15:47:02 -0400317 iface->pm_usage_cnt = !(driver->supports_autosuspend);
Alan Sterne0318eb2006-09-26 14:50:20 -0400318 usb_pm_unlock(udev);
Alan Stern36e56a32006-07-01 22:08:06 -0400319
320 /* if interface was already added, bind now; else let
321 * the future device_add() bind it, bypassing probe()
322 */
323 if (device_is_registered(dev))
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700324 retval = device_bind_driver(dev);
Alan Stern36e56a32006-07-01 22:08:06 -0400325
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700326 return retval;
Alan Stern36e56a32006-07-01 22:08:06 -0400327}
328EXPORT_SYMBOL(usb_driver_claim_interface);
329
330/**
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
334 *
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.
338 *
339 * This call is synchronous, and may not be used in an interrupt context.
Greg Kroah-Hartman341487a82007-04-09 11:52:31 -0400340 * 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.
Alan Stern36e56a32006-07-01 22:08:06 -0400343 */
344void usb_driver_release_interface(struct usb_driver *driver,
345 struct usb_interface *iface)
346{
347 struct device *dev = &iface->dev;
Alan Stern645daaa2006-08-30 15:47:02 -0400348 struct usb_device *udev = interface_to_usbdev(iface);
Alan Stern36e56a32006-07-01 22:08:06 -0400349
350 /* this should never happen, don't release something that's not ours */
Alan Stern8bb54ab2006-07-01 22:08:49 -0400351 if (!dev->driver || dev->driver != &driver->drvwrap.driver)
Alan Stern36e56a32006-07-01 22:08:06 -0400352 return;
353
354 /* don't release from within disconnect() */
355 if (iface->condition != USB_INTERFACE_BOUND)
356 return;
357
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);
362 }
363
364 dev->driver = NULL;
365 usb_set_intfdata(iface, NULL);
Alan Stern645daaa2006-08-30 15:47:02 -0400366
Alan Sterne0318eb2006-09-26 14:50:20 -0400367 usb_pm_lock(udev);
Alan Stern36e56a32006-07-01 22:08:06 -0400368 iface->condition = USB_INTERFACE_UNBOUND;
369 mark_quiesced(iface);
Alan Stern645daaa2006-08-30 15:47:02 -0400370 iface->needs_remote_wakeup = 0;
Alan Sterne0318eb2006-09-26 14:50:20 -0400371 usb_pm_unlock(udev);
Alan Stern36e56a32006-07-01 22:08:06 -0400372}
373EXPORT_SYMBOL(usb_driver_release_interface);
374
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800375/* returns 0 if no match, 1 if match */
Greg Kroah-Hartmanbb417022007-01-26 14:26:21 +0100376int usb_match_device(struct usb_device *dev, const struct usb_device_id *id)
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800377{
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800378 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
379 id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
380 return 0;
381
382 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
383 id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
384 return 0;
385
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;
391
392 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
393 (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
394 return 0;
395
396 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
397 (id->bDeviceClass != dev->descriptor.bDeviceClass))
398 return 0;
399
400 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
401 (id->bDeviceSubClass!= dev->descriptor.bDeviceSubClass))
402 return 0;
403
404 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
405 (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
406 return 0;
407
Greg Kroah-Hartmanbb417022007-01-26 14:26:21 +0100408 return 1;
409}
410
411/* returns 0 if no match, 1 if match */
412int usb_match_one_id(struct usb_interface *interface,
413 const struct usb_device_id *id)
414{
415 struct usb_host_interface *intf;
416 struct usb_device *dev;
417
418 /* proc_connectinfo in devio.c may call us with id == NULL. */
419 if (id == NULL)
420 return 0;
421
422 intf = interface->cur_altsetting;
423 dev = interface_to_usbdev(interface);
424
425 if (!usb_match_device(dev, id))
426 return 0;
427
Alan Stern93c8bf42006-10-18 16:41:51 -0400428 /* 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;
437
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800438 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
439 (id->bInterfaceClass != intf->desc.bInterfaceClass))
440 return 0;
441
442 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
443 (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
444 return 0;
445
446 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
447 (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
448 return 0;
449
450 return 1;
451}
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100452EXPORT_SYMBOL_GPL(usb_match_one_id);
453
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800454/**
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
458 *
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.
466 *
467 * What Matches:
468 *
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.
474 *
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.
481 *
482 * What Makes Good usb_device_id Tables:
483 *
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.
490 *
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.
497 *
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.
503 *
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
Alan Stern93c8bf42006-10-18 16:41:51 -0400508 * devices (as recorded in bInterfaceClass).
509 *
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.)
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800519 *
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.
524 */
525const struct usb_device_id *usb_match_id(struct usb_interface *interface,
526 const struct usb_device_id *id)
527{
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800528 /* proc_connectinfo in devio.c may call us with id == NULL. */
529 if (id == NULL)
530 return NULL;
531
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800532 /* 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->bDeviceClass || id->bInterfaceClass ||
538 id->driver_info; id++) {
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800539 if (usb_match_one_id(interface, id))
540 return id;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800541 }
542
543 return NULL;
544}
Greg Kroah-Hartmanb87ba0a2006-03-20 13:17:13 -0800545EXPORT_SYMBOL_GPL_FUTURE(usb_match_id);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800546
Adrian Bunk8bb22d22006-11-21 22:02:54 +0100547static int usb_device_match(struct device *dev, struct device_driver *drv)
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800548{
Alan Stern8bb54ab2006-07-01 22:08:49 -0400549 /* devices and interfaces are handled separately */
550 if (is_usb_device(dev)) {
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800551
Alan Stern8bb54ab2006-07-01 22:08:49 -0400552 /* interface drivers never match devices */
553 if (!is_usb_device_driver(drv))
554 return 0;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800555
Alan Stern8bb54ab2006-07-01 22:08:49 -0400556 /* TODO: Add real matching code */
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800557 return 1;
558
Alan Stern8bb54ab2006-07-01 22:08:49 -0400559 } else {
560 struct usb_interface *intf;
561 struct usb_driver *usb_drv;
562 const struct usb_device_id *id;
563
564 /* device drivers never match interfaces */
565 if (is_usb_device_driver(drv))
566 return 0;
567
568 intf = to_usb_interface(dev);
569 usb_drv = to_usb_driver(drv);
570
571 id = usb_match_id(intf, usb_drv->id_table);
572 if (id)
573 return 1;
574
575 id = usb_match_dynamic_id(intf, usb_drv);
576 if (id)
577 return 1;
578 }
579
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800580 return 0;
581}
582
Alan Stern36e56a32006-07-01 22:08:06 -0400583#ifdef CONFIG_HOTPLUG
Alan Stern36e56a32006-07-01 22:08:06 -0400584static int usb_uevent(struct device *dev, char **envp, int num_envp,
585 char *buffer, int buffer_size)
586{
Alan Stern36e56a32006-07-01 22:08:06 -0400587 struct usb_device *usb_dev;
Alan Stern36e56a32006-07-01 22:08:06 -0400588 int i = 0;
589 int length = 0;
590
591 if (!dev)
592 return -ENODEV;
593
594 /* driver is often null here; dev_dbg() would oops */
595 pr_debug ("usb %s: uevent\n", dev->bus_id);
596
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100597 if (is_usb_device(dev))
Alan Stern782da722006-07-01 22:09:35 -0400598 usb_dev = to_usb_device(dev);
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100599 else {
600 struct usb_interface *intf = to_usb_interface(dev);
Alan Stern8bb54ab2006-07-01 22:08:49 -0400601 usb_dev = interface_to_usbdev(intf);
Alan Stern8bb54ab2006-07-01 22:08:49 -0400602 }
Alan Stern36e56a32006-07-01 22:08:06 -0400603
604 if (usb_dev->devnum < 0) {
605 pr_debug ("usb %s: already deleted?\n", dev->bus_id);
606 return -ENODEV;
607 }
608 if (!usb_dev->bus) {
609 pr_debug ("usb %s: bus removed?\n", dev->bus_id);
610 return -ENODEV;
611 }
612
613#ifdef CONFIG_USB_DEVICEFS
614 /* If this is available, userspace programs can directly read
615 * all the device descriptors we don't tell them about. Or
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100616 * act as usermode drivers.
Alan Stern36e56a32006-07-01 22:08:06 -0400617 */
618 if (add_uevent_var(envp, num_envp, &i,
619 buffer, buffer_size, &length,
620 "DEVICE=/proc/bus/usb/%03d/%03d",
621 usb_dev->bus->busnum, usb_dev->devnum))
622 return -ENOMEM;
623#endif
624
625 /* per-device configurations are common */
626 if (add_uevent_var(envp, num_envp, &i,
627 buffer, buffer_size, &length,
628 "PRODUCT=%x/%x/%x",
629 le16_to_cpu(usb_dev->descriptor.idVendor),
630 le16_to_cpu(usb_dev->descriptor.idProduct),
631 le16_to_cpu(usb_dev->descriptor.bcdDevice)))
632 return -ENOMEM;
633
634 /* class-based driver binding models */
635 if (add_uevent_var(envp, num_envp, &i,
636 buffer, buffer_size, &length,
637 "TYPE=%d/%d/%d",
638 usb_dev->descriptor.bDeviceClass,
639 usb_dev->descriptor.bDeviceSubClass,
640 usb_dev->descriptor.bDeviceProtocol))
641 return -ENOMEM;
642
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100643 if (add_uevent_var(envp, num_envp, &i,
Alan Stern36e56a32006-07-01 22:08:06 -0400644 buffer, buffer_size, &length,
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100645 "BUSNUM=%03d",
646 usb_dev->bus->busnum))
647 return -ENOMEM;
Alan Stern36e56a32006-07-01 22:08:06 -0400648
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100649 if (add_uevent_var(envp, num_envp, &i,
Alan Stern36e56a32006-07-01 22:08:06 -0400650 buffer, buffer_size, &length,
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100651 "DEVNUM=%03d",
652 usb_dev->devnum))
653 return -ENOMEM;
Alan Stern36e56a32006-07-01 22:08:06 -0400654
655 envp[i] = NULL;
Alan Stern36e56a32006-07-01 22:08:06 -0400656 return 0;
657}
658
659#else
660
661static int usb_uevent(struct device *dev, char **envp,
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100662 int num_envp, char *buffer, int buffer_size)
Alan Stern36e56a32006-07-01 22:08:06 -0400663{
664 return -ENODEV;
665}
Alan Stern36e56a32006-07-01 22:08:06 -0400666#endif /* CONFIG_HOTPLUG */
667
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800668/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400669 * usb_register_device_driver - register a USB device (not interface) driver
670 * @new_udriver: USB operations for the device driver
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -0800671 * @owner: module owner of this driver.
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800672 *
Alan Stern8bb54ab2006-07-01 22:08:49 -0400673 * Registers a USB device driver with the USB core. The list of
674 * unattached devices will be rescanned whenever a new driver is
675 * added, allowing the new driver to attach to any recognized devices.
676 * Returns a negative error code on failure and 0 on success.
677 */
678int usb_register_device_driver(struct usb_device_driver *new_udriver,
679 struct module *owner)
680{
681 int retval = 0;
682
683 if (usb_disabled())
684 return -ENODEV;
685
686 new_udriver->drvwrap.for_devices = 1;
687 new_udriver->drvwrap.driver.name = (char *) new_udriver->name;
688 new_udriver->drvwrap.driver.bus = &usb_bus_type;
689 new_udriver->drvwrap.driver.probe = usb_probe_device;
690 new_udriver->drvwrap.driver.remove = usb_unbind_device;
691 new_udriver->drvwrap.driver.owner = owner;
692
693 retval = driver_register(&new_udriver->drvwrap.driver);
694
695 if (!retval) {
696 pr_info("%s: registered new device driver %s\n",
697 usbcore_name, new_udriver->name);
698 usbfs_update_special();
699 } else {
700 printk(KERN_ERR "%s: error %d registering device "
701 " driver %s\n",
702 usbcore_name, retval, new_udriver->name);
703 }
704
705 return retval;
706}
707EXPORT_SYMBOL_GPL(usb_register_device_driver);
708
709/**
710 * usb_deregister_device_driver - unregister a USB device (not interface) driver
711 * @udriver: USB operations of the device driver to unregister
712 * Context: must be able to sleep
713 *
714 * Unlinks the specified driver from the internal USB driver list.
715 */
716void usb_deregister_device_driver(struct usb_device_driver *udriver)
717{
718 pr_info("%s: deregistering device driver %s\n",
719 usbcore_name, udriver->name);
720
721 driver_unregister(&udriver->drvwrap.driver);
722 usbfs_update_special();
723}
724EXPORT_SYMBOL_GPL(usb_deregister_device_driver);
725
726/**
727 * usb_register_driver - register a USB interface driver
728 * @new_driver: USB operations for the interface driver
729 * @owner: module owner of this driver.
Randy Dunlap892705a2007-02-10 14:41:41 -0800730 * @mod_name: module name string
Alan Stern8bb54ab2006-07-01 22:08:49 -0400731 *
732 * Registers a USB interface driver with the USB core. The list of
733 * unattached interfaces will be rescanned whenever a new driver is
734 * added, allowing the new driver to attach to any recognized interfaces.
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800735 * Returns a negative error code on failure and 0 on success.
736 *
737 * NOTE: if you want your driver to use the USB major number, you must call
738 * usb_register_dev() to enable that functionality. This function no longer
739 * takes care of that.
740 */
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800741int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
742 const char *mod_name)
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800743{
744 int retval = 0;
745
746 if (usb_disabled())
747 return -ENODEV;
748
Alan Stern8bb54ab2006-07-01 22:08:49 -0400749 new_driver->drvwrap.for_devices = 0;
750 new_driver->drvwrap.driver.name = (char *) new_driver->name;
751 new_driver->drvwrap.driver.bus = &usb_bus_type;
752 new_driver->drvwrap.driver.probe = usb_probe_interface;
753 new_driver->drvwrap.driver.remove = usb_unbind_interface;
754 new_driver->drvwrap.driver.owner = owner;
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800755 new_driver->drvwrap.driver.mod_name = mod_name;
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800756 spin_lock_init(&new_driver->dynids.lock);
757 INIT_LIST_HEAD(&new_driver->dynids.list);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800758
Alan Stern8bb54ab2006-07-01 22:08:49 -0400759 retval = driver_register(&new_driver->drvwrap.driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800760
761 if (!retval) {
Alan Stern8bb54ab2006-07-01 22:08:49 -0400762 pr_info("%s: registered new interface driver %s\n",
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800763 usbcore_name, new_driver->name);
764 usbfs_update_special();
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800765 usb_create_newid_file(new_driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800766 } else {
Alan Stern8bb54ab2006-07-01 22:08:49 -0400767 printk(KERN_ERR "%s: error %d registering interface "
768 " driver %s\n",
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800769 usbcore_name, retval, new_driver->name);
770 }
771
772 return retval;
773}
Greg Kroah-Hartmanb87ba0a2006-03-20 13:17:13 -0800774EXPORT_SYMBOL_GPL_FUTURE(usb_register_driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800775
776/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400777 * usb_deregister - unregister a USB interface driver
778 * @driver: USB operations of the interface driver to unregister
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800779 * Context: must be able to sleep
780 *
781 * Unlinks the specified driver from the internal USB driver list.
782 *
783 * NOTE: If you called usb_register_dev(), you still need to call
784 * usb_deregister_dev() to clean up your driver's allocated minor numbers,
785 * this * call will no longer do it for you.
786 */
787void usb_deregister(struct usb_driver *driver)
788{
Alan Stern8bb54ab2006-07-01 22:08:49 -0400789 pr_info("%s: deregistering interface driver %s\n",
790 usbcore_name, driver->name);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800791
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800792 usb_remove_newid_file(driver);
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800793 usb_free_dynids(driver);
Alan Stern8bb54ab2006-07-01 22:08:49 -0400794 driver_unregister(&driver->drvwrap.driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800795
796 usbfs_update_special();
797}
Greg Kroah-Hartmanb87ba0a2006-03-20 13:17:13 -0800798EXPORT_SYMBOL_GPL_FUTURE(usb_deregister);
Alan Stern36e56a32006-07-01 22:08:06 -0400799
800#ifdef CONFIG_PM
801
Alan Sterne0318eb2006-09-26 14:50:20 -0400802/* Caller has locked udev's pm_mutex */
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -0800803static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
Alan Stern36e56a32006-07-01 22:08:06 -0400804{
Alan Stern782da722006-07-01 22:09:35 -0400805 struct usb_device_driver *udriver;
Alan Stern2bf40862006-07-01 22:12:19 -0400806 int status = 0;
Alan Stern36e56a32006-07-01 22:08:06 -0400807
Alan Stern114b3682006-07-01 22:13:04 -0400808 if (udev->state == USB_STATE_NOTATTACHED ||
809 udev->state == USB_STATE_SUSPENDED)
810 goto done;
811
Alan Sternb6f64362007-05-04 11:51:54 -0400812 /* For devices that don't have a driver, we do a generic suspend. */
813 if (udev->dev.driver)
814 udriver = to_usb_device_driver(udev->dev.driver);
815 else {
Alan Stern645daaa2006-08-30 15:47:02 -0400816 udev->do_remote_wakeup = 0;
Alan Sternb6f64362007-05-04 11:51:54 -0400817 udriver = &usb_generic_driver;
Alan Stern1c5df7e2006-07-01 22:13:50 -0400818 }
Alan Stern2bf40862006-07-01 22:12:19 -0400819 status = udriver->suspend(udev, msg);
820
Alan Stern20dfdad2007-05-22 11:50:17 -0400821 done:
822 dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
Alan Stern2bf40862006-07-01 22:12:19 -0400823 if (status == 0)
824 udev->dev.power.power_state.event = msg.event;
825 return status;
Alan Stern1cc8a252006-07-01 22:10:15 -0400826}
Alan Stern36e56a32006-07-01 22:08:06 -0400827
Alan Sterne0318eb2006-09-26 14:50:20 -0400828/* Caller has locked udev's pm_mutex */
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -0800829static int usb_resume_device(struct usb_device *udev)
Alan Stern1cc8a252006-07-01 22:10:15 -0400830{
831 struct usb_device_driver *udriver;
Alan Stern2bf40862006-07-01 22:12:19 -0400832 int status = 0;
Alan Stern1cc8a252006-07-01 22:10:15 -0400833
Alan Stern0458d5b2007-05-04 11:52:20 -0400834 if (udev->state == USB_STATE_NOTATTACHED)
835 goto done;
836 if (udev->state != USB_STATE_SUSPENDED && !udev->reset_resume)
Alan Stern2bf40862006-07-01 22:12:19 -0400837 goto done;
Alan Stern1cc8a252006-07-01 22:10:15 -0400838
Alan Stern1c5df7e2006-07-01 22:13:50 -0400839 /* Can't resume it if it doesn't have a driver. */
840 if (udev->dev.driver == NULL) {
841 status = -ENOTCONN;
Alan Stern2bf40862006-07-01 22:12:19 -0400842 goto done;
Alan Stern1c5df7e2006-07-01 22:13:50 -0400843 }
844
Alan Stern6bc6cff2007-05-04 11:53:03 -0400845 if (udev->quirks & USB_QUIRK_RESET_RESUME)
846 udev->reset_resume = 1;
847
Alan Stern1cc8a252006-07-01 22:10:15 -0400848 udriver = to_usb_device_driver(udev->dev.driver);
Alan Stern2bf40862006-07-01 22:12:19 -0400849 status = udriver->resume(udev);
850
Alan Stern20dfdad2007-05-22 11:50:17 -0400851 done:
852 dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
Alan Stern2add5222007-03-20 14:59:39 -0400853 if (status == 0) {
854 udev->autoresume_disabled = 0;
Alan Stern2bf40862006-07-01 22:12:19 -0400855 udev->dev.power.power_state.event = PM_EVENT_ON;
Alan Stern2add5222007-03-20 14:59:39 -0400856 }
Alan Stern2bf40862006-07-01 22:12:19 -0400857 return status;
Alan Stern1cc8a252006-07-01 22:10:15 -0400858}
859
Alan Sterne0318eb2006-09-26 14:50:20 -0400860/* Caller has locked intf's usb_device's pm mutex */
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -0800861static int usb_suspend_interface(struct usb_interface *intf, pm_message_t msg)
Alan Stern1cc8a252006-07-01 22:10:15 -0400862{
863 struct usb_driver *driver;
Alan Stern2bf40862006-07-01 22:12:19 -0400864 int status = 0;
Alan Stern1cc8a252006-07-01 22:10:15 -0400865
Alan Stern114b3682006-07-01 22:13:04 -0400866 /* with no hardware, USB interfaces only use FREEZE and ON states */
867 if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
868 !is_active(intf))
869 goto done;
870
Alan Stern645daaa2006-08-30 15:47:02 -0400871 if (intf->condition == USB_INTERFACE_UNBOUND) /* This can't happen */
Alan Stern2bf40862006-07-01 22:12:19 -0400872 goto done;
Alan Stern1cc8a252006-07-01 22:10:15 -0400873 driver = to_usb_driver(intf->dev.driver);
Alan Stern36e56a32006-07-01 22:08:06 -0400874
Alan Stern36e56a32006-07-01 22:08:06 -0400875 if (driver->suspend && driver->resume) {
Alan Stern1cc8a252006-07-01 22:10:15 -0400876 status = driver->suspend(intf, msg);
Alan Stern645daaa2006-08-30 15:47:02 -0400877 if (status == 0)
878 mark_quiesced(intf);
879 else if (!interface_to_usbdev(intf)->auto_pm)
Alan Stern1cc8a252006-07-01 22:10:15 -0400880 dev_err(&intf->dev, "%s error %d\n",
881 "suspend", status);
Alan Stern36e56a32006-07-01 22:08:06 -0400882 } else {
883 // FIXME else if there's no suspend method, disconnect...
Alan Stern645daaa2006-08-30 15:47:02 -0400884 // Not possible if auto_pm is set...
Alan Stern1cc8a252006-07-01 22:10:15 -0400885 dev_warn(&intf->dev, "no suspend for driver %s?\n",
886 driver->name);
Alan Stern36e56a32006-07-01 22:08:06 -0400887 mark_quiesced(intf);
Alan Stern36e56a32006-07-01 22:08:06 -0400888 }
Alan Stern2bf40862006-07-01 22:12:19 -0400889
Alan Stern20dfdad2007-05-22 11:50:17 -0400890 done:
891 dev_vdbg(&intf->dev, "%s: status %d\n", __FUNCTION__, status);
Alan Stern36e56a32006-07-01 22:08:06 -0400892 return status;
893}
894
Alan Stern645daaa2006-08-30 15:47:02 -0400895/* Caller has locked intf's usb_device's pm_mutex */
Alan Stern0458d5b2007-05-04 11:52:20 -0400896static int usb_resume_interface(struct usb_interface *intf, int reset_resume)
Alan Stern36e56a32006-07-01 22:08:06 -0400897{
Alan Stern1cc8a252006-07-01 22:10:15 -0400898 struct usb_driver *driver;
Alan Stern2bf40862006-07-01 22:12:19 -0400899 int status = 0;
Alan Stern36e56a32006-07-01 22:08:06 -0400900
Alan Stern114b3682006-07-01 22:13:04 -0400901 if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
902 is_active(intf))
Alan Stern2bf40862006-07-01 22:12:19 -0400903 goto done;
Alan Stern36e56a32006-07-01 22:08:06 -0400904
Alan Stern645daaa2006-08-30 15:47:02 -0400905 /* Don't let autoresume interfere with unbinding */
906 if (intf->condition == USB_INTERFACE_UNBINDING)
907 goto done;
908
Alan Stern1c5df7e2006-07-01 22:13:50 -0400909 /* Can't resume it if it doesn't have a driver. */
Alan Stern645daaa2006-08-30 15:47:02 -0400910 if (intf->condition == USB_INTERFACE_UNBOUND) {
Alan Stern1c5df7e2006-07-01 22:13:50 -0400911 status = -ENOTCONN;
Alan Stern2bf40862006-07-01 22:12:19 -0400912 goto done;
Alan Stern1c5df7e2006-07-01 22:13:50 -0400913 }
Alan Stern1cc8a252006-07-01 22:10:15 -0400914 driver = to_usb_driver(intf->dev.driver);
Alan Stern36e56a32006-07-01 22:08:06 -0400915
Alan Sternf07600c2007-05-30 15:38:16 -0400916 if (reset_resume) {
917 if (driver->reset_resume) {
918 status = driver->reset_resume(intf);
919 if (status)
920 dev_err(&intf->dev, "%s error %d\n",
921 "reset_resume", status);
922 } else {
923 // status = -EOPNOTSUPP;
924 dev_warn(&intf->dev, "no %s for driver %s?\n",
925 "reset_resume", driver->name);
926 }
927 } else {
928 if (driver->resume) {
929 status = driver->resume(intf);
930 if (status)
931 dev_err(&intf->dev, "%s error %d\n",
932 "resume", status);
933 } else {
934 // status = -EOPNOTSUPP;
935 dev_warn(&intf->dev, "no %s for driver %s?\n",
936 "resume", driver->name);
937 }
938 }
Alan Stern2bf40862006-07-01 22:12:19 -0400939
940done:
Alan Stern20dfdad2007-05-22 11:50:17 -0400941 dev_vdbg(&intf->dev, "%s: status %d\n", __FUNCTION__, status);
Alan Stern0458d5b2007-05-04 11:52:20 -0400942 if (status == 0)
943 mark_active(intf);
Alan Sternf07600c2007-05-30 15:38:16 -0400944
945 /* FIXME: Unbind the driver and reprobe if the resume failed
946 * (not possible if auto_pm is set) */
Alan Stern2bf40862006-07-01 22:12:19 -0400947 return status;
Alan Stern36e56a32006-07-01 22:08:06 -0400948}
949
Alan Stern94fcda12006-11-20 11:38:46 -0500950#ifdef CONFIG_USB_SUSPEND
951
Alan Sternaf4f7602006-10-30 17:06:45 -0500952/* Internal routine to check whether we may autosuspend a device. */
953static int autosuspend_check(struct usb_device *udev)
954{
955 int i;
956 struct usb_interface *intf;
Alan Stern8c9862e2007-04-11 12:06:16 -0400957 unsigned long suspend_time;
Alan Sternaf4f7602006-10-30 17:06:45 -0500958
Alan Sternb5e795f2007-02-20 15:00:53 -0500959 /* For autosuspend, fail fast if anything is in use or autosuspend
960 * is disabled. Also fail if any interfaces require remote wakeup
961 * but it isn't available.
962 */
Alan Sternaf4f7602006-10-30 17:06:45 -0500963 udev->do_remote_wakeup = device_may_wakeup(&udev->dev);
964 if (udev->pm_usage_cnt > 0)
965 return -EBUSY;
Alan Stern2add5222007-03-20 14:59:39 -0400966 if (udev->autosuspend_delay < 0 || udev->autosuspend_disabled)
Alan Sternb5e795f2007-02-20 15:00:53 -0500967 return -EPERM;
968
Alan Stern19410442007-03-27 13:33:59 -0400969 suspend_time = udev->last_busy + udev->autosuspend_delay;
Alan Sternaf4f7602006-10-30 17:06:45 -0500970 if (udev->actconfig) {
971 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
972 intf = udev->actconfig->interface[i];
973 if (!is_active(intf))
974 continue;
975 if (intf->pm_usage_cnt > 0)
976 return -EBUSY;
977 if (intf->needs_remote_wakeup &&
978 !udev->do_remote_wakeup) {
979 dev_dbg(&udev->dev, "remote wakeup needed "
980 "for autosuspend\n");
981 return -EOPNOTSUPP;
982 }
Alan Sternf07600c2007-05-30 15:38:16 -0400983
984 /* Don't allow autosuspend if the device will need
985 * a reset-resume and any of its interface drivers
986 * doesn't include support.
987 */
988 if (udev->quirks & USB_QUIRK_RESET_RESUME) {
989 struct usb_driver *driver;
990
991 driver = to_usb_driver(intf->dev.driver);
992 if (!driver->reset_resume)
993 return -EOPNOTSUPP;
994 }
Alan Sternaf4f7602006-10-30 17:06:45 -0500995 }
996 }
Alan Stern19410442007-03-27 13:33:59 -0400997
998 /* If everything is okay but the device hasn't been idle for long
999 * enough, queue a delayed autosuspend request.
1000 */
Alan Stern8c9862e2007-04-11 12:06:16 -04001001 if (time_after(suspend_time, jiffies)) {
1002 if (!timer_pending(&udev->autosuspend.timer)) {
1003
1004 /* The value of jiffies may change between the
1005 * time_after() comparison above and the subtraction
1006 * below. That's okay; the system behaves sanely
1007 * when a timer is registered for the present moment
1008 * or for the past.
1009 */
Alan Stern19410442007-03-27 13:33:59 -04001010 queue_delayed_work(ksuspend_usb_wq, &udev->autosuspend,
Venki Pallipadi8d6d5fd2007-07-09 12:03:06 -07001011 round_jiffies_relative(suspend_time - jiffies));
Alan Stern8c9862e2007-04-11 12:06:16 -04001012 }
Alan Stern19410442007-03-27 13:33:59 -04001013 return -EAGAIN;
1014 }
Alan Sternaf4f7602006-10-30 17:06:45 -05001015 return 0;
1016}
1017
Alan Stern94fcda12006-11-20 11:38:46 -05001018#else
1019
Alan Sternef7f6c72007-04-05 16:03:49 -04001020static inline int autosuspend_check(struct usb_device *udev)
1021{
1022 return 0;
1023}
Alan Stern94fcda12006-11-20 11:38:46 -05001024
Alan Sternb5e795f2007-02-20 15:00:53 -05001025#endif /* CONFIG_USB_SUSPEND */
Alan Stern94fcda12006-11-20 11:38:46 -05001026
Alan Stern645daaa2006-08-30 15:47:02 -04001027/**
1028 * usb_suspend_both - suspend a USB device and its interfaces
1029 * @udev: the usb_device to suspend
1030 * @msg: Power Management message describing this state transition
1031 *
1032 * This is the central routine for suspending USB devices. It calls the
1033 * suspend methods for all the interface drivers in @udev and then calls
1034 * the suspend method for @udev itself. If an error occurs at any stage,
1035 * all the interfaces which were suspended are resumed so that they remain
1036 * in the same state as the device.
1037 *
1038 * If an autosuspend is in progress (@udev->auto_pm is set), the routine
1039 * checks first to make sure that neither the device itself or any of its
1040 * active interfaces is in use (pm_usage_cnt is greater than 0). If they
1041 * are, the autosuspend fails.
1042 *
1043 * If the suspend succeeds, the routine recursively queues an autosuspend
1044 * request for @udev's parent device, thereby propagating the change up
1045 * the device tree. If all of the parent's children are now suspended,
1046 * the parent will autosuspend in turn.
1047 *
1048 * The suspend method calls are subject to mutual exclusion under control
1049 * of @udev's pm_mutex. Many of these calls are also under the protection
1050 * of @udev's device lock (including all requests originating outside the
1051 * USB subsystem), but autosuspend requests generated by a child device or
1052 * interface driver may not be. Usbcore will insure that the method calls
1053 * do not arrive during bind, unbind, or reset operations. However, drivers
1054 * must be prepared to handle suspend calls arriving at unpredictable times.
1055 * The only way to block such calls is to do an autoresume (preventing
1056 * autosuspends) while holding @udev's device lock (preventing outside
1057 * suspends).
1058 *
1059 * The caller must hold @udev->pm_mutex.
1060 *
1061 * This routine can run only in process context.
1062 */
Alan Stern718efa62007-03-09 15:41:13 -05001063static int usb_suspend_both(struct usb_device *udev, pm_message_t msg)
Alan Sterna8e7c562006-07-01 22:11:02 -04001064{
1065 int status = 0;
1066 int i = 0;
1067 struct usb_interface *intf;
Alan Stern645daaa2006-08-30 15:47:02 -04001068 struct usb_device *parent = udev->parent;
Alan Sterna8e7c562006-07-01 22:11:02 -04001069
Alan Stern19410442007-03-27 13:33:59 -04001070 if (udev->state == USB_STATE_NOTATTACHED ||
1071 udev->state == USB_STATE_SUSPENDED)
1072 goto done;
Alan Stern645daaa2006-08-30 15:47:02 -04001073
1074 udev->do_remote_wakeup = device_may_wakeup(&udev->dev);
1075
Alan Stern645daaa2006-08-30 15:47:02 -04001076 if (udev->auto_pm) {
Alan Sternaf4f7602006-10-30 17:06:45 -05001077 status = autosuspend_check(udev);
1078 if (status < 0)
Alan Stern19410442007-03-27 13:33:59 -04001079 goto done;
Alan Stern645daaa2006-08-30 15:47:02 -04001080 }
1081
1082 /* Suspend all the interfaces and then udev itself */
Alan Sterna8e7c562006-07-01 22:11:02 -04001083 if (udev->actconfig) {
1084 for (; i < udev->actconfig->desc.bNumInterfaces; i++) {
1085 intf = udev->actconfig->interface[i];
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -08001086 status = usb_suspend_interface(intf, msg);
Alan Sterna8e7c562006-07-01 22:11:02 -04001087 if (status != 0)
1088 break;
1089 }
1090 }
Alan Stern5ad4f712007-09-10 11:31:43 -04001091 if (status == 0)
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -08001092 status = usb_suspend_device(udev, msg);
Alan Sterna8e7c562006-07-01 22:11:02 -04001093
1094 /* If the suspend failed, resume interfaces that did get suspended */
1095 if (status != 0) {
1096 while (--i >= 0) {
1097 intf = udev->actconfig->interface[i];
Alan Stern0458d5b2007-05-04 11:52:20 -04001098 usb_resume_interface(intf, 0);
Alan Sterna8e7c562006-07-01 22:11:02 -04001099 }
Alan Stern645daaa2006-08-30 15:47:02 -04001100
Alan Sternef7f6c72007-04-05 16:03:49 -04001101 /* Try another autosuspend when the interfaces aren't busy */
1102 if (udev->auto_pm)
1103 autosuspend_check(udev);
1104
Alan Stern645daaa2006-08-30 15:47:02 -04001105 /* If the suspend succeeded, propagate it up the tree */
Alan Sternef7f6c72007-04-05 16:03:49 -04001106 } else {
1107 cancel_delayed_work(&udev->autosuspend);
1108 if (parent)
1109 usb_autosuspend_device(parent);
1110 }
Alan Stern645daaa2006-08-30 15:47:02 -04001111
Alan Stern19410442007-03-27 13:33:59 -04001112 done:
Alan Stern20dfdad2007-05-22 11:50:17 -04001113 dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
Alan Sterna8e7c562006-07-01 22:11:02 -04001114 return status;
1115}
1116
Alan Stern645daaa2006-08-30 15:47:02 -04001117/**
1118 * usb_resume_both - resume a USB device and its interfaces
1119 * @udev: the usb_device to resume
1120 *
1121 * This is the central routine for resuming USB devices. It calls the
1122 * the resume method for @udev and then calls the resume methods for all
1123 * the interface drivers in @udev.
1124 *
1125 * Before starting the resume, the routine calls itself recursively for
1126 * the parent device of @udev, thereby propagating the change up the device
1127 * tree and assuring that @udev will be able to resume. If the parent is
1128 * unable to resume successfully, the routine fails.
1129 *
1130 * The resume method calls are subject to mutual exclusion under control
1131 * of @udev's pm_mutex. Many of these calls are also under the protection
1132 * of @udev's device lock (including all requests originating outside the
1133 * USB subsystem), but autoresume requests generated by a child device or
1134 * interface driver may not be. Usbcore will insure that the method calls
1135 * do not arrive during bind, unbind, or reset operations. However, drivers
1136 * must be prepared to handle resume calls arriving at unpredictable times.
1137 * The only way to block such calls is to do an autoresume (preventing
1138 * other autoresumes) while holding @udev's device lock (preventing outside
1139 * resumes).
1140 *
1141 * The caller must hold @udev->pm_mutex.
1142 *
1143 * This routine can run only in process context.
1144 */
Alan Stern718efa62007-03-09 15:41:13 -05001145static int usb_resume_both(struct usb_device *udev)
Alan Sterna8e7c562006-07-01 22:11:02 -04001146{
Alan Stern645daaa2006-08-30 15:47:02 -04001147 int status = 0;
Alan Sterna8e7c562006-07-01 22:11:02 -04001148 int i;
1149 struct usb_interface *intf;
Alan Stern645daaa2006-08-30 15:47:02 -04001150 struct usb_device *parent = udev->parent;
Alan Sterna8e7c562006-07-01 22:11:02 -04001151
Alan Stern645daaa2006-08-30 15:47:02 -04001152 cancel_delayed_work(&udev->autosuspend);
Alan Stern19410442007-03-27 13:33:59 -04001153 if (udev->state == USB_STATE_NOTATTACHED) {
1154 status = -ENODEV;
1155 goto done;
1156 }
Alan Stern645daaa2006-08-30 15:47:02 -04001157
1158 /* Propagate the resume up the tree, if necessary */
1159 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern19410442007-03-27 13:33:59 -04001160 if (udev->auto_pm && udev->autoresume_disabled) {
1161 status = -EPERM;
1162 goto done;
1163 }
Alan Stern645daaa2006-08-30 15:47:02 -04001164 if (parent) {
Alan Stern94fcda12006-11-20 11:38:46 -05001165 status = usb_autoresume_device(parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001166 if (status == 0) {
1167 status = usb_resume_device(udev);
Alan Sternf07600c2007-05-30 15:38:16 -04001168 if (status || udev->state ==
1169 USB_STATE_NOTATTACHED) {
Alan Stern94fcda12006-11-20 11:38:46 -05001170 usb_autosuspend_device(parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001171
1172 /* It's possible usb_resume_device()
1173 * failed after the port was
1174 * unsuspended, causing udev to be
1175 * logically disconnected. We don't
1176 * want usb_disconnect() to autosuspend
1177 * the parent again, so tell it that
1178 * udev disconnected while still
1179 * suspended. */
1180 if (udev->state ==
1181 USB_STATE_NOTATTACHED)
1182 udev->discon_suspended = 1;
1183 }
1184 }
Alan Stern645daaa2006-08-30 15:47:02 -04001185 } else {
1186
1187 /* We can't progagate beyond the USB subsystem,
1188 * so if a root hub's controller is suspended
1189 * then we're stuck. */
Alan Sterne7e6da92007-06-21 16:25:17 -04001190 status = usb_resume_device(udev);
Alan Sternee49fb52006-11-22 16:55:54 -05001191 }
Alan Stern592fbbe2006-09-19 10:08:43 -04001192 } else {
1193
Alan Stern0458d5b2007-05-04 11:52:20 -04001194 /* Needed for setting udev->dev.power.power_state.event,
1195 * for possible debugging message, and for reset_resume. */
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -08001196 status = usb_resume_device(udev);
Alan Stern114b3682006-07-01 22:13:04 -04001197 }
1198
Alan Sterna8e7c562006-07-01 22:11:02 -04001199 if (status == 0 && udev->actconfig) {
1200 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1201 intf = udev->actconfig->interface[i];
Alan Stern0458d5b2007-05-04 11:52:20 -04001202 usb_resume_interface(intf, udev->reset_resume);
Alan Sterna8e7c562006-07-01 22:11:02 -04001203 }
1204 }
Alan Stern645daaa2006-08-30 15:47:02 -04001205
Alan Stern19410442007-03-27 13:33:59 -04001206 done:
Alan Stern20dfdad2007-05-22 11:50:17 -04001207 dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
Alan Stern0458d5b2007-05-04 11:52:20 -04001208 udev->reset_resume = 0;
Alan Sterna8e7c562006-07-01 22:11:02 -04001209 return status;
1210}
1211
Alan Stern645daaa2006-08-30 15:47:02 -04001212#ifdef CONFIG_USB_SUSPEND
1213
Alan Stern94fcda12006-11-20 11:38:46 -05001214/* Internal routine to adjust a device's usage counter and change
1215 * its autosuspend state.
1216 */
1217static int usb_autopm_do_device(struct usb_device *udev, int inc_usage_cnt)
1218{
1219 int status = 0;
1220
1221 usb_pm_lock(udev);
Alan Stern19410442007-03-27 13:33:59 -04001222 udev->auto_pm = 1;
Alan Stern94fcda12006-11-20 11:38:46 -05001223 udev->pm_usage_cnt += inc_usage_cnt;
1224 WARN_ON(udev->pm_usage_cnt < 0);
Alan Stern013d27f2007-08-20 12:18:39 -04001225 if (inc_usage_cnt)
1226 udev->last_busy = jiffies;
Alan Stern94fcda12006-11-20 11:38:46 -05001227 if (inc_usage_cnt >= 0 && udev->pm_usage_cnt > 0) {
Alan Stern19410442007-03-27 13:33:59 -04001228 if (udev->state == USB_STATE_SUSPENDED)
1229 status = usb_resume_both(udev);
Alan Stern94fcda12006-11-20 11:38:46 -05001230 if (status != 0)
1231 udev->pm_usage_cnt -= inc_usage_cnt;
Alan Stern19410442007-03-27 13:33:59 -04001232 else if (inc_usage_cnt)
1233 udev->last_busy = jiffies;
1234 } else if (inc_usage_cnt <= 0 && udev->pm_usage_cnt <= 0) {
Alan Stern19410442007-03-27 13:33:59 -04001235 status = usb_suspend_both(udev, PMSG_SUSPEND);
1236 }
Alan Stern94fcda12006-11-20 11:38:46 -05001237 usb_pm_unlock(udev);
1238 return status;
1239}
1240
Alan Stern19410442007-03-27 13:33:59 -04001241/* usb_autosuspend_work - callback routine to autosuspend a USB device */
1242void usb_autosuspend_work(struct work_struct *work)
1243{
1244 struct usb_device *udev =
1245 container_of(work, struct usb_device, autosuspend.work);
1246
1247 usb_autopm_do_device(udev, 0);
1248}
1249
Alan Stern645daaa2006-08-30 15:47:02 -04001250/**
1251 * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
Henrik Kretzschmar701f35a2006-09-25 17:00:56 -07001252 * @udev: the usb_device to autosuspend
Alan Stern645daaa2006-08-30 15:47:02 -04001253 *
1254 * This routine should be called when a core subsystem is finished using
1255 * @udev and wants to allow it to autosuspend. Examples would be when
1256 * @udev's device file in usbfs is closed or after a configuration change.
1257 *
Alan Stern94fcda12006-11-20 11:38:46 -05001258 * @udev's usage counter is decremented. If it or any of the usage counters
1259 * for an active interface is greater than 0, no autosuspend request will be
1260 * queued. (If an interface driver does not support autosuspend then its
1261 * usage counter is permanently positive.) Furthermore, if an interface
1262 * driver requires remote-wakeup capability during autosuspend but remote
1263 * wakeup is disabled, the autosuspend will fail.
Alan Stern645daaa2006-08-30 15:47:02 -04001264 *
1265 * Often the caller will hold @udev's device lock, but this is not
1266 * necessary.
1267 *
1268 * This routine can run only in process context.
1269 */
Alan Stern94fcda12006-11-20 11:38:46 -05001270void usb_autosuspend_device(struct usb_device *udev)
Alan Stern645daaa2006-08-30 15:47:02 -04001271{
Alan Stern94fcda12006-11-20 11:38:46 -05001272 int status;
1273
1274 status = usb_autopm_do_device(udev, -1);
Alan Stern20dfdad2007-05-22 11:50:17 -04001275 dev_vdbg(&udev->dev, "%s: cnt %d\n",
1276 __FUNCTION__, udev->pm_usage_cnt);
Alan Stern645daaa2006-08-30 15:47:02 -04001277}
1278
1279/**
Alan Stern19c26232007-02-20 15:03:32 -05001280 * usb_try_autosuspend_device - attempt an autosuspend of a USB device and its interfaces
1281 * @udev: the usb_device to autosuspend
1282 *
1283 * This routine should be called when a core subsystem thinks @udev may
1284 * be ready to autosuspend.
1285 *
1286 * @udev's usage counter left unchanged. If it or any of the usage counters
1287 * for an active interface is greater than 0, or autosuspend is not allowed
1288 * for any other reason, no autosuspend request will be queued.
1289 *
1290 * This routine can run only in process context.
1291 */
1292void usb_try_autosuspend_device(struct usb_device *udev)
1293{
1294 usb_autopm_do_device(udev, 0);
Alan Stern20dfdad2007-05-22 11:50:17 -04001295 dev_vdbg(&udev->dev, "%s: cnt %d\n",
1296 __FUNCTION__, udev->pm_usage_cnt);
Alan Stern19c26232007-02-20 15:03:32 -05001297}
1298
1299/**
Alan Stern645daaa2006-08-30 15:47:02 -04001300 * usb_autoresume_device - immediately autoresume a USB device and its interfaces
Henrik Kretzschmar701f35a2006-09-25 17:00:56 -07001301 * @udev: the usb_device to autoresume
Alan Stern645daaa2006-08-30 15:47:02 -04001302 *
1303 * This routine should be called when a core subsystem wants to use @udev
Alan Stern94fcda12006-11-20 11:38:46 -05001304 * and needs to guarantee that it is not suspended. No autosuspend will
1305 * occur until usb_autosuspend_device is called. (Note that this will not
1306 * prevent suspend events originating in the PM core.) Examples would be
1307 * when @udev's device file in usbfs is opened or when a remote-wakeup
1308 * request is received.
Alan Stern645daaa2006-08-30 15:47:02 -04001309 *
Alan Stern94fcda12006-11-20 11:38:46 -05001310 * @udev's usage counter is incremented to prevent subsequent autosuspends.
1311 * However if the autoresume fails then the usage counter is re-decremented.
Alan Stern645daaa2006-08-30 15:47:02 -04001312 *
1313 * Often the caller will hold @udev's device lock, but this is not
1314 * necessary (and attempting it might cause deadlock).
1315 *
1316 * This routine can run only in process context.
1317 */
Alan Stern94fcda12006-11-20 11:38:46 -05001318int usb_autoresume_device(struct usb_device *udev)
Alan Stern645daaa2006-08-30 15:47:02 -04001319{
1320 int status;
1321
Alan Stern94fcda12006-11-20 11:38:46 -05001322 status = usb_autopm_do_device(udev, 1);
Alan Stern20dfdad2007-05-22 11:50:17 -04001323 dev_vdbg(&udev->dev, "%s: status %d cnt %d\n",
1324 __FUNCTION__, status, udev->pm_usage_cnt);
Alan Stern645daaa2006-08-30 15:47:02 -04001325 return status;
1326}
1327
Alan Sternaf4f7602006-10-30 17:06:45 -05001328/* Internal routine to adjust an interface's usage counter and change
1329 * its device's autosuspend state.
1330 */
1331static int usb_autopm_do_interface(struct usb_interface *intf,
1332 int inc_usage_cnt)
1333{
1334 struct usb_device *udev = interface_to_usbdev(intf);
1335 int status = 0;
1336
1337 usb_pm_lock(udev);
1338 if (intf->condition == USB_INTERFACE_UNBOUND)
1339 status = -ENODEV;
1340 else {
Alan Stern19410442007-03-27 13:33:59 -04001341 udev->auto_pm = 1;
Alan Sternaf4f7602006-10-30 17:06:45 -05001342 intf->pm_usage_cnt += inc_usage_cnt;
Alan Stern013d27f2007-08-20 12:18:39 -04001343 udev->last_busy = jiffies;
Alan Sternaf4f7602006-10-30 17:06:45 -05001344 if (inc_usage_cnt >= 0 && intf->pm_usage_cnt > 0) {
Alan Stern19410442007-03-27 13:33:59 -04001345 if (udev->state == USB_STATE_SUSPENDED)
1346 status = usb_resume_both(udev);
Alan Sternaf4f7602006-10-30 17:06:45 -05001347 if (status != 0)
1348 intf->pm_usage_cnt -= inc_usage_cnt;
Alan Stern013d27f2007-08-20 12:18:39 -04001349 else
Alan Stern19410442007-03-27 13:33:59 -04001350 udev->last_busy = jiffies;
1351 } else if (inc_usage_cnt <= 0 && intf->pm_usage_cnt <= 0) {
Alan Stern19410442007-03-27 13:33:59 -04001352 status = usb_suspend_both(udev, PMSG_SUSPEND);
1353 }
Alan Sternaf4f7602006-10-30 17:06:45 -05001354 }
1355 usb_pm_unlock(udev);
1356 return status;
1357}
1358
Alan Stern645daaa2006-08-30 15:47:02 -04001359/**
1360 * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
Henrik Kretzschmar701f35a2006-09-25 17:00:56 -07001361 * @intf: the usb_interface whose counter should be decremented
Alan Stern645daaa2006-08-30 15:47:02 -04001362 *
1363 * This routine should be called by an interface driver when it is
1364 * finished using @intf and wants to allow it to autosuspend. A typical
1365 * example would be a character-device driver when its device file is
1366 * closed.
1367 *
1368 * The routine decrements @intf's usage counter. When the counter reaches
1369 * 0, a delayed autosuspend request for @intf's device is queued. When
1370 * the delay expires, if @intf->pm_usage_cnt is still <= 0 along with all
1371 * the other usage counters for the sibling interfaces and @intf's
1372 * usb_device, the device and all its interfaces will be autosuspended.
1373 *
1374 * Note that @intf->pm_usage_cnt is owned by the interface driver. The
1375 * core will not change its value other than the increment and decrement
1376 * in usb_autopm_get_interface and usb_autopm_put_interface. The driver
1377 * may use this simple counter-oriented discipline or may set the value
1378 * any way it likes.
1379 *
1380 * If the driver has set @intf->needs_remote_wakeup then autosuspend will
1381 * take place only if the device's remote-wakeup facility is enabled.
1382 *
1383 * Suspend method calls queued by this routine can arrive at any time
1384 * while @intf is resumed and its usage counter is equal to 0. They are
1385 * not protected by the usb_device's lock but only by its pm_mutex.
1386 * Drivers must provide their own synchronization.
1387 *
1388 * This routine can run only in process context.
1389 */
1390void usb_autopm_put_interface(struct usb_interface *intf)
1391{
Alan Sternaf4f7602006-10-30 17:06:45 -05001392 int status;
Alan Stern645daaa2006-08-30 15:47:02 -04001393
Alan Sternaf4f7602006-10-30 17:06:45 -05001394 status = usb_autopm_do_interface(intf, -1);
Alan Stern20dfdad2007-05-22 11:50:17 -04001395 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1396 __FUNCTION__, status, intf->pm_usage_cnt);
Alan Stern645daaa2006-08-30 15:47:02 -04001397}
1398EXPORT_SYMBOL_GPL(usb_autopm_put_interface);
1399
1400/**
1401 * usb_autopm_get_interface - increment a USB interface's PM-usage counter
Henrik Kretzschmar701f35a2006-09-25 17:00:56 -07001402 * @intf: the usb_interface whose counter should be incremented
Alan Stern645daaa2006-08-30 15:47:02 -04001403 *
1404 * This routine should be called by an interface driver when it wants to
1405 * use @intf and needs to guarantee that it is not suspended. In addition,
1406 * the routine prevents @intf from being autosuspended subsequently. (Note
1407 * that this will not prevent suspend events originating in the PM core.)
1408 * This prevention will persist until usb_autopm_put_interface() is called
1409 * or @intf is unbound. A typical example would be a character-device
1410 * driver when its device file is opened.
1411 *
Alan Stern19410442007-03-27 13:33:59 -04001412 *
1413 * The routine increments @intf's usage counter. (However if the
1414 * autoresume fails then the counter is re-decremented.) So long as the
1415 * counter is greater than 0, autosuspend will not be allowed for @intf
1416 * or its usb_device. When the driver is finished using @intf it should
1417 * call usb_autopm_put_interface() to decrement the usage counter and
1418 * queue a delayed autosuspend request (if the counter is <= 0).
1419 *
Alan Stern645daaa2006-08-30 15:47:02 -04001420 *
1421 * Note that @intf->pm_usage_cnt is owned by the interface driver. The
1422 * core will not change its value other than the increment and decrement
1423 * in usb_autopm_get_interface and usb_autopm_put_interface. The driver
1424 * may use this simple counter-oriented discipline or may set the value
1425 * any way it likes.
1426 *
1427 * Resume method calls generated by this routine can arrive at any time
1428 * while @intf is suspended. They are not protected by the usb_device's
1429 * lock but only by its pm_mutex. Drivers must provide their own
1430 * synchronization.
1431 *
1432 * This routine can run only in process context.
1433 */
1434int usb_autopm_get_interface(struct usb_interface *intf)
1435{
Alan Sternaf4f7602006-10-30 17:06:45 -05001436 int status;
Alan Stern645daaa2006-08-30 15:47:02 -04001437
Alan Sternaf4f7602006-10-30 17:06:45 -05001438 status = usb_autopm_do_interface(intf, 1);
Alan Stern20dfdad2007-05-22 11:50:17 -04001439 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1440 __FUNCTION__, status, intf->pm_usage_cnt);
Alan Stern645daaa2006-08-30 15:47:02 -04001441 return status;
1442}
1443EXPORT_SYMBOL_GPL(usb_autopm_get_interface);
1444
Alan Stern692a1862006-10-30 17:07:51 -05001445/**
1446 * usb_autopm_set_interface - set a USB interface's autosuspend state
1447 * @intf: the usb_interface whose state should be set
1448 *
1449 * This routine sets the autosuspend state of @intf's device according
1450 * to @intf's usage counter, which the caller must have set previously.
1451 * If the counter is <= 0, the device is autosuspended (if it isn't
1452 * already suspended and if nothing else prevents the autosuspend). If
1453 * the counter is > 0, the device is autoresumed (if it isn't already
1454 * awake).
1455 */
1456int usb_autopm_set_interface(struct usb_interface *intf)
1457{
1458 int status;
1459
1460 status = usb_autopm_do_interface(intf, 0);
Alan Stern20dfdad2007-05-22 11:50:17 -04001461 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1462 __FUNCTION__, status, intf->pm_usage_cnt);
Alan Stern692a1862006-10-30 17:07:51 -05001463 return status;
1464}
1465EXPORT_SYMBOL_GPL(usb_autopm_set_interface);
1466
Alan Stern718efa62007-03-09 15:41:13 -05001467#else
1468
1469void usb_autosuspend_work(struct work_struct *work)
1470{}
1471
Alan Stern645daaa2006-08-30 15:47:02 -04001472#endif /* CONFIG_USB_SUSPEND */
1473
Alan Stern6b157c92007-03-13 16:37:30 -04001474/**
1475 * usb_external_suspend_device - external suspend of a USB device and its interfaces
1476 * @udev: the usb_device to suspend
1477 * @msg: Power Management message describing this state transition
1478 *
1479 * This routine handles external suspend requests: ones not generated
1480 * internally by a USB driver (autosuspend) but rather coming from the user
1481 * (via sysfs) or the PM core (system sleep). The suspend will be carried
1482 * out regardless of @udev's usage counter or those of its interfaces,
1483 * and regardless of whether or not remote wakeup is enabled. Of course,
1484 * interface drivers still have the option of failing the suspend (if
1485 * there are unsuspended children, for example).
1486 *
1487 * The caller must hold @udev's device lock.
1488 */
1489int usb_external_suspend_device(struct usb_device *udev, pm_message_t msg)
Alan Stern1cc8a252006-07-01 22:10:15 -04001490{
1491 int status;
1492
Alan Stern6b157c92007-03-13 16:37:30 -04001493 usb_pm_lock(udev);
1494 udev->auto_pm = 0;
1495 status = usb_suspend_both(udev, msg);
1496 usb_pm_unlock(udev);
Alan Stern1cc8a252006-07-01 22:10:15 -04001497 return status;
1498}
1499
Alan Stern6b157c92007-03-13 16:37:30 -04001500/**
1501 * usb_external_resume_device - external resume of a USB device and its interfaces
1502 * @udev: the usb_device to resume
1503 *
1504 * This routine handles external resume requests: ones not generated
1505 * internally by a USB driver (autoresume) but rather coming from the user
1506 * (via sysfs), the PM core (system resume), or the device itself (remote
1507 * wakeup). @udev's usage counter is unaffected.
1508 *
1509 * The caller must hold @udev's device lock.
1510 */
1511int usb_external_resume_device(struct usb_device *udev)
1512{
1513 int status;
1514
1515 usb_pm_lock(udev);
1516 udev->auto_pm = 0;
1517 status = usb_resume_both(udev);
Alan Sternef7f6c72007-04-05 16:03:49 -04001518 udev->last_busy = jiffies;
Alan Stern6b157c92007-03-13 16:37:30 -04001519 usb_pm_unlock(udev);
1520
1521 /* Now that the device is awake, we can start trying to autosuspend
1522 * it again. */
1523 if (status == 0)
1524 usb_try_autosuspend_device(udev);
1525 return status;
1526}
1527
1528static int usb_suspend(struct device *dev, pm_message_t message)
1529{
1530 if (!is_usb_device(dev)) /* Ignore PM for interfaces */
1531 return 0;
1532 return usb_external_suspend_device(to_usb_device(dev), message);
1533}
1534
Alan Stern1cc8a252006-07-01 22:10:15 -04001535static int usb_resume(struct device *dev)
1536{
Alan Stern2add5222007-03-20 14:59:39 -04001537 struct usb_device *udev;
1538
Alan Stern6b157c92007-03-13 16:37:30 -04001539 if (!is_usb_device(dev)) /* Ignore PM for interfaces */
1540 return 0;
Alan Stern2add5222007-03-20 14:59:39 -04001541 udev = to_usb_device(dev);
Alan Stern0458d5b2007-05-04 11:52:20 -04001542
1543 /* If autoresume is disabled then we also want to prevent resume
1544 * during system wakeup. However, a "persistent-device" reset-resume
1545 * after power loss counts as a wakeup event. So allow a
1546 * reset-resume to occur if remote wakeup is enabled. */
1547 if (udev->autoresume_disabled) {
1548 if (!(udev->reset_resume && udev->do_remote_wakeup))
1549 return -EPERM;
1550 }
Alan Stern2add5222007-03-20 14:59:39 -04001551 return usb_external_resume_device(udev);
Alan Stern1cc8a252006-07-01 22:10:15 -04001552}
1553
Alan Stern6b157c92007-03-13 16:37:30 -04001554#else
1555
1556#define usb_suspend NULL
1557#define usb_resume NULL
1558
Alan Stern36e56a32006-07-01 22:08:06 -04001559#endif /* CONFIG_PM */
1560
1561struct bus_type usb_bus_type = {
1562 .name = "usb",
1563 .match = usb_device_match,
1564 .uevent = usb_uevent,
Alan Stern782da722006-07-01 22:09:35 -04001565 .suspend = usb_suspend,
1566 .resume = usb_resume,
Alan Stern36e56a32006-07-01 22:08:06 -04001567};