2  *      Functions to handle I2O drivers (OSMs) and I2O bus type for sysfs
 
   4  *      Copyright (C) 2004      Markus Lidel <Markus.Lidel@shadowconnect.com>
 
   6  *      This program is free software; you can redistribute it and/or modify it
 
   7  *      under the terms of the GNU General Public License as published by the
 
   8  *      Free Software Foundation; either version 2 of the License, or (at your
 
   9  *      option) any later version.
 
  12  *              Markus Lidel <Markus.Lidel@shadowconnect.com>
 
  16 #include <linux/device.h>
 
  17 #include <linux/module.h>
 
  18 #include <linux/rwsem.h>
 
  19 #include <linux/i2o.h>
 
  20 #include <linux/workqueue.h>
 
  21 #include <linux/string.h>
 
  22 #include <linux/slab.h>
 
  25 #define OSM_NAME        "i2o"
 
  27 /* max_drivers - Maximum I2O drivers (OSMs) which could be registered */
 
  28 static unsigned int i2o_max_drivers = I2O_MAX_DRIVERS;
 
  29 module_param_named(max_drivers, i2o_max_drivers, uint, 0);
 
  30 MODULE_PARM_DESC(max_drivers, "maximum number of OSM's to support");
 
  32 /* I2O drivers lock and array */
 
  33 static spinlock_t i2o_drivers_lock;
 
  34 static struct i2o_driver **i2o_drivers;
 
  37  *      i2o_bus_match - Tell if a I2O device class id match the class ids of
 
  38  *                      the I2O driver (OSM)
 
  40  *      @dev: device which should be verified
 
  41  *      @drv: the driver to match against
 
  43  *      Used by the bus to check if the driver wants to handle the device.
 
  45  *      Returns 1 if the class ids of the driver match the class id of the
 
  46  *      device, otherwise 0.
 
  48 static int i2o_bus_match(struct device *dev, struct device_driver *drv)
 
  50         struct i2o_device *i2o_dev = to_i2o_device(dev);
 
  51         struct i2o_driver *i2o_drv = to_i2o_driver(drv);
 
  52         struct i2o_class_id *ids = i2o_drv->classes;
 
  55                 while (ids->class_id != I2O_CLASS_END) {
 
  56                         if (ids->class_id == i2o_dev->lct_data.class_id)
 
  64 struct bus_type i2o_bus_type = {
 
  66         .match = i2o_bus_match,
 
  67         .dev_attrs = i2o_device_attrs
 
  71  *      i2o_driver_register - Register a I2O driver (OSM) in the I2O core
 
  72  *      @drv: I2O driver which should be registered
 
  74  *      Registers the OSM drv in the I2O core and creates an event queues if
 
  77  *      Returns 0 on success or negative error code on failure.
 
  79 int i2o_driver_register(struct i2o_driver *drv)
 
  81         struct i2o_controller *c;
 
  86         osm_debug("Register driver %s\n", drv->name);
 
  89                 drv->event_queue = create_workqueue(drv->name);
 
  90                 if (!drv->event_queue) {
 
  91                         osm_err("Could not initialize event queue for driver "
 
  95                 osm_debug("Event queue initialized for driver %s\n", drv->name);
 
  97                 drv->event_queue = NULL;
 
  99         drv->driver.name = drv->name;
 
 100         drv->driver.bus = &i2o_bus_type;
 
 102         spin_lock_irqsave(&i2o_drivers_lock, flags);
 
 104         for (i = 0; i2o_drivers[i]; i++)
 
 105                 if (i >= i2o_max_drivers) {
 
 106                         osm_err("too many drivers registered, increase "
 
 108                         spin_unlock_irqrestore(&i2o_drivers_lock, flags);
 
 113         i2o_drivers[i] = drv;
 
 115         spin_unlock_irqrestore(&i2o_drivers_lock, flags);
 
 117         osm_debug("driver %s gets context id %d\n", drv->name, drv->context);
 
 119         list_for_each_entry(c, &i2o_controllers, list) {
 
 120                 struct i2o_device *i2o_dev;
 
 122                 i2o_driver_notify_controller_add(drv, c);
 
 123                 list_for_each_entry(i2o_dev, &c->devices, list)
 
 124                     i2o_driver_notify_device_add(drv, i2o_dev);
 
 127         rc = driver_register(&drv->driver);
 
 129                 destroy_workqueue(drv->event_queue);
 
 135  *      i2o_driver_unregister - Unregister a I2O driver (OSM) from the I2O core
 
 136  *      @drv: I2O driver which should be unregistered
 
 138  *      Unregisters the OSM drv from the I2O core and cleanup event queues if
 
 141 void i2o_driver_unregister(struct i2o_driver *drv)
 
 143         struct i2o_controller *c;
 
 146         osm_debug("unregister driver %s\n", drv->name);
 
 148         driver_unregister(&drv->driver);
 
 150         list_for_each_entry(c, &i2o_controllers, list) {
 
 151                 struct i2o_device *i2o_dev;
 
 153                 list_for_each_entry(i2o_dev, &c->devices, list)
 
 154                     i2o_driver_notify_device_remove(drv, i2o_dev);
 
 156                 i2o_driver_notify_controller_remove(drv, c);
 
 159         spin_lock_irqsave(&i2o_drivers_lock, flags);
 
 160         i2o_drivers[drv->context] = NULL;
 
 161         spin_unlock_irqrestore(&i2o_drivers_lock, flags);
 
 163         if (drv->event_queue) {
 
 164                 destroy_workqueue(drv->event_queue);
 
 165                 drv->event_queue = NULL;
 
 166                 osm_debug("event queue removed for %s\n", drv->name);
 
 171  *      i2o_driver_dispatch - dispatch an I2O reply message
 
 172  *      @c: I2O controller of the message
 
 173  *      @m: I2O message number
 
 174  *      @msg: I2O message to be delivered
 
 176  *      The reply is delivered to the driver from which the original message
 
 177  *      was. This function is only called from interrupt context.
 
 179  *      Returns 0 on success and the message should not be flushed. Returns > 0
 
 180  *      on success and if the message should be flushed afterwords. Returns
 
 181  *      negative error code on failure (the message will be flushed too).
 
 183 int i2o_driver_dispatch(struct i2o_controller *c, u32 m)
 
 185         struct i2o_driver *drv;
 
 186         struct i2o_message *msg = i2o_msg_out_to_virt(c, m);
 
 187         u32 context = le32_to_cpu(msg->u.s.icntxt);
 
 190         if (unlikely(context >= i2o_max_drivers)) {
 
 191                 osm_warn("%s: Spurious reply to unknown driver %d\n", c->name,
 
 196         spin_lock_irqsave(&i2o_drivers_lock, flags);
 
 197         drv = i2o_drivers[context];
 
 198         spin_unlock_irqrestore(&i2o_drivers_lock, flags);
 
 200         if (unlikely(!drv)) {
 
 201                 osm_warn("%s: Spurious reply to unknown driver %d\n", c->name,
 
 206         if ((le32_to_cpu(msg->u.head[1]) >> 24) == I2O_CMD_UTIL_EVT_REGISTER) {
 
 207                 struct i2o_device *dev, *tmp;
 
 208                 struct i2o_event *evt;
 
 210                 u16 tid = le32_to_cpu(msg->u.head[1]) & 0xfff;
 
 212                 osm_debug("event received from device %d\n", tid);
 
 217                 /* cut of header from message size (in 32-bit words) */
 
 218                 size = (le32_to_cpu(msg->u.head[0]) >> 16) - 5;
 
 220                 evt = kzalloc(size * 4 + sizeof(*evt), GFP_ATOMIC);
 
 225                 evt->tcntxt = le32_to_cpu(msg->u.s.tcntxt);
 
 226                 evt->event_indicator = le32_to_cpu(msg->body[0]);
 
 227                 memcpy(&evt->data, &msg->body[1], size * 4);
 
 229                 list_for_each_entry_safe(dev, tmp, &c->devices, list)
 
 230                     if (dev->lct_data.tid == tid) {
 
 235                 INIT_WORK(&evt->work, (void (*)(void *))drv->event, evt);
 
 236                 queue_work(drv->event_queue, &evt->work);
 
 240         if (unlikely(!drv->reply)) {
 
 241                 osm_debug("%s: Reply to driver %s, but no reply function"
 
 242                           " defined!\n", c->name, drv->name);
 
 246         return drv->reply(c, m, msg);
 
 250  *      i2o_driver_notify_controller_add_all - Send notify of added controller
 
 253  *      Send notifications to all registered drivers that a new controller was
 
 256 void i2o_driver_notify_controller_add_all(struct i2o_controller *c)
 
 259         struct i2o_driver *drv;
 
 261         for (i = 0; i < I2O_MAX_DRIVERS; i++) {
 
 262                 drv = i2o_drivers[i];
 
 265                         i2o_driver_notify_controller_add(drv, c);
 
 270  *      i2o_driver_notify_controller_remove_all - Send notify of removed
 
 271  *                                                controller to all I2O drivers
 
 273  *      Send notifications to all registered drivers that a controller was
 
 276 void i2o_driver_notify_controller_remove_all(struct i2o_controller *c)
 
 279         struct i2o_driver *drv;
 
 281         for (i = 0; i < I2O_MAX_DRIVERS; i++) {
 
 282                 drv = i2o_drivers[i];
 
 285                         i2o_driver_notify_controller_remove(drv, c);
 
 290  *      i2o_driver_notify_device_add_all - Send notify of added device to all
 
 293  *      Send notifications to all registered drivers that a device was added.
 
 295 void i2o_driver_notify_device_add_all(struct i2o_device *i2o_dev)
 
 298         struct i2o_driver *drv;
 
 300         for (i = 0; i < I2O_MAX_DRIVERS; i++) {
 
 301                 drv = i2o_drivers[i];
 
 304                         i2o_driver_notify_device_add(drv, i2o_dev);
 
 309  *      i2o_driver_notify_device_remove_all - Send notify of removed device to
 
 312  *      Send notifications to all registered drivers that a device was removed.
 
 314 void i2o_driver_notify_device_remove_all(struct i2o_device *i2o_dev)
 
 317         struct i2o_driver *drv;
 
 319         for (i = 0; i < I2O_MAX_DRIVERS; i++) {
 
 320                 drv = i2o_drivers[i];
 
 323                         i2o_driver_notify_device_remove(drv, i2o_dev);
 
 328  *      i2o_driver_init - initialize I2O drivers (OSMs)
 
 330  *      Registers the I2O bus and allocate memory for the array of OSMs.
 
 332  *      Returns 0 on success or negative error code on failure.
 
 334 int __init i2o_driver_init(void)
 
 338         spin_lock_init(&i2o_drivers_lock);
 
 340         if ((i2o_max_drivers < 2) || (i2o_max_drivers > 64) ||
 
 341             ((i2o_max_drivers ^ (i2o_max_drivers - 1)) !=
 
 342              (2 * i2o_max_drivers - 1))) {
 
 343                 osm_warn("max_drivers set to %d, but must be >=2 and <= 64 and "
 
 344                          "a power of 2\n", i2o_max_drivers);
 
 345                 i2o_max_drivers = I2O_MAX_DRIVERS;
 
 347         osm_info("max drivers = %d\n", i2o_max_drivers);
 
 350             kzalloc(i2o_max_drivers * sizeof(*i2o_drivers), GFP_KERNEL);
 
 354         rc = bus_register(&i2o_bus_type);
 
 363  *      i2o_driver_exit - clean up I2O drivers (OSMs)
 
 365  *      Unregisters the I2O bus and free driver array.
 
 367 void __exit i2o_driver_exit(void)
 
 369         bus_unregister(&i2o_bus_type);
 
 373 EXPORT_SYMBOL(i2o_driver_register);
 
 374 EXPORT_SYMBOL(i2o_driver_unregister);
 
 375 EXPORT_SYMBOL(i2o_driver_notify_controller_add_all);
 
 376 EXPORT_SYMBOL(i2o_driver_notify_controller_remove_all);
 
 377 EXPORT_SYMBOL(i2o_driver_notify_device_add_all);
 
 378 EXPORT_SYMBOL(i2o_driver_notify_device_remove_all);