Driver core: Remove unneeded get_{device,driver}() calls.
[linux-2.6.git] / drivers / base / driver.c
1 /*
2  * driver.c - centralized device driver management
3  *
4  * Copyright (c) 2002-3 Patrick Mochel
5  * Copyright (c) 2002-3 Open Source Development Labs
6  * Copyright (c) 2007 Greg Kroah-Hartman <gregkh@suse.de>
7  * Copyright (c) 2007 Novell Inc.
8  *
9  * This file is released under the GPLv2
10  *
11  */
12
13 #include <linux/device.h>
14 #include <linux/module.h>
15 #include <linux/errno.h>
16 #include <linux/string.h>
17 #include "base.h"
18
19 #define to_dev(node) container_of(node, struct device, driver_list)
20
21
22 static struct device *next_device(struct klist_iter *i)
23 {
24         struct klist_node *n = klist_next(i);
25         return n ? container_of(n, struct device, knode_driver) : NULL;
26 }
27
28 /**
29  * driver_for_each_device - Iterator for devices bound to a driver.
30  * @drv: Driver we're iterating.
31  * @start: Device to begin with
32  * @data: Data to pass to the callback.
33  * @fn: Function to call for each device.
34  *
35  * Iterate over the @drv's list of devices calling @fn for each one.
36  */
37 int driver_for_each_device(struct device_driver *drv, struct device *start,
38                            void *data, int (*fn)(struct device *, void *))
39 {
40         struct klist_iter i;
41         struct device *dev;
42         int error = 0;
43
44         if (!drv)
45                 return -EINVAL;
46
47         klist_iter_init_node(&drv->p->klist_devices, &i,
48                              start ? &start->knode_driver : NULL);
49         while ((dev = next_device(&i)) && !error)
50                 error = fn(dev, data);
51         klist_iter_exit(&i);
52         return error;
53 }
54 EXPORT_SYMBOL_GPL(driver_for_each_device);
55
56 /**
57  * driver_find_device - device iterator for locating a particular device.
58  * @drv: The device's driver
59  * @start: Device to begin with
60  * @data: Data to pass to match function
61  * @match: Callback function to check device
62  *
63  * This is similar to the driver_for_each_device() function above, but
64  * it returns a reference to a device that is 'found' for later use, as
65  * determined by the @match callback.
66  *
67  * The callback should return 0 if the device doesn't match and non-zero
68  * if it does.  If the callback returns non-zero, this function will
69  * return to the caller and not iterate over any more devices.
70  */
71 struct device *driver_find_device(struct device_driver *drv,
72                                   struct device *start, void *data,
73                                   int (*match)(struct device *dev, void *data))
74 {
75         struct klist_iter i;
76         struct device *dev;
77
78         if (!drv)
79                 return NULL;
80
81         klist_iter_init_node(&drv->p->klist_devices, &i,
82                              (start ? &start->knode_driver : NULL));
83         while ((dev = next_device(&i)))
84                 if (match(dev, data) && get_device(dev))
85                         break;
86         klist_iter_exit(&i);
87         return dev;
88 }
89 EXPORT_SYMBOL_GPL(driver_find_device);
90
91 /**
92  * driver_create_file - create sysfs file for driver.
93  * @drv: driver.
94  * @attr: driver attribute descriptor.
95  */
96 int driver_create_file(struct device_driver *drv,
97                        struct driver_attribute *attr)
98 {
99         int error;
100         if (drv)
101                 error = sysfs_create_file(&drv->p->kobj, &attr->attr);
102         else
103                 error = -EINVAL;
104         return error;
105 }
106 EXPORT_SYMBOL_GPL(driver_create_file);
107
108 /**
109  * driver_remove_file - remove sysfs file for driver.
110  * @drv: driver.
111  * @attr: driver attribute descriptor.
112  */
113 void driver_remove_file(struct device_driver *drv,
114                         struct driver_attribute *attr)
115 {
116         if (drv)
117                 sysfs_remove_file(&drv->p->kobj, &attr->attr);
118 }
119 EXPORT_SYMBOL_GPL(driver_remove_file);
120
121 /**
122  * driver_add_kobj - add a kobject below the specified driver
123  *
124  * You really don't want to do this, this is only here due to one looney
125  * iseries driver, go poke those developers if you are annoyed about
126  * this...
127  */
128 int driver_add_kobj(struct device_driver *drv, struct kobject *kobj,
129                     const char *fmt, ...)
130 {
131         va_list args;
132         char *name;
133
134         va_start(args, fmt);
135         name = kvasprintf(GFP_KERNEL, fmt, args);
136         va_end(args);
137
138         if (!name)
139                 return -ENOMEM;
140
141         return kobject_add(kobj, &drv->p->kobj, "%s", name);
142 }
143 EXPORT_SYMBOL_GPL(driver_add_kobj);
144
145 /**
146  * get_driver - increment driver reference count.
147  * @drv: driver.
148  */
149 struct device_driver *get_driver(struct device_driver *drv)
150 {
151         if (drv) {
152                 struct driver_private *priv;
153                 struct kobject *kobj;
154
155                 kobj = kobject_get(&drv->p->kobj);
156                 priv = to_driver(kobj);
157                 return priv->driver;
158         }
159         return NULL;
160 }
161 EXPORT_SYMBOL_GPL(get_driver);
162
163 /**
164  * put_driver - decrement driver's refcount.
165  * @drv: driver.
166  */
167 void put_driver(struct device_driver *drv)
168 {
169         kobject_put(&drv->p->kobj);
170 }
171 EXPORT_SYMBOL_GPL(put_driver);
172
173 static int driver_add_groups(struct device_driver *drv,
174                              struct attribute_group **groups)
175 {
176         int error = 0;
177         int i;
178
179         if (groups) {
180                 for (i = 0; groups[i]; i++) {
181                         error = sysfs_create_group(&drv->p->kobj, groups[i]);
182                         if (error) {
183                                 while (--i >= 0)
184                                         sysfs_remove_group(&drv->p->kobj,
185                                                            groups[i]);
186                                 break;
187                         }
188                 }
189         }
190         return error;
191 }
192
193 static void driver_remove_groups(struct device_driver *drv,
194                                  struct attribute_group **groups)
195 {
196         int i;
197
198         if (groups)
199                 for (i = 0; groups[i]; i++)
200                         sysfs_remove_group(&drv->p->kobj, groups[i]);
201 }
202
203 /**
204  * driver_register - register driver with bus
205  * @drv: driver to register
206  *
207  * We pass off most of the work to the bus_add_driver() call,
208  * since most of the things we have to do deal with the bus
209  * structures.
210  */
211 int driver_register(struct device_driver *drv)
212 {
213         int ret;
214
215         if ((drv->bus->probe && drv->probe) ||
216             (drv->bus->remove && drv->remove) ||
217             (drv->bus->shutdown && drv->shutdown))
218                 printk(KERN_WARNING "Driver '%s' needs updating - please use "
219                         "bus_type methods\n", drv->name);
220         ret = bus_add_driver(drv);
221         if (ret)
222                 return ret;
223         ret = driver_add_groups(drv, drv->groups);
224         if (ret)
225                 bus_remove_driver(drv);
226         return ret;
227 }
228 EXPORT_SYMBOL_GPL(driver_register);
229
230 /**
231  * driver_unregister - remove driver from system.
232  * @drv: driver.
233  *
234  * Again, we pass off most of the work to the bus-level call.
235  */
236 void driver_unregister(struct device_driver *drv)
237 {
238         driver_remove_groups(drv, drv->groups);
239         bus_remove_driver(drv);
240 }
241 EXPORT_SYMBOL_GPL(driver_unregister);
242
243 /**
244  * driver_find - locate driver on a bus by its name.
245  * @name: name of the driver.
246  * @bus: bus to scan for the driver.
247  *
248  * Call kset_find_obj() to iterate over list of drivers on
249  * a bus to find driver by name. Return driver if found.
250  *
251  * Note that kset_find_obj increments driver's reference count.
252  */
253 struct device_driver *driver_find(const char *name, struct bus_type *bus)
254 {
255         struct kobject *k = kset_find_obj(bus->p->drivers_kset, name);
256         struct driver_private *priv;
257
258         if (k) {
259                 priv = to_driver(k);
260                 return priv->driver;
261         }
262         return NULL;
263 }
264 EXPORT_SYMBOL_GPL(driver_find);