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