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