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