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