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