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