4 * Copyright (C) 1999-2002 Red Hat Software
6 * Written by Alan Cox, Building Number Three Ltd
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
13 * A lot of the I2O message side code from this is taken from the Red
14 * Creek RCPCI45 adapter driver by Red Creek Communications
18 * Juha Sievänen <Juha.Sievanen@cs.Helsinki.FI>
19 * Auvo Häkkinen <Auvo.Hakkinen@cs.Helsinki.FI>
20 * Deepak Saxena <deepak@plexity.net>
21 * Boji T Kannanthanam <boji.t.kannanthanam@intel.com>
22 * Alan Cox <alan@redhat.com>:
23 * Ported to Linux 2.5.
24 * Markus Lidel <Markus.Lidel@shadowconnect.com>:
25 * Minor fixes for 2.6.
26 * Markus Lidel <Markus.Lidel@shadowconnect.com>:
27 * Support for sysfs included.
30 #include <linux/module.h>
31 #include <linux/i2o.h>
32 #include <linux/delay.h>
33 #include <linux/workqueue.h>
34 #include <linux/string.h>
35 #include <linux/slab.h>
36 #include <linux/sched.h> /* wait_event_interruptible_timeout() needs this */
37 #include <asm/param.h> /* HZ */
40 #define OSM_NAME "exec-osm"
42 struct i2o_driver i2o_exec_driver
;
44 static int i2o_exec_lct_notify(struct i2o_controller
*c
, u32 change_ind
);
46 /* global wait list for POST WAIT */
47 static LIST_HEAD(i2o_exec_wait_list
);
49 /* Wait struct needed for POST WAIT */
50 struct i2o_exec_wait
{
51 wait_queue_head_t
*wq
; /* Pointer to Wait queue */
52 struct i2o_dma dma
; /* DMA buffers to free on failure */
53 u32 tcntxt
; /* transaction context from reply */
54 int complete
; /* 1 if reply received otherwise 0 */
55 u32 m
; /* message id */
56 struct i2o_message
*msg
; /* pointer to the reply message */
57 struct list_head list
; /* node in global wait list */
60 /* Work struct needed to handle LCT NOTIFY replies */
61 struct i2o_exec_lct_notify_work
{
62 struct work_struct work
; /* work struct */
63 struct i2o_controller
*c
; /* controller on which the LCT NOTIFY
67 /* Exec OSM class handling definition */
68 static struct i2o_class_id i2o_exec_class_id
[] = {
69 {I2O_CLASS_EXECUTIVE
},
74 * i2o_exec_wait_alloc - Allocate a i2o_exec_wait struct an initialize it
76 * Allocate the i2o_exec_wait struct and initialize the wait.
78 * Returns i2o_exec_wait pointer on success or negative error code on
81 static struct i2o_exec_wait
*i2o_exec_wait_alloc(void)
83 struct i2o_exec_wait
*wait
;
85 wait
= kzalloc(sizeof(*wait
), GFP_KERNEL
);
89 INIT_LIST_HEAD(&wait
->list
);
95 * i2o_exec_wait_free - Free a i2o_exec_wait struct
96 * @i2o_exec_wait: I2O wait data which should be cleaned up
98 static void i2o_exec_wait_free(struct i2o_exec_wait
*wait
)
104 * i2o_msg_post_wait_mem - Post and wait a message with DMA buffers
106 * @m: message to post
107 * @timeout: time in seconds to wait
108 * @dma: i2o_dma struct of the DMA buffer to free on failure
110 * This API allows an OSM to post a message and then be told whether or
111 * not the system received a successful reply. If the message times out
112 * then the value '-ETIMEDOUT' is returned. This is a special case. In
113 * this situation the message may (should) complete at an indefinite time
114 * in the future. When it completes it will use the memory buffer
115 * attached to the request. If -ETIMEDOUT is returned then the memory
116 * buffer must not be freed. Instead the event completion will free them
117 * for you. In all other cases the buffer are your problem.
119 * Returns 0 on success, negative error code on timeout or positive error
122 int i2o_msg_post_wait_mem(struct i2o_controller
*c
, struct i2o_message
*msg
,
123 unsigned long timeout
, struct i2o_dma
*dma
)
125 DECLARE_WAIT_QUEUE_HEAD(wq
);
126 struct i2o_exec_wait
*wait
;
127 static u32 tcntxt
= 0x80000000;
130 wait
= i2o_exec_wait_alloc();
134 if (tcntxt
== 0xffffffff)
141 * Fill in the message initiator context and transaction context.
142 * We will only use transaction contexts >= 0x80000000 for POST WAIT,
143 * so we could find a POST WAIT reply easier in the reply handler.
145 msg
->u
.s
.icntxt
= cpu_to_le32(i2o_exec_driver
.context
);
146 wait
->tcntxt
= tcntxt
++;
147 msg
->u
.s
.tcntxt
= cpu_to_le32(wait
->tcntxt
);
150 * Post the message to the controller. At some point later it will
151 * return. If we time out before it returns then complete will be zero.
153 i2o_msg_post(c
, msg
);
155 if (!wait
->complete
) {
158 * we add elements add the head, because if a entry in the list
159 * will never be removed, we have to iterate over it every time
161 list_add(&wait
->list
, &i2o_exec_wait_list
);
163 wait_event_interruptible_timeout(wq
, wait
->complete
,
171 if (wait
->complete
) {
172 rc
= le32_to_cpu(wait
->msg
->body
[0]) >> 24;
173 i2o_flush_reply(c
, wait
->m
);
174 i2o_exec_wait_free(wait
);
177 * We cannot remove it now. This is important. When it does
178 * terminate (which it must do if the controller has not
179 * died...) then it will otherwise scribble on stuff.
181 * FIXME: try abort message
193 * i2o_msg_post_wait_complete - Reply to a i2o_msg_post request from IOP
194 * @c: I2O controller which answers
196 * @msg: pointer to the I2O reply message
197 * @context: transaction context of request
199 * This function is called in interrupt context only. If the reply reached
200 * before the timeout, the i2o_exec_wait struct is filled with the message
201 * and the task will be waked up. The task is now responsible for returning
202 * the message m back to the controller! If the message reaches us after
203 * the timeout clean up the i2o_exec_wait struct (including allocated
206 * Return 0 on success and if the message m should not be given back to the
207 * I2O controller, or >0 on success and if the message should be given back
208 * afterwords. Returns negative error code on failure. In this case the
209 * message must also be given back to the controller.
211 static int i2o_msg_post_wait_complete(struct i2o_controller
*c
, u32 m
,
212 struct i2o_message
*msg
, u32 context
)
214 struct i2o_exec_wait
*wait
, *tmp
;
216 static spinlock_t lock
= SPIN_LOCK_UNLOCKED
;
220 * We need to search through the i2o_exec_wait_list to see if the given
221 * message is still outstanding. If not, it means that the IOP took
222 * longer to respond to the message than we had allowed and timer has
223 * already expired. Not much we can do about that except log it for
224 * debug purposes, increase timeout, and recompile.
226 spin_lock_irqsave(&lock
, flags
);
227 list_for_each_entry_safe(wait
, tmp
, &i2o_exec_wait_list
, list
) {
228 if (wait
->tcntxt
== context
) {
229 list_del(&wait
->list
);
231 spin_unlock_irqrestore(&lock
, flags
);
240 wake_up_interruptible(wait
->wq
);
247 pr_debug("%s: timedout reply received!\n",
249 i2o_dma_free(dev
, &wait
->dma
);
250 i2o_exec_wait_free(wait
);
258 spin_unlock_irqrestore(&lock
, flags
);
260 osm_warn("%s: Bogus reply in POST WAIT (tr-context: %08x)!\n", c
->name
,
267 * i2o_exec_show_vendor_id - Displays Vendor ID of controller
268 * @d: device of which the Vendor ID should be displayed
269 * @buf: buffer into which the Vendor ID should be printed
271 * Returns number of bytes printed into buffer.
273 static ssize_t
i2o_exec_show_vendor_id(struct device
*d
,
274 struct device_attribute
*attr
, char *buf
)
276 struct i2o_device
*dev
= to_i2o_device(d
);
279 if (!i2o_parm_field_get(dev
, 0x0000, 0, &id
, 2)) {
280 sprintf(buf
, "0x%04x", le16_to_cpu(id
));
281 return strlen(buf
) + 1;
288 * i2o_exec_show_product_id - Displays Product ID of controller
289 * @d: device of which the Product ID should be displayed
290 * @buf: buffer into which the Product ID should be printed
292 * Returns number of bytes printed into buffer.
294 static ssize_t
i2o_exec_show_product_id(struct device
*d
,
295 struct device_attribute
*attr
,
298 struct i2o_device
*dev
= to_i2o_device(d
);
301 if (!i2o_parm_field_get(dev
, 0x0000, 1, &id
, 2)) {
302 sprintf(buf
, "0x%04x", le16_to_cpu(id
));
303 return strlen(buf
) + 1;
309 /* Exec-OSM device attributes */
310 static DEVICE_ATTR(vendor_id
, S_IRUGO
, i2o_exec_show_vendor_id
, NULL
);
311 static DEVICE_ATTR(product_id
, S_IRUGO
, i2o_exec_show_product_id
, NULL
);
314 * i2o_exec_probe - Called if a new I2O device (executive class) appears
315 * @dev: I2O device which should be probed
317 * Registers event notification for every event from Executive device. The
318 * return is always 0, because we want all devices of class Executive.
320 * Returns 0 on success.
322 static int i2o_exec_probe(struct device
*dev
)
324 struct i2o_device
*i2o_dev
= to_i2o_device(dev
);
325 struct i2o_controller
*c
= i2o_dev
->iop
;
327 i2o_event_register(i2o_dev
, &i2o_exec_driver
, 0, 0xffffffff);
331 i2o_exec_lct_notify(c
, c
->lct
->change_ind
+ 1);
333 device_create_file(dev
, &dev_attr_vendor_id
);
334 device_create_file(dev
, &dev_attr_product_id
);
340 * i2o_exec_remove - Called on I2O device removal
341 * @dev: I2O device which was removed
343 * Unregisters event notification from Executive I2O device.
345 * Returns 0 on success.
347 static int i2o_exec_remove(struct device
*dev
)
349 device_remove_file(dev
, &dev_attr_product_id
);
350 device_remove_file(dev
, &dev_attr_vendor_id
);
352 i2o_event_register(to_i2o_device(dev
), &i2o_exec_driver
, 0, 0);
358 * i2o_exec_lct_modified - Called on LCT NOTIFY reply
359 * @c: I2O controller on which the LCT has modified
361 * This function handles asynchronus LCT NOTIFY replies. It parses the
362 * new LCT and if the buffer for the LCT was to small sends a LCT NOTIFY
363 * again, otherwise send LCT NOTIFY to get informed on next LCT change.
365 static void i2o_exec_lct_modified(struct i2o_exec_lct_notify_work
*work
)
368 struct i2o_controller
*c
= work
->c
;
372 if (i2o_device_parse_lct(c
) != -EAGAIN
)
373 change_ind
= c
->lct
->change_ind
+ 1;
375 #ifdef CONFIG_I2O_LCT_NOTIFY_ON_CHANGES
376 i2o_exec_lct_notify(c
, change_ind
);
381 * i2o_exec_reply - I2O Executive reply handler
382 * @c: I2O controller from which the reply comes
384 * @msg: pointer to the I2O reply message
386 * This function is always called from interrupt context. If a POST WAIT
387 * reply was received, pass it to the complete function. If a LCT NOTIFY
388 * reply was received, a new event is created to handle the update.
390 * Returns 0 on success and if the reply should not be flushed or > 0
391 * on success and if the reply should be flushed. Returns negative error
392 * code on failure and if the reply should be flushed.
394 static int i2o_exec_reply(struct i2o_controller
*c
, u32 m
,
395 struct i2o_message
*msg
)
399 if (le32_to_cpu(msg
->u
.head
[0]) & MSG_FAIL
) {
400 struct i2o_message __iomem
*pmsg
;
404 * If Fail bit is set we must take the transaction context of
405 * the preserved message to find the right request again.
408 pm
= le32_to_cpu(msg
->body
[3]);
409 pmsg
= i2o_msg_in_to_virt(c
, pm
);
410 context
= readl(&pmsg
->u
.s
.tcntxt
);
412 i2o_report_status(KERN_INFO
, "i2o_core", msg
);
414 /* Release the preserved msg */
415 i2o_msg_nop_mfa(c
, pm
);
417 context
= le32_to_cpu(msg
->u
.s
.tcntxt
);
419 if (context
& 0x80000000)
420 return i2o_msg_post_wait_complete(c
, m
, msg
, context
);
422 if ((le32_to_cpu(msg
->u
.head
[1]) >> 24) == I2O_CMD_LCT_NOTIFY
) {
423 struct i2o_exec_lct_notify_work
*work
;
425 pr_debug("%s: LCT notify received\n", c
->name
);
427 work
= kmalloc(sizeof(*work
), GFP_ATOMIC
);
433 INIT_WORK(&work
->work
, (void (*)(void *))i2o_exec_lct_modified
,
435 queue_work(i2o_exec_driver
.event_queue
, &work
->work
);
440 * If this happens, we want to dump the message to the syslog so
441 * it can be sent back to the card manufacturer by the end user
442 * to aid in debugging.
445 printk(KERN_WARNING
"%s: Unsolicited message reply sent to core!"
446 "Message dumped to syslog\n", c
->name
);
447 i2o_dump_message(msg
);
453 * i2o_exec_event - Event handling function
454 * @evt: Event which occurs
456 * Handles events send by the Executive device. At the moment does not do
459 static void i2o_exec_event(struct i2o_event
*evt
)
461 if (likely(evt
->i2o_dev
))
462 osm_debug("Event received from device: %d\n",
463 evt
->i2o_dev
->lct_data
.tid
);
468 * i2o_exec_lct_get - Get the IOP's Logical Configuration Table
469 * @c: I2O controller from which the LCT should be fetched
471 * Send a LCT NOTIFY request to the controller, and wait
472 * I2O_TIMEOUT_LCT_GET seconds until arrival of response. If the LCT is
473 * to large, retry it.
475 * Returns 0 on success or negative error code on failure.
477 int i2o_exec_lct_get(struct i2o_controller
*c
)
479 struct i2o_message
*msg
;
483 for (i
= 1; i
<= I2O_LCT_GET_TRIES
; i
++) {
484 msg
= i2o_msg_get_wait(c
, I2O_TIMEOUT_MESSAGE_GET
);
489 cpu_to_le32(EIGHT_WORD_MSG_SIZE
| SGL_OFFSET_6
);
491 cpu_to_le32(I2O_CMD_LCT_NOTIFY
<< 24 | HOST_TID
<< 12 |
493 msg
->body
[0] = cpu_to_le32(0xffffffff);
494 msg
->body
[1] = cpu_to_le32(0x00000000);
495 msg
->body
[2] = cpu_to_le32(0xd0000000 | c
->dlct
.len
);
496 msg
->body
[3] = cpu_to_le32(c
->dlct
.phys
);
498 rc
= i2o_msg_post_wait(c
, msg
, I2O_TIMEOUT_LCT_GET
);
502 rc
= i2o_device_parse_lct(c
);
511 * i2o_exec_lct_notify - Send a asynchronus LCT NOTIFY request
512 * @c: I2O controller to which the request should be send
513 * @change_ind: change indicator
515 * This function sends a LCT NOTIFY request to the I2O controller with
516 * the change indicator change_ind. If the change_ind == 0 the controller
517 * replies immediately after the request. If change_ind > 0 the reply is
518 * send after change indicator of the LCT is > change_ind.
520 static int i2o_exec_lct_notify(struct i2o_controller
*c
, u32 change_ind
)
522 i2o_status_block
*sb
= c
->status_block
.virt
;
524 struct i2o_message
*msg
;
529 (dev
, &c
->dlct
, le32_to_cpu(sb
->expected_lct_size
), GFP_KERNEL
))
532 msg
= i2o_msg_get_wait(c
, I2O_TIMEOUT_MESSAGE_GET
);
536 msg
->u
.head
[0] = cpu_to_le32(EIGHT_WORD_MSG_SIZE
| SGL_OFFSET_6
);
537 msg
->u
.head
[1] = cpu_to_le32(I2O_CMD_LCT_NOTIFY
<< 24 | HOST_TID
<< 12 |
539 msg
->u
.s
.icntxt
= cpu_to_le32(i2o_exec_driver
.context
);
540 msg
->u
.s
.tcntxt
= cpu_to_le32(0x00000000);
541 msg
->body
[0] = cpu_to_le32(0xffffffff);
542 msg
->body
[1] = cpu_to_le32(change_ind
);
543 msg
->body
[2] = cpu_to_le32(0xd0000000 | c
->dlct
.len
);
544 msg
->body
[3] = cpu_to_le32(c
->dlct
.phys
);
546 i2o_msg_post(c
, msg
);
551 /* Exec OSM driver struct */
552 struct i2o_driver i2o_exec_driver
= {
554 .reply
= i2o_exec_reply
,
555 .event
= i2o_exec_event
,
556 .classes
= i2o_exec_class_id
,
558 .probe
= i2o_exec_probe
,
559 .remove
= i2o_exec_remove
,
564 * i2o_exec_init - Registers the Exec OSM
566 * Registers the Exec OSM in the I2O core.
568 * Returns 0 on success or negative error code on failure.
570 int __init
i2o_exec_init(void)
572 return i2o_driver_register(&i2o_exec_driver
);
576 * i2o_exec_exit - Removes the Exec OSM
578 * Unregisters the Exec OSM from the I2O core.
580 void __exit
i2o_exec_exit(void)
582 i2o_driver_unregister(&i2o_exec_driver
);
585 EXPORT_SYMBOL(i2o_msg_post_wait_mem
);
586 EXPORT_SYMBOL(i2o_exec_lct_get
);