Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * drivers/base/dd.c - The core device/driver interactions.
4 *
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.
8 *
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'.
12 *
13 * Copyright (c) 2002-5 Patrick Mochel
14 * Copyright (c) 2002-3 Open Source Development Labs
15 * Copyright (c) 2007-2009 Greg Kroah-Hartman <gregkh@suse.de>
16 * Copyright (c) 2007-2009 Novell Inc.
17 */
18
19#include <linux/debugfs.h>
20#include <linux/device.h>
21#include <linux/delay.h>
22#include <linux/dma-mapping.h>
23#include <linux/init.h>
24#include <linux/module.h>
25#include <linux/kthread.h>
26#include <linux/wait.h>
27#include <linux/async.h>
28#include <linux/pm_runtime.h>
29#include <linux/pinctrl/devinfo.h>
30
31#include "base.h"
32#include "power/power.h"
33
34/*
35 * Deferred Probe infrastructure.
36 *
37 * Sometimes driver probe order matters, but the kernel doesn't always have
38 * dependency information which means some drivers will get probed before a
39 * resource it depends on is available. For example, an SDHCI driver may
40 * first need a GPIO line from an i2c GPIO controller before it can be
41 * initialized. If a required resource is not available yet, a driver can
42 * request probing to be deferred by returning -EPROBE_DEFER from its probe hook
43 *
44 * Deferred probe maintains two lists of devices, a pending list and an active
45 * list. A driver returning -EPROBE_DEFER causes the device to be added to the
46 * pending list. A successful driver probe will trigger moving all devices
47 * from the pending to the active list so that the workqueue will eventually
48 * retry them.
49 *
50 * The deferred_probe_mutex must be held any time the deferred_probe_*_list
51 * of the (struct device*)->p->deferred_probe pointers are manipulated
52 */
53static DEFINE_MUTEX(deferred_probe_mutex);
54static LIST_HEAD(deferred_probe_pending_list);
55static LIST_HEAD(deferred_probe_active_list);
56static atomic_t deferred_trigger_count = ATOMIC_INIT(0);
57static struct dentry *deferred_devices;
58static bool initcalls_done;
59
60/*
61 * In some cases, like suspend to RAM or hibernation, It might be reasonable
62 * to prohibit probing of devices as it could be unsafe.
63 * Once defer_all_probes is true all drivers probes will be forcibly deferred.
64 */
65static bool defer_all_probes;
66
67/*
68 * deferred_probe_work_func() - Retry probing devices in the active list.
69 */
70static void deferred_probe_work_func(struct work_struct *work)
71{
72 struct device *dev;
73 struct device_private *private;
74 /*
75 * This block processes every device in the deferred 'active' list.
76 * Each device is removed from the active list and passed to
77 * bus_probe_device() to re-attempt the probe. The loop continues
78 * until every device in the active list is removed and retried.
79 *
80 * Note: Once the device is removed from the list and the mutex is
81 * released, it is possible for the device get freed by another thread
82 * and cause a illegal pointer dereference. This code uses
83 * get/put_device() to ensure the device structure cannot disappear
84 * from under our feet.
85 */
86 mutex_lock(&deferred_probe_mutex);
87 while (!list_empty(&deferred_probe_active_list)) {
88 private = list_first_entry(&deferred_probe_active_list,
89 typeof(*dev->p), deferred_probe);
90 dev = private->device;
91 list_del_init(&private->deferred_probe);
92
93 get_device(dev);
94
95 /*
96 * Drop the mutex while probing each device; the probe path may
97 * manipulate the deferred list
98 */
99 mutex_unlock(&deferred_probe_mutex);
100
101 /*
102 * Force the device to the end of the dpm_list since
103 * the PM code assumes that the order we add things to
104 * the list is a good order for suspend but deferred
105 * probe makes that very unsafe.
106 */
107 device_pm_move_to_tail(dev);
108
109 dev_dbg(dev, "Retrying from deferred list\n");
110 bus_probe_device(dev);
111 mutex_lock(&deferred_probe_mutex);
112
113 put_device(dev);
114 }
115 mutex_unlock(&deferred_probe_mutex);
116}
117static DECLARE_WORK(deferred_probe_work, deferred_probe_work_func);
118
119static void driver_deferred_probe_add(struct device *dev)
120{
121 mutex_lock(&deferred_probe_mutex);
122 if (list_empty(&dev->p->deferred_probe)) {
123 dev_dbg(dev, "Added to deferred list\n");
124 list_add_tail(&dev->p->deferred_probe, &deferred_probe_pending_list);
125 }
126 mutex_unlock(&deferred_probe_mutex);
127}
128
129void driver_deferred_probe_del(struct device *dev)
130{
131 mutex_lock(&deferred_probe_mutex);
132 if (!list_empty(&dev->p->deferred_probe)) {
133 dev_dbg(dev, "Removed from deferred list\n");
134 list_del_init(&dev->p->deferred_probe);
135 }
136 mutex_unlock(&deferred_probe_mutex);
137}
138
139static bool driver_deferred_probe_enable = false;
140/**
141 * driver_deferred_probe_trigger() - Kick off re-probing deferred devices
142 *
143 * This functions moves all devices from the pending list to the active
144 * list and schedules the deferred probe workqueue to process them. It
145 * should be called anytime a driver is successfully bound to a device.
146 *
147 * Note, there is a race condition in multi-threaded probe. In the case where
148 * more than one device is probing at the same time, it is possible for one
149 * probe to complete successfully while another is about to defer. If the second
150 * depends on the first, then it will get put on the pending list after the
151 * trigger event has already occurred and will be stuck there.
152 *
153 * The atomic 'deferred_trigger_count' is used to determine if a successful
154 * trigger has occurred in the midst of probing a driver. If the trigger count
155 * changes in the midst of a probe, then deferred processing should be triggered
156 * again.
157 */
158static void driver_deferred_probe_trigger(void)
159{
160 if (!driver_deferred_probe_enable)
161 return;
162
163 /*
164 * A successful probe means that all the devices in the pending list
165 * should be triggered to be reprobed. Move all the deferred devices
166 * into the active list so they can be retried by the workqueue
167 */
168 mutex_lock(&deferred_probe_mutex);
169 atomic_inc(&deferred_trigger_count);
170 list_splice_tail_init(&deferred_probe_pending_list,
171 &deferred_probe_active_list);
172 mutex_unlock(&deferred_probe_mutex);
173
174 /*
175 * Kick the re-probe thread. It may already be scheduled, but it is
176 * safe to kick it again.
177 */
178 schedule_work(&deferred_probe_work);
179}
180
181/**
182 * device_block_probing() - Block/defere device's probes
183 *
184 * It will disable probing of devices and defer their probes instead.
185 */
186void device_block_probing(void)
187{
188 defer_all_probes = true;
189 /* sync with probes to avoid races. */
190 wait_for_device_probe();
191}
192
193/**
194 * device_unblock_probing() - Unblock/enable device's probes
195 *
196 * It will restore normal behavior and trigger re-probing of deferred
197 * devices.
198 */
199void device_unblock_probing(void)
200{
201 defer_all_probes = false;
202 driver_deferred_probe_trigger();
203}
204
205/*
206 * deferred_devs_show() - Show the devices in the deferred probe pending list.
207 */
208static int deferred_devs_show(struct seq_file *s, void *data)
209{
210 struct device_private *curr;
211
212 mutex_lock(&deferred_probe_mutex);
213
214 list_for_each_entry(curr, &deferred_probe_pending_list, deferred_probe)
215 seq_printf(s, "%s\n", dev_name(curr->device));
216
217 mutex_unlock(&deferred_probe_mutex);
218
219 return 0;
220}
221DEFINE_SHOW_ATTRIBUTE(deferred_devs);
222
223static int deferred_probe_timeout = -1;
224static int __init deferred_probe_timeout_setup(char *str)
225{
226 deferred_probe_timeout = simple_strtol(str, NULL, 10);
227 return 1;
228}
229__setup("deferred_probe_timeout=", deferred_probe_timeout_setup);
230
231/**
232 * driver_deferred_probe_check_state() - Check deferred probe state
233 * @dev: device to check
234 *
235 * Returns -ENODEV if init is done and all built-in drivers have had a chance
236 * to probe (i.e. initcalls are done), -ETIMEDOUT if deferred probe debug
237 * timeout has expired, or -EPROBE_DEFER if none of those conditions are met.
238 *
239 * Drivers or subsystems can opt-in to calling this function instead of directly
240 * returning -EPROBE_DEFER.
241 */
242int driver_deferred_probe_check_state(struct device *dev)
243{
244 if (initcalls_done) {
245 if (!deferred_probe_timeout) {
246 dev_WARN(dev, "deferred probe timeout, ignoring dependency");
247 return -ETIMEDOUT;
248 }
249 dev_warn(dev, "ignoring dependency for device, assuming no driver");
250 return -ENODEV;
251 }
252 return -EPROBE_DEFER;
253}
254
255static void deferred_probe_timeout_work_func(struct work_struct *work)
256{
257 struct device_private *private, *p;
258
259 deferred_probe_timeout = 0;
260 driver_deferred_probe_trigger();
261 flush_work(&deferred_probe_work);
262
263 list_for_each_entry_safe(private, p, &deferred_probe_pending_list, deferred_probe)
264 dev_info(private->device, "deferred probe pending");
265}
266static DECLARE_DELAYED_WORK(deferred_probe_timeout_work, deferred_probe_timeout_work_func);
267
268/**
269 * deferred_probe_initcall() - Enable probing of deferred devices
270 *
271 * We don't want to get in the way when the bulk of drivers are getting probed.
272 * Instead, this initcall makes sure that deferred probing is delayed until
273 * late_initcall time.
274 */
275static int deferred_probe_initcall(void)
276{
277 deferred_devices = debugfs_create_file("devices_deferred", 0444, NULL,
278 NULL, &deferred_devs_fops);
279
280 driver_deferred_probe_enable = true;
281 driver_deferred_probe_trigger();
282 /* Sort as many dependencies as possible before exiting initcalls */
283 flush_work(&deferred_probe_work);
284 initcalls_done = true;
285
286 /*
287 * Trigger deferred probe again, this time we won't defer anything
288 * that is optional
289 */
290 driver_deferred_probe_trigger();
291 flush_work(&deferred_probe_work);
292
293 if (deferred_probe_timeout > 0) {
294 schedule_delayed_work(&deferred_probe_timeout_work,
295 deferred_probe_timeout * HZ);
296 }
297 return 0;
298}
299late_initcall(deferred_probe_initcall);
300
301static void __exit deferred_probe_exit(void)
302{
303 debugfs_remove_recursive(deferred_devices);
304}
305__exitcall(deferred_probe_exit);
306
307/**
308 * device_is_bound() - Check if device is bound to a driver
309 * @dev: device to check
310 *
311 * Returns true if passed device has already finished probing successfully
312 * against a driver.
313 *
314 * This function must be called with the device lock held.
315 */
316bool device_is_bound(struct device *dev)
317{
318 return dev->p && klist_node_attached(&dev->p->knode_driver);
319}
320
321static void driver_bound(struct device *dev)
322{
323 if (device_is_bound(dev)) {
324 printk(KERN_WARNING "%s: device %s already bound\n",
325 __func__, kobject_name(&dev->kobj));
326 return;
327 }
328
329 pr_debug("driver: '%s': %s: bound to device '%s'\n", dev->driver->name,
330 __func__, dev_name(dev));
331
332 klist_add_tail(&dev->p->knode_driver, &dev->driver->p->klist_devices);
333 device_links_driver_bound(dev);
334
335 device_pm_check_callbacks(dev);
336
337 /*
338 * Make sure the device is no longer in one of the deferred lists and
339 * kick off retrying all pending devices
340 */
341 driver_deferred_probe_del(dev);
342 driver_deferred_probe_trigger();
343
344 if (dev->bus)
345 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
346 BUS_NOTIFY_BOUND_DRIVER, dev);
347
348 kobject_uevent(&dev->kobj, KOBJ_BIND);
349}
350
351static ssize_t coredump_store(struct device *dev, struct device_attribute *attr,
352 const char *buf, size_t count)
353{
354 device_lock(dev);
355 dev->driver->coredump(dev);
356 device_unlock(dev);
357
358 return count;
359}
360static DEVICE_ATTR_WO(coredump);
361
362static int driver_sysfs_add(struct device *dev)
363{
364 int ret;
365
366 if (dev->bus)
367 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
368 BUS_NOTIFY_BIND_DRIVER, dev);
369
370 ret = sysfs_create_link(&dev->driver->p->kobj, &dev->kobj,
371 kobject_name(&dev->kobj));
372 if (ret)
373 goto fail;
374
375 ret = sysfs_create_link(&dev->kobj, &dev->driver->p->kobj,
376 "driver");
377 if (ret)
378 goto rm_dev;
379
380 if (!IS_ENABLED(CONFIG_DEV_COREDUMP) || !dev->driver->coredump ||
381 !device_create_file(dev, &dev_attr_coredump))
382 return 0;
383
384 sysfs_remove_link(&dev->kobj, "driver");
385
386rm_dev:
387 sysfs_remove_link(&dev->driver->p->kobj,
388 kobject_name(&dev->kobj));
389
390fail:
391 return ret;
392}
393
394static void driver_sysfs_remove(struct device *dev)
395{
396 struct device_driver *drv = dev->driver;
397
398 if (drv) {
399 if (drv->coredump)
400 device_remove_file(dev, &dev_attr_coredump);
401 sysfs_remove_link(&drv->p->kobj, kobject_name(&dev->kobj));
402 sysfs_remove_link(&dev->kobj, "driver");
403 }
404}
405
406/**
407 * device_bind_driver - bind a driver to one device.
408 * @dev: device.
409 *
410 * Allow manual attachment of a driver to a device.
411 * Caller must have already set @dev->driver.
412 *
413 * Note that this does not modify the bus reference count
414 * nor take the bus's rwsem. Please verify those are accounted
415 * for before calling this. (It is ok to call with no other effort
416 * from a driver's probe() method.)
417 *
418 * This function must be called with the device lock held.
419 */
420int device_bind_driver(struct device *dev)
421{
422 int ret;
423
424 ret = driver_sysfs_add(dev);
425 if (!ret)
426 driver_bound(dev);
427 else if (dev->bus)
428 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
429 BUS_NOTIFY_DRIVER_NOT_BOUND, dev);
430 return ret;
431}
432EXPORT_SYMBOL_GPL(device_bind_driver);
433
434static atomic_t probe_count = ATOMIC_INIT(0);
435static DECLARE_WAIT_QUEUE_HEAD(probe_waitqueue);
436
437static void driver_deferred_probe_add_trigger(struct device *dev,
438 int local_trigger_count)
439{
440 driver_deferred_probe_add(dev);
441 /* Did a trigger occur while probing? Need to re-trigger if yes */
442 if (local_trigger_count != atomic_read(&deferred_trigger_count))
443 driver_deferred_probe_trigger();
444}
445
446static int really_probe(struct device *dev, struct device_driver *drv)
447{
448 int ret = -EPROBE_DEFER;
449 int local_trigger_count = atomic_read(&deferred_trigger_count);
450 bool test_remove = IS_ENABLED(CONFIG_DEBUG_TEST_DRIVER_REMOVE) &&
451 !drv->suppress_bind_attrs;
452
453 if (defer_all_probes) {
454 /*
455 * Value of defer_all_probes can be set only by
456 * device_defer_all_probes_enable() which, in turn, will call
457 * wait_for_device_probe() right after that to avoid any races.
458 */
459 dev_dbg(dev, "Driver %s force probe deferral\n", drv->name);
460 driver_deferred_probe_add(dev);
461 return ret;
462 }
463
464 ret = device_links_check_suppliers(dev);
465 if (ret == -EPROBE_DEFER)
466 driver_deferred_probe_add_trigger(dev, local_trigger_count);
467 if (ret)
468 return ret;
469
470 atomic_inc(&probe_count);
471 pr_debug("bus: '%s': %s: probing driver %s with device %s\n",
472 drv->bus->name, __func__, drv->name, dev_name(dev));
473 WARN_ON(!list_empty(&dev->devres_head));
474
475re_probe:
476 dev->driver = drv;
477
478 /* If using pinctrl, bind pins now before probing */
479 ret = pinctrl_bind_pins(dev);
480 if (ret)
481 goto pinctrl_bind_failed;
482
483 if (dev->bus->dma_configure) {
484 ret = dev->bus->dma_configure(dev);
485 if (ret)
486 goto dma_failed;
487 }
488
489 if (driver_sysfs_add(dev)) {
490 printk(KERN_ERR "%s: driver_sysfs_add(%s) failed\n",
491 __func__, dev_name(dev));
492 goto probe_failed;
493 }
494
495 if (dev->pm_domain && dev->pm_domain->activate) {
496 ret = dev->pm_domain->activate(dev);
497 if (ret)
498 goto probe_failed;
499 }
500
501 if (dev->bus->probe) {
502 ret = dev->bus->probe(dev);
503 if (ret)
504 goto probe_failed;
505 } else if (drv->probe) {
506 ret = drv->probe(dev);
507 if (ret)
508 goto probe_failed;
509 }
510
511 if (test_remove) {
512 test_remove = false;
513
514 if (dev->bus->remove)
515 dev->bus->remove(dev);
516 else if (drv->remove)
517 drv->remove(dev);
518
519 devres_release_all(dev);
520 driver_sysfs_remove(dev);
521 dev->driver = NULL;
522 dev_set_drvdata(dev, NULL);
523 if (dev->pm_domain && dev->pm_domain->dismiss)
524 dev->pm_domain->dismiss(dev);
525 pm_runtime_reinit(dev);
526
527 goto re_probe;
528 }
529
530 pinctrl_init_done(dev);
531
532 if (dev->pm_domain && dev->pm_domain->sync)
533 dev->pm_domain->sync(dev);
534
535 driver_bound(dev);
536 ret = 1;
537 pr_debug("bus: '%s': %s: bound device %s to driver %s\n",
538 drv->bus->name, __func__, dev_name(dev), drv->name);
539 goto done;
540
541probe_failed:
542 arch_teardown_dma_ops(dev);
543dma_failed:
544 if (dev->bus)
545 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
546 BUS_NOTIFY_DRIVER_NOT_BOUND, dev);
547pinctrl_bind_failed:
548 device_links_no_driver(dev);
549 devres_release_all(dev);
550 driver_sysfs_remove(dev);
551 dev->driver = NULL;
552 dev_set_drvdata(dev, NULL);
553 if (dev->pm_domain && dev->pm_domain->dismiss)
554 dev->pm_domain->dismiss(dev);
555 pm_runtime_reinit(dev);
556 dev_pm_set_driver_flags(dev, 0);
557
558 switch (ret) {
559 case -EPROBE_DEFER:
560 /* Driver requested deferred probing */
561 dev_dbg(dev, "Driver %s requests probe deferral\n", drv->name);
562 driver_deferred_probe_add_trigger(dev, local_trigger_count);
563 break;
564 case -ENODEV:
565 case -ENXIO:
566 pr_debug("%s: probe of %s rejects match %d\n",
567 drv->name, dev_name(dev), ret);
568 break;
569 default:
570 /* driver matched but the probe failed */
571 printk(KERN_WARNING
572 "%s: probe of %s failed with error %d\n",
573 drv->name, dev_name(dev), ret);
574 }
575 /*
576 * Ignore errors returned by ->probe so that the next driver can try
577 * its luck.
578 */
579 ret = 0;
580done:
581 atomic_dec(&probe_count);
582 wake_up(&probe_waitqueue);
583 return ret;
584}
585
586/*
587 * For initcall_debug, show the driver probe time.
588 */
589static int really_probe_debug(struct device *dev, struct device_driver *drv)
590{
591 ktime_t calltime, delta, rettime;
592 int ret;
593
594 calltime = ktime_get();
595 ret = really_probe(dev, drv);
596 rettime = ktime_get();
597 delta = ktime_sub(rettime, calltime);
598 printk(KERN_DEBUG "probe of %s returned %d after %lld usecs\n",
599 dev_name(dev), ret, (s64) ktime_to_us(delta));
600 return ret;
601}
602
603/**
604 * driver_probe_done
605 * Determine if the probe sequence is finished or not.
606 *
607 * Should somehow figure out how to use a semaphore, not an atomic variable...
608 */
609int driver_probe_done(void)
610{
611 pr_debug("%s: probe_count = %d\n", __func__,
612 atomic_read(&probe_count));
613 if (atomic_read(&probe_count))
614 return -EBUSY;
615 return 0;
616}
617
618/**
619 * wait_for_device_probe
620 * Wait for device probing to be completed.
621 */
622void wait_for_device_probe(void)
623{
624 /* wait for the deferred probe workqueue to finish */
625 flush_work(&deferred_probe_work);
626
627 /* wait for the known devices to complete their probing */
628 wait_event(probe_waitqueue, atomic_read(&probe_count) == 0);
629 async_synchronize_full();
630}
631EXPORT_SYMBOL_GPL(wait_for_device_probe);
632
633/**
634 * driver_probe_device - attempt to bind device & driver together
635 * @drv: driver to bind a device to
636 * @dev: device to try to bind to the driver
637 *
638 * This function returns -ENODEV if the device is not registered,
639 * 1 if the device is bound successfully and 0 otherwise.
640 *
641 * This function must be called with @dev lock held. When called for a
642 * USB interface, @dev->parent lock must be held as well.
643 *
644 * If the device has a parent, runtime-resume the parent before driver probing.
645 */
646int driver_probe_device(struct device_driver *drv, struct device *dev)
647{
648 int ret = 0;
649
650 if (!device_is_registered(dev))
651 return -ENODEV;
652
653 pr_debug("bus: '%s': %s: matched device %s with driver %s\n",
654 drv->bus->name, __func__, dev_name(dev), drv->name);
655
656 pm_runtime_get_suppliers(dev);
657 if (dev->parent)
658 pm_runtime_get_sync(dev->parent);
659
660 pm_runtime_barrier(dev);
661 if (initcall_debug)
662 ret = really_probe_debug(dev, drv);
663 else
664 ret = really_probe(dev, drv);
665 pm_request_idle(dev);
666
667 if (dev->parent)
668 pm_runtime_put(dev->parent);
669
670 pm_runtime_put_suppliers(dev);
671 return ret;
672}
673
674bool driver_allows_async_probing(struct device_driver *drv)
675{
676 switch (drv->probe_type) {
677 case PROBE_PREFER_ASYNCHRONOUS:
678 return true;
679
680 case PROBE_FORCE_SYNCHRONOUS:
681 return false;
682
683 default:
684 if (module_requested_async_probing(drv->owner))
685 return true;
686
687 return false;
688 }
689}
690
691struct device_attach_data {
692 struct device *dev;
693
694 /*
695 * Indicates whether we are are considering asynchronous probing or
696 * not. Only initial binding after device or driver registration
697 * (including deferral processing) may be done asynchronously, the
698 * rest is always synchronous, as we expect it is being done by
699 * request from userspace.
700 */
701 bool check_async;
702
703 /*
704 * Indicates if we are binding synchronous or asynchronous drivers.
705 * When asynchronous probing is enabled we'll execute 2 passes
706 * over drivers: first pass doing synchronous probing and second
707 * doing asynchronous probing (if synchronous did not succeed -
708 * most likely because there was no driver requiring synchronous
709 * probing - and we found asynchronous driver during first pass).
710 * The 2 passes are done because we can't shoot asynchronous
711 * probe for given device and driver from bus_for_each_drv() since
712 * driver pointer is not guaranteed to stay valid once
713 * bus_for_each_drv() iterates to the next driver on the bus.
714 */
715 bool want_async;
716
717 /*
718 * We'll set have_async to 'true' if, while scanning for matching
719 * driver, we'll encounter one that requests asynchronous probing.
720 */
721 bool have_async;
722};
723
724static int __device_attach_driver(struct device_driver *drv, void *_data)
725{
726 struct device_attach_data *data = _data;
727 struct device *dev = data->dev;
728 bool async_allowed;
729 int ret;
730
731 /*
732 * Check if device has already been claimed. This may
733 * happen with driver loading, device discovery/registration,
734 * and deferred probe processing happens all at once with
735 * multiple threads.
736 */
737 if (dev->driver)
738 return -EBUSY;
739
740 ret = driver_match_device(drv, dev);
741 if (ret == 0) {
742 /* no match */
743 return 0;
744 } else if (ret == -EPROBE_DEFER) {
745 dev_dbg(dev, "Device match requests probe deferral\n");
746 driver_deferred_probe_add(dev);
747 } else if (ret < 0) {
748 dev_dbg(dev, "Bus failed to match device: %d", ret);
749 return ret;
750 } /* ret > 0 means positive match */
751
752 async_allowed = driver_allows_async_probing(drv);
753
754 if (async_allowed)
755 data->have_async = true;
756
757 if (data->check_async && async_allowed != data->want_async)
758 return 0;
759
760 return driver_probe_device(drv, dev);
761}
762
763static void __device_attach_async_helper(void *_dev, async_cookie_t cookie)
764{
765 struct device *dev = _dev;
766 struct device_attach_data data = {
767 .dev = dev,
768 .check_async = true,
769 .want_async = true,
770 };
771
772 device_lock(dev);
773
774 if (dev->parent)
775 pm_runtime_get_sync(dev->parent);
776
777 bus_for_each_drv(dev->bus, NULL, &data, __device_attach_driver);
778 dev_dbg(dev, "async probe completed\n");
779
780 pm_request_idle(dev);
781
782 if (dev->parent)
783 pm_runtime_put(dev->parent);
784
785 device_unlock(dev);
786
787 put_device(dev);
788}
789
790static int __device_attach(struct device *dev, bool allow_async)
791{
792 int ret = 0;
793
794 device_lock(dev);
795 if (dev->driver) {
796 if (device_is_bound(dev)) {
797 ret = 1;
798 goto out_unlock;
799 }
800 ret = device_bind_driver(dev);
801 if (ret == 0)
802 ret = 1;
803 else {
804 dev->driver = NULL;
805 ret = 0;
806 }
807 } else {
808 struct device_attach_data data = {
809 .dev = dev,
810 .check_async = allow_async,
811 .want_async = false,
812 };
813
814 if (dev->parent)
815 pm_runtime_get_sync(dev->parent);
816
817 ret = bus_for_each_drv(dev->bus, NULL, &data,
818 __device_attach_driver);
819 if (!ret && allow_async && data.have_async) {
820 /*
821 * If we could not find appropriate driver
822 * synchronously and we are allowed to do
823 * async probes and there are drivers that
824 * want to probe asynchronously, we'll
825 * try them.
826 */
827 dev_dbg(dev, "scheduling asynchronous probe\n");
828 get_device(dev);
829 async_schedule(__device_attach_async_helper, dev);
830 } else {
831 pm_request_idle(dev);
832 }
833
834 if (dev->parent)
835 pm_runtime_put(dev->parent);
836 }
837out_unlock:
838 device_unlock(dev);
839 return ret;
840}
841
842/**
843 * device_attach - try to attach device to a driver.
844 * @dev: device.
845 *
846 * Walk the list of drivers that the bus has and call
847 * driver_probe_device() for each pair. If a compatible
848 * pair is found, break out and return.
849 *
850 * Returns 1 if the device was bound to a driver;
851 * 0 if no matching driver was found;
852 * -ENODEV if the device is not registered.
853 *
854 * When called for a USB interface, @dev->parent lock must be held.
855 */
856int device_attach(struct device *dev)
857{
858 return __device_attach(dev, false);
859}
860EXPORT_SYMBOL_GPL(device_attach);
861
862void device_initial_probe(struct device *dev)
863{
864 __device_attach(dev, true);
865}
866
867static int __driver_attach(struct device *dev, void *data)
868{
869 struct device_driver *drv = data;
870 int ret;
871
872 /*
873 * Lock device and try to bind to it. We drop the error
874 * here and always return 0, because we need to keep trying
875 * to bind to devices and some drivers will return an error
876 * simply if it didn't support the device.
877 *
878 * driver_probe_device() will spit a warning if there
879 * is an error.
880 */
881
882 ret = driver_match_device(drv, dev);
883 if (ret == 0) {
884 /* no match */
885 return 0;
886 } else if (ret == -EPROBE_DEFER) {
887 dev_dbg(dev, "Device match requests probe deferral\n");
888 driver_deferred_probe_add(dev);
889 } else if (ret < 0) {
890 dev_dbg(dev, "Bus failed to match device: %d", ret);
891 return ret;
892 } /* ret > 0 means positive match */
893
894 if (dev->parent && dev->bus->need_parent_lock)
895 device_lock(dev->parent);
896 device_lock(dev);
897 if (!dev->driver)
898 driver_probe_device(drv, dev);
899 device_unlock(dev);
900 if (dev->parent && dev->bus->need_parent_lock)
901 device_unlock(dev->parent);
902
903 return 0;
904}
905
906/**
907 * driver_attach - try to bind driver to devices.
908 * @drv: driver.
909 *
910 * Walk the list of devices that the bus has on it and try to
911 * match the driver with each one. If driver_probe_device()
912 * returns 0 and the @dev->driver is set, we've found a
913 * compatible pair.
914 */
915int driver_attach(struct device_driver *drv)
916{
917 return bus_for_each_dev(drv->bus, NULL, drv, __driver_attach);
918}
919EXPORT_SYMBOL_GPL(driver_attach);
920
921/*
922 * __device_release_driver() must be called with @dev lock held.
923 * When called for a USB interface, @dev->parent lock must be held as well.
924 */
925static void __device_release_driver(struct device *dev, struct device *parent)
926{
927 struct device_driver *drv;
928
929 drv = dev->driver;
930 if (drv) {
931 if (driver_allows_async_probing(drv))
932 async_synchronize_full();
933
934 while (device_links_busy(dev)) {
935 device_unlock(dev);
936 if (parent)
937 device_unlock(parent);
938
939 device_links_unbind_consumers(dev);
940 if (parent)
941 device_lock(parent);
942
943 device_lock(dev);
944 /*
945 * A concurrent invocation of the same function might
946 * have released the driver successfully while this one
947 * was waiting, so check for that.
948 */
949 if (dev->driver != drv)
950 return;
951 }
952
953 pm_runtime_get_sync(dev);
954 pm_runtime_clean_up_links(dev);
955
956 driver_sysfs_remove(dev);
957
958 if (dev->bus)
959 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
960 BUS_NOTIFY_UNBIND_DRIVER,
961 dev);
962
963 pm_runtime_put_sync(dev);
964
965 if (dev->bus && dev->bus->remove)
966 dev->bus->remove(dev);
967 else if (drv->remove)
968 drv->remove(dev);
969
970 device_links_driver_cleanup(dev);
971 arch_teardown_dma_ops(dev);
972
973 devres_release_all(dev);
974 dev->driver = NULL;
975 dev_set_drvdata(dev, NULL);
976 if (dev->pm_domain && dev->pm_domain->dismiss)
977 dev->pm_domain->dismiss(dev);
978 pm_runtime_reinit(dev);
979 dev_pm_set_driver_flags(dev, 0);
980
981 klist_remove(&dev->p->knode_driver);
982 device_pm_check_callbacks(dev);
983 if (dev->bus)
984 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
985 BUS_NOTIFY_UNBOUND_DRIVER,
986 dev);
987
988 kobject_uevent(&dev->kobj, KOBJ_UNBIND);
989 }
990}
991
992void device_release_driver_internal(struct device *dev,
993 struct device_driver *drv,
994 struct device *parent)
995{
996 if (parent && dev->bus->need_parent_lock)
997 device_lock(parent);
998
999 device_lock(dev);
1000 if (!drv || drv == dev->driver)
1001 __device_release_driver(dev, parent);
1002
1003 device_unlock(dev);
1004 if (parent && dev->bus->need_parent_lock)
1005 device_unlock(parent);
1006}
1007
1008/**
1009 * device_release_driver - manually detach device from driver.
1010 * @dev: device.
1011 *
1012 * Manually detach device from driver.
1013 * When called for a USB interface, @dev->parent lock must be held.
1014 *
1015 * If this function is to be called with @dev->parent lock held, ensure that
1016 * the device's consumers are unbound in advance or that their locks can be
1017 * acquired under the @dev->parent lock.
1018 */
1019void device_release_driver(struct device *dev)
1020{
1021 /*
1022 * If anyone calls device_release_driver() recursively from
1023 * within their ->remove callback for the same device, they
1024 * will deadlock right here.
1025 */
1026 device_release_driver_internal(dev, NULL, NULL);
1027}
1028EXPORT_SYMBOL_GPL(device_release_driver);
1029
1030/**
1031 * driver_detach - detach driver from all devices it controls.
1032 * @drv: driver.
1033 */
1034void driver_detach(struct device_driver *drv)
1035{
1036 struct device_private *dev_prv;
1037 struct device *dev;
1038
1039 for (;;) {
1040 spin_lock(&drv->p->klist_devices.k_lock);
1041 if (list_empty(&drv->p->klist_devices.k_list)) {
1042 spin_unlock(&drv->p->klist_devices.k_lock);
1043 break;
1044 }
1045 dev_prv = list_entry(drv->p->klist_devices.k_list.prev,
1046 struct device_private,
1047 knode_driver.n_node);
1048 dev = dev_prv->device;
1049 get_device(dev);
1050 spin_unlock(&drv->p->klist_devices.k_lock);
1051 device_release_driver_internal(dev, drv, dev->parent);
1052 put_device(dev);
1053 }
1054}