2 * drivers/base/dd.c - The core device/driver interactions.
4 * This file contains the (sometimes tricky) code that controls the
5 * interactions between devices and drivers, which primarily includes
6 * driver binding and unbinding.
8 * All of this code used to exist in drivers/base/bus.c, but was
9 * relocated to here in the name of compartmentalization (since it wasn't
10 * strictly code just for the 'struct bus_type'.
12 * Copyright (c) 2002-5 Patrick Mochel
13 * Copyright (c) 2002-3 Open Source Development Labs
14 * Copyright (c) 2007-2009 Greg Kroah-Hartman <gregkh@suse.de>
15 * Copyright (c) 2007-2009 Novell Inc.
17 * This file is released under the GPLv2
20 #include <linux/device.h>
21 #include <linux/delay.h>
22 #include <linux/module.h>
23 #include <linux/kthread.h>
24 #include <linux/wait.h>
25 #include <linux/async.h>
26 #include <linux/pm_runtime.h>
27 #include <linux/pinctrl/devinfo.h>
30 #include "power/power.h"
33 * Deferred Probe infrastructure.
35 * Sometimes driver probe order matters, but the kernel doesn't always have
36 * dependency information which means some drivers will get probed before a
37 * resource it depends on is available. For example, an SDHCI driver may
38 * first need a GPIO line from an i2c GPIO controller before it can be
39 * initialized. If a required resource is not available yet, a driver can
40 * request probing to be deferred by returning -EPROBE_DEFER from its probe hook
42 * Deferred probe maintains two lists of devices, a pending list and an active
43 * list. A driver returning -EPROBE_DEFER causes the device to be added to the
44 * pending list. A successful driver probe will trigger moving all devices
45 * from the pending to the active list so that the workqueue will eventually
48 * The deferred_probe_mutex must be held any time the deferred_probe_*_list
49 * of the (struct device*)->p->deferred_probe pointers are manipulated
51 static DEFINE_MUTEX(deferred_probe_mutex
);
52 static LIST_HEAD(deferred_probe_pending_list
);
53 static LIST_HEAD(deferred_probe_active_list
);
54 static struct workqueue_struct
*deferred_wq
;
57 * deferred_probe_work_func() - Retry probing devices in the active list.
59 static void deferred_probe_work_func(struct work_struct
*work
)
62 struct device_private
*private;
64 * This block processes every device in the deferred 'active' list.
65 * Each device is removed from the active list and passed to
66 * bus_probe_device() to re-attempt the probe. The loop continues
67 * until every device in the active list is removed and retried.
69 * Note: Once the device is removed from the list and the mutex is
70 * released, it is possible for the device get freed by another thread
71 * and cause a illegal pointer dereference. This code uses
72 * get/put_device() to ensure the device structure cannot disappear
73 * from under our feet.
75 mutex_lock(&deferred_probe_mutex
);
76 while (!list_empty(&deferred_probe_active_list
)) {
77 private = list_first_entry(&deferred_probe_active_list
,
78 typeof(*dev
->p
), deferred_probe
);
79 dev
= private->device
;
80 list_del_init(&private->deferred_probe
);
85 * Drop the mutex while probing each device; the probe path may
86 * manipulate the deferred list
88 mutex_unlock(&deferred_probe_mutex
);
91 * Force the device to the end of the dpm_list since
92 * the PM code assumes that the order we add things to
93 * the list is a good order for suspend but deferred
94 * probe makes that very unsafe.
97 device_pm_move_last(dev
);
100 dev_dbg(dev
, "Retrying from deferred list\n");
101 bus_probe_device(dev
);
103 mutex_lock(&deferred_probe_mutex
);
107 mutex_unlock(&deferred_probe_mutex
);
109 static DECLARE_WORK(deferred_probe_work
, deferred_probe_work_func
);
111 static void driver_deferred_probe_add(struct device
*dev
)
113 mutex_lock(&deferred_probe_mutex
);
114 if (list_empty(&dev
->p
->deferred_probe
)) {
115 dev_dbg(dev
, "Added to deferred list\n");
116 list_add_tail(&dev
->p
->deferred_probe
, &deferred_probe_pending_list
);
118 mutex_unlock(&deferred_probe_mutex
);
121 void driver_deferred_probe_del(struct device
*dev
)
123 mutex_lock(&deferred_probe_mutex
);
124 if (!list_empty(&dev
->p
->deferred_probe
)) {
125 dev_dbg(dev
, "Removed from deferred list\n");
126 list_del_init(&dev
->p
->deferred_probe
);
128 mutex_unlock(&deferred_probe_mutex
);
131 static bool driver_deferred_probe_enable
= false;
133 * driver_deferred_probe_trigger() - Kick off re-probing deferred devices
135 * This functions moves all devices from the pending list to the active
136 * list and schedules the deferred probe workqueue to process them. It
137 * should be called anytime a driver is successfully bound to a device.
139 static void driver_deferred_probe_trigger(void)
141 if (!driver_deferred_probe_enable
)
145 * A successful probe means that all the devices in the pending list
146 * should be triggered to be reprobed. Move all the deferred devices
147 * into the active list so they can be retried by the workqueue
149 mutex_lock(&deferred_probe_mutex
);
150 list_splice_tail_init(&deferred_probe_pending_list
,
151 &deferred_probe_active_list
);
152 mutex_unlock(&deferred_probe_mutex
);
155 * Kick the re-probe thread. It may already be scheduled, but it is
156 * safe to kick it again.
158 queue_work(deferred_wq
, &deferred_probe_work
);
162 * deferred_probe_initcall() - Enable probing of deferred devices
164 * We don't want to get in the way when the bulk of drivers are getting probed.
165 * Instead, this initcall makes sure that deferred probing is delayed until
166 * late_initcall time.
168 static int deferred_probe_initcall(void)
170 deferred_wq
= create_singlethread_workqueue("deferwq");
171 if (WARN_ON(!deferred_wq
))
174 driver_deferred_probe_enable
= true;
175 driver_deferred_probe_trigger();
178 late_initcall(deferred_probe_initcall
);
180 static void driver_bound(struct device
*dev
)
182 if (klist_node_attached(&dev
->p
->knode_driver
)) {
183 printk(KERN_WARNING
"%s: device %s already bound\n",
184 __func__
, kobject_name(&dev
->kobj
));
188 pr_debug("driver: '%s': %s: bound to device '%s'\n", dev_name(dev
),
189 __func__
, dev
->driver
->name
);
191 klist_add_tail(&dev
->p
->knode_driver
, &dev
->driver
->p
->klist_devices
);
194 * Make sure the device is no longer in one of the deferred lists and
195 * kick off retrying all pending devices
197 driver_deferred_probe_del(dev
);
198 driver_deferred_probe_trigger();
201 blocking_notifier_call_chain(&dev
->bus
->p
->bus_notifier
,
202 BUS_NOTIFY_BOUND_DRIVER
, dev
);
205 static int driver_sysfs_add(struct device
*dev
)
210 blocking_notifier_call_chain(&dev
->bus
->p
->bus_notifier
,
211 BUS_NOTIFY_BIND_DRIVER
, dev
);
213 ret
= sysfs_create_link(&dev
->driver
->p
->kobj
, &dev
->kobj
,
214 kobject_name(&dev
->kobj
));
216 ret
= sysfs_create_link(&dev
->kobj
, &dev
->driver
->p
->kobj
,
219 sysfs_remove_link(&dev
->driver
->p
->kobj
,
220 kobject_name(&dev
->kobj
));
225 static void driver_sysfs_remove(struct device
*dev
)
227 struct device_driver
*drv
= dev
->driver
;
230 sysfs_remove_link(&drv
->p
->kobj
, kobject_name(&dev
->kobj
));
231 sysfs_remove_link(&dev
->kobj
, "driver");
236 * device_bind_driver - bind a driver to one device.
239 * Allow manual attachment of a driver to a device.
240 * Caller must have already set @dev->driver.
242 * Note that this does not modify the bus reference count
243 * nor take the bus's rwsem. Please verify those are accounted
244 * for before calling this. (It is ok to call with no other effort
245 * from a driver's probe() method.)
247 * This function must be called with the device lock held.
249 int device_bind_driver(struct device
*dev
)
253 ret
= driver_sysfs_add(dev
);
258 EXPORT_SYMBOL_GPL(device_bind_driver
);
260 static atomic_t probe_count
= ATOMIC_INIT(0);
261 static DECLARE_WAIT_QUEUE_HEAD(probe_waitqueue
);
263 static int really_probe(struct device
*dev
, struct device_driver
*drv
)
267 atomic_inc(&probe_count
);
268 pr_debug("bus: '%s': %s: probing driver %s with device %s\n",
269 drv
->bus
->name
, __func__
, drv
->name
, dev_name(dev
));
270 WARN_ON(!list_empty(&dev
->devres_head
));
274 /* If using pinctrl, bind pins now before probing */
275 ret
= pinctrl_bind_pins(dev
);
279 if (driver_sysfs_add(dev
)) {
280 printk(KERN_ERR
"%s: driver_sysfs_add(%s) failed\n",
281 __func__
, dev_name(dev
));
285 if (dev
->bus
->probe
) {
286 ret
= dev
->bus
->probe(dev
);
289 } else if (drv
->probe
) {
290 ret
= drv
->probe(dev
);
297 pr_debug("bus: '%s': %s: bound device %s to driver %s\n",
298 drv
->bus
->name
, __func__
, dev_name(dev
), drv
->name
);
302 devres_release_all(dev
);
303 driver_sysfs_remove(dev
);
305 dev_set_drvdata(dev
, NULL
);
307 if (ret
== -EPROBE_DEFER
) {
308 /* Driver requested deferred probing */
309 dev_info(dev
, "Driver %s requests probe deferral\n", drv
->name
);
310 driver_deferred_probe_add(dev
);
311 } else if (ret
!= -ENODEV
&& ret
!= -ENXIO
) {
312 /* driver matched but the probe failed */
314 "%s: probe of %s failed with error %d\n",
315 drv
->name
, dev_name(dev
), ret
);
317 pr_debug("%s: probe of %s rejects match %d\n",
318 drv
->name
, dev_name(dev
), ret
);
321 * Ignore errors returned by ->probe so that the next driver can try
326 atomic_dec(&probe_count
);
327 wake_up(&probe_waitqueue
);
333 * Determine if the probe sequence is finished or not.
335 * Should somehow figure out how to use a semaphore, not an atomic variable...
337 int driver_probe_done(void)
339 pr_debug("%s: probe_count = %d\n", __func__
,
340 atomic_read(&probe_count
));
341 if (atomic_read(&probe_count
))
347 * wait_for_device_probe
348 * Wait for device probing to be completed.
350 void wait_for_device_probe(void)
352 /* wait for the known devices to complete their probing */
353 wait_event(probe_waitqueue
, atomic_read(&probe_count
) == 0);
354 async_synchronize_full();
356 EXPORT_SYMBOL_GPL(wait_for_device_probe
);
359 * driver_probe_device - attempt to bind device & driver together
360 * @drv: driver to bind a device to
361 * @dev: device to try to bind to the driver
363 * This function returns -ENODEV if the device is not registered,
364 * 1 if the device is bound successfully and 0 otherwise.
366 * This function must be called with @dev lock held. When called for a
367 * USB interface, @dev->parent lock must be held as well.
369 int driver_probe_device(struct device_driver
*drv
, struct device
*dev
)
373 if (!device_is_registered(dev
))
376 pr_debug("bus: '%s': %s: matched device %s with driver %s\n",
377 drv
->bus
->name
, __func__
, dev_name(dev
), drv
->name
);
379 pm_runtime_barrier(dev
);
380 ret
= really_probe(dev
, drv
);
381 pm_runtime_idle(dev
);
386 static int __device_attach(struct device_driver
*drv
, void *data
)
388 struct device
*dev
= data
;
390 if (!driver_match_device(drv
, dev
))
393 return driver_probe_device(drv
, dev
);
397 * device_attach - try to attach device to a driver.
400 * Walk the list of drivers that the bus has and call
401 * driver_probe_device() for each pair. If a compatible
402 * pair is found, break out and return.
404 * Returns 1 if the device was bound to a driver;
405 * 0 if no matching driver was found;
406 * -ENODEV if the device is not registered.
408 * When called for a USB interface, @dev->parent lock must be held.
410 int device_attach(struct device
*dev
)
416 if (klist_node_attached(&dev
->p
->knode_driver
)) {
420 ret
= device_bind_driver(dev
);
428 ret
= bus_for_each_drv(dev
->bus
, NULL
, dev
, __device_attach
);
429 pm_runtime_idle(dev
);
435 EXPORT_SYMBOL_GPL(device_attach
);
437 static int __driver_attach(struct device
*dev
, void *data
)
439 struct device_driver
*drv
= data
;
442 * Lock device and try to bind to it. We drop the error
443 * here and always return 0, because we need to keep trying
444 * to bind to devices and some drivers will return an error
445 * simply if it didn't support the device.
447 * driver_probe_device() will spit a warning if there
451 if (!driver_match_device(drv
, dev
))
454 if (dev
->parent
) /* Needed for USB */
455 device_lock(dev
->parent
);
458 driver_probe_device(drv
, dev
);
461 device_unlock(dev
->parent
);
467 * driver_attach - try to bind driver to devices.
470 * Walk the list of devices that the bus has on it and try to
471 * match the driver with each one. If driver_probe_device()
472 * returns 0 and the @dev->driver is set, we've found a
475 int driver_attach(struct device_driver
*drv
)
477 return bus_for_each_dev(drv
->bus
, NULL
, drv
, __driver_attach
);
479 EXPORT_SYMBOL_GPL(driver_attach
);
482 * __device_release_driver() must be called with @dev lock held.
483 * When called for a USB interface, @dev->parent lock must be held as well.
485 static void __device_release_driver(struct device
*dev
)
487 struct device_driver
*drv
;
491 pm_runtime_get_sync(dev
);
493 driver_sysfs_remove(dev
);
496 blocking_notifier_call_chain(&dev
->bus
->p
->bus_notifier
,
497 BUS_NOTIFY_UNBIND_DRIVER
,
500 pm_runtime_put_sync(dev
);
502 if (dev
->bus
&& dev
->bus
->remove
)
503 dev
->bus
->remove(dev
);
504 else if (drv
->remove
)
506 devres_release_all(dev
);
508 dev_set_drvdata(dev
, NULL
);
509 klist_remove(&dev
->p
->knode_driver
);
511 blocking_notifier_call_chain(&dev
->bus
->p
->bus_notifier
,
512 BUS_NOTIFY_UNBOUND_DRIVER
,
519 * device_release_driver - manually detach device from driver.
522 * Manually detach device from driver.
523 * When called for a USB interface, @dev->parent lock must be held.
525 void device_release_driver(struct device
*dev
)
528 * If anyone calls device_release_driver() recursively from
529 * within their ->remove callback for the same device, they
530 * will deadlock right here.
533 __device_release_driver(dev
);
536 EXPORT_SYMBOL_GPL(device_release_driver
);
539 * driver_detach - detach driver from all devices it controls.
542 void driver_detach(struct device_driver
*drv
)
544 struct device_private
*dev_prv
;
548 spin_lock(&drv
->p
->klist_devices
.k_lock
);
549 if (list_empty(&drv
->p
->klist_devices
.k_list
)) {
550 spin_unlock(&drv
->p
->klist_devices
.k_lock
);
553 dev_prv
= list_entry(drv
->p
->klist_devices
.k_list
.prev
,
554 struct device_private
,
555 knode_driver
.n_node
);
556 dev
= dev_prv
->device
;
558 spin_unlock(&drv
->p
->klist_devices
.k_lock
);
560 if (dev
->parent
) /* Needed for USB */
561 device_lock(dev
->parent
);
563 if (dev
->driver
== drv
)
564 __device_release_driver(dev
);
567 device_unlock(dev
->parent
);
573 * These exports can't be _GPL due to .h files using this within them, and it
574 * might break something that was previously working...
576 void *dev_get_drvdata(const struct device
*dev
)
579 return dev
->p
->driver_data
;
582 EXPORT_SYMBOL(dev_get_drvdata
);
584 int dev_set_drvdata(struct device
*dev
, void *data
)
589 error
= device_private_init(dev
);
593 dev
->p
->driver_data
= data
;
596 EXPORT_SYMBOL(dev_set_drvdata
);