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 succeeds,
  58  *      the owner is the primary. 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         mutex_lock(&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         mutex_unlock(&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         mutex_lock(&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         mutex_unlock(&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         mutex_init(&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  *      @c: I2O controller that 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 zero on success, or a -ve errno.
 218  */
 219 static int i2o_device_add(struct i2o_controller *c, i2o_lct_entry *entry)
 220 {
 221         struct i2o_device *i2o_dev, *tmp;
 222         int rc;
 223
 224         i2o_dev = i2o_device_alloc();
 225         if (IS_ERR(i2o_dev)) {
 226                 printk(KERN_ERR "i2o: unable to allocate i2o device\n");
 227                 return PTR_ERR(i2o_dev);
 228         }
 229
 230         i2o_dev->lct_data = *entry;
 231
 232         snprintf(i2o_dev->device.bus_id, BUS_ID_SIZE, "%d:%03x", c->unit,
 233                  i2o_dev->lct_data.tid);
 234
 235         i2o_dev->iop = c;
 236         i2o_dev->device.parent = &c->device;
 237
 238         rc = device_register(&i2o_dev->device);
 239         if (rc)
 240                 goto err;
 241
 242         list_add_tail(&i2o_dev->list, &c->devices);
 243
 244         /* create user entries for this device */
 245         tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.user_tid);
 246         if (tmp && (tmp != i2o_dev)) {
 247                 rc = sysfs_create_link(&i2o_dev->device.kobj,
 248                                        &tmp->device.kobj, "user");
 249                 if (rc)
 250                         goto unreg_dev;
 251         }
 252
 253         /* create user entries refering to this device */
 254         list_for_each_entry(tmp, &c->devices, list)
 255             if ((tmp->lct_data.user_tid == i2o_dev->lct_data.tid)
 256                 && (tmp != i2o_dev)) {
 257                 rc = sysfs_create_link(&tmp->device.kobj,
 258                                        &i2o_dev->device.kobj, "user");
 259                 if (rc)
 260                         goto rmlink1;
 261         }
 262
 263         /* create parent entries for this device */
 264         tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.parent_tid);
 265         if (tmp && (tmp != i2o_dev)) {
 266                 rc = sysfs_create_link(&i2o_dev->device.kobj,
 267                                        &tmp->device.kobj, "parent");
 268                 if (rc)
 269                         goto rmlink1;
 270         }
 271
 272         /* create parent entries refering to this device */
 273         list_for_each_entry(tmp, &c->devices, list)
 274             if ((tmp->lct_data.parent_tid == i2o_dev->lct_data.tid)
 275                 && (tmp != i2o_dev)) {
 276                 rc = sysfs_create_link(&tmp->device.kobj,
 277                                        &i2o_dev->device.kobj, "parent");
 278                 if (rc)
 279                         goto rmlink2;
 280         }
 281
 282         i2o_driver_notify_device_add_all(i2o_dev);
 283
 284         pr_debug("i2o: device %s added\n", i2o_dev->device.bus_id);
 285
 286         return 0;
 287
 288 rmlink2:
 289         /* If link creating failed halfway, we loop whole list to cleanup.
 290          * And we don't care wrong removing of link, because sysfs_remove_link
 291          * will take care of it.
 292          */
 293         list_for_each_entry(tmp, &c->devices, list) {
 294                 if (tmp->lct_data.parent_tid == i2o_dev->lct_data.tid)
 295                         sysfs_remove_link(&tmp->device.kobj, "parent");
 296         }
 297         sysfs_remove_link(&i2o_dev->device.kobj, "parent");
 298 rmlink1:
 299         list_for_each_entry(tmp, &c->devices, list)
 300                 if (tmp->lct_data.user_tid == i2o_dev->lct_data.tid)
 301                         sysfs_remove_link(&tmp->device.kobj, "user");
 302         sysfs_remove_link(&i2o_dev->device.kobj, "user");
 303 unreg_dev:
 304         list_del(&i2o_dev->list);
 305         device_unregister(&i2o_dev->device);
 306 err:
 307         kfree(i2o_dev);
 308         return rc;
 309 }
 310
 311 /**
 312  *      i2o_device_remove - remove an I2O device from the I2O core
 313  *      @i2o_dev: I2O device which should be released
 314  *
 315  *      Is used on I2O controller removal or LCT modification, when the device
 316  *      is removed from the system. Note that the device could still hang
 317  *      around until the refcount reaches 0.
 318  */
 319 void i2o_device_remove(struct i2o_device *i2o_dev)
 320 {
 321         struct i2o_device *tmp;
 322         struct i2o_controller *c = i2o_dev->iop;
 323
 324         i2o_driver_notify_device_remove_all(i2o_dev);
 325
 326         sysfs_remove_link(&i2o_dev->device.kobj, "parent");
 327         sysfs_remove_link(&i2o_dev->device.kobj, "user");
 328
 329         list_for_each_entry(tmp, &c->devices, list) {
 330                 if (tmp->lct_data.parent_tid == i2o_dev->lct_data.tid)
 331                         sysfs_remove_link(&tmp->device.kobj, "parent");
 332                 if (tmp->lct_data.user_tid == i2o_dev->lct_data.tid)
 333                         sysfs_remove_link(&tmp->device.kobj, "user");
 334         }
 335         list_del(&i2o_dev->list);
 336
 337         device_unregister(&i2o_dev->device);
 338 }
 339
 340 /**
 341  *      i2o_device_parse_lct - Parse a previously fetched LCT and create devices
 342  *      @c: I2O controller from which the LCT should be parsed.
 343  *
 344  *      The Logical Configuration Table tells us what we can talk to on the
 345  *      board. For every entry we create an I2O device, which is registered in
 346  *      the I2O core.
 347  *
 348  *      Returns 0 on success or negative error code on failure.
 349  */
 350 int i2o_device_parse_lct(struct i2o_controller *c)
 351 {
 352         struct i2o_device *dev, *tmp;
 353         i2o_lct *lct;
 354         u32 *dlct = c->dlct.virt;
 355         int max = 0, i = 0;
 356         u16 table_size;
 357         u32 buf;
 358
 359         mutex_lock(&c->lct_lock);
 360
 361         kfree(c->lct);
 362
 363         buf = le32_to_cpu(*dlct++);
 364         table_size = buf & 0xffff;
 365
 366         lct = c->lct = kmalloc(table_size * 4, GFP_KERNEL);
 367         if (!lct) {
 368                 mutex_unlock(&c->lct_lock);
 369                 return -ENOMEM;
 370         }
 371
 372         lct->lct_ver = buf >> 28;
 373         lct->boot_tid = buf >> 16 & 0xfff;
 374         lct->table_size = table_size;
 375         lct->change_ind = le32_to_cpu(*dlct++);
 376         lct->iop_flags = le32_to_cpu(*dlct++);
 377
 378         table_size -= 3;
 379
 380         pr_debug("%s: LCT has %d entries (LCT size: %d)\n", c->name, max,
 381                  lct->table_size);
 382
 383         while (table_size > 0) {
 384                 i2o_lct_entry *entry = &lct->lct_entry[max];
 385                 int found = 0;
 386
 387                 buf = le32_to_cpu(*dlct++);
 388                 entry->entry_size = buf & 0xffff;
 389                 entry->tid = buf >> 16 & 0xfff;
 390
 391                 entry->change_ind = le32_to_cpu(*dlct++);
 392                 entry->device_flags = le32_to_cpu(*dlct++);
 393
 394                 buf = le32_to_cpu(*dlct++);
 395                 entry->class_id = buf & 0xfff;
 396                 entry->version = buf >> 12 & 0xf;
 397                 entry->vendor_id = buf >> 16;
 398
 399                 entry->sub_class = le32_to_cpu(*dlct++);
 400
 401                 buf = le32_to_cpu(*dlct++);
 402                 entry->user_tid = buf & 0xfff;
 403                 entry->parent_tid = buf >> 12 & 0xfff;
 404                 entry->bios_info = buf >> 24;
 405
 406                 memcpy(&entry->identity_tag, dlct, 8);
 407                 dlct += 2;
 408
 409                 entry->event_capabilities = le32_to_cpu(*dlct++);
 410
 411                 /* add new devices, which are new in the LCT */
 412                 list_for_each_entry_safe(dev, tmp, &c->devices, list) {
 413                         if (entry->tid == dev->lct_data.tid) {
 414                                 found = 1;
 415                                 break;
 416                         }
 417                 }
 418
 419                 if (!found)
 420                         i2o_device_add(c, entry);
 421
 422                 table_size -= 9;
 423                 max++;
 424         }
 425
 426         /* remove devices, which are not in the LCT anymore */
 427         list_for_each_entry_safe(dev, tmp, &c->devices, list) {
 428                 int found = 0;
 429
 430                 for (i = 0; i < max; i++) {
 431                         if (lct->lct_entry[i].tid == dev->lct_data.tid) {
 432                                 found = 1;
 433                                 break;
 434                         }
 435                 }
 436
 437                 if (!found)
 438                         i2o_device_remove(dev);
 439         }
 440
 441         mutex_unlock(&c->lct_lock);
 442
 443         return 0;
 444 }
 445
 446 /*
 447  *      Run time support routines
 448  */
 449
 450 /*      Issue UTIL_PARAMS_GET or UTIL_PARAMS_SET
 451  *
 452  *      This function can be used for all UtilParamsGet/Set operations.
 453  *      The OperationList is given in oplist-buffer,
 454  *      and results are returned in reslist-buffer.
 455  *      Note that the minimum sized reslist is 8 bytes and contains
 456  *      ResultCount, ErrorInfoSize, BlockStatus and BlockSize.
 457  */
 458 int i2o_parm_issue(struct i2o_device *i2o_dev, int cmd, void *oplist,
 459                    int oplen, void *reslist, int reslen)
 460 {
 461         struct i2o_message *msg;
 462         int i = 0;
 463         int rc;
 464         struct i2o_dma res;
 465         struct i2o_controller *c = i2o_dev->iop;
 466         struct device *dev = &c->pdev->dev;
 467
 468         res.virt = NULL;
 469
 470         if (i2o_dma_alloc(dev, &res, reslen, GFP_KERNEL))
 471                 return -ENOMEM;
 472
 473         msg = i2o_msg_get_wait(c, I2O_TIMEOUT_MESSAGE_GET);
 474         if (IS_ERR(msg)) {
 475                 i2o_dma_free(dev, &res);
 476                 return PTR_ERR(msg);
 477         }
 478
 479         i = 0;
 480         msg->u.head[1] =
 481             cpu_to_le32(cmd << 24 | HOST_TID << 12 | i2o_dev->lct_data.tid);
 482         msg->body[i++] = cpu_to_le32(0x00000000);
 483         msg->body[i++] = cpu_to_le32(0x4C000000 | oplen);       /* OperationList */
 484         memcpy(&msg->body[i], oplist, oplen);
 485         i += (oplen / 4 + (oplen % 4 ? 1 : 0));
 486         msg->body[i++] = cpu_to_le32(0xD0000000 | res.len);     /* ResultList */
 487         msg->body[i++] = cpu_to_le32(res.phys);
 488
 489         msg->u.head[0] =
 490             cpu_to_le32(I2O_MESSAGE_SIZE(i + sizeof(struct i2o_message) / 4) |
 491                         SGL_OFFSET_5);
 492
 493         rc = i2o_msg_post_wait_mem(c, msg, 10, &res);
 494
 495         /* This only looks like a memory leak - don't "fix" it. */
 496         if (rc == -ETIMEDOUT)
 497                 return rc;
 498
 499         memcpy(reslist, res.virt, res.len);
 500         i2o_dma_free(dev, &res);
 501
 502         return rc;
 503 }
 504
 505 /*
 506  *       Query one field group value or a whole scalar group.
 507  */
 508 int i2o_parm_field_get(struct i2o_device *i2o_dev, int group, int field,
 509                        void *buf, int buflen)
 510 {
 511         u32 opblk[] = { cpu_to_le32(0x00000001),
 512                 cpu_to_le32((u16) group << 16 | I2O_PARAMS_FIELD_GET),
 513                 cpu_to_le32((s16) field << 16 | 0x00000001)
 514         };
 515         u8 *resblk;             /* 8 bytes for header */
 516         int rc;
 517
 518         resblk = kmalloc(buflen + 8, GFP_KERNEL);
 519         if (!resblk)
 520                 return -ENOMEM;
 521
 522         rc = i2o_parm_issue(i2o_dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
 523                             sizeof(opblk), resblk, buflen + 8);
 524
 525         memcpy(buf, resblk + 8, buflen);        /* cut off header */
 526
 527         kfree(resblk);
 528
 529         return rc;
 530 }
 531
 532 /*
 533  *      if oper == I2O_PARAMS_TABLE_GET, get from all rows
 534  *              if fieldcount == -1 return all fields
 535  *                      ibuf and ibuflen are unused (use NULL, 0)
 536  *              else return specific fields
 537  *                      ibuf contains fieldindexes
 538  *
 539  *      if oper == I2O_PARAMS_LIST_GET, get from specific rows
 540  *              if fieldcount == -1 return all fields
 541  *                      ibuf contains rowcount, keyvalues
 542  *              else return specific fields
 543  *                      fieldcount is # of fieldindexes
 544  *                      ibuf contains fieldindexes, rowcount, keyvalues
 545  *
 546  *      You could also use directly function i2o_issue_params().
 547  */
 548 int i2o_parm_table_get(struct i2o_device *dev, int oper, int group,
 549                        int fieldcount, void *ibuf, int ibuflen, void *resblk,
 550                        int reslen)
 551 {
 552         u16 *opblk;
 553         int size;
 554
 555         size = 10 + ibuflen;
 556         if (size % 4)
 557                 size += 4 - size % 4;
 558
 559         opblk = kmalloc(size, GFP_KERNEL);
 560         if (opblk == NULL) {
 561                 printk(KERN_ERR "i2o: no memory for query buffer.\n");
 562                 return -ENOMEM;
 563         }
 564
 565         opblk[0] = 1;           /* operation count */
 566         opblk[1] = 0;           /* pad */
 567         opblk[2] = oper;
 568         opblk[3] = group;
 569         opblk[4] = fieldcount;
 570         memcpy(opblk + 5, ibuf, ibuflen);       /* other params */
 571
 572         size = i2o_parm_issue(dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
 573                               size, resblk, reslen);
 574
 575         kfree(opblk);
 576         if (size > reslen)
 577                 return reslen;
 578
 579         return size;
 580 }
 581
 582 EXPORT_SYMBOL(i2o_device_claim);
 583 EXPORT_SYMBOL(i2o_device_claim_release);
 584 EXPORT_SYMBOL(i2o_parm_field_get);
 585 EXPORT_SYMBOL(i2o_parm_table_get);
 586 EXPORT_SYMBOL(i2o_parm_issue);