Driver core: plug device probe memory leak
[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  *
15  *      This file is released under the GPLv2
16  */
17
18 #include <linux/device.h>
19 #include <linux/module.h>
20 #include <linux/kthread.h>
21
22 #include "base.h"
23 #include "power/power.h"
24
25 #define to_drv(node) container_of(node, struct device_driver, kobj.entry)
26
27
28 /**
29  *      device_bind_driver - bind a driver to one device.
30  *      @dev:   device.
31  *
32  *      Allow manual attachment of a driver to a device.
33  *      Caller must have already set @dev->driver.
34  *
35  *      Note that this does not modify the bus reference count
36  *      nor take the bus's rwsem. Please verify those are accounted
37  *      for before calling this. (It is ok to call with no other effort
38  *      from a driver's probe() method.)
39  *
40  *      This function must be called with @dev->sem held.
41  */
42 int device_bind_driver(struct device *dev)
43 {
44         int ret;
45
46         if (klist_node_attached(&dev->knode_driver)) {
47                 printk(KERN_WARNING "%s: device %s already bound\n",
48                         __FUNCTION__, kobject_name(&dev->kobj));
49                 return 0;
50         }
51
52         pr_debug("bound device '%s' to driver '%s'\n",
53                  dev->bus_id, dev->driver->name);
54         klist_add_tail(&dev->knode_driver, &dev->driver->klist_devices);
55         ret = sysfs_create_link(&dev->driver->kobj, &dev->kobj,
56                           kobject_name(&dev->kobj));
57         if (ret == 0) {
58                 ret = sysfs_create_link(&dev->kobj, &dev->driver->kobj,
59                                         "driver");
60                 if (ret)
61                         sysfs_remove_link(&dev->driver->kobj,
62                                         kobject_name(&dev->kobj));
63         }
64         return ret;
65 }
66
67 struct stupid_thread_structure {
68         struct device_driver *drv;
69         struct device *dev;
70 };
71
72 static atomic_t probe_count = ATOMIC_INIT(0);
73 static int really_probe(void *void_data)
74 {
75         struct stupid_thread_structure *data = void_data;
76         struct device_driver *drv = data->drv;
77         struct device *dev = data->dev;
78         int ret = 0;
79
80         atomic_inc(&probe_count);
81         pr_debug("%s: Probing driver %s with device %s\n",
82                  drv->bus->name, drv->name, dev->bus_id);
83
84         dev->driver = drv;
85         if (dev->bus->probe) {
86                 ret = dev->bus->probe(dev);
87                 if (ret) {
88                         dev->driver = NULL;
89                         goto probe_failed;
90                 }
91         } else if (drv->probe) {
92                 ret = drv->probe(dev);
93                 if (ret) {
94                         dev->driver = NULL;
95                         goto probe_failed;
96                 }
97         }
98         if (device_bind_driver(dev)) {
99                 printk(KERN_ERR "%s: device_bind_driver(%s) failed\n",
100                         __FUNCTION__, dev->bus_id);
101                 /* How does undo a ->probe?  We're screwed. */
102         }
103         ret = 1;
104         pr_debug("%s: Bound Device %s to Driver %s\n",
105                  drv->bus->name, dev->bus_id, drv->name);
106         goto done;
107
108 probe_failed:
109         if (ret == -ENODEV || ret == -ENXIO) {
110                 /* Driver matched, but didn't support device
111                  * or device not found.
112                  * Not an error; keep going.
113                  */
114                 ret = 0;
115         } else {
116                 /* driver matched but the probe failed */
117                 printk(KERN_WARNING
118                        "%s: probe of %s failed with error %d\n",
119                        drv->name, dev->bus_id, ret);
120         }
121 done:
122         kfree(data);
123         atomic_dec(&probe_count);
124         return ret;
125 }
126
127 /**
128  * driver_probe_done
129  * Determine if the probe sequence is finished or not.
130  *
131  * Should somehow figure out how to use a semaphore, not an atomic variable...
132  */
133 int driver_probe_done(void)
134 {
135         pr_debug("%s: probe_count = %d\n", __FUNCTION__,
136                  atomic_read(&probe_count));
137         if (atomic_read(&probe_count))
138                 return -EBUSY;
139         return 0;
140 }
141
142 /**
143  * driver_probe_device - attempt to bind device & driver together
144  * @drv: driver to bind a device to
145  * @dev: device to try to bind to the driver
146  *
147  * First, we call the bus's match function, if one present, which should
148  * compare the device IDs the driver supports with the device IDs of the
149  * device. Note we don't do this ourselves because we don't know the
150  * format of the ID structures, nor what is to be considered a match and
151  * what is not.
152  *
153  * This function returns 1 if a match is found, an error if one occurs
154  * (that is not -ENODEV or -ENXIO), and 0 otherwise.
155  *
156  * This function must be called with @dev->sem held.  When called for a
157  * USB interface, @dev->parent->sem must be held as well.
158  */
159 int driver_probe_device(struct device_driver * drv, struct device * dev)
160 {
161         struct stupid_thread_structure *data;
162         struct task_struct *probe_task;
163         int ret = 0;
164
165         if (!device_is_registered(dev))
166                 return -ENODEV;
167         if (drv->bus->match && !drv->bus->match(dev, drv))
168                 goto done;
169
170         pr_debug("%s: Matched Device %s with Driver %s\n",
171                  drv->bus->name, dev->bus_id, drv->name);
172
173         data = kmalloc(sizeof(*data), GFP_KERNEL);
174         data->drv = drv;
175         data->dev = dev;
176
177         if (drv->multithread_probe) {
178                 probe_task = kthread_run(really_probe, data,
179                                          "probe-%s", dev->bus_id);
180                 if (IS_ERR(probe_task))
181                         ret = really_probe(data);
182         } else
183                 ret = really_probe(data);
184
185 done:
186         return ret;
187 }
188
189 static int __device_attach(struct device_driver * drv, void * data)
190 {
191         struct device * dev = data;
192         return driver_probe_device(drv, dev);
193 }
194
195 /**
196  *      device_attach - try to attach device to a driver.
197  *      @dev:   device.
198  *
199  *      Walk the list of drivers that the bus has and call
200  *      driver_probe_device() for each pair. If a compatible
201  *      pair is found, break out and return.
202  *
203  *      Returns 1 if the device was bound to a driver;
204  *      0 if no matching device was found; error code otherwise.
205  *
206  *      When called for a USB interface, @dev->parent->sem must be held.
207  */
208 int device_attach(struct device * dev)
209 {
210         int ret = 0;
211
212         down(&dev->sem);
213         if (dev->driver) {
214                 ret = device_bind_driver(dev);
215                 if (ret == 0)
216                         ret = 1;
217         } else
218                 ret = bus_for_each_drv(dev->bus, NULL, dev, __device_attach);
219         up(&dev->sem);
220         return ret;
221 }
222
223 static int __driver_attach(struct device * dev, void * data)
224 {
225         struct device_driver * drv = data;
226
227         /*
228          * Lock device and try to bind to it. We drop the error
229          * here and always return 0, because we need to keep trying
230          * to bind to devices and some drivers will return an error
231          * simply if it didn't support the device.
232          *
233          * driver_probe_device() will spit a warning if there
234          * is an error.
235          */
236
237         if (dev->parent)        /* Needed for USB */
238                 down(&dev->parent->sem);
239         down(&dev->sem);
240         if (!dev->driver)
241                 driver_probe_device(drv, dev);
242         up(&dev->sem);
243         if (dev->parent)
244                 up(&dev->parent->sem);
245
246         return 0;
247 }
248
249 /**
250  *      driver_attach - try to bind driver to devices.
251  *      @drv:   driver.
252  *
253  *      Walk the list of devices that the bus has on it and try to
254  *      match the driver with each one.  If driver_probe_device()
255  *      returns 0 and the @dev->driver is set, we've found a
256  *      compatible pair.
257  */
258 int driver_attach(struct device_driver * drv)
259 {
260         return bus_for_each_dev(drv->bus, NULL, drv, __driver_attach);
261 }
262
263 /**
264  *      device_release_driver - manually detach device from driver.
265  *      @dev:   device.
266  *
267  *      Manually detach device from driver.
268  *
269  *      __device_release_driver() must be called with @dev->sem held.
270  *      When called for a USB interface, @dev->parent->sem must be held
271  *      as well.
272  */
273
274 static void __device_release_driver(struct device * dev)
275 {
276         struct device_driver * drv;
277
278         drv = dev->driver;
279         if (drv) {
280                 get_driver(drv);
281                 sysfs_remove_link(&drv->kobj, kobject_name(&dev->kobj));
282                 sysfs_remove_link(&dev->kobj, "driver");
283                 klist_remove(&dev->knode_driver);
284
285                 if (dev->bus && dev->bus->remove)
286                         dev->bus->remove(dev);
287                 else if (drv->remove)
288                         drv->remove(dev);
289                 dev->driver = NULL;
290                 put_driver(drv);
291         }
292 }
293
294 void device_release_driver(struct device * dev)
295 {
296         /*
297          * If anyone calls device_release_driver() recursively from
298          * within their ->remove callback for the same device, they
299          * will deadlock right here.
300          */
301         down(&dev->sem);
302         __device_release_driver(dev);
303         up(&dev->sem);
304 }
305
306
307 /**
308  * driver_detach - detach driver from all devices it controls.
309  * @drv: driver.
310  */
311 void driver_detach(struct device_driver * drv)
312 {
313         struct device * dev;
314
315         for (;;) {
316                 spin_lock(&drv->klist_devices.k_lock);
317                 if (list_empty(&drv->klist_devices.k_list)) {
318                         spin_unlock(&drv->klist_devices.k_lock);
319                         break;
320                 }
321                 dev = list_entry(drv->klist_devices.k_list.prev,
322                                 struct device, knode_driver.n_node);
323                 get_device(dev);
324                 spin_unlock(&drv->klist_devices.k_lock);
325
326                 if (dev->parent)        /* Needed for USB */
327                         down(&dev->parent->sem);
328                 down(&dev->sem);
329                 if (dev->driver == drv)
330                         __device_release_driver(dev);
331                 up(&dev->sem);
332                 if (dev->parent)
333                         up(&dev->parent->sem);
334                 put_device(dev);
335         }
336 }
337
338
339 EXPORT_SYMBOL_GPL(device_bind_driver);
340 EXPORT_SYMBOL_GPL(device_release_driver);
341 EXPORT_SYMBOL_GPL(device_attach);
342 EXPORT_SYMBOL_GPL(driver_attach);
343