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