Merge branch 'release' of master.kernel.org:/pub/scm/linux/kernel/git/aegl/linux-2.6
[linux-2.6] / drivers / message / i2o / exec-osm.c
1 /*
2  *      Executive OSM
3  *
4  *      Copyright (C) 1999-2002 Red Hat Software
5  *
6  *      Written by Alan Cox, Building Number Three Ltd
7  *
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.
12  *
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
15  *
16  *      Fixes/additions:
17  *              Philipp Rumpf
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.
28  */
29
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 */
38 #include "core.h"
39
40 #define OSM_NAME "exec-osm"
41
42 struct i2o_driver i2o_exec_driver;
43
44 static int i2o_exec_lct_notify(struct i2o_controller *c, u32 change_ind);
45
46 /* global wait list for POST WAIT */
47 static LIST_HEAD(i2o_exec_wait_list);
48
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 */
59 };
60
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
65                                            was received */
66 };
67
68 /* Exec OSM class handling definition */
69 static struct i2o_class_id i2o_exec_class_id[] = {
70         {I2O_CLASS_EXECUTIVE},
71         {I2O_CLASS_END}
72 };
73
74 /**
75  *      i2o_exec_wait_alloc - Allocate a i2o_exec_wait struct an initialize it
76  *
77  *      Allocate the i2o_exec_wait struct and initialize the wait.
78  *
79  *      Returns i2o_exec_wait pointer on success or negative error code on
80  *      failure.
81  */
82 static struct i2o_exec_wait *i2o_exec_wait_alloc(void)
83 {
84         struct i2o_exec_wait *wait;
85
86         wait = kzalloc(sizeof(*wait), GFP_KERNEL);
87         if (!wait)
88                 return NULL;
89
90         INIT_LIST_HEAD(&wait->list);
91         spin_lock_init(&wait->lock);
92
93         return wait;
94 };
95
96 /**
97  *      i2o_exec_wait_free - Free a i2o_exec_wait struct
98  *      @i2o_exec_wait: I2O wait data which should be cleaned up
99  */
100 static void i2o_exec_wait_free(struct i2o_exec_wait *wait)
101 {
102         kfree(wait);
103 };
104
105 /**
106  *      i2o_msg_post_wait_mem - Post and wait a message with DMA buffers
107  *      @c: controller
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
111  *
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.
120  *
121  *      Returns 0 on success, negative error code on timeout or positive error
122  *      code from reply.
123  */
124 int i2o_msg_post_wait_mem(struct i2o_controller *c, struct i2o_message *msg,
125                           unsigned long timeout, struct i2o_dma *dma)
126 {
127         DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
128         struct i2o_exec_wait *wait;
129         static u32 tcntxt = 0x80000000;
130         unsigned long flags;
131         int rc = 0;
132
133         wait = i2o_exec_wait_alloc();
134         if (!wait)
135                 return -ENOMEM;
136
137         if (tcntxt == 0xffffffff)
138                 tcntxt = 0x80000000;
139
140         if (dma)
141                 wait->dma = *dma;
142
143         /*
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.
147          */
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);
151
152         wait->wq = &wq;
153         /*
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
156          */
157         list_add(&wait->list, &i2o_exec_wait_list);
158
159         /*
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.
162          */
163         i2o_msg_post(c, msg);
164
165         wait_event_interruptible_timeout(wq, wait->complete, timeout * HZ);
166
167         spin_lock_irqsave(&wait->lock, flags);
168
169         wait->wq = NULL;
170
171         if (wait->complete)
172                 rc = le32_to_cpu(wait->msg->body[0]) >> 24;
173         else {
174                 /*
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.
178                  *
179                  * FIXME: try abort message
180                  */
181                 if (dma)
182                         dma->virt = NULL;
183
184                 rc = -ETIMEDOUT;
185         }
186
187         spin_unlock_irqrestore(&wait->lock, flags);
188
189         if (rc != -ETIMEDOUT) {
190                 i2o_flush_reply(c, wait->m);
191                 i2o_exec_wait_free(wait);
192         }
193
194         return rc;
195 };
196
197 /**
198  *      i2o_msg_post_wait_complete - Reply to a i2o_msg_post request from IOP
199  *      @c: I2O controller which answers
200  *      @m: message id
201  *      @msg: pointer to the I2O reply message
202  *      @context: transaction context of request
203  *
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
209  *      DMA buffer).
210  *
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.
215  */
216 static int i2o_msg_post_wait_complete(struct i2o_controller *c, u32 m,
217                                       struct i2o_message *msg, u32 context)
218 {
219         struct i2o_exec_wait *wait, *tmp;
220         unsigned long flags;
221         int rc = 1;
222
223         /*
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.
229          */
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);
233
234                         list_del(&wait->list);
235
236                         wait->m = m;
237                         wait->msg = msg;
238                         wait->complete = 1;
239
240                         if (wait->wq)
241                                 rc = 0;
242                         else
243                                 rc = -1;
244
245                         spin_unlock_irqrestore(&wait->lock, flags);
246
247                         if (rc) {
248                                 struct device *dev;
249
250                                 dev = &c->pdev->dev;
251
252                                 pr_debug("%s: timedout reply received!\n",
253                                          c->name);
254                                 i2o_dma_free(dev, &wait->dma);
255                                 i2o_exec_wait_free(wait);
256                         } else
257                                 wake_up_interruptible(wait->wq);
258
259                         return rc;
260                 }
261         }
262
263         osm_warn("%s: Bogus reply in POST WAIT (tr-context: %08x)!\n", c->name,
264                  context);
265
266         return -1;
267 };
268
269 /**
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
273  *
274  *      Returns number of bytes printed into buffer.
275  */
276 static ssize_t i2o_exec_show_vendor_id(struct device *d,
277                                        struct device_attribute *attr, char *buf)
278 {
279         struct i2o_device *dev = to_i2o_device(d);
280         u16 id;
281
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;
285         }
286
287         return 0;
288 };
289
290 /**
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
294  *
295  *      Returns number of bytes printed into buffer.
296  */
297 static ssize_t i2o_exec_show_product_id(struct device *d,
298                                         struct device_attribute *attr,
299                                         char *buf)
300 {
301         struct i2o_device *dev = to_i2o_device(d);
302         u16 id;
303
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;
307         }
308
309         return 0;
310 };
311
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);
315
316 /**
317  *      i2o_exec_probe - Called if a new I2O device (executive class) appears
318  *      @dev: I2O device which should be probed
319  *
320  *      Registers event notification for every event from Executive device. The
321  *      return is always 0, because we want all devices of class Executive.
322  *
323  *      Returns 0 on success.
324  */
325 static int i2o_exec_probe(struct device *dev)
326 {
327         struct i2o_device *i2o_dev = to_i2o_device(dev);
328         int rc;
329
330         rc = i2o_event_register(i2o_dev, &i2o_exec_driver, 0, 0xffffffff);
331         if (rc) goto err_out;
332
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;
337
338         return 0;
339
340 err_vid:
341         device_remove_file(dev, &dev_attr_vendor_id);
342 err_evtreg:
343         i2o_event_register(to_i2o_device(dev), &i2o_exec_driver, 0, 0);
344 err_out:
345         return rc;
346 };
347
348 /**
349  *      i2o_exec_remove - Called on I2O device removal
350  *      @dev: I2O device which was removed
351  *
352  *      Unregisters event notification from Executive I2O device.
353  *
354  *      Returns 0 on success.
355  */
356 static int i2o_exec_remove(struct device *dev)
357 {
358         device_remove_file(dev, &dev_attr_product_id);
359         device_remove_file(dev, &dev_attr_vendor_id);
360
361         i2o_event_register(to_i2o_device(dev), &i2o_exec_driver, 0, 0);
362
363         return 0;
364 };
365
366 /**
367  *      i2o_exec_lct_modified - Called on LCT NOTIFY reply
368  *      @c: I2O controller on which the LCT has modified
369  *
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.
373  */
374 static void i2o_exec_lct_modified(struct i2o_exec_lct_notify_work *work)
375 {
376         u32 change_ind = 0;
377         struct i2o_controller *c = work->c;
378
379         kfree(work);
380
381         if (i2o_device_parse_lct(c) != -EAGAIN)
382                 change_ind = c->lct->change_ind + 1;
383
384 #ifdef CONFIG_I2O_LCT_NOTIFY_ON_CHANGES
385         i2o_exec_lct_notify(c, change_ind);
386 #endif
387 };
388
389 /**
390  *      i2o_exec_reply -  I2O Executive reply handler
391  *      @c: I2O controller from which the reply comes
392  *      @m: message id
393  *      @msg: pointer to the I2O reply message
394  *
395  *      This function is always called from interrupt context. If a POST WAIT
396  *      reply was received, pass it to the complete function. If a LCT NOTIFY
397  *      reply was received, a new event is created to handle the update.
398  *
399  *      Returns 0 on success and if the reply should not be flushed or > 0
400  *      on success and if the reply should be flushed. Returns negative error
401  *      code on failure and if the reply should be flushed.
402  */
403 static int i2o_exec_reply(struct i2o_controller *c, u32 m,
404                           struct i2o_message *msg)
405 {
406         u32 context;
407
408         if (le32_to_cpu(msg->u.head[0]) & MSG_FAIL) {
409                 struct i2o_message __iomem *pmsg;
410                 u32 pm;
411
412                 /*
413                  * If Fail bit is set we must take the transaction context of
414                  * the preserved message to find the right request again.
415                  */
416
417                 pm = le32_to_cpu(msg->body[3]);
418                 pmsg = i2o_msg_in_to_virt(c, pm);
419                 context = readl(&pmsg->u.s.tcntxt);
420
421                 i2o_report_status(KERN_INFO, "i2o_core", msg);
422
423                 /* Release the preserved msg */
424                 i2o_msg_nop_mfa(c, pm);
425         } else
426                 context = le32_to_cpu(msg->u.s.tcntxt);
427
428         if (context & 0x80000000)
429                 return i2o_msg_post_wait_complete(c, m, msg, context);
430
431         if ((le32_to_cpu(msg->u.head[1]) >> 24) == I2O_CMD_LCT_NOTIFY) {
432                 struct i2o_exec_lct_notify_work *work;
433
434                 pr_debug("%s: LCT notify received\n", c->name);
435
436                 work = kmalloc(sizeof(*work), GFP_ATOMIC);
437                 if (!work)
438                         return -ENOMEM;
439
440                 work->c = c;
441
442                 INIT_WORK(&work->work, (void (*)(void *))i2o_exec_lct_modified,
443                           work);
444                 queue_work(i2o_exec_driver.event_queue, &work->work);
445                 return 1;
446         }
447
448         /*
449          * If this happens, we want to dump the message to the syslog so
450          * it can be sent back to the card manufacturer by the end user
451          * to aid in debugging.
452          *
453          */
454         printk(KERN_WARNING "%s: Unsolicited message reply sent to core!"
455                "Message dumped to syslog\n", c->name);
456         i2o_dump_message(msg);
457
458         return -EFAULT;
459 }
460
461 /**
462  *      i2o_exec_event - Event handling function
463  *      @evt: Event which occurs
464  *
465  *      Handles events send by the Executive device. At the moment does not do
466  *      anything useful.
467  */
468 static void i2o_exec_event(struct i2o_event *evt)
469 {
470         if (likely(evt->i2o_dev))
471                 osm_debug("Event received from device: %d\n",
472                           evt->i2o_dev->lct_data.tid);
473         kfree(evt);
474 };
475
476 /**
477  *      i2o_exec_lct_get - Get the IOP's Logical Configuration Table
478  *      @c: I2O controller from which the LCT should be fetched
479  *
480  *      Send a LCT NOTIFY request to the controller, and wait
481  *      I2O_TIMEOUT_LCT_GET seconds until arrival of response. If the LCT is
482  *      to large, retry it.
483  *
484  *      Returns 0 on success or negative error code on failure.
485  */
486 int i2o_exec_lct_get(struct i2o_controller *c)
487 {
488         struct i2o_message *msg;
489         int i = 0;
490         int rc = -EAGAIN;
491
492         for (i = 1; i <= I2O_LCT_GET_TRIES; i++) {
493                 msg = i2o_msg_get_wait(c, I2O_TIMEOUT_MESSAGE_GET);
494                 if (IS_ERR(msg))
495                         return PTR_ERR(msg);
496
497                 msg->u.head[0] =
498                     cpu_to_le32(EIGHT_WORD_MSG_SIZE | SGL_OFFSET_6);
499                 msg->u.head[1] =
500                     cpu_to_le32(I2O_CMD_LCT_NOTIFY << 24 | HOST_TID << 12 |
501                                 ADAPTER_TID);
502                 msg->body[0] = cpu_to_le32(0xffffffff);
503                 msg->body[1] = cpu_to_le32(0x00000000);
504                 msg->body[2] = cpu_to_le32(0xd0000000 | c->dlct.len);
505                 msg->body[3] = cpu_to_le32(c->dlct.phys);
506
507                 rc = i2o_msg_post_wait(c, msg, I2O_TIMEOUT_LCT_GET);
508                 if (rc < 0)
509                         break;
510
511                 rc = i2o_device_parse_lct(c);
512                 if (rc != -EAGAIN)
513                         break;
514         }
515
516         return rc;
517 }
518
519 /**
520  *      i2o_exec_lct_notify - Send a asynchronus LCT NOTIFY request
521  *      @c: I2O controller to which the request should be send
522  *      @change_ind: change indicator
523  *
524  *      This function sends a LCT NOTIFY request to the I2O controller with
525  *      the change indicator change_ind. If the change_ind == 0 the controller
526  *      replies immediately after the request. If change_ind > 0 the reply is
527  *      send after change indicator of the LCT is > change_ind.
528  */
529 static int i2o_exec_lct_notify(struct i2o_controller *c, u32 change_ind)
530 {
531         i2o_status_block *sb = c->status_block.virt;
532         struct device *dev;
533         struct i2o_message *msg;
534
535         down(&c->lct_lock);
536
537         dev = &c->pdev->dev;
538
539         if (i2o_dma_realloc
540             (dev, &c->dlct, le32_to_cpu(sb->expected_lct_size), GFP_KERNEL))
541                 return -ENOMEM;
542
543         msg = i2o_msg_get_wait(c, I2O_TIMEOUT_MESSAGE_GET);
544         if (IS_ERR(msg))
545                 return PTR_ERR(msg);
546
547         msg->u.head[0] = cpu_to_le32(EIGHT_WORD_MSG_SIZE | SGL_OFFSET_6);
548         msg->u.head[1] = cpu_to_le32(I2O_CMD_LCT_NOTIFY << 24 | HOST_TID << 12 |
549                                      ADAPTER_TID);
550         msg->u.s.icntxt = cpu_to_le32(i2o_exec_driver.context);
551         msg->u.s.tcntxt = cpu_to_le32(0x00000000);
552         msg->body[0] = cpu_to_le32(0xffffffff);
553         msg->body[1] = cpu_to_le32(change_ind);
554         msg->body[2] = cpu_to_le32(0xd0000000 | c->dlct.len);
555         msg->body[3] = cpu_to_le32(c->dlct.phys);
556
557         i2o_msg_post(c, msg);
558
559         up(&c->lct_lock);
560
561         return 0;
562 };
563
564 /* Exec OSM driver struct */
565 struct i2o_driver i2o_exec_driver = {
566         .name = OSM_NAME,
567         .reply = i2o_exec_reply,
568         .event = i2o_exec_event,
569         .classes = i2o_exec_class_id,
570         .driver = {
571                    .probe = i2o_exec_probe,
572                    .remove = i2o_exec_remove,
573                    },
574 };
575
576 /**
577  *      i2o_exec_init - Registers the Exec OSM
578  *
579  *      Registers the Exec OSM in the I2O core.
580  *
581  *      Returns 0 on success or negative error code on failure.
582  */
583 int __init i2o_exec_init(void)
584 {
585         return i2o_driver_register(&i2o_exec_driver);
586 };
587
588 /**
589  *      i2o_exec_exit - Removes the Exec OSM
590  *
591  *      Unregisters the Exec OSM from the I2O core.
592  */
593 void __exit i2o_exec_exit(void)
594 {
595         i2o_driver_unregister(&i2o_exec_driver);
596 };
597
598 EXPORT_SYMBOL(i2o_msg_post_wait_mem);
599 EXPORT_SYMBOL(i2o_exec_lct_get);