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 /* 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
  64                                            was received */
  65 };
  66
  67 /* Exec OSM class handling definition */
  68 static struct i2o_class_id i2o_exec_class_id[] = {
  69         {I2O_CLASS_EXECUTIVE},
  70         {I2O_CLASS_END}
  71 };
  72
  73 /**
  74  *      i2o_exec_wait_alloc - Allocate a i2o_exec_wait struct an initialize it
  75  *
  76  *      Allocate the i2o_exec_wait struct and initialize the wait.
  77  *
  78  *      Returns i2o_exec_wait pointer on success or negative error code on
  79  *      failure.
  80  */
  81 static struct i2o_exec_wait *i2o_exec_wait_alloc(void)
  82 {
  83         struct i2o_exec_wait *wait;
  84
  85         wait = kzalloc(sizeof(*wait), GFP_KERNEL);
  86         if (!wait)
  87                 return NULL;
  88
  89         INIT_LIST_HEAD(&wait->list);
  90
  91         return wait;
  92 };
  93
  94 /**
  95  *      i2o_exec_wait_free - Free a i2o_exec_wait struct
  96  *      @i2o_exec_wait: I2O wait data which should be cleaned up
  97  */
  98 static void i2o_exec_wait_free(struct i2o_exec_wait *wait)
  99 {
 100         kfree(wait);
 101 };
 102
 103 /**
 104  *      i2o_msg_post_wait_mem - Post and wait a message with DMA buffers
 105  *      @c: controller
 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
 109  *
 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.
 118  *
 119  *      Returns 0 on success, negative error code on timeout or positive error
 120  *      code from reply.
 121  */
 122 int i2o_msg_post_wait_mem(struct i2o_controller *c, struct i2o_message *msg,
 123                           unsigned long timeout, struct i2o_dma *dma)
 124 {
 125         DECLARE_WAIT_QUEUE_HEAD(wq);
 126         struct i2o_exec_wait *wait;
 127         static u32 tcntxt = 0x80000000;
 128         int rc = 0;
 129
 130         wait = i2o_exec_wait_alloc();
 131         if (!wait)
 132                 return -ENOMEM;
 133
 134         if (tcntxt == 0xffffffff)
 135                 tcntxt = 0x80000000;
 136
 137         if (dma)
 138                 wait->dma = *dma;
 139
 140         /*
 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.
 144          */
 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);
 148
 149         /*
 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.
 152          */
 153         i2o_msg_post(c, msg);
 154
 155         if (!wait->complete) {
 156                 wait->wq = &wq;
 157                 /*
 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
 160                  */
 161                 list_add(&wait->list, &i2o_exec_wait_list);
 162
 163                 wait_event_interruptible_timeout(wq, wait->complete,
 164                                                  timeout * HZ);
 165
 166                 wait->wq = NULL;
 167         }
 168
 169         barrier();
 170
 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);
 175         } else {
 176                 /*
 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.
 180                  *
 181                  * FIXME: try abort message
 182                  */
 183                 if (dma)
 184                         dma->virt = NULL;
 185
 186                 rc = -ETIMEDOUT;
 187         }
 188
 189         return rc;
 190 };
 191
 192 /**
 193  *      i2o_msg_post_wait_complete - Reply to a i2o_msg_post request from IOP
 194  *      @c: I2O controller which answers
 195  *      @m: message id
 196  *      @msg: pointer to the I2O reply message
 197  *      @context: transaction context of request
 198  *
 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
 204  *      DMA buffer).
 205  *
 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.
 210  */
 211 static int i2o_msg_post_wait_complete(struct i2o_controller *c, u32 m,
 212                                       struct i2o_message *msg, u32 context)
 213 {
 214         struct i2o_exec_wait *wait, *tmp;
 215         unsigned long flags;
 216         static spinlock_t lock = SPIN_LOCK_UNLOCKED;
 217         int rc = 1;
 218
 219         /*
 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.
 225          */
 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);
 230
 231                         spin_unlock_irqrestore(&lock, flags);
 232
 233                         wait->m = m;
 234                         wait->msg = msg;
 235                         wait->complete = 1;
 236
 237                         barrier();
 238
 239                         if (wait->wq) {
 240                                 wake_up_interruptible(wait->wq);
 241                                 rc = 0;
 242                         } else {
 243                                 struct device *dev;
 244
 245                                 dev = &c->pdev->dev;
 246
 247                                 pr_debug("%s: timedout reply received!\n",
 248                                          c->name);
 249                                 i2o_dma_free(dev, &wait->dma);
 250                                 i2o_exec_wait_free(wait);
 251                                 rc = -1;
 252                         }
 253
 254                         return rc;
 255                 }
 256         }
 257
 258         spin_unlock_irqrestore(&lock, flags);
 259
 260         osm_warn("%s: Bogus reply in POST WAIT (tr-context: %08x)!\n", c->name,
 261                  context);
 262
 263         return -1;
 264 };
 265
 266 /**
 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
 270  *
 271  *      Returns number of bytes printed into buffer.
 272  */
 273 static ssize_t i2o_exec_show_vendor_id(struct device *d,
 274                                        struct device_attribute *attr, char *buf)
 275 {
 276         struct i2o_device *dev = to_i2o_device(d);
 277         u16 id;
 278
 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;
 282         }
 283
 284         return 0;
 285 };
 286
 287 /**
 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
 291  *
 292  *      Returns number of bytes printed into buffer.
 293  */
 294 static ssize_t i2o_exec_show_product_id(struct device *d,
 295                                         struct device_attribute *attr,
 296                                         char *buf)
 297 {
 298         struct i2o_device *dev = to_i2o_device(d);
 299         u16 id;
 300
 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;
 304         }
 305
 306         return 0;
 307 };
 308
 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);
 312
 313 /**
 314  *      i2o_exec_probe - Called if a new I2O device (executive class) appears
 315  *      @dev: I2O device which should be probed
 316  *
 317  *      Registers event notification for every event from Executive device. The
 318  *      return is always 0, because we want all devices of class Executive.
 319  *
 320  *      Returns 0 on success.
 321  */
 322 static int i2o_exec_probe(struct device *dev)
 323 {
 324         struct i2o_device *i2o_dev = to_i2o_device(dev);
 325         struct i2o_controller *c = i2o_dev->iop;
 326
 327         i2o_event_register(i2o_dev, &i2o_exec_driver, 0, 0xffffffff);
 328
 329         c->exec = i2o_dev;
 330
 331         i2o_exec_lct_notify(c, c->lct->change_ind + 1);
 332
 333         device_create_file(dev, &dev_attr_vendor_id);
 334         device_create_file(dev, &dev_attr_product_id);
 335
 336         return 0;
 337 };
 338
 339 /**
 340  *      i2o_exec_remove - Called on I2O device removal
 341  *      @dev: I2O device which was removed
 342  *
 343  *      Unregisters event notification from Executive I2O device.
 344  *
 345  *      Returns 0 on success.
 346  */
 347 static int i2o_exec_remove(struct device *dev)
 348 {
 349         device_remove_file(dev, &dev_attr_product_id);
 350         device_remove_file(dev, &dev_attr_vendor_id);
 351
 352         i2o_event_register(to_i2o_device(dev), &i2o_exec_driver, 0, 0);
 353
 354         return 0;
 355 };
 356
 357 /**
 358  *      i2o_exec_lct_modified - Called on LCT NOTIFY reply
 359  *      @c: I2O controller on which the LCT has modified
 360  *
 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.
 364  */
 365 static void i2o_exec_lct_modified(struct i2o_exec_lct_notify_work *work)
 366 {
 367         u32 change_ind = 0;
 368         struct i2o_controller *c = work->c;
 369
 370         kfree(work);
 371
 372         if (i2o_device_parse_lct(c) != -EAGAIN)
 373                 change_ind = c->lct->change_ind + 1;
 374
 375 #ifdef CONFIG_I2O_LCT_NOTIFY_ON_CHANGES
 376         i2o_exec_lct_notify(c, change_ind);
 377 #endif
 378 };
 379
 380 /**
 381  *      i2o_exec_reply -  I2O Executive reply handler
 382  *      @c: I2O controller from which the reply comes
 383  *      @m: message id
 384  *      @msg: pointer to the I2O reply message
 385  *
 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.
 389  *
 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.
 393  */
 394 static int i2o_exec_reply(struct i2o_controller *c, u32 m,
 395                           struct i2o_message *msg)
 396 {
 397         u32 context;
 398
 399         if (le32_to_cpu(msg->u.head[0]) & MSG_FAIL) {
 400                 struct i2o_message __iomem *pmsg;
 401                 u32 pm;
 402
 403                 /*
 404                  * If Fail bit is set we must take the transaction context of
 405                  * the preserved message to find the right request again.
 406                  */
 407
 408                 pm = le32_to_cpu(msg->body[3]);
 409                 pmsg = i2o_msg_in_to_virt(c, pm);
 410                 context = readl(&pmsg->u.s.tcntxt);
 411
 412                 i2o_report_status(KERN_INFO, "i2o_core", msg);
 413
 414                 /* Release the preserved msg */
 415                 i2o_msg_nop_mfa(c, pm);
 416         } else
 417                 context = le32_to_cpu(msg->u.s.tcntxt);
 418
 419         if (context & 0x80000000)
 420                 return i2o_msg_post_wait_complete(c, m, msg, context);
 421
 422         if ((le32_to_cpu(msg->u.head[1]) >> 24) == I2O_CMD_LCT_NOTIFY) {
 423                 struct i2o_exec_lct_notify_work *work;
 424
 425                 pr_debug("%s: LCT notify received\n", c->name);
 426
 427                 work = kmalloc(sizeof(*work), GFP_ATOMIC);
 428                 if (!work)
 429                         return -ENOMEM;
 430
 431                 work->c = c;
 432
 433                 INIT_WORK(&work->work, (void (*)(void *))i2o_exec_lct_modified,
 434                           work);
 435                 queue_work(i2o_exec_driver.event_queue, &work->work);
 436                 return 1;
 437         }
 438
 439         /*
 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.
 443          *
 444          */
 445         printk(KERN_WARNING "%s: Unsolicited message reply sent to core!"
 446                "Message dumped to syslog\n", c->name);
 447         i2o_dump_message(msg);
 448
 449         return -EFAULT;
 450 }
 451
 452 /**
 453  *      i2o_exec_event - Event handling function
 454  *      @evt: Event which occurs
 455  *
 456  *      Handles events send by the Executive device. At the moment does not do
 457  *      anything useful.
 458  */
 459 static void i2o_exec_event(struct i2o_event *evt)
 460 {
 461         if (likely(evt->i2o_dev))
 462                 osm_debug("Event received from device: %d\n",
 463                           evt->i2o_dev->lct_data.tid);
 464         kfree(evt);
 465 };
 466
 467 /**
 468  *      i2o_exec_lct_get - Get the IOP's Logical Configuration Table
 469  *      @c: I2O controller from which the LCT should be fetched
 470  *
 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.
 474  *
 475  *      Returns 0 on success or negative error code on failure.
 476  */
 477 int i2o_exec_lct_get(struct i2o_controller *c)
 478 {
 479         struct i2o_message *msg;
 480         int i = 0;
 481         int rc = -EAGAIN;
 482
 483         for (i = 1; i <= I2O_LCT_GET_TRIES; i++) {
 484                 msg = i2o_msg_get_wait(c, I2O_TIMEOUT_MESSAGE_GET);
 485                 if (IS_ERR(msg))
 486                         return PTR_ERR(msg);
 487
 488                 msg->u.head[0] =
 489                     cpu_to_le32(EIGHT_WORD_MSG_SIZE | SGL_OFFSET_6);
 490                 msg->u.head[1] =
 491                     cpu_to_le32(I2O_CMD_LCT_NOTIFY << 24 | HOST_TID << 12 |
 492                                 ADAPTER_TID);
 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);
 497
 498                 rc = i2o_msg_post_wait(c, msg, I2O_TIMEOUT_LCT_GET);
 499                 if (rc < 0)
 500                         break;
 501
 502                 rc = i2o_device_parse_lct(c);
 503                 if (rc != -EAGAIN)
 504                         break;
 505         }
 506
 507         return rc;
 508 }
 509
 510 /**
 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
 514  *
 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.
 519  */
 520 static int i2o_exec_lct_notify(struct i2o_controller *c, u32 change_ind)
 521 {
 522         i2o_status_block *sb = c->status_block.virt;
 523         struct device *dev;
 524         struct i2o_message *msg;
 525
 526         dev = &c->pdev->dev;
 527
 528         if (i2o_dma_realloc
 529             (dev, &c->dlct, le32_to_cpu(sb->expected_lct_size), GFP_KERNEL))
 530                 return -ENOMEM;
 531
 532         msg = i2o_msg_get_wait(c, I2O_TIMEOUT_MESSAGE_GET);
 533         if (IS_ERR(msg))
 534                 return PTR_ERR(msg);
 535
 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 |
 538                                      ADAPTER_TID);
 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);
 545
 546         i2o_msg_post(c, msg);
 547
 548         return 0;
 549 };
 550
 551 /* Exec OSM driver struct */
 552 struct i2o_driver i2o_exec_driver = {
 553         .name = OSM_NAME,
 554         .reply = i2o_exec_reply,
 555         .event = i2o_exec_event,
 556         .classes = i2o_exec_class_id,
 557         .driver = {
 558                    .probe = i2o_exec_probe,
 559                    .remove = i2o_exec_remove,
 560                    },
 561 };
 562
 563 /**
 564  *      i2o_exec_init - Registers the Exec OSM
 565  *
 566  *      Registers the Exec OSM in the I2O core.
 567  *
 568  *      Returns 0 on success or negative error code on failure.
 569  */
 570 int __init i2o_exec_init(void)
 571 {
 572         return i2o_driver_register(&i2o_exec_driver);
 573 };
 574
 575 /**
 576  *      i2o_exec_exit - Removes the Exec OSM
 577  *
 578  *      Unregisters the Exec OSM from the I2O core.
 579  */
 580 void __exit i2o_exec_exit(void)
 581 {
 582         i2o_driver_unregister(&i2o_exec_driver);
 583 };
 584
 585 EXPORT_SYMBOL(i2o_msg_post_wait_mem);
 586 EXPORT_SYMBOL(i2o_exec_lct_get);