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