2 * Functions to handle I2O devices
4 * Copyright (C) 2004 Markus Lidel <Markus.Lidel@shadowconnect.com>
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.
12 * Markus Lidel <Markus.Lidel@shadowconnect.com>
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>
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
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).
33 * Returs 0 on success or negative error code on failure.
35 static inline int i2o_device_issue_claim(struct i2o_device *dev, u32 cmd,
38 struct i2o_message __iomem *msg;
41 m = i2o_msg_get_wait(dev->iop, &msg, I2O_TIMEOUT_MESSAGE_GET);
42 if (m == I2O_QUEUE_EMPTY)
45 writel(FIVE_WORD_MSG_SIZE | SGL_OFFSET_0, &msg->u.head[0]);
46 writel(cmd << 24 | HOST_TID << 12 | dev->lct_data.tid, &msg->u.head[1]);
47 writel(type, &msg->body[0]);
49 return i2o_msg_post_wait(dev->iop, m, 60);
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
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.
61 int i2o_device_claim(struct i2o_device *dev)
67 rc = i2o_device_issue_claim(dev, I2O_CMD_UTIL_CLAIM, I2O_CLAIM_PRIMARY);
69 pr_debug("i2o: claim of device %d succeded\n",
72 pr_debug("i2o: claim of device %d failed %d\n",
73 dev->lct_data.tid, rc);
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
85 * Drop a claim by an OSM on a given I2O device.
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.
92 * Returns 0 on success or negative error code on failure.
94 int i2o_device_claim_release(struct i2o_device *dev)
102 * If the controller takes a nonblocking approach to
103 * releases we have to sleep/poll for a few times.
105 for (tries = 0; tries < 10; tries++) {
106 rc = i2o_device_issue_claim(dev, I2O_CMD_UTIL_RELEASE,
115 pr_debug("i2o: claim release of device %d succeded\n",
118 pr_debug("i2o: claim release of device %d failed %d\n",
119 dev->lct_data.tid, rc);
128 * i2o_device_release - release the memory for a I2O device
129 * @dev: I2O device which should be released
131 * Release the allocated memory. This function is called if refcount of
132 * device reaches 0 automatically.
134 static void i2o_device_release(struct device *dev)
136 struct i2o_device *i2o_dev = to_i2o_device(dev);
138 pr_debug("i2o: device %s released\n", dev->bus_id);
145 * i2o_device_class_show_class_id - Displays class id of I2O device
146 * @cd: class device of which the class id should be displayed
147 * @buf: buffer into which the class id should be printed
149 * Returns the number of bytes which are printed into the buffer.
151 static ssize_t i2o_device_show_class_id(struct device *dev,
152 struct device_attribute *attr,
155 struct i2o_device *i2o_dev = to_i2o_device(dev);
157 sprintf(buf, "0x%03x\n", i2o_dev->lct_data.class_id);
158 return strlen(buf) + 1;
162 * i2o_device_class_show_tid - Displays TID of I2O device
163 * @cd: class device of which the TID should be displayed
164 * @buf: buffer into which the class id should be printed
166 * Returns the number of bytes which are printed into the buffer.
168 static ssize_t i2o_device_show_tid(struct device *dev,
169 struct device_attribute *attr,
172 struct i2o_device *i2o_dev = to_i2o_device(dev);
174 sprintf(buf, "0x%03x\n", i2o_dev->lct_data.tid);
175 return strlen(buf) + 1;
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),
185 * i2o_device_alloc - Allocate a I2O device and initialize it
187 * Allocate the memory for a I2O device and initialize locks and lists
189 * Returns the allocated I2O device or a negative error code if the device
190 * could not be allocated.
192 static struct i2o_device *i2o_device_alloc(void)
194 struct i2o_device *dev;
196 dev = kmalloc(sizeof(*dev), GFP_KERNEL);
198 return ERR_PTR(-ENOMEM);
200 memset(dev, 0, sizeof(*dev));
202 INIT_LIST_HEAD(&dev->list);
203 init_MUTEX(&dev->lock);
205 dev->device.bus = &i2o_bus_type;
206 dev->device.release = &i2o_device_release;
212 * i2o_setup_sysfs_links - Adds attributes to the I2O device
213 * @cd: I2O class device which is added to the I2O device class
215 * This function get called when a I2O device is added to the class. It
216 * creates the attributes for each device and creates user/parent symlink
219 * Returns 0 on success or negative error code on failure.
221 static void i2o_setup_sysfs_links(struct i2o_device *i2o_dev)
223 struct i2o_controller *c = i2o_dev->iop;
224 struct i2o_device *tmp;
226 /* create user entries for this device */
227 tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.user_tid);
228 if (tmp && tmp != i2o_dev)
229 sysfs_create_link(&i2o_dev->device.kobj,
230 &tmp->device.kobj, "user");
232 /* create user entries refering to this device */
233 list_for_each_entry(tmp, &c->devices, list)
234 if (tmp->lct_data.user_tid == i2o_dev->lct_data.tid &&
236 sysfs_create_link(&tmp->device.kobj,
237 &i2o_dev->device.kobj, "user");
239 /* create parent entries for this device */
240 tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.parent_tid);
241 if (tmp && tmp != i2o_dev)
242 sysfs_create_link(&i2o_dev->device.kobj,
243 &tmp->device.kobj, "parent");
245 /* create parent entries refering to this device */
246 list_for_each_entry(tmp, &c->devices, list)
247 if (tmp->lct_data.parent_tid == i2o_dev->lct_data.tid &&
249 sysfs_create_link(&tmp->device.kobj,
250 &i2o_dev->device.kobj, "parent");
253 static void i2o_remove_sysfs_links(struct i2o_device *i2o_dev)
255 struct i2o_controller *c = i2o_dev->iop;
256 struct i2o_device *tmp;
258 sysfs_remove_link(&i2o_dev->device.kobj, "parent");
259 sysfs_remove_link(&i2o_dev->device.kobj, "user");
261 list_for_each_entry(tmp, &c->devices, list) {
262 if (tmp->lct_data.parent_tid == i2o_dev->lct_data.tid)
263 sysfs_remove_link(&tmp->device.kobj, "parent");
264 if (tmp->lct_data.user_tid == i2o_dev->lct_data.tid)
265 sysfs_remove_link(&tmp->device.kobj, "user");
272 * i2o_device_add - allocate a new I2O device and add it to the IOP
273 * @iop: I2O controller where the device is on
274 * @entry: LCT entry of the I2O device
276 * Allocate a new I2O device and initialize it with the LCT entry. The
277 * device is appended to the device list of the controller.
279 * Returns a pointer to the I2O device on success or negative error code
282 static struct i2o_device *i2o_device_add(struct i2o_controller *c,
283 i2o_lct_entry * entry)
285 struct i2o_device *dev;
287 dev = i2o_device_alloc();
289 printk(KERN_ERR "i2o: unable to allocate i2o device\n");
293 dev->lct_data = *entry;
296 snprintf(dev->device.bus_id, BUS_ID_SIZE, "%d:%03x", c->unit,
299 dev->device.parent = &c->device;
301 device_register(&dev->device);
303 list_add_tail(&dev->list, &c->devices);
305 i2o_setup_sysfs_links(dev);
307 i2o_driver_notify_device_add_all(dev);
309 pr_debug("i2o: device %s added\n", dev->device.bus_id);
315 * i2o_device_remove - remove an I2O device from the I2O core
316 * @dev: I2O device which should be released
318 * Is used on I2O controller removal or LCT modification, when the device
319 * is removed from the system. Note that the device could still hang
320 * around until the refcount reaches 0.
322 void i2o_device_remove(struct i2o_device *i2o_dev)
324 i2o_driver_notify_device_remove_all(i2o_dev);
325 i2o_remove_sysfs_links(i2o_dev);
326 list_del(&i2o_dev->list);
327 device_unregister(&i2o_dev->device);
331 * i2o_device_parse_lct - Parse a previously fetched LCT and create devices
332 * @c: I2O controller from which the LCT should be parsed.
334 * The Logical Configuration Table tells us what we can talk to on the
335 * board. For every entry we create an I2O device, which is registered in
338 * Returns 0 on success or negative error code on failure.
340 int i2o_device_parse_lct(struct i2o_controller *c)
342 struct i2o_device *dev, *tmp;
353 c->lct = kmalloc(lct->table_size * 4, GFP_KERNEL);
359 if (lct->table_size * 4 > c->dlct.len) {
360 memcpy(c->lct, c->dlct.virt, c->dlct.len);
365 memcpy(c->lct, c->dlct.virt, lct->table_size * 4);
369 max = (lct->table_size - 3) / 9;
371 pr_debug("%s: LCT has %d entries (LCT size: %d)\n", c->name, max,
374 /* remove devices, which are not in the LCT anymore */
375 list_for_each_entry_safe(dev, tmp, &c->devices, list) {
378 for (i = 0; i < max; i++) {
379 if (lct->lct_entry[i].tid == dev->lct_data.tid) {
386 i2o_device_remove(dev);
389 /* add new devices, which are new in the LCT */
390 for (i = 0; i < max; i++) {
393 list_for_each_entry_safe(dev, tmp, &c->devices, list) {
394 if (lct->lct_entry[i].tid == dev->lct_data.tid) {
401 i2o_device_add(c, &lct->lct_entry[i]);
410 * Run time support routines
413 /* Issue UTIL_PARAMS_GET or UTIL_PARAMS_SET
415 * This function can be used for all UtilParamsGet/Set operations.
416 * The OperationList is given in oplist-buffer,
417 * and results are returned in reslist-buffer.
418 * Note that the minimum sized reslist is 8 bytes and contains
419 * ResultCount, ErrorInfoSize, BlockStatus and BlockSize.
421 int i2o_parm_issue(struct i2o_device *i2o_dev, int cmd, void *oplist,
422 int oplen, void *reslist, int reslen)
424 struct i2o_message __iomem *msg;
426 u32 *res32 = (u32 *) reslist;
427 u32 *restmp = (u32 *) reslist;
432 struct i2o_controller *c = i2o_dev->iop;
433 struct device *dev = &c->pdev->dev;
437 if (i2o_dma_alloc(dev, &res, reslen, GFP_KERNEL))
440 m = i2o_msg_get_wait(c, &msg, I2O_TIMEOUT_MESSAGE_GET);
441 if (m == I2O_QUEUE_EMPTY) {
442 i2o_dma_free(dev, &res);
447 writel(cmd << 24 | HOST_TID << 12 | i2o_dev->lct_data.tid,
449 writel(0, &msg->body[i++]);
450 writel(0x4C000000 | oplen, &msg->body[i++]); /* OperationList */
451 memcpy_toio(&msg->body[i], oplist, oplen);
452 i += (oplen / 4 + (oplen % 4 ? 1 : 0));
453 writel(0xD0000000 | res.len, &msg->body[i++]); /* ResultList */
454 writel(res.phys, &msg->body[i++]);
456 writel(I2O_MESSAGE_SIZE(i + sizeof(struct i2o_message) / 4) |
457 SGL_OFFSET_5, &msg->u.head[0]);
459 rc = i2o_msg_post_wait_mem(c, m, 10, &res);
461 /* This only looks like a memory leak - don't "fix" it. */
462 if (rc == -ETIMEDOUT)
465 memcpy(reslist, res.virt, res.len);
466 i2o_dma_free(dev, &res);
472 * Calculate number of bytes of Result LIST
473 * We need to loop through each Result BLOCK and grab the length
477 for (i = 0; i < (res32[0] & 0X0000FFFF); i++) {
478 if (restmp[0] & 0x00FF0000) { /* BlockStatus != SUCCESS */
480 "%s - Error:\n ErrorInfoSize = 0x%02x, "
481 "BlockStatus = 0x%02x, BlockSize = 0x%04x\n",
483 I2O_CMD_UTIL_PARAMS_SET) ? "PARAMS_SET" :
484 "PARAMS_GET", res32[1] >> 24,
485 (res32[1] >> 16) & 0xFF, res32[1] & 0xFFFF);
488 * If this is the only request,than we return an error
490 if ((res32[0] & 0x0000FFFF) == 1) {
491 return -((res32[1] >> 16) & 0xFF); /* -BlockStatus */
494 len += restmp[0] & 0x0000FFFF; /* Length of res BLOCK */
495 restmp += restmp[0] & 0x0000FFFF; /* Skip to next BLOCK */
497 return (len << 2); /* bytes used by result list */
501 * Query one field group value or a whole scalar group.
503 int i2o_parm_field_get(struct i2o_device *i2o_dev, int group, int field,
504 void *buf, int buflen)
506 u16 opblk[] = { 1, 0, I2O_PARAMS_FIELD_GET, group, 1, field };
507 u8 *resblk; /* 8 bytes for header */
510 if (field == -1) /* whole group */
513 resblk = kmalloc(buflen + 8, GFP_KERNEL | GFP_ATOMIC);
517 size = i2o_parm_issue(i2o_dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
518 sizeof(opblk), resblk, buflen + 8);
520 memcpy(buf, resblk + 8, buflen); /* cut off header */
531 * if oper == I2O_PARAMS_TABLE_GET, get from all rows
532 * if fieldcount == -1 return all fields
533 * ibuf and ibuflen are unused (use NULL, 0)
534 * else return specific fields
535 * ibuf contains fieldindexes
537 * if oper == I2O_PARAMS_LIST_GET, get from specific rows
538 * if fieldcount == -1 return all fields
539 * ibuf contains rowcount, keyvalues
540 * else return specific fields
541 * fieldcount is # of fieldindexes
542 * ibuf contains fieldindexes, rowcount, keyvalues
544 * You could also use directly function i2o_issue_params().
546 int i2o_parm_table_get(struct i2o_device *dev, int oper, int group,
547 int fieldcount, void *ibuf, int ibuflen, void *resblk,
555 size += 4 - size % 4;
557 opblk = kmalloc(size, GFP_KERNEL);
559 printk(KERN_ERR "i2o: no memory for query buffer.\n");
563 opblk[0] = 1; /* operation count */
564 opblk[1] = 0; /* pad */
567 opblk[4] = fieldcount;
568 memcpy(opblk + 5, ibuf, ibuflen); /* other params */
570 size = i2o_parm_issue(dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
571 size, resblk, reslen);
580 EXPORT_SYMBOL(i2o_device_claim);
581 EXPORT_SYMBOL(i2o_device_claim_release);
582 EXPORT_SYMBOL(i2o_parm_field_get);
583 EXPORT_SYMBOL(i2o_parm_table_get);
584 EXPORT_SYMBOL(i2o_parm_issue);