]>
Commit | Line | Data |
---|---|---|
989d42e8 | 1 | // SPDX-License-Identifier: GPL-2.0 |
07e4a3e2 | 2 | /* |
4a3ad20c | 3 | * drivers/base/dd.c - The core device/driver interactions. |
07e4a3e2 | 4 | * |
4a3ad20c GKH |
5 | * This file contains the (sometimes tricky) code that controls the |
6 | * interactions between devices and drivers, which primarily includes | |
7 | * driver binding and unbinding. | |
07e4a3e2 | 8 | * |
4a3ad20c GKH |
9 | * All of this code used to exist in drivers/base/bus.c, but was |
10 | * relocated to here in the name of compartmentalization (since it wasn't | |
11 | * strictly code just for the 'struct bus_type'. | |
07e4a3e2 | 12 | * |
4a3ad20c GKH |
13 | * Copyright (c) 2002-5 Patrick Mochel |
14 | * Copyright (c) 2002-3 Open Source Development Labs | |
b4028437 GKH |
15 | * Copyright (c) 2007-2009 Greg Kroah-Hartman <gregkh@suse.de> |
16 | * Copyright (c) 2007-2009 Novell Inc. | |
07e4a3e2 PM |
17 | */ |
18 | ||
28af109a | 19 | #include <linux/debugfs.h> |
07e4a3e2 | 20 | #include <linux/device.h> |
216773a7 | 21 | #include <linux/delay.h> |
0a0f0d8b | 22 | #include <linux/dma-map-ops.h> |
1f5000bd | 23 | #include <linux/init.h> |
07e4a3e2 | 24 | #include <linux/module.h> |
d779249e | 25 | #include <linux/kthread.h> |
735a7ffb | 26 | #include <linux/wait.h> |
216773a7 | 27 | #include <linux/async.h> |
5e928f77 | 28 | #include <linux/pm_runtime.h> |
ab78029e | 29 | #include <linux/pinctrl/devinfo.h> |
d090b70e | 30 | #include <linux/slab.h> |
07e4a3e2 PM |
31 | |
32 | #include "base.h" | |
33 | #include "power/power.h" | |
34 | ||
d1c3414c GL |
35 | /* |
36 | * Deferred Probe infrastructure. | |
37 | * | |
38 | * Sometimes driver probe order matters, but the kernel doesn't always have | |
39 | * dependency information which means some drivers will get probed before a | |
40 | * resource it depends on is available. For example, an SDHCI driver may | |
41 | * first need a GPIO line from an i2c GPIO controller before it can be | |
42 | * initialized. If a required resource is not available yet, a driver can | |
43 | * request probing to be deferred by returning -EPROBE_DEFER from its probe hook | |
44 | * | |
45 | * Deferred probe maintains two lists of devices, a pending list and an active | |
46 | * list. A driver returning -EPROBE_DEFER causes the device to be added to the | |
47 | * pending list. A successful driver probe will trigger moving all devices | |
48 | * from the pending to the active list so that the workqueue will eventually | |
49 | * retry them. | |
50 | * | |
51 | * The deferred_probe_mutex must be held any time the deferred_probe_*_list | |
ef8a3fd6 | 52 | * of the (struct device*)->p->deferred_probe pointers are manipulated |
d1c3414c GL |
53 | */ |
54 | static DEFINE_MUTEX(deferred_probe_mutex); | |
55 | static LIST_HEAD(deferred_probe_pending_list); | |
56 | static LIST_HEAD(deferred_probe_active_list); | |
58b116bc | 57 | static atomic_t deferred_trigger_count = ATOMIC_INIT(0); |
25b4e70d | 58 | static bool initcalls_done; |
d1c3414c | 59 | |
1ea61b68 FT |
60 | /* Save the async probe drivers' name from kernel cmdline */ |
61 | #define ASYNC_DRV_NAMES_MAX_LEN 256 | |
62 | static char async_probe_drv_names[ASYNC_DRV_NAMES_MAX_LEN]; | |
63 | ||
013c074f SG |
64 | /* |
65 | * In some cases, like suspend to RAM or hibernation, It might be reasonable | |
66 | * to prohibit probing of devices as it could be unsafe. | |
67 | * Once defer_all_probes is true all drivers probes will be forcibly deferred. | |
68 | */ | |
69 | static bool defer_all_probes; | |
70 | ||
72a91f19 AF |
71 | static void __device_set_deferred_probe_reason(const struct device *dev, char *reason) |
72 | { | |
73 | kfree(dev->p->deferred_probe_reason); | |
74 | dev->p->deferred_probe_reason = reason; | |
75 | } | |
76 | ||
41575335 | 77 | /* |
d1c3414c GL |
78 | * deferred_probe_work_func() - Retry probing devices in the active list. |
79 | */ | |
80 | static void deferred_probe_work_func(struct work_struct *work) | |
81 | { | |
82 | struct device *dev; | |
ef8a3fd6 | 83 | struct device_private *private; |
d1c3414c GL |
84 | /* |
85 | * This block processes every device in the deferred 'active' list. | |
86 | * Each device is removed from the active list and passed to | |
87 | * bus_probe_device() to re-attempt the probe. The loop continues | |
88 | * until every device in the active list is removed and retried. | |
89 | * | |
90 | * Note: Once the device is removed from the list and the mutex is | |
91 | * released, it is possible for the device get freed by another thread | |
92 | * and cause a illegal pointer dereference. This code uses | |
93 | * get/put_device() to ensure the device structure cannot disappear | |
94 | * from under our feet. | |
95 | */ | |
96 | mutex_lock(&deferred_probe_mutex); | |
97 | while (!list_empty(&deferred_probe_active_list)) { | |
ef8a3fd6 GKH |
98 | private = list_first_entry(&deferred_probe_active_list, |
99 | typeof(*dev->p), deferred_probe); | |
100 | dev = private->device; | |
101 | list_del_init(&private->deferred_probe); | |
d1c3414c GL |
102 | |
103 | get_device(dev); | |
104 | ||
72a91f19 | 105 | __device_set_deferred_probe_reason(dev, NULL); |
f0acf637 | 106 | |
8b0372a2 GKH |
107 | /* |
108 | * Drop the mutex while probing each device; the probe path may | |
109 | * manipulate the deferred list | |
110 | */ | |
d1c3414c | 111 | mutex_unlock(&deferred_probe_mutex); |
8153584e MB |
112 | |
113 | /* | |
114 | * Force the device to the end of the dpm_list since | |
115 | * the PM code assumes that the order we add things to | |
116 | * the list is a good order for suspend but deferred | |
117 | * probe makes that very unsafe. | |
118 | */ | |
494fd7b7 | 119 | device_pm_move_to_tail(dev); |
8153584e | 120 | |
d1c3414c | 121 | dev_dbg(dev, "Retrying from deferred list\n"); |
0a50f61c | 122 | bus_probe_device(dev); |
d1c3414c GL |
123 | mutex_lock(&deferred_probe_mutex); |
124 | ||
125 | put_device(dev); | |
126 | } | |
127 | mutex_unlock(&deferred_probe_mutex); | |
128 | } | |
129 | static DECLARE_WORK(deferred_probe_work, deferred_probe_work_func); | |
130 | ||
e7dd4010 | 131 | void driver_deferred_probe_add(struct device *dev) |
d1c3414c | 132 | { |
f2db85b6 SK |
133 | if (!dev->can_match) |
134 | return; | |
135 | ||
d1c3414c | 136 | mutex_lock(&deferred_probe_mutex); |
ef8a3fd6 | 137 | if (list_empty(&dev->p->deferred_probe)) { |
d1c3414c | 138 | dev_dbg(dev, "Added to deferred list\n"); |
1d29cfa5 | 139 | list_add_tail(&dev->p->deferred_probe, &deferred_probe_pending_list); |
d1c3414c GL |
140 | } |
141 | mutex_unlock(&deferred_probe_mutex); | |
142 | } | |
143 | ||
144 | void driver_deferred_probe_del(struct device *dev) | |
145 | { | |
146 | mutex_lock(&deferred_probe_mutex); | |
ef8a3fd6 | 147 | if (!list_empty(&dev->p->deferred_probe)) { |
d1c3414c | 148 | dev_dbg(dev, "Removed from deferred list\n"); |
ef8a3fd6 | 149 | list_del_init(&dev->p->deferred_probe); |
72a91f19 | 150 | __device_set_deferred_probe_reason(dev, NULL); |
d1c3414c GL |
151 | } |
152 | mutex_unlock(&deferred_probe_mutex); | |
153 | } | |
154 | ||
155 | static bool driver_deferred_probe_enable = false; | |
156 | /** | |
157 | * driver_deferred_probe_trigger() - Kick off re-probing deferred devices | |
158 | * | |
159 | * This functions moves all devices from the pending list to the active | |
160 | * list and schedules the deferred probe workqueue to process them. It | |
161 | * should be called anytime a driver is successfully bound to a device. | |
58b116bc GL |
162 | * |
163 | * Note, there is a race condition in multi-threaded probe. In the case where | |
164 | * more than one device is probing at the same time, it is possible for one | |
165 | * probe to complete successfully while another is about to defer. If the second | |
166 | * depends on the first, then it will get put on the pending list after the | |
9ba8af66 | 167 | * trigger event has already occurred and will be stuck there. |
58b116bc GL |
168 | * |
169 | * The atomic 'deferred_trigger_count' is used to determine if a successful | |
170 | * trigger has occurred in the midst of probing a driver. If the trigger count | |
171 | * changes in the midst of a probe, then deferred processing should be triggered | |
172 | * again. | |
d1c3414c GL |
173 | */ |
174 | static void driver_deferred_probe_trigger(void) | |
96d8a916 | 175 | { |
999032ec SK |
176 | if (!driver_deferred_probe_enable) |
177 | return; | |
178 | ||
8b0372a2 GKH |
179 | /* |
180 | * A successful probe means that all the devices in the pending list | |
d1c3414c | 181 | * should be triggered to be reprobed. Move all the deferred devices |
8b0372a2 GKH |
182 | * into the active list so they can be retried by the workqueue |
183 | */ | |
d1c3414c | 184 | mutex_lock(&deferred_probe_mutex); |
58b116bc | 185 | atomic_inc(&deferred_trigger_count); |
d1c3414c GL |
186 | list_splice_tail_init(&deferred_probe_pending_list, |
187 | &deferred_probe_active_list); | |
188 | mutex_unlock(&deferred_probe_mutex); | |
189 | ||
8b0372a2 GKH |
190 | /* |
191 | * Kick the re-probe thread. It may already be scheduled, but it is | |
192 | * safe to kick it again. | |
193 | */ | |
e611f8cd | 194 | queue_work(system_unbound_wq, &deferred_probe_work); |
d1c3414c GL |
195 | } |
196 | ||
013c074f | 197 | /** |
dbf03d65 | 198 | * device_block_probing() - Block/defer device's probes |
013c074f SG |
199 | * |
200 | * It will disable probing of devices and defer their probes instead. | |
201 | */ | |
202 | void device_block_probing(void) | |
203 | { | |
204 | defer_all_probes = true; | |
205 | /* sync with probes to avoid races. */ | |
206 | wait_for_device_probe(); | |
207 | } | |
208 | ||
209 | /** | |
210 | * device_unblock_probing() - Unblock/enable device's probes | |
211 | * | |
212 | * It will restore normal behavior and trigger re-probing of deferred | |
213 | * devices. | |
214 | */ | |
215 | void device_unblock_probing(void) | |
216 | { | |
217 | defer_all_probes = false; | |
218 | driver_deferred_probe_trigger(); | |
219 | } | |
220 | ||
d090b70e AH |
221 | /** |
222 | * device_set_deferred_probe_reason() - Set defer probe reason message for device | |
223 | * @dev: the pointer to the struct device | |
224 | * @vaf: the pointer to va_format structure with message | |
225 | */ | |
226 | void device_set_deferred_probe_reason(const struct device *dev, struct va_format *vaf) | |
227 | { | |
228 | const char *drv = dev_driver_string(dev); | |
72a91f19 | 229 | char *reason; |
d090b70e AH |
230 | |
231 | mutex_lock(&deferred_probe_mutex); | |
232 | ||
72a91f19 AF |
233 | reason = kasprintf(GFP_KERNEL, "%s: %pV", drv, vaf); |
234 | __device_set_deferred_probe_reason(dev, reason); | |
d090b70e AH |
235 | |
236 | mutex_unlock(&deferred_probe_mutex); | |
237 | } | |
238 | ||
28af109a JMC |
239 | /* |
240 | * deferred_devs_show() - Show the devices in the deferred probe pending list. | |
241 | */ | |
242 | static int deferred_devs_show(struct seq_file *s, void *data) | |
243 | { | |
244 | struct device_private *curr; | |
245 | ||
246 | mutex_lock(&deferred_probe_mutex); | |
247 | ||
248 | list_for_each_entry(curr, &deferred_probe_pending_list, deferred_probe) | |
d090b70e AH |
249 | seq_printf(s, "%s\t%s", dev_name(curr->device), |
250 | curr->device->p->deferred_probe_reason ?: "\n"); | |
28af109a JMC |
251 | |
252 | mutex_unlock(&deferred_probe_mutex); | |
253 | ||
254 | return 0; | |
255 | } | |
256 | DEFINE_SHOW_ATTRIBUTE(deferred_devs); | |
257 | ||
ce68929f | 258 | int driver_deferred_probe_timeout; |
64c775fb | 259 | EXPORT_SYMBOL_GPL(driver_deferred_probe_timeout); |
35a67236 | 260 | static DECLARE_WAIT_QUEUE_HEAD(probe_timeout_waitqueue); |
64c775fb | 261 | |
25b4e70d RH |
262 | static int __init deferred_probe_timeout_setup(char *str) |
263 | { | |
63c98047 MS |
264 | int timeout; |
265 | ||
266 | if (!kstrtoint(str, 10, &timeout)) | |
64c775fb | 267 | driver_deferred_probe_timeout = timeout; |
25b4e70d RH |
268 | return 1; |
269 | } | |
270 | __setup("deferred_probe_timeout=", deferred_probe_timeout_setup); | |
271 | ||
272 | /** | |
273 | * driver_deferred_probe_check_state() - Check deferred probe state | |
274 | * @dev: device to check | |
275 | * | |
c8c43cee JS |
276 | * Return: |
277 | * -ENODEV if initcalls have completed and modules are disabled. | |
278 | * -ETIMEDOUT if the deferred probe timeout was set and has expired | |
279 | * and modules are enabled. | |
280 | * -EPROBE_DEFER in other cases. | |
25b4e70d RH |
281 | * |
282 | * Drivers or subsystems can opt-in to calling this function instead of directly | |
283 | * returning -EPROBE_DEFER. | |
284 | */ | |
285 | int driver_deferred_probe_check_state(struct device *dev) | |
286 | { | |
0e9f8d09 | 287 | if (!IS_ENABLED(CONFIG_MODULES) && initcalls_done) { |
eb7fbc9f | 288 | dev_warn(dev, "ignoring dependency for device, assuming no driver\n"); |
0e9f8d09 JS |
289 | return -ENODEV; |
290 | } | |
62a6bc3a | 291 | |
ce68929f | 292 | if (!driver_deferred_probe_timeout && initcalls_done) { |
c8be6af9 | 293 | dev_warn(dev, "deferred probe timeout, ignoring dependency\n"); |
0e9f8d09 JS |
294 | return -ETIMEDOUT; |
295 | } | |
62a6bc3a | 296 | |
25b4e70d RH |
297 | return -EPROBE_DEFER; |
298 | } | |
4c33225e | 299 | EXPORT_SYMBOL_GPL(driver_deferred_probe_check_state); |
25b4e70d RH |
300 | |
301 | static void deferred_probe_timeout_work_func(struct work_struct *work) | |
302 | { | |
eed6e418 | 303 | struct device_private *p; |
25b4e70d | 304 | |
d46f3e3e SK |
305 | fw_devlink_drivers_done(); |
306 | ||
64c775fb | 307 | driver_deferred_probe_timeout = 0; |
25b4e70d RH |
308 | driver_deferred_probe_trigger(); |
309 | flush_work(&deferred_probe_work); | |
310 | ||
eed6e418 SK |
311 | mutex_lock(&deferred_probe_mutex); |
312 | list_for_each_entry(p, &deferred_probe_pending_list, deferred_probe) | |
313 | dev_info(p->device, "deferred probe pending\n"); | |
314 | mutex_unlock(&deferred_probe_mutex); | |
b292b50b | 315 | wake_up_all(&probe_timeout_waitqueue); |
25b4e70d RH |
316 | } |
317 | static DECLARE_DELAYED_WORK(deferred_probe_timeout_work, deferred_probe_timeout_work_func); | |
318 | ||
d1c3414c GL |
319 | /** |
320 | * deferred_probe_initcall() - Enable probing of deferred devices | |
321 | * | |
322 | * We don't want to get in the way when the bulk of drivers are getting probed. | |
323 | * Instead, this initcall makes sure that deferred probing is delayed until | |
324 | * late_initcall time. | |
325 | */ | |
326 | static int deferred_probe_initcall(void) | |
327 | { | |
2942df67 GKH |
328 | debugfs_create_file("devices_deferred", 0444, NULL, NULL, |
329 | &deferred_devs_fops); | |
28af109a | 330 | |
d1c3414c GL |
331 | driver_deferred_probe_enable = true; |
332 | driver_deferred_probe_trigger(); | |
d72cca1e | 333 | /* Sort as many dependencies as possible before exiting initcalls */ |
2c507e46 | 334 | flush_work(&deferred_probe_work); |
25b4e70d RH |
335 | initcalls_done = true; |
336 | ||
d46f3e3e SK |
337 | if (!IS_ENABLED(CONFIG_MODULES)) |
338 | fw_devlink_drivers_done(); | |
339 | ||
25b4e70d RH |
340 | /* |
341 | * Trigger deferred probe again, this time we won't defer anything | |
342 | * that is optional | |
343 | */ | |
344 | driver_deferred_probe_trigger(); | |
345 | flush_work(&deferred_probe_work); | |
346 | ||
64c775fb | 347 | if (driver_deferred_probe_timeout > 0) { |
25b4e70d | 348 | schedule_delayed_work(&deferred_probe_timeout_work, |
64c775fb | 349 | driver_deferred_probe_timeout * HZ); |
25b4e70d | 350 | } |
d1c3414c GL |
351 | return 0; |
352 | } | |
353 | late_initcall(deferred_probe_initcall); | |
07e4a3e2 | 354 | |
28af109a JMC |
355 | static void __exit deferred_probe_exit(void) |
356 | { | |
2942df67 | 357 | debugfs_remove_recursive(debugfs_lookup("devices_deferred", NULL)); |
28af109a JMC |
358 | } |
359 | __exitcall(deferred_probe_exit); | |
360 | ||
6b9cb427 TV |
361 | /** |
362 | * device_is_bound() - Check if device is bound to a driver | |
363 | * @dev: device to check | |
364 | * | |
365 | * Returns true if passed device has already finished probing successfully | |
366 | * against a driver. | |
367 | * | |
368 | * This function must be called with the device lock held. | |
369 | */ | |
370 | bool device_is_bound(struct device *dev) | |
371 | { | |
3ded9104 | 372 | return dev->p && klist_node_attached(&dev->p->knode_driver); |
6b9cb427 TV |
373 | } |
374 | ||
1901fb26 | 375 | static void driver_bound(struct device *dev) |
07e4a3e2 | 376 | { |
6b9cb427 | 377 | if (device_is_bound(dev)) { |
eb7fbc9f | 378 | pr_warn("%s: device %s already bound\n", |
2b3a302a | 379 | __func__, kobject_name(&dev->kobj)); |
1901fb26 | 380 | return; |
f86db396 | 381 | } |
4c898c7f | 382 | |
94f8cc0e FR |
383 | pr_debug("driver: '%s': %s: bound to device '%s'\n", dev->driver->name, |
384 | __func__, dev_name(dev)); | |
116af378 | 385 | |
fbb88fad | 386 | klist_add_tail(&dev->p->knode_driver, &dev->driver->p->klist_devices); |
9ed98953 | 387 | device_links_driver_bound(dev); |
fbb88fad | 388 | |
aa8e54b5 TV |
389 | device_pm_check_callbacks(dev); |
390 | ||
8b0372a2 GKH |
391 | /* |
392 | * Make sure the device is no longer in one of the deferred lists and | |
393 | * kick off retrying all pending devices | |
394 | */ | |
d1c3414c GL |
395 | driver_deferred_probe_del(dev); |
396 | driver_deferred_probe_trigger(); | |
397 | ||
116af378 | 398 | if (dev->bus) |
c6f7e72a | 399 | blocking_notifier_call_chain(&dev->bus->p->bus_notifier, |
116af378 | 400 | BUS_NOTIFY_BOUND_DRIVER, dev); |
1455cf8d DT |
401 | |
402 | kobject_uevent(&dev->kobj, KOBJ_BIND); | |
1901fb26 KS |
403 | } |
404 | ||
3c47d19f AS |
405 | static ssize_t coredump_store(struct device *dev, struct device_attribute *attr, |
406 | const char *buf, size_t count) | |
407 | { | |
408 | device_lock(dev); | |
1fe56e0c | 409 | dev->driver->coredump(dev); |
3c47d19f AS |
410 | device_unlock(dev); |
411 | ||
412 | return count; | |
413 | } | |
414 | static DEVICE_ATTR_WO(coredump); | |
415 | ||
1901fb26 KS |
416 | static int driver_sysfs_add(struct device *dev) |
417 | { | |
418 | int ret; | |
419 | ||
45daef0f MD |
420 | if (dev->bus) |
421 | blocking_notifier_call_chain(&dev->bus->p->bus_notifier, | |
422 | BUS_NOTIFY_BIND_DRIVER, dev); | |
423 | ||
e5dd1278 | 424 | ret = sysfs_create_link(&dev->driver->p->kobj, &dev->kobj, |
3c47d19f AS |
425 | kobject_name(&dev->kobj)); |
426 | if (ret) | |
427 | goto fail; | |
428 | ||
429 | ret = sysfs_create_link(&dev->kobj, &dev->driver->p->kobj, | |
430 | "driver"); | |
431 | if (ret) | |
432 | goto rm_dev; | |
433 | ||
d225ef6f JJB |
434 | if (!IS_ENABLED(CONFIG_DEV_COREDUMP) || !dev->driver->coredump) |
435 | return 0; | |
436 | ||
437 | ret = device_create_file(dev, &dev_attr_coredump); | |
438 | if (!ret) | |
3c47d19f AS |
439 | return 0; |
440 | ||
441 | sysfs_remove_link(&dev->kobj, "driver"); | |
442 | ||
443 | rm_dev: | |
444 | sysfs_remove_link(&dev->driver->p->kobj, | |
07e4a3e2 | 445 | kobject_name(&dev->kobj)); |
3c47d19f AS |
446 | |
447 | fail: | |
f86db396 | 448 | return ret; |
07e4a3e2 PM |
449 | } |
450 | ||
1901fb26 KS |
451 | static void driver_sysfs_remove(struct device *dev) |
452 | { | |
453 | struct device_driver *drv = dev->driver; | |
454 | ||
455 | if (drv) { | |
3c47d19f AS |
456 | if (drv->coredump) |
457 | device_remove_file(dev, &dev_attr_coredump); | |
e5dd1278 | 458 | sysfs_remove_link(&drv->p->kobj, kobject_name(&dev->kobj)); |
1901fb26 KS |
459 | sysfs_remove_link(&dev->kobj, "driver"); |
460 | } | |
461 | } | |
462 | ||
463 | /** | |
4a3ad20c GKH |
464 | * device_bind_driver - bind a driver to one device. |
465 | * @dev: device. | |
1901fb26 | 466 | * |
4a3ad20c GKH |
467 | * Allow manual attachment of a driver to a device. |
468 | * Caller must have already set @dev->driver. | |
1901fb26 | 469 | * |
fe940d73 LW |
470 | * Note that this does not modify the bus reference count. |
471 | * Please verify that is accounted for before calling this. | |
472 | * (It is ok to call with no other effort from a driver's probe() method.) | |
1901fb26 | 473 | * |
8e9394ce | 474 | * This function must be called with the device lock held. |
0d9f837c JG |
475 | * |
476 | * Callers should prefer to use device_driver_attach() instead. | |
1901fb26 KS |
477 | */ |
478 | int device_bind_driver(struct device *dev) | |
479 | { | |
cb986b74 CH |
480 | int ret; |
481 | ||
482 | ret = driver_sysfs_add(dev); | |
b6f617df SK |
483 | if (!ret) { |
484 | device_links_force_bind(dev); | |
cb986b74 | 485 | driver_bound(dev); |
b6f617df | 486 | } |
14b6257a AS |
487 | else if (dev->bus) |
488 | blocking_notifier_call_chain(&dev->bus->p->bus_notifier, | |
489 | BUS_NOTIFY_DRIVER_NOT_BOUND, dev); | |
cb986b74 | 490 | return ret; |
1901fb26 | 491 | } |
4a3ad20c | 492 | EXPORT_SYMBOL_GPL(device_bind_driver); |
1901fb26 | 493 | |
d779249e | 494 | static atomic_t probe_count = ATOMIC_INIT(0); |
735a7ffb AM |
495 | static DECLARE_WAIT_QUEUE_HEAD(probe_waitqueue); |
496 | ||
8fd456ec SK |
497 | static ssize_t state_synced_show(struct device *dev, |
498 | struct device_attribute *attr, char *buf) | |
499 | { | |
500 | bool val; | |
501 | ||
502 | device_lock(dev); | |
503 | val = dev->state_synced; | |
504 | device_unlock(dev); | |
948b3edb | 505 | |
aa838896 | 506 | return sysfs_emit(buf, "%u\n", val); |
8fd456ec SK |
507 | } |
508 | static DEVICE_ATTR_RO(state_synced); | |
509 | ||
e1499647 CH |
510 | |
511 | static int call_driver_probe(struct device *dev, struct device_driver *drv) | |
512 | { | |
513 | int ret = 0; | |
514 | ||
515 | if (dev->bus->probe) | |
516 | ret = dev->bus->probe(dev); | |
517 | else if (drv->probe) | |
518 | ret = drv->probe(dev); | |
519 | ||
520 | switch (ret) { | |
521 | case 0: | |
522 | break; | |
523 | case -EPROBE_DEFER: | |
524 | /* Driver requested deferred probing */ | |
525 | dev_dbg(dev, "Driver %s requests probe deferral\n", drv->name); | |
526 | break; | |
527 | case -ENODEV: | |
528 | case -ENXIO: | |
529 | pr_debug("%s: probe of %s rejects match %d\n", | |
530 | drv->name, dev_name(dev), ret); | |
531 | break; | |
532 | default: | |
533 | /* driver matched but the probe failed */ | |
534 | pr_warn("%s: probe of %s failed with error %d\n", | |
535 | drv->name, dev_name(dev), ret); | |
536 | break; | |
537 | } | |
538 | ||
539 | return ret; | |
540 | } | |
541 | ||
21c7f30b | 542 | static int really_probe(struct device *dev, struct device_driver *drv) |
07e4a3e2 | 543 | { |
c5f06274 RH |
544 | bool test_remove = IS_ENABLED(CONFIG_DEBUG_TEST_DRIVER_REMOVE) && |
545 | !drv->suppress_bind_attrs; | |
45ddcb42 | 546 | int ret; |
07e4a3e2 | 547 | |
013c074f SG |
548 | if (defer_all_probes) { |
549 | /* | |
550 | * Value of defer_all_probes can be set only by | |
dbf03d65 | 551 | * device_block_probing() which, in turn, will call |
013c074f SG |
552 | * wait_for_device_probe() right after that to avoid any races. |
553 | */ | |
554 | dev_dbg(dev, "Driver %s force probe deferral\n", drv->name); | |
45ddcb42 | 555 | return -EPROBE_DEFER; |
013c074f SG |
556 | } |
557 | ||
9ed98953 RW |
558 | ret = device_links_check_suppliers(dev); |
559 | if (ret) | |
560 | return ret; | |
561 | ||
7dc72b28 | 562 | pr_debug("bus: '%s': %s: probing driver %s with device %s\n", |
1e0b2cf9 | 563 | drv->bus->name, __func__, drv->name, dev_name(dev)); |
7c35e699 GU |
564 | if (!list_empty(&dev->devres_head)) { |
565 | dev_crit(dev, "Resources present before probing\n"); | |
b292b50b TH |
566 | ret = -EBUSY; |
567 | goto done; | |
7c35e699 | 568 | } |
07e4a3e2 | 569 | |
bea5b158 | 570 | re_probe: |
07e4a3e2 | 571 | dev->driver = drv; |
ab78029e LW |
572 | |
573 | /* If using pinctrl, bind pins now before probing */ | |
574 | ret = pinctrl_bind_pins(dev); | |
575 | if (ret) | |
14b6257a | 576 | goto pinctrl_bind_failed; |
ab78029e | 577 | |
ccf640f4 CH |
578 | if (dev->bus->dma_configure) { |
579 | ret = dev->bus->dma_configure(dev); | |
580 | if (ret) | |
0b777eee | 581 | goto probe_failed; |
ccf640f4 | 582 | } |
09515ef5 | 583 | |
f04948de ZL |
584 | ret = driver_sysfs_add(dev); |
585 | if (ret) { | |
eb7fbc9f CJ |
586 | pr_err("%s: driver_sysfs_add(%s) failed\n", |
587 | __func__, dev_name(dev)); | |
1901fb26 KS |
588 | goto probe_failed; |
589 | } | |
590 | ||
e90d5532 RW |
591 | if (dev->pm_domain && dev->pm_domain->activate) { |
592 | ret = dev->pm_domain->activate(dev); | |
593 | if (ret) | |
594 | goto probe_failed; | |
595 | } | |
596 | ||
45ddcb42 CH |
597 | ret = call_driver_probe(dev, drv); |
598 | if (ret) { | |
e1499647 | 599 | /* |
ef6dcbdd CH |
600 | * Return probe errors as positive values so that the callers |
601 | * can distinguish them from other errors. | |
e1499647 | 602 | */ |
45ddcb42 | 603 | ret = -ret; |
e1499647 | 604 | goto probe_failed; |
f86db396 | 605 | } |
1901fb26 | 606 | |
f04948de ZL |
607 | ret = device_add_groups(dev, drv->dev_groups); |
608 | if (ret) { | |
23b69044 DT |
609 | dev_err(dev, "device_add_groups() failed\n"); |
610 | goto dev_groups_failed; | |
611 | } | |
612 | ||
f04948de ZL |
613 | if (dev_has_sync_state(dev)) { |
614 | ret = device_create_file(dev, &dev_attr_state_synced); | |
615 | if (ret) { | |
616 | dev_err(dev, "state_synced sysfs add failed\n"); | |
617 | goto dev_sysfs_state_synced_failed; | |
618 | } | |
8fd456ec SK |
619 | } |
620 | ||
bea5b158 RH |
621 | if (test_remove) { |
622 | test_remove = false; | |
623 | ||
8fd456ec | 624 | device_remove_file(dev, &dev_attr_state_synced); |
23b69044 DT |
625 | device_remove_groups(dev, drv->dev_groups); |
626 | ||
bdacd1b4 | 627 | if (dev->bus->remove) |
bea5b158 RH |
628 | dev->bus->remove(dev); |
629 | else if (drv->remove) | |
630 | drv->remove(dev); | |
631 | ||
632 | devres_release_all(dev); | |
4c1e238a ML |
633 | arch_teardown_dma_ops(dev); |
634 | kfree(dev->dma_range_map); | |
635 | dev->dma_range_map = NULL; | |
bea5b158 RH |
636 | driver_sysfs_remove(dev); |
637 | dev->driver = NULL; | |
638 | dev_set_drvdata(dev, NULL); | |
639 | if (dev->pm_domain && dev->pm_domain->dismiss) | |
640 | dev->pm_domain->dismiss(dev); | |
641 | pm_runtime_reinit(dev); | |
642 | ||
643 | goto re_probe; | |
644 | } | |
645 | ||
ef0eebc0 DA |
646 | pinctrl_init_done(dev); |
647 | ||
e90d5532 RW |
648 | if (dev->pm_domain && dev->pm_domain->sync) |
649 | dev->pm_domain->sync(dev); | |
650 | ||
1901fb26 | 651 | driver_bound(dev); |
7dc72b28 | 652 | pr_debug("bus: '%s': %s: bound device %s to driver %s\n", |
1e0b2cf9 | 653 | drv->bus->name, __func__, dev_name(dev), drv->name); |
d779249e | 654 | goto done; |
0d3e5a2e | 655 | |
8fd456ec SK |
656 | dev_sysfs_state_synced_failed: |
657 | device_remove_groups(dev, drv->dev_groups); | |
23b69044 DT |
658 | dev_groups_failed: |
659 | if (dev->bus->remove) | |
660 | dev->bus->remove(dev); | |
661 | else if (drv->remove) | |
662 | drv->remove(dev); | |
d779249e | 663 | probe_failed: |
14b6257a AS |
664 | if (dev->bus) |
665 | blocking_notifier_call_chain(&dev->bus->p->bus_notifier, | |
666 | BUS_NOTIFY_DRIVER_NOT_BOUND, dev); | |
667 | pinctrl_bind_failed: | |
9ed98953 | 668 | device_links_no_driver(dev); |
9ac7849e | 669 | devres_release_all(dev); |
0b777eee | 670 | arch_teardown_dma_ops(dev); |
4d1014c1 FS |
671 | kfree(dev->dma_range_map); |
672 | dev->dma_range_map = NULL; | |
1901fb26 KS |
673 | driver_sysfs_remove(dev); |
674 | dev->driver = NULL; | |
0998d063 | 675 | dev_set_drvdata(dev, NULL); |
e90d5532 RW |
676 | if (dev->pm_domain && dev->pm_domain->dismiss) |
677 | dev->pm_domain->dismiss(dev); | |
5de85b9d | 678 | pm_runtime_reinit(dev); |
08810a41 | 679 | dev_pm_set_driver_flags(dev, 0); |
d779249e | 680 | done: |
d779249e GKH |
681 | return ret; |
682 | } | |
683 | ||
0a50f61c TP |
684 | /* |
685 | * For initcall_debug, show the driver probe time. | |
686 | */ | |
687 | static int really_probe_debug(struct device *dev, struct device_driver *drv) | |
688 | { | |
e3aa745f | 689 | ktime_t calltime, rettime; |
0a50f61c TP |
690 | int ret; |
691 | ||
692 | calltime = ktime_get(); | |
693 | ret = really_probe(dev, drv); | |
694 | rettime = ktime_get(); | |
eb7fbc9f | 695 | pr_debug("probe of %s returned %d after %lld usecs\n", |
e3aa745f | 696 | dev_name(dev), ret, ktime_us_delta(rettime, calltime)); |
0a50f61c TP |
697 | return ret; |
698 | } | |
699 | ||
d779249e GKH |
700 | /** |
701 | * driver_probe_done | |
702 | * Determine if the probe sequence is finished or not. | |
703 | * | |
704 | * Should somehow figure out how to use a semaphore, not an atomic variable... | |
705 | */ | |
706 | int driver_probe_done(void) | |
707 | { | |
927f8287 AS |
708 | int local_probe_count = atomic_read(&probe_count); |
709 | ||
710 | pr_debug("%s: probe_count = %d\n", __func__, local_probe_count); | |
711 | if (local_probe_count) | |
d779249e GKH |
712 | return -EBUSY; |
713 | return 0; | |
714 | } | |
715 | ||
216773a7 AV |
716 | /** |
717 | * wait_for_device_probe | |
718 | * Wait for device probing to be completed. | |
216773a7 | 719 | */ |
b23530eb | 720 | void wait_for_device_probe(void) |
216773a7 | 721 | { |
35a67236 JS |
722 | /* wait for probe timeout */ |
723 | wait_event(probe_timeout_waitqueue, !driver_deferred_probe_timeout); | |
724 | ||
013c074f | 725 | /* wait for the deferred probe workqueue to finish */ |
2c507e46 | 726 | flush_work(&deferred_probe_work); |
013c074f | 727 | |
216773a7 | 728 | /* wait for the known devices to complete their probing */ |
b23530eb | 729 | wait_event(probe_waitqueue, atomic_read(&probe_count) == 0); |
216773a7 | 730 | async_synchronize_full(); |
216773a7 | 731 | } |
d4d5291c | 732 | EXPORT_SYMBOL_GPL(wait_for_device_probe); |
216773a7 | 733 | |
45ddcb42 | 734 | static int __driver_probe_device(struct device_driver *drv, struct device *dev) |
d779249e | 735 | { |
d779249e GKH |
736 | int ret = 0; |
737 | ||
204db60c | 738 | if (dev->p->dead || !device_is_registered(dev)) |
f2eaae19 | 739 | return -ENODEV; |
204db60c JG |
740 | if (dev->driver) |
741 | return -EBUSY; | |
d779249e | 742 | |
f2db85b6 | 743 | dev->can_match = true; |
7dc72b28 | 744 | pr_debug("bus: '%s': %s: matched device %s with driver %s\n", |
1e0b2cf9 | 745 | drv->bus->name, __func__, dev_name(dev), drv->name); |
d779249e | 746 | |
b06c0b2f | 747 | pm_runtime_get_suppliers(dev); |
ddef08dd RW |
748 | if (dev->parent) |
749 | pm_runtime_get_sync(dev->parent); | |
750 | ||
5e928f77 | 751 | pm_runtime_barrier(dev); |
0a50f61c TP |
752 | if (initcall_debug) |
753 | ret = really_probe_debug(dev, drv); | |
754 | else | |
755 | ret = really_probe(dev, drv); | |
fa180eb4 | 756 | pm_request_idle(dev); |
d779249e | 757 | |
ddef08dd RW |
758 | if (dev->parent) |
759 | pm_runtime_put(dev->parent); | |
760 | ||
b06c0b2f | 761 | pm_runtime_put_suppliers(dev); |
0d3e5a2e | 762 | return ret; |
07e4a3e2 PM |
763 | } |
764 | ||
45ddcb42 CH |
765 | /** |
766 | * driver_probe_device - attempt to bind device & driver together | |
767 | * @drv: driver to bind a device to | |
768 | * @dev: device to try to bind to the driver | |
769 | * | |
770 | * This function returns -ENODEV if the device is not registered, -EBUSY if it | |
771 | * already has a driver, 0 if the device is bound successfully and a positive | |
772 | * (inverted) error code for failures from the ->probe method. | |
773 | * | |
774 | * This function must be called with @dev lock held. When called for a | |
775 | * USB interface, @dev->parent lock must be held as well. | |
776 | * | |
777 | * If the device has a parent, runtime-resume the parent before driver probing. | |
778 | */ | |
779 | static int driver_probe_device(struct device_driver *drv, struct device *dev) | |
780 | { | |
781 | int trigger_count = atomic_read(&deferred_trigger_count); | |
782 | int ret; | |
783 | ||
784 | atomic_inc(&probe_count); | |
785 | ret = __driver_probe_device(drv, dev); | |
786 | if (ret == -EPROBE_DEFER || ret == EPROBE_DEFER) { | |
787 | driver_deferred_probe_add(dev); | |
788 | ||
789 | /* | |
790 | * Did a trigger occur while probing? Need to re-trigger if yes | |
791 | */ | |
792 | if (trigger_count != atomic_read(&deferred_trigger_count) && | |
793 | !defer_all_probes) | |
794 | driver_deferred_probe_trigger(); | |
795 | } | |
796 | atomic_dec(&probe_count); | |
797 | wake_up_all(&probe_waitqueue); | |
798 | return ret; | |
799 | } | |
800 | ||
1ea61b68 FT |
801 | static inline bool cmdline_requested_async_probing(const char *drv_name) |
802 | { | |
803 | return parse_option_str(async_probe_drv_names, drv_name); | |
804 | } | |
805 | ||
806 | /* The option format is "driver_async_probe=drv_name1,drv_name2,..." */ | |
807 | static int __init save_async_options(char *buf) | |
808 | { | |
809 | if (strlen(buf) >= ASYNC_DRV_NAMES_MAX_LEN) | |
eb7fbc9f | 810 | pr_warn("Too long list of driver names for 'driver_async_probe'!\n"); |
1ea61b68 FT |
811 | |
812 | strlcpy(async_probe_drv_names, buf, ASYNC_DRV_NAMES_MAX_LEN); | |
6ff72f1a | 813 | return 1; |
1ea61b68 FT |
814 | } |
815 | __setup("driver_async_probe=", save_async_options); | |
816 | ||
765230b5 | 817 | bool driver_allows_async_probing(struct device_driver *drv) |
2287c322 | 818 | { |
d173a137 LR |
819 | switch (drv->probe_type) { |
820 | case PROBE_PREFER_ASYNCHRONOUS: | |
f2411da7 LR |
821 | return true; |
822 | ||
d173a137 LR |
823 | case PROBE_FORCE_SYNCHRONOUS: |
824 | return false; | |
825 | ||
826 | default: | |
1ea61b68 FT |
827 | if (cmdline_requested_async_probing(drv->name)) |
828 | return true; | |
829 | ||
80c6e146 | 830 | if (module_requested_async_probing(drv->owner)) |
d173a137 | 831 | return true; |
f2411da7 | 832 | |
d173a137 LR |
833 | return false; |
834 | } | |
765230b5 DT |
835 | } |
836 | ||
837 | struct device_attach_data { | |
838 | struct device *dev; | |
839 | ||
840 | /* | |
841 | * Indicates whether we are are considering asynchronous probing or | |
842 | * not. Only initial binding after device or driver registration | |
843 | * (including deferral processing) may be done asynchronously, the | |
844 | * rest is always synchronous, as we expect it is being done by | |
845 | * request from userspace. | |
846 | */ | |
847 | bool check_async; | |
848 | ||
849 | /* | |
850 | * Indicates if we are binding synchronous or asynchronous drivers. | |
851 | * When asynchronous probing is enabled we'll execute 2 passes | |
852 | * over drivers: first pass doing synchronous probing and second | |
853 | * doing asynchronous probing (if synchronous did not succeed - | |
854 | * most likely because there was no driver requiring synchronous | |
855 | * probing - and we found asynchronous driver during first pass). | |
856 | * The 2 passes are done because we can't shoot asynchronous | |
857 | * probe for given device and driver from bus_for_each_drv() since | |
858 | * driver pointer is not guaranteed to stay valid once | |
859 | * bus_for_each_drv() iterates to the next driver on the bus. | |
860 | */ | |
861 | bool want_async; | |
862 | ||
863 | /* | |
864 | * We'll set have_async to 'true' if, while scanning for matching | |
865 | * driver, we'll encounter one that requests asynchronous probing. | |
866 | */ | |
867 | bool have_async; | |
868 | }; | |
869 | ||
870 | static int __device_attach_driver(struct device_driver *drv, void *_data) | |
871 | { | |
872 | struct device_attach_data *data = _data; | |
873 | struct device *dev = data->dev; | |
874 | bool async_allowed; | |
656b8035 | 875 | int ret; |
765230b5 | 876 | |
656b8035 TV |
877 | ret = driver_match_device(drv, dev); |
878 | if (ret == 0) { | |
879 | /* no match */ | |
49b420a1 | 880 | return 0; |
656b8035 TV |
881 | } else if (ret == -EPROBE_DEFER) { |
882 | dev_dbg(dev, "Device match requests probe deferral\n"); | |
f2db85b6 | 883 | dev->can_match = true; |
656b8035 TV |
884 | driver_deferred_probe_add(dev); |
885 | } else if (ret < 0) { | |
eb7fbc9f | 886 | dev_dbg(dev, "Bus failed to match device: %d\n", ret); |
656b8035 TV |
887 | return ret; |
888 | } /* ret > 0 means positive match */ | |
49b420a1 | 889 | |
765230b5 DT |
890 | async_allowed = driver_allows_async_probing(drv); |
891 | ||
892 | if (async_allowed) | |
893 | data->have_async = true; | |
894 | ||
895 | if (data->check_async && async_allowed != data->want_async) | |
896 | return 0; | |
897 | ||
ef6dcbdd CH |
898 | /* |
899 | * Ignore errors returned by ->probe so that the next driver can try | |
900 | * its luck. | |
901 | */ | |
902 | ret = driver_probe_device(drv, dev); | |
903 | if (ret < 0) | |
904 | return ret; | |
905 | return ret == 0; | |
2287c322 PM |
906 | } |
907 | ||
765230b5 DT |
908 | static void __device_attach_async_helper(void *_dev, async_cookie_t cookie) |
909 | { | |
910 | struct device *dev = _dev; | |
911 | struct device_attach_data data = { | |
912 | .dev = dev, | |
913 | .check_async = true, | |
914 | .want_async = true, | |
915 | }; | |
916 | ||
917 | device_lock(dev); | |
918 | ||
3451a495 AD |
919 | /* |
920 | * Check if device has already been removed or claimed. This may | |
921 | * happen with driver loading, device discovery/registration, | |
922 | * and deferred probe processing happens all at once with | |
923 | * multiple threads. | |
924 | */ | |
925 | if (dev->p->dead || dev->driver) | |
926 | goto out_unlock; | |
927 | ||
ddef08dd RW |
928 | if (dev->parent) |
929 | pm_runtime_get_sync(dev->parent); | |
930 | ||
765230b5 DT |
931 | bus_for_each_drv(dev->bus, NULL, &data, __device_attach_driver); |
932 | dev_dbg(dev, "async probe completed\n"); | |
933 | ||
934 | pm_request_idle(dev); | |
935 | ||
ddef08dd RW |
936 | if (dev->parent) |
937 | pm_runtime_put(dev->parent); | |
3451a495 | 938 | out_unlock: |
765230b5 DT |
939 | device_unlock(dev); |
940 | ||
941 | put_device(dev); | |
942 | } | |
943 | ||
802a87fd | 944 | static int __device_attach(struct device *dev, bool allow_async) |
07e4a3e2 | 945 | { |
0d3e5a2e PM |
946 | int ret = 0; |
947 | ||
8e9394ce | 948 | device_lock(dev); |
65488832 LW |
949 | if (dev->p->dead) { |
950 | goto out_unlock; | |
951 | } else if (dev->driver) { | |
6b9cb427 | 952 | if (device_is_bound(dev)) { |
8497d6a2 SO |
953 | ret = 1; |
954 | goto out_unlock; | |
955 | } | |
f86db396 AM |
956 | ret = device_bind_driver(dev); |
957 | if (ret == 0) | |
958 | ret = 1; | |
c6a46696 CH |
959 | else { |
960 | dev->driver = NULL; | |
961 | ret = 0; | |
962 | } | |
21c7f30b | 963 | } else { |
765230b5 DT |
964 | struct device_attach_data data = { |
965 | .dev = dev, | |
966 | .check_async = allow_async, | |
967 | .want_async = false, | |
968 | }; | |
969 | ||
ddef08dd RW |
970 | if (dev->parent) |
971 | pm_runtime_get_sync(dev->parent); | |
972 | ||
765230b5 DT |
973 | ret = bus_for_each_drv(dev->bus, NULL, &data, |
974 | __device_attach_driver); | |
975 | if (!ret && allow_async && data.have_async) { | |
976 | /* | |
977 | * If we could not find appropriate driver | |
978 | * synchronously and we are allowed to do | |
979 | * async probes and there are drivers that | |
980 | * want to probe asynchronously, we'll | |
981 | * try them. | |
982 | */ | |
983 | dev_dbg(dev, "scheduling asynchronous probe\n"); | |
984 | get_device(dev); | |
c37e20ea | 985 | async_schedule_dev(__device_attach_async_helper, dev); |
765230b5 DT |
986 | } else { |
987 | pm_request_idle(dev); | |
988 | } | |
ddef08dd RW |
989 | |
990 | if (dev->parent) | |
991 | pm_runtime_put(dev->parent); | |
21c7f30b | 992 | } |
8497d6a2 | 993 | out_unlock: |
8e9394ce | 994 | device_unlock(dev); |
0d3e5a2e | 995 | return ret; |
2287c322 | 996 | } |
765230b5 DT |
997 | |
998 | /** | |
999 | * device_attach - try to attach device to a driver. | |
1000 | * @dev: device. | |
1001 | * | |
1002 | * Walk the list of drivers that the bus has and call | |
1003 | * driver_probe_device() for each pair. If a compatible | |
1004 | * pair is found, break out and return. | |
1005 | * | |
1006 | * Returns 1 if the device was bound to a driver; | |
1007 | * 0 if no matching driver was found; | |
1008 | * -ENODEV if the device is not registered. | |
1009 | * | |
1010 | * When called for a USB interface, @dev->parent lock must be held. | |
1011 | */ | |
1012 | int device_attach(struct device *dev) | |
1013 | { | |
1014 | return __device_attach(dev, false); | |
1015 | } | |
4a3ad20c | 1016 | EXPORT_SYMBOL_GPL(device_attach); |
2287c322 | 1017 | |
765230b5 DT |
1018 | void device_initial_probe(struct device *dev) |
1019 | { | |
1020 | __device_attach(dev, true); | |
1021 | } | |
1022 | ||
ed88747c AD |
1023 | /* |
1024 | * __device_driver_lock - acquire locks needed to manipulate dev->drv | |
1025 | * @dev: Device we will update driver info for | |
1026 | * @parent: Parent device. Needed if the bus requires parent lock | |
1027 | * | |
1028 | * This function will take the required locks for manipulating dev->drv. | |
1029 | * Normally this will just be the @dev lock, but when called for a USB | |
1030 | * interface, @parent lock will be held as well. | |
1031 | */ | |
1032 | static void __device_driver_lock(struct device *dev, struct device *parent) | |
1033 | { | |
1034 | if (parent && dev->bus->need_parent_lock) | |
1035 | device_lock(parent); | |
1036 | device_lock(dev); | |
1037 | } | |
1038 | ||
1039 | /* | |
1040 | * __device_driver_unlock - release locks needed to manipulate dev->drv | |
1041 | * @dev: Device we will update driver info for | |
1042 | * @parent: Parent device. Needed if the bus requires parent lock | |
1043 | * | |
1044 | * This function will release the required locks for manipulating dev->drv. | |
1045 | * Normally this will just be the the @dev lock, but when called for a | |
1046 | * USB interface, @parent lock will be released as well. | |
1047 | */ | |
1048 | static void __device_driver_unlock(struct device *dev, struct device *parent) | |
1049 | { | |
1050 | device_unlock(dev); | |
1051 | if (parent && dev->bus->need_parent_lock) | |
1052 | device_unlock(parent); | |
1053 | } | |
1054 | ||
1055 | /** | |
1056 | * device_driver_attach - attach a specific driver to a specific device | |
1057 | * @drv: Driver to attach | |
1058 | * @dev: Device to attach it to | |
1059 | * | |
1060 | * Manually attach driver to a device. Will acquire both @dev lock and | |
ef6dcbdd | 1061 | * @dev->parent lock if needed. Returns 0 on success, -ERR on failure. |
ed88747c AD |
1062 | */ |
1063 | int device_driver_attach(struct device_driver *drv, struct device *dev) | |
1064 | { | |
204db60c | 1065 | int ret; |
ed88747c AD |
1066 | |
1067 | __device_driver_lock(dev, dev->parent); | |
45ddcb42 | 1068 | ret = __driver_probe_device(drv, dev); |
ed88747c AD |
1069 | __device_driver_unlock(dev, dev->parent); |
1070 | ||
ef6dcbdd CH |
1071 | /* also return probe errors as normal negative errnos */ |
1072 | if (ret > 0) | |
1073 | ret = -ret; | |
45ddcb42 CH |
1074 | if (ret == -EPROBE_DEFER) |
1075 | return -EAGAIN; | |
ed88747c AD |
1076 | return ret; |
1077 | } | |
0d9f837c | 1078 | EXPORT_SYMBOL_GPL(device_driver_attach); |
ed88747c | 1079 | |
ef0ff683 AD |
1080 | static void __driver_attach_async_helper(void *_dev, async_cookie_t cookie) |
1081 | { | |
1082 | struct device *dev = _dev; | |
1083 | struct device_driver *drv; | |
204db60c | 1084 | int ret; |
ef0ff683 AD |
1085 | |
1086 | __device_driver_lock(dev, dev->parent); | |
ef0ff683 | 1087 | drv = dev->p->async_driver; |
204db60c | 1088 | ret = driver_probe_device(drv, dev); |
ef0ff683 AD |
1089 | __device_driver_unlock(dev, dev->parent); |
1090 | ||
1091 | dev_dbg(dev, "driver %s async attach completed: %d\n", drv->name, ret); | |
1092 | ||
1093 | put_device(dev); | |
1094 | } | |
1095 | ||
4a3ad20c | 1096 | static int __driver_attach(struct device *dev, void *data) |
2287c322 | 1097 | { |
4a3ad20c | 1098 | struct device_driver *drv = data; |
656b8035 | 1099 | int ret; |
0d3e5a2e PM |
1100 | |
1101 | /* | |
1102 | * Lock device and try to bind to it. We drop the error | |
1103 | * here and always return 0, because we need to keep trying | |
1104 | * to bind to devices and some drivers will return an error | |
1105 | * simply if it didn't support the device. | |
1106 | * | |
1107 | * driver_probe_device() will spit a warning if there | |
1108 | * is an error. | |
1109 | */ | |
1110 | ||
656b8035 TV |
1111 | ret = driver_match_device(drv, dev); |
1112 | if (ret == 0) { | |
1113 | /* no match */ | |
6cd49586 | 1114 | return 0; |
656b8035 TV |
1115 | } else if (ret == -EPROBE_DEFER) { |
1116 | dev_dbg(dev, "Device match requests probe deferral\n"); | |
f2db85b6 | 1117 | dev->can_match = true; |
656b8035 TV |
1118 | driver_deferred_probe_add(dev); |
1119 | } else if (ret < 0) { | |
eb7fbc9f | 1120 | dev_dbg(dev, "Bus failed to match device: %d\n", ret); |
656b8035 TV |
1121 | return ret; |
1122 | } /* ret > 0 means positive match */ | |
6cd49586 | 1123 | |
ef0ff683 AD |
1124 | if (driver_allows_async_probing(drv)) { |
1125 | /* | |
1126 | * Instead of probing the device synchronously we will | |
1127 | * probe it asynchronously to allow for more parallelism. | |
1128 | * | |
1129 | * We only take the device lock here in order to guarantee | |
1130 | * that the dev->driver and async_driver fields are protected | |
1131 | */ | |
1132 | dev_dbg(dev, "probing driver %s asynchronously\n", drv->name); | |
1133 | device_lock(dev); | |
1134 | if (!dev->driver) { | |
1135 | get_device(dev); | |
1136 | dev->p->async_driver = drv; | |
c37e20ea | 1137 | async_schedule_dev(__driver_attach_async_helper, dev); |
ef0ff683 AD |
1138 | } |
1139 | device_unlock(dev); | |
1140 | return 0; | |
1141 | } | |
1142 | ||
ef6dcbdd CH |
1143 | __device_driver_lock(dev, dev->parent); |
1144 | driver_probe_device(drv, dev); | |
1145 | __device_driver_unlock(dev, dev->parent); | |
0d3e5a2e | 1146 | |
07e4a3e2 PM |
1147 | return 0; |
1148 | } | |
1149 | ||
1150 | /** | |
4a3ad20c GKH |
1151 | * driver_attach - try to bind driver to devices. |
1152 | * @drv: driver. | |
07e4a3e2 | 1153 | * |
4a3ad20c GKH |
1154 | * Walk the list of devices that the bus has on it and try to |
1155 | * match the driver with each one. If driver_probe_device() | |
1156 | * returns 0 and the @dev->driver is set, we've found a | |
1157 | * compatible pair. | |
07e4a3e2 | 1158 | */ |
4a3ad20c | 1159 | int driver_attach(struct device_driver *drv) |
07e4a3e2 | 1160 | { |
f86db396 | 1161 | return bus_for_each_dev(drv->bus, NULL, drv, __driver_attach); |
07e4a3e2 | 1162 | } |
4a3ad20c | 1163 | EXPORT_SYMBOL_GPL(driver_attach); |
07e4a3e2 | 1164 | |
ab71c6f0 | 1165 | /* |
8e9394ce GKH |
1166 | * __device_release_driver() must be called with @dev lock held. |
1167 | * When called for a USB interface, @dev->parent lock must be held as well. | |
07e4a3e2 | 1168 | */ |
9ed98953 | 1169 | static void __device_release_driver(struct device *dev, struct device *parent) |
07e4a3e2 | 1170 | { |
4a3ad20c | 1171 | struct device_driver *drv; |
07e4a3e2 | 1172 | |
ef2c5174 | 1173 | drv = dev->driver; |
c95a6b05 | 1174 | if (drv) { |
9226c504 RW |
1175 | pm_runtime_get_sync(dev); |
1176 | ||
9ed98953 | 1177 | while (device_links_busy(dev)) { |
ed88747c | 1178 | __device_driver_unlock(dev, parent); |
9ed98953 RW |
1179 | |
1180 | device_links_unbind_consumers(dev); | |
9ed98953 | 1181 | |
ed88747c | 1182 | __device_driver_lock(dev, parent); |
9ed98953 RW |
1183 | /* |
1184 | * A concurrent invocation of the same function might | |
1185 | * have released the driver successfully while this one | |
1186 | * was waiting, so check for that. | |
1187 | */ | |
9226c504 RW |
1188 | if (dev->driver != drv) { |
1189 | pm_runtime_put(dev); | |
9ed98953 | 1190 | return; |
9226c504 | 1191 | } |
9ed98953 RW |
1192 | } |
1193 | ||
1901fb26 | 1194 | driver_sysfs_remove(dev); |
0d3e5a2e | 1195 | |
116af378 | 1196 | if (dev->bus) |
c6f7e72a | 1197 | blocking_notifier_call_chain(&dev->bus->p->bus_notifier, |
116af378 BH |
1198 | BUS_NOTIFY_UNBIND_DRIVER, |
1199 | dev); | |
1200 | ||
baab52de | 1201 | pm_runtime_put_sync(dev); |
e1866b33 | 1202 | |
8fd456ec | 1203 | device_remove_file(dev, &dev_attr_state_synced); |
23b69044 DT |
1204 | device_remove_groups(dev, drv->dev_groups); |
1205 | ||
0f836ca4 | 1206 | if (dev->bus && dev->bus->remove) |
594c8281 RK |
1207 | dev->bus->remove(dev); |
1208 | else if (drv->remove) | |
0d3e5a2e | 1209 | drv->remove(dev); |
9ed98953 RW |
1210 | |
1211 | device_links_driver_cleanup(dev); | |
09515ef5 | 1212 | |
9ac7849e | 1213 | devres_release_all(dev); |
376991db | 1214 | arch_teardown_dma_ops(dev); |
4c1e238a ML |
1215 | kfree(dev->dma_range_map); |
1216 | dev->dma_range_map = NULL; | |
0d3e5a2e | 1217 | dev->driver = NULL; |
0998d063 | 1218 | dev_set_drvdata(dev, NULL); |
e90d5532 RW |
1219 | if (dev->pm_domain && dev->pm_domain->dismiss) |
1220 | dev->pm_domain->dismiss(dev); | |
5de85b9d | 1221 | pm_runtime_reinit(dev); |
08810a41 | 1222 | dev_pm_set_driver_flags(dev, 0); |
e90d5532 | 1223 | |
8940b4f3 | 1224 | klist_remove(&dev->p->knode_driver); |
aa8e54b5 | 1225 | device_pm_check_callbacks(dev); |
309b7d60 JR |
1226 | if (dev->bus) |
1227 | blocking_notifier_call_chain(&dev->bus->p->bus_notifier, | |
1228 | BUS_NOTIFY_UNBOUND_DRIVER, | |
1229 | dev); | |
1455cf8d DT |
1230 | |
1231 | kobject_uevent(&dev->kobj, KOBJ_UNBIND); | |
0d3e5a2e | 1232 | } |
07e4a3e2 PM |
1233 | } |
1234 | ||
9ed98953 RW |
1235 | void device_release_driver_internal(struct device *dev, |
1236 | struct device_driver *drv, | |
1237 | struct device *parent) | |
4bdb3550 | 1238 | { |
ed88747c | 1239 | __device_driver_lock(dev, parent); |
4bdb3550 | 1240 | |
4bdb3550 | 1241 | if (!drv || drv == dev->driver) |
9ed98953 | 1242 | __device_release_driver(dev, parent); |
4bdb3550 | 1243 | |
ed88747c | 1244 | __device_driver_unlock(dev, parent); |
4bdb3550 RW |
1245 | } |
1246 | ||
ab71c6f0 | 1247 | /** |
4a3ad20c GKH |
1248 | * device_release_driver - manually detach device from driver. |
1249 | * @dev: device. | |
ab71c6f0 | 1250 | * |
4a3ad20c | 1251 | * Manually detach device from driver. |
8e9394ce | 1252 | * When called for a USB interface, @dev->parent lock must be held. |
9ed98953 RW |
1253 | * |
1254 | * If this function is to be called with @dev->parent lock held, ensure that | |
1255 | * the device's consumers are unbound in advance or that their locks can be | |
1256 | * acquired under the @dev->parent lock. | |
ab71c6f0 | 1257 | */ |
4a3ad20c | 1258 | void device_release_driver(struct device *dev) |
94e7b1c5 | 1259 | { |
c95a6b05 AS |
1260 | /* |
1261 | * If anyone calls device_release_driver() recursively from | |
1262 | * within their ->remove callback for the same device, they | |
1263 | * will deadlock right here. | |
1264 | */ | |
4bdb3550 | 1265 | device_release_driver_internal(dev, NULL, NULL); |
94e7b1c5 | 1266 | } |
4a3ad20c | 1267 | EXPORT_SYMBOL_GPL(device_release_driver); |
c95a6b05 | 1268 | |
ed88747c AD |
1269 | /** |
1270 | * device_driver_detach - detach driver from a specific device | |
1271 | * @dev: device to detach driver from | |
1272 | * | |
1273 | * Detach driver from device. Will acquire both @dev lock and @dev->parent | |
1274 | * lock if needed. | |
1275 | */ | |
1276 | void device_driver_detach(struct device *dev) | |
1277 | { | |
1278 | device_release_driver_internal(dev, NULL, dev->parent); | |
1279 | } | |
1280 | ||
07e4a3e2 PM |
1281 | /** |
1282 | * driver_detach - detach driver from all devices it controls. | |
1283 | * @drv: driver. | |
1284 | */ | |
4a3ad20c | 1285 | void driver_detach(struct device_driver *drv) |
07e4a3e2 | 1286 | { |
8940b4f3 | 1287 | struct device_private *dev_prv; |
4a3ad20c | 1288 | struct device *dev; |
c95a6b05 | 1289 | |
c37d721c AD |
1290 | if (driver_allows_async_probing(drv)) |
1291 | async_synchronize_full(); | |
1292 | ||
c95a6b05 | 1293 | for (;;) { |
e5dd1278 GKH |
1294 | spin_lock(&drv->p->klist_devices.k_lock); |
1295 | if (list_empty(&drv->p->klist_devices.k_list)) { | |
1296 | spin_unlock(&drv->p->klist_devices.k_lock); | |
c95a6b05 AS |
1297 | break; |
1298 | } | |
a3a87d66 | 1299 | dev_prv = list_last_entry(&drv->p->klist_devices.k_list, |
8940b4f3 GKH |
1300 | struct device_private, |
1301 | knode_driver.n_node); | |
1302 | dev = dev_prv->device; | |
c95a6b05 | 1303 | get_device(dev); |
e5dd1278 | 1304 | spin_unlock(&drv->p->klist_devices.k_lock); |
4bdb3550 | 1305 | device_release_driver_internal(dev, drv, dev->parent); |
c95a6b05 AS |
1306 | put_device(dev); |
1307 | } | |
07e4a3e2 | 1308 | } |