USB: remove excess code from hub.c
[linux-2.6-block.git] / drivers / usb / core / driver.c
CommitLineData
ddae41be
GKH
1/*
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
36e56a34
AS
20 * matching, probing, releasing, suspending and resuming for
21 * real drivers.
ddae41be
GKH
22 *
23 */
24
ddae41be
GKH
25#include <linux/device.h>
26#include <linux/usb.h>
6bc6cff5 27#include <linux/usb/quirks.h>
bd859281 28#include <linux/workqueue.h>
ddae41be
GKH
29#include "hcd.h"
30#include "usb.h"
31
20dfdad7
AS
32#define VERBOSE_DEBUG 0
33
34#if VERBOSE_DEBUG
35#define dev_vdbg dev_dbg
36#else
37#define dev_vdbg(dev, fmt, args...) do { } while (0)
38#endif
39
733260ff
GKH
40#ifdef CONFIG_HOTPLUG
41
42/*
43 * Adds a new dynamic USBdevice ID to this driver,
44 * and cause the driver to probe for all devices again.
45 */
93bacefc
GKH
46ssize_t usb_store_new_id(struct usb_dynids *dynids,
47 struct device_driver *driver,
48 const char *buf, size_t count)
733260ff 49{
733260ff
GKH
50 struct usb_dynid *dynid;
51 u32 idVendor = 0;
52 u32 idProduct = 0;
53 int fields = 0;
1b21d5e1 54 int retval = 0;
733260ff
GKH
55
56 fields = sscanf(buf, "%x %x", &idVendor, &idProduct);
57 if (fields < 2)
58 return -EINVAL;
59
60 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
61 if (!dynid)
62 return -ENOMEM;
63
64 INIT_LIST_HEAD(&dynid->node);
65 dynid->id.idVendor = idVendor;
66 dynid->id.idProduct = idProduct;
67 dynid->id.match_flags = USB_DEVICE_ID_MATCH_DEVICE;
68
93bacefc
GKH
69 spin_lock(&dynids->lock);
70 list_add_tail(&dynids->list, &dynid->node);
71 spin_unlock(&dynids->lock);
733260ff
GKH
72
73 if (get_driver(driver)) {
1b21d5e1 74 retval = driver_attach(driver);
733260ff
GKH
75 put_driver(driver);
76 }
77
1b21d5e1
GKH
78 if (retval)
79 return retval;
733260ff
GKH
80 return count;
81}
93bacefc
GKH
82EXPORT_SYMBOL_GPL(usb_store_new_id);
83
84static ssize_t store_new_id(struct device_driver *driver,
85 const char *buf, size_t count)
86{
87 struct usb_driver *usb_drv = to_usb_driver(driver);
88
89 return usb_store_new_id(&usb_drv->dynids, driver, buf, count);
90}
733260ff
GKH
91static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
92
93static int usb_create_newid_file(struct usb_driver *usb_drv)
94{
95 int error = 0;
96
ba9dc657
GKH
97 if (usb_drv->no_dynamic_id)
98 goto exit;
99
733260ff 100 if (usb_drv->probe != NULL)
8bb54ab5 101 error = sysfs_create_file(&usb_drv->drvwrap.driver.kobj,
733260ff 102 &driver_attr_new_id.attr);
ba9dc657 103exit:
733260ff
GKH
104 return error;
105}
106
ba9dc657
GKH
107static void usb_remove_newid_file(struct usb_driver *usb_drv)
108{
109 if (usb_drv->no_dynamic_id)
110 return;
111
112 if (usb_drv->probe != NULL)
8bb54ab5 113 sysfs_remove_file(&usb_drv->drvwrap.driver.kobj,
ba9dc657
GKH
114 &driver_attr_new_id.attr);
115}
116
733260ff
GKH
117static void usb_free_dynids(struct usb_driver *usb_drv)
118{
119 struct usb_dynid *dynid, *n;
120
121 spin_lock(&usb_drv->dynids.lock);
122 list_for_each_entry_safe(dynid, n, &usb_drv->dynids.list, node) {
123 list_del(&dynid->node);
124 kfree(dynid);
125 }
126 spin_unlock(&usb_drv->dynids.lock);
127}
128#else
129static inline int usb_create_newid_file(struct usb_driver *usb_drv)
130{
131 return 0;
132}
133
ba9dc657
GKH
134static void usb_remove_newid_file(struct usb_driver *usb_drv)
135{
136}
137
733260ff
GKH
138static inline void usb_free_dynids(struct usb_driver *usb_drv)
139{
140}
141#endif
142
143static const struct usb_device_id *usb_match_dynamic_id(struct usb_interface *intf,
144 struct usb_driver *drv)
145{
146 struct usb_dynid *dynid;
147
148 spin_lock(&drv->dynids.lock);
149 list_for_each_entry(dynid, &drv->dynids.list, node) {
150 if (usb_match_one_id(intf, &dynid->id)) {
151 spin_unlock(&drv->dynids.lock);
152 return &dynid->id;
153 }
154 }
155 spin_unlock(&drv->dynids.lock);
156 return NULL;
157}
158
159
8bb54ab5
AS
160/* called from driver core with dev locked */
161static int usb_probe_device(struct device *dev)
162{
163 struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
164 struct usb_device *udev;
165 int error = -ENODEV;
166
167 dev_dbg(dev, "%s\n", __FUNCTION__);
168
169 if (!is_usb_device(dev)) /* Sanity check */
170 return error;
171
172 udev = to_usb_device(dev);
173
8bb54ab5
AS
174 /* TODO: Add real matching code */
175
645daaab
AS
176 /* The device should always appear to be in use
177 * unless the driver suports autosuspend.
178 */
179 udev->pm_usage_cnt = !(udriver->supports_autosuspend);
180
8bb54ab5
AS
181 error = udriver->probe(udev);
182 return error;
183}
184
185/* called from driver core with dev locked */
186static int usb_unbind_device(struct device *dev)
187{
188 struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
189
190 udriver->disconnect(to_usb_device(dev));
191 return 0;
192}
193
194
195/* called from driver core with dev locked */
ddae41be
GKH
196static int usb_probe_interface(struct device *dev)
197{
8bb54ab5
AS
198 struct usb_driver *driver = to_usb_driver(dev->driver);
199 struct usb_interface *intf;
645daaab 200 struct usb_device *udev;
ddae41be
GKH
201 const struct usb_device_id *id;
202 int error = -ENODEV;
203
204 dev_dbg(dev, "%s\n", __FUNCTION__);
205
8bb54ab5 206 if (is_usb_device(dev)) /* Sanity check */
ddae41be 207 return error;
8bb54ab5
AS
208
209 intf = to_usb_interface(dev);
645daaab 210 udev = interface_to_usbdev(intf);
ddae41be
GKH
211
212 id = usb_match_id(intf, driver->id_table);
733260ff
GKH
213 if (!id)
214 id = usb_match_dynamic_id(intf, driver);
ddae41be
GKH
215 if (id) {
216 dev_dbg(dev, "%s - got id\n", __FUNCTION__);
217
94fcda1f 218 error = usb_autoresume_device(udev);
645daaab
AS
219 if (error)
220 return error;
221
ddae41be
GKH
222 /* Interface "power state" doesn't correspond to any hardware
223 * state whatsoever. We use it to record when it's bound to
224 * a driver that may start I/0: it's not frozen/quiesced.
225 */
226 mark_active(intf);
227 intf->condition = USB_INTERFACE_BINDING;
645daaab
AS
228
229 /* The interface should always appear to be in use
230 * unless the driver suports autosuspend.
231 */
232 intf->pm_usage_cnt = !(driver->supports_autosuspend);
233
ddae41be
GKH
234 error = driver->probe(intf, id);
235 if (error) {
236 mark_quiesced(intf);
645daaab 237 intf->needs_remote_wakeup = 0;
ddae41be
GKH
238 intf->condition = USB_INTERFACE_UNBOUND;
239 } else
240 intf->condition = USB_INTERFACE_BOUND;
645daaab 241
94fcda1f 242 usb_autosuspend_device(udev);
ddae41be
GKH
243 }
244
245 return error;
246}
247
8bb54ab5 248/* called from driver core with dev locked */
ddae41be
GKH
249static int usb_unbind_interface(struct device *dev)
250{
8bb54ab5 251 struct usb_driver *driver = to_usb_driver(dev->driver);
ddae41be 252 struct usb_interface *intf = to_usb_interface(dev);
645daaab
AS
253 struct usb_device *udev;
254 int error;
ddae41be
GKH
255
256 intf->condition = USB_INTERFACE_UNBINDING;
257
645daaab
AS
258 /* Autoresume for set_interface call below */
259 udev = interface_to_usbdev(intf);
94fcda1f 260 error = usb_autoresume_device(udev);
645daaab 261
ddae41be
GKH
262 /* release all urbs for this interface */
263 usb_disable_interface(interface_to_usbdev(intf), intf);
264
8bb54ab5 265 driver->disconnect(intf);
ddae41be
GKH
266
267 /* reset other interface state */
268 usb_set_interface(interface_to_usbdev(intf),
269 intf->altsetting[0].desc.bInterfaceNumber,
270 0);
271 usb_set_intfdata(intf, NULL);
645daaab 272
ddae41be
GKH
273 intf->condition = USB_INTERFACE_UNBOUND;
274 mark_quiesced(intf);
645daaab
AS
275 intf->needs_remote_wakeup = 0;
276
277 if (!error)
94fcda1f 278 usb_autosuspend_device(udev);
ddae41be
GKH
279
280 return 0;
281}
282
36e56a34
AS
283/**
284 * usb_driver_claim_interface - bind a driver to an interface
285 * @driver: the driver to be bound
286 * @iface: the interface to which it will be bound; must be in the
287 * usb device's active configuration
288 * @priv: driver data associated with that interface
289 *
290 * This is used by usb device drivers that need to claim more than one
291 * interface on a device when probing (audio and acm are current examples).
292 * No device driver should directly modify internal usb_interface or
293 * usb_device structure members.
294 *
295 * Few drivers should need to use this routine, since the most natural
296 * way to bind to an interface is to return the private data from
297 * the driver's probe() method.
298 *
341487a8
GKH
299 * Callers must own the device lock, so driver probe() entries don't need
300 * extra locking, but other call contexts may need to explicitly claim that
301 * lock.
36e56a34
AS
302 */
303int usb_driver_claim_interface(struct usb_driver *driver,
304 struct usb_interface *iface, void* priv)
305{
306 struct device *dev = &iface->dev;
645daaab 307 struct usb_device *udev = interface_to_usbdev(iface);
1b21d5e1 308 int retval = 0;
36e56a34
AS
309
310 if (dev->driver)
311 return -EBUSY;
312
8bb54ab5 313 dev->driver = &driver->drvwrap.driver;
36e56a34 314 usb_set_intfdata(iface, priv);
645daaab 315
e0318ebf 316 usb_pm_lock(udev);
36e56a34
AS
317 iface->condition = USB_INTERFACE_BOUND;
318 mark_active(iface);
645daaab 319 iface->pm_usage_cnt = !(driver->supports_autosuspend);
e0318ebf 320 usb_pm_unlock(udev);
36e56a34
AS
321
322 /* if interface was already added, bind now; else let
323 * the future device_add() bind it, bypassing probe()
324 */
325 if (device_is_registered(dev))
1b21d5e1 326 retval = device_bind_driver(dev);
36e56a34 327
1b21d5e1 328 return retval;
36e56a34
AS
329}
330EXPORT_SYMBOL(usb_driver_claim_interface);
331
332/**
333 * usb_driver_release_interface - unbind a driver from an interface
334 * @driver: the driver to be unbound
335 * @iface: the interface from which it will be unbound
336 *
337 * This can be used by drivers to release an interface without waiting
338 * for their disconnect() methods to be called. In typical cases this
339 * also causes the driver disconnect() method to be called.
340 *
341 * This call is synchronous, and may not be used in an interrupt context.
341487a8
GKH
342 * Callers must own the device lock, so driver disconnect() entries don't
343 * need extra locking, but other call contexts may need to explicitly claim
344 * that lock.
36e56a34
AS
345 */
346void usb_driver_release_interface(struct usb_driver *driver,
347 struct usb_interface *iface)
348{
349 struct device *dev = &iface->dev;
645daaab 350 struct usb_device *udev = interface_to_usbdev(iface);
36e56a34
AS
351
352 /* this should never happen, don't release something that's not ours */
8bb54ab5 353 if (!dev->driver || dev->driver != &driver->drvwrap.driver)
36e56a34
AS
354 return;
355
356 /* don't release from within disconnect() */
357 if (iface->condition != USB_INTERFACE_BOUND)
358 return;
359
360 /* don't release if the interface hasn't been added yet */
361 if (device_is_registered(dev)) {
362 iface->condition = USB_INTERFACE_UNBINDING;
363 device_release_driver(dev);
364 }
365
366 dev->driver = NULL;
367 usb_set_intfdata(iface, NULL);
645daaab 368
e0318ebf 369 usb_pm_lock(udev);
36e56a34
AS
370 iface->condition = USB_INTERFACE_UNBOUND;
371 mark_quiesced(iface);
645daaab 372 iface->needs_remote_wakeup = 0;
e0318ebf 373 usb_pm_unlock(udev);
36e56a34
AS
374}
375EXPORT_SYMBOL(usb_driver_release_interface);
376
733260ff 377/* returns 0 if no match, 1 if match */
bb417020 378int usb_match_device(struct usb_device *dev, const struct usb_device_id *id)
733260ff 379{
733260ff
GKH
380 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
381 id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
382 return 0;
383
384 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
385 id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
386 return 0;
387
388 /* No need to test id->bcdDevice_lo != 0, since 0 is never
389 greater than any unsigned number. */
390 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
391 (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice)))
392 return 0;
393
394 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
395 (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
396 return 0;
397
398 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
399 (id->bDeviceClass != dev->descriptor.bDeviceClass))
400 return 0;
401
402 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
403 (id->bDeviceSubClass!= dev->descriptor.bDeviceSubClass))
404 return 0;
405
406 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
407 (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
408 return 0;
409
bb417020
GKH
410 return 1;
411}
412
413/* returns 0 if no match, 1 if match */
414int usb_match_one_id(struct usb_interface *interface,
415 const struct usb_device_id *id)
416{
417 struct usb_host_interface *intf;
418 struct usb_device *dev;
419
420 /* proc_connectinfo in devio.c may call us with id == NULL. */
421 if (id == NULL)
422 return 0;
423
424 intf = interface->cur_altsetting;
425 dev = interface_to_usbdev(interface);
426
427 if (!usb_match_device(dev, id))
428 return 0;
429
93c8bf45
AS
430 /* The interface class, subclass, and protocol should never be
431 * checked for a match if the device class is Vendor Specific,
432 * unless the match record specifies the Vendor ID. */
433 if (dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC &&
434 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
435 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
436 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
437 USB_DEVICE_ID_MATCH_INT_PROTOCOL)))
438 return 0;
439
733260ff
GKH
440 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
441 (id->bInterfaceClass != intf->desc.bInterfaceClass))
442 return 0;
443
444 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
445 (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
446 return 0;
447
448 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
449 (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
450 return 0;
451
452 return 1;
453}
93bacefc
GKH
454EXPORT_SYMBOL_GPL(usb_match_one_id);
455
ddae41be
GKH
456/**
457 * usb_match_id - find first usb_device_id matching device or interface
458 * @interface: the interface of interest
459 * @id: array of usb_device_id structures, terminated by zero entry
460 *
461 * usb_match_id searches an array of usb_device_id's and returns
462 * the first one matching the device or interface, or null.
463 * This is used when binding (or rebinding) a driver to an interface.
464 * Most USB device drivers will use this indirectly, through the usb core,
465 * but some layered driver frameworks use it directly.
466 * These device tables are exported with MODULE_DEVICE_TABLE, through
467 * modutils, to support the driver loading functionality of USB hotplugging.
468 *
469 * What Matches:
470 *
471 * The "match_flags" element in a usb_device_id controls which
472 * members are used. If the corresponding bit is set, the
473 * value in the device_id must match its corresponding member
474 * in the device or interface descriptor, or else the device_id
475 * does not match.
476 *
477 * "driver_info" is normally used only by device drivers,
478 * but you can create a wildcard "matches anything" usb_device_id
479 * as a driver's "modules.usbmap" entry if you provide an id with
480 * only a nonzero "driver_info" field. If you do this, the USB device
481 * driver's probe() routine should use additional intelligence to
482 * decide whether to bind to the specified interface.
483 *
484 * What Makes Good usb_device_id Tables:
485 *
486 * The match algorithm is very simple, so that intelligence in
487 * driver selection must come from smart driver id records.
488 * Unless you have good reasons to use another selection policy,
489 * provide match elements only in related groups, and order match
490 * specifiers from specific to general. Use the macros provided
491 * for that purpose if you can.
492 *
493 * The most specific match specifiers use device descriptor
494 * data. These are commonly used with product-specific matches;
495 * the USB_DEVICE macro lets you provide vendor and product IDs,
496 * and you can also match against ranges of product revisions.
497 * These are widely used for devices with application or vendor
498 * specific bDeviceClass values.
499 *
500 * Matches based on device class/subclass/protocol specifications
501 * are slightly more general; use the USB_DEVICE_INFO macro, or
502 * its siblings. These are used with single-function devices
503 * where bDeviceClass doesn't specify that each interface has
504 * its own class.
505 *
506 * Matches based on interface class/subclass/protocol are the
507 * most general; they let drivers bind to any interface on a
508 * multiple-function device. Use the USB_INTERFACE_INFO
509 * macro, or its siblings, to match class-per-interface style
93c8bf45
AS
510 * devices (as recorded in bInterfaceClass).
511 *
512 * Note that an entry created by USB_INTERFACE_INFO won't match
513 * any interface if the device class is set to Vendor-Specific.
514 * This is deliberate; according to the USB spec the meanings of
515 * the interface class/subclass/protocol for these devices are also
516 * vendor-specific, and hence matching against a standard product
517 * class wouldn't work anyway. If you really want to use an
518 * interface-based match for such a device, create a match record
519 * that also specifies the vendor ID. (Unforunately there isn't a
520 * standard macro for creating records like this.)
ddae41be
GKH
521 *
522 * Within those groups, remember that not all combinations are
523 * meaningful. For example, don't give a product version range
524 * without vendor and product IDs; or specify a protocol without
525 * its associated class and subclass.
526 */
527const struct usb_device_id *usb_match_id(struct usb_interface *interface,
528 const struct usb_device_id *id)
529{
ddae41be
GKH
530 /* proc_connectinfo in devio.c may call us with id == NULL. */
531 if (id == NULL)
532 return NULL;
533
ddae41be
GKH
534 /* It is important to check that id->driver_info is nonzero,
535 since an entry that is all zeroes except for a nonzero
536 id->driver_info is the way to create an entry that
537 indicates that the driver want to examine every
538 device and interface. */
539 for (; id->idVendor || id->bDeviceClass || id->bInterfaceClass ||
540 id->driver_info; id++) {
733260ff
GKH
541 if (usb_match_one_id(interface, id))
542 return id;
ddae41be
GKH
543 }
544
545 return NULL;
546}
b87ba0a3 547EXPORT_SYMBOL_GPL_FUTURE(usb_match_id);
ddae41be 548
8bb22d2b 549static int usb_device_match(struct device *dev, struct device_driver *drv)
ddae41be 550{
8bb54ab5
AS
551 /* devices and interfaces are handled separately */
552 if (is_usb_device(dev)) {
ddae41be 553
8bb54ab5
AS
554 /* interface drivers never match devices */
555 if (!is_usb_device_driver(drv))
556 return 0;
ddae41be 557
8bb54ab5 558 /* TODO: Add real matching code */
ddae41be
GKH
559 return 1;
560
8bb54ab5
AS
561 } else {
562 struct usb_interface *intf;
563 struct usb_driver *usb_drv;
564 const struct usb_device_id *id;
565
566 /* device drivers never match interfaces */
567 if (is_usb_device_driver(drv))
568 return 0;
569
570 intf = to_usb_interface(dev);
571 usb_drv = to_usb_driver(drv);
572
573 id = usb_match_id(intf, usb_drv->id_table);
574 if (id)
575 return 1;
576
577 id = usb_match_dynamic_id(intf, usb_drv);
578 if (id)
579 return 1;
580 }
581
ddae41be
GKH
582 return 0;
583}
584
36e56a34 585#ifdef CONFIG_HOTPLUG
36e56a34
AS
586static int usb_uevent(struct device *dev, char **envp, int num_envp,
587 char *buffer, int buffer_size)
588{
36e56a34 589 struct usb_device *usb_dev;
36e56a34
AS
590 int i = 0;
591 int length = 0;
592
593 if (!dev)
594 return -ENODEV;
595
596 /* driver is often null here; dev_dbg() would oops */
597 pr_debug ("usb %s: uevent\n", dev->bus_id);
598
9f8b17e6 599 if (is_usb_device(dev))
782da727 600 usb_dev = to_usb_device(dev);
9f8b17e6
KS
601 else {
602 struct usb_interface *intf = to_usb_interface(dev);
8bb54ab5 603 usb_dev = interface_to_usbdev(intf);
8bb54ab5 604 }
36e56a34
AS
605
606 if (usb_dev->devnum < 0) {
607 pr_debug ("usb %s: already deleted?\n", dev->bus_id);
608 return -ENODEV;
609 }
610 if (!usb_dev->bus) {
611 pr_debug ("usb %s: bus removed?\n", dev->bus_id);
612 return -ENODEV;
613 }
614
615#ifdef CONFIG_USB_DEVICEFS
616 /* If this is available, userspace programs can directly read
617 * all the device descriptors we don't tell them about. Or
9f8b17e6 618 * act as usermode drivers.
36e56a34
AS
619 */
620 if (add_uevent_var(envp, num_envp, &i,
621 buffer, buffer_size, &length,
622 "DEVICE=/proc/bus/usb/%03d/%03d",
623 usb_dev->bus->busnum, usb_dev->devnum))
624 return -ENOMEM;
625#endif
626
627 /* per-device configurations are common */
628 if (add_uevent_var(envp, num_envp, &i,
629 buffer, buffer_size, &length,
630 "PRODUCT=%x/%x/%x",
631 le16_to_cpu(usb_dev->descriptor.idVendor),
632 le16_to_cpu(usb_dev->descriptor.idProduct),
633 le16_to_cpu(usb_dev->descriptor.bcdDevice)))
634 return -ENOMEM;
635
636 /* class-based driver binding models */
637 if (add_uevent_var(envp, num_envp, &i,
638 buffer, buffer_size, &length,
639 "TYPE=%d/%d/%d",
640 usb_dev->descriptor.bDeviceClass,
641 usb_dev->descriptor.bDeviceSubClass,
642 usb_dev->descriptor.bDeviceProtocol))
643 return -ENOMEM;
644
9f8b17e6 645 if (add_uevent_var(envp, num_envp, &i,
36e56a34 646 buffer, buffer_size, &length,
9f8b17e6
KS
647 "BUSNUM=%03d",
648 usb_dev->bus->busnum))
649 return -ENOMEM;
36e56a34 650
9f8b17e6 651 if (add_uevent_var(envp, num_envp, &i,
36e56a34 652 buffer, buffer_size, &length,
9f8b17e6
KS
653 "DEVNUM=%03d",
654 usb_dev->devnum))
655 return -ENOMEM;
36e56a34
AS
656
657 envp[i] = NULL;
36e56a34
AS
658 return 0;
659}
660
661#else
662
663static int usb_uevent(struct device *dev, char **envp,
9f8b17e6 664 int num_envp, char *buffer, int buffer_size)
36e56a34
AS
665{
666 return -ENODEV;
667}
36e56a34
AS
668#endif /* CONFIG_HOTPLUG */
669
ddae41be 670/**
8bb54ab5
AS
671 * usb_register_device_driver - register a USB device (not interface) driver
672 * @new_udriver: USB operations for the device driver
2143acc6 673 * @owner: module owner of this driver.
ddae41be 674 *
8bb54ab5
AS
675 * Registers a USB device driver with the USB core. The list of
676 * unattached devices will be rescanned whenever a new driver is
677 * added, allowing the new driver to attach to any recognized devices.
678 * Returns a negative error code on failure and 0 on success.
679 */
680int usb_register_device_driver(struct usb_device_driver *new_udriver,
681 struct module *owner)
682{
683 int retval = 0;
684
685 if (usb_disabled())
686 return -ENODEV;
687
688 new_udriver->drvwrap.for_devices = 1;
689 new_udriver->drvwrap.driver.name = (char *) new_udriver->name;
690 new_udriver->drvwrap.driver.bus = &usb_bus_type;
691 new_udriver->drvwrap.driver.probe = usb_probe_device;
692 new_udriver->drvwrap.driver.remove = usb_unbind_device;
693 new_udriver->drvwrap.driver.owner = owner;
694
695 retval = driver_register(&new_udriver->drvwrap.driver);
696
697 if (!retval) {
698 pr_info("%s: registered new device driver %s\n",
699 usbcore_name, new_udriver->name);
700 usbfs_update_special();
701 } else {
702 printk(KERN_ERR "%s: error %d registering device "
703 " driver %s\n",
704 usbcore_name, retval, new_udriver->name);
705 }
706
707 return retval;
708}
709EXPORT_SYMBOL_GPL(usb_register_device_driver);
710
711/**
712 * usb_deregister_device_driver - unregister a USB device (not interface) driver
713 * @udriver: USB operations of the device driver to unregister
714 * Context: must be able to sleep
715 *
716 * Unlinks the specified driver from the internal USB driver list.
717 */
718void usb_deregister_device_driver(struct usb_device_driver *udriver)
719{
720 pr_info("%s: deregistering device driver %s\n",
721 usbcore_name, udriver->name);
722
723 driver_unregister(&udriver->drvwrap.driver);
724 usbfs_update_special();
725}
726EXPORT_SYMBOL_GPL(usb_deregister_device_driver);
727
728/**
729 * usb_register_driver - register a USB interface driver
730 * @new_driver: USB operations for the interface driver
731 * @owner: module owner of this driver.
892705a1 732 * @mod_name: module name string
8bb54ab5
AS
733 *
734 * Registers a USB interface driver with the USB core. The list of
735 * unattached interfaces will be rescanned whenever a new driver is
736 * added, allowing the new driver to attach to any recognized interfaces.
ddae41be
GKH
737 * Returns a negative error code on failure and 0 on success.
738 *
739 * NOTE: if you want your driver to use the USB major number, you must call
740 * usb_register_dev() to enable that functionality. This function no longer
741 * takes care of that.
742 */
80f745fb
GKH
743int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
744 const char *mod_name)
ddae41be
GKH
745{
746 int retval = 0;
747
748 if (usb_disabled())
749 return -ENODEV;
750
8bb54ab5
AS
751 new_driver->drvwrap.for_devices = 0;
752 new_driver->drvwrap.driver.name = (char *) new_driver->name;
753 new_driver->drvwrap.driver.bus = &usb_bus_type;
754 new_driver->drvwrap.driver.probe = usb_probe_interface;
755 new_driver->drvwrap.driver.remove = usb_unbind_interface;
756 new_driver->drvwrap.driver.owner = owner;
80f745fb 757 new_driver->drvwrap.driver.mod_name = mod_name;
733260ff
GKH
758 spin_lock_init(&new_driver->dynids.lock);
759 INIT_LIST_HEAD(&new_driver->dynids.list);
ddae41be 760
8bb54ab5 761 retval = driver_register(&new_driver->drvwrap.driver);
ddae41be
GKH
762
763 if (!retval) {
8bb54ab5 764 pr_info("%s: registered new interface driver %s\n",
ddae41be
GKH
765 usbcore_name, new_driver->name);
766 usbfs_update_special();
733260ff 767 usb_create_newid_file(new_driver);
ddae41be 768 } else {
8bb54ab5
AS
769 printk(KERN_ERR "%s: error %d registering interface "
770 " driver %s\n",
ddae41be
GKH
771 usbcore_name, retval, new_driver->name);
772 }
773
774 return retval;
775}
b87ba0a3 776EXPORT_SYMBOL_GPL_FUTURE(usb_register_driver);
ddae41be
GKH
777
778/**
8bb54ab5
AS
779 * usb_deregister - unregister a USB interface driver
780 * @driver: USB operations of the interface driver to unregister
ddae41be
GKH
781 * Context: must be able to sleep
782 *
783 * Unlinks the specified driver from the internal USB driver list.
784 *
785 * NOTE: If you called usb_register_dev(), you still need to call
786 * usb_deregister_dev() to clean up your driver's allocated minor numbers,
787 * this * call will no longer do it for you.
788 */
789void usb_deregister(struct usb_driver *driver)
790{
8bb54ab5
AS
791 pr_info("%s: deregistering interface driver %s\n",
792 usbcore_name, driver->name);
ddae41be 793
ba9dc657 794 usb_remove_newid_file(driver);
733260ff 795 usb_free_dynids(driver);
8bb54ab5 796 driver_unregister(&driver->drvwrap.driver);
ddae41be
GKH
797
798 usbfs_update_special();
799}
b87ba0a3 800EXPORT_SYMBOL_GPL_FUTURE(usb_deregister);
36e56a34
AS
801
802#ifdef CONFIG_PM
803
e0318ebf 804/* Caller has locked udev's pm_mutex */
d5ec1686 805static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
36e56a34 806{
782da727 807 struct usb_device_driver *udriver;
2bf4086d 808 int status = 0;
36e56a34 809
114b368c
AS
810 if (udev->state == USB_STATE_NOTATTACHED ||
811 udev->state == USB_STATE_SUSPENDED)
812 goto done;
813
b6f6436d
AS
814 /* For devices that don't have a driver, we do a generic suspend. */
815 if (udev->dev.driver)
816 udriver = to_usb_device_driver(udev->dev.driver);
817 else {
645daaab 818 udev->do_remote_wakeup = 0;
b6f6436d 819 udriver = &usb_generic_driver;
1c5df7e7 820 }
2bf4086d
AS
821 status = udriver->suspend(udev, msg);
822
20dfdad7
AS
823 done:
824 dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
2bf4086d
AS
825 if (status == 0)
826 udev->dev.power.power_state.event = msg.event;
827 return status;
1cc8a25d
AS
828}
829
e0318ebf 830/* Caller has locked udev's pm_mutex */
d5ec1686 831static int usb_resume_device(struct usb_device *udev)
1cc8a25d
AS
832{
833 struct usb_device_driver *udriver;
2bf4086d 834 int status = 0;
36e56a34 835
0458d5b4
AS
836 if (udev->state == USB_STATE_NOTATTACHED)
837 goto done;
838 if (udev->state != USB_STATE_SUSPENDED && !udev->reset_resume)
2bf4086d 839 goto done;
1cc8a25d 840
1c5df7e7
AS
841 /* Can't resume it if it doesn't have a driver. */
842 if (udev->dev.driver == NULL) {
843 status = -ENOTCONN;
2bf4086d 844 goto done;
1c5df7e7
AS
845 }
846
6bc6cff5
AS
847 if (udev->quirks & USB_QUIRK_RESET_RESUME)
848 udev->reset_resume = 1;
849
1cc8a25d 850 udriver = to_usb_device_driver(udev->dev.driver);
2bf4086d
AS
851 status = udriver->resume(udev);
852
20dfdad7
AS
853 done:
854 dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
2add5229
AS
855 if (status == 0) {
856 udev->autoresume_disabled = 0;
2bf4086d 857 udev->dev.power.power_state.event = PM_EVENT_ON;
2add5229 858 }
2bf4086d 859 return status;
1cc8a25d
AS
860}
861
e0318ebf 862/* Caller has locked intf's usb_device's pm mutex */
d5ec1686 863static int usb_suspend_interface(struct usb_interface *intf, pm_message_t msg)
1cc8a25d
AS
864{
865 struct usb_driver *driver;
2bf4086d 866 int status = 0;
1cc8a25d 867
114b368c
AS
868 /* with no hardware, USB interfaces only use FREEZE and ON states */
869 if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
870 !is_active(intf))
2bf4086d 871 goto done;
1cc8a25d 872
645daaab 873 if (intf->condition == USB_INTERFACE_UNBOUND) /* This can't happen */
2bf4086d 874 goto done;
114b368c 875 driver = to_usb_driver(intf->dev.driver);
36e56a34
AS
876
877 if (driver->suspend && driver->resume) {
1cc8a25d 878 status = driver->suspend(intf, msg);
645daaab
AS
879 if (status == 0)
880 mark_quiesced(intf);
881 else if (!interface_to_usbdev(intf)->auto_pm)
1cc8a25d
AS
882 dev_err(&intf->dev, "%s error %d\n",
883 "suspend", status);
36e56a34
AS
884 } else {
885 // FIXME else if there's no suspend method, disconnect...
645daaab 886 // Not possible if auto_pm is set...
1cc8a25d
AS
887 dev_warn(&intf->dev, "no suspend for driver %s?\n",
888 driver->name);
36e56a34 889 mark_quiesced(intf);
36e56a34 890 }
2bf4086d 891
20dfdad7
AS
892 done:
893 dev_vdbg(&intf->dev, "%s: status %d\n", __FUNCTION__, status);
36e56a34
AS
894 return status;
895}
896
645daaab 897/* Caller has locked intf's usb_device's pm_mutex */
0458d5b4 898static int usb_resume_interface(struct usb_interface *intf, int reset_resume)
36e56a34 899{
1cc8a25d 900 struct usb_driver *driver;
2bf4086d 901 int status = 0;
36e56a34 902
114b368c
AS
903 if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
904 is_active(intf))
2bf4086d 905 goto done;
36e56a34 906
645daaab
AS
907 /* Don't let autoresume interfere with unbinding */
908 if (intf->condition == USB_INTERFACE_UNBINDING)
909 goto done;
910
1c5df7e7 911 /* Can't resume it if it doesn't have a driver. */
645daaab 912 if (intf->condition == USB_INTERFACE_UNBOUND) {
1c5df7e7 913 status = -ENOTCONN;
2bf4086d 914 goto done;
1c5df7e7 915 }
1cc8a25d 916 driver = to_usb_driver(intf->dev.driver);
36e56a34 917
0458d5b4
AS
918 if (reset_resume && driver->post_reset)
919 driver->post_reset(intf, reset_resume);
920 else if (driver->resume) {
36e56a34 921 status = driver->resume(intf);
2bf4086d 922 if (status)
1cc8a25d
AS
923 dev_err(&intf->dev, "%s error %d\n",
924 "resume", status);
0458d5b4 925 } else
1cc8a25d
AS
926 dev_warn(&intf->dev, "no resume for driver %s?\n",
927 driver->name);
2bf4086d
AS
928
929done:
20dfdad7 930 dev_vdbg(&intf->dev, "%s: status %d\n", __FUNCTION__, status);
0458d5b4
AS
931 if (status == 0)
932 mark_active(intf);
2bf4086d 933 return status;
36e56a34
AS
934}
935
94fcda1f
AS
936#ifdef CONFIG_USB_SUSPEND
937
af4f7606
AS
938/* Internal routine to check whether we may autosuspend a device. */
939static int autosuspend_check(struct usb_device *udev)
940{
941 int i;
942 struct usb_interface *intf;
8c9862e5 943 unsigned long suspend_time;
af4f7606 944
b5e795f8
AS
945 /* For autosuspend, fail fast if anything is in use or autosuspend
946 * is disabled. Also fail if any interfaces require remote wakeup
947 * but it isn't available.
948 */
af4f7606
AS
949 udev->do_remote_wakeup = device_may_wakeup(&udev->dev);
950 if (udev->pm_usage_cnt > 0)
951 return -EBUSY;
2add5229 952 if (udev->autosuspend_delay < 0 || udev->autosuspend_disabled)
b5e795f8
AS
953 return -EPERM;
954
1941044a 955 suspend_time = udev->last_busy + udev->autosuspend_delay;
af4f7606
AS
956 if (udev->actconfig) {
957 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
958 intf = udev->actconfig->interface[i];
959 if (!is_active(intf))
960 continue;
961 if (intf->pm_usage_cnt > 0)
962 return -EBUSY;
963 if (intf->needs_remote_wakeup &&
964 !udev->do_remote_wakeup) {
965 dev_dbg(&udev->dev, "remote wakeup needed "
966 "for autosuspend\n");
967 return -EOPNOTSUPP;
968 }
969 }
970 }
1941044a
AS
971
972 /* If everything is okay but the device hasn't been idle for long
973 * enough, queue a delayed autosuspend request.
974 */
8c9862e5
AS
975 if (time_after(suspend_time, jiffies)) {
976 if (!timer_pending(&udev->autosuspend.timer)) {
977
978 /* The value of jiffies may change between the
979 * time_after() comparison above and the subtraction
980 * below. That's okay; the system behaves sanely
981 * when a timer is registered for the present moment
982 * or for the past.
983 */
1941044a 984 queue_delayed_work(ksuspend_usb_wq, &udev->autosuspend,
8c9862e5
AS
985 suspend_time - jiffies);
986 }
1941044a
AS
987 return -EAGAIN;
988 }
af4f7606
AS
989 return 0;
990}
991
94fcda1f
AS
992#else
993
ef7f6c70
AS
994static inline int autosuspend_check(struct usb_device *udev)
995{
996 return 0;
997}
94fcda1f 998
b5e795f8 999#endif /* CONFIG_USB_SUSPEND */
94fcda1f 1000
645daaab
AS
1001/**
1002 * usb_suspend_both - suspend a USB device and its interfaces
1003 * @udev: the usb_device to suspend
1004 * @msg: Power Management message describing this state transition
1005 *
1006 * This is the central routine for suspending USB devices. It calls the
1007 * suspend methods for all the interface drivers in @udev and then calls
1008 * the suspend method for @udev itself. If an error occurs at any stage,
1009 * all the interfaces which were suspended are resumed so that they remain
1010 * in the same state as the device.
1011 *
1012 * If an autosuspend is in progress (@udev->auto_pm is set), the routine
1013 * checks first to make sure that neither the device itself or any of its
1014 * active interfaces is in use (pm_usage_cnt is greater than 0). If they
1015 * are, the autosuspend fails.
1016 *
1017 * If the suspend succeeds, the routine recursively queues an autosuspend
1018 * request for @udev's parent device, thereby propagating the change up
1019 * the device tree. If all of the parent's children are now suspended,
1020 * the parent will autosuspend in turn.
1021 *
1022 * The suspend method calls are subject to mutual exclusion under control
1023 * of @udev's pm_mutex. Many of these calls are also under the protection
1024 * of @udev's device lock (including all requests originating outside the
1025 * USB subsystem), but autosuspend requests generated by a child device or
1026 * interface driver may not be. Usbcore will insure that the method calls
1027 * do not arrive during bind, unbind, or reset operations. However, drivers
1028 * must be prepared to handle suspend calls arriving at unpredictable times.
1029 * The only way to block such calls is to do an autoresume (preventing
1030 * autosuspends) while holding @udev's device lock (preventing outside
1031 * suspends).
1032 *
1033 * The caller must hold @udev->pm_mutex.
1034 *
1035 * This routine can run only in process context.
1036 */
718efa64 1037static int usb_suspend_both(struct usb_device *udev, pm_message_t msg)
a8e7c565
AS
1038{
1039 int status = 0;
1040 int i = 0;
1041 struct usb_interface *intf;
645daaab
AS
1042 struct usb_device *parent = udev->parent;
1043
1941044a
AS
1044 if (udev->state == USB_STATE_NOTATTACHED ||
1045 udev->state == USB_STATE_SUSPENDED)
1046 goto done;
a8e7c565 1047
645daaab
AS
1048 udev->do_remote_wakeup = device_may_wakeup(&udev->dev);
1049
645daaab 1050 if (udev->auto_pm) {
af4f7606
AS
1051 status = autosuspend_check(udev);
1052 if (status < 0)
1941044a 1053 goto done;
645daaab
AS
1054 }
1055
1056 /* Suspend all the interfaces and then udev itself */
a8e7c565
AS
1057 if (udev->actconfig) {
1058 for (; i < udev->actconfig->desc.bNumInterfaces; i++) {
1059 intf = udev->actconfig->interface[i];
d5ec1686 1060 status = usb_suspend_interface(intf, msg);
a8e7c565
AS
1061 if (status != 0)
1062 break;
1063 }
1064 }
4d461095
AS
1065 if (status == 0) {
1066
1067 /* Non-root devices don't need to do anything for FREEZE
1068 * or PRETHAW. */
1069 if (udev->parent && (msg.event == PM_EVENT_FREEZE ||
1070 msg.event == PM_EVENT_PRETHAW))
1071 goto done;
d5ec1686 1072 status = usb_suspend_device(udev, msg);
4d461095 1073 }
a8e7c565
AS
1074
1075 /* If the suspend failed, resume interfaces that did get suspended */
1076 if (status != 0) {
1077 while (--i >= 0) {
1078 intf = udev->actconfig->interface[i];
0458d5b4 1079 usb_resume_interface(intf, 0);
a8e7c565 1080 }
645daaab 1081
ef7f6c70
AS
1082 /* Try another autosuspend when the interfaces aren't busy */
1083 if (udev->auto_pm)
1084 autosuspend_check(udev);
1085
645daaab 1086 /* If the suspend succeeded, propagate it up the tree */
ef7f6c70
AS
1087 } else {
1088 cancel_delayed_work(&udev->autosuspend);
1089 if (parent)
1090 usb_autosuspend_device(parent);
1091 }
645daaab 1092
1941044a 1093 done:
20dfdad7 1094 dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
a8e7c565
AS
1095 return status;
1096}
1097
645daaab
AS
1098/**
1099 * usb_resume_both - resume a USB device and its interfaces
1100 * @udev: the usb_device to resume
1101 *
1102 * This is the central routine for resuming USB devices. It calls the
1103 * the resume method for @udev and then calls the resume methods for all
1104 * the interface drivers in @udev.
1105 *
1106 * Before starting the resume, the routine calls itself recursively for
1107 * the parent device of @udev, thereby propagating the change up the device
1108 * tree and assuring that @udev will be able to resume. If the parent is
1109 * unable to resume successfully, the routine fails.
1110 *
1111 * The resume method calls are subject to mutual exclusion under control
1112 * of @udev's pm_mutex. Many of these calls are also under the protection
1113 * of @udev's device lock (including all requests originating outside the
1114 * USB subsystem), but autoresume requests generated by a child device or
1115 * interface driver may not be. Usbcore will insure that the method calls
1116 * do not arrive during bind, unbind, or reset operations. However, drivers
1117 * must be prepared to handle resume calls arriving at unpredictable times.
1118 * The only way to block such calls is to do an autoresume (preventing
1119 * other autoresumes) while holding @udev's device lock (preventing outside
1120 * resumes).
1121 *
1122 * The caller must hold @udev->pm_mutex.
1123 *
1124 * This routine can run only in process context.
1125 */
718efa64 1126static int usb_resume_both(struct usb_device *udev)
a8e7c565 1127{
645daaab 1128 int status = 0;
a8e7c565
AS
1129 int i;
1130 struct usb_interface *intf;
645daaab
AS
1131 struct usb_device *parent = udev->parent;
1132
1133 cancel_delayed_work(&udev->autosuspend);
1941044a
AS
1134 if (udev->state == USB_STATE_NOTATTACHED) {
1135 status = -ENODEV;
1136 goto done;
1137 }
a8e7c565 1138
645daaab
AS
1139 /* Propagate the resume up the tree, if necessary */
1140 if (udev->state == USB_STATE_SUSPENDED) {
1941044a
AS
1141 if (udev->auto_pm && udev->autoresume_disabled) {
1142 status = -EPERM;
1143 goto done;
1144 }
645daaab 1145 if (parent) {
94fcda1f 1146 status = usb_autoresume_device(parent);
ee49fb5d
AS
1147 if (status == 0) {
1148 status = usb_resume_device(udev);
1149 if (status) {
94fcda1f 1150 usb_autosuspend_device(parent);
ee49fb5d
AS
1151
1152 /* It's possible usb_resume_device()
1153 * failed after the port was
1154 * unsuspended, causing udev to be
1155 * logically disconnected. We don't
1156 * want usb_disconnect() to autosuspend
1157 * the parent again, so tell it that
1158 * udev disconnected while still
1159 * suspended. */
1160 if (udev->state ==
1161 USB_STATE_NOTATTACHED)
1162 udev->discon_suspended = 1;
1163 }
1164 }
645daaab
AS
1165 } else {
1166
1167 /* We can't progagate beyond the USB subsystem,
1168 * so if a root hub's controller is suspended
1169 * then we're stuck. */
1170 if (udev->dev.parent->power.power_state.event !=
1171 PM_EVENT_ON)
1172 status = -EHOSTUNREACH;
ee49fb5d
AS
1173 else
1174 status = usb_resume_device(udev);
1175 }
592fbbe4
AS
1176 } else {
1177
0458d5b4
AS
1178 /* Needed for setting udev->dev.power.power_state.event,
1179 * for possible debugging message, and for reset_resume. */
d5ec1686 1180 status = usb_resume_device(udev);
114b368c
AS
1181 }
1182
a8e7c565
AS
1183 if (status == 0 && udev->actconfig) {
1184 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1185 intf = udev->actconfig->interface[i];
0458d5b4 1186 usb_resume_interface(intf, udev->reset_resume);
a8e7c565
AS
1187 }
1188 }
645daaab 1189
1941044a 1190 done:
20dfdad7 1191 dev_vdbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
0458d5b4 1192 udev->reset_resume = 0;
645daaab
AS
1193 return status;
1194}
1195
1196#ifdef CONFIG_USB_SUSPEND
1197
94fcda1f
AS
1198/* Internal routine to adjust a device's usage counter and change
1199 * its autosuspend state.
1200 */
1201static int usb_autopm_do_device(struct usb_device *udev, int inc_usage_cnt)
1202{
1203 int status = 0;
1204
1205 usb_pm_lock(udev);
1941044a 1206 udev->auto_pm = 1;
94fcda1f
AS
1207 udev->pm_usage_cnt += inc_usage_cnt;
1208 WARN_ON(udev->pm_usage_cnt < 0);
1209 if (inc_usage_cnt >= 0 && udev->pm_usage_cnt > 0) {
1941044a
AS
1210 if (udev->state == USB_STATE_SUSPENDED)
1211 status = usb_resume_both(udev);
94fcda1f
AS
1212 if (status != 0)
1213 udev->pm_usage_cnt -= inc_usage_cnt;
1941044a
AS
1214 else if (inc_usage_cnt)
1215 udev->last_busy = jiffies;
1216 } else if (inc_usage_cnt <= 0 && udev->pm_usage_cnt <= 0) {
1217 if (inc_usage_cnt)
1218 udev->last_busy = jiffies;
1219 status = usb_suspend_both(udev, PMSG_SUSPEND);
1220 }
94fcda1f
AS
1221 usb_pm_unlock(udev);
1222 return status;
1223}
1224
1941044a
AS
1225/* usb_autosuspend_work - callback routine to autosuspend a USB device */
1226void usb_autosuspend_work(struct work_struct *work)
1227{
1228 struct usb_device *udev =
1229 container_of(work, struct usb_device, autosuspend.work);
1230
1231 usb_autopm_do_device(udev, 0);
1232}
1233
645daaab
AS
1234/**
1235 * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
701f35af 1236 * @udev: the usb_device to autosuspend
645daaab
AS
1237 *
1238 * This routine should be called when a core subsystem is finished using
1239 * @udev and wants to allow it to autosuspend. Examples would be when
1240 * @udev's device file in usbfs is closed or after a configuration change.
1241 *
94fcda1f
AS
1242 * @udev's usage counter is decremented. If it or any of the usage counters
1243 * for an active interface is greater than 0, no autosuspend request will be
1244 * queued. (If an interface driver does not support autosuspend then its
1245 * usage counter is permanently positive.) Furthermore, if an interface
1246 * driver requires remote-wakeup capability during autosuspend but remote
1247 * wakeup is disabled, the autosuspend will fail.
645daaab
AS
1248 *
1249 * Often the caller will hold @udev's device lock, but this is not
1250 * necessary.
1251 *
1252 * This routine can run only in process context.
1253 */
94fcda1f 1254void usb_autosuspend_device(struct usb_device *udev)
645daaab 1255{
94fcda1f
AS
1256 int status;
1257
1258 status = usb_autopm_do_device(udev, -1);
20dfdad7
AS
1259 dev_vdbg(&udev->dev, "%s: cnt %d\n",
1260 __FUNCTION__, udev->pm_usage_cnt);
19c26239
AS
1261}
1262
1263/**
1264 * usb_try_autosuspend_device - attempt an autosuspend of a USB device and its interfaces
1265 * @udev: the usb_device to autosuspend
1266 *
1267 * This routine should be called when a core subsystem thinks @udev may
1268 * be ready to autosuspend.
1269 *
1270 * @udev's usage counter left unchanged. If it or any of the usage counters
1271 * for an active interface is greater than 0, or autosuspend is not allowed
1272 * for any other reason, no autosuspend request will be queued.
1273 *
1274 * This routine can run only in process context.
1275 */
1276void usb_try_autosuspend_device(struct usb_device *udev)
1277{
1278 usb_autopm_do_device(udev, 0);
20dfdad7
AS
1279 dev_vdbg(&udev->dev, "%s: cnt %d\n",
1280 __FUNCTION__, udev->pm_usage_cnt);
645daaab
AS
1281}
1282
1283/**
1284 * usb_autoresume_device - immediately autoresume a USB device and its interfaces
701f35af 1285 * @udev: the usb_device to autoresume
645daaab
AS
1286 *
1287 * This routine should be called when a core subsystem wants to use @udev
94fcda1f
AS
1288 * and needs to guarantee that it is not suspended. No autosuspend will
1289 * occur until usb_autosuspend_device is called. (Note that this will not
1290 * prevent suspend events originating in the PM core.) Examples would be
1291 * when @udev's device file in usbfs is opened or when a remote-wakeup
1292 * request is received.
645daaab 1293 *
94fcda1f
AS
1294 * @udev's usage counter is incremented to prevent subsequent autosuspends.
1295 * However if the autoresume fails then the usage counter is re-decremented.
645daaab
AS
1296 *
1297 * Often the caller will hold @udev's device lock, but this is not
1298 * necessary (and attempting it might cause deadlock).
1299 *
1300 * This routine can run only in process context.
1301 */
94fcda1f 1302int usb_autoresume_device(struct usb_device *udev)
645daaab
AS
1303{
1304 int status;
1305
94fcda1f 1306 status = usb_autopm_do_device(udev, 1);
20dfdad7
AS
1307 dev_vdbg(&udev->dev, "%s: status %d cnt %d\n",
1308 __FUNCTION__, status, udev->pm_usage_cnt);
645daaab
AS
1309 return status;
1310}
1311
af4f7606
AS
1312/* Internal routine to adjust an interface's usage counter and change
1313 * its device's autosuspend state.
1314 */
1315static int usb_autopm_do_interface(struct usb_interface *intf,
1316 int inc_usage_cnt)
1317{
1318 struct usb_device *udev = interface_to_usbdev(intf);
1319 int status = 0;
1320
1321 usb_pm_lock(udev);
1322 if (intf->condition == USB_INTERFACE_UNBOUND)
1323 status = -ENODEV;
1324 else {
1941044a 1325 udev->auto_pm = 1;
af4f7606
AS
1326 intf->pm_usage_cnt += inc_usage_cnt;
1327 if (inc_usage_cnt >= 0 && intf->pm_usage_cnt > 0) {
1941044a
AS
1328 if (udev->state == USB_STATE_SUSPENDED)
1329 status = usb_resume_both(udev);
af4f7606
AS
1330 if (status != 0)
1331 intf->pm_usage_cnt -= inc_usage_cnt;
1941044a
AS
1332 else if (inc_usage_cnt)
1333 udev->last_busy = jiffies;
1334 } else if (inc_usage_cnt <= 0 && intf->pm_usage_cnt <= 0) {
1335 if (inc_usage_cnt)
1336 udev->last_busy = jiffies;
1337 status = usb_suspend_both(udev, PMSG_SUSPEND);
1338 }
af4f7606
AS
1339 }
1340 usb_pm_unlock(udev);
1341 return status;
1342}
1343
645daaab
AS
1344/**
1345 * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
701f35af 1346 * @intf: the usb_interface whose counter should be decremented
645daaab
AS
1347 *
1348 * This routine should be called by an interface driver when it is
1349 * finished using @intf and wants to allow it to autosuspend. A typical
1350 * example would be a character-device driver when its device file is
1351 * closed.
1352 *
1353 * The routine decrements @intf's usage counter. When the counter reaches
1354 * 0, a delayed autosuspend request for @intf's device is queued. When
1355 * the delay expires, if @intf->pm_usage_cnt is still <= 0 along with all
1356 * the other usage counters for the sibling interfaces and @intf's
1357 * usb_device, the device and all its interfaces will be autosuspended.
1358 *
1359 * Note that @intf->pm_usage_cnt is owned by the interface driver. The
1360 * core will not change its value other than the increment and decrement
1361 * in usb_autopm_get_interface and usb_autopm_put_interface. The driver
1362 * may use this simple counter-oriented discipline or may set the value
1363 * any way it likes.
1364 *
1365 * If the driver has set @intf->needs_remote_wakeup then autosuspend will
1366 * take place only if the device's remote-wakeup facility is enabled.
1367 *
1368 * Suspend method calls queued by this routine can arrive at any time
1369 * while @intf is resumed and its usage counter is equal to 0. They are
1370 * not protected by the usb_device's lock but only by its pm_mutex.
1371 * Drivers must provide their own synchronization.
1372 *
1373 * This routine can run only in process context.
1374 */
1375void usb_autopm_put_interface(struct usb_interface *intf)
1376{
af4f7606 1377 int status;
645daaab 1378
af4f7606 1379 status = usb_autopm_do_interface(intf, -1);
20dfdad7
AS
1380 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1381 __FUNCTION__, status, intf->pm_usage_cnt);
645daaab
AS
1382}
1383EXPORT_SYMBOL_GPL(usb_autopm_put_interface);
1384
1385/**
1386 * usb_autopm_get_interface - increment a USB interface's PM-usage counter
701f35af 1387 * @intf: the usb_interface whose counter should be incremented
645daaab
AS
1388 *
1389 * This routine should be called by an interface driver when it wants to
1390 * use @intf and needs to guarantee that it is not suspended. In addition,
1391 * the routine prevents @intf from being autosuspended subsequently. (Note
1392 * that this will not prevent suspend events originating in the PM core.)
1393 * This prevention will persist until usb_autopm_put_interface() is called
1394 * or @intf is unbound. A typical example would be a character-device
1395 * driver when its device file is opened.
1396 *
1941044a
AS
1397 *
1398 * The routine increments @intf's usage counter. (However if the
1399 * autoresume fails then the counter is re-decremented.) So long as the
1400 * counter is greater than 0, autosuspend will not be allowed for @intf
1401 * or its usb_device. When the driver is finished using @intf it should
1402 * call usb_autopm_put_interface() to decrement the usage counter and
1403 * queue a delayed autosuspend request (if the counter is <= 0).
1404 *
645daaab
AS
1405 *
1406 * Note that @intf->pm_usage_cnt is owned by the interface driver. The
1407 * core will not change its value other than the increment and decrement
1408 * in usb_autopm_get_interface and usb_autopm_put_interface. The driver
1409 * may use this simple counter-oriented discipline or may set the value
1410 * any way it likes.
1411 *
1412 * Resume method calls generated by this routine can arrive at any time
1413 * while @intf is suspended. They are not protected by the usb_device's
1414 * lock but only by its pm_mutex. Drivers must provide their own
1415 * synchronization.
1416 *
1417 * This routine can run only in process context.
1418 */
1419int usb_autopm_get_interface(struct usb_interface *intf)
1420{
af4f7606 1421 int status;
645daaab 1422
af4f7606 1423 status = usb_autopm_do_interface(intf, 1);
20dfdad7
AS
1424 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1425 __FUNCTION__, status, intf->pm_usage_cnt);
a8e7c565
AS
1426 return status;
1427}
645daaab
AS
1428EXPORT_SYMBOL_GPL(usb_autopm_get_interface);
1429
692a186c
AS
1430/**
1431 * usb_autopm_set_interface - set a USB interface's autosuspend state
1432 * @intf: the usb_interface whose state should be set
1433 *
1434 * This routine sets the autosuspend state of @intf's device according
1435 * to @intf's usage counter, which the caller must have set previously.
1436 * If the counter is <= 0, the device is autosuspended (if it isn't
1437 * already suspended and if nothing else prevents the autosuspend). If
1438 * the counter is > 0, the device is autoresumed (if it isn't already
1439 * awake).
1440 */
1441int usb_autopm_set_interface(struct usb_interface *intf)
1442{
1443 int status;
1444
1445 status = usb_autopm_do_interface(intf, 0);
20dfdad7
AS
1446 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1447 __FUNCTION__, status, intf->pm_usage_cnt);
692a186c
AS
1448 return status;
1449}
1450EXPORT_SYMBOL_GPL(usb_autopm_set_interface);
1451
718efa64
AS
1452#else
1453
1454void usb_autosuspend_work(struct work_struct *work)
1455{}
1456
645daaab 1457#endif /* CONFIG_USB_SUSPEND */
a8e7c565 1458
6b157c9b
AS
1459/**
1460 * usb_external_suspend_device - external suspend of a USB device and its interfaces
1461 * @udev: the usb_device to suspend
1462 * @msg: Power Management message describing this state transition
1463 *
1464 * This routine handles external suspend requests: ones not generated
1465 * internally by a USB driver (autosuspend) but rather coming from the user
1466 * (via sysfs) or the PM core (system sleep). The suspend will be carried
1467 * out regardless of @udev's usage counter or those of its interfaces,
1468 * and regardless of whether or not remote wakeup is enabled. Of course,
1469 * interface drivers still have the option of failing the suspend (if
1470 * there are unsuspended children, for example).
1471 *
1472 * The caller must hold @udev's device lock.
1473 */
1474int usb_external_suspend_device(struct usb_device *udev, pm_message_t msg)
1cc8a25d
AS
1475{
1476 int status;
1477
6b157c9b
AS
1478 usb_pm_lock(udev);
1479 udev->auto_pm = 0;
1480 status = usb_suspend_both(udev, msg);
1481 usb_pm_unlock(udev);
1cc8a25d
AS
1482 return status;
1483}
1484
6b157c9b
AS
1485/**
1486 * usb_external_resume_device - external resume of a USB device and its interfaces
1487 * @udev: the usb_device to resume
1488 *
1489 * This routine handles external resume requests: ones not generated
1490 * internally by a USB driver (autoresume) but rather coming from the user
1491 * (via sysfs), the PM core (system resume), or the device itself (remote
1492 * wakeup). @udev's usage counter is unaffected.
1493 *
1494 * The caller must hold @udev's device lock.
1495 */
1496int usb_external_resume_device(struct usb_device *udev)
1cc8a25d
AS
1497{
1498 int status;
1499
6b157c9b
AS
1500 usb_pm_lock(udev);
1501 udev->auto_pm = 0;
1502 status = usb_resume_both(udev);
ef7f6c70 1503 udev->last_busy = jiffies;
6b157c9b 1504 usb_pm_unlock(udev);
a8e7c565 1505
6b157c9b
AS
1506 /* Now that the device is awake, we can start trying to autosuspend
1507 * it again. */
1508 if (status == 0)
1509 usb_try_autosuspend_device(udev);
1cc8a25d
AS
1510 return status;
1511}
1512
6b157c9b
AS
1513static int usb_suspend(struct device *dev, pm_message_t message)
1514{
1515 if (!is_usb_device(dev)) /* Ignore PM for interfaces */
1516 return 0;
1517 return usb_external_suspend_device(to_usb_device(dev), message);
1518}
1519
1520static int usb_resume(struct device *dev)
1521{
2add5229
AS
1522 struct usb_device *udev;
1523
6b157c9b
AS
1524 if (!is_usb_device(dev)) /* Ignore PM for interfaces */
1525 return 0;
2add5229 1526 udev = to_usb_device(dev);
0458d5b4
AS
1527
1528 /* If autoresume is disabled then we also want to prevent resume
1529 * during system wakeup. However, a "persistent-device" reset-resume
1530 * after power loss counts as a wakeup event. So allow a
1531 * reset-resume to occur if remote wakeup is enabled. */
1532 if (udev->autoresume_disabled) {
1533 if (!(udev->reset_resume && udev->do_remote_wakeup))
1534 return -EPERM;
1535 }
2add5229 1536 return usb_external_resume_device(udev);
6b157c9b
AS
1537}
1538
1539#else
1540
1541#define usb_suspend NULL
1542#define usb_resume NULL
1543
36e56a34
AS
1544#endif /* CONFIG_PM */
1545
1546struct bus_type usb_bus_type = {
1547 .name = "usb",
1548 .match = usb_device_match,
1549 .uevent = usb_uevent,
782da727
AS
1550 .suspend = usb_suspend,
1551 .resume = usb_resume,
36e56a34 1552};