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