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 *msg;
40 msg = i2o_msg_get_wait(dev->iop, I2O_TIMEOUT_MESSAGE_GET);
44 msg->u.head[0] = cpu_to_le32(FIVE_WORD_MSG_SIZE | SGL_OFFSET_0);
46 cpu_to_le32(cmd << 24 | HOST_TID << 12 | dev->lct_data.tid);
47 msg->body[0] = cpu_to_le32(type);
49 return i2o_msg_post_wait(dev->iop, msg, 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_show_class_id - Displays class id of I2O device
146 * @dev: device of which the class id should be displayed
147 * @attr: pointer to device attribute
148 * @buf: buffer into which the class id should be printed
150 * Returns the number of bytes which are printed into the buffer.
152 static ssize_t i2o_device_show_class_id(struct device *dev,
153 struct device_attribute *attr,
156 struct i2o_device *i2o_dev = to_i2o_device(dev);
158 sprintf(buf, "0x%03x\n", i2o_dev->lct_data.class_id);
159 return strlen(buf) + 1;
163 * i2o_device_show_tid - Displays TID of I2O device
164 * @dev: device of which the TID should be displayed
165 * @attr: pointer to device attribute
166 * @buf: buffer into which the TID should be printed
168 * Returns the number of bytes which are printed into the buffer.
170 static ssize_t i2o_device_show_tid(struct device *dev,
171 struct device_attribute *attr, char *buf)
173 struct i2o_device *i2o_dev = to_i2o_device(dev);
175 sprintf(buf, "0x%03x\n", i2o_dev->lct_data.tid);
176 return strlen(buf) + 1;
179 struct device_attribute i2o_device_attrs[] = {
180 __ATTR(class_id, S_IRUGO, i2o_device_show_class_id, NULL),
181 __ATTR(tid, S_IRUGO, i2o_device_show_tid, NULL),
186 * i2o_device_alloc - Allocate a I2O device and initialize it
188 * Allocate the memory for a I2O device and initialize locks and lists
190 * Returns the allocated I2O device or a negative error code if the device
191 * could not be allocated.
193 static struct i2o_device *i2o_device_alloc(void)
195 struct i2o_device *dev;
197 dev = kmalloc(sizeof(*dev), GFP_KERNEL);
199 return ERR_PTR(-ENOMEM);
201 memset(dev, 0, sizeof(*dev));
203 INIT_LIST_HEAD(&dev->list);
204 init_MUTEX(&dev->lock);
206 dev->device.bus = &i2o_bus_type;
207 dev->device.release = &i2o_device_release;
213 * i2o_device_add - allocate a new I2O device and add it to the IOP
214 * @iop: I2O controller where the device is on
215 * @entry: LCT entry of the I2O device
217 * Allocate a new I2O device and initialize it with the LCT entry. The
218 * device is appended to the device list of the controller.
220 * Returns a pointer to the I2O device on success or negative error code
223 static struct i2o_device *i2o_device_add(struct i2o_controller *c,
224 i2o_lct_entry * entry)
226 struct i2o_device *i2o_dev, *tmp;
228 i2o_dev = i2o_device_alloc();
229 if (IS_ERR(i2o_dev)) {
230 printk(KERN_ERR "i2o: unable to allocate i2o device\n");
234 i2o_dev->lct_data = *entry;
236 snprintf(i2o_dev->device.bus_id, BUS_ID_SIZE, "%d:%03x", c->unit,
237 i2o_dev->lct_data.tid);
240 i2o_dev->device.parent = &c->device;
242 device_register(&i2o_dev->device);
244 list_add_tail(&i2o_dev->list, &c->devices);
246 /* create user entries for this device */
247 tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.user_tid);
248 if (tmp && (tmp != i2o_dev))
249 sysfs_create_link(&i2o_dev->device.kobj, &tmp->device.kobj,
252 /* create user entries refering to this device */
253 list_for_each_entry(tmp, &c->devices, list)
254 if ((tmp->lct_data.user_tid == i2o_dev->lct_data.tid)
256 sysfs_create_link(&tmp->device.kobj,
257 &i2o_dev->device.kobj, "user");
259 /* create parent entries for this device */
260 tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.parent_tid);
261 if (tmp && (tmp != i2o_dev))
262 sysfs_create_link(&i2o_dev->device.kobj, &tmp->device.kobj,
265 /* create parent entries refering to this device */
266 list_for_each_entry(tmp, &c->devices, list)
267 if ((tmp->lct_data.parent_tid == i2o_dev->lct_data.tid)
269 sysfs_create_link(&tmp->device.kobj,
270 &i2o_dev->device.kobj, "parent");
272 i2o_driver_notify_device_add_all(i2o_dev);
274 pr_debug("i2o: device %s added\n", i2o_dev->device.bus_id);
280 * i2o_device_remove - remove an I2O device from the I2O core
281 * @dev: I2O device which should be released
283 * Is used on I2O controller removal or LCT modification, when the device
284 * is removed from the system. Note that the device could still hang
285 * around until the refcount reaches 0.
287 void i2o_device_remove(struct i2o_device *i2o_dev)
289 struct i2o_device *tmp;
290 struct i2o_controller *c = i2o_dev->iop;
292 i2o_driver_notify_device_remove_all(i2o_dev);
294 sysfs_remove_link(&i2o_dev->device.kobj, "parent");
295 sysfs_remove_link(&i2o_dev->device.kobj, "user");
297 list_for_each_entry(tmp, &c->devices, list) {
298 if (tmp->lct_data.parent_tid == i2o_dev->lct_data.tid)
299 sysfs_remove_link(&tmp->device.kobj, "parent");
300 if (tmp->lct_data.user_tid == i2o_dev->lct_data.tid)
301 sysfs_remove_link(&tmp->device.kobj, "user");
303 list_del(&i2o_dev->list);
305 device_unregister(&i2o_dev->device);
309 * i2o_device_parse_lct - Parse a previously fetched LCT and create devices
310 * @c: I2O controller from which the LCT should be parsed.
312 * The Logical Configuration Table tells us what we can talk to on the
313 * board. For every entry we create an I2O device, which is registered in
316 * Returns 0 on success or negative error code on failure.
318 int i2o_device_parse_lct(struct i2o_controller *c)
320 struct i2o_device *dev, *tmp;
322 u32 *dlct = c->dlct.virt;
331 buf = le32_to_cpu(*dlct++);
332 table_size = buf & 0xffff;
334 lct = c->lct = kmalloc(table_size * 4, GFP_KERNEL);
340 lct->lct_ver = buf >> 28;
341 lct->boot_tid = buf >> 16 & 0xfff;
342 lct->table_size = table_size;
343 lct->change_ind = le32_to_cpu(*dlct++);
344 lct->iop_flags = le32_to_cpu(*dlct++);
348 pr_debug("%s: LCT has %d entries (LCT size: %d)\n", c->name, max,
351 while (table_size > 0) {
352 i2o_lct_entry *entry = &lct->lct_entry[max];
355 buf = le32_to_cpu(*dlct++);
356 entry->entry_size = buf & 0xffff;
357 entry->tid = buf >> 16 & 0xfff;
359 entry->change_ind = le32_to_cpu(*dlct++);
360 entry->device_flags = le32_to_cpu(*dlct++);
362 buf = le32_to_cpu(*dlct++);
363 entry->class_id = buf & 0xfff;
364 entry->version = buf >> 12 & 0xf;
365 entry->vendor_id = buf >> 16;
367 entry->sub_class = le32_to_cpu(*dlct++);
369 buf = le32_to_cpu(*dlct++);
370 entry->user_tid = buf & 0xfff;
371 entry->parent_tid = buf >> 12 & 0xfff;
372 entry->bios_info = buf >> 24;
374 memcpy(&entry->identity_tag, dlct, 8);
377 entry->event_capabilities = le32_to_cpu(*dlct++);
379 /* add new devices, which are new in the LCT */
380 list_for_each_entry_safe(dev, tmp, &c->devices, list) {
381 if (entry->tid == dev->lct_data.tid) {
388 i2o_device_add(c, entry);
394 /* remove devices, which are not in the LCT anymore */
395 list_for_each_entry_safe(dev, tmp, &c->devices, list) {
398 for (i = 0; i < max; i++) {
399 if (lct->lct_entry[i].tid == dev->lct_data.tid) {
406 i2o_device_remove(dev);
416 * Run time support routines
419 /* Issue UTIL_PARAMS_GET or UTIL_PARAMS_SET
421 * This function can be used for all UtilParamsGet/Set operations.
422 * The OperationList is given in oplist-buffer,
423 * and results are returned in reslist-buffer.
424 * Note that the minimum sized reslist is 8 bytes and contains
425 * ResultCount, ErrorInfoSize, BlockStatus and BlockSize.
427 int i2o_parm_issue(struct i2o_device *i2o_dev, int cmd, void *oplist,
428 int oplen, void *reslist, int reslen)
430 struct i2o_message *msg;
434 struct i2o_controller *c = i2o_dev->iop;
435 struct device *dev = &c->pdev->dev;
439 if (i2o_dma_alloc(dev, &res, reslen, GFP_KERNEL))
442 msg = i2o_msg_get_wait(c, I2O_TIMEOUT_MESSAGE_GET);
444 i2o_dma_free(dev, &res);
450 cpu_to_le32(cmd << 24 | HOST_TID << 12 | i2o_dev->lct_data.tid);
451 msg->body[i++] = cpu_to_le32(0x00000000);
452 msg->body[i++] = cpu_to_le32(0x4C000000 | oplen); /* OperationList */
453 memcpy(&msg->body[i], oplist, oplen);
454 i += (oplen / 4 + (oplen % 4 ? 1 : 0));
455 msg->body[i++] = cpu_to_le32(0xD0000000 | res.len); /* ResultList */
456 msg->body[i++] = cpu_to_le32(res.phys);
459 cpu_to_le32(I2O_MESSAGE_SIZE(i + sizeof(struct i2o_message) / 4) |
462 rc = i2o_msg_post_wait_mem(c, msg, 10, &res);
464 /* This only looks like a memory leak - don't "fix" it. */
465 if (rc == -ETIMEDOUT)
468 memcpy(reslist, res.virt, res.len);
469 i2o_dma_free(dev, &res);
475 * Query one field group value or a whole scalar group.
477 int i2o_parm_field_get(struct i2o_device *i2o_dev, int group, int field,
478 void *buf, int buflen)
480 u32 opblk[] = { cpu_to_le32(0x00000001),
481 cpu_to_le32((u16) group << 16 | I2O_PARAMS_FIELD_GET),
482 cpu_to_le32((s16) field << 16 | 0x00000001)
484 u8 *resblk; /* 8 bytes for header */
487 resblk = kmalloc(buflen + 8, GFP_KERNEL | GFP_ATOMIC);
491 rc = i2o_parm_issue(i2o_dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
492 sizeof(opblk), resblk, buflen + 8);
494 memcpy(buf, resblk + 8, buflen); /* cut off header */
502 * if oper == I2O_PARAMS_TABLE_GET, get from all rows
503 * if fieldcount == -1 return all fields
504 * ibuf and ibuflen are unused (use NULL, 0)
505 * else return specific fields
506 * ibuf contains fieldindexes
508 * if oper == I2O_PARAMS_LIST_GET, get from specific rows
509 * if fieldcount == -1 return all fields
510 * ibuf contains rowcount, keyvalues
511 * else return specific fields
512 * fieldcount is # of fieldindexes
513 * ibuf contains fieldindexes, rowcount, keyvalues
515 * You could also use directly function i2o_issue_params().
517 int i2o_parm_table_get(struct i2o_device *dev, int oper, int group,
518 int fieldcount, void *ibuf, int ibuflen, void *resblk,
526 size += 4 - size % 4;
528 opblk = kmalloc(size, GFP_KERNEL);
530 printk(KERN_ERR "i2o: no memory for query buffer.\n");
534 opblk[0] = 1; /* operation count */
535 opblk[1] = 0; /* pad */
538 opblk[4] = fieldcount;
539 memcpy(opblk + 5, ibuf, ibuflen); /* other params */
541 size = i2o_parm_issue(dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
542 size, resblk, reslen);
551 EXPORT_SYMBOL(i2o_device_claim);
552 EXPORT_SYMBOL(i2o_device_claim_release);
553 EXPORT_SYMBOL(i2o_parm_field_get);
554 EXPORT_SYMBOL(i2o_parm_table_get);
555 EXPORT_SYMBOL(i2o_parm_issue);