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