USB: replace remaining __FUNCTION__ occurrences
[linux-2.6.git] / 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 = driver_create_file(&usb_drv->drvwrap.driver,
95                                            &driver_attr_new_id);
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                 driver_remove_file(&usb_drv->drvwrap.driver,
107                                    &driver_attr_new_id);
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", __func__);
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", __func__);
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", __func__);
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_GPL(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_GPL(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->idProduct || id->bDeviceClass ||
538                id->bInterfaceClass || 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(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         /* driver is often null here; dev_dbg() would oops */
589         pr_debug("usb %s: uevent\n", dev->bus_id);
590
591         if (is_usb_device(dev))
592                 usb_dev = to_usb_device(dev);
593         else {
594                 struct usb_interface *intf = to_usb_interface(dev);
595                 usb_dev = interface_to_usbdev(intf);
596         }
597
598         if (usb_dev->devnum < 0) {
599                 pr_debug("usb %s: already deleted?\n", dev->bus_id);
600                 return -ENODEV;
601         }
602         if (!usb_dev->bus) {
603                 pr_debug("usb %s: bus removed?\n", dev->bus_id);
604                 return -ENODEV;
605         }
606
607 #ifdef  CONFIG_USB_DEVICEFS
608         /* If this is available, userspace programs can directly read
609          * all the device descriptors we don't tell them about.  Or
610          * act as usermode drivers.
611          */
612         if (add_uevent_var(env, "DEVICE=/proc/bus/usb/%03d/%03d",
613                            usb_dev->bus->busnum, usb_dev->devnum))
614                 return -ENOMEM;
615 #endif
616
617         /* per-device configurations are common */
618         if (add_uevent_var(env, "PRODUCT=%x/%x/%x",
619                            le16_to_cpu(usb_dev->descriptor.idVendor),
620                            le16_to_cpu(usb_dev->descriptor.idProduct),
621                            le16_to_cpu(usb_dev->descriptor.bcdDevice)))
622                 return -ENOMEM;
623
624         /* class-based driver binding models */
625         if (add_uevent_var(env, "TYPE=%d/%d/%d",
626                            usb_dev->descriptor.bDeviceClass,
627                            usb_dev->descriptor.bDeviceSubClass,
628                            usb_dev->descriptor.bDeviceProtocol))
629                 return -ENOMEM;
630
631         return 0;
632 }
633
634 #else
635
636 static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
637 {
638         return -ENODEV;
639 }
640 #endif  /* CONFIG_HOTPLUG */
641
642 /**
643  * usb_register_device_driver - register a USB device (not interface) driver
644  * @new_udriver: USB operations for the device driver
645  * @owner: module owner of this driver.
646  *
647  * Registers a USB device driver with the USB core.  The list of
648  * unattached devices will be rescanned whenever a new driver is
649  * added, allowing the new driver to attach to any recognized devices.
650  * Returns a negative error code on failure and 0 on success.
651  */
652 int usb_register_device_driver(struct usb_device_driver *new_udriver,
653                 struct module *owner)
654 {
655         int retval = 0;
656
657         if (usb_disabled())
658                 return -ENODEV;
659
660         new_udriver->drvwrap.for_devices = 1;
661         new_udriver->drvwrap.driver.name = (char *) new_udriver->name;
662         new_udriver->drvwrap.driver.bus = &usb_bus_type;
663         new_udriver->drvwrap.driver.probe = usb_probe_device;
664         new_udriver->drvwrap.driver.remove = usb_unbind_device;
665         new_udriver->drvwrap.driver.owner = owner;
666
667         retval = driver_register(&new_udriver->drvwrap.driver);
668
669         if (!retval) {
670                 pr_info("%s: registered new device driver %s\n",
671                         usbcore_name, new_udriver->name);
672                 usbfs_update_special();
673         } else {
674                 printk(KERN_ERR "%s: error %d registering device "
675                         "       driver %s\n",
676                         usbcore_name, retval, new_udriver->name);
677         }
678
679         return retval;
680 }
681 EXPORT_SYMBOL_GPL(usb_register_device_driver);
682
683 /**
684  * usb_deregister_device_driver - unregister a USB device (not interface) driver
685  * @udriver: USB operations of the device driver to unregister
686  * Context: must be able to sleep
687  *
688  * Unlinks the specified driver from the internal USB driver list.
689  */
690 void usb_deregister_device_driver(struct usb_device_driver *udriver)
691 {
692         pr_info("%s: deregistering device driver %s\n",
693                         usbcore_name, udriver->name);
694
695         driver_unregister(&udriver->drvwrap.driver);
696         usbfs_update_special();
697 }
698 EXPORT_SYMBOL_GPL(usb_deregister_device_driver);
699
700 /**
701  * usb_register_driver - register a USB interface driver
702  * @new_driver: USB operations for the interface driver
703  * @owner: module owner of this driver.
704  * @mod_name: module name string
705  *
706  * Registers a USB interface driver with the USB core.  The list of
707  * unattached interfaces will be rescanned whenever a new driver is
708  * added, allowing the new driver to attach to any recognized interfaces.
709  * Returns a negative error code on failure and 0 on success.
710  *
711  * NOTE: if you want your driver to use the USB major number, you must call
712  * usb_register_dev() to enable that functionality.  This function no longer
713  * takes care of that.
714  */
715 int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
716                         const char *mod_name)
717 {
718         int retval = 0;
719
720         if (usb_disabled())
721                 return -ENODEV;
722
723         new_driver->drvwrap.for_devices = 0;
724         new_driver->drvwrap.driver.name = (char *) new_driver->name;
725         new_driver->drvwrap.driver.bus = &usb_bus_type;
726         new_driver->drvwrap.driver.probe = usb_probe_interface;
727         new_driver->drvwrap.driver.remove = usb_unbind_interface;
728         new_driver->drvwrap.driver.owner = owner;
729         new_driver->drvwrap.driver.mod_name = mod_name;
730         spin_lock_init(&new_driver->dynids.lock);
731         INIT_LIST_HEAD(&new_driver->dynids.list);
732
733         retval = driver_register(&new_driver->drvwrap.driver);
734
735         if (!retval) {
736                 pr_info("%s: registered new interface driver %s\n",
737                         usbcore_name, new_driver->name);
738                 usbfs_update_special();
739                 usb_create_newid_file(new_driver);
740         } else {
741                 printk(KERN_ERR "%s: error %d registering interface "
742                         "       driver %s\n",
743                         usbcore_name, retval, new_driver->name);
744         }
745
746         return retval;
747 }
748 EXPORT_SYMBOL_GPL(usb_register_driver);
749
750 /**
751  * usb_deregister - unregister a USB interface driver
752  * @driver: USB operations of the interface driver to unregister
753  * Context: must be able to sleep
754  *
755  * Unlinks the specified driver from the internal USB driver list.
756  *
757  * NOTE: If you called usb_register_dev(), you still need to call
758  * usb_deregister_dev() to clean up your driver's allocated minor numbers,
759  * this * call will no longer do it for you.
760  */
761 void usb_deregister(struct usb_driver *driver)
762 {
763         pr_info("%s: deregistering interface driver %s\n",
764                         usbcore_name, driver->name);
765
766         usb_remove_newid_file(driver);
767         usb_free_dynids(driver);
768         driver_unregister(&driver->drvwrap.driver);
769
770         usbfs_update_special();
771 }
772 EXPORT_SYMBOL_GPL(usb_deregister);
773
774 #ifdef CONFIG_PM
775
776 /* Caller has locked udev's pm_mutex */
777 static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
778 {
779         struct usb_device_driver        *udriver;
780         int                             status = 0;
781
782         if (udev->state == USB_STATE_NOTATTACHED ||
783                         udev->state == USB_STATE_SUSPENDED)
784                 goto done;
785
786         /* For devices that don't have a driver, we do a generic suspend. */
787         if (udev->dev.driver)
788                 udriver = to_usb_device_driver(udev->dev.driver);
789         else {
790                 udev->do_remote_wakeup = 0;
791                 udriver = &usb_generic_driver;
792         }
793         status = udriver->suspend(udev, msg);
794
795  done:
796         dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
797         return status;
798 }
799
800 /* Caller has locked udev's pm_mutex */
801 static int usb_resume_device(struct usb_device *udev)
802 {
803         struct usb_device_driver        *udriver;
804         int                             status = 0;
805
806         if (udev->state == USB_STATE_NOTATTACHED)
807                 goto done;
808         if (udev->state != USB_STATE_SUSPENDED && !udev->reset_resume)
809                 goto done;
810
811         /* Can't resume it if it doesn't have a driver. */
812         if (udev->dev.driver == NULL) {
813                 status = -ENOTCONN;
814                 goto done;
815         }
816
817         if (udev->quirks & USB_QUIRK_RESET_RESUME)
818                 udev->reset_resume = 1;
819
820         udriver = to_usb_device_driver(udev->dev.driver);
821         status = udriver->resume(udev);
822
823  done:
824         dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
825         if (status == 0)
826                 udev->autoresume_disabled = 0;
827         return status;
828 }
829
830 /* Caller has locked intf's usb_device's pm mutex */
831 static int usb_suspend_interface(struct usb_interface *intf, pm_message_t msg)
832 {
833         struct usb_driver       *driver;
834         int                     status = 0;
835
836         /* with no hardware, USB interfaces only use FREEZE and ON states */
837         if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
838                         !is_active(intf))
839                 goto done;
840
841         if (intf->condition == USB_INTERFACE_UNBOUND)   /* This can't happen */
842                 goto done;
843         driver = to_usb_driver(intf->dev.driver);
844
845         if (driver->suspend && driver->resume) {
846                 status = driver->suspend(intf, msg);
847                 if (status == 0)
848                         mark_quiesced(intf);
849                 else if (!interface_to_usbdev(intf)->auto_pm)
850                         dev_err(&intf->dev, "%s error %d\n",
851                                         "suspend", status);
852         } else {
853                 /*
854                  * FIXME else if there's no suspend method, disconnect...
855                  * Not possible if auto_pm is set...
856                  */
857                 dev_warn(&intf->dev, "no suspend for driver %s?\n",
858                                 driver->name);
859                 mark_quiesced(intf);
860         }
861
862  done:
863         dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
864         return status;
865 }
866
867 /* Caller has locked intf's usb_device's pm_mutex */
868 static int usb_resume_interface(struct usb_interface *intf, int reset_resume)
869 {
870         struct usb_driver       *driver;
871         int                     status = 0;
872
873         if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
874                         is_active(intf))
875                 goto done;
876
877         /* Don't let autoresume interfere with unbinding */
878         if (intf->condition == USB_INTERFACE_UNBINDING)
879                 goto done;
880
881         /* Can't resume it if it doesn't have a driver. */
882         if (intf->condition == USB_INTERFACE_UNBOUND) {
883                 status = -ENOTCONN;
884                 goto done;
885         }
886         driver = to_usb_driver(intf->dev.driver);
887
888         if (reset_resume) {
889                 if (driver->reset_resume) {
890                         status = driver->reset_resume(intf);
891                         if (status)
892                                 dev_err(&intf->dev, "%s error %d\n",
893                                                 "reset_resume", status);
894                 } else {
895                         /* status = -EOPNOTSUPP; */
896                         dev_warn(&intf->dev, "no %s for driver %s?\n",
897                                         "reset_resume", driver->name);
898                 }
899         } else {
900                 if (driver->resume) {
901                         status = driver->resume(intf);
902                         if (status)
903                                 dev_err(&intf->dev, "%s error %d\n",
904                                                 "resume", status);
905                 } else {
906                         /* status = -EOPNOTSUPP; */
907                         dev_warn(&intf->dev, "no %s for driver %s?\n",
908                                         "resume", driver->name);
909                 }
910         }
911
912 done:
913         dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
914         if (status == 0)
915                 mark_active(intf);
916
917         /* FIXME: Unbind the driver and reprobe if the resume failed
918          * (not possible if auto_pm is set) */
919         return status;
920 }
921
922 #ifdef  CONFIG_USB_SUSPEND
923
924 /* Internal routine to check whether we may autosuspend a device. */
925 static int autosuspend_check(struct usb_device *udev, int reschedule)
926 {
927         int                     i;
928         struct usb_interface    *intf;
929         unsigned long           suspend_time, j;
930
931         /* For autosuspend, fail fast if anything is in use or autosuspend
932          * is disabled.  Also fail if any interfaces require remote wakeup
933          * but it isn't available.
934          */
935         if (udev->pm_usage_cnt > 0)
936                 return -EBUSY;
937         if (udev->autosuspend_delay < 0 || udev->autosuspend_disabled)
938                 return -EPERM;
939
940         suspend_time = udev->last_busy + udev->autosuspend_delay;
941         if (udev->actconfig) {
942                 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
943                         intf = udev->actconfig->interface[i];
944                         if (!is_active(intf))
945                                 continue;
946                         if (intf->pm_usage_cnt > 0)
947                                 return -EBUSY;
948                         if (intf->needs_remote_wakeup &&
949                                         !udev->do_remote_wakeup) {
950                                 dev_dbg(&udev->dev, "remote wakeup needed "
951                                                 "for autosuspend\n");
952                                 return -EOPNOTSUPP;
953                         }
954
955                         /* Don't allow autosuspend if the device will need
956                          * a reset-resume and any of its interface drivers
957                          * doesn't include support.
958                          */
959                         if (udev->quirks & USB_QUIRK_RESET_RESUME) {
960                                 struct usb_driver *driver;
961
962                                 driver = to_usb_driver(intf->dev.driver);
963                                 if (!driver->reset_resume)
964                                         return -EOPNOTSUPP;
965                         }
966                 }
967         }
968
969         /* If everything is okay but the device hasn't been idle for long
970          * enough, queue a delayed autosuspend request.  If the device
971          * _has_ been idle for long enough and the reschedule flag is set,
972          * likewise queue a delayed (1 second) autosuspend request.
973          */
974         j = jiffies;
975         if (time_before(j, suspend_time))
976                 reschedule = 1;
977         else
978                 suspend_time = j + HZ;
979         if (reschedule) {
980                 if (!timer_pending(&udev->autosuspend.timer)) {
981                         queue_delayed_work(ksuspend_usb_wq, &udev->autosuspend,
982                                 round_jiffies_relative(suspend_time - j));
983                 }
984                 return -EAGAIN;
985         }
986         return 0;
987 }
988
989 #else
990
991 static inline int autosuspend_check(struct usb_device *udev, int reschedule)
992 {
993         return 0;
994 }
995
996 #endif  /* CONFIG_USB_SUSPEND */
997
998 /**
999  * usb_suspend_both - suspend a USB device and its interfaces
1000  * @udev: the usb_device to suspend
1001  * @msg: Power Management message describing this state transition
1002  *
1003  * This is the central routine for suspending USB devices.  It calls the
1004  * suspend methods for all the interface drivers in @udev and then calls
1005  * the suspend method for @udev itself.  If an error occurs at any stage,
1006  * all the interfaces which were suspended are resumed so that they remain
1007  * in the same state as the device.
1008  *
1009  * If an autosuspend is in progress (@udev->auto_pm is set), the routine
1010  * checks first to make sure that neither the device itself or any of its
1011  * active interfaces is in use (pm_usage_cnt is greater than 0).  If they
1012  * are, the autosuspend fails.
1013  *
1014  * If the suspend succeeds, the routine recursively queues an autosuspend
1015  * request for @udev's parent device, thereby propagating the change up
1016  * the device tree.  If all of the parent's children are now suspended,
1017  * the parent will autosuspend in turn.
1018  *
1019  * The suspend method calls are subject to mutual exclusion under control
1020  * of @udev's pm_mutex.  Many of these calls are also under the protection
1021  * of @udev's device lock (including all requests originating outside the
1022  * USB subsystem), but autosuspend requests generated by a child device or
1023  * interface driver may not be.  Usbcore will insure that the method calls
1024  * do not arrive during bind, unbind, or reset operations.  However, drivers
1025  * must be prepared to handle suspend calls arriving at unpredictable times.
1026  * The only way to block such calls is to do an autoresume (preventing
1027  * autosuspends) while holding @udev's device lock (preventing outside
1028  * suspends).
1029  *
1030  * The caller must hold @udev->pm_mutex.
1031  *
1032  * This routine can run only in process context.
1033  */
1034 static int usb_suspend_both(struct usb_device *udev, pm_message_t msg)
1035 {
1036         int                     status = 0;
1037         int                     i = 0;
1038         struct usb_interface    *intf;
1039         struct usb_device       *parent = udev->parent;
1040
1041         if (udev->state == USB_STATE_NOTATTACHED ||
1042                         udev->state == USB_STATE_SUSPENDED)
1043                 goto done;
1044
1045         udev->do_remote_wakeup = device_may_wakeup(&udev->dev);
1046
1047         if (udev->auto_pm) {
1048                 status = autosuspend_check(udev, 0);
1049                 if (status < 0)
1050                         goto done;
1051         }
1052
1053         /* Suspend all the interfaces and then udev itself */
1054         if (udev->actconfig) {
1055                 for (; i < udev->actconfig->desc.bNumInterfaces; i++) {
1056                         intf = udev->actconfig->interface[i];
1057                         status = usb_suspend_interface(intf, msg);
1058                         if (status != 0)
1059                                 break;
1060                 }
1061         }
1062         if (status == 0)
1063                 status = usb_suspend_device(udev, msg);
1064
1065         /* If the suspend failed, resume interfaces that did get suspended */
1066         if (status != 0) {
1067                 while (--i >= 0) {
1068                         intf = udev->actconfig->interface[i];
1069                         usb_resume_interface(intf, 0);
1070                 }
1071
1072                 /* Try another autosuspend when the interfaces aren't busy */
1073                 if (udev->auto_pm)
1074                         autosuspend_check(udev, status == -EBUSY);
1075
1076         /* If the suspend succeeded then prevent any more URB submissions,
1077          * flush any outstanding URBs, and propagate the suspend up the tree.
1078          */
1079         } else {
1080                 cancel_delayed_work(&udev->autosuspend);
1081                 udev->can_submit = 0;
1082                 for (i = 0; i < 16; ++i) {
1083                         usb_hcd_flush_endpoint(udev, udev->ep_out[i]);
1084                         usb_hcd_flush_endpoint(udev, udev->ep_in[i]);
1085                 }
1086
1087                 /* If this is just a FREEZE or a PRETHAW, udev might
1088                  * not really be suspended.  Only true suspends get
1089                  * propagated up the device tree.
1090                  */
1091                 if (parent && udev->state == USB_STATE_SUSPENDED)
1092                         usb_autosuspend_device(parent);
1093         }
1094
1095  done:
1096         dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1097         return status;
1098 }
1099
1100 /**
1101  * usb_resume_both - resume a USB device and its interfaces
1102  * @udev: the usb_device to resume
1103  *
1104  * This is the central routine for resuming USB devices.  It calls the
1105  * the resume method for @udev and then calls the resume methods for all
1106  * the interface drivers in @udev.
1107  *
1108  * Before starting the resume, the routine calls itself recursively for
1109  * the parent device of @udev, thereby propagating the change up the device
1110  * tree and assuring that @udev will be able to resume.  If the parent is
1111  * unable to resume successfully, the routine fails.
1112  *
1113  * The resume method calls are subject to mutual exclusion under control
1114  * of @udev's pm_mutex.  Many of these calls are also under the protection
1115  * of @udev's device lock (including all requests originating outside the
1116  * USB subsystem), but autoresume requests generated by a child device or
1117  * interface driver may not be.  Usbcore will insure that the method calls
1118  * do not arrive during bind, unbind, or reset operations.  However, drivers
1119  * must be prepared to handle resume calls arriving at unpredictable times.
1120  * The only way to block such calls is to do an autoresume (preventing
1121  * other autoresumes) while holding @udev's device lock (preventing outside
1122  * resumes).
1123  *
1124  * The caller must hold @udev->pm_mutex.
1125  *
1126  * This routine can run only in process context.
1127  */
1128 static int usb_resume_both(struct usb_device *udev)
1129 {
1130         int                     status = 0;
1131         int                     i;
1132         struct usb_interface    *intf;
1133         struct usb_device       *parent = udev->parent;
1134
1135         cancel_delayed_work(&udev->autosuspend);
1136         if (udev->state == USB_STATE_NOTATTACHED) {
1137                 status = -ENODEV;
1138                 goto done;
1139         }
1140         udev->can_submit = 1;
1141
1142         /* Propagate the resume up the tree, if necessary */
1143         if (udev->state == USB_STATE_SUSPENDED) {
1144                 if (udev->auto_pm && udev->autoresume_disabled) {
1145                         status = -EPERM;
1146                         goto done;
1147                 }
1148                 if (parent) {
1149                         status = usb_autoresume_device(parent);
1150                         if (status == 0) {
1151                                 status = usb_resume_device(udev);
1152                                 if (status || udev->state ==
1153                                                 USB_STATE_NOTATTACHED) {
1154                                         usb_autosuspend_device(parent);
1155
1156                                         /* It's possible usb_resume_device()
1157                                          * failed after the port was
1158                                          * unsuspended, causing udev to be
1159                                          * logically disconnected.  We don't
1160                                          * want usb_disconnect() to autosuspend
1161                                          * the parent again, so tell it that
1162                                          * udev disconnected while still
1163                                          * suspended. */
1164                                         if (udev->state ==
1165                                                         USB_STATE_NOTATTACHED)
1166                                                 udev->discon_suspended = 1;
1167                                 }
1168                         }
1169                 } else {
1170
1171                         /* We can't progagate beyond the USB subsystem,
1172                          * so if a root hub's controller is suspended
1173                          * then we're stuck. */
1174                         status = usb_resume_device(udev);
1175                 }
1176         } else {
1177
1178                 /* Needed for reset-resume */
1179                 status = usb_resume_device(udev);
1180         }
1181
1182         if (status == 0 && udev->actconfig) {
1183                 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1184                         intf = udev->actconfig->interface[i];
1185                         usb_resume_interface(intf, udev->reset_resume);
1186                 }
1187         }
1188
1189  done:
1190         dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1191         if (!status)
1192                 udev->reset_resume = 0;
1193         return status;
1194 }
1195
1196 #ifdef CONFIG_USB_SUSPEND
1197
1198 /* Internal routine to adjust a device's usage counter and change
1199  * its autosuspend state.
1200  */
1201 static int usb_autopm_do_device(struct usb_device *udev, int inc_usage_cnt)
1202 {
1203         int     status = 0;
1204
1205         usb_pm_lock(udev);
1206         udev->auto_pm = 1;
1207         udev->pm_usage_cnt += inc_usage_cnt;
1208         WARN_ON(udev->pm_usage_cnt < 0);
1209         if (inc_usage_cnt)
1210                 udev->last_busy = jiffies;
1211         if (inc_usage_cnt >= 0 && udev->pm_usage_cnt > 0) {
1212                 if (udev->state == USB_STATE_SUSPENDED)
1213                         status = usb_resume_both(udev);
1214                 if (status != 0)
1215                         udev->pm_usage_cnt -= inc_usage_cnt;
1216                 else if (inc_usage_cnt)
1217                         udev->last_busy = jiffies;
1218         } else if (inc_usage_cnt <= 0 && udev->pm_usage_cnt <= 0) {
1219                 status = usb_suspend_both(udev, PMSG_SUSPEND);
1220         }
1221         usb_pm_unlock(udev);
1222         return status;
1223 }
1224
1225 /* usb_autosuspend_work - callback routine to autosuspend a USB device */
1226 void 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
1234 /**
1235  * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
1236  * @udev: the usb_device to autosuspend
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  *
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.
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  */
1254 void usb_autosuspend_device(struct usb_device *udev)
1255 {
1256         int     status;
1257
1258         status = usb_autopm_do_device(udev, -1);
1259         dev_vdbg(&udev->dev, "%s: cnt %d\n",
1260                         __func__, udev->pm_usage_cnt);
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  */
1276 void usb_try_autosuspend_device(struct usb_device *udev)
1277 {
1278         usb_autopm_do_device(udev, 0);
1279         dev_vdbg(&udev->dev, "%s: cnt %d\n",
1280                         __func__, udev->pm_usage_cnt);
1281 }
1282
1283 /**
1284  * usb_autoresume_device - immediately autoresume a USB device and its interfaces
1285  * @udev: the usb_device to autoresume
1286  *
1287  * This routine should be called when a core subsystem wants to use @udev
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.
1293  *
1294  * @udev's usage counter is incremented to prevent subsequent autosuspends.
1295  * However if the autoresume fails then the usage counter is re-decremented.
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  */
1302 int usb_autoresume_device(struct usb_device *udev)
1303 {
1304         int     status;
1305
1306         status = usb_autopm_do_device(udev, 1);
1307         dev_vdbg(&udev->dev, "%s: status %d cnt %d\n",
1308                         __func__, status, udev->pm_usage_cnt);
1309         return status;
1310 }
1311
1312 /* Internal routine to adjust an interface's usage counter and change
1313  * its device's autosuspend state.
1314  */
1315 static 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 {
1325                 udev->auto_pm = 1;
1326                 intf->pm_usage_cnt += inc_usage_cnt;
1327                 udev->last_busy = jiffies;
1328                 if (inc_usage_cnt >= 0 && intf->pm_usage_cnt > 0) {
1329                         if (udev->state == USB_STATE_SUSPENDED)
1330                                 status = usb_resume_both(udev);
1331                         if (status != 0)
1332                                 intf->pm_usage_cnt -= inc_usage_cnt;
1333                         else
1334                                 udev->last_busy = jiffies;
1335                 } else if (inc_usage_cnt <= 0 && intf->pm_usage_cnt <= 0) {
1336                         status = usb_suspend_both(udev, PMSG_SUSPEND);
1337                 }
1338         }
1339         usb_pm_unlock(udev);
1340         return status;
1341 }
1342
1343 /**
1344  * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
1345  * @intf: the usb_interface whose counter should be decremented
1346  *
1347  * This routine should be called by an interface driver when it is
1348  * finished using @intf and wants to allow it to autosuspend.  A typical
1349  * example would be a character-device driver when its device file is
1350  * closed.
1351  *
1352  * The routine decrements @intf's usage counter.  When the counter reaches
1353  * 0, a delayed autosuspend request for @intf's device is queued.  When
1354  * the delay expires, if @intf->pm_usage_cnt is still <= 0 along with all
1355  * the other usage counters for the sibling interfaces and @intf's
1356  * usb_device, the device and all its interfaces will be autosuspended.
1357  *
1358  * Note that @intf->pm_usage_cnt is owned by the interface driver.  The
1359  * core will not change its value other than the increment and decrement
1360  * in usb_autopm_get_interface and usb_autopm_put_interface.  The driver
1361  * may use this simple counter-oriented discipline or may set the value
1362  * any way it likes.
1363  *
1364  * If the driver has set @intf->needs_remote_wakeup then autosuspend will
1365  * take place only if the device's remote-wakeup facility is enabled.
1366  *
1367  * Suspend method calls queued by this routine can arrive at any time
1368  * while @intf is resumed and its usage counter is equal to 0.  They are
1369  * not protected by the usb_device's lock but only by its pm_mutex.
1370  * Drivers must provide their own synchronization.
1371  *
1372  * This routine can run only in process context.
1373  */
1374 void usb_autopm_put_interface(struct usb_interface *intf)
1375 {
1376         int     status;
1377
1378         status = usb_autopm_do_interface(intf, -1);
1379         dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1380                         __func__, status, intf->pm_usage_cnt);
1381 }
1382 EXPORT_SYMBOL_GPL(usb_autopm_put_interface);
1383
1384 /**
1385  * usb_autopm_get_interface - increment a USB interface's PM-usage counter
1386  * @intf: the usb_interface whose counter should be incremented
1387  *
1388  * This routine should be called by an interface driver when it wants to
1389  * use @intf and needs to guarantee that it is not suspended.  In addition,
1390  * the routine prevents @intf from being autosuspended subsequently.  (Note
1391  * that this will not prevent suspend events originating in the PM core.)
1392  * This prevention will persist until usb_autopm_put_interface() is called
1393  * or @intf is unbound.  A typical example would be a character-device
1394  * driver when its device file is opened.
1395  *
1396  *
1397  * The routine increments @intf's usage counter.  (However if the
1398  * autoresume fails then the counter is re-decremented.)  So long as the
1399  * counter is greater than 0, autosuspend will not be allowed for @intf
1400  * or its usb_device.  When the driver is finished using @intf it should
1401  * call usb_autopm_put_interface() to decrement the usage counter and
1402  * queue a delayed autosuspend request (if the counter is <= 0).
1403  *
1404  *
1405  * Note that @intf->pm_usage_cnt is owned by the interface driver.  The
1406  * core will not change its value other than the increment and decrement
1407  * in usb_autopm_get_interface and usb_autopm_put_interface.  The driver
1408  * may use this simple counter-oriented discipline or may set the value
1409  * any way it likes.
1410  *
1411  * Resume method calls generated by this routine can arrive at any time
1412  * while @intf is suspended.  They are not protected by the usb_device's
1413  * lock but only by its pm_mutex.  Drivers must provide their own
1414  * synchronization.
1415  *
1416  * This routine can run only in process context.
1417  */
1418 int usb_autopm_get_interface(struct usb_interface *intf)
1419 {
1420         int     status;
1421
1422         status = usb_autopm_do_interface(intf, 1);
1423         dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1424                         __func__, status, intf->pm_usage_cnt);
1425         return status;
1426 }
1427 EXPORT_SYMBOL_GPL(usb_autopm_get_interface);
1428
1429 /**
1430  * usb_autopm_set_interface - set a USB interface's autosuspend state
1431  * @intf: the usb_interface whose state should be set
1432  *
1433  * This routine sets the autosuspend state of @intf's device according
1434  * to @intf's usage counter, which the caller must have set previously.
1435  * If the counter is <= 0, the device is autosuspended (if it isn't
1436  * already suspended and if nothing else prevents the autosuspend).  If
1437  * the counter is > 0, the device is autoresumed (if it isn't already
1438  * awake).
1439  */
1440 int usb_autopm_set_interface(struct usb_interface *intf)
1441 {
1442         int     status;
1443
1444         status = usb_autopm_do_interface(intf, 0);
1445         dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
1446                         __func__, status, intf->pm_usage_cnt);
1447         return status;
1448 }
1449 EXPORT_SYMBOL_GPL(usb_autopm_set_interface);
1450
1451 #else
1452
1453 void usb_autosuspend_work(struct work_struct *work)
1454 {}
1455
1456 #endif /* CONFIG_USB_SUSPEND */
1457
1458 /**
1459  * usb_external_suspend_device - external suspend of a USB device and its interfaces
1460  * @udev: the usb_device to suspend
1461  * @msg: Power Management message describing this state transition
1462  *
1463  * This routine handles external suspend requests: ones not generated
1464  * internally by a USB driver (autosuspend) but rather coming from the user
1465  * (via sysfs) or the PM core (system sleep).  The suspend will be carried
1466  * out regardless of @udev's usage counter or those of its interfaces,
1467  * and regardless of whether or not remote wakeup is enabled.  Of course,
1468  * interface drivers still have the option of failing the suspend (if
1469  * there are unsuspended children, for example).
1470  *
1471  * The caller must hold @udev's device lock.
1472  */
1473 int usb_external_suspend_device(struct usb_device *udev, pm_message_t msg)
1474 {
1475         int     status;
1476
1477         usb_pm_lock(udev);
1478         udev->auto_pm = 0;
1479         status = usb_suspend_both(udev, msg);
1480         usb_pm_unlock(udev);
1481         return status;
1482 }
1483
1484 /**
1485  * usb_external_resume_device - external resume of a USB device and its interfaces
1486  * @udev: the usb_device to resume
1487  *
1488  * This routine handles external resume requests: ones not generated
1489  * internally by a USB driver (autoresume) but rather coming from the user
1490  * (via sysfs), the PM core (system resume), or the device itself (remote
1491  * wakeup).  @udev's usage counter is unaffected.
1492  *
1493  * The caller must hold @udev's device lock.
1494  */
1495 int usb_external_resume_device(struct usb_device *udev)
1496 {
1497         int     status;
1498
1499         usb_pm_lock(udev);
1500         udev->auto_pm = 0;
1501         status = usb_resume_both(udev);
1502         udev->last_busy = jiffies;
1503         usb_pm_unlock(udev);
1504
1505         /* Now that the device is awake, we can start trying to autosuspend
1506          * it again. */
1507         if (status == 0)
1508                 usb_try_autosuspend_device(udev);
1509         return status;
1510 }
1511
1512 static int usb_suspend(struct device *dev, pm_message_t message)
1513 {
1514         struct usb_device       *udev;
1515
1516         if (!is_usb_device(dev))        /* Ignore PM for interfaces */
1517                 return 0;
1518         udev = to_usb_device(dev);
1519
1520         /* If udev is already suspended, we can skip this suspend and
1521          * we should also skip the upcoming system resume.  High-speed
1522          * root hubs are an exception; they need to resume whenever the
1523          * system wakes up in order for USB-PERSIST port handover to work
1524          * properly.
1525          */
1526         if (udev->state == USB_STATE_SUSPENDED) {
1527                 if (udev->parent || udev->speed != USB_SPEED_HIGH)
1528                         udev->skip_sys_resume = 1;
1529                 return 0;
1530         }
1531
1532         udev->skip_sys_resume = 0;
1533         return usb_external_suspend_device(udev, message);
1534 }
1535
1536 static int usb_resume(struct device *dev)
1537 {
1538         struct usb_device       *udev;
1539
1540         if (!is_usb_device(dev))        /* Ignore PM for interfaces */
1541                 return 0;
1542         udev = to_usb_device(dev);
1543
1544         /* If udev->skip_sys_resume is set then udev was already suspended
1545          * when the system suspend started, so we don't want to resume
1546          * udev during this system wakeup.  However a reset-resume counts
1547          * as a wakeup event, so allow a reset-resume to occur if remote
1548          * wakeup is enabled. */
1549         if (udev->skip_sys_resume) {
1550                 if (!(udev->reset_resume && udev->do_remote_wakeup))
1551                         return -EHOSTUNREACH;
1552         }
1553         return usb_external_resume_device(udev);
1554 }
1555
1556 #else
1557
1558 #define usb_suspend     NULL
1559 #define usb_resume      NULL
1560
1561 #endif /* CONFIG_PM */
1562
1563 struct bus_type usb_bus_type = {
1564         .name =         "usb",
1565         .match =        usb_device_match,
1566         .uevent =       usb_uevent,
1567         .suspend =      usb_suspend,
1568         .resume =       usb_resume,
1569 };