Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 6 | * Copyright (c) 2007 Greg Kroah-Hartman <gregkh@suse.de> |
| 7 | * Copyright (c) 2007 Novell Inc. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 8 | * |
| 9 | * This file is released under the GPLv2 |
| 10 | * |
| 11 | */ |
| 12 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 20 | |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 21 | |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 22 | static struct device *next_device(struct klist_iter *i) |
mochel@digitalimplant.org | 94e7b1c5 | 2005-03-21 12:25:36 -0800 | [diff] [blame] | 23 | { |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 24 | struct klist_node *n = klist_next(i); |
mochel@digitalimplant.org | 94e7b1c5 | 2005-03-21 12:25:36 -0800 | [diff] [blame] | 25 | return n ? container_of(n, struct device, knode_driver) : NULL; |
| 26 | } |
| 27 | |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 28 | /** |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 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. |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 34 | * |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 35 | * Iterate over the @drv's list of devices calling @fn for each one. |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 36 | */ |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 37 | int driver_for_each_device(struct device_driver *drv, struct device *start, |
| 38 | void *data, int (*fn)(struct device *, void *)) |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 39 | { |
mochel@digitalimplant.org | 94e7b1c5 | 2005-03-21 12:25:36 -0800 | [diff] [blame] | 40 | struct klist_iter i; |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 41 | struct device *dev; |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 42 | int error = 0; |
| 43 | |
mochel@digitalimplant.org | 94e7b1c5 | 2005-03-21 12:25:36 -0800 | [diff] [blame] | 44 | if (!drv) |
| 45 | return -EINVAL; |
| 46 | |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 47 | klist_iter_init_node(&drv->p->klist_devices, &i, |
mochel@digitalimplant.org | 94e7b1c5 | 2005-03-21 12:25:36 -0800 | [diff] [blame] | 48 | start ? &start->knode_driver : NULL); |
| 49 | while ((dev = next_device(&i)) && !error) |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 50 | error = fn(dev, data); |
mochel@digitalimplant.org | 94e7b1c5 | 2005-03-21 12:25:36 -0800 | [diff] [blame] | 51 | klist_iter_exit(&i); |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 52 | return error; |
| 53 | } |
gregkh@suse.de | 126eddf | 2005-03-22 12:17:13 -0800 | [diff] [blame] | 54 | EXPORT_SYMBOL_GPL(driver_for_each_device); |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 55 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | /** |
Cornelia Huck | 0edb586 | 2005-06-22 16:59:51 +0200 | [diff] [blame] | 57 | * driver_find_device - device iterator for locating a particular device. |
Randy Dunlap | c41455f | 2005-10-23 11:59:14 -0700 | [diff] [blame] | 58 | * @drv: The device's driver |
Cornelia Huck | 0edb586 | 2005-06-22 16:59:51 +0200 | [diff] [blame] | 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 | */ |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 71 | struct device *driver_find_device(struct device_driver *drv, |
| 72 | struct device *start, void *data, |
| 73 | int (*match)(struct device *dev, void *data)) |
Cornelia Huck | 0edb586 | 2005-06-22 16:59:51 +0200 | [diff] [blame] | 74 | { |
| 75 | struct klist_iter i; |
| 76 | struct device *dev; |
| 77 | |
| 78 | if (!drv) |
| 79 | return NULL; |
| 80 | |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 81 | klist_iter_init_node(&drv->p->klist_devices, &i, |
Cornelia Huck | 0edb586 | 2005-06-22 16:59:51 +0200 | [diff] [blame] | 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 | /** |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 92 | * driver_create_file - create sysfs file for driver. |
| 93 | * @drv: driver. |
| 94 | * @attr: driver attribute descriptor. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 95 | */ |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 96 | int driver_create_file(struct device_driver *drv, |
| 97 | struct driver_attribute *attr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 98 | { |
| 99 | int error; |
| 100 | if (get_driver(drv)) { |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 101 | error = sysfs_create_file(&drv->p->kobj, &attr->attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 102 | put_driver(drv); |
| 103 | } else |
| 104 | error = -EINVAL; |
| 105 | return error; |
| 106 | } |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 107 | EXPORT_SYMBOL_GPL(driver_create_file); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 108 | |
| 109 | /** |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 110 | * driver_remove_file - remove sysfs file for driver. |
| 111 | * @drv: driver. |
| 112 | * @attr: driver attribute descriptor. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 113 | */ |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 114 | void driver_remove_file(struct device_driver *drv, |
| 115 | struct driver_attribute *attr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 116 | { |
| 117 | if (get_driver(drv)) { |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 118 | sysfs_remove_file(&drv->p->kobj, &attr->attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 119 | put_driver(drv); |
| 120 | } |
| 121 | } |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 122 | EXPORT_SYMBOL_GPL(driver_remove_file); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 123 | |
| 124 | /** |
Greg Kroah-Hartman | cbe9c59 | 2007-12-19 15:54:39 -0400 | [diff] [blame] | 125 | * driver_add_kobj - add a kobject below the specified driver |
| 126 | * |
| 127 | * You really don't want to do this, this is only here due to one looney |
| 128 | * iseries driver, go poke those developers if you are annoyed about |
| 129 | * this... |
| 130 | */ |
| 131 | int driver_add_kobj(struct device_driver *drv, struct kobject *kobj, |
| 132 | const char *fmt, ...) |
| 133 | { |
| 134 | va_list args; |
| 135 | char *name; |
| 136 | |
| 137 | va_start(args, fmt); |
| 138 | name = kvasprintf(GFP_KERNEL, fmt, args); |
| 139 | va_end(args); |
| 140 | |
| 141 | if (!name) |
| 142 | return -ENOMEM; |
| 143 | |
Greg Kroah-Hartman | b2d6db5 | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 144 | return kobject_add(kobj, &drv->p->kobj, "%s", name); |
Greg Kroah-Hartman | cbe9c59 | 2007-12-19 15:54:39 -0400 | [diff] [blame] | 145 | } |
| 146 | EXPORT_SYMBOL_GPL(driver_add_kobj); |
| 147 | |
| 148 | /** |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 149 | * get_driver - increment driver reference count. |
| 150 | * @drv: driver. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 | */ |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 152 | struct device_driver *get_driver(struct device_driver *drv) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | { |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 154 | if (drv) { |
| 155 | struct driver_private *priv; |
| 156 | struct kobject *kobj; |
| 157 | |
| 158 | kobj = kobject_get(&drv->p->kobj); |
| 159 | priv = to_driver(kobj); |
| 160 | return priv->driver; |
| 161 | } |
| 162 | return NULL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 163 | } |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 164 | EXPORT_SYMBOL_GPL(get_driver); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 165 | |
| 166 | /** |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 167 | * put_driver - decrement driver's refcount. |
| 168 | * @drv: driver. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 169 | */ |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 170 | void put_driver(struct device_driver *drv) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 171 | { |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 172 | kobject_put(&drv->p->kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 173 | } |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 174 | EXPORT_SYMBOL_GPL(put_driver); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 175 | |
Cornelia Huck | 57c7453 | 2007-12-05 12:50:23 +0100 | [diff] [blame] | 176 | static int driver_add_groups(struct device_driver *drv, |
| 177 | struct attribute_group **groups) |
| 178 | { |
| 179 | int error = 0; |
| 180 | int i; |
| 181 | |
| 182 | if (groups) { |
| 183 | for (i = 0; groups[i]; i++) { |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 184 | error = sysfs_create_group(&drv->p->kobj, groups[i]); |
Cornelia Huck | 57c7453 | 2007-12-05 12:50:23 +0100 | [diff] [blame] | 185 | if (error) { |
| 186 | while (--i >= 0) |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 187 | sysfs_remove_group(&drv->p->kobj, |
Cornelia Huck | 57c7453 | 2007-12-05 12:50:23 +0100 | [diff] [blame] | 188 | groups[i]); |
| 189 | break; |
| 190 | } |
| 191 | } |
| 192 | } |
| 193 | return error; |
| 194 | } |
| 195 | |
| 196 | static void driver_remove_groups(struct device_driver *drv, |
| 197 | struct attribute_group **groups) |
| 198 | { |
| 199 | int i; |
| 200 | |
| 201 | if (groups) |
| 202 | for (i = 0; groups[i]; i++) |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 203 | sysfs_remove_group(&drv->p->kobj, groups[i]); |
Cornelia Huck | 57c7453 | 2007-12-05 12:50:23 +0100 | [diff] [blame] | 204 | } |
| 205 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 206 | /** |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 207 | * driver_register - register driver with bus |
| 208 | * @drv: driver to register |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 209 | * |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 210 | * We pass off most of the work to the bus_add_driver() call, |
| 211 | * since most of the things we have to do deal with the bus |
| 212 | * structures. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 213 | */ |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 214 | int driver_register(struct device_driver *drv) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 215 | { |
Cornelia Huck | 57c7453 | 2007-12-05 12:50:23 +0100 | [diff] [blame] | 216 | int ret; |
| 217 | |
Russell King | 594c828 | 2006-01-05 14:29:51 +0000 | [diff] [blame] | 218 | if ((drv->bus->probe && drv->probe) || |
| 219 | (drv->bus->remove && drv->remove) || |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 220 | (drv->bus->shutdown && drv->shutdown)) |
| 221 | printk(KERN_WARNING "Driver '%s' needs updating - please use " |
| 222 | "bus_type methods\n", drv->name); |
Cornelia Huck | 57c7453 | 2007-12-05 12:50:23 +0100 | [diff] [blame] | 223 | ret = bus_add_driver(drv); |
| 224 | if (ret) |
| 225 | return ret; |
| 226 | ret = driver_add_groups(drv, drv->groups); |
| 227 | if (ret) |
| 228 | bus_remove_driver(drv); |
| 229 | return ret; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 230 | } |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 231 | EXPORT_SYMBOL_GPL(driver_register); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 232 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 233 | /** |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 234 | * driver_unregister - remove driver from system. |
| 235 | * @drv: driver. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 236 | * |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 237 | * Again, we pass off most of the work to the bus-level call. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 238 | */ |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 239 | void driver_unregister(struct device_driver *drv) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 240 | { |
Cornelia Huck | 57c7453 | 2007-12-05 12:50:23 +0100 | [diff] [blame] | 241 | driver_remove_groups(drv, drv->groups); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 242 | bus_remove_driver(drv); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 243 | } |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 244 | EXPORT_SYMBOL_GPL(driver_unregister); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 245 | |
| 246 | /** |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 247 | * driver_find - locate driver on a bus by its name. |
| 248 | * @name: name of the driver. |
| 249 | * @bus: bus to scan for the driver. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 250 | * |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 251 | * Call kset_find_obj() to iterate over list of drivers on |
| 252 | * a bus to find driver by name. Return driver if found. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 253 | * |
Greg Kroah-Hartman | 4a3ad20 | 2008-01-24 22:50:12 -0800 | [diff] [blame] | 254 | * Note that kset_find_obj increments driver's reference count. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 255 | */ |
| 256 | struct device_driver *driver_find(const char *name, struct bus_type *bus) |
| 257 | { |
Greg Kroah-Hartman | c6f7e72 | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 258 | struct kobject *k = kset_find_obj(bus->p->drivers_kset, name); |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 259 | struct driver_private *priv; |
| 260 | |
| 261 | if (k) { |
| 262 | priv = to_driver(k); |
| 263 | return priv->driver; |
| 264 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 265 | return NULL; |
| 266 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 267 | EXPORT_SYMBOL_GPL(driver_find); |