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/slab.h>
  17 #include <linux/string.h>
  18 #include "base.h"
  19
  20 static struct device *next_device(struct klist_iter *i)
  21 {
  22         struct klist_node *n = klist_next(i);
  23         struct device *dev = NULL;
  24         struct device_private *dev_prv;
  25
  26         if (n) {
  27                 dev_prv = to_device_private_driver(n);
  28                 dev = dev_prv->device;
  29         }
  30         return dev;
  31 }
  32
  33 /**
  34  * driver_for_each_device - Iterator for devices bound to a driver.
  35  * @drv: Driver we're iterating.
  36  * @start: Device to begin with
  37  * @data: Data to pass to the callback.
  38  * @fn: Function to call for each device.
  39  *
  40  * Iterate over the @drv's list of devices calling @fn for each one.
  41  */
  42 int driver_for_each_device(struct device_driver *drv, struct device *start,
  43                            void *data, int (*fn)(struct device *, void *))
  44 {
  45         struct klist_iter i;
  46         struct device *dev;
  47         int error = 0;
  48
  49         if (!drv)
  50                 return -EINVAL;
  51
  52         error = klist_iter_init_node(&drv->p->klist_devices, &i,
  53                                      start ? &start->p->knode_driver : NULL);
  54         if (!error) {
  55                 while ((dev = next_device(&i)) && !error)
  56                         error = fn(dev, data);
  57                 klist_iter_exit(&i);
  58         }
  59         return error;
  60 }
  61 EXPORT_SYMBOL_GPL(driver_for_each_device);
  62
  63 /**
  64  * driver_find_device - device iterator for locating a particular device.
  65  * @drv: The device's driver
  66  * @start: Device to begin with
  67  * @data: Data to pass to match function
  68  * @match: Callback function to check device
  69  *
  70  * This is similar to the driver_for_each_device() function above, but
  71  * it returns a reference to a device that is 'found' for later use, as
  72  * determined by the @match callback.
  73  *
  74  * The callback should return 0 if the device doesn't match and non-zero
  75  * if it does.  If the callback returns non-zero, this function will
  76  * return to the caller and not iterate over any more devices.
  77  */
  78 struct device *driver_find_device(struct device_driver *drv,
  79                                   struct device *start, void *data,
  80                                   int (*match)(struct device *dev, void *data))
  81 {
  82         struct klist_iter i;
  83         struct device *dev;
  84
  85         if (!drv)
  86                 return NULL;
  87
  88         if (klist_iter_init_node(&drv->p->klist_devices, &i,
  89                                  (start ? &start->p->knode_driver : NULL)) < 0)
  90                 return NULL;
  91
  92         while ((dev = next_device(&i)))
  93                 if (match(dev, data) && get_device(dev))
  94                         break;
  95         klist_iter_exit(&i);
  96         return dev;
  97 }
  98 EXPORT_SYMBOL_GPL(driver_find_device);
  99
 100 /**
 101  * driver_create_file - create sysfs file for driver.
 102  * @drv: driver.
 103  * @attr: driver attribute descriptor.
 104  */
 105 int driver_create_file(struct device_driver *drv,
 106                        const struct driver_attribute *attr)
 107 {
 108         int error;
 109         if (drv)
 110                 error = sysfs_create_file(&drv->p->kobj, &attr->attr);
 111         else
 112                 error = -EINVAL;
 113         return error;
 114 }
 115 EXPORT_SYMBOL_GPL(driver_create_file);
 116
 117 /**
 118  * driver_remove_file - remove sysfs file for driver.
 119  * @drv: driver.
 120  * @attr: driver attribute descriptor.
 121  */
 122 void driver_remove_file(struct device_driver *drv,
 123                         const struct driver_attribute *attr)
 124 {
 125         if (drv)
 126                 sysfs_remove_file(&drv->p->kobj, &attr->attr);
 127 }
 128 EXPORT_SYMBOL_GPL(driver_remove_file);
 129
 130 static int driver_add_groups(struct device_driver *drv,
 131                              const struct attribute_group **groups)
 132 {
 133         int error = 0;
 134         int i;
 135
 136         if (groups) {
 137                 for (i = 0; groups[i]; i++) {
 138                         error = sysfs_create_group(&drv->p->kobj, groups[i]);
 139                         if (error) {
 140                                 while (--i >= 0)
 141                                         sysfs_remove_group(&drv->p->kobj,
 142                                                            groups[i]);
 143                                 break;
 144                         }
 145                 }
 146         }
 147         return error;
 148 }
 149
 150 static void driver_remove_groups(struct device_driver *drv,
 151                                  const struct attribute_group **groups)
 152 {
 153         int i;
 154
 155         if (groups)
 156                 for (i = 0; groups[i]; i++)
 157                         sysfs_remove_group(&drv->p->kobj, groups[i]);
 158 }
 159
 160 /**
 161  * driver_register - register driver with bus
 162  * @drv: driver to register
 163  *
 164  * We pass off most of the work to the bus_add_driver() call,
 165  * since most of the things we have to do deal with the bus
 166  * structures.
 167  */
 168 int driver_register(struct device_driver *drv)
 169 {
 170         int ret;
 171         struct device_driver *other;
 172
 173         BUG_ON(!drv->bus->p);
 174
 175         if ((drv->bus->probe && drv->probe) ||
 176             (drv->bus->remove && drv->remove) ||
 177             (drv->bus->shutdown && drv->shutdown))
 178                 printk(KERN_WARNING "Driver '%s' needs updating - please use "
 179                         "bus_type methods\n", drv->name);
 180
 181         other = driver_find(drv->name, drv->bus);
 182         if (other) {
 183                 printk(KERN_ERR "Error: Driver '%s' is already registered, "
 184                         "aborting...\n", drv->name);
 185                 return -EBUSY;
 186         }
 187
 188         ret = bus_add_driver(drv);
 189         if (ret)
 190                 return ret;
 191         ret = driver_add_groups(drv, drv->groups);
 192         if (ret)
 193                 bus_remove_driver(drv);
 194         return ret;
 195 }
 196 EXPORT_SYMBOL_GPL(driver_register);
 197
 198 /**
 199  * driver_unregister - remove driver from system.
 200  * @drv: driver.
 201  *
 202  * Again, we pass off most of the work to the bus-level call.
 203  */
 204 void driver_unregister(struct device_driver *drv)
 205 {
 206         if (!drv || !drv->p) {
 207                 WARN(1, "Unexpected driver unregister!\n");
 208                 return;
 209         }
 210         driver_remove_groups(drv, drv->groups);
 211         bus_remove_driver(drv);
 212 }
 213 EXPORT_SYMBOL_GPL(driver_unregister);
 214
 215 /**
 216  * driver_find - locate driver on a bus by its name.
 217  * @name: name of the driver.
 218  * @bus: bus to scan for the driver.
 219  *
 220  * Call kset_find_obj() to iterate over list of drivers on
 221  * a bus to find driver by name. Return driver if found.
 222  *
 223  * This routine provides no locking to prevent the driver it returns
 224  * from being unregistered or unloaded while the caller is using it.
 225  * The caller is responsible for preventing this.
 226  */
 227 struct device_driver *driver_find(const char *name, struct bus_type *bus)
 228 {
 229         struct kobject *k = kset_find_obj(bus->p->drivers_kset, name);
 230         struct driver_private *priv;
 231
 232         if (k) {
 233                 /* Drop reference added by kset_find_obj() */
 234                 kobject_put(k);
 235                 priv = to_driver(k);
 236                 return priv->driver;
 237         }
 238         return NULL;
 239 }
 240 EXPORT_SYMBOL_GPL(driver_find);