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 */
58 spinlock_t lock
; /* lock before modifying */
61 /* Work struct needed to handle LCT NOTIFY replies */
62 struct i2o_exec_lct_notify_work
{
63 struct work_struct work
; /* work struct */
64 struct i2o_controller
*c
; /* controller on which the LCT NOTIFY
68 /* Exec OSM class handling definition */
69 static struct i2o_class_id i2o_exec_class_id
[] = {
70 {I2O_CLASS_EXECUTIVE
},
75 * i2o_exec_wait_alloc - Allocate a i2o_exec_wait struct an initialize it
77 * Allocate the i2o_exec_wait struct and initialize the wait.
79 * Returns i2o_exec_wait pointer on success or negative error code on
82 static struct i2o_exec_wait
*i2o_exec_wait_alloc(void)
84 struct i2o_exec_wait
*wait
;
86 wait
= kzalloc(sizeof(*wait
), GFP_KERNEL
);
90 INIT_LIST_HEAD(&wait
->list
);
91 spin_lock_init(&wait
->lock
);
97 * i2o_exec_wait_free - Free a i2o_exec_wait struct
98 * @i2o_exec_wait: I2O wait data which should be cleaned up
100 static void i2o_exec_wait_free(struct i2o_exec_wait
*wait
)
106 * i2o_msg_post_wait_mem - Post and wait a message with DMA buffers
108 * @m: message to post
109 * @timeout: time in seconds to wait
110 * @dma: i2o_dma struct of the DMA buffer to free on failure
112 * This API allows an OSM to post a message and then be told whether or
113 * not the system received a successful reply. If the message times out
114 * then the value '-ETIMEDOUT' is returned. This is a special case. In
115 * this situation the message may (should) complete at an indefinite time
116 * in the future. When it completes it will use the memory buffer
117 * attached to the request. If -ETIMEDOUT is returned then the memory
118 * buffer must not be freed. Instead the event completion will free them
119 * for you. In all other cases the buffer are your problem.
121 * Returns 0 on success, negative error code on timeout or positive error
124 int i2o_msg_post_wait_mem(struct i2o_controller
*c
, struct i2o_message
*msg
,
125 unsigned long timeout
, struct i2o_dma
*dma
)
127 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq
);
128 struct i2o_exec_wait
*wait
;
129 static u32 tcntxt
= 0x80000000;
133 wait
= i2o_exec_wait_alloc();
137 if (tcntxt
== 0xffffffff)
144 * Fill in the message initiator context and transaction context.
145 * We will only use transaction contexts >= 0x80000000 for POST WAIT,
146 * so we could find a POST WAIT reply easier in the reply handler.
148 msg
->u
.s
.icntxt
= cpu_to_le32(i2o_exec_driver
.context
);
149 wait
->tcntxt
= tcntxt
++;
150 msg
->u
.s
.tcntxt
= cpu_to_le32(wait
->tcntxt
);
154 * we add elements to the head, because if a entry in the list will
155 * never be removed, we have to iterate over it every time
157 list_add(&wait
->list
, &i2o_exec_wait_list
);
160 * Post the message to the controller. At some point later it will
161 * return. If we time out before it returns then complete will be zero.
163 i2o_msg_post(c
, msg
);
165 wait_event_interruptible_timeout(wq
, wait
->complete
, timeout
* HZ
);
167 spin_lock_irqsave(&wait
->lock
, flags
);
172 rc
= le32_to_cpu(wait
->msg
->body
[0]) >> 24;
175 * We cannot remove it now. This is important. When it does
176 * terminate (which it must do if the controller has not
177 * died...) then it will otherwise scribble on stuff.
179 * FIXME: try abort message
187 spin_unlock_irqrestore(&wait
->lock
, flags
);
189 if (rc
!= -ETIMEDOUT
) {
190 i2o_flush_reply(c
, wait
->m
);
191 i2o_exec_wait_free(wait
);
198 * i2o_msg_post_wait_complete - Reply to a i2o_msg_post request from IOP
199 * @c: I2O controller which answers
201 * @msg: pointer to the I2O reply message
202 * @context: transaction context of request
204 * This function is called in interrupt context only. If the reply reached
205 * before the timeout, the i2o_exec_wait struct is filled with the message
206 * and the task will be waked up. The task is now responsible for returning
207 * the message m back to the controller! If the message reaches us after
208 * the timeout clean up the i2o_exec_wait struct (including allocated
211 * Return 0 on success and if the message m should not be given back to the
212 * I2O controller, or >0 on success and if the message should be given back
213 * afterwords. Returns negative error code on failure. In this case the
214 * message must also be given back to the controller.
216 static int i2o_msg_post_wait_complete(struct i2o_controller
*c
, u32 m
,
217 struct i2o_message
*msg
, u32 context
)
219 struct i2o_exec_wait
*wait
, *tmp
;
224 * We need to search through the i2o_exec_wait_list to see if the given
225 * message is still outstanding. If not, it means that the IOP took
226 * longer to respond to the message than we had allowed and timer has
227 * already expired. Not much we can do about that except log it for
228 * debug purposes, increase timeout, and recompile.
230 list_for_each_entry_safe(wait
, tmp
, &i2o_exec_wait_list
, list
) {
231 if (wait
->tcntxt
== context
) {
232 spin_lock_irqsave(&wait
->lock
, flags
);
234 list_del(&wait
->list
);
245 spin_unlock_irqrestore(&wait
->lock
, flags
);
252 pr_debug("%s: timedout reply received!\n",
254 i2o_dma_free(dev
, &wait
->dma
);
255 i2o_exec_wait_free(wait
);
257 wake_up_interruptible(wait
->wq
);
263 osm_warn("%s: Bogus reply in POST WAIT (tr-context: %08x)!\n", c
->name
,
270 * i2o_exec_show_vendor_id - Displays Vendor ID of controller
271 * @d: device of which the Vendor ID should be displayed
272 * @buf: buffer into which the Vendor ID should be printed
274 * Returns number of bytes printed into buffer.
276 static ssize_t
i2o_exec_show_vendor_id(struct device
*d
,
277 struct device_attribute
*attr
, char *buf
)
279 struct i2o_device
*dev
= to_i2o_device(d
);
282 if (!i2o_parm_field_get(dev
, 0x0000, 0, &id
, 2)) {
283 sprintf(buf
, "0x%04x", le16_to_cpu(id
));
284 return strlen(buf
) + 1;
291 * i2o_exec_show_product_id - Displays Product ID of controller
292 * @d: device of which the Product ID should be displayed
293 * @buf: buffer into which the Product ID should be printed
295 * Returns number of bytes printed into buffer.
297 static ssize_t
i2o_exec_show_product_id(struct device
*d
,
298 struct device_attribute
*attr
,
301 struct i2o_device
*dev
= to_i2o_device(d
);
304 if (!i2o_parm_field_get(dev
, 0x0000, 1, &id
, 2)) {
305 sprintf(buf
, "0x%04x", le16_to_cpu(id
));
306 return strlen(buf
) + 1;
312 /* Exec-OSM device attributes */
313 static DEVICE_ATTR(vendor_id
, S_IRUGO
, i2o_exec_show_vendor_id
, NULL
);
314 static DEVICE_ATTR(product_id
, S_IRUGO
, i2o_exec_show_product_id
, NULL
);
317 * i2o_exec_probe - Called if a new I2O device (executive class) appears
318 * @dev: I2O device which should be probed
320 * Registers event notification for every event from Executive device. The
321 * return is always 0, because we want all devices of class Executive.
323 * Returns 0 on success.
325 static int i2o_exec_probe(struct device
*dev
)
327 struct i2o_device
*i2o_dev
= to_i2o_device(dev
);
330 rc
= i2o_event_register(i2o_dev
, &i2o_exec_driver
, 0, 0xffffffff);
331 if (rc
) goto err_out
;
333 rc
= device_create_file(dev
, &dev_attr_vendor_id
);
334 if (rc
) goto err_evtreg
;
335 rc
= device_create_file(dev
, &dev_attr_product_id
);
336 if (rc
) goto err_vid
;
341 device_remove_file(dev
, &dev_attr_vendor_id
);
343 i2o_event_register(to_i2o_device(dev
), &i2o_exec_driver
, 0, 0);
349 * i2o_exec_remove - Called on I2O device removal
350 * @dev: I2O device which was removed
352 * Unregisters event notification from Executive I2O device.
354 * Returns 0 on success.
356 static int i2o_exec_remove(struct device
*dev
)
358 device_remove_file(dev
, &dev_attr_product_id
);
359 device_remove_file(dev
, &dev_attr_vendor_id
);
361 i2o_event_register(to_i2o_device(dev
), &i2o_exec_driver
, 0, 0);
367 * i2o_exec_lct_modified - Called on LCT NOTIFY reply
368 * @c: I2O controller on which the LCT has modified
370 * This function handles asynchronus LCT NOTIFY replies. It parses the
371 * new LCT and if the buffer for the LCT was to small sends a LCT NOTIFY
372 * again, otherwise send LCT NOTIFY to get informed on next LCT change.
374 static void i2o_exec_lct_modified(struct work_struct
*_work
)
376 struct i2o_exec_lct_notify_work
*work
=
377 container_of(_work
, struct i2o_exec_lct_notify_work
, work
);
379 struct i2o_controller
*c
= work
->c
;
383 if (i2o_device_parse_lct(c
) != -EAGAIN
)
384 change_ind
= c
->lct
->change_ind
+ 1;
386 #ifdef CONFIG_I2O_LCT_NOTIFY_ON_CHANGES
387 i2o_exec_lct_notify(c
, change_ind
);
392 * i2o_exec_reply - I2O Executive reply handler
393 * @c: I2O controller from which the reply comes
395 * @msg: pointer to the I2O reply message
397 * This function is always called from interrupt context. If a POST WAIT
398 * reply was received, pass it to the complete function. If a LCT NOTIFY
399 * reply was received, a new event is created to handle the update.
401 * Returns 0 on success and if the reply should not be flushed or > 0
402 * on success and if the reply should be flushed. Returns negative error
403 * code on failure and if the reply should be flushed.
405 static int i2o_exec_reply(struct i2o_controller
*c
, u32 m
,
406 struct i2o_message
*msg
)
410 if (le32_to_cpu(msg
->u
.head
[0]) & MSG_FAIL
) {
411 struct i2o_message __iomem
*pmsg
;
415 * If Fail bit is set we must take the transaction context of
416 * the preserved message to find the right request again.
419 pm
= le32_to_cpu(msg
->body
[3]);
420 pmsg
= i2o_msg_in_to_virt(c
, pm
);
421 context
= readl(&pmsg
->u
.s
.tcntxt
);
423 i2o_report_status(KERN_INFO
, "i2o_core", msg
);
425 /* Release the preserved msg */
426 i2o_msg_nop_mfa(c
, pm
);
428 context
= le32_to_cpu(msg
->u
.s
.tcntxt
);
430 if (context
& 0x80000000)
431 return i2o_msg_post_wait_complete(c
, m
, msg
, context
);
433 if ((le32_to_cpu(msg
->u
.head
[1]) >> 24) == I2O_CMD_LCT_NOTIFY
) {
434 struct i2o_exec_lct_notify_work
*work
;
436 pr_debug("%s: LCT notify received\n", c
->name
);
438 work
= kmalloc(sizeof(*work
), GFP_ATOMIC
);
444 INIT_WORK(&work
->work
, i2o_exec_lct_modified
);
445 queue_work(i2o_exec_driver
.event_queue
, &work
->work
);
450 * If this happens, we want to dump the message to the syslog so
451 * it can be sent back to the card manufacturer by the end user
452 * to aid in debugging.
455 printk(KERN_WARNING
"%s: Unsolicited message reply sent to core!"
456 "Message dumped to syslog\n", c
->name
);
457 i2o_dump_message(msg
);
463 * i2o_exec_event - Event handling function
464 * @work: Work item in occurring event
466 * Handles events send by the Executive device. At the moment does not do
469 static void i2o_exec_event(struct work_struct
*work
)
471 struct i2o_event
*evt
= container_of(work
, struct i2o_event
, work
);
473 if (likely(evt
->i2o_dev
))
474 osm_debug("Event received from device: %d\n",
475 evt
->i2o_dev
->lct_data
.tid
);
480 * i2o_exec_lct_get - Get the IOP's Logical Configuration Table
481 * @c: I2O controller from which the LCT should be fetched
483 * Send a LCT NOTIFY request to the controller, and wait
484 * I2O_TIMEOUT_LCT_GET seconds until arrival of response. If the LCT is
485 * to large, retry it.
487 * Returns 0 on success or negative error code on failure.
489 int i2o_exec_lct_get(struct i2o_controller
*c
)
491 struct i2o_message
*msg
;
495 for (i
= 1; i
<= I2O_LCT_GET_TRIES
; i
++) {
496 msg
= i2o_msg_get_wait(c
, I2O_TIMEOUT_MESSAGE_GET
);
501 cpu_to_le32(EIGHT_WORD_MSG_SIZE
| SGL_OFFSET_6
);
503 cpu_to_le32(I2O_CMD_LCT_NOTIFY
<< 24 | HOST_TID
<< 12 |
505 msg
->body
[0] = cpu_to_le32(0xffffffff);
506 msg
->body
[1] = cpu_to_le32(0x00000000);
507 msg
->body
[2] = cpu_to_le32(0xd0000000 | c
->dlct
.len
);
508 msg
->body
[3] = cpu_to_le32(c
->dlct
.phys
);
510 rc
= i2o_msg_post_wait(c
, msg
, I2O_TIMEOUT_LCT_GET
);
514 rc
= i2o_device_parse_lct(c
);
523 * i2o_exec_lct_notify - Send a asynchronus LCT NOTIFY request
524 * @c: I2O controller to which the request should be send
525 * @change_ind: change indicator
527 * This function sends a LCT NOTIFY request to the I2O controller with
528 * the change indicator change_ind. If the change_ind == 0 the controller
529 * replies immediately after the request. If change_ind > 0 the reply is
530 * send after change indicator of the LCT is > change_ind.
532 static int i2o_exec_lct_notify(struct i2o_controller
*c
, u32 change_ind
)
534 i2o_status_block
*sb
= c
->status_block
.virt
;
536 struct i2o_message
*msg
;
543 (dev
, &c
->dlct
, le32_to_cpu(sb
->expected_lct_size
), GFP_KERNEL
))
546 msg
= i2o_msg_get_wait(c
, I2O_TIMEOUT_MESSAGE_GET
);
550 msg
->u
.head
[0] = cpu_to_le32(EIGHT_WORD_MSG_SIZE
| SGL_OFFSET_6
);
551 msg
->u
.head
[1] = cpu_to_le32(I2O_CMD_LCT_NOTIFY
<< 24 | HOST_TID
<< 12 |
553 msg
->u
.s
.icntxt
= cpu_to_le32(i2o_exec_driver
.context
);
554 msg
->u
.s
.tcntxt
= cpu_to_le32(0x00000000);
555 msg
->body
[0] = cpu_to_le32(0xffffffff);
556 msg
->body
[1] = cpu_to_le32(change_ind
);
557 msg
->body
[2] = cpu_to_le32(0xd0000000 | c
->dlct
.len
);
558 msg
->body
[3] = cpu_to_le32(c
->dlct
.phys
);
560 i2o_msg_post(c
, msg
);
567 /* Exec OSM driver struct */
568 struct i2o_driver i2o_exec_driver
= {
570 .reply
= i2o_exec_reply
,
571 .event
= i2o_exec_event
,
572 .classes
= i2o_exec_class_id
,
574 .probe
= i2o_exec_probe
,
575 .remove
= i2o_exec_remove
,
580 * i2o_exec_init - Registers the Exec OSM
582 * Registers the Exec OSM in the I2O core.
584 * Returns 0 on success or negative error code on failure.
586 int __init
i2o_exec_init(void)
588 return i2o_driver_register(&i2o_exec_driver
);
592 * i2o_exec_exit - Removes the Exec OSM
594 * Unregisters the Exec OSM from the I2O core.
596 void __exit
i2o_exec_exit(void)
598 i2o_driver_unregister(&i2o_exec_driver
);
601 EXPORT_SYMBOL(i2o_msg_post_wait_mem
);
602 EXPORT_SYMBOL(i2o_exec_lct_get
);