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