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