driver core: move the deferred probe pointer into the private area
[linux-2.6.git] / drivers / base / dd.c
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/module.h>
23 #include <linux/kthread.h>
24 #include <linux/wait.h>
25 #include <linux/async.h>
26 #include <linux/pm_runtime.h>
27
28 #include "base.h"
29 #include "power/power.h"
30
31 /*
32  * Deferred Probe infrastructure.
33  *
34  * Sometimes driver probe order matters, but the kernel doesn't always have
35  * dependency information which means some drivers will get probed before a
36  * resource it depends on is available.  For example, an SDHCI driver may
37  * first need a GPIO line from an i2c GPIO controller before it can be
38  * initialized.  If a required resource is not available yet, a driver can
39  * request probing to be deferred by returning -EPROBE_DEFER from its probe hook
40  *
41  * Deferred probe maintains two lists of devices, a pending list and an active
42  * list.  A driver returning -EPROBE_DEFER causes the device to be added to the
43  * pending list.  A successful driver probe will trigger moving all devices
44  * from the pending to the active list so that the workqueue will eventually
45  * retry them.
46  *
47  * The deferred_probe_mutex must be held any time the deferred_probe_*_list
48  * of the (struct device*)->p->deferred_probe pointers are manipulated
49  */
50 static DEFINE_MUTEX(deferred_probe_mutex);
51 static LIST_HEAD(deferred_probe_pending_list);
52 static LIST_HEAD(deferred_probe_active_list);
53 static struct workqueue_struct *deferred_wq;
54
55 /**
56  * deferred_probe_work_func() - Retry probing devices in the active list.
57  */
58 static void deferred_probe_work_func(struct work_struct *work)
59 {
60         struct device *dev;
61         struct device_private *private;
62         /*
63          * This block processes every device in the deferred 'active' list.
64          * Each device is removed from the active list and passed to
65          * bus_probe_device() to re-attempt the probe.  The loop continues
66          * until every device in the active list is removed and retried.
67          *
68          * Note: Once the device is removed from the list and the mutex is
69          * released, it is possible for the device get freed by another thread
70          * and cause a illegal pointer dereference.  This code uses
71          * get/put_device() to ensure the device structure cannot disappear
72          * from under our feet.
73          */
74         mutex_lock(&deferred_probe_mutex);
75         while (!list_empty(&deferred_probe_active_list)) {
76                 private = list_first_entry(&deferred_probe_active_list,
77                                         typeof(*dev->p), deferred_probe);
78                 dev = private->device;
79                 list_del_init(&private->deferred_probe);
80
81                 get_device(dev);
82
83                 /* Drop the mutex while probing each device; the probe path
84                  * may manipulate the deferred list */
85                 mutex_unlock(&deferred_probe_mutex);
86                 dev_dbg(dev, "Retrying from deferred list\n");
87                 bus_probe_device(dev);
88                 mutex_lock(&deferred_probe_mutex);
89
90                 put_device(dev);
91         }
92         mutex_unlock(&deferred_probe_mutex);
93 }
94 static DECLARE_WORK(deferred_probe_work, deferred_probe_work_func);
95
96 static void driver_deferred_probe_add(struct device *dev)
97 {
98         mutex_lock(&deferred_probe_mutex);
99         if (list_empty(&dev->p->deferred_probe)) {
100                 dev_dbg(dev, "Added to deferred list\n");
101                 list_add(&dev->p->deferred_probe, &deferred_probe_pending_list);
102         }
103         mutex_unlock(&deferred_probe_mutex);
104 }
105
106 void driver_deferred_probe_del(struct device *dev)
107 {
108         mutex_lock(&deferred_probe_mutex);
109         if (!list_empty(&dev->p->deferred_probe)) {
110                 dev_dbg(dev, "Removed from deferred list\n");
111                 list_del_init(&dev->p->deferred_probe);
112         }
113         mutex_unlock(&deferred_probe_mutex);
114 }
115
116 static bool driver_deferred_probe_enable = false;
117 /**
118  * driver_deferred_probe_trigger() - Kick off re-probing deferred devices
119  *
120  * This functions moves all devices from the pending list to the active
121  * list and schedules the deferred probe workqueue to process them.  It
122  * should be called anytime a driver is successfully bound to a device.
123  */
124 static void driver_deferred_probe_trigger(void)
125 {
126         if (!driver_deferred_probe_enable)
127                 return;
128
129         /* A successful probe means that all the devices in the pending list
130          * should be triggered to be reprobed.  Move all the deferred devices
131          * into the active list so they can be retried by the workqueue */
132         mutex_lock(&deferred_probe_mutex);
133         list_splice_tail_init(&deferred_probe_pending_list,
134                               &deferred_probe_active_list);
135         mutex_unlock(&deferred_probe_mutex);
136
137         /* Kick the re-probe thread.  It may already be scheduled, but
138          * it is safe to kick it again. */
139         queue_work(deferred_wq, &deferred_probe_work);
140 }
141
142 /**
143  * deferred_probe_initcall() - Enable probing of deferred devices
144  *
145  * We don't want to get in the way when the bulk of drivers are getting probed.
146  * Instead, this initcall makes sure that deferred probing is delayed until
147  * late_initcall time.
148  */
149 static int deferred_probe_initcall(void)
150 {
151         deferred_wq = create_singlethread_workqueue("deferwq");
152         if (WARN_ON(!deferred_wq))
153                 return -ENOMEM;
154
155         driver_deferred_probe_enable = true;
156         driver_deferred_probe_trigger();
157         return 0;
158 }
159 late_initcall(deferred_probe_initcall);
160
161 static void driver_bound(struct device *dev)
162 {
163         if (klist_node_attached(&dev->p->knode_driver)) {
164                 printk(KERN_WARNING "%s: device %s already bound\n",
165                         __func__, kobject_name(&dev->kobj));
166                 return;
167         }
168
169         pr_debug("driver: '%s': %s: bound to device '%s'\n", dev_name(dev),
170                  __func__, dev->driver->name);
171
172         klist_add_tail(&dev->p->knode_driver, &dev->driver->p->klist_devices);
173
174         /* Make sure the device is no longer in one of the deferred lists
175          * and kick off retrying all pending devices */
176         driver_deferred_probe_del(dev);
177         driver_deferred_probe_trigger();
178
179         if (dev->bus)
180                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
181                                              BUS_NOTIFY_BOUND_DRIVER, dev);
182 }
183
184 static int driver_sysfs_add(struct device *dev)
185 {
186         int ret;
187
188         if (dev->bus)
189                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
190                                              BUS_NOTIFY_BIND_DRIVER, dev);
191
192         ret = sysfs_create_link(&dev->driver->p->kobj, &dev->kobj,
193                           kobject_name(&dev->kobj));
194         if (ret == 0) {
195                 ret = sysfs_create_link(&dev->kobj, &dev->driver->p->kobj,
196                                         "driver");
197                 if (ret)
198                         sysfs_remove_link(&dev->driver->p->kobj,
199                                         kobject_name(&dev->kobj));
200         }
201         return ret;
202 }
203
204 static void driver_sysfs_remove(struct device *dev)
205 {
206         struct device_driver *drv = dev->driver;
207
208         if (drv) {
209                 sysfs_remove_link(&drv->p->kobj, kobject_name(&dev->kobj));
210                 sysfs_remove_link(&dev->kobj, "driver");
211         }
212 }
213
214 /**
215  * device_bind_driver - bind a driver to one device.
216  * @dev: device.
217  *
218  * Allow manual attachment of a driver to a device.
219  * Caller must have already set @dev->driver.
220  *
221  * Note that this does not modify the bus reference count
222  * nor take the bus's rwsem. Please verify those are accounted
223  * for before calling this. (It is ok to call with no other effort
224  * from a driver's probe() method.)
225  *
226  * This function must be called with the device lock held.
227  */
228 int device_bind_driver(struct device *dev)
229 {
230         int ret;
231
232         ret = driver_sysfs_add(dev);
233         if (!ret)
234                 driver_bound(dev);
235         return ret;
236 }
237 EXPORT_SYMBOL_GPL(device_bind_driver);
238
239 static atomic_t probe_count = ATOMIC_INIT(0);
240 static DECLARE_WAIT_QUEUE_HEAD(probe_waitqueue);
241
242 static int really_probe(struct device *dev, struct device_driver *drv)
243 {
244         int ret = 0;
245
246         atomic_inc(&probe_count);
247         pr_debug("bus: '%s': %s: probing driver %s with device %s\n",
248                  drv->bus->name, __func__, drv->name, dev_name(dev));
249         WARN_ON(!list_empty(&dev->devres_head));
250
251         dev->driver = drv;
252         if (driver_sysfs_add(dev)) {
253                 printk(KERN_ERR "%s: driver_sysfs_add(%s) failed\n",
254                         __func__, dev_name(dev));
255                 goto probe_failed;
256         }
257
258         if (dev->bus->probe) {
259                 ret = dev->bus->probe(dev);
260                 if (ret)
261                         goto probe_failed;
262         } else if (drv->probe) {
263                 ret = drv->probe(dev);
264                 if (ret)
265                         goto probe_failed;
266         }
267
268         driver_bound(dev);
269         ret = 1;
270         pr_debug("bus: '%s': %s: bound device %s to driver %s\n",
271                  drv->bus->name, __func__, dev_name(dev), drv->name);
272         goto done;
273
274 probe_failed:
275         devres_release_all(dev);
276         driver_sysfs_remove(dev);
277         dev->driver = NULL;
278
279         if (ret == -EPROBE_DEFER) {
280                 /* Driver requested deferred probing */
281                 dev_info(dev, "Driver %s requests probe deferral\n", drv->name);
282                 driver_deferred_probe_add(dev);
283         } else if (ret != -ENODEV && ret != -ENXIO) {
284                 /* driver matched but the probe failed */
285                 printk(KERN_WARNING
286                        "%s: probe of %s failed with error %d\n",
287                        drv->name, dev_name(dev), ret);
288         } else {
289                 pr_debug("%s: probe of %s rejects match %d\n",
290                        drv->name, dev_name(dev), ret);
291         }
292         /*
293          * Ignore errors returned by ->probe so that the next driver can try
294          * its luck.
295          */
296         ret = 0;
297 done:
298         atomic_dec(&probe_count);
299         wake_up(&probe_waitqueue);
300         return ret;
301 }
302
303 /**
304  * driver_probe_done
305  * Determine if the probe sequence is finished or not.
306  *
307  * Should somehow figure out how to use a semaphore, not an atomic variable...
308  */
309 int driver_probe_done(void)
310 {
311         pr_debug("%s: probe_count = %d\n", __func__,
312                  atomic_read(&probe_count));
313         if (atomic_read(&probe_count))
314                 return -EBUSY;
315         return 0;
316 }
317
318 /**
319  * wait_for_device_probe
320  * Wait for device probing to be completed.
321  */
322 void wait_for_device_probe(void)
323 {
324         /* wait for the known devices to complete their probing */
325         wait_event(probe_waitqueue, atomic_read(&probe_count) == 0);
326         async_synchronize_full();
327 }
328 EXPORT_SYMBOL_GPL(wait_for_device_probe);
329
330 /**
331  * driver_probe_device - attempt to bind device & driver together
332  * @drv: driver to bind a device to
333  * @dev: device to try to bind to the driver
334  *
335  * This function returns -ENODEV if the device is not registered,
336  * 1 if the device is bound successfully and 0 otherwise.
337  *
338  * This function must be called with @dev lock held.  When called for a
339  * USB interface, @dev->parent lock must be held as well.
340  */
341 int driver_probe_device(struct device_driver *drv, struct device *dev)
342 {
343         int ret = 0;
344
345         if (!device_is_registered(dev))
346                 return -ENODEV;
347
348         pr_debug("bus: '%s': %s: matched device %s with driver %s\n",
349                  drv->bus->name, __func__, dev_name(dev), drv->name);
350
351         pm_runtime_get_noresume(dev);
352         pm_runtime_barrier(dev);
353         ret = really_probe(dev, drv);
354         pm_runtime_put_sync(dev);
355
356         return ret;
357 }
358
359 static int __device_attach(struct device_driver *drv, void *data)
360 {
361         struct device *dev = data;
362
363         if (!driver_match_device(drv, dev))
364                 return 0;
365
366         return driver_probe_device(drv, dev);
367 }
368
369 /**
370  * device_attach - try to attach device to a driver.
371  * @dev: device.
372  *
373  * Walk the list of drivers that the bus has and call
374  * driver_probe_device() for each pair. If a compatible
375  * pair is found, break out and return.
376  *
377  * Returns 1 if the device was bound to a driver;
378  * 0 if no matching driver was found;
379  * -ENODEV if the device is not registered.
380  *
381  * When called for a USB interface, @dev->parent lock must be held.
382  */
383 int device_attach(struct device *dev)
384 {
385         int ret = 0;
386
387         device_lock(dev);
388         if (dev->driver) {
389                 if (klist_node_attached(&dev->p->knode_driver)) {
390                         ret = 1;
391                         goto out_unlock;
392                 }
393                 ret = device_bind_driver(dev);
394                 if (ret == 0)
395                         ret = 1;
396                 else {
397                         dev->driver = NULL;
398                         ret = 0;
399                 }
400         } else {
401                 pm_runtime_get_noresume(dev);
402                 ret = bus_for_each_drv(dev->bus, NULL, dev, __device_attach);
403                 pm_runtime_put_sync(dev);
404         }
405 out_unlock:
406         device_unlock(dev);
407         return ret;
408 }
409 EXPORT_SYMBOL_GPL(device_attach);
410
411 static int __driver_attach(struct device *dev, void *data)
412 {
413         struct device_driver *drv = data;
414
415         /*
416          * Lock device and try to bind to it. We drop the error
417          * here and always return 0, because we need to keep trying
418          * to bind to devices and some drivers will return an error
419          * simply if it didn't support the device.
420          *
421          * driver_probe_device() will spit a warning if there
422          * is an error.
423          */
424
425         if (!driver_match_device(drv, dev))
426                 return 0;
427
428         if (dev->parent)        /* Needed for USB */
429                 device_lock(dev->parent);
430         device_lock(dev);
431         if (!dev->driver)
432                 driver_probe_device(drv, dev);
433         device_unlock(dev);
434         if (dev->parent)
435                 device_unlock(dev->parent);
436
437         return 0;
438 }
439
440 /**
441  * driver_attach - try to bind driver to devices.
442  * @drv: driver.
443  *
444  * Walk the list of devices that the bus has on it and try to
445  * match the driver with each one.  If driver_probe_device()
446  * returns 0 and the @dev->driver is set, we've found a
447  * compatible pair.
448  */
449 int driver_attach(struct device_driver *drv)
450 {
451         return bus_for_each_dev(drv->bus, NULL, drv, __driver_attach);
452 }
453 EXPORT_SYMBOL_GPL(driver_attach);
454
455 /*
456  * __device_release_driver() must be called with @dev lock held.
457  * When called for a USB interface, @dev->parent lock must be held as well.
458  */
459 static void __device_release_driver(struct device *dev)
460 {
461         struct device_driver *drv;
462
463         drv = dev->driver;
464         if (drv) {
465                 pm_runtime_get_sync(dev);
466
467                 driver_sysfs_remove(dev);
468
469                 if (dev->bus)
470                         blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
471                                                      BUS_NOTIFY_UNBIND_DRIVER,
472                                                      dev);
473
474                 pm_runtime_put_sync(dev);
475
476                 if (dev->bus && dev->bus->remove)
477                         dev->bus->remove(dev);
478                 else if (drv->remove)
479                         drv->remove(dev);
480                 devres_release_all(dev);
481                 dev->driver = NULL;
482                 klist_remove(&dev->p->knode_driver);
483                 if (dev->bus)
484                         blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
485                                                      BUS_NOTIFY_UNBOUND_DRIVER,
486                                                      dev);
487
488         }
489 }
490
491 /**
492  * device_release_driver - manually detach device from driver.
493  * @dev: device.
494  *
495  * Manually detach device from driver.
496  * When called for a USB interface, @dev->parent lock must be held.
497  */
498 void device_release_driver(struct device *dev)
499 {
500         /*
501          * If anyone calls device_release_driver() recursively from
502          * within their ->remove callback for the same device, they
503          * will deadlock right here.
504          */
505         device_lock(dev);
506         __device_release_driver(dev);
507         device_unlock(dev);
508 }
509 EXPORT_SYMBOL_GPL(device_release_driver);
510
511 /**
512  * driver_detach - detach driver from all devices it controls.
513  * @drv: driver.
514  */
515 void driver_detach(struct device_driver *drv)
516 {
517         struct device_private *dev_prv;
518         struct device *dev;
519
520         for (;;) {
521                 spin_lock(&drv->p->klist_devices.k_lock);
522                 if (list_empty(&drv->p->klist_devices.k_list)) {
523                         spin_unlock(&drv->p->klist_devices.k_lock);
524                         break;
525                 }
526                 dev_prv = list_entry(drv->p->klist_devices.k_list.prev,
527                                      struct device_private,
528                                      knode_driver.n_node);
529                 dev = dev_prv->device;
530                 get_device(dev);
531                 spin_unlock(&drv->p->klist_devices.k_lock);
532
533                 if (dev->parent)        /* Needed for USB */
534                         device_lock(dev->parent);
535                 device_lock(dev);
536                 if (dev->driver == drv)
537                         __device_release_driver(dev);
538                 device_unlock(dev);
539                 if (dev->parent)
540                         device_unlock(dev->parent);
541                 put_device(dev);
542         }
543 }
544
545 /*
546  * These exports can't be _GPL due to .h files using this within them, and it
547  * might break something that was previously working...
548  */
549 void *dev_get_drvdata(const struct device *dev)
550 {
551         if (dev && dev->p)
552                 return dev->p->driver_data;
553         return NULL;
554 }
555 EXPORT_SYMBOL(dev_get_drvdata);
556
557 int dev_set_drvdata(struct device *dev, void *data)
558 {
559         int error;
560
561         if (!dev->p) {
562                 error = device_private_init(dev);
563                 if (error)
564                         return error;
565         }
566         dev->p->driver_data = data;
567         return 0;
568 }
569 EXPORT_SYMBOL(dev_set_drvdata);