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