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