drivers/message/i2o/device.c

   1 /*
   2  *      Functions to handle I2O devices
   3  *
   4  *      Copyright (C) 2004      Markus Lidel <Markus.Lidel@shadowconnect.com>
   5  *
   6  *      This program is free software; you can redistribute it and/or modify it
   7  *      under the terms of the GNU General Public License as published by the
   8  *      Free Software Foundation; either version 2 of the License, or (at your
   9  *      option) any later version.
  10  *
  11  *      Fixes/additions:
  12  *              Markus Lidel <Markus.Lidel@shadowconnect.com>
  13  *                      initial version.
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/i2o.h>
  18 #include <linux/delay.h>
  19 #include "core.h"
  20
  21 /**
  22  *      i2o_device_issue_claim - claim or release a device
  23  *      @dev: I2O device to claim or release
  24  *      @cmd: claim or release command
  25  *      @type: type of claim
  26  *
  27  *      Issue I2O UTIL_CLAIM or UTIL_RELEASE messages. The message to be sent
  28  *      is set by cmd. dev is the I2O device which should be claim or
  29  *      released and the type is the claim type (see the I2O spec).
  30  *
  31  *      Returs 0 on success or negative error code on failure.
  32  */
  33 static inline int i2o_device_issue_claim(struct i2o_device *dev, u32 cmd,
  34                                          u32 type)
  35 {
  36         struct i2o_message __iomem *msg;
  37         u32 m;
  38
  39         m = i2o_msg_get_wait(dev->iop, &msg, I2O_TIMEOUT_MESSAGE_GET);
  40         if (m == I2O_QUEUE_EMPTY)
  41                 return -ETIMEDOUT;
  42
  43         writel(FIVE_WORD_MSG_SIZE | SGL_OFFSET_0, &msg->u.head[0]);
  44         writel(cmd << 24 | HOST_TID << 12 | dev->lct_data.tid, &msg->u.head[1]);
  45         writel(type, &msg->body[0]);
  46
  47         return i2o_msg_post_wait(dev->iop, m, 60);
  48 }
  49
  50 /**
  51  *      i2o_device_claim - claim a device for use by an OSM
  52  *      @dev: I2O device to claim
  53  *      @drv: I2O driver which wants to claim the device
  54  *
  55  *      Do the leg work to assign a device to a given OSM. If the claim succeed
  56  *      the owner of the rimary. If the attempt fails a negative errno code
  57  *      is returned. On success zero is returned.
  58  */
  59 int i2o_device_claim(struct i2o_device *dev)
  60 {
  61         int rc = 0;
  62
  63         down(&dev->lock);
  64
  65         rc = i2o_device_issue_claim(dev, I2O_CMD_UTIL_CLAIM, I2O_CLAIM_PRIMARY);
  66         if (!rc)
  67                 pr_debug("i2o: claim of device %d succeded\n",
  68                          dev->lct_data.tid);
  69         else
  70                 pr_debug("i2o: claim of device %d failed %d\n",
  71                          dev->lct_data.tid, rc);
  72
  73         up(&dev->lock);
  74
  75         return rc;
  76 }
  77
  78 /**
  79  *      i2o_device_claim_release - release a device that the OSM is using
  80  *      @dev: device to release
  81  *      @drv: driver which claimed the device
  82  *
  83  *      Drop a claim by an OSM on a given I2O device.
  84  *
  85  *      AC - some devices seem to want to refuse an unclaim until they have
  86  *      finished internal processing. It makes sense since you don't want a
  87  *      new device to go reconfiguring the entire system until you are done.
  88  *      Thus we are prepared to wait briefly.
  89  *
  90  *      Returns 0 on success or negative error code on failure.
  91  */
  92 int i2o_device_claim_release(struct i2o_device *dev)
  93 {
  94         int tries;
  95         int rc = 0;
  96
  97         down(&dev->lock);
  98
  99         /*
 100          *      If the controller takes a nonblocking approach to
 101          *      releases we have to sleep/poll for a few times.
 102          */
 103         for (tries = 0; tries < 10; tries++) {
 104                 rc = i2o_device_issue_claim(dev, I2O_CMD_UTIL_RELEASE,
 105                                             I2O_CLAIM_PRIMARY);
 106                 if (!rc)
 107                         break;
 108
 109                 ssleep(1);
 110         }
 111
 112         if (!rc)
 113                 pr_debug("i2o: claim release of device %d succeded\n",
 114                          dev->lct_data.tid);
 115         else
 116                 pr_debug("i2o: claim release of device %d failed %d\n",
 117                          dev->lct_data.tid, rc);
 118
 119         up(&dev->lock);
 120
 121         return rc;
 122 }
 123
 124
 125 /**
 126  *      i2o_device_release - release the memory for a I2O device
 127  *      @dev: I2O device which should be released
 128  *
 129  *      Release the allocated memory. This function is called if refcount of
 130  *      device reaches 0 automatically.
 131  */
 132 static void i2o_device_release(struct device *dev)
 133 {
 134         struct i2o_device *i2o_dev = to_i2o_device(dev);
 135
 136         pr_debug("i2o: device %s released\n", dev->bus_id);
 137
 138         kfree(i2o_dev);
 139 }
 140
 141 /**
 142  *      i2o_device_class_release - I2O class device release function
 143  *      @cd: I2O class device which is added to the I2O device class
 144  *
 145  *      The function is just a stub - memory will be freed when
 146  *      associated I2O device is released.
 147  */
 148 static void i2o_device_class_release(struct class_device *cd)
 149 {
 150         /* empty */
 151 }
 152
 153 /**
 154  *      i2o_device_class_show_class_id - Displays class id of I2O device
 155  *      @cd: class device of which the class id should be displayed
 156  *      @buf: buffer into which the class id should be printed
 157  *
 158  *      Returns the number of bytes which are printed into the buffer.
 159  */
 160 static ssize_t i2o_device_class_show_class_id(struct class_device *cd,
 161                                               char *buf)
 162 {
 163         struct i2o_device *dev = to_i2o_device(cd->dev);
 164
 165         sprintf(buf, "0x%03x\n", dev->lct_data.class_id);
 166         return strlen(buf) + 1;
 167 }
 168
 169 /**
 170  *      i2o_device_class_show_tid - Displays TID of I2O device
 171  *      @cd: class device of which the TID should be displayed
 172  *      @buf: buffer into which the class id should be printed
 173  *
 174  *      Returns the number of bytes which are printed into the buffer.
 175  */
 176 static ssize_t i2o_device_class_show_tid(struct class_device *cd, char *buf)
 177 {
 178         struct i2o_device *dev = to_i2o_device(cd->dev);
 179
 180         sprintf(buf, "0x%03x\n", dev->lct_data.tid);
 181         return strlen(buf) + 1;
 182 }
 183
 184 static struct class_device_attribute i2o_device_class_attrs[] = {
 185         __ATTR(class_id, S_IRUGO, i2o_device_class_show_class_id, NULL),
 186         __ATTR(tid, S_IRUGO, i2o_device_class_show_tid, NULL),
 187         __ATTR_NULL
 188 };
 189
 190 /* I2O device class */
 191 static struct class i2o_device_class = {
 192         .name                   = "i2o_device",
 193         .release                = i2o_device_class_release,
 194         .class_dev_attrs        = i2o_device_class_attrs,
 195 };
 196
 197 /**
 198  *      i2o_device_alloc - Allocate a I2O device and initialize it
 199  *
 200  *      Allocate the memory for a I2O device and initialize locks and lists
 201  *
 202  *      Returns the allocated I2O device or a negative error code if the device
 203  *      could not be allocated.
 204  */
 205 static struct i2o_device *i2o_device_alloc(void)
 206 {
 207         struct i2o_device *dev;
 208
 209         dev = kmalloc(sizeof(*dev), GFP_KERNEL);
 210         if (!dev)
 211                 return ERR_PTR(-ENOMEM);
 212
 213         memset(dev, 0, sizeof(*dev));
 214
 215         INIT_LIST_HEAD(&dev->list);
 216         init_MUTEX(&dev->lock);
 217
 218         dev->device.bus = &i2o_bus_type;
 219         dev->device.release = &i2o_device_release;
 220         dev->classdev.class = &i2o_device_class;
 221         dev->classdev.dev = &dev->device;
 222
 223         return dev;
 224 }
 225
 226 /**
 227  *      i2o_setup_sysfs_links - Adds attributes to the I2O device
 228  *      @cd: I2O class device which is added to the I2O device class
 229  *
 230  *      This function get called when a I2O device is added to the class. It
 231  *      creates the attributes for each device and creates user/parent symlink
 232  *      if necessary.
 233  *
 234  *      Returns 0 on success or negative error code on failure.
 235  */
 236 static void i2o_setup_sysfs_links(struct i2o_device *i2o_dev)
 237 {
 238         struct i2o_controller *c = i2o_dev->iop;
 239         struct i2o_device *tmp;
 240
 241         /* create user entries for this device */
 242         tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.user_tid);
 243         if (tmp && tmp != i2o_dev)
 244                 sysfs_create_link(&i2o_dev->device.kobj,
 245                                   &tmp->device.kobj, "user");
 246
 247         /* create user entries refering to this device */
 248         list_for_each_entry(tmp, &c->devices, list)
 249                 if (tmp->lct_data.user_tid == i2o_dev->lct_data.tid &&
 250                     tmp != i2o_dev)
 251                         sysfs_create_link(&tmp->device.kobj,
 252                                           &i2o_dev->device.kobj, "user");
 253
 254         /* create parent entries for this device */
 255         tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.parent_tid);
 256         if (tmp && tmp != i2o_dev)
 257                 sysfs_create_link(&i2o_dev->device.kobj,
 258                                   &tmp->device.kobj, "parent");
 259
 260         /* create parent entries refering to this device */
 261         list_for_each_entry(tmp, &c->devices, list)
 262                 if (tmp->lct_data.parent_tid == i2o_dev->lct_data.tid &&
 263                     tmp != i2o_dev)
 264                 sysfs_create_link(&tmp->device.kobj,
 265                                   &i2o_dev->device.kobj, "parent");
 266 }
 267
 268 static void i2o_remove_sysfs_links(struct i2o_device *i2o_dev)
 269 {
 270         struct i2o_controller *c = i2o_dev->iop;
 271         struct i2o_device *tmp;
 272
 273         sysfs_remove_link(&i2o_dev->device.kobj, "parent");
 274         sysfs_remove_link(&i2o_dev->device.kobj, "user");
 275
 276         list_for_each_entry(tmp, &c->devices, list) {
 277                 if (tmp->lct_data.parent_tid == i2o_dev->lct_data.tid)
 278                         sysfs_remove_link(&tmp->device.kobj, "parent");
 279                 if (tmp->lct_data.user_tid == i2o_dev->lct_data.tid)
 280                         sysfs_remove_link(&tmp->device.kobj, "user");
 281         }
 282 }
 283
 284
 285
 286 /**
 287  *      i2o_device_add - allocate a new I2O device and add it to the IOP
 288  *      @iop: I2O controller where the device is on
 289  *      @entry: LCT entry of the I2O device
 290  *
 291  *      Allocate a new I2O device and initialize it with the LCT entry. The
 292  *      device is appended to the device list of the controller.
 293  *
 294  *      Returns a pointer to the I2O device on success or negative error code
 295  *      on failure.
 296  */
 297 static struct i2o_device *i2o_device_add(struct i2o_controller *c,
 298                                          i2o_lct_entry * entry)
 299 {
 300         struct i2o_device *dev;
 301
 302         dev = i2o_device_alloc();
 303         if (IS_ERR(dev)) {
 304                 printk(KERN_ERR "i2o: unable to allocate i2o device\n");
 305                 return dev;
 306         }
 307
 308         dev->lct_data = *entry;
 309         dev->iop = c;
 310
 311         snprintf(dev->device.bus_id, BUS_ID_SIZE, "%d:%03x", c->unit,
 312                  dev->lct_data.tid);
 313
 314         snprintf(dev->classdev.class_id, BUS_ID_SIZE, "%d:%03x", c->unit,
 315                  dev->lct_data.tid);
 316
 317         dev->device.parent = &c->device;
 318
 319         device_register(&dev->device);
 320
 321         list_add_tail(&dev->list, &c->devices);
 322
 323         class_device_register(&dev->classdev);
 324
 325         i2o_setup_sysfs_links(dev);
 326
 327         i2o_driver_notify_device_add_all(dev);
 328
 329         pr_debug("i2o: device %s added\n", dev->device.bus_id);
 330
 331         return dev;
 332 }
 333
 334 /**
 335  *      i2o_device_remove - remove an I2O device from the I2O core
 336  *      @dev: I2O device which should be released
 337  *
 338  *      Is used on I2O controller removal or LCT modification, when the device
 339  *      is removed from the system. Note that the device could still hang
 340  *      around until the refcount reaches 0.
 341  */
 342 void i2o_device_remove(struct i2o_device *i2o_dev)
 343 {
 344         i2o_driver_notify_device_remove_all(i2o_dev);
 345         i2o_remove_sysfs_links(i2o_dev);
 346         class_device_unregister(&i2o_dev->classdev);
 347         list_del(&i2o_dev->list);
 348         device_unregister(&i2o_dev->device);
 349 }
 350
 351 /**
 352  *      i2o_device_parse_lct - Parse a previously fetched LCT and create devices
 353  *      @c: I2O controller from which the LCT should be parsed.
 354  *
 355  *      The Logical Configuration Table tells us what we can talk to on the
 356  *      board. For every entry we create an I2O device, which is registered in
 357  *      the I2O core.
 358  *
 359  *      Returns 0 on success or negative error code on failure.
 360  */
 361 int i2o_device_parse_lct(struct i2o_controller *c)
 362 {
 363         struct i2o_device *dev, *tmp;
 364         i2o_lct *lct;
 365         int i;
 366         int max;
 367
 368         down(&c->lct_lock);
 369
 370         kfree(c->lct);
 371
 372         lct = c->dlct.virt;
 373
 374         c->lct = kmalloc(lct->table_size * 4, GFP_KERNEL);
 375         if (!c->lct) {
 376                 up(&c->lct_lock);
 377                 return -ENOMEM;
 378         }
 379
 380         if (lct->table_size * 4 > c->dlct.len) {
 381                 memcpy(c->lct, c->dlct.virt, c->dlct.len);
 382                 up(&c->lct_lock);
 383                 return -EAGAIN;
 384         }
 385
 386         memcpy(c->lct, c->dlct.virt, lct->table_size * 4);
 387
 388         lct = c->lct;
 389
 390         max = (lct->table_size - 3) / 9;
 391
 392         pr_debug("%s: LCT has %d entries (LCT size: %d)\n", c->name, max,
 393                  lct->table_size);
 394
 395         /* remove devices, which are not in the LCT anymore */
 396         list_for_each_entry_safe(dev, tmp, &c->devices, list) {
 397                 int found = 0;
 398
 399                 for (i = 0; i < max; i++) {
 400                         if (lct->lct_entry[i].tid == dev->lct_data.tid) {
 401                                 found = 1;
 402                                 break;
 403                         }
 404                 }
 405
 406                 if (!found)
 407                         i2o_device_remove(dev);
 408         }
 409
 410         /* add new devices, which are new in the LCT */
 411         for (i = 0; i < max; i++) {
 412                 int found = 0;
 413
 414                 list_for_each_entry_safe(dev, tmp, &c->devices, list) {
 415                         if (lct->lct_entry[i].tid == dev->lct_data.tid) {
 416                                 found = 1;
 417                                 break;
 418                         }
 419                 }
 420
 421                 if (!found)
 422                         i2o_device_add(c, &lct->lct_entry[i]);
 423         }
 424         up(&c->lct_lock);
 425
 426         return 0;
 427 }
 428
 429
 430 /*
 431  *      Run time support routines
 432  */
 433
 434 /*      Issue UTIL_PARAMS_GET or UTIL_PARAMS_SET
 435  *
 436  *      This function can be used for all UtilParamsGet/Set operations.
 437  *      The OperationList is given in oplist-buffer,
 438  *      and results are returned in reslist-buffer.
 439  *      Note that the minimum sized reslist is 8 bytes and contains
 440  *      ResultCount, ErrorInfoSize, BlockStatus and BlockSize.
 441  */
 442 int i2o_parm_issue(struct i2o_device *i2o_dev, int cmd, void *oplist,
 443                           int oplen, void *reslist, int reslen)
 444 {
 445         struct i2o_message __iomem *msg;
 446         u32 m;
 447         u32 *res32 = (u32 *) reslist;
 448         u32 *restmp = (u32 *) reslist;
 449         int len = 0;
 450         int i = 0;
 451         int rc;
 452         struct i2o_dma res;
 453         struct i2o_controller *c = i2o_dev->iop;
 454         struct device *dev = &c->pdev->dev;
 455
 456         res.virt = NULL;
 457
 458         if (i2o_dma_alloc(dev, &res, reslen, GFP_KERNEL))
 459                 return -ENOMEM;
 460
 461         m = i2o_msg_get_wait(c, &msg, I2O_TIMEOUT_MESSAGE_GET);
 462         if (m == I2O_QUEUE_EMPTY) {
 463                 i2o_dma_free(dev, &res);
 464                 return -ETIMEDOUT;
 465         }
 466
 467         i = 0;
 468         writel(cmd << 24 | HOST_TID << 12 | i2o_dev->lct_data.tid,
 469                &msg->u.head[1]);
 470         writel(0, &msg->body[i++]);
 471         writel(0x4C000000 | oplen, &msg->body[i++]);    /* OperationList */
 472         memcpy_toio(&msg->body[i], oplist, oplen);
 473         i += (oplen / 4 + (oplen % 4 ? 1 : 0));
 474         writel(0xD0000000 | res.len, &msg->body[i++]);  /* ResultList */
 475         writel(res.phys, &msg->body[i++]);
 476
 477         writel(I2O_MESSAGE_SIZE(i + sizeof(struct i2o_message) / 4) |
 478                SGL_OFFSET_5, &msg->u.head[0]);
 479
 480         rc = i2o_msg_post_wait_mem(c, m, 10, &res);
 481
 482         /* This only looks like a memory leak - don't "fix" it. */
 483         if (rc == -ETIMEDOUT)
 484                 return rc;
 485
 486         memcpy(reslist, res.virt, res.len);
 487         i2o_dma_free(dev, &res);
 488
 489         /* Query failed */
 490         if (rc)
 491                 return rc;
 492         /*
 493          * Calculate number of bytes of Result LIST
 494          * We need to loop through each Result BLOCK and grab the length
 495          */
 496         restmp = res32 + 1;
 497         len = 1;
 498         for (i = 0; i < (res32[0] & 0X0000FFFF); i++) {
 499                 if (restmp[0] & 0x00FF0000) {   /* BlockStatus != SUCCESS */
 500                         printk(KERN_WARNING
 501                                "%s - Error:\n  ErrorInfoSize = 0x%02x, "
 502                                "BlockStatus = 0x%02x, BlockSize = 0x%04x\n",
 503                                (cmd ==
 504                                 I2O_CMD_UTIL_PARAMS_SET) ? "PARAMS_SET" :
 505                                "PARAMS_GET", res32[1] >> 24,
 506                                (res32[1] >> 16) & 0xFF, res32[1] & 0xFFFF);
 507
 508                         /*
 509                          *      If this is the only request,than we return an error
 510                          */
 511                         if ((res32[0] & 0x0000FFFF) == 1) {
 512                                 return -((res32[1] >> 16) & 0xFF);      /* -BlockStatus */
 513                         }
 514                 }
 515                 len += restmp[0] & 0x0000FFFF;  /* Length of res BLOCK */
 516                 restmp += restmp[0] & 0x0000FFFF;       /* Skip to next BLOCK */
 517         }
 518         return (len << 2);      /* bytes used by result list */
 519 }
 520
 521 /*
 522  *       Query one field group value or a whole scalar group.
 523  */
 524 int i2o_parm_field_get(struct i2o_device *i2o_dev, int group, int field,
 525                        void *buf, int buflen)
 526 {
 527         u16 opblk[] = { 1, 0, I2O_PARAMS_FIELD_GET, group, 1, field };
 528         u8 *resblk;             /* 8 bytes for header */
 529         int size;
 530
 531         if (field == -1)        /* whole group */
 532                 opblk[4] = -1;
 533
 534         resblk = kmalloc(buflen + 8, GFP_KERNEL | GFP_ATOMIC);
 535         if (!resblk)
 536                 return -ENOMEM;
 537
 538         size = i2o_parm_issue(i2o_dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
 539                               sizeof(opblk), resblk, buflen + 8);
 540
 541         memcpy(buf, resblk + 8, buflen);        /* cut off header */
 542
 543         kfree(resblk);
 544
 545         if (size > buflen)
 546                 return buflen;
 547
 548         return size;
 549 }
 550
 551 /*
 552  *      if oper == I2O_PARAMS_TABLE_GET, get from all rows
 553  *              if fieldcount == -1 return all fields
 554  *                      ibuf and ibuflen are unused (use NULL, 0)
 555  *              else return specific fields
 556  *                      ibuf contains fieldindexes
 557  *
 558  *      if oper == I2O_PARAMS_LIST_GET, get from specific rows
 559  *              if fieldcount == -1 return all fields
 560  *                      ibuf contains rowcount, keyvalues
 561  *              else return specific fields
 562  *                      fieldcount is # of fieldindexes
 563  *                      ibuf contains fieldindexes, rowcount, keyvalues
 564  *
 565  *      You could also use directly function i2o_issue_params().
 566  */
 567 int i2o_parm_table_get(struct i2o_device *dev, int oper, int group,
 568                        int fieldcount, void *ibuf, int ibuflen, void *resblk,
 569                        int reslen)
 570 {
 571         u16 *opblk;
 572         int size;
 573
 574         size = 10 + ibuflen;
 575         if (size % 4)
 576                 size += 4 - size % 4;
 577
 578         opblk = kmalloc(size, GFP_KERNEL);
 579         if (opblk == NULL) {
 580                 printk(KERN_ERR "i2o: no memory for query buffer.\n");
 581                 return -ENOMEM;
 582         }
 583
 584         opblk[0] = 1;           /* operation count */
 585         opblk[1] = 0;           /* pad */
 586         opblk[2] = oper;
 587         opblk[3] = group;
 588         opblk[4] = fieldcount;
 589         memcpy(opblk + 5, ibuf, ibuflen);       /* other params */
 590
 591         size = i2o_parm_issue(dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
 592                               size, resblk, reslen);
 593
 594         kfree(opblk);
 595         if (size > reslen)
 596                 return reslen;
 597
 598         return size;
 599 }
 600
 601 /**
 602  *      i2o_device_init - Initialize I2O devices
 603  *
 604  *      Registers the I2O device class.
 605  *
 606  *      Returns 0 on success or negative error code on failure.
 607  */
 608 int i2o_device_init(void)
 609 {
 610         return class_register(&i2o_device_class);
 611 }
 612
 613 /**
 614  *      i2o_device_exit - I2O devices exit function
 615  *
 616  *      Unregisters the I2O device class.
 617  */
 618 void i2o_device_exit(void)
 619 {
 620         class_unregister(&i2o_device_class);
 621 }
 622
 623 EXPORT_SYMBOL(i2o_device_claim);
 624 EXPORT_SYMBOL(i2o_device_claim_release);
 625 EXPORT_SYMBOL(i2o_parm_field_get);
 626 EXPORT_SYMBOL(i2o_parm_table_get);
 627 EXPORT_SYMBOL(i2o_parm_issue);