blob: 63b1243a9139d7071a221255bdacde5e524b5996 [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
205 id = usb_match_id(intf, driver->id_table);
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800206 if (!id)
207 id = usb_match_dynamic_id(intf, driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800208 if (id) {
209 dev_dbg(dev, "%s - got id\n", __FUNCTION__);
210
Alan Stern94fcda12006-11-20 11:38:46 -0500211 error = usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -0400212 if (error)
213 return error;
214
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800215 /* Interface "power state" doesn't correspond to any hardware
216 * state whatsoever. We use it to record when it's bound to
217 * a driver that may start I/0: it's not frozen/quiesced.
218 */
219 mark_active(intf);
220 intf->condition = USB_INTERFACE_BINDING;
Alan Stern645daaa2006-08-30 15:47:02 -0400221
222 /* The interface should always appear to be in use
223 * unless the driver suports autosuspend.
224 */
225 intf->pm_usage_cnt = !(driver->supports_autosuspend);
226
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800227 error = driver->probe(intf, id);
228 if (error) {
229 mark_quiesced(intf);
Alan Stern645daaa2006-08-30 15:47:02 -0400230 intf->needs_remote_wakeup = 0;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800231 intf->condition = USB_INTERFACE_UNBOUND;
232 } else
233 intf->condition = USB_INTERFACE_BOUND;
Alan Stern645daaa2006-08-30 15:47:02 -0400234
Alan Stern94fcda12006-11-20 11:38:46 -0500235 usb_autosuspend_device(udev);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800236 }
237
238 return error;
239}
240
Alan Stern8bb54ab2006-07-01 22:08:49 -0400241/* called from driver core with dev locked */
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800242static int usb_unbind_interface(struct device *dev)
243{
Alan Stern8bb54ab2006-07-01 22:08:49 -0400244 struct usb_driver *driver = to_usb_driver(dev->driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800245 struct usb_interface *intf = to_usb_interface(dev);
Alan Stern645daaa2006-08-30 15:47:02 -0400246 struct usb_device *udev;
247 int error;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800248
249 intf->condition = USB_INTERFACE_UNBINDING;
250
Alan Stern645daaa2006-08-30 15:47:02 -0400251 /* Autoresume for set_interface call below */
252 udev = interface_to_usbdev(intf);
Alan Stern94fcda12006-11-20 11:38:46 -0500253 error = usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -0400254
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800255 /* release all urbs for this interface */
256 usb_disable_interface(interface_to_usbdev(intf), intf);
257
Alan Stern8bb54ab2006-07-01 22:08:49 -0400258 driver->disconnect(intf);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800259
260 /* reset other interface state */
261 usb_set_interface(interface_to_usbdev(intf),
262 intf->altsetting[0].desc.bInterfaceNumber,
263 0);
264 usb_set_intfdata(intf, NULL);
Alan Stern645daaa2006-08-30 15:47:02 -0400265
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800266 intf->condition = USB_INTERFACE_UNBOUND;
267 mark_quiesced(intf);
Alan Stern645daaa2006-08-30 15:47:02 -0400268 intf->needs_remote_wakeup = 0;
269
270 if (!error)
Alan Stern94fcda12006-11-20 11:38:46 -0500271 usb_autosuspend_device(udev);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800272
273 return 0;
274}
275
Alan Stern36e56a32006-07-01 22:08:06 -0400276/**
277 * usb_driver_claim_interface - bind a driver to an interface
278 * @driver: the driver to be bound
279 * @iface: the interface to which it will be bound; must be in the
280 * usb device's active configuration
281 * @priv: driver data associated with that interface
282 *
283 * This is used by usb device drivers that need to claim more than one
284 * interface on a device when probing (audio and acm are current examples).
285 * No device driver should directly modify internal usb_interface or
286 * usb_device structure members.
287 *
288 * Few drivers should need to use this routine, since the most natural
289 * way to bind to an interface is to return the private data from
290 * the driver's probe() method.
291 *
Greg Kroah-Hartman341487a82007-04-09 11:52:31 -0400292 * Callers must own the device lock, so driver probe() entries don't need
293 * extra locking, but other call contexts may need to explicitly claim that
294 * lock.
Alan Stern36e56a32006-07-01 22:08:06 -0400295 */
296int usb_driver_claim_interface(struct usb_driver *driver,
297 struct usb_interface *iface, void* priv)
298{
299 struct device *dev = &iface->dev;
Alan Stern645daaa2006-08-30 15:47:02 -0400300 struct usb_device *udev = interface_to_usbdev(iface);
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700301 int retval = 0;
Alan Stern36e56a32006-07-01 22:08:06 -0400302
303 if (dev->driver)
304 return -EBUSY;
305
Alan Stern8bb54ab2006-07-01 22:08:49 -0400306 dev->driver = &driver->drvwrap.driver;
Alan Stern36e56a32006-07-01 22:08:06 -0400307 usb_set_intfdata(iface, priv);
Alan Stern645daaa2006-08-30 15:47:02 -0400308
Alan Sterne0318eb2006-09-26 14:50:20 -0400309 usb_pm_lock(udev);
Alan Stern36e56a32006-07-01 22:08:06 -0400310 iface->condition = USB_INTERFACE_BOUND;
311 mark_active(iface);
Alan Stern645daaa2006-08-30 15:47:02 -0400312 iface->pm_usage_cnt = !(driver->supports_autosuspend);
Alan Sterne0318eb2006-09-26 14:50:20 -0400313 usb_pm_unlock(udev);
Alan Stern36e56a32006-07-01 22:08:06 -0400314
315 /* if interface was already added, bind now; else let
316 * the future device_add() bind it, bypassing probe()
317 */
318 if (device_is_registered(dev))
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700319 retval = device_bind_driver(dev);
Alan Stern36e56a32006-07-01 22:08:06 -0400320
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700321 return retval;
Alan Stern36e56a32006-07-01 22:08:06 -0400322}
323EXPORT_SYMBOL(usb_driver_claim_interface);
324
325/**
326 * usb_driver_release_interface - unbind a driver from an interface
327 * @driver: the driver to be unbound
328 * @iface: the interface from which it will be unbound
329 *
330 * This can be used by drivers to release an interface without waiting
331 * for their disconnect() methods to be called. In typical cases this
332 * also causes the driver disconnect() method to be called.
333 *
334 * This call is synchronous, and may not be used in an interrupt context.
Greg Kroah-Hartman341487a82007-04-09 11:52:31 -0400335 * Callers must own the device lock, so driver disconnect() entries don't
336 * need extra locking, but other call contexts may need to explicitly claim
337 * that lock.
Alan Stern36e56a32006-07-01 22:08:06 -0400338 */
339void usb_driver_release_interface(struct usb_driver *driver,
340 struct usb_interface *iface)
341{
342 struct device *dev = &iface->dev;
Alan Stern645daaa2006-08-30 15:47:02 -0400343 struct usb_device *udev = interface_to_usbdev(iface);
Alan Stern36e56a32006-07-01 22:08:06 -0400344
345 /* this should never happen, don't release something that's not ours */
Alan Stern8bb54ab2006-07-01 22:08:49 -0400346 if (!dev->driver || dev->driver != &driver->drvwrap.driver)
Alan Stern36e56a32006-07-01 22:08:06 -0400347 return;
348
349 /* don't release from within disconnect() */
350 if (iface->condition != USB_INTERFACE_BOUND)
351 return;
352
353 /* don't release if the interface hasn't been added yet */
354 if (device_is_registered(dev)) {
355 iface->condition = USB_INTERFACE_UNBINDING;
356 device_release_driver(dev);
357 }
358
359 dev->driver = NULL;
360 usb_set_intfdata(iface, NULL);
Alan Stern645daaa2006-08-30 15:47:02 -0400361
Alan Sterne0318eb2006-09-26 14:50:20 -0400362 usb_pm_lock(udev);
Alan Stern36e56a32006-07-01 22:08:06 -0400363 iface->condition = USB_INTERFACE_UNBOUND;
364 mark_quiesced(iface);
Alan Stern645daaa2006-08-30 15:47:02 -0400365 iface->needs_remote_wakeup = 0;
Alan Sterne0318eb2006-09-26 14:50:20 -0400366 usb_pm_unlock(udev);
Alan Stern36e56a32006-07-01 22:08:06 -0400367}
368EXPORT_SYMBOL(usb_driver_release_interface);
369
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800370/* returns 0 if no match, 1 if match */
Greg Kroah-Hartmanbb417022007-01-26 14:26:21 +0100371int usb_match_device(struct usb_device *dev, const struct usb_device_id *id)
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800372{
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800373 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
374 id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
375 return 0;
376
377 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
378 id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
379 return 0;
380
381 /* No need to test id->bcdDevice_lo != 0, since 0 is never
382 greater than any unsigned number. */
383 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
384 (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice)))
385 return 0;
386
387 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
388 (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
389 return 0;
390
391 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
392 (id->bDeviceClass != dev->descriptor.bDeviceClass))
393 return 0;
394
395 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
396 (id->bDeviceSubClass!= dev->descriptor.bDeviceSubClass))
397 return 0;
398
399 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
400 (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
401 return 0;
402
Greg Kroah-Hartmanbb417022007-01-26 14:26:21 +0100403 return 1;
404}
405
406/* returns 0 if no match, 1 if match */
407int usb_match_one_id(struct usb_interface *interface,
408 const struct usb_device_id *id)
409{
410 struct usb_host_interface *intf;
411 struct usb_device *dev;
412
413 /* proc_connectinfo in devio.c may call us with id == NULL. */
414 if (id == NULL)
415 return 0;
416
417 intf = interface->cur_altsetting;
418 dev = interface_to_usbdev(interface);
419
420 if (!usb_match_device(dev, id))
421 return 0;
422
Alan Stern93c8bf42006-10-18 16:41:51 -0400423 /* The interface class, subclass, and protocol should never be
424 * checked for a match if the device class is Vendor Specific,
425 * unless the match record specifies the Vendor ID. */
426 if (dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC &&
427 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
428 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
429 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
430 USB_DEVICE_ID_MATCH_INT_PROTOCOL)))
431 return 0;
432
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800433 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
434 (id->bInterfaceClass != intf->desc.bInterfaceClass))
435 return 0;
436
437 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
438 (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
439 return 0;
440
441 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
442 (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
443 return 0;
444
445 return 1;
446}
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100447EXPORT_SYMBOL_GPL(usb_match_one_id);
448
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800449/**
450 * usb_match_id - find first usb_device_id matching device or interface
451 * @interface: the interface of interest
452 * @id: array of usb_device_id structures, terminated by zero entry
453 *
454 * usb_match_id searches an array of usb_device_id's and returns
455 * the first one matching the device or interface, or null.
456 * This is used when binding (or rebinding) a driver to an interface.
457 * Most USB device drivers will use this indirectly, through the usb core,
458 * but some layered driver frameworks use it directly.
459 * These device tables are exported with MODULE_DEVICE_TABLE, through
460 * modutils, to support the driver loading functionality of USB hotplugging.
461 *
462 * What Matches:
463 *
464 * The "match_flags" element in a usb_device_id controls which
465 * members are used. If the corresponding bit is set, the
466 * value in the device_id must match its corresponding member
467 * in the device or interface descriptor, or else the device_id
468 * does not match.
469 *
470 * "driver_info" is normally used only by device drivers,
471 * but you can create a wildcard "matches anything" usb_device_id
472 * as a driver's "modules.usbmap" entry if you provide an id with
473 * only a nonzero "driver_info" field. If you do this, the USB device
474 * driver's probe() routine should use additional intelligence to
475 * decide whether to bind to the specified interface.
476 *
477 * What Makes Good usb_device_id Tables:
478 *
479 * The match algorithm is very simple, so that intelligence in
480 * driver selection must come from smart driver id records.
481 * Unless you have good reasons to use another selection policy,
482 * provide match elements only in related groups, and order match
483 * specifiers from specific to general. Use the macros provided
484 * for that purpose if you can.
485 *
486 * The most specific match specifiers use device descriptor
487 * data. These are commonly used with product-specific matches;
488 * the USB_DEVICE macro lets you provide vendor and product IDs,
489 * and you can also match against ranges of product revisions.
490 * These are widely used for devices with application or vendor
491 * specific bDeviceClass values.
492 *
493 * Matches based on device class/subclass/protocol specifications
494 * are slightly more general; use the USB_DEVICE_INFO macro, or
495 * its siblings. These are used with single-function devices
496 * where bDeviceClass doesn't specify that each interface has
497 * its own class.
498 *
499 * Matches based on interface class/subclass/protocol are the
500 * most general; they let drivers bind to any interface on a
501 * multiple-function device. Use the USB_INTERFACE_INFO
502 * macro, or its siblings, to match class-per-interface style
Alan Stern93c8bf42006-10-18 16:41:51 -0400503 * devices (as recorded in bInterfaceClass).
504 *
505 * Note that an entry created by USB_INTERFACE_INFO won't match
506 * any interface if the device class is set to Vendor-Specific.
507 * This is deliberate; according to the USB spec the meanings of
508 * the interface class/subclass/protocol for these devices are also
509 * vendor-specific, and hence matching against a standard product
510 * class wouldn't work anyway. If you really want to use an
511 * interface-based match for such a device, create a match record
512 * that also specifies the vendor ID. (Unforunately there isn't a
513 * standard macro for creating records like this.)
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800514 *
515 * Within those groups, remember that not all combinations are
516 * meaningful. For example, don't give a product version range
517 * without vendor and product IDs; or specify a protocol without
518 * its associated class and subclass.
519 */
520const struct usb_device_id *usb_match_id(struct usb_interface *interface,
521 const struct usb_device_id *id)
522{
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800523 /* proc_connectinfo in devio.c may call us with id == NULL. */
524 if (id == NULL)
525 return NULL;
526
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800527 /* It is important to check that id->driver_info is nonzero,
528 since an entry that is all zeroes except for a nonzero
529 id->driver_info is the way to create an entry that
530 indicates that the driver want to examine every
531 device and interface. */
532 for (; id->idVendor || id->bDeviceClass || id->bInterfaceClass ||
533 id->driver_info; id++) {
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800534 if (usb_match_one_id(interface, id))
535 return id;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800536 }
537
538 return NULL;
539}
Greg Kroah-Hartmanb87ba0a2006-03-20 13:17:13 -0800540EXPORT_SYMBOL_GPL_FUTURE(usb_match_id);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800541
Adrian Bunk8bb22d22006-11-21 22:02:54 +0100542static int usb_device_match(struct device *dev, struct device_driver *drv)
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800543{
Alan Stern8bb54ab2006-07-01 22:08:49 -0400544 /* devices and interfaces are handled separately */
545 if (is_usb_device(dev)) {
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800546
Alan Stern8bb54ab2006-07-01 22:08:49 -0400547 /* interface drivers never match devices */
548 if (!is_usb_device_driver(drv))
549 return 0;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800550
Alan Stern8bb54ab2006-07-01 22:08:49 -0400551 /* TODO: Add real matching code */
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800552 return 1;
553
Alan Stern8bb54ab2006-07-01 22:08:49 -0400554 } else {
555 struct usb_interface *intf;
556 struct usb_driver *usb_drv;
557 const struct usb_device_id *id;
558
559 /* device drivers never match interfaces */
560 if (is_usb_device_driver(drv))
561 return 0;
562
563 intf = to_usb_interface(dev);
564 usb_drv = to_usb_driver(drv);
565
566 id = usb_match_id(intf, usb_drv->id_table);
567 if (id)
568 return 1;
569
570 id = usb_match_dynamic_id(intf, usb_drv);
571 if (id)
572 return 1;
573 }
574
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800575 return 0;
576}
577
Alan Stern36e56a32006-07-01 22:08:06 -0400578#ifdef CONFIG_HOTPLUG
Alan Stern36e56a32006-07-01 22:08:06 -0400579static int usb_uevent(struct device *dev, char **envp, int num_envp,
580 char *buffer, int buffer_size)
581{
Alan Stern36e56a32006-07-01 22:08:06 -0400582 struct usb_device *usb_dev;
Alan Stern36e56a32006-07-01 22:08:06 -0400583 int i = 0;
584 int length = 0;
585
586 if (!dev)
587 return -ENODEV;
588
589 /* driver is often null here; dev_dbg() would oops */
590 pr_debug ("usb %s: uevent\n", dev->bus_id);
591
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100592 if (is_usb_device(dev))
Alan Stern782da722006-07-01 22:09:35 -0400593 usb_dev = to_usb_device(dev);
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100594 else {
595 struct usb_interface *intf = to_usb_interface(dev);
Alan Stern8bb54ab2006-07-01 22:08:49 -0400596 usb_dev = interface_to_usbdev(intf);
Alan Stern8bb54ab2006-07-01 22:08:49 -0400597 }
Alan Stern36e56a32006-07-01 22:08:06 -0400598
599 if (usb_dev->devnum < 0) {
600 pr_debug ("usb %s: already deleted?\n", dev->bus_id);
601 return -ENODEV;
602 }
603 if (!usb_dev->bus) {
604 pr_debug ("usb %s: bus removed?\n", dev->bus_id);
605 return -ENODEV;
606 }
607
608#ifdef CONFIG_USB_DEVICEFS
609 /* If this is available, userspace programs can directly read
610 * all the device descriptors we don't tell them about. Or
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100611 * act as usermode drivers.
Alan Stern36e56a32006-07-01 22:08:06 -0400612 */
613 if (add_uevent_var(envp, num_envp, &i,
614 buffer, buffer_size, &length,
615 "DEVICE=/proc/bus/usb/%03d/%03d",
616 usb_dev->bus->busnum, usb_dev->devnum))
617 return -ENOMEM;
618#endif
619
620 /* per-device configurations are common */
621 if (add_uevent_var(envp, num_envp, &i,
622 buffer, buffer_size, &length,
623 "PRODUCT=%x/%x/%x",
624 le16_to_cpu(usb_dev->descriptor.idVendor),
625 le16_to_cpu(usb_dev->descriptor.idProduct),
626 le16_to_cpu(usb_dev->descriptor.bcdDevice)))
627 return -ENOMEM;
628
629 /* class-based driver binding models */
630 if (add_uevent_var(envp, num_envp, &i,
631 buffer, buffer_size, &length,
632 "TYPE=%d/%d/%d",
633 usb_dev->descriptor.bDeviceClass,
634 usb_dev->descriptor.bDeviceSubClass,
635 usb_dev->descriptor.bDeviceProtocol))
636 return -ENOMEM;
637
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100638 if (add_uevent_var(envp, num_envp, &i,
Alan Stern36e56a32006-07-01 22:08:06 -0400639 buffer, buffer_size, &length,
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100640 "BUSNUM=%03d",
641 usb_dev->bus->busnum))
642 return -ENOMEM;
Alan Stern36e56a32006-07-01 22:08:06 -0400643
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100644 if (add_uevent_var(envp, num_envp, &i,
Alan Stern36e56a32006-07-01 22:08:06 -0400645 buffer, buffer_size, &length,
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100646 "DEVNUM=%03d",
647 usb_dev->devnum))
648 return -ENOMEM;
Alan Stern36e56a32006-07-01 22:08:06 -0400649
650 envp[i] = NULL;
Alan Stern36e56a32006-07-01 22:08:06 -0400651 return 0;
652}
653
654#else
655
656static int usb_uevent(struct device *dev, char **envp,
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100657 int num_envp, char *buffer, int buffer_size)
Alan Stern36e56a32006-07-01 22:08:06 -0400658{
659 return -ENODEV;
660}
Alan Stern36e56a32006-07-01 22:08:06 -0400661#endif /* CONFIG_HOTPLUG */
662
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800663/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400664 * usb_register_device_driver - register a USB device (not interface) driver
665 * @new_udriver: USB operations for the device driver
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -0800666 * @owner: module owner of this driver.
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800667 *
Alan Stern8bb54ab2006-07-01 22:08:49 -0400668 * Registers a USB device driver with the USB core. The list of
669 * unattached devices will be rescanned whenever a new driver is
670 * added, allowing the new driver to attach to any recognized devices.
671 * Returns a negative error code on failure and 0 on success.
672 */
673int usb_register_device_driver(struct usb_device_driver *new_udriver,
674 struct module *owner)
675{
676 int retval = 0;
677
678 if (usb_disabled())
679 return -ENODEV;
680
681 new_udriver->drvwrap.for_devices = 1;
682 new_udriver->drvwrap.driver.name = (char *) new_udriver->name;
683 new_udriver->drvwrap.driver.bus = &usb_bus_type;
684 new_udriver->drvwrap.driver.probe = usb_probe_device;
685 new_udriver->drvwrap.driver.remove = usb_unbind_device;
686 new_udriver->drvwrap.driver.owner = owner;
687
688 retval = driver_register(&new_udriver->drvwrap.driver);
689
690 if (!retval) {
691 pr_info("%s: registered new device driver %s\n",
692 usbcore_name, new_udriver->name);
693 usbfs_update_special();
694 } else {
695 printk(KERN_ERR "%s: error %d registering device "
696 " driver %s\n",
697 usbcore_name, retval, new_udriver->name);
698 }
699
700 return retval;
701}
702EXPORT_SYMBOL_GPL(usb_register_device_driver);
703
704/**
705 * usb_deregister_device_driver - unregister a USB device (not interface) driver
706 * @udriver: USB operations of the device driver to unregister
707 * Context: must be able to sleep
708 *
709 * Unlinks the specified driver from the internal USB driver list.
710 */
711void usb_deregister_device_driver(struct usb_device_driver *udriver)
712{
713 pr_info("%s: deregistering device driver %s\n",
714 usbcore_name, udriver->name);
715
716 driver_unregister(&udriver->drvwrap.driver);
717 usbfs_update_special();
718}
719EXPORT_SYMBOL_GPL(usb_deregister_device_driver);
720
721/**
722 * usb_register_driver - register a USB interface driver
723 * @new_driver: USB operations for the interface driver
724 * @owner: module owner of this driver.
Randy Dunlap892705a2007-02-10 14:41:41 -0800725 * @mod_name: module name string
Alan Stern8bb54ab2006-07-01 22:08:49 -0400726 *
727 * Registers a USB interface driver with the USB core. The list of
728 * unattached interfaces will be rescanned whenever a new driver is
729 * added, allowing the new driver to attach to any recognized interfaces.
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800730 * Returns a negative error code on failure and 0 on success.
731 *
732 * NOTE: if you want your driver to use the USB major number, you must call
733 * usb_register_dev() to enable that functionality. This function no longer
734 * takes care of that.
735 */
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800736int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
737 const char *mod_name)
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800738{
739 int retval = 0;
740
741 if (usb_disabled())
742 return -ENODEV;
743
Alan Stern8bb54ab2006-07-01 22:08:49 -0400744 new_driver->drvwrap.for_devices = 0;
745 new_driver->drvwrap.driver.name = (char *) new_driver->name;
746 new_driver->drvwrap.driver.bus = &usb_bus_type;
747 new_driver->drvwrap.driver.probe = usb_probe_interface;
748 new_driver->drvwrap.driver.remove = usb_unbind_interface;
749 new_driver->drvwrap.driver.owner = owner;
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800750 new_driver->drvwrap.driver.mod_name = mod_name;
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800751 spin_lock_init(&new_driver->dynids.lock);
752 INIT_LIST_HEAD(&new_driver->dynids.list);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800753
Alan Stern8bb54ab2006-07-01 22:08:49 -0400754 retval = driver_register(&new_driver->drvwrap.driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800755
756 if (!retval) {
Alan Stern8bb54ab2006-07-01 22:08:49 -0400757 pr_info("%s: registered new interface driver %s\n",
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800758 usbcore_name, new_driver->name);
759 usbfs_update_special();
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800760 usb_create_newid_file(new_driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800761 } else {
Alan Stern8bb54ab2006-07-01 22:08:49 -0400762 printk(KERN_ERR "%s: error %d registering interface "
763 " driver %s\n",
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800764 usbcore_name, retval, new_driver->name);
765 }
766
767 return retval;
768}
Greg Kroah-Hartmanb87ba0a2006-03-20 13:17:13 -0800769EXPORT_SYMBOL_GPL_FUTURE(usb_register_driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800770
771/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400772 * usb_deregister - unregister a USB interface driver
773 * @driver: USB operations of the interface driver to unregister
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800774 * Context: must be able to sleep
775 *
776 * Unlinks the specified driver from the internal USB driver list.
777 *
778 * NOTE: If you called usb_register_dev(), you still need to call
779 * usb_deregister_dev() to clean up your driver's allocated minor numbers,
780 * this * call will no longer do it for you.
781 */
782void usb_deregister(struct usb_driver *driver)
783{
Alan Stern8bb54ab2006-07-01 22:08:49 -0400784 pr_info("%s: deregistering interface driver %s\n",
785 usbcore_name, driver->name);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800786
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800787 usb_remove_newid_file(driver);
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800788 usb_free_dynids(driver);
Alan Stern8bb54ab2006-07-01 22:08:49 -0400789 driver_unregister(&driver->drvwrap.driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800790
791 usbfs_update_special();
792}
Greg Kroah-Hartmanb87ba0a2006-03-20 13:17:13 -0800793EXPORT_SYMBOL_GPL_FUTURE(usb_deregister);
Alan Stern36e56a32006-07-01 22:08:06 -0400794
795#ifdef CONFIG_PM
796
Alan Sterne0318eb2006-09-26 14:50:20 -0400797/* Caller has locked udev's pm_mutex */
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -0800798static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
Alan Stern36e56a32006-07-01 22:08:06 -0400799{
Alan Stern782da722006-07-01 22:09:35 -0400800 struct usb_device_driver *udriver;
Alan Stern2bf40862006-07-01 22:12:19 -0400801 int status = 0;
Alan Stern36e56a32006-07-01 22:08:06 -0400802
Alan Stern114b3682006-07-01 22:13:04 -0400803 if (udev->state == USB_STATE_NOTATTACHED ||
804 udev->state == USB_STATE_SUSPENDED)
805 goto done;
806
Alan Sternb6f64362007-05-04 11:51:54 -0400807 /* For devices that don't have a driver, we do a generic suspend. */
808 if (udev->dev.driver)
809 udriver = to_usb_device_driver(udev->dev.driver);
810 else {
Alan Stern645daaa2006-08-30 15:47:02 -0400811 udev->do_remote_wakeup = 0;
Alan Sternb6f64362007-05-04 11:51:54 -0400812 udriver = &usb_generic_driver;
Alan Stern1c5df7e2006-07-01 22:13:50 -0400813 }
Alan Stern2bf40862006-07-01 22:12:19 -0400814 status = udriver->suspend(udev, msg);
815
Alan Stern20dfdad2007-05-22 11:50:17 -0400816 done:
817 dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
Alan Stern2bf40862006-07-01 22:12:19 -0400818 if (status == 0)
819 udev->dev.power.power_state.event = msg.event;
820 return status;
Alan Stern1cc8a252006-07-01 22:10:15 -0400821}
Alan Stern36e56a32006-07-01 22:08:06 -0400822
Alan Sterne0318eb2006-09-26 14:50:20 -0400823/* Caller has locked udev's pm_mutex */
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -0800824static int usb_resume_device(struct usb_device *udev)
Alan Stern1cc8a252006-07-01 22:10:15 -0400825{
826 struct usb_device_driver *udriver;
Alan Stern2bf40862006-07-01 22:12:19 -0400827 int status = 0;
Alan Stern1cc8a252006-07-01 22:10:15 -0400828
Alan Stern0458d5b2007-05-04 11:52:20 -0400829 if (udev->state == USB_STATE_NOTATTACHED)
830 goto done;
831 if (udev->state != USB_STATE_SUSPENDED && !udev->reset_resume)
Alan Stern2bf40862006-07-01 22:12:19 -0400832 goto done;
Alan Stern1cc8a252006-07-01 22:10:15 -0400833
Alan Stern1c5df7e2006-07-01 22:13:50 -0400834 /* Can't resume it if it doesn't have a driver. */
835 if (udev->dev.driver == NULL) {
836 status = -ENOTCONN;
Alan Stern2bf40862006-07-01 22:12:19 -0400837 goto done;
Alan Stern1c5df7e2006-07-01 22:13:50 -0400838 }
839
Alan Stern6bc6cff2007-05-04 11:53:03 -0400840 if (udev->quirks & USB_QUIRK_RESET_RESUME)
841 udev->reset_resume = 1;
842
Alan Stern1cc8a252006-07-01 22:10:15 -0400843 udriver = to_usb_device_driver(udev->dev.driver);
Alan Stern2bf40862006-07-01 22:12:19 -0400844 status = udriver->resume(udev);
845
Alan Stern20dfdad2007-05-22 11:50:17 -0400846 done:
847 dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
Alan Stern2add5222007-03-20 14:59:39 -0400848 if (status == 0) {
849 udev->autoresume_disabled = 0;
Alan Stern2bf40862006-07-01 22:12:19 -0400850 udev->dev.power.power_state.event = PM_EVENT_ON;
Alan Stern2add5222007-03-20 14:59:39 -0400851 }
Alan Stern2bf40862006-07-01 22:12:19 -0400852 return status;
Alan Stern1cc8a252006-07-01 22:10:15 -0400853}
854
Alan Sterne0318eb2006-09-26 14:50:20 -0400855/* Caller has locked intf's usb_device's pm mutex */
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -0800856static int usb_suspend_interface(struct usb_interface *intf, pm_message_t msg)
Alan Stern1cc8a252006-07-01 22:10:15 -0400857{
858 struct usb_driver *driver;
Alan Stern2bf40862006-07-01 22:12:19 -0400859 int status = 0;
Alan Stern1cc8a252006-07-01 22:10:15 -0400860
Alan Stern114b3682006-07-01 22:13:04 -0400861 /* with no hardware, USB interfaces only use FREEZE and ON states */
862 if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
863 !is_active(intf))
864 goto done;
865
Alan Stern645daaa2006-08-30 15:47:02 -0400866 if (intf->condition == USB_INTERFACE_UNBOUND) /* This can't happen */
Alan Stern2bf40862006-07-01 22:12:19 -0400867 goto done;
Alan Stern1cc8a252006-07-01 22:10:15 -0400868 driver = to_usb_driver(intf->dev.driver);
Alan Stern36e56a32006-07-01 22:08:06 -0400869
Alan Stern36e56a32006-07-01 22:08:06 -0400870 if (driver->suspend && driver->resume) {
Alan Stern1cc8a252006-07-01 22:10:15 -0400871 status = driver->suspend(intf, msg);
Alan Stern645daaa2006-08-30 15:47:02 -0400872 if (status == 0)
873 mark_quiesced(intf);
874 else if (!interface_to_usbdev(intf)->auto_pm)
Alan Stern1cc8a252006-07-01 22:10:15 -0400875 dev_err(&intf->dev, "%s error %d\n",
876 "suspend", status);
Alan Stern36e56a32006-07-01 22:08:06 -0400877 } else {
878 // FIXME else if there's no suspend method, disconnect...
Alan Stern645daaa2006-08-30 15:47:02 -0400879 // Not possible if auto_pm is set...
Alan Stern1cc8a252006-07-01 22:10:15 -0400880 dev_warn(&intf->dev, "no suspend for driver %s?\n",
881 driver->name);
Alan Stern36e56a32006-07-01 22:08:06 -0400882 mark_quiesced(intf);
Alan Stern36e56a32006-07-01 22:08:06 -0400883 }
Alan Stern2bf40862006-07-01 22:12:19 -0400884
Alan Stern20dfdad2007-05-22 11:50:17 -0400885 done:
886 dev_vdbg(&intf->dev, "%s: status %d\n", __FUNCTION__, status);
Alan Stern36e56a32006-07-01 22:08:06 -0400887 return status;
888}
889
Alan Stern645daaa2006-08-30 15:47:02 -0400890/* Caller has locked intf's usb_device's pm_mutex */
Alan Stern0458d5b2007-05-04 11:52:20 -0400891static int usb_resume_interface(struct usb_interface *intf, int reset_resume)
Alan Stern36e56a32006-07-01 22:08:06 -0400892{
Alan Stern1cc8a252006-07-01 22:10:15 -0400893 struct usb_driver *driver;
Alan Stern2bf40862006-07-01 22:12:19 -0400894 int status = 0;
Alan Stern36e56a32006-07-01 22:08:06 -0400895
Alan Stern114b3682006-07-01 22:13:04 -0400896 if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
897 is_active(intf))
Alan Stern2bf40862006-07-01 22:12:19 -0400898 goto done;
Alan Stern36e56a32006-07-01 22:08:06 -0400899
Alan Stern645daaa2006-08-30 15:47:02 -0400900 /* Don't let autoresume interfere with unbinding */
901 if (intf->condition == USB_INTERFACE_UNBINDING)
902 goto done;
903
Alan Stern1c5df7e2006-07-01 22:13:50 -0400904 /* Can't resume it if it doesn't have a driver. */
Alan Stern645daaa2006-08-30 15:47:02 -0400905 if (intf->condition == USB_INTERFACE_UNBOUND) {
Alan Stern1c5df7e2006-07-01 22:13:50 -0400906 status = -ENOTCONN;
Alan Stern2bf40862006-07-01 22:12:19 -0400907 goto done;
Alan Stern1c5df7e2006-07-01 22:13:50 -0400908 }
Alan Stern1cc8a252006-07-01 22:10:15 -0400909 driver = to_usb_driver(intf->dev.driver);
Alan Stern36e56a32006-07-01 22:08:06 -0400910
Alan Sternf07600c2007-05-30 15:38:16 -0400911 if (reset_resume) {
912 if (driver->reset_resume) {
913 status = driver->reset_resume(intf);
914 if (status)
915 dev_err(&intf->dev, "%s error %d\n",
916 "reset_resume", status);
917 } else {
918 // status = -EOPNOTSUPP;
919 dev_warn(&intf->dev, "no %s for driver %s?\n",
920 "reset_resume", driver->name);
921 }
922 } else {
923 if (driver->resume) {
924 status = driver->resume(intf);
925 if (status)
926 dev_err(&intf->dev, "%s error %d\n",
927 "resume", status);
928 } else {
929 // status = -EOPNOTSUPP;
930 dev_warn(&intf->dev, "no %s for driver %s?\n",
931 "resume", driver->name);
932 }
933 }
Alan Stern2bf40862006-07-01 22:12:19 -0400934
935done:
Alan Stern20dfdad2007-05-22 11:50:17 -0400936 dev_vdbg(&intf->dev, "%s: status %d\n", __FUNCTION__, status);
Alan Stern0458d5b2007-05-04 11:52:20 -0400937 if (status == 0)
938 mark_active(intf);
Alan Sternf07600c2007-05-30 15:38:16 -0400939
940 /* FIXME: Unbind the driver and reprobe if the resume failed
941 * (not possible if auto_pm is set) */
Alan Stern2bf40862006-07-01 22:12:19 -0400942 return status;
Alan Stern36e56a32006-07-01 22:08:06 -0400943}
944
Alan Stern94fcda12006-11-20 11:38:46 -0500945#ifdef CONFIG_USB_SUSPEND
946
Alan Sternaf4f7602006-10-30 17:06:45 -0500947/* Internal routine to check whether we may autosuspend a device. */
948static int autosuspend_check(struct usb_device *udev)
949{
950 int i;
951 struct usb_interface *intf;
Alan Stern8c9862e2007-04-11 12:06:16 -0400952 unsigned long suspend_time;
Alan Sternaf4f7602006-10-30 17:06:45 -0500953
Alan Sternb5e795f2007-02-20 15:00:53 -0500954 /* For autosuspend, fail fast if anything is in use or autosuspend
955 * is disabled. Also fail if any interfaces require remote wakeup
956 * but it isn't available.
957 */
Alan Sternaf4f7602006-10-30 17:06:45 -0500958 udev->do_remote_wakeup = device_may_wakeup(&udev->dev);
959 if (udev->pm_usage_cnt > 0)
960 return -EBUSY;
Alan Stern2add5222007-03-20 14:59:39 -0400961 if (udev->autosuspend_delay < 0 || udev->autosuspend_disabled)
Alan Sternb5e795f2007-02-20 15:00:53 -0500962 return -EPERM;
963
Alan Stern19410442007-03-27 13:33:59 -0400964 suspend_time = udev->last_busy + udev->autosuspend_delay;
Alan Sternaf4f7602006-10-30 17:06:45 -0500965 if (udev->actconfig) {
966 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
967 intf = udev->actconfig->interface[i];
968 if (!is_active(intf))
969 continue;
970 if (intf->pm_usage_cnt > 0)
971 return -EBUSY;
972 if (intf->needs_remote_wakeup &&
973 !udev->do_remote_wakeup) {
974 dev_dbg(&udev->dev, "remote wakeup needed "
975 "for autosuspend\n");
976 return -EOPNOTSUPP;
977 }
Alan Sternf07600c2007-05-30 15:38:16 -0400978
979 /* Don't allow autosuspend if the device will need
980 * a reset-resume and any of its interface drivers
981 * doesn't include support.
982 */
983 if (udev->quirks & USB_QUIRK_RESET_RESUME) {
984 struct usb_driver *driver;
985
986 driver = to_usb_driver(intf->dev.driver);
987 if (!driver->reset_resume)
988 return -EOPNOTSUPP;
989 }
Alan Sternaf4f7602006-10-30 17:06:45 -0500990 }
991 }
Alan Stern19410442007-03-27 13:33:59 -0400992
993 /* If everything is okay but the device hasn't been idle for long
994 * enough, queue a delayed autosuspend request.
995 */
Alan Stern8c9862e2007-04-11 12:06:16 -0400996 if (time_after(suspend_time, jiffies)) {
997 if (!timer_pending(&udev->autosuspend.timer)) {
998
999 /* The value of jiffies may change between the
1000 * time_after() comparison above and the subtraction
1001 * below. That's okay; the system behaves sanely
1002 * when a timer is registered for the present moment
1003 * or for the past.
1004 */
Alan Stern19410442007-03-27 13:33:59 -04001005 queue_delayed_work(ksuspend_usb_wq, &udev->autosuspend,
Venki Pallipadi8d6d5fd2007-07-09 12:03:06 -07001006 round_jiffies_relative(suspend_time - jiffies));
Alan Stern8c9862e2007-04-11 12:06:16 -04001007 }
Alan Stern19410442007-03-27 13:33:59 -04001008 return -EAGAIN;
1009 }
Alan Sternaf4f7602006-10-30 17:06:45 -05001010 return 0;
1011}
1012
Alan Stern94fcda12006-11-20 11:38:46 -05001013#else
1014
Alan Sternef7f6c72007-04-05 16:03:49 -04001015static inline int autosuspend_check(struct usb_device *udev)
1016{
1017 return 0;
1018}
Alan Stern94fcda12006-11-20 11:38:46 -05001019
Alan Sternb5e795f2007-02-20 15:00:53 -05001020#endif /* CONFIG_USB_SUSPEND */
Alan Stern94fcda12006-11-20 11:38:46 -05001021
Alan Stern645daaa2006-08-30 15:47:02 -04001022/**
1023 * usb_suspend_both - suspend a USB device and its interfaces
1024 * @udev: the usb_device to suspend
1025 * @msg: Power Management message describing this state transition
1026 *
1027 * This is the central routine for suspending USB devices. It calls the
1028 * suspend methods for all the interface drivers in @udev and then calls
1029 * the suspend method for @udev itself. If an error occurs at any stage,
1030 * all the interfaces which were suspended are resumed so that they remain
1031 * in the same state as the device.
1032 *
1033 * If an autosuspend is in progress (@udev->auto_pm is set), the routine
1034 * checks first to make sure that neither the device itself or any of its
1035 * active interfaces is in use (pm_usage_cnt is greater than 0). If they
1036 * are, the autosuspend fails.
1037 *
1038 * If the suspend succeeds, the routine recursively queues an autosuspend
1039 * request for @udev's parent device, thereby propagating the change up
1040 * the device tree. If all of the parent's children are now suspended,
1041 * the parent will autosuspend in turn.
1042 *
1043 * The suspend method calls are subject to mutual exclusion under control
1044 * of @udev's pm_mutex. Many of these calls are also under the protection
1045 * of @udev's device lock (including all requests originating outside the
1046 * USB subsystem), but autosuspend requests generated by a child device or
1047 * interface driver may not be. Usbcore will insure that the method calls
1048 * do not arrive during bind, unbind, or reset operations. However, drivers
1049 * must be prepared to handle suspend calls arriving at unpredictable times.
1050 * The only way to block such calls is to do an autoresume (preventing
1051 * autosuspends) while holding @udev's device lock (preventing outside
1052 * suspends).
1053 *
1054 * The caller must hold @udev->pm_mutex.
1055 *
1056 * This routine can run only in process context.
1057 */
Alan Stern718efa62007-03-09 15:41:13 -05001058static int usb_suspend_both(struct usb_device *udev, pm_message_t msg)
Alan Sterna8e7c562006-07-01 22:11:02 -04001059{
1060 int status = 0;
1061 int i = 0;
1062 struct usb_interface *intf;
Alan Stern645daaa2006-08-30 15:47:02 -04001063 struct usb_device *parent = udev->parent;
Alan Sterna8e7c562006-07-01 22:11:02 -04001064
Alan Stern19410442007-03-27 13:33:59 -04001065 if (udev->state == USB_STATE_NOTATTACHED ||
1066 udev->state == USB_STATE_SUSPENDED)
1067 goto done;
Alan Stern645daaa2006-08-30 15:47:02 -04001068
1069 udev->do_remote_wakeup = device_may_wakeup(&udev->dev);
1070
Alan Stern645daaa2006-08-30 15:47:02 -04001071 if (udev->auto_pm) {
Alan Sternaf4f7602006-10-30 17:06:45 -05001072 status = autosuspend_check(udev);
1073 if (status < 0)
Alan Stern19410442007-03-27 13:33:59 -04001074 goto done;
Alan Stern645daaa2006-08-30 15:47:02 -04001075 }
1076
1077 /* Suspend all the interfaces and then udev itself */
Alan Sterna8e7c562006-07-01 22:11:02 -04001078 if (udev->actconfig) {
1079 for (; i < udev->actconfig->desc.bNumInterfaces; i++) {
1080 intf = udev->actconfig->interface[i];
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -08001081 status = usb_suspend_interface(intf, msg);
Alan Sterna8e7c562006-07-01 22:11:02 -04001082 if (status != 0)
1083 break;
1084 }
1085 }
Alan Stern4d461092007-05-04 11:51:25 -04001086 if (status == 0) {
1087
1088 /* Non-root devices don't need to do anything for FREEZE
1089 * or PRETHAW. */
1090 if (udev->parent && (msg.event == PM_EVENT_FREEZE ||
1091 msg.event == PM_EVENT_PRETHAW))
1092 goto done;
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -08001093 status = usb_suspend_device(udev, msg);
Alan Stern4d461092007-05-04 11:51:25 -04001094 }
Alan Sterna8e7c562006-07-01 22:11:02 -04001095
1096 /* If the suspend failed, resume interfaces that did get suspended */
1097 if (status != 0) {
1098 while (--i >= 0) {
1099 intf = udev->actconfig->interface[i];
Alan Stern0458d5b2007-05-04 11:52:20 -04001100 usb_resume_interface(intf, 0);
Alan Sterna8e7c562006-07-01 22:11:02 -04001101 }
Alan Stern645daaa2006-08-30 15:47:02 -04001102
Alan Sternef7f6c72007-04-05 16:03:49 -04001103 /* Try another autosuspend when the interfaces aren't busy */
1104 if (udev->auto_pm)
1105 autosuspend_check(udev);
1106
Alan Stern645daaa2006-08-30 15:47:02 -04001107 /* If the suspend succeeded, propagate it up the tree */
Alan Sternef7f6c72007-04-05 16:03:49 -04001108 } else {
1109 cancel_delayed_work(&udev->autosuspend);
1110 if (parent)
1111 usb_autosuspend_device(parent);
1112 }
Alan Stern645daaa2006-08-30 15:47:02 -04001113
Alan Stern19410442007-03-27 13:33:59 -04001114 done:
Alan Stern20dfdad2007-05-22 11:50:17 -04001115 dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
Alan Sterna8e7c562006-07-01 22:11:02 -04001116 return status;
1117}
1118
Alan Stern645daaa2006-08-30 15:47:02 -04001119/**
1120 * usb_resume_both - resume a USB device and its interfaces
1121 * @udev: the usb_device to resume
1122 *
1123 * This is the central routine for resuming USB devices. It calls the
1124 * the resume method for @udev and then calls the resume methods for all
1125 * the interface drivers in @udev.
1126 *
1127 * Before starting the resume, the routine calls itself recursively for
1128 * the parent device of @udev, thereby propagating the change up the device
1129 * tree and assuring that @udev will be able to resume. If the parent is
1130 * unable to resume successfully, the routine fails.
1131 *
1132 * The resume method calls are subject to mutual exclusion under control
1133 * of @udev's pm_mutex. Many of these calls are also under the protection
1134 * of @udev's device lock (including all requests originating outside the
1135 * USB subsystem), but autoresume requests generated by a child device or
1136 * interface driver may not be. Usbcore will insure that the method calls
1137 * do not arrive during bind, unbind, or reset operations. However, drivers
1138 * must be prepared to handle resume calls arriving at unpredictable times.
1139 * The only way to block such calls is to do an autoresume (preventing
1140 * other autoresumes) while holding @udev's device lock (preventing outside
1141 * resumes).
1142 *
1143 * The caller must hold @udev->pm_mutex.
1144 *
1145 * This routine can run only in process context.
1146 */
Alan Stern718efa62007-03-09 15:41:13 -05001147static int usb_resume_both(struct usb_device *udev)
Alan Sterna8e7c562006-07-01 22:11:02 -04001148{
Alan Stern645daaa2006-08-30 15:47:02 -04001149 int status = 0;
Alan Sterna8e7c562006-07-01 22:11:02 -04001150 int i;
1151 struct usb_interface *intf;
Alan Stern645daaa2006-08-30 15:47:02 -04001152 struct usb_device *parent = udev->parent;
Alan Sterna8e7c562006-07-01 22:11:02 -04001153
Alan Stern645daaa2006-08-30 15:47:02 -04001154 cancel_delayed_work(&udev->autosuspend);
Alan Stern19410442007-03-27 13:33:59 -04001155 if (udev->state == USB_STATE_NOTATTACHED) {
1156 status = -ENODEV;
1157 goto done;
1158 }
Alan Stern645daaa2006-08-30 15:47:02 -04001159
1160 /* Propagate the resume up the tree, if necessary */
1161 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern19410442007-03-27 13:33:59 -04001162 if (udev->auto_pm && udev->autoresume_disabled) {
1163 status = -EPERM;
1164 goto done;
1165 }
Alan Stern645daaa2006-08-30 15:47:02 -04001166 if (parent) {
Alan Stern94fcda12006-11-20 11:38:46 -05001167 status = usb_autoresume_device(parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001168 if (status == 0) {
1169 status = usb_resume_device(udev);
Alan Sternf07600c2007-05-30 15:38:16 -04001170 if (status || udev->state ==
1171 USB_STATE_NOTATTACHED) {
Alan Stern94fcda12006-11-20 11:38:46 -05001172 usb_autosuspend_device(parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001173
1174 /* It's possible usb_resume_device()
1175 * failed after the port was
1176 * unsuspended, causing udev to be
1177 * logically disconnected. We don't
1178 * want usb_disconnect() to autosuspend
1179 * the parent again, so tell it that
1180 * udev disconnected while still
1181 * suspended. */
1182 if (udev->state ==
1183 USB_STATE_NOTATTACHED)
1184 udev->discon_suspended = 1;
1185 }
1186 }
Alan Stern645daaa2006-08-30 15:47:02 -04001187 } else {
1188
1189 /* We can't progagate beyond the USB subsystem,
1190 * so if a root hub's controller is suspended
1191 * then we're stuck. */
Alan Sterne7e6da92007-06-21 16:25:17 -04001192 status = usb_resume_device(udev);
Alan Sternee49fb52006-11-22 16:55:54 -05001193 }
Alan Stern592fbbe2006-09-19 10:08:43 -04001194 } else {
1195
Alan Stern0458d5b2007-05-04 11:52:20 -04001196 /* Needed for setting udev->dev.power.power_state.event,
1197 * for possible debugging message, and for reset_resume. */
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -08001198 status = usb_resume_device(udev);
Alan Stern114b3682006-07-01 22:13:04 -04001199 }
1200
Alan Sterna8e7c562006-07-01 22:11:02 -04001201 if (status == 0 && udev->actconfig) {
1202 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1203 intf = udev->actconfig->interface[i];
Alan Stern0458d5b2007-05-04 11:52:20 -04001204 usb_resume_interface(intf, udev->reset_resume);
Alan Sterna8e7c562006-07-01 22:11:02 -04001205 }
1206 }
Alan Stern645daaa2006-08-30 15:47:02 -04001207
Alan Stern19410442007-03-27 13:33:59 -04001208 done:
Alan Stern20dfdad2007-05-22 11:50:17 -04001209 dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
Alan Stern0458d5b2007-05-04 11:52:20 -04001210 udev->reset_resume = 0;
Alan Sterna8e7c562006-07-01 22:11:02 -04001211 return status;
1212}
1213
Alan Stern645daaa2006-08-30 15:47:02 -04001214#ifdef CONFIG_USB_SUSPEND
1215
Alan Stern94fcda12006-11-20 11:38:46 -05001216/* Internal routine to adjust a device's usage counter and change
1217 * its autosuspend state.
1218 */
1219static int usb_autopm_do_device(struct usb_device *udev, int inc_usage_cnt)
1220{
1221 int status = 0;
1222
1223 usb_pm_lock(udev);
Alan Stern19410442007-03-27 13:33:59 -04001224 udev->auto_pm = 1;
Alan Stern94fcda12006-11-20 11:38:46 -05001225 udev->pm_usage_cnt += inc_usage_cnt;
1226 WARN_ON(udev->pm_usage_cnt < 0);
Alan Stern013d27f2007-08-20 12:18:39 -04001227 if (inc_usage_cnt)
1228 udev->last_busy = jiffies;
Alan Stern94fcda12006-11-20 11:38:46 -05001229 if (inc_usage_cnt >= 0 && udev->pm_usage_cnt > 0) {
Alan Stern19410442007-03-27 13:33:59 -04001230 if (udev->state == USB_STATE_SUSPENDED)
1231 status = usb_resume_both(udev);
Alan Stern94fcda12006-11-20 11:38:46 -05001232 if (status != 0)
1233 udev->pm_usage_cnt -= inc_usage_cnt;
Alan Stern19410442007-03-27 13:33:59 -04001234 else if (inc_usage_cnt)
1235 udev->last_busy = jiffies;
1236 } else if (inc_usage_cnt <= 0 && udev->pm_usage_cnt <= 0) {
Alan Stern19410442007-03-27 13:33:59 -04001237 status = usb_suspend_both(udev, PMSG_SUSPEND);
1238 }
Alan Stern94fcda12006-11-20 11:38:46 -05001239 usb_pm_unlock(udev);
1240 return status;
1241}
1242
Alan Stern19410442007-03-27 13:33:59 -04001243/* usb_autosuspend_work - callback routine to autosuspend a USB device */
1244void usb_autosuspend_work(struct work_struct *work)
1245{
1246 struct usb_device *udev =
1247 container_of(work, struct usb_device, autosuspend.work);
1248
1249 usb_autopm_do_device(udev, 0);
1250}
1251
Alan Stern645daaa2006-08-30 15:47:02 -04001252/**
1253 * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
Henrik Kretzschmar701f35a2006-09-25 17:00:56 -07001254 * @udev: the usb_device to autosuspend
Alan Stern645daaa2006-08-30 15:47:02 -04001255 *
1256 * This routine should be called when a core subsystem is finished using
1257 * @udev and wants to allow it to autosuspend. Examples would be when
1258 * @udev's device file in usbfs is closed or after a configuration change.
1259 *
Alan Stern94fcda12006-11-20 11:38:46 -05001260 * @udev's usage counter is decremented. If it or any of the usage counters
1261 * for an active interface is greater than 0, no autosuspend request will be
1262 * queued. (If an interface driver does not support autosuspend then its
1263 * usage counter is permanently positive.) Furthermore, if an interface
1264 * driver requires remote-wakeup capability during autosuspend but remote
1265 * wakeup is disabled, the autosuspend will fail.
Alan Stern645daaa2006-08-30 15:47:02 -04001266 *
1267 * Often the caller will hold @udev's device lock, but this is not
1268 * necessary.
1269 *
1270 * This routine can run only in process context.
1271 */
Alan Stern94fcda12006-11-20 11:38:46 -05001272void usb_autosuspend_device(struct usb_device *udev)
Alan Stern645daaa2006-08-30 15:47:02 -04001273{
Alan Stern94fcda12006-11-20 11:38:46 -05001274 int status;
1275
1276 status = usb_autopm_do_device(udev, -1);
Alan Stern20dfdad2007-05-22 11:50:17 -04001277 dev_vdbg(&udev->dev, "%s: cnt %d\n",
1278 __FUNCTION__, udev->pm_usage_cnt);
Alan Stern645daaa2006-08-30 15:47:02 -04001279}
1280
1281/**
Alan Stern19c26232007-02-20 15:03:32 -05001282 * usb_try_autosuspend_device - attempt an autosuspend of a USB device and its interfaces
1283 * @udev: the usb_device to autosuspend
1284 *
1285 * This routine should be called when a core subsystem thinks @udev may
1286 * be ready to autosuspend.
1287 *
1288 * @udev's usage counter left unchanged. If it or any of the usage counters
1289 * for an active interface is greater than 0, or autosuspend is not allowed
1290 * for any other reason, no autosuspend request will be queued.
1291 *
1292 * This routine can run only in process context.
1293 */
1294void usb_try_autosuspend_device(struct usb_device *udev)
1295{
1296 usb_autopm_do_device(udev, 0);
Alan Stern20dfdad2007-05-22 11:50:17 -04001297 dev_vdbg(&udev->dev, "%s: cnt %d\n",
1298 __FUNCTION__, udev->pm_usage_cnt);
Alan Stern19c26232007-02-20 15:03:32 -05001299}
1300
1301/**
Alan Stern645daaa2006-08-30 15:47:02 -04001302 * usb_autoresume_device - immediately autoresume a USB device and its interfaces
Henrik Kretzschmar701f35a2006-09-25 17:00:56 -07001303 * @udev: the usb_device to autoresume
Alan Stern645daaa2006-08-30 15:47:02 -04001304 *
1305 * This routine should be called when a core subsystem wants to use @udev
Alan Stern94fcda12006-11-20 11:38:46 -05001306 * and needs to guarantee that it is not suspended. No autosuspend will
1307 * occur until usb_autosuspend_device is called. (Note that this will not
1308 * prevent suspend events originating in the PM core.) Examples would be
1309 * when @udev's device file in usbfs is opened or when a remote-wakeup
1310 * request is received.
Alan Stern645daaa2006-08-30 15:47:02 -04001311 *
Alan Stern94fcda12006-11-20 11:38:46 -05001312 * @udev's usage counter is incremented to prevent subsequent autosuspends.
1313 * However if the autoresume fails then the usage counter is re-decremented.
Alan Stern645daaa2006-08-30 15:47:02 -04001314 *
1315 * Often the caller will hold @udev's device lock, but this is not
1316 * necessary (and attempting it might cause deadlock).
1317 *
1318 * This routine can run only in process context.
1319 */
Alan Stern94fcda12006-11-20 11:38:46 -05001320int usb_autoresume_device(struct usb_device *udev)
Alan Stern645daaa2006-08-30 15:47:02 -04001321{
1322 int status;
1323
Alan Stern94fcda12006-11-20 11:38:46 -05001324 status = usb_autopm_do_device(udev, 1);
Alan Stern20dfdad2007-05-22 11:50:17 -04001325 dev_vdbg(&udev->dev, "%s: status %d cnt %d\n",
1326 __FUNCTION__, status, udev->pm_usage_cnt);
Alan Stern645daaa2006-08-30 15:47:02 -04001327 return status;
1328}
1329
Alan Sternaf4f7602006-10-30 17:06:45 -05001330/* Internal routine to adjust an interface's usage counter and change
1331 * its device's autosuspend state.
1332 */
1333static int usb_autopm_do_interface(struct usb_interface *intf,
1334 int inc_usage_cnt)
1335{
1336 struct usb_device *udev = interface_to_usbdev(intf);
1337 int status = 0;
1338
1339 usb_pm_lock(udev);
1340 if (intf->condition == USB_INTERFACE_UNBOUND)
1341 status = -ENODEV;
1342 else {
Alan Stern19410442007-03-27 13:33:59 -04001343 udev->auto_pm = 1;
Alan Sternaf4f7602006-10-30 17:06:45 -05001344 intf->pm_usage_cnt += inc_usage_cnt;
Alan Stern013d27f2007-08-20 12:18:39 -04001345 udev->last_busy = jiffies;
Alan Sternaf4f7602006-10-30 17:06:45 -05001346 if (inc_usage_cnt >= 0 && intf->pm_usage_cnt > 0) {
Alan Stern19410442007-03-27 13:33:59 -04001347 if (udev->state == USB_STATE_SUSPENDED)
1348 status = usb_resume_both(udev);
Alan Sternaf4f7602006-10-30 17:06:45 -05001349 if (status != 0)
1350 intf->pm_usage_cnt -= inc_usage_cnt;
Alan Stern013d27f2007-08-20 12:18:39 -04001351 else
Alan Stern19410442007-03-27 13:33:59 -04001352 udev->last_busy = jiffies;
1353 } else if (inc_usage_cnt <= 0 && intf->pm_usage_cnt <= 0) {
Alan Stern19410442007-03-27 13:33:59 -04001354 status = usb_suspend_both(udev, PMSG_SUSPEND);
1355 }
Alan Sternaf4f7602006-10-30 17:06:45 -05001356 }
1357 usb_pm_unlock(udev);
1358 return status;
1359}
1360
Alan Stern645daaa2006-08-30 15:47:02 -04001361/**
1362 * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
Henrik Kretzschmar701f35a2006-09-25 17:00:56 -07001363 * @intf: the usb_interface whose counter should be decremented
Alan Stern645daaa2006-08-30 15:47:02 -04001364 *
1365 * This routine should be called by an interface driver when it is
1366 * finished using @intf and wants to allow it to autosuspend. A typical
1367 * example would be a character-device driver when its device file is
1368 * closed.
1369 *
1370 * The routine decrements @intf's usage counter. When the counter reaches
1371 * 0, a delayed autosuspend request for @intf's device is queued. When
1372 * the delay expires, if @intf->pm_usage_cnt is still <= 0 along with all
1373 * the other usage counters for the sibling interfaces and @intf's
1374 * usb_device, the device and all its interfaces will be autosuspended.
1375 *
1376 * Note that @intf->pm_usage_cnt is owned by the interface driver. The
1377 * core will not change its value other than the increment and decrement
1378 * in usb_autopm_get_interface and usb_autopm_put_interface. The driver
1379 * may use this simple counter-oriented discipline or may set the value
1380 * any way it likes.
1381 *
1382 * If the driver has set @intf->needs_remote_wakeup then autosuspend will
1383 * take place only if the device's remote-wakeup facility is enabled.
1384 *
1385 * Suspend method calls queued by this routine can arrive at any time
1386 * while @intf is resumed and its usage counter is equal to 0. They are
1387 * not protected by the usb_device's lock but only by its pm_mutex.
1388 * Drivers must provide their own synchronization.
1389 *
1390 * This routine can run only in process context.
1391 */
1392void usb_autopm_put_interface(struct usb_interface *intf)
1393{
Alan Sternaf4f7602006-10-30 17:06:45 -05001394 int status;
Alan Stern645daaa2006-08-30 15:47:02 -04001395
Alan Sternaf4f7602006-10-30 17:06:45 -05001396 status = usb_autopm_do_interface(intf, -1);
Alan Stern20dfdad2007-05-22 11:50:17 -04001397 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1398 __FUNCTION__, status, intf->pm_usage_cnt);
Alan Stern645daaa2006-08-30 15:47:02 -04001399}
1400EXPORT_SYMBOL_GPL(usb_autopm_put_interface);
1401
1402/**
1403 * usb_autopm_get_interface - increment a USB interface's PM-usage counter
Henrik Kretzschmar701f35a2006-09-25 17:00:56 -07001404 * @intf: the usb_interface whose counter should be incremented
Alan Stern645daaa2006-08-30 15:47:02 -04001405 *
1406 * This routine should be called by an interface driver when it wants to
1407 * use @intf and needs to guarantee that it is not suspended. In addition,
1408 * the routine prevents @intf from being autosuspended subsequently. (Note
1409 * that this will not prevent suspend events originating in the PM core.)
1410 * This prevention will persist until usb_autopm_put_interface() is called
1411 * or @intf is unbound. A typical example would be a character-device
1412 * driver when its device file is opened.
1413 *
Alan Stern19410442007-03-27 13:33:59 -04001414 *
1415 * The routine increments @intf's usage counter. (However if the
1416 * autoresume fails then the counter is re-decremented.) So long as the
1417 * counter is greater than 0, autosuspend will not be allowed for @intf
1418 * or its usb_device. When the driver is finished using @intf it should
1419 * call usb_autopm_put_interface() to decrement the usage counter and
1420 * queue a delayed autosuspend request (if the counter is <= 0).
1421 *
Alan Stern645daaa2006-08-30 15:47:02 -04001422 *
1423 * Note that @intf->pm_usage_cnt is owned by the interface driver. The
1424 * core will not change its value other than the increment and decrement
1425 * in usb_autopm_get_interface and usb_autopm_put_interface. The driver
1426 * may use this simple counter-oriented discipline or may set the value
1427 * any way it likes.
1428 *
1429 * Resume method calls generated by this routine can arrive at any time
1430 * while @intf is suspended. They are not protected by the usb_device's
1431 * lock but only by its pm_mutex. Drivers must provide their own
1432 * synchronization.
1433 *
1434 * This routine can run only in process context.
1435 */
1436int usb_autopm_get_interface(struct usb_interface *intf)
1437{
Alan Sternaf4f7602006-10-30 17:06:45 -05001438 int status;
Alan Stern645daaa2006-08-30 15:47:02 -04001439
Alan Sternaf4f7602006-10-30 17:06:45 -05001440 status = usb_autopm_do_interface(intf, 1);
Alan Stern20dfdad2007-05-22 11:50:17 -04001441 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1442 __FUNCTION__, status, intf->pm_usage_cnt);
Alan Stern645daaa2006-08-30 15:47:02 -04001443 return status;
1444}
1445EXPORT_SYMBOL_GPL(usb_autopm_get_interface);
1446
Alan Stern692a1862006-10-30 17:07:51 -05001447/**
1448 * usb_autopm_set_interface - set a USB interface's autosuspend state
1449 * @intf: the usb_interface whose state should be set
1450 *
1451 * This routine sets the autosuspend state of @intf's device according
1452 * to @intf's usage counter, which the caller must have set previously.
1453 * If the counter is <= 0, the device is autosuspended (if it isn't
1454 * already suspended and if nothing else prevents the autosuspend). If
1455 * the counter is > 0, the device is autoresumed (if it isn't already
1456 * awake).
1457 */
1458int usb_autopm_set_interface(struct usb_interface *intf)
1459{
1460 int status;
1461
1462 status = usb_autopm_do_interface(intf, 0);
Alan Stern20dfdad2007-05-22 11:50:17 -04001463 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1464 __FUNCTION__, status, intf->pm_usage_cnt);
Alan Stern692a1862006-10-30 17:07:51 -05001465 return status;
1466}
1467EXPORT_SYMBOL_GPL(usb_autopm_set_interface);
1468
Alan Stern718efa62007-03-09 15:41:13 -05001469#else
1470
1471void usb_autosuspend_work(struct work_struct *work)
1472{}
1473
Alan Stern645daaa2006-08-30 15:47:02 -04001474#endif /* CONFIG_USB_SUSPEND */
1475
Alan Stern6b157c92007-03-13 16:37:30 -04001476/**
1477 * usb_external_suspend_device - external suspend of a USB device and its interfaces
1478 * @udev: the usb_device to suspend
1479 * @msg: Power Management message describing this state transition
1480 *
1481 * This routine handles external suspend requests: ones not generated
1482 * internally by a USB driver (autosuspend) but rather coming from the user
1483 * (via sysfs) or the PM core (system sleep). The suspend will be carried
1484 * out regardless of @udev's usage counter or those of its interfaces,
1485 * and regardless of whether or not remote wakeup is enabled. Of course,
1486 * interface drivers still have the option of failing the suspend (if
1487 * there are unsuspended children, for example).
1488 *
1489 * The caller must hold @udev's device lock.
1490 */
1491int usb_external_suspend_device(struct usb_device *udev, pm_message_t msg)
Alan Stern1cc8a252006-07-01 22:10:15 -04001492{
1493 int status;
1494
Alan Stern6b157c92007-03-13 16:37:30 -04001495 usb_pm_lock(udev);
1496 udev->auto_pm = 0;
1497 status = usb_suspend_both(udev, msg);
1498 usb_pm_unlock(udev);
Alan Stern1cc8a252006-07-01 22:10:15 -04001499 return status;
1500}
1501
Alan Stern6b157c92007-03-13 16:37:30 -04001502/**
1503 * usb_external_resume_device - external resume of a USB device and its interfaces
1504 * @udev: the usb_device to resume
1505 *
1506 * This routine handles external resume requests: ones not generated
1507 * internally by a USB driver (autoresume) but rather coming from the user
1508 * (via sysfs), the PM core (system resume), or the device itself (remote
1509 * wakeup). @udev's usage counter is unaffected.
1510 *
1511 * The caller must hold @udev's device lock.
1512 */
1513int usb_external_resume_device(struct usb_device *udev)
1514{
1515 int status;
1516
1517 usb_pm_lock(udev);
1518 udev->auto_pm = 0;
1519 status = usb_resume_both(udev);
Alan Sternef7f6c72007-04-05 16:03:49 -04001520 udev->last_busy = jiffies;
Alan Stern6b157c92007-03-13 16:37:30 -04001521 usb_pm_unlock(udev);
1522
1523 /* Now that the device is awake, we can start trying to autosuspend
1524 * it again. */
1525 if (status == 0)
1526 usb_try_autosuspend_device(udev);
1527 return status;
1528}
1529
1530static int usb_suspend(struct device *dev, pm_message_t message)
1531{
1532 if (!is_usb_device(dev)) /* Ignore PM for interfaces */
1533 return 0;
1534 return usb_external_suspend_device(to_usb_device(dev), message);
1535}
1536
Alan Stern1cc8a252006-07-01 22:10:15 -04001537static int usb_resume(struct device *dev)
1538{
Alan Stern2add5222007-03-20 14:59:39 -04001539 struct usb_device *udev;
1540
Alan Stern6b157c92007-03-13 16:37:30 -04001541 if (!is_usb_device(dev)) /* Ignore PM for interfaces */
1542 return 0;
Alan Stern2add5222007-03-20 14:59:39 -04001543 udev = to_usb_device(dev);
Alan Stern0458d5b2007-05-04 11:52:20 -04001544
1545 /* If autoresume is disabled then we also want to prevent resume
1546 * during system wakeup. However, a "persistent-device" reset-resume
1547 * after power loss counts as a wakeup event. So allow a
1548 * reset-resume to occur if remote wakeup is enabled. */
1549 if (udev->autoresume_disabled) {
1550 if (!(udev->reset_resume && udev->do_remote_wakeup))
1551 return -EPERM;
1552 }
Alan Stern2add5222007-03-20 14:59:39 -04001553 return usb_external_resume_device(udev);
Alan Stern1cc8a252006-07-01 22:10:15 -04001554}
1555
Alan Stern6b157c92007-03-13 16:37:30 -04001556#else
1557
1558#define usb_suspend NULL
1559#define usb_resume NULL
1560
Alan Stern36e56a32006-07-01 22:08:06 -04001561#endif /* CONFIG_PM */
1562
1563struct bus_type usb_bus_type = {
1564 .name = "usb",
1565 .match = usb_device_match,
1566 .uevent = usb_uevent,
Alan Stern782da722006-07-01 22:09:35 -04001567 .suspend = usb_suspend,
1568 .resume = usb_resume,
Alan Stern36e56a32006-07-01 22:08:06 -04001569};