Merge branches 'x86-alternatives-for-linus', 'x86-fpu-for-linus', 'x86-hwmon-for...
[pandora-kernel.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/slab.h>
27 #include <linux/usb.h>
28 #include <linux/usb/quirks.h>
29 #include <linux/usb/hcd.h>
30 #include <linux/pm_runtime.h>
31
32 #include "usb.h"
33
34
35 #ifdef CONFIG_HOTPLUG
36
37 /*
38  * Adds a new dynamic USBdevice ID to this driver,
39  * and cause the driver to probe for all devices again.
40  */
41 ssize_t usb_store_new_id(struct usb_dynids *dynids,
42                          struct device_driver *driver,
43                          const char *buf, size_t count)
44 {
45         struct usb_dynid *dynid;
46         u32 idVendor = 0;
47         u32 idProduct = 0;
48         int fields = 0;
49         int retval = 0;
50
51         fields = sscanf(buf, "%x %x", &idVendor, &idProduct);
52         if (fields < 2)
53                 return -EINVAL;
54
55         dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
56         if (!dynid)
57                 return -ENOMEM;
58
59         INIT_LIST_HEAD(&dynid->node);
60         dynid->id.idVendor = idVendor;
61         dynid->id.idProduct = idProduct;
62         dynid->id.match_flags = USB_DEVICE_ID_MATCH_DEVICE;
63
64         spin_lock(&dynids->lock);
65         list_add_tail(&dynid->node, &dynids->list);
66         spin_unlock(&dynids->lock);
67
68         if (get_driver(driver)) {
69                 retval = driver_attach(driver);
70                 put_driver(driver);
71         }
72
73         if (retval)
74                 return retval;
75         return count;
76 }
77 EXPORT_SYMBOL_GPL(usb_store_new_id);
78
79 static ssize_t store_new_id(struct device_driver *driver,
80                             const char *buf, size_t count)
81 {
82         struct usb_driver *usb_drv = to_usb_driver(driver);
83
84         return usb_store_new_id(&usb_drv->dynids, driver, buf, count);
85 }
86 static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
87
88 /**
89  * store_remove_id - remove a USB device ID from this driver
90  * @driver: target device driver
91  * @buf: buffer for scanning device ID data
92  * @count: input size
93  *
94  * Removes a dynamic usb device ID from this driver.
95  */
96 static ssize_t
97 store_remove_id(struct device_driver *driver, const char *buf, size_t count)
98 {
99         struct usb_dynid *dynid, *n;
100         struct usb_driver *usb_driver = to_usb_driver(driver);
101         u32 idVendor = 0;
102         u32 idProduct = 0;
103         int fields = 0;
104         int retval = 0;
105
106         fields = sscanf(buf, "%x %x", &idVendor, &idProduct);
107         if (fields < 2)
108                 return -EINVAL;
109
110         spin_lock(&usb_driver->dynids.lock);
111         list_for_each_entry_safe(dynid, n, &usb_driver->dynids.list, node) {
112                 struct usb_device_id *id = &dynid->id;
113                 if ((id->idVendor == idVendor) &&
114                     (id->idProduct == idProduct)) {
115                         list_del(&dynid->node);
116                         kfree(dynid);
117                         retval = 0;
118                         break;
119                 }
120         }
121         spin_unlock(&usb_driver->dynids.lock);
122
123         if (retval)
124                 return retval;
125         return count;
126 }
127 static DRIVER_ATTR(remove_id, S_IWUSR, NULL, store_remove_id);
128
129 static int usb_create_newid_file(struct usb_driver *usb_drv)
130 {
131         int error = 0;
132
133         if (usb_drv->no_dynamic_id)
134                 goto exit;
135
136         if (usb_drv->probe != NULL)
137                 error = driver_create_file(&usb_drv->drvwrap.driver,
138                                            &driver_attr_new_id);
139 exit:
140         return error;
141 }
142
143 static void usb_remove_newid_file(struct usb_driver *usb_drv)
144 {
145         if (usb_drv->no_dynamic_id)
146                 return;
147
148         if (usb_drv->probe != NULL)
149                 driver_remove_file(&usb_drv->drvwrap.driver,
150                                    &driver_attr_new_id);
151 }
152
153 static int
154 usb_create_removeid_file(struct usb_driver *drv)
155 {
156         int error = 0;
157         if (drv->probe != NULL)
158                 error = driver_create_file(&drv->drvwrap.driver,
159                                 &driver_attr_remove_id);
160         return error;
161 }
162
163 static void usb_remove_removeid_file(struct usb_driver *drv)
164 {
165         driver_remove_file(&drv->drvwrap.driver, &driver_attr_remove_id);
166 }
167
168 static void usb_free_dynids(struct usb_driver *usb_drv)
169 {
170         struct usb_dynid *dynid, *n;
171
172         spin_lock(&usb_drv->dynids.lock);
173         list_for_each_entry_safe(dynid, n, &usb_drv->dynids.list, node) {
174                 list_del(&dynid->node);
175                 kfree(dynid);
176         }
177         spin_unlock(&usb_drv->dynids.lock);
178 }
179 #else
180 static inline int usb_create_newid_file(struct usb_driver *usb_drv)
181 {
182         return 0;
183 }
184
185 static void usb_remove_newid_file(struct usb_driver *usb_drv)
186 {
187 }
188
189 static int
190 usb_create_removeid_file(struct usb_driver *drv)
191 {
192         return 0;
193 }
194
195 static void usb_remove_removeid_file(struct usb_driver *drv)
196 {
197 }
198
199 static inline void usb_free_dynids(struct usb_driver *usb_drv)
200 {
201 }
202 #endif
203
204 static const struct usb_device_id *usb_match_dynamic_id(struct usb_interface *intf,
205                                                         struct usb_driver *drv)
206 {
207         struct usb_dynid *dynid;
208
209         spin_lock(&drv->dynids.lock);
210         list_for_each_entry(dynid, &drv->dynids.list, node) {
211                 if (usb_match_one_id(intf, &dynid->id)) {
212                         spin_unlock(&drv->dynids.lock);
213                         return &dynid->id;
214                 }
215         }
216         spin_unlock(&drv->dynids.lock);
217         return NULL;
218 }
219
220
221 /* called from driver core with dev locked */
222 static int usb_probe_device(struct device *dev)
223 {
224         struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
225         struct usb_device *udev = to_usb_device(dev);
226         int error = 0;
227
228         dev_dbg(dev, "%s\n", __func__);
229
230         /* TODO: Add real matching code */
231
232         /* The device should always appear to be in use
233          * unless the driver suports autosuspend.
234          */
235         if (!udriver->supports_autosuspend)
236                 error = usb_autoresume_device(udev);
237
238         if (!error)
239                 error = udriver->probe(udev);
240         return error;
241 }
242
243 /* called from driver core with dev locked */
244 static int usb_unbind_device(struct device *dev)
245 {
246         struct usb_device *udev = to_usb_device(dev);
247         struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
248
249         udriver->disconnect(udev);
250         if (!udriver->supports_autosuspend)
251                 usb_autosuspend_device(udev);
252         return 0;
253 }
254
255 /*
256  * Cancel any pending scheduled resets
257  *
258  * [see usb_queue_reset_device()]
259  *
260  * Called after unconfiguring / when releasing interfaces. See
261  * comments in __usb_queue_reset_device() regarding
262  * udev->reset_running.
263  */
264 static void usb_cancel_queued_reset(struct usb_interface *iface)
265 {
266         if (iface->reset_running == 0)
267                 cancel_work_sync(&iface->reset_ws);
268 }
269
270 /* called from driver core with dev locked */
271 static int usb_probe_interface(struct device *dev)
272 {
273         struct usb_driver *driver = to_usb_driver(dev->driver);
274         struct usb_interface *intf = to_usb_interface(dev);
275         struct usb_device *udev = interface_to_usbdev(intf);
276         const struct usb_device_id *id;
277         int error = -ENODEV;
278
279         dev_dbg(dev, "%s\n", __func__);
280
281         intf->needs_binding = 0;
282
283         if (usb_device_is_owned(udev))
284                 return error;
285
286         if (udev->authorized == 0) {
287                 dev_err(&intf->dev, "Device is not authorized for usage\n");
288                 return error;
289         }
290
291         id = usb_match_id(intf, driver->id_table);
292         if (!id)
293                 id = usb_match_dynamic_id(intf, driver);
294         if (!id)
295                 return error;
296
297         dev_dbg(dev, "%s - got id\n", __func__);
298
299         error = usb_autoresume_device(udev);
300         if (error)
301                 return error;
302
303         intf->condition = USB_INTERFACE_BINDING;
304
305         /* Probed interfaces are initially active.  They are
306          * runtime-PM-enabled only if the driver has autosuspend support.
307          * They are sensitive to their children's power states.
308          */
309         pm_runtime_set_active(dev);
310         pm_suspend_ignore_children(dev, false);
311         if (driver->supports_autosuspend)
312                 pm_runtime_enable(dev);
313
314         /* Carry out a deferred switch to altsetting 0 */
315         if (intf->needs_altsetting0) {
316                 error = usb_set_interface(udev, intf->altsetting[0].
317                                 desc.bInterfaceNumber, 0);
318                 if (error < 0)
319                         goto err;
320                 intf->needs_altsetting0 = 0;
321         }
322
323         error = driver->probe(intf, id);
324         if (error)
325                 goto err;
326
327         intf->condition = USB_INTERFACE_BOUND;
328         usb_autosuspend_device(udev);
329         return error;
330
331  err:
332         intf->needs_remote_wakeup = 0;
333         intf->condition = USB_INTERFACE_UNBOUND;
334         usb_cancel_queued_reset(intf);
335
336         /* Unbound interfaces are always runtime-PM-disabled and -suspended */
337         if (driver->supports_autosuspend)
338                 pm_runtime_disable(dev);
339         pm_runtime_set_suspended(dev);
340
341         usb_autosuspend_device(udev);
342         return error;
343 }
344
345 /* called from driver core with dev locked */
346 static int usb_unbind_interface(struct device *dev)
347 {
348         struct usb_driver *driver = to_usb_driver(dev->driver);
349         struct usb_interface *intf = to_usb_interface(dev);
350         struct usb_device *udev;
351         int error, r;
352
353         intf->condition = USB_INTERFACE_UNBINDING;
354
355         /* Autoresume for set_interface call below */
356         udev = interface_to_usbdev(intf);
357         error = usb_autoresume_device(udev);
358
359         /* Terminate all URBs for this interface unless the driver
360          * supports "soft" unbinding.
361          */
362         if (!driver->soft_unbind)
363                 usb_disable_interface(udev, intf, false);
364
365         driver->disconnect(intf);
366         usb_cancel_queued_reset(intf);
367
368         /* Reset other interface state.
369          * We cannot do a Set-Interface if the device is suspended or
370          * if it is prepared for a system sleep (since installing a new
371          * altsetting means creating new endpoint device entries).
372          * When either of these happens, defer the Set-Interface.
373          */
374         if (intf->cur_altsetting->desc.bAlternateSetting == 0) {
375                 /* Already in altsetting 0 so skip Set-Interface.
376                  * Just re-enable it without affecting the endpoint toggles.
377                  */
378                 usb_enable_interface(udev, intf, false);
379         } else if (!error && intf->dev.power.status == DPM_ON) {
380                 r = usb_set_interface(udev, intf->altsetting[0].
381                                 desc.bInterfaceNumber, 0);
382                 if (r < 0)
383                         intf->needs_altsetting0 = 1;
384         } else {
385                 intf->needs_altsetting0 = 1;
386         }
387         usb_set_intfdata(intf, NULL);
388
389         intf->condition = USB_INTERFACE_UNBOUND;
390         intf->needs_remote_wakeup = 0;
391
392         /* Unbound interfaces are always runtime-PM-disabled and -suspended */
393         if (driver->supports_autosuspend)
394                 pm_runtime_disable(dev);
395         pm_runtime_set_suspended(dev);
396
397         /* Undo any residual pm_autopm_get_interface_* calls */
398         for (r = atomic_read(&intf->pm_usage_cnt); r > 0; --r)
399                 usb_autopm_put_interface_no_suspend(intf);
400         atomic_set(&intf->pm_usage_cnt, 0);
401
402         if (!error)
403                 usb_autosuspend_device(udev);
404
405         return 0;
406 }
407
408 /**
409  * usb_driver_claim_interface - bind a driver to an interface
410  * @driver: the driver to be bound
411  * @iface: the interface to which it will be bound; must be in the
412  *      usb device's active configuration
413  * @priv: driver data associated with that interface
414  *
415  * This is used by usb device drivers that need to claim more than one
416  * interface on a device when probing (audio and acm are current examples).
417  * No device driver should directly modify internal usb_interface or
418  * usb_device structure members.
419  *
420  * Few drivers should need to use this routine, since the most natural
421  * way to bind to an interface is to return the private data from
422  * the driver's probe() method.
423  *
424  * Callers must own the device lock, so driver probe() entries don't need
425  * extra locking, but other call contexts may need to explicitly claim that
426  * lock.
427  */
428 int usb_driver_claim_interface(struct usb_driver *driver,
429                                 struct usb_interface *iface, void *priv)
430 {
431         struct device *dev = &iface->dev;
432         int retval = 0;
433
434         if (dev->driver)
435                 return -EBUSY;
436
437         dev->driver = &driver->drvwrap.driver;
438         usb_set_intfdata(iface, priv);
439         iface->needs_binding = 0;
440
441         iface->condition = USB_INTERFACE_BOUND;
442
443         /* Claimed interfaces are initially inactive (suspended) and
444          * runtime-PM-enabled, but only if the driver has autosuspend
445          * support.  Otherwise they are marked active, to prevent the
446          * device from being autosuspended, but left disabled.  In either
447          * case they are sensitive to their children's power states.
448          */
449         pm_suspend_ignore_children(dev, false);
450         if (driver->supports_autosuspend)
451                 pm_runtime_enable(dev);
452         else
453                 pm_runtime_set_active(dev);
454
455         /* if interface was already added, bind now; else let
456          * the future device_add() bind it, bypassing probe()
457          */
458         if (device_is_registered(dev))
459                 retval = device_bind_driver(dev);
460
461         return retval;
462 }
463 EXPORT_SYMBOL_GPL(usb_driver_claim_interface);
464
465 /**
466  * usb_driver_release_interface - unbind a driver from an interface
467  * @driver: the driver to be unbound
468  * @iface: the interface from which it will be unbound
469  *
470  * This can be used by drivers to release an interface without waiting
471  * for their disconnect() methods to be called.  In typical cases this
472  * also causes the driver disconnect() method to be called.
473  *
474  * This call is synchronous, and may not be used in an interrupt context.
475  * Callers must own the device lock, so driver disconnect() entries don't
476  * need extra locking, but other call contexts may need to explicitly claim
477  * that lock.
478  */
479 void usb_driver_release_interface(struct usb_driver *driver,
480                                         struct usb_interface *iface)
481 {
482         struct device *dev = &iface->dev;
483
484         /* this should never happen, don't release something that's not ours */
485         if (!dev->driver || dev->driver != &driver->drvwrap.driver)
486                 return;
487
488         /* don't release from within disconnect() */
489         if (iface->condition != USB_INTERFACE_BOUND)
490                 return;
491         iface->condition = USB_INTERFACE_UNBINDING;
492
493         /* Release via the driver core only if the interface
494          * has already been registered
495          */
496         if (device_is_registered(dev)) {
497                 device_release_driver(dev);
498         } else {
499                 device_lock(dev);
500                 usb_unbind_interface(dev);
501                 dev->driver = NULL;
502                 device_unlock(dev);
503         }
504 }
505 EXPORT_SYMBOL_GPL(usb_driver_release_interface);
506
507 /* returns 0 if no match, 1 if match */
508 int usb_match_device(struct usb_device *dev, const struct usb_device_id *id)
509 {
510         if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
511             id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
512                 return 0;
513
514         if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
515             id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
516                 return 0;
517
518         /* No need to test id->bcdDevice_lo != 0, since 0 is never
519            greater than any unsigned number. */
520         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
521             (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice)))
522                 return 0;
523
524         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
525             (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
526                 return 0;
527
528         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
529             (id->bDeviceClass != dev->descriptor.bDeviceClass))
530                 return 0;
531
532         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
533             (id->bDeviceSubClass != dev->descriptor.bDeviceSubClass))
534                 return 0;
535
536         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
537             (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
538                 return 0;
539
540         return 1;
541 }
542
543 /* returns 0 if no match, 1 if match */
544 int usb_match_one_id(struct usb_interface *interface,
545                      const struct usb_device_id *id)
546 {
547         struct usb_host_interface *intf;
548         struct usb_device *dev;
549
550         /* proc_connectinfo in devio.c may call us with id == NULL. */
551         if (id == NULL)
552                 return 0;
553
554         intf = interface->cur_altsetting;
555         dev = interface_to_usbdev(interface);
556
557         if (!usb_match_device(dev, id))
558                 return 0;
559
560         /* The interface class, subclass, and protocol should never be
561          * checked for a match if the device class is Vendor Specific,
562          * unless the match record specifies the Vendor ID. */
563         if (dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC &&
564                         !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
565                         (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
566                                 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
567                                 USB_DEVICE_ID_MATCH_INT_PROTOCOL)))
568                 return 0;
569
570         if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
571             (id->bInterfaceClass != intf->desc.bInterfaceClass))
572                 return 0;
573
574         if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
575             (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
576                 return 0;
577
578         if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
579             (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
580                 return 0;
581
582         return 1;
583 }
584 EXPORT_SYMBOL_GPL(usb_match_one_id);
585
586 /**
587  * usb_match_id - find first usb_device_id matching device or interface
588  * @interface: the interface of interest
589  * @id: array of usb_device_id structures, terminated by zero entry
590  *
591  * usb_match_id searches an array of usb_device_id's and returns
592  * the first one matching the device or interface, or null.
593  * This is used when binding (or rebinding) a driver to an interface.
594  * Most USB device drivers will use this indirectly, through the usb core,
595  * but some layered driver frameworks use it directly.
596  * These device tables are exported with MODULE_DEVICE_TABLE, through
597  * modutils, to support the driver loading functionality of USB hotplugging.
598  *
599  * What Matches:
600  *
601  * The "match_flags" element in a usb_device_id controls which
602  * members are used.  If the corresponding bit is set, the
603  * value in the device_id must match its corresponding member
604  * in the device or interface descriptor, or else the device_id
605  * does not match.
606  *
607  * "driver_info" is normally used only by device drivers,
608  * but you can create a wildcard "matches anything" usb_device_id
609  * as a driver's "modules.usbmap" entry if you provide an id with
610  * only a nonzero "driver_info" field.  If you do this, the USB device
611  * driver's probe() routine should use additional intelligence to
612  * decide whether to bind to the specified interface.
613  *
614  * What Makes Good usb_device_id Tables:
615  *
616  * The match algorithm is very simple, so that intelligence in
617  * driver selection must come from smart driver id records.
618  * Unless you have good reasons to use another selection policy,
619  * provide match elements only in related groups, and order match
620  * specifiers from specific to general.  Use the macros provided
621  * for that purpose if you can.
622  *
623  * The most specific match specifiers use device descriptor
624  * data.  These are commonly used with product-specific matches;
625  * the USB_DEVICE macro lets you provide vendor and product IDs,
626  * and you can also match against ranges of product revisions.
627  * These are widely used for devices with application or vendor
628  * specific bDeviceClass values.
629  *
630  * Matches based on device class/subclass/protocol specifications
631  * are slightly more general; use the USB_DEVICE_INFO macro, or
632  * its siblings.  These are used with single-function devices
633  * where bDeviceClass doesn't specify that each interface has
634  * its own class.
635  *
636  * Matches based on interface class/subclass/protocol are the
637  * most general; they let drivers bind to any interface on a
638  * multiple-function device.  Use the USB_INTERFACE_INFO
639  * macro, or its siblings, to match class-per-interface style
640  * devices (as recorded in bInterfaceClass).
641  *
642  * Note that an entry created by USB_INTERFACE_INFO won't match
643  * any interface if the device class is set to Vendor-Specific.
644  * This is deliberate; according to the USB spec the meanings of
645  * the interface class/subclass/protocol for these devices are also
646  * vendor-specific, and hence matching against a standard product
647  * class wouldn't work anyway.  If you really want to use an
648  * interface-based match for such a device, create a match record
649  * that also specifies the vendor ID.  (Unforunately there isn't a
650  * standard macro for creating records like this.)
651  *
652  * Within those groups, remember that not all combinations are
653  * meaningful.  For example, don't give a product version range
654  * without vendor and product IDs; or specify a protocol without
655  * its associated class and subclass.
656  */
657 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
658                                          const struct usb_device_id *id)
659 {
660         /* proc_connectinfo in devio.c may call us with id == NULL. */
661         if (id == NULL)
662                 return NULL;
663
664         /* It is important to check that id->driver_info is nonzero,
665            since an entry that is all zeroes except for a nonzero
666            id->driver_info is the way to create an entry that
667            indicates that the driver want to examine every
668            device and interface. */
669         for (; id->idVendor || id->idProduct || id->bDeviceClass ||
670                id->bInterfaceClass || id->driver_info; id++) {
671                 if (usb_match_one_id(interface, id))
672                         return id;
673         }
674
675         return NULL;
676 }
677 EXPORT_SYMBOL_GPL(usb_match_id);
678
679 static int usb_device_match(struct device *dev, struct device_driver *drv)
680 {
681         /* devices and interfaces are handled separately */
682         if (is_usb_device(dev)) {
683
684                 /* interface drivers never match devices */
685                 if (!is_usb_device_driver(drv))
686                         return 0;
687
688                 /* TODO: Add real matching code */
689                 return 1;
690
691         } else if (is_usb_interface(dev)) {
692                 struct usb_interface *intf;
693                 struct usb_driver *usb_drv;
694                 const struct usb_device_id *id;
695
696                 /* device drivers never match interfaces */
697                 if (is_usb_device_driver(drv))
698                         return 0;
699
700                 intf = to_usb_interface(dev);
701                 usb_drv = to_usb_driver(drv);
702
703                 id = usb_match_id(intf, usb_drv->id_table);
704                 if (id)
705                         return 1;
706
707                 id = usb_match_dynamic_id(intf, usb_drv);
708                 if (id)
709                         return 1;
710         }
711
712         return 0;
713 }
714
715 #ifdef  CONFIG_HOTPLUG
716 static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
717 {
718         struct usb_device *usb_dev;
719
720         if (is_usb_device(dev)) {
721                 usb_dev = to_usb_device(dev);
722         } else if (is_usb_interface(dev)) {
723                 struct usb_interface *intf = to_usb_interface(dev);
724
725                 usb_dev = interface_to_usbdev(intf);
726         } else {
727                 return 0;
728         }
729
730         if (usb_dev->devnum < 0) {
731                 /* driver is often null here; dev_dbg() would oops */
732                 pr_debug("usb %s: already deleted?\n", dev_name(dev));
733                 return -ENODEV;
734         }
735         if (!usb_dev->bus) {
736                 pr_debug("usb %s: bus removed?\n", dev_name(dev));
737                 return -ENODEV;
738         }
739
740 #ifdef  CONFIG_USB_DEVICEFS
741         /* If this is available, userspace programs can directly read
742          * all the device descriptors we don't tell them about.  Or
743          * act as usermode drivers.
744          */
745         if (add_uevent_var(env, "DEVICE=/proc/bus/usb/%03d/%03d",
746                            usb_dev->bus->busnum, usb_dev->devnum))
747                 return -ENOMEM;
748 #endif
749
750         /* per-device configurations are common */
751         if (add_uevent_var(env, "PRODUCT=%x/%x/%x",
752                            le16_to_cpu(usb_dev->descriptor.idVendor),
753                            le16_to_cpu(usb_dev->descriptor.idProduct),
754                            le16_to_cpu(usb_dev->descriptor.bcdDevice)))
755                 return -ENOMEM;
756
757         /* class-based driver binding models */
758         if (add_uevent_var(env, "TYPE=%d/%d/%d",
759                            usb_dev->descriptor.bDeviceClass,
760                            usb_dev->descriptor.bDeviceSubClass,
761                            usb_dev->descriptor.bDeviceProtocol))
762                 return -ENOMEM;
763
764         return 0;
765 }
766
767 #else
768
769 static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
770 {
771         return -ENODEV;
772 }
773 #endif  /* CONFIG_HOTPLUG */
774
775 /**
776  * usb_register_device_driver - register a USB device (not interface) driver
777  * @new_udriver: USB operations for the device driver
778  * @owner: module owner of this driver.
779  *
780  * Registers a USB device driver with the USB core.  The list of
781  * unattached devices will be rescanned whenever a new driver is
782  * added, allowing the new driver to attach to any recognized devices.
783  * Returns a negative error code on failure and 0 on success.
784  */
785 int usb_register_device_driver(struct usb_device_driver *new_udriver,
786                 struct module *owner)
787 {
788         int retval = 0;
789
790         if (usb_disabled())
791                 return -ENODEV;
792
793         new_udriver->drvwrap.for_devices = 1;
794         new_udriver->drvwrap.driver.name = (char *) new_udriver->name;
795         new_udriver->drvwrap.driver.bus = &usb_bus_type;
796         new_udriver->drvwrap.driver.probe = usb_probe_device;
797         new_udriver->drvwrap.driver.remove = usb_unbind_device;
798         new_udriver->drvwrap.driver.owner = owner;
799
800         retval = driver_register(&new_udriver->drvwrap.driver);
801
802         if (!retval) {
803                 pr_info("%s: registered new device driver %s\n",
804                         usbcore_name, new_udriver->name);
805                 usbfs_update_special();
806         } else {
807                 printk(KERN_ERR "%s: error %d registering device "
808                         "       driver %s\n",
809                         usbcore_name, retval, new_udriver->name);
810         }
811
812         return retval;
813 }
814 EXPORT_SYMBOL_GPL(usb_register_device_driver);
815
816 /**
817  * usb_deregister_device_driver - unregister a USB device (not interface) driver
818  * @udriver: USB operations of the device driver to unregister
819  * Context: must be able to sleep
820  *
821  * Unlinks the specified driver from the internal USB driver list.
822  */
823 void usb_deregister_device_driver(struct usb_device_driver *udriver)
824 {
825         pr_info("%s: deregistering device driver %s\n",
826                         usbcore_name, udriver->name);
827
828         driver_unregister(&udriver->drvwrap.driver);
829         usbfs_update_special();
830 }
831 EXPORT_SYMBOL_GPL(usb_deregister_device_driver);
832
833 /**
834  * usb_register_driver - register a USB interface driver
835  * @new_driver: USB operations for the interface driver
836  * @owner: module owner of this driver.
837  * @mod_name: module name string
838  *
839  * Registers a USB interface driver with the USB core.  The list of
840  * unattached interfaces will be rescanned whenever a new driver is
841  * added, allowing the new driver to attach to any recognized interfaces.
842  * Returns a negative error code on failure and 0 on success.
843  *
844  * NOTE: if you want your driver to use the USB major number, you must call
845  * usb_register_dev() to enable that functionality.  This function no longer
846  * takes care of that.
847  */
848 int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
849                         const char *mod_name)
850 {
851         int retval = 0;
852
853         if (usb_disabled())
854                 return -ENODEV;
855
856         new_driver->drvwrap.for_devices = 0;
857         new_driver->drvwrap.driver.name = (char *) new_driver->name;
858         new_driver->drvwrap.driver.bus = &usb_bus_type;
859         new_driver->drvwrap.driver.probe = usb_probe_interface;
860         new_driver->drvwrap.driver.remove = usb_unbind_interface;
861         new_driver->drvwrap.driver.owner = owner;
862         new_driver->drvwrap.driver.mod_name = mod_name;
863         spin_lock_init(&new_driver->dynids.lock);
864         INIT_LIST_HEAD(&new_driver->dynids.list);
865
866         retval = driver_register(&new_driver->drvwrap.driver);
867         if (retval)
868                 goto out;
869
870         usbfs_update_special();
871
872         retval = usb_create_newid_file(new_driver);
873         if (retval)
874                 goto out_newid;
875
876         retval = usb_create_removeid_file(new_driver);
877         if (retval)
878                 goto out_removeid;
879
880         pr_info("%s: registered new interface driver %s\n",
881                         usbcore_name, new_driver->name);
882
883 out:
884         return retval;
885
886 out_removeid:
887         usb_remove_newid_file(new_driver);
888 out_newid:
889         driver_unregister(&new_driver->drvwrap.driver);
890
891         printk(KERN_ERR "%s: error %d registering interface "
892                         "       driver %s\n",
893                         usbcore_name, retval, new_driver->name);
894         goto out;
895 }
896 EXPORT_SYMBOL_GPL(usb_register_driver);
897
898 /**
899  * usb_deregister - unregister a USB interface driver
900  * @driver: USB operations of the interface driver to unregister
901  * Context: must be able to sleep
902  *
903  * Unlinks the specified driver from the internal USB driver list.
904  *
905  * NOTE: If you called usb_register_dev(), you still need to call
906  * usb_deregister_dev() to clean up your driver's allocated minor numbers,
907  * this * call will no longer do it for you.
908  */
909 void usb_deregister(struct usb_driver *driver)
910 {
911         pr_info("%s: deregistering interface driver %s\n",
912                         usbcore_name, driver->name);
913
914         usb_remove_removeid_file(driver);
915         usb_remove_newid_file(driver);
916         usb_free_dynids(driver);
917         driver_unregister(&driver->drvwrap.driver);
918
919         usbfs_update_special();
920 }
921 EXPORT_SYMBOL_GPL(usb_deregister);
922
923 /* Forced unbinding of a USB interface driver, either because
924  * it doesn't support pre_reset/post_reset/reset_resume or
925  * because it doesn't support suspend/resume.
926  *
927  * The caller must hold @intf's device's lock, but not its pm_mutex
928  * and not @intf->dev.sem.
929  */
930 void usb_forced_unbind_intf(struct usb_interface *intf)
931 {
932         struct usb_driver *driver = to_usb_driver(intf->dev.driver);
933
934         dev_dbg(&intf->dev, "forced unbind\n");
935         usb_driver_release_interface(driver, intf);
936
937         /* Mark the interface for later rebinding */
938         intf->needs_binding = 1;
939 }
940
941 /* Delayed forced unbinding of a USB interface driver and scan
942  * for rebinding.
943  *
944  * The caller must hold @intf's device's lock, but not its pm_mutex
945  * and not @intf->dev.sem.
946  *
947  * Note: Rebinds will be skipped if a system sleep transition is in
948  * progress and the PM "complete" callback hasn't occurred yet.
949  */
950 void usb_rebind_intf(struct usb_interface *intf)
951 {
952         int rc;
953
954         /* Delayed unbind of an existing driver */
955         if (intf->dev.driver) {
956                 struct usb_driver *driver =
957                                 to_usb_driver(intf->dev.driver);
958
959                 dev_dbg(&intf->dev, "forced unbind\n");
960                 usb_driver_release_interface(driver, intf);
961         }
962
963         /* Try to rebind the interface */
964         if (intf->dev.power.status == DPM_ON) {
965                 intf->needs_binding = 0;
966                 rc = device_attach(&intf->dev);
967                 if (rc < 0)
968                         dev_warn(&intf->dev, "rebind failed: %d\n", rc);
969         }
970 }
971
972 #ifdef CONFIG_PM
973
974 #define DO_UNBIND       0
975 #define DO_REBIND       1
976
977 /* Unbind drivers for @udev's interfaces that don't support suspend/resume,
978  * or rebind interfaces that have been unbound, according to @action.
979  *
980  * The caller must hold @udev's device lock.
981  */
982 static void do_unbind_rebind(struct usb_device *udev, int action)
983 {
984         struct usb_host_config  *config;
985         int                     i;
986         struct usb_interface    *intf;
987         struct usb_driver       *drv;
988
989         config = udev->actconfig;
990         if (config) {
991                 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
992                         intf = config->interface[i];
993                         switch (action) {
994                         case DO_UNBIND:
995                                 if (intf->dev.driver) {
996                                         drv = to_usb_driver(intf->dev.driver);
997                                         if (!drv->suspend || !drv->resume)
998                                                 usb_forced_unbind_intf(intf);
999                                 }
1000                                 break;
1001                         case DO_REBIND:
1002                                 if (intf->needs_binding)
1003                                         usb_rebind_intf(intf);
1004                                 break;
1005                         }
1006                 }
1007         }
1008 }
1009
1010 static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
1011 {
1012         struct usb_device_driver        *udriver;
1013         int                             status = 0;
1014
1015         if (udev->state == USB_STATE_NOTATTACHED ||
1016                         udev->state == USB_STATE_SUSPENDED)
1017                 goto done;
1018
1019         /* For devices that don't have a driver, we do a generic suspend. */
1020         if (udev->dev.driver)
1021                 udriver = to_usb_device_driver(udev->dev.driver);
1022         else {
1023                 udev->do_remote_wakeup = 0;
1024                 udriver = &usb_generic_driver;
1025         }
1026         status = udriver->suspend(udev, msg);
1027
1028  done:
1029         dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1030         return status;
1031 }
1032
1033 static int usb_resume_device(struct usb_device *udev, pm_message_t msg)
1034 {
1035         struct usb_device_driver        *udriver;
1036         int                             status = 0;
1037
1038         if (udev->state == USB_STATE_NOTATTACHED)
1039                 goto done;
1040
1041         /* Can't resume it if it doesn't have a driver. */
1042         if (udev->dev.driver == NULL) {
1043                 status = -ENOTCONN;
1044                 goto done;
1045         }
1046
1047         /* Non-root devices on a full/low-speed bus must wait for their
1048          * companion high-speed root hub, in case a handoff is needed.
1049          */
1050         if (!(msg.event & PM_EVENT_AUTO) && udev->parent &&
1051                         udev->bus->hs_companion)
1052                 device_pm_wait_for_dev(&udev->dev,
1053                                 &udev->bus->hs_companion->root_hub->dev);
1054
1055         if (udev->quirks & USB_QUIRK_RESET_RESUME)
1056                 udev->reset_resume = 1;
1057
1058         udriver = to_usb_device_driver(udev->dev.driver);
1059         status = udriver->resume(udev, msg);
1060
1061  done:
1062         dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1063         return status;
1064 }
1065
1066 static int usb_suspend_interface(struct usb_device *udev,
1067                 struct usb_interface *intf, pm_message_t msg)
1068 {
1069         struct usb_driver       *driver;
1070         int                     status = 0;
1071
1072         if (udev->state == USB_STATE_NOTATTACHED ||
1073                         intf->condition == USB_INTERFACE_UNBOUND)
1074                 goto done;
1075         driver = to_usb_driver(intf->dev.driver);
1076
1077         if (driver->suspend) {
1078                 status = driver->suspend(intf, msg);
1079                 if (status && !(msg.event & PM_EVENT_AUTO))
1080                         dev_err(&intf->dev, "%s error %d\n",
1081                                         "suspend", status);
1082         } else {
1083                 /* Later we will unbind the driver and reprobe */
1084                 intf->needs_binding = 1;
1085                 dev_warn(&intf->dev, "no %s for driver %s?\n",
1086                                 "suspend", driver->name);
1087         }
1088
1089  done:
1090         dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
1091         return status;
1092 }
1093
1094 static int usb_resume_interface(struct usb_device *udev,
1095                 struct usb_interface *intf, pm_message_t msg, int reset_resume)
1096 {
1097         struct usb_driver       *driver;
1098         int                     status = 0;
1099
1100         if (udev->state == USB_STATE_NOTATTACHED)
1101                 goto done;
1102
1103         /* Don't let autoresume interfere with unbinding */
1104         if (intf->condition == USB_INTERFACE_UNBINDING)
1105                 goto done;
1106
1107         /* Can't resume it if it doesn't have a driver. */
1108         if (intf->condition == USB_INTERFACE_UNBOUND) {
1109
1110                 /* Carry out a deferred switch to altsetting 0 */
1111                 if (intf->needs_altsetting0 &&
1112                                 intf->dev.power.status == DPM_ON) {
1113                         usb_set_interface(udev, intf->altsetting[0].
1114                                         desc.bInterfaceNumber, 0);
1115                         intf->needs_altsetting0 = 0;
1116                 }
1117                 goto done;
1118         }
1119
1120         /* Don't resume if the interface is marked for rebinding */
1121         if (intf->needs_binding)
1122                 goto done;
1123         driver = to_usb_driver(intf->dev.driver);
1124
1125         if (reset_resume) {
1126                 if (driver->reset_resume) {
1127                         status = driver->reset_resume(intf);
1128                         if (status)
1129                                 dev_err(&intf->dev, "%s error %d\n",
1130                                                 "reset_resume", status);
1131                 } else {
1132                         intf->needs_binding = 1;
1133                         dev_warn(&intf->dev, "no %s for driver %s?\n",
1134                                         "reset_resume", driver->name);
1135                 }
1136         } else {
1137                 if (driver->resume) {
1138                         status = driver->resume(intf);
1139                         if (status)
1140                                 dev_err(&intf->dev, "%s error %d\n",
1141                                                 "resume", status);
1142                 } else {
1143                         intf->needs_binding = 1;
1144                         dev_warn(&intf->dev, "no %s for driver %s?\n",
1145                                         "resume", driver->name);
1146                 }
1147         }
1148
1149 done:
1150         dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
1151
1152         /* Later we will unbind the driver and/or reprobe, if necessary */
1153         return status;
1154 }
1155
1156 /**
1157  * usb_suspend_both - suspend a USB device and its interfaces
1158  * @udev: the usb_device to suspend
1159  * @msg: Power Management message describing this state transition
1160  *
1161  * This is the central routine for suspending USB devices.  It calls the
1162  * suspend methods for all the interface drivers in @udev and then calls
1163  * the suspend method for @udev itself.  If an error occurs at any stage,
1164  * all the interfaces which were suspended are resumed so that they remain
1165  * in the same state as the device.
1166  *
1167  * Autosuspend requests originating from a child device or an interface
1168  * driver may be made without the protection of @udev's device lock, but
1169  * all other suspend calls will hold the lock.  Usbcore will insure that
1170  * method calls do not arrive during bind, unbind, or reset operations.
1171  * However drivers must be prepared to handle suspend calls arriving at
1172  * unpredictable times.
1173  *
1174  * This routine can run only in process context.
1175  */
1176 static int usb_suspend_both(struct usb_device *udev, pm_message_t msg)
1177 {
1178         int                     status = 0;
1179         int                     i = 0, n = 0;
1180         struct usb_interface    *intf;
1181
1182         if (udev->state == USB_STATE_NOTATTACHED ||
1183                         udev->state == USB_STATE_SUSPENDED)
1184                 goto done;
1185
1186         /* Suspend all the interfaces and then udev itself */
1187         if (udev->actconfig) {
1188                 n = udev->actconfig->desc.bNumInterfaces;
1189                 for (i = n - 1; i >= 0; --i) {
1190                         intf = udev->actconfig->interface[i];
1191                         status = usb_suspend_interface(udev, intf, msg);
1192                         if (status != 0)
1193                                 break;
1194                 }
1195         }
1196         if (status == 0)
1197                 status = usb_suspend_device(udev, msg);
1198
1199         /* If the suspend failed, resume interfaces that did get suspended */
1200         if (status != 0) {
1201                 msg.event ^= (PM_EVENT_SUSPEND | PM_EVENT_RESUME);
1202                 while (++i < n) {
1203                         intf = udev->actconfig->interface[i];
1204                         usb_resume_interface(udev, intf, msg, 0);
1205                 }
1206
1207         /* If the suspend succeeded then prevent any more URB submissions
1208          * and flush any outstanding URBs.
1209          */
1210         } else {
1211                 udev->can_submit = 0;
1212                 for (i = 0; i < 16; ++i) {
1213                         usb_hcd_flush_endpoint(udev, udev->ep_out[i]);
1214                         usb_hcd_flush_endpoint(udev, udev->ep_in[i]);
1215                 }
1216         }
1217
1218  done:
1219         dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1220         return status;
1221 }
1222
1223 /**
1224  * usb_resume_both - resume a USB device and its interfaces
1225  * @udev: the usb_device to resume
1226  * @msg: Power Management message describing this state transition
1227  *
1228  * This is the central routine for resuming USB devices.  It calls the
1229  * the resume method for @udev and then calls the resume methods for all
1230  * the interface drivers in @udev.
1231  *
1232  * Autoresume requests originating from a child device or an interface
1233  * driver may be made without the protection of @udev's device lock, but
1234  * all other resume calls will hold the lock.  Usbcore will insure that
1235  * method calls do not arrive during bind, unbind, or reset operations.
1236  * However drivers must be prepared to handle resume calls arriving at
1237  * unpredictable times.
1238  *
1239  * This routine can run only in process context.
1240  */
1241 static int usb_resume_both(struct usb_device *udev, pm_message_t msg)
1242 {
1243         int                     status = 0;
1244         int                     i;
1245         struct usb_interface    *intf;
1246
1247         if (udev->state == USB_STATE_NOTATTACHED) {
1248                 status = -ENODEV;
1249                 goto done;
1250         }
1251         udev->can_submit = 1;
1252
1253         /* Resume the device */
1254         if (udev->state == USB_STATE_SUSPENDED || udev->reset_resume)
1255                 status = usb_resume_device(udev, msg);
1256
1257         /* Resume the interfaces */
1258         if (status == 0 && udev->actconfig) {
1259                 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1260                         intf = udev->actconfig->interface[i];
1261                         usb_resume_interface(udev, intf, msg,
1262                                         udev->reset_resume);
1263                 }
1264         }
1265
1266  done:
1267         dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1268         if (!status)
1269                 udev->reset_resume = 0;
1270         return status;
1271 }
1272
1273 static void choose_wakeup(struct usb_device *udev, pm_message_t msg)
1274 {
1275         int     w;
1276
1277         /* Remote wakeup is needed only when we actually go to sleep.
1278          * For things like FREEZE and QUIESCE, if the device is already
1279          * autosuspended then its current wakeup setting is okay.
1280          */
1281         if (msg.event == PM_EVENT_FREEZE || msg.event == PM_EVENT_QUIESCE) {
1282                 if (udev->state != USB_STATE_SUSPENDED)
1283                         udev->do_remote_wakeup = 0;
1284                 return;
1285         }
1286
1287         /* Enable remote wakeup if it is allowed, even if no interface drivers
1288          * actually want it.
1289          */
1290         w = device_may_wakeup(&udev->dev);
1291
1292         /* If the device is autosuspended with the wrong wakeup setting,
1293          * autoresume now so the setting can be changed.
1294          */
1295         if (udev->state == USB_STATE_SUSPENDED && w != udev->do_remote_wakeup)
1296                 pm_runtime_resume(&udev->dev);
1297         udev->do_remote_wakeup = w;
1298 }
1299
1300 /* The device lock is held by the PM core */
1301 int usb_suspend(struct device *dev, pm_message_t msg)
1302 {
1303         struct usb_device       *udev = to_usb_device(dev);
1304
1305         do_unbind_rebind(udev, DO_UNBIND);
1306         choose_wakeup(udev, msg);
1307         return usb_suspend_both(udev, msg);
1308 }
1309
1310 /* The device lock is held by the PM core */
1311 int usb_resume(struct device *dev, pm_message_t msg)
1312 {
1313         struct usb_device       *udev = to_usb_device(dev);
1314         int                     status;
1315
1316         /* For PM complete calls, all we do is rebind interfaces */
1317         if (msg.event == PM_EVENT_ON) {
1318                 if (udev->state != USB_STATE_NOTATTACHED)
1319                         do_unbind_rebind(udev, DO_REBIND);
1320                 status = 0;
1321
1322         /* For all other calls, take the device back to full power and
1323          * tell the PM core in case it was autosuspended previously.
1324          * Unbind the interfaces that will need rebinding later.
1325          */
1326         } else {
1327                 status = usb_resume_both(udev, msg);
1328                 if (status == 0) {
1329                         pm_runtime_disable(dev);
1330                         pm_runtime_set_active(dev);
1331                         pm_runtime_enable(dev);
1332                         udev->last_busy = jiffies;
1333                         do_unbind_rebind(udev, DO_REBIND);
1334                 }
1335         }
1336
1337         /* Avoid PM error messages for devices disconnected while suspended
1338          * as we'll display regular disconnect messages just a bit later.
1339          */
1340         if (status == -ENODEV || status == -ESHUTDOWN)
1341                 status = 0;
1342         return status;
1343 }
1344
1345 #endif /* CONFIG_PM */
1346
1347 #ifdef CONFIG_USB_SUSPEND
1348
1349 /**
1350  * usb_enable_autosuspend - allow a USB device to be autosuspended
1351  * @udev: the USB device which may be autosuspended
1352  *
1353  * This routine allows @udev to be autosuspended.  An autosuspend won't
1354  * take place until the autosuspend_delay has elapsed and all the other
1355  * necessary conditions are satisfied.
1356  *
1357  * The caller must hold @udev's device lock.
1358  */
1359 void usb_enable_autosuspend(struct usb_device *udev)
1360 {
1361         pm_runtime_allow(&udev->dev);
1362 }
1363 EXPORT_SYMBOL_GPL(usb_enable_autosuspend);
1364
1365 /**
1366  * usb_disable_autosuspend - prevent a USB device from being autosuspended
1367  * @udev: the USB device which may not be autosuspended
1368  *
1369  * This routine prevents @udev from being autosuspended and wakes it up
1370  * if it is already autosuspended.
1371  *
1372  * The caller must hold @udev's device lock.
1373  */
1374 void usb_disable_autosuspend(struct usb_device *udev)
1375 {
1376         pm_runtime_forbid(&udev->dev);
1377 }
1378 EXPORT_SYMBOL_GPL(usb_disable_autosuspend);
1379
1380 /**
1381  * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
1382  * @udev: the usb_device to autosuspend
1383  *
1384  * This routine should be called when a core subsystem is finished using
1385  * @udev and wants to allow it to autosuspend.  Examples would be when
1386  * @udev's device file in usbfs is closed or after a configuration change.
1387  *
1388  * @udev's usage counter is decremented; if it drops to 0 and all the
1389  * interfaces are inactive then a delayed autosuspend will be attempted.
1390  * The attempt may fail (see autosuspend_check()).
1391  *
1392  * The caller must hold @udev's device lock.
1393  *
1394  * This routine can run only in process context.
1395  */
1396 void usb_autosuspend_device(struct usb_device *udev)
1397 {
1398         int     status;
1399
1400         udev->last_busy = jiffies;
1401         status = pm_runtime_put_sync(&udev->dev);
1402         dev_vdbg(&udev->dev, "%s: cnt %d -> %d\n",
1403                         __func__, atomic_read(&udev->dev.power.usage_count),
1404                         status);
1405 }
1406
1407 /**
1408  * usb_try_autosuspend_device - attempt an autosuspend of a USB device and its interfaces
1409  * @udev: the usb_device to autosuspend
1410  *
1411  * This routine should be called when a core subsystem thinks @udev may
1412  * be ready to autosuspend.
1413  *
1414  * @udev's usage counter left unchanged.  If it is 0 and all the interfaces
1415  * are inactive then an autosuspend will be attempted.  The attempt may
1416  * fail or be delayed.
1417  *
1418  * The caller must hold @udev's device lock.
1419  *
1420  * This routine can run only in process context.
1421  */
1422 void usb_try_autosuspend_device(struct usb_device *udev)
1423 {
1424         int     status;
1425
1426         status = pm_runtime_idle(&udev->dev);
1427         dev_vdbg(&udev->dev, "%s: cnt %d -> %d\n",
1428                         __func__, atomic_read(&udev->dev.power.usage_count),
1429                         status);
1430 }
1431
1432 /**
1433  * usb_autoresume_device - immediately autoresume a USB device and its interfaces
1434  * @udev: the usb_device to autoresume
1435  *
1436  * This routine should be called when a core subsystem wants to use @udev
1437  * and needs to guarantee that it is not suspended.  No autosuspend will
1438  * occur until usb_autosuspend_device() is called.  (Note that this will
1439  * not prevent suspend events originating in the PM core.)  Examples would
1440  * be when @udev's device file in usbfs is opened or when a remote-wakeup
1441  * request is received.
1442  *
1443  * @udev's usage counter is incremented to prevent subsequent autosuspends.
1444  * However if the autoresume fails then the usage counter is re-decremented.
1445  *
1446  * The caller must hold @udev's device lock.
1447  *
1448  * This routine can run only in process context.
1449  */
1450 int usb_autoresume_device(struct usb_device *udev)
1451 {
1452         int     status;
1453
1454         status = pm_runtime_get_sync(&udev->dev);
1455         if (status < 0)
1456                 pm_runtime_put_sync(&udev->dev);
1457         dev_vdbg(&udev->dev, "%s: cnt %d -> %d\n",
1458                         __func__, atomic_read(&udev->dev.power.usage_count),
1459                         status);
1460         if (status > 0)
1461                 status = 0;
1462         return status;
1463 }
1464
1465 /**
1466  * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
1467  * @intf: the usb_interface whose counter should be decremented
1468  *
1469  * This routine should be called by an interface driver when it is
1470  * finished using @intf and wants to allow it to autosuspend.  A typical
1471  * example would be a character-device driver when its device file is
1472  * closed.
1473  *
1474  * The routine decrements @intf's usage counter.  When the counter reaches
1475  * 0, a delayed autosuspend request for @intf's device is attempted.  The
1476  * attempt may fail (see autosuspend_check()).
1477  *
1478  * This routine can run only in process context.
1479  */
1480 void usb_autopm_put_interface(struct usb_interface *intf)
1481 {
1482         struct usb_device       *udev = interface_to_usbdev(intf);
1483         int                     status;
1484
1485         udev->last_busy = jiffies;
1486         atomic_dec(&intf->pm_usage_cnt);
1487         status = pm_runtime_put_sync(&intf->dev);
1488         dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
1489                         __func__, atomic_read(&intf->dev.power.usage_count),
1490                         status);
1491 }
1492 EXPORT_SYMBOL_GPL(usb_autopm_put_interface);
1493
1494 /**
1495  * usb_autopm_put_interface_async - decrement a USB interface's PM-usage counter
1496  * @intf: the usb_interface whose counter should be decremented
1497  *
1498  * This routine does much the same thing as usb_autopm_put_interface():
1499  * It decrements @intf's usage counter and schedules a delayed
1500  * autosuspend request if the counter is <= 0.  The difference is that it
1501  * does not perform any synchronization; callers should hold a private
1502  * lock and handle all synchronization issues themselves.
1503  *
1504  * Typically a driver would call this routine during an URB's completion
1505  * handler, if no more URBs were pending.
1506  *
1507  * This routine can run in atomic context.
1508  */
1509 void usb_autopm_put_interface_async(struct usb_interface *intf)
1510 {
1511         struct usb_device       *udev = interface_to_usbdev(intf);
1512         unsigned long           last_busy;
1513         int                     status = 0;
1514
1515         last_busy = udev->last_busy;
1516         udev->last_busy = jiffies;
1517         atomic_dec(&intf->pm_usage_cnt);
1518         pm_runtime_put_noidle(&intf->dev);
1519
1520         if (udev->dev.power.runtime_auto) {
1521                 /* Optimization: Don't schedule a delayed autosuspend if
1522                  * the timer is already running and the expiration time
1523                  * wouldn't change.
1524                  *
1525                  * We have to use the interface's timer.  Attempts to
1526                  * schedule a suspend for the device would fail because
1527                  * the interface is still active.
1528                  */
1529                 if (intf->dev.power.timer_expires == 0 ||
1530                                 round_jiffies_up(last_busy) !=
1531                                 round_jiffies_up(jiffies)) {
1532                         status = pm_schedule_suspend(&intf->dev,
1533                                         jiffies_to_msecs(
1534                                         round_jiffies_up_relative(
1535                                                 udev->autosuspend_delay)));
1536                 }
1537         }
1538         dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
1539                         __func__, atomic_read(&intf->dev.power.usage_count),
1540                         status);
1541 }
1542 EXPORT_SYMBOL_GPL(usb_autopm_put_interface_async);
1543
1544 /**
1545  * usb_autopm_put_interface_no_suspend - decrement a USB interface's PM-usage counter
1546  * @intf: the usb_interface whose counter should be decremented
1547  *
1548  * This routine decrements @intf's usage counter but does not carry out an
1549  * autosuspend.
1550  *
1551  * This routine can run in atomic context.
1552  */
1553 void usb_autopm_put_interface_no_suspend(struct usb_interface *intf)
1554 {
1555         struct usb_device       *udev = interface_to_usbdev(intf);
1556
1557         udev->last_busy = jiffies;
1558         atomic_dec(&intf->pm_usage_cnt);
1559         pm_runtime_put_noidle(&intf->dev);
1560 }
1561 EXPORT_SYMBOL_GPL(usb_autopm_put_interface_no_suspend);
1562
1563 /**
1564  * usb_autopm_get_interface - increment a USB interface's PM-usage counter
1565  * @intf: the usb_interface whose counter should be incremented
1566  *
1567  * This routine should be called by an interface driver when it wants to
1568  * use @intf and needs to guarantee that it is not suspended.  In addition,
1569  * the routine prevents @intf from being autosuspended subsequently.  (Note
1570  * that this will not prevent suspend events originating in the PM core.)
1571  * This prevention will persist until usb_autopm_put_interface() is called
1572  * or @intf is unbound.  A typical example would be a character-device
1573  * driver when its device file is opened.
1574  *
1575  * @intf's usage counter is incremented to prevent subsequent autosuspends.
1576  * However if the autoresume fails then the counter is re-decremented.
1577  *
1578  * This routine can run only in process context.
1579  */
1580 int usb_autopm_get_interface(struct usb_interface *intf)
1581 {
1582         int     status;
1583
1584         status = pm_runtime_get_sync(&intf->dev);
1585         if (status < 0)
1586                 pm_runtime_put_sync(&intf->dev);
1587         else
1588                 atomic_inc(&intf->pm_usage_cnt);
1589         dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
1590                         __func__, atomic_read(&intf->dev.power.usage_count),
1591                         status);
1592         if (status > 0)
1593                 status = 0;
1594         return status;
1595 }
1596 EXPORT_SYMBOL_GPL(usb_autopm_get_interface);
1597
1598 /**
1599  * usb_autopm_get_interface_async - increment a USB interface's PM-usage counter
1600  * @intf: the usb_interface whose counter should be incremented
1601  *
1602  * This routine does much the same thing as
1603  * usb_autopm_get_interface(): It increments @intf's usage counter and
1604  * queues an autoresume request if the device is suspended.  The
1605  * differences are that it does not perform any synchronization (callers
1606  * should hold a private lock and handle all synchronization issues
1607  * themselves), and it does not autoresume the device directly (it only
1608  * queues a request).  After a successful call, the device may not yet be
1609  * resumed.
1610  *
1611  * This routine can run in atomic context.
1612  */
1613 int usb_autopm_get_interface_async(struct usb_interface *intf)
1614 {
1615         int             status = 0;
1616         enum rpm_status s;
1617
1618         /* Don't request a resume unless the interface is already suspending
1619          * or suspended.  Doing so would force a running suspend timer to be
1620          * cancelled.
1621          */
1622         pm_runtime_get_noresume(&intf->dev);
1623         s = ACCESS_ONCE(intf->dev.power.runtime_status);
1624         if (s == RPM_SUSPENDING || s == RPM_SUSPENDED)
1625                 status = pm_request_resume(&intf->dev);
1626
1627         if (status < 0 && status != -EINPROGRESS)
1628                 pm_runtime_put_noidle(&intf->dev);
1629         else
1630                 atomic_inc(&intf->pm_usage_cnt);
1631         dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
1632                         __func__, atomic_read(&intf->dev.power.usage_count),
1633                         status);
1634         if (status > 0)
1635                 status = 0;
1636         return status;
1637 }
1638 EXPORT_SYMBOL_GPL(usb_autopm_get_interface_async);
1639
1640 /**
1641  * usb_autopm_get_interface_no_resume - increment a USB interface's PM-usage counter
1642  * @intf: the usb_interface whose counter should be incremented
1643  *
1644  * This routine increments @intf's usage counter but does not carry out an
1645  * autoresume.
1646  *
1647  * This routine can run in atomic context.
1648  */
1649 void usb_autopm_get_interface_no_resume(struct usb_interface *intf)
1650 {
1651         struct usb_device       *udev = interface_to_usbdev(intf);
1652
1653         udev->last_busy = jiffies;
1654         atomic_inc(&intf->pm_usage_cnt);
1655         pm_runtime_get_noresume(&intf->dev);
1656 }
1657 EXPORT_SYMBOL_GPL(usb_autopm_get_interface_no_resume);
1658
1659 /* Internal routine to check whether we may autosuspend a device. */
1660 static int autosuspend_check(struct usb_device *udev)
1661 {
1662         int                     w, i;
1663         struct usb_interface    *intf;
1664         unsigned long           suspend_time, j;
1665
1666         /* Fail if autosuspend is disabled, or any interfaces are in use, or
1667          * any interface drivers require remote wakeup but it isn't available.
1668          */
1669         w = 0;
1670         if (udev->actconfig) {
1671                 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1672                         intf = udev->actconfig->interface[i];
1673
1674                         /* We don't need to check interfaces that are
1675                          * disabled for runtime PM.  Either they are unbound
1676                          * or else their drivers don't support autosuspend
1677                          * and so they are permanently active.
1678                          */
1679                         if (intf->dev.power.disable_depth)
1680                                 continue;
1681                         if (atomic_read(&intf->dev.power.usage_count) > 0)
1682                                 return -EBUSY;
1683                         w |= intf->needs_remote_wakeup;
1684
1685                         /* Don't allow autosuspend if the device will need
1686                          * a reset-resume and any of its interface drivers
1687                          * doesn't include support or needs remote wakeup.
1688                          */
1689                         if (udev->quirks & USB_QUIRK_RESET_RESUME) {
1690                                 struct usb_driver *driver;
1691
1692                                 driver = to_usb_driver(intf->dev.driver);
1693                                 if (!driver->reset_resume ||
1694                                                 intf->needs_remote_wakeup)
1695                                         return -EOPNOTSUPP;
1696                         }
1697                 }
1698         }
1699         if (w && !device_can_wakeup(&udev->dev)) {
1700                 dev_dbg(&udev->dev, "remote wakeup needed for autosuspend\n");
1701                 return -EOPNOTSUPP;
1702         }
1703         udev->do_remote_wakeup = w;
1704
1705         /* If everything is okay but the device hasn't been idle for long
1706          * enough, queue a delayed autosuspend request.
1707          */
1708         j = ACCESS_ONCE(jiffies);
1709         suspend_time = udev->last_busy + udev->autosuspend_delay;
1710         if (time_before(j, suspend_time)) {
1711                 pm_schedule_suspend(&udev->dev, jiffies_to_msecs(
1712                                 round_jiffies_up_relative(suspend_time - j)));
1713                 return -EAGAIN;
1714         }
1715         return 0;
1716 }
1717
1718 static int usb_runtime_suspend(struct device *dev)
1719 {
1720         int     status = 0;
1721
1722         /* A USB device can be suspended if it passes the various autosuspend
1723          * checks.  Runtime suspend for a USB device means suspending all the
1724          * interfaces and then the device itself.
1725          */
1726         if (is_usb_device(dev)) {
1727                 struct usb_device       *udev = to_usb_device(dev);
1728
1729                 if (autosuspend_check(udev) != 0)
1730                         return -EAGAIN;
1731
1732                 status = usb_suspend_both(udev, PMSG_AUTO_SUSPEND);
1733
1734                 /* If an interface fails the suspend, adjust the last_busy
1735                  * time so that we don't get another suspend attempt right
1736                  * away.
1737                  */
1738                 if (status) {
1739                         udev->last_busy = jiffies +
1740                                         (udev->autosuspend_delay == 0 ?
1741                                                 HZ/2 : 0);
1742                 }
1743
1744                 /* Prevent the parent from suspending immediately after */
1745                 else if (udev->parent)
1746                         udev->parent->last_busy = jiffies;
1747         }
1748
1749         /* Runtime suspend for a USB interface doesn't mean anything. */
1750         return status;
1751 }
1752
1753 static int usb_runtime_resume(struct device *dev)
1754 {
1755         /* Runtime resume for a USB device means resuming both the device
1756          * and all its interfaces.
1757          */
1758         if (is_usb_device(dev)) {
1759                 struct usb_device       *udev = to_usb_device(dev);
1760                 int                     status;
1761
1762                 status = usb_resume_both(udev, PMSG_AUTO_RESUME);
1763                 udev->last_busy = jiffies;
1764                 return status;
1765         }
1766
1767         /* Runtime resume for a USB interface doesn't mean anything. */
1768         return 0;
1769 }
1770
1771 static int usb_runtime_idle(struct device *dev)
1772 {
1773         /* An idle USB device can be suspended if it passes the various
1774          * autosuspend checks.  An idle interface can be suspended at
1775          * any time.
1776          */
1777         if (is_usb_device(dev)) {
1778                 struct usb_device       *udev = to_usb_device(dev);
1779
1780                 if (autosuspend_check(udev) != 0)
1781                         return 0;
1782         }
1783
1784         pm_runtime_suspend(dev);
1785         return 0;
1786 }
1787
1788 static const struct dev_pm_ops usb_bus_pm_ops = {
1789         .runtime_suspend =      usb_runtime_suspend,
1790         .runtime_resume =       usb_runtime_resume,
1791         .runtime_idle =         usb_runtime_idle,
1792 };
1793
1794 #endif /* CONFIG_USB_SUSPEND */
1795
1796 struct bus_type usb_bus_type = {
1797         .name =         "usb",
1798         .match =        usb_device_match,
1799         .uevent =       usb_uevent,
1800 #ifdef CONFIG_USB_SUSPEND
1801         .pm =           &usb_bus_pm_ops,
1802 #endif
1803 };