b675b4ebbebdff558521b181d81b4eb2ab59b7c7
[linux-2.6.git] / 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 <asm/param.h>          /* HZ */
37 #include "core.h"
38
39 #define OSM_NAME "exec-osm"
40
41 struct i2o_driver i2o_exec_driver;
42
43 static int i2o_exec_lct_notify(struct i2o_controller *c, u32 change_ind);
44
45 /* global wait list for POST WAIT */
46 static LIST_HEAD(i2o_exec_wait_list);
47
48 /* Wait struct needed for POST WAIT */
49 struct i2o_exec_wait {
50         wait_queue_head_t *wq;  /* Pointer to Wait queue */
51         struct i2o_dma dma;     /* DMA buffers to free on failure */
52         u32 tcntxt;             /* transaction context from reply */
53         int complete;           /* 1 if reply received otherwise 0 */
54         u32 m;                  /* message id */
55         struct i2o_message *msg;        /* pointer to the reply message */
56         struct list_head list;  /* node in global wait list */
57 };
58
59 /* Exec OSM class handling definition */
60 static struct i2o_class_id i2o_exec_class_id[] = {
61         {I2O_CLASS_EXECUTIVE},
62         {I2O_CLASS_END}
63 };
64
65 /**
66  *      i2o_exec_wait_alloc - Allocate a i2o_exec_wait struct an initialize it
67  *
68  *      Allocate the i2o_exec_wait struct and initialize the wait.
69  *
70  *      Returns i2o_exec_wait pointer on success or negative error code on
71  *      failure.
72  */
73 static struct i2o_exec_wait *i2o_exec_wait_alloc(void)
74 {
75         struct i2o_exec_wait *wait;
76
77         wait = kmalloc(sizeof(*wait), GFP_KERNEL);
78         if (!wait)
79                 return ERR_PTR(-ENOMEM);
80
81         memset(wait, 0, sizeof(*wait));
82
83         INIT_LIST_HEAD(&wait->list);
84
85         return wait;
86 };
87
88 /**
89  *      i2o_exec_wait_free - Free a i2o_exec_wait struct
90  *      @i2o_exec_wait: I2O wait data which should be cleaned up
91  */
92 static void i2o_exec_wait_free(struct i2o_exec_wait *wait)
93 {
94         kfree(wait);
95 };
96
97 /**
98  *      i2o_msg_post_wait_mem - Post and wait a message with DMA buffers
99  *      @c: controller
100  *      @m: message to post
101  *      @timeout: time in seconds to wait
102  *      @dma: i2o_dma struct of the DMA buffer to free on failure
103  *
104  *      This API allows an OSM to post a message and then be told whether or
105  *      not the system received a successful reply. If the message times out
106  *      then the value '-ETIMEDOUT' is returned. This is a special case. In
107  *      this situation the message may (should) complete at an indefinite time
108  *      in the future. When it completes it will use the memory buffer
109  *      attached to the request. If -ETIMEDOUT is returned then the memory
110  *      buffer must not be freed. Instead the event completion will free them
111  *      for you. In all other cases the buffer are your problem.
112  *
113  *      Returns 0 on success, negative error code on timeout or positive error
114  *      code from reply.
115  */
116 int i2o_msg_post_wait_mem(struct i2o_controller *c, u32 m, unsigned long
117                           timeout, struct i2o_dma *dma)
118 {
119         DECLARE_WAIT_QUEUE_HEAD(wq);
120         struct i2o_exec_wait *wait;
121         static u32 tcntxt = 0x80000000;
122         struct i2o_message __iomem *msg = i2o_msg_in_to_virt(c, m);
123         int rc = 0;
124
125         wait = i2o_exec_wait_alloc();
126         if (!wait)
127                 return -ENOMEM;
128
129         if (tcntxt == 0xffffffff)
130                 tcntxt = 0x80000000;
131
132         if (dma)
133                 wait->dma = *dma;
134
135         /*
136          * Fill in the message initiator context and transaction context.
137          * We will only use transaction contexts >= 0x80000000 for POST WAIT,
138          * so we could find a POST WAIT reply easier in the reply handler.
139          */
140         writel(i2o_exec_driver.context, &msg->u.s.icntxt);
141         wait->tcntxt = tcntxt++;
142         writel(wait->tcntxt, &msg->u.s.tcntxt);
143
144         /*
145          * Post the message to the controller. At some point later it will
146          * return. If we time out before it returns then complete will be zero.
147          */
148         i2o_msg_post(c, m);
149
150         if (!wait->complete) {
151                 wait->wq = &wq;
152                 /*
153                  * we add elements add the head, because if a entry in the list
154                  * will never be removed, we have to iterate over it every time
155                  */
156                 list_add(&wait->list, &i2o_exec_wait_list);
157
158                 wait_event_interruptible_timeout(wq, wait->complete,
159                                                  timeout * HZ);
160
161                 wait->wq = NULL;
162         }
163
164         barrier();
165
166         if (wait->complete) {
167                 rc = le32_to_cpu(wait->msg->body[0]) >> 24;
168                 i2o_flush_reply(c, wait->m);
169                 i2o_exec_wait_free(wait);
170         } else {
171                 /*
172                  * We cannot remove it now. This is important. When it does
173                  * terminate (which it must do if the controller has not
174                  * died...) then it will otherwise scribble on stuff.
175                  *
176                  * FIXME: try abort message
177                  */
178                 if (dma)
179                         dma->virt = NULL;
180
181                 rc = -ETIMEDOUT;
182         }
183
184         return rc;
185 };
186
187 /**
188  *      i2o_msg_post_wait_complete - Reply to a i2o_msg_post request from IOP
189  *      @c: I2O controller which answers
190  *      @m: message id
191  *      @msg: pointer to the I2O reply message
192  *      @context: transaction context of request
193  *
194  *      This function is called in interrupt context only. If the reply reached
195  *      before the timeout, the i2o_exec_wait struct is filled with the message
196  *      and the task will be waked up. The task is now responsible for returning
197  *      the message m back to the controller! If the message reaches us after
198  *      the timeout clean up the i2o_exec_wait struct (including allocated
199  *      DMA buffer).
200  *
201  *      Return 0 on success and if the message m should not be given back to the
202  *      I2O controller, or >0 on success and if the message should be given back
203  *      afterwords. Returns negative error code on failure. In this case the
204  *      message must also be given back to the controller.
205  */
206 static int i2o_msg_post_wait_complete(struct i2o_controller *c, u32 m,
207                                       struct i2o_message *msg, u32 context)
208 {
209         struct i2o_exec_wait *wait, *tmp;
210         unsigned long flags;
211         static spinlock_t lock = SPIN_LOCK_UNLOCKED;
212         int rc = 1;
213
214         /*
215          * We need to search through the i2o_exec_wait_list to see if the given
216          * message is still outstanding. If not, it means that the IOP took
217          * longer to respond to the message than we had allowed and timer has
218          * already expired. Not much we can do about that except log it for
219          * debug purposes, increase timeout, and recompile.
220          */
221         spin_lock_irqsave(&lock, flags);
222         list_for_each_entry_safe(wait, tmp, &i2o_exec_wait_list, list) {
223                 if (wait->tcntxt == context) {
224                         list_del(&wait->list);
225
226                         spin_unlock_irqrestore(&lock, flags);
227
228                         wait->m = m;
229                         wait->msg = msg;
230                         wait->complete = 1;
231
232                         barrier();
233
234                         if (wait->wq) {
235                                 wake_up_interruptible(wait->wq);
236                                 rc = 0;
237                         } else {
238                                 struct device *dev;
239
240                                 dev = &c->pdev->dev;
241
242                                 pr_debug("%s: timedout reply received!\n",
243                                          c->name);
244                                 i2o_dma_free(dev, &wait->dma);
245                                 i2o_exec_wait_free(wait);
246                                 rc = -1;
247                         }
248
249                         return rc;
250                 }
251         }
252
253         spin_unlock_irqrestore(&lock, flags);
254
255         osm_warn("%s: Bogus reply in POST WAIT (tr-context: %08x)!\n", c->name,
256                  context);
257
258         return -1;
259 };
260
261 /**
262  *      i2o_exec_show_vendor_id - Displays Vendor ID of controller
263  *      @d: device of which the Vendor ID should be displayed
264  *      @buf: buffer into which the Vendor ID should be printed
265  *
266  *      Returns number of bytes printed into buffer.
267  */
268 static ssize_t i2o_exec_show_vendor_id(struct device *d, struct device_attribute *attr, char *buf)
269 {
270         struct i2o_device *dev = to_i2o_device(d);
271         u16 id;
272
273         if (i2o_parm_field_get(dev, 0x0000, 0, &id, 2)) {
274                 sprintf(buf, "0x%04x", id);
275                 return strlen(buf) + 1;
276         }
277
278         return 0;
279 };
280
281 /**
282  *      i2o_exec_show_product_id - Displays Product ID of controller
283  *      @d: device of which the Product ID should be displayed
284  *      @buf: buffer into which the Product ID should be printed
285  *
286  *      Returns number of bytes printed into buffer.
287  */
288 static ssize_t i2o_exec_show_product_id(struct device *d, struct device_attribute *attr, char *buf)
289 {
290         struct i2o_device *dev = to_i2o_device(d);
291         u16 id;
292
293         if (i2o_parm_field_get(dev, 0x0000, 1, &id, 2)) {
294                 sprintf(buf, "0x%04x", id);
295                 return strlen(buf) + 1;
296         }
297
298         return 0;
299 };
300
301 /* Exec-OSM device attributes */
302 static DEVICE_ATTR(vendor_id, S_IRUGO, i2o_exec_show_vendor_id, NULL);
303 static DEVICE_ATTR(product_id, S_IRUGO, i2o_exec_show_product_id, NULL);
304
305 /**
306  *      i2o_exec_probe - Called if a new I2O device (executive class) appears
307  *      @dev: I2O device which should be probed
308  *
309  *      Registers event notification for every event from Executive device. The
310  *      return is always 0, because we want all devices of class Executive.
311  *
312  *      Returns 0 on success.
313  */
314 static int i2o_exec_probe(struct device *dev)
315 {
316         struct i2o_device *i2o_dev = to_i2o_device(dev);
317         struct i2o_controller *c = i2o_dev->iop;
318
319         i2o_event_register(i2o_dev, &i2o_exec_driver, 0, 0xffffffff);
320
321         c->exec = i2o_dev;
322
323         i2o_exec_lct_notify(c, c->lct->change_ind + 1);
324
325         device_create_file(dev, &dev_attr_vendor_id);
326         device_create_file(dev, &dev_attr_product_id);
327
328         return 0;
329 };
330
331 /**
332  *      i2o_exec_remove - Called on I2O device removal
333  *      @dev: I2O device which was removed
334  *
335  *      Unregisters event notification from Executive I2O device.
336  *
337  *      Returns 0 on success.
338  */
339 static int i2o_exec_remove(struct device *dev)
340 {
341         device_remove_file(dev, &dev_attr_product_id);
342         device_remove_file(dev, &dev_attr_vendor_id);
343
344         i2o_event_register(to_i2o_device(dev), &i2o_exec_driver, 0, 0);
345
346         return 0;
347 };
348
349 /**
350  *      i2o_exec_lct_modified - Called on LCT NOTIFY reply
351  *      @c: I2O controller on which the LCT has modified
352  *
353  *      This function handles asynchronus LCT NOTIFY replies. It parses the
354  *      new LCT and if the buffer for the LCT was to small sends a LCT NOTIFY
355  *      again, otherwise send LCT NOTIFY to get informed on next LCT change.
356  */
357 static void i2o_exec_lct_modified(struct i2o_controller *c)
358 {
359         u32 change_ind = 0;
360
361         if (i2o_device_parse_lct(c) != -EAGAIN)
362                 change_ind = c->lct->change_ind + 1;
363
364         i2o_exec_lct_notify(c, change_ind);
365 };
366
367 /**
368  *      i2o_exec_reply -  I2O Executive reply handler
369  *      @c: I2O controller from which the reply comes
370  *      @m: message id
371  *      @msg: pointer to the I2O reply message
372  *
373  *      This function is always called from interrupt context. If a POST WAIT
374  *      reply was received, pass it to the complete function. If a LCT NOTIFY
375  *      reply was received, a new event is created to handle the update.
376  *
377  *      Returns 0 on success and if the reply should not be flushed or > 0
378  *      on success and if the reply should be flushed. Returns negative error
379  *      code on failure and if the reply should be flushed.
380  */
381 static int i2o_exec_reply(struct i2o_controller *c, u32 m,
382                           struct i2o_message *msg)
383 {
384         u32 context;
385
386         if (le32_to_cpu(msg->u.head[0]) & MSG_FAIL) {
387                 /*
388                  * If Fail bit is set we must take the transaction context of
389                  * the preserved message to find the right request again.
390                  */
391                 struct i2o_message __iomem *pmsg;
392                 u32 pm;
393
394                 pm = le32_to_cpu(msg->body[3]);
395
396                 pmsg = i2o_msg_in_to_virt(c, pm);
397
398                 i2o_report_status(KERN_INFO, "i2o_core", msg);
399
400                 context = readl(&pmsg->u.s.tcntxt);
401
402                 /* Release the preserved msg */
403                 i2o_msg_nop(c, pm);
404         } else
405                 context = le32_to_cpu(msg->u.s.tcntxt);
406
407         if (context & 0x80000000)
408                 return i2o_msg_post_wait_complete(c, m, msg, context);
409
410         if ((le32_to_cpu(msg->u.head[1]) >> 24) == I2O_CMD_LCT_NOTIFY) {
411                 struct work_struct *work;
412
413                 pr_debug("%s: LCT notify received\n", c->name);
414
415                 work = kmalloc(sizeof(*work), GFP_ATOMIC);
416                 if (!work)
417                         return -ENOMEM;
418
419                 INIT_WORK(work, (void (*)(void *))i2o_exec_lct_modified, c);
420                 queue_work(i2o_exec_driver.event_queue, work);
421                 return 1;
422         }
423
424         /*
425          * If this happens, we want to dump the message to the syslog so
426          * it can be sent back to the card manufacturer by the end user
427          * to aid in debugging.
428          *
429          */
430         printk(KERN_WARNING "%s: Unsolicited message reply sent to core!"
431                "Message dumped to syslog\n", c->name);
432         i2o_dump_message(msg);
433
434         return -EFAULT;
435 }
436
437 /**
438  *      i2o_exec_event - Event handling function
439  *      @evt: Event which occurs
440  *
441  *      Handles events send by the Executive device. At the moment does not do
442  *      anything useful.
443  */
444 static void i2o_exec_event(struct i2o_event *evt)
445 {
446         if (likely(evt->i2o_dev))
447                 osm_debug("Event received from device: %d\n",
448                           evt->i2o_dev->lct_data.tid);
449         kfree(evt);
450 };
451
452 /**
453  *      i2o_exec_lct_get - Get the IOP's Logical Configuration Table
454  *      @c: I2O controller from which the LCT should be fetched
455  *
456  *      Send a LCT NOTIFY request to the controller, and wait
457  *      I2O_TIMEOUT_LCT_GET seconds until arrival of response. If the LCT is
458  *      to large, retry it.
459  *
460  *      Returns 0 on success or negative error code on failure.
461  */
462 int i2o_exec_lct_get(struct i2o_controller *c)
463 {
464         struct i2o_message __iomem *msg;
465         u32 m;
466         int i = 0;
467         int rc = -EAGAIN;
468
469         for (i = 1; i <= I2O_LCT_GET_TRIES; i++) {
470                 m = i2o_msg_get_wait(c, &msg, I2O_TIMEOUT_MESSAGE_GET);
471                 if (m == I2O_QUEUE_EMPTY)
472                         return -ETIMEDOUT;
473
474                 writel(EIGHT_WORD_MSG_SIZE | SGL_OFFSET_6, &msg->u.head[0]);
475                 writel(I2O_CMD_LCT_NOTIFY << 24 | HOST_TID << 12 | ADAPTER_TID,
476                        &msg->u.head[1]);
477                 writel(0xffffffff, &msg->body[0]);
478                 writel(0x00000000, &msg->body[1]);
479                 writel(0xd0000000 | c->dlct.len, &msg->body[2]);
480                 writel(c->dlct.phys, &msg->body[3]);
481
482                 rc = i2o_msg_post_wait(c, m, I2O_TIMEOUT_LCT_GET);
483                 if (rc < 0)
484                         break;
485
486                 rc = i2o_device_parse_lct(c);
487                 if (rc != -EAGAIN)
488                         break;
489         }
490
491         return rc;
492 }
493
494 /**
495  *      i2o_exec_lct_notify - Send a asynchronus LCT NOTIFY request
496  *      @c: I2O controller to which the request should be send
497  *      @change_ind: change indicator
498  *
499  *      This function sends a LCT NOTIFY request to the I2O controller with
500  *      the change indicator change_ind. If the change_ind == 0 the controller
501  *      replies immediately after the request. If change_ind > 0 the reply is
502  *      send after change indicator of the LCT is > change_ind.
503  */
504 static int i2o_exec_lct_notify(struct i2o_controller *c, u32 change_ind)
505 {
506         i2o_status_block *sb = c->status_block.virt;
507         struct device *dev;
508         struct i2o_message __iomem *msg;
509         u32 m;
510
511         dev = &c->pdev->dev;
512
513         if (i2o_dma_realloc(dev, &c->dlct, sb->expected_lct_size, GFP_KERNEL))
514                 return -ENOMEM;
515
516         m = i2o_msg_get_wait(c, &msg, I2O_TIMEOUT_MESSAGE_GET);
517         if (m == I2O_QUEUE_EMPTY)
518                 return -ETIMEDOUT;
519
520         writel(EIGHT_WORD_MSG_SIZE | SGL_OFFSET_6, &msg->u.head[0]);
521         writel(I2O_CMD_LCT_NOTIFY << 24 | HOST_TID << 12 | ADAPTER_TID,
522                &msg->u.head[1]);
523         writel(i2o_exec_driver.context, &msg->u.s.icntxt);
524         writel(0, &msg->u.s.tcntxt);    /* FIXME */
525         writel(0xffffffff, &msg->body[0]);
526         writel(change_ind, &msg->body[1]);
527         writel(0xd0000000 | c->dlct.len, &msg->body[2]);
528         writel(c->dlct.phys, &msg->body[3]);
529
530         i2o_msg_post(c, m);
531
532         return 0;
533 };
534
535 /* Exec OSM driver struct */
536 struct i2o_driver i2o_exec_driver = {
537         .name = OSM_NAME,
538         .reply = i2o_exec_reply,
539         .event = i2o_exec_event,
540         .classes = i2o_exec_class_id,
541         .driver = {
542                    .probe = i2o_exec_probe,
543                    .remove = i2o_exec_remove,
544                    },
545 };
546
547 /**
548  *      i2o_exec_init - Registers the Exec OSM
549  *
550  *      Registers the Exec OSM in the I2O core.
551  *
552  *      Returns 0 on success or negative error code on failure.
553  */
554 int __init i2o_exec_init(void)
555 {
556         return i2o_driver_register(&i2o_exec_driver);
557 };
558
559 /**
560  *      i2o_exec_exit - Removes the Exec OSM
561  *
562  *      Unregisters the Exec OSM from the I2O core.
563  */
564 void __exit i2o_exec_exit(void)
565 {
566         i2o_driver_unregister(&i2o_exec_driver);
567 };
568
569 EXPORT_SYMBOL(i2o_msg_post_wait_mem);
570 EXPORT_SYMBOL(i2o_exec_lct_get);