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