blob: 1b18a0d1d05bdfd3a7ce364b221ee0a2ae59f5cd [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Functions to handle I2O drivers (OSMs) and I2O bus type for sysfs
3 *
4 * Copyright (C) 2004 Markus Lidel <Markus.Lidel@shadowconnect.com>
5 *
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.
10 *
11 * Fixes/additions:
12 * Markus Lidel <Markus.Lidel@shadowconnect.com>
13 * initial version.
14 */
15
16#include <linux/device.h>
17#include <linux/module.h>
18#include <linux/rwsem.h>
19#include <linux/i2o.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080020#include <linux/workqueue.h>
21#include <linux/string.h>
22#include <linux/slab.h>
Markus Lidel9e875452005-06-23 22:02:21 -070023#include "core.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Markus Lidelf88e1192005-06-23 22:02:14 -070025#define OSM_NAME "i2o"
Markus Lidel61fbfa82005-06-23 22:02:11 -070026
Linus Torvalds1da177e2005-04-16 15:20:36 -070027/* max_drivers - Maximum I2O drivers (OSMs) which could be registered */
Markus Lidel9e875452005-06-23 22:02:21 -070028static unsigned int i2o_max_drivers = I2O_MAX_DRIVERS;
Linus Torvalds1da177e2005-04-16 15:20:36 -070029module_param_named(max_drivers, i2o_max_drivers, uint, 0);
30MODULE_PARM_DESC(max_drivers, "maximum number of OSM's to support");
31
32/* I2O drivers lock and array */
33static spinlock_t i2o_drivers_lock;
34static struct i2o_driver **i2o_drivers;
35
36/**
Randy Dunlapd9489fb2006-12-06 20:38:43 -080037 * i2o_bus_match - Tell if I2O device class id matches the class ids of the I2O driver (OSM)
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 * @dev: device which should be verified
39 * @drv: the driver to match against
40 *
41 * Used by the bus to check if the driver wants to handle the device.
42 *
43 * Returns 1 if the class ids of the driver match the class id of the
44 * device, otherwise 0.
45 */
46static int i2o_bus_match(struct device *dev, struct device_driver *drv)
47{
48 struct i2o_device *i2o_dev = to_i2o_device(dev);
49 struct i2o_driver *i2o_drv = to_i2o_driver(drv);
50 struct i2o_class_id *ids = i2o_drv->classes;
51
52 if (ids)
53 while (ids->class_id != I2O_CLASS_END) {
54 if (ids->class_id == i2o_dev->lct_data.class_id)
55 return 1;
56 ids++;
57 }
58 return 0;
59};
60
61/* I2O bus type */
62struct bus_type i2o_bus_type = {
63 .name = "i2o",
64 .match = i2o_bus_match,
Greg Kroah-Hartmanba6857b2013-10-07 18:27:42 -070065 .dev_groups = i2o_device_groups,
Linus Torvalds1da177e2005-04-16 15:20:36 -070066};
67
68/**
69 * i2o_driver_register - Register a I2O driver (OSM) in the I2O core
70 * @drv: I2O driver which should be registered
71 *
72 * Registers the OSM drv in the I2O core and creates an event queues if
73 * necessary.
74 *
75 * Returns 0 on success or negative error code on failure.
76 */
77int i2o_driver_register(struct i2o_driver *drv)
78{
79 struct i2o_controller *c;
80 int i;
81 int rc = 0;
82 unsigned long flags;
83
Markus Lidelf88e1192005-06-23 22:02:14 -070084 osm_debug("Register driver %s\n", drv->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86 if (drv->event) {
Kees Cookd8537542013-07-03 15:04:57 -070087 drv->event_queue = alloc_workqueue("%s", WQ_MEM_RECLAIM, 1,
88 drv->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 if (!drv->event_queue) {
Markus Lidelf88e1192005-06-23 22:02:14 -070090 osm_err("Could not initialize event queue for driver "
91 "%s\n", drv->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 return -EFAULT;
93 }
Markus Lidelf88e1192005-06-23 22:02:14 -070094 osm_debug("Event queue initialized for driver %s\n", drv->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 } else
96 drv->event_queue = NULL;
97
98 drv->driver.name = drv->name;
99 drv->driver.bus = &i2o_bus_type;
100
101 spin_lock_irqsave(&i2o_drivers_lock, flags);
102
103 for (i = 0; i2o_drivers[i]; i++)
104 if (i >= i2o_max_drivers) {
Markus Lidelf88e1192005-06-23 22:02:14 -0700105 osm_err("too many drivers registered, increase "
106 "max_drivers\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 spin_unlock_irqrestore(&i2o_drivers_lock, flags);
Wei Yongjun10992432013-11-12 15:10:24 -0800108 rc = -EFAULT;
109 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 }
111
112 drv->context = i;
113 i2o_drivers[i] = drv;
114
115 spin_unlock_irqrestore(&i2o_drivers_lock, flags);
116
Markus Lidelf88e1192005-06-23 22:02:14 -0700117 osm_debug("driver %s gets context id %d\n", drv->name, drv->context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
119 list_for_each_entry(c, &i2o_controllers, list) {
120 struct i2o_device *i2o_dev;
121
122 i2o_driver_notify_controller_add(drv, c);
123 list_for_each_entry(i2o_dev, &c->devices, list)
Markus Lidelf33213e2005-06-23 22:02:23 -0700124 i2o_driver_notify_device_add(drv, i2o_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 }
126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 rc = driver_register(&drv->driver);
Wei Yongjun10992432013-11-12 15:10:24 -0800128 if (rc)
129 goto out;
130
131 return 0;
132out:
133 if (drv->event_queue) {
134 destroy_workqueue(drv->event_queue);
135 drv->event_queue = NULL;
Akinobu Mitae578e9a2007-05-23 13:58:05 -0700136 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138 return rc;
139};
140
141/**
142 * i2o_driver_unregister - Unregister a I2O driver (OSM) from the I2O core
143 * @drv: I2O driver which should be unregistered
144 *
145 * Unregisters the OSM drv from the I2O core and cleanup event queues if
146 * necessary.
147 */
148void i2o_driver_unregister(struct i2o_driver *drv)
149{
150 struct i2o_controller *c;
151 unsigned long flags;
152
Markus Lidelf88e1192005-06-23 22:02:14 -0700153 osm_debug("unregister driver %s\n", drv->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
155 driver_unregister(&drv->driver);
156
157 list_for_each_entry(c, &i2o_controllers, list) {
158 struct i2o_device *i2o_dev;
159
160 list_for_each_entry(i2o_dev, &c->devices, list)
161 i2o_driver_notify_device_remove(drv, i2o_dev);
162
163 i2o_driver_notify_controller_remove(drv, c);
164 }
165
166 spin_lock_irqsave(&i2o_drivers_lock, flags);
167 i2o_drivers[drv->context] = NULL;
168 spin_unlock_irqrestore(&i2o_drivers_lock, flags);
169
170 if (drv->event_queue) {
171 destroy_workqueue(drv->event_queue);
172 drv->event_queue = NULL;
Markus Lidelf88e1192005-06-23 22:02:14 -0700173 osm_debug("event queue removed for %s\n", drv->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 }
175};
176
177/**
178 * i2o_driver_dispatch - dispatch an I2O reply message
179 * @c: I2O controller of the message
180 * @m: I2O message number
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 *
182 * The reply is delivered to the driver from which the original message
183 * was. This function is only called from interrupt context.
184 *
185 * Returns 0 on success and the message should not be flushed. Returns > 0
186 * on success and if the message should be flushed afterwords. Returns
187 * negative error code on failure (the message will be flushed too).
188 */
Markus Lidelf88e1192005-06-23 22:02:14 -0700189int i2o_driver_dispatch(struct i2o_controller *c, u32 m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190{
191 struct i2o_driver *drv;
Markus Lidel9e875452005-06-23 22:02:21 -0700192 struct i2o_message *msg = i2o_msg_out_to_virt(c, m);
193 u32 context = le32_to_cpu(msg->u.s.icntxt);
Markus Lidelf10378f2005-06-23 22:02:16 -0700194 unsigned long flags;
195
Markus Lidel61fbfa82005-06-23 22:02:11 -0700196 if (unlikely(context >= i2o_max_drivers)) {
Markus Lidelf88e1192005-06-23 22:02:14 -0700197 osm_warn("%s: Spurious reply to unknown driver %d\n", c->name,
198 context);
Markus Lidel61fbfa82005-06-23 22:02:11 -0700199 return -EIO;
200 }
201
Markus Lidelf10378f2005-06-23 22:02:16 -0700202 spin_lock_irqsave(&i2o_drivers_lock, flags);
Markus Lidel61fbfa82005-06-23 22:02:11 -0700203 drv = i2o_drivers[context];
Markus Lidelf10378f2005-06-23 22:02:16 -0700204 spin_unlock_irqrestore(&i2o_drivers_lock, flags);
Markus Lidel61fbfa82005-06-23 22:02:11 -0700205
206 if (unlikely(!drv)) {
Markus Lidelf88e1192005-06-23 22:02:14 -0700207 osm_warn("%s: Spurious reply to unknown driver %d\n", c->name,
208 context);
Markus Lidel61fbfa82005-06-23 22:02:11 -0700209 return -EIO;
210 }
211
Markus Lidel9e875452005-06-23 22:02:21 -0700212 if ((le32_to_cpu(msg->u.head[1]) >> 24) == I2O_CMD_UTIL_EVT_REGISTER) {
Markus Lidel61fbfa82005-06-23 22:02:11 -0700213 struct i2o_device *dev, *tmp;
214 struct i2o_event *evt;
215 u16 size;
Markus Lidel9e875452005-06-23 22:02:21 -0700216 u16 tid = le32_to_cpu(msg->u.head[1]) & 0xfff;
Markus Lidel61fbfa82005-06-23 22:02:11 -0700217
218 osm_debug("event received from device %d\n", tid);
219
Markus Lidelf88e1192005-06-23 22:02:14 -0700220 if (!drv->event)
221 return -EIO;
222
Markus Lidel61fbfa82005-06-23 22:02:11 -0700223 /* cut of header from message size (in 32-bit words) */
Markus Lidel9e875452005-06-23 22:02:21 -0700224 size = (le32_to_cpu(msg->u.head[0]) >> 16) - 5;
Markus Lidel61fbfa82005-06-23 22:02:11 -0700225
Markus Lidelf6ed39a2006-01-06 00:19:33 -0800226 evt = kzalloc(size * 4 + sizeof(*evt), GFP_ATOMIC);
Markus Lidel61fbfa82005-06-23 22:02:11 -0700227 if (!evt)
228 return -ENOMEM;
229
230 evt->size = size;
Markus Lidel9e875452005-06-23 22:02:21 -0700231 evt->tcntxt = le32_to_cpu(msg->u.s.tcntxt);
232 evt->event_indicator = le32_to_cpu(msg->body[0]);
Markus Lideldcceafe2006-01-06 00:19:32 -0800233 memcpy(&evt->data, &msg->body[1], size * 4);
Markus Lidel61fbfa82005-06-23 22:02:11 -0700234
235 list_for_each_entry_safe(dev, tmp, &c->devices, list)
236 if (dev->lct_data.tid == tid) {
237 evt->i2o_dev = dev;
238 break;
239 }
240
David Howellsc4028952006-11-22 14:57:56 +0000241 INIT_WORK(&evt->work, drv->event);
Markus Lidel61fbfa82005-06-23 22:02:11 -0700242 queue_work(drv->event_queue, &evt->work);
243 return 1;
244 }
245
246 if (unlikely(!drv->reply)) {
Markus Lidelf88e1192005-06-23 22:02:14 -0700247 osm_debug("%s: Reply to driver %s, but no reply function"
248 " defined!\n", c->name, drv->name);
Markus Lidel61fbfa82005-06-23 22:02:11 -0700249 return -EIO;
250 }
251
252 return drv->reply(c, m, msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253}
254
255/**
256 * i2o_driver_notify_controller_add_all - Send notify of added controller
Randy Dunlapd9489fb2006-12-06 20:38:43 -0800257 * @c: newly added controller
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 *
259 * Send notifications to all registered drivers that a new controller was
260 * added.
261 */
262void i2o_driver_notify_controller_add_all(struct i2o_controller *c)
263{
264 int i;
265 struct i2o_driver *drv;
266
Akinobu Mitabe324792007-05-23 13:58:06 -0700267 for (i = 0; i < i2o_max_drivers; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 drv = i2o_drivers[i];
269
270 if (drv)
271 i2o_driver_notify_controller_add(drv, c);
272 }
273}
274
275/**
Randy Dunlapd9489fb2006-12-06 20:38:43 -0800276 * i2o_driver_notify_controller_remove_all - Send notify of removed controller
277 * @c: controller that is being removed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 *
279 * Send notifications to all registered drivers that a controller was
280 * removed.
281 */
282void i2o_driver_notify_controller_remove_all(struct i2o_controller *c)
283{
284 int i;
285 struct i2o_driver *drv;
286
Akinobu Mitabe324792007-05-23 13:58:06 -0700287 for (i = 0; i < i2o_max_drivers; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 drv = i2o_drivers[i];
289
290 if (drv)
291 i2o_driver_notify_controller_remove(drv, c);
292 }
293}
294
295/**
Randy Dunlapd9489fb2006-12-06 20:38:43 -0800296 * i2o_driver_notify_device_add_all - Send notify of added device
297 * @i2o_dev: newly added I2O device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 *
299 * Send notifications to all registered drivers that a device was added.
300 */
301void i2o_driver_notify_device_add_all(struct i2o_device *i2o_dev)
302{
303 int i;
304 struct i2o_driver *drv;
305
Akinobu Mitabe324792007-05-23 13:58:06 -0700306 for (i = 0; i < i2o_max_drivers; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 drv = i2o_drivers[i];
308
309 if (drv)
310 i2o_driver_notify_device_add(drv, i2o_dev);
311 }
312}
313
314/**
Randy Dunlapd9489fb2006-12-06 20:38:43 -0800315 * i2o_driver_notify_device_remove_all - Send notify of removed device
316 * @i2o_dev: device that is being removed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 *
318 * Send notifications to all registered drivers that a device was removed.
319 */
320void i2o_driver_notify_device_remove_all(struct i2o_device *i2o_dev)
321{
322 int i;
323 struct i2o_driver *drv;
324
Akinobu Mitabe324792007-05-23 13:58:06 -0700325 for (i = 0; i < i2o_max_drivers; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 drv = i2o_drivers[i];
327
328 if (drv)
329 i2o_driver_notify_device_remove(drv, i2o_dev);
330 }
331}
332
333/**
334 * i2o_driver_init - initialize I2O drivers (OSMs)
335 *
336 * Registers the I2O bus and allocate memory for the array of OSMs.
337 *
338 * Returns 0 on success or negative error code on failure.
339 */
340int __init i2o_driver_init(void)
341{
342 int rc = 0;
343
344 spin_lock_init(&i2o_drivers_lock);
345
Akinobu Mita82cd0e82007-05-23 13:58:07 -0700346 if ((i2o_max_drivers < 2) || (i2o_max_drivers > 64)) {
347 osm_warn("max_drivers set to %d, but must be >=2 and <= 64\n",
348 i2o_max_drivers);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 i2o_max_drivers = I2O_MAX_DRIVERS;
350 }
Markus Lidelf88e1192005-06-23 22:02:14 -0700351 osm_info("max drivers = %d\n", i2o_max_drivers);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
353 i2o_drivers =
Akinobu Mitabe324792007-05-23 13:58:06 -0700354 kcalloc(i2o_max_drivers, sizeof(*i2o_drivers), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 if (!i2o_drivers)
356 return -ENOMEM;
357
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 rc = bus_register(&i2o_bus_type);
359
360 if (rc < 0)
361 kfree(i2o_drivers);
362
363 return rc;
364};
365
366/**
367 * i2o_driver_exit - clean up I2O drivers (OSMs)
368 *
Randy Dunlapd9489fb2006-12-06 20:38:43 -0800369 * Unregisters the I2O bus and frees driver array.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 */
Ralf Baechled7843722006-12-13 00:33:53 -0800371void i2o_driver_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372{
373 bus_unregister(&i2o_bus_type);
374 kfree(i2o_drivers);
375};
376
377EXPORT_SYMBOL(i2o_driver_register);
378EXPORT_SYMBOL(i2o_driver_unregister);
379EXPORT_SYMBOL(i2o_driver_notify_controller_add_all);
380EXPORT_SYMBOL(i2o_driver_notify_controller_remove_all);
381EXPORT_SYMBOL(i2o_driver_notify_device_add_all);
382EXPORT_SYMBOL(i2o_driver_notify_device_remove_all);