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 /* I2O device attributes */
180 struct device_attribute i2o_device_attrs[] = {
181 __ATTR(class_id, S_IRUGO, i2o_device_show_class_id, NULL),
182 __ATTR(tid, S_IRUGO, i2o_device_show_tid, NULL),
187 * i2o_device_alloc - Allocate a I2O device and initialize it
189 * Allocate the memory for a I2O device and initialize locks and lists
191 * Returns the allocated I2O device or a negative error code if the device
192 * could not be allocated.
194 static struct i2o_device *i2o_device_alloc(void)
196 struct i2o_device *dev;
198 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
200 return ERR_PTR(-ENOMEM);
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_device_add - allocate a new I2O device and add it to the IOP
213 * @iop: I2O controller where the device is on
214 * @entry: LCT entry of the I2O device
216 * Allocate a new I2O device and initialize it with the LCT entry. The
217 * device is appended to the device list of the controller.
219 * Returns a pointer to the I2O device on success or negative error code
222 static struct i2o_device *i2o_device_add(struct i2o_controller *c,
223 i2o_lct_entry * entry)
225 struct i2o_device *i2o_dev, *tmp;
227 i2o_dev = i2o_device_alloc();
228 if (IS_ERR(i2o_dev)) {
229 printk(KERN_ERR "i2o: unable to allocate i2o device\n");
233 i2o_dev->lct_data = *entry;
235 snprintf(i2o_dev->device.bus_id, BUS_ID_SIZE, "%d:%03x", c->unit,
236 i2o_dev->lct_data.tid);
239 i2o_dev->device.parent = &c->device;
241 device_register(&i2o_dev->device);
243 list_add_tail(&i2o_dev->list, &c->devices);
245 /* create user entries for this device */
246 tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.user_tid);
247 if (tmp && (tmp != i2o_dev))
248 sysfs_create_link(&i2o_dev->device.kobj, &tmp->device.kobj,
251 /* create user entries refering to this device */
252 list_for_each_entry(tmp, &c->devices, list)
253 if ((tmp->lct_data.user_tid == i2o_dev->lct_data.tid)
255 sysfs_create_link(&tmp->device.kobj,
256 &i2o_dev->device.kobj, "user");
258 /* create parent entries for this device */
259 tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.parent_tid);
260 if (tmp && (tmp != i2o_dev))
261 sysfs_create_link(&i2o_dev->device.kobj, &tmp->device.kobj,
264 /* create parent entries refering to this device */
265 list_for_each_entry(tmp, &c->devices, list)
266 if ((tmp->lct_data.parent_tid == i2o_dev->lct_data.tid)
268 sysfs_create_link(&tmp->device.kobj,
269 &i2o_dev->device.kobj, "parent");
271 i2o_driver_notify_device_add_all(i2o_dev);
273 pr_debug("i2o: device %s added\n", i2o_dev->device.bus_id);
279 * i2o_device_remove - remove an I2O device from the I2O core
280 * @dev: I2O device which should be released
282 * Is used on I2O controller removal or LCT modification, when the device
283 * is removed from the system. Note that the device could still hang
284 * around until the refcount reaches 0.
286 void i2o_device_remove(struct i2o_device *i2o_dev)
288 struct i2o_device *tmp;
289 struct i2o_controller *c = i2o_dev->iop;
291 i2o_driver_notify_device_remove_all(i2o_dev);
293 sysfs_remove_link(&i2o_dev->device.kobj, "parent");
294 sysfs_remove_link(&i2o_dev->device.kobj, "user");
296 list_for_each_entry(tmp, &c->devices, list) {
297 if (tmp->lct_data.parent_tid == i2o_dev->lct_data.tid)
298 sysfs_remove_link(&tmp->device.kobj, "parent");
299 if (tmp->lct_data.user_tid == i2o_dev->lct_data.tid)
300 sysfs_remove_link(&tmp->device.kobj, "user");
302 list_del(&i2o_dev->list);
304 device_unregister(&i2o_dev->device);
308 * i2o_device_parse_lct - Parse a previously fetched LCT and create devices
309 * @c: I2O controller from which the LCT should be parsed.
311 * The Logical Configuration Table tells us what we can talk to on the
312 * board. For every entry we create an I2O device, which is registered in
315 * Returns 0 on success or negative error code on failure.
317 int i2o_device_parse_lct(struct i2o_controller *c)
319 struct i2o_device *dev, *tmp;
321 u32 *dlct = c->dlct.virt;
330 buf = le32_to_cpu(*dlct++);
331 table_size = buf & 0xffff;
333 lct = c->lct = kmalloc(table_size * 4, GFP_KERNEL);
339 lct->lct_ver = buf >> 28;
340 lct->boot_tid = buf >> 16 & 0xfff;
341 lct->table_size = table_size;
342 lct->change_ind = le32_to_cpu(*dlct++);
343 lct->iop_flags = le32_to_cpu(*dlct++);
347 pr_debug("%s: LCT has %d entries (LCT size: %d)\n", c->name, max,
350 while (table_size > 0) {
351 i2o_lct_entry *entry = &lct->lct_entry[max];
354 buf = le32_to_cpu(*dlct++);
355 entry->entry_size = buf & 0xffff;
356 entry->tid = buf >> 16 & 0xfff;
358 entry->change_ind = le32_to_cpu(*dlct++);
359 entry->device_flags = le32_to_cpu(*dlct++);
361 buf = le32_to_cpu(*dlct++);
362 entry->class_id = buf & 0xfff;
363 entry->version = buf >> 12 & 0xf;
364 entry->vendor_id = buf >> 16;
366 entry->sub_class = le32_to_cpu(*dlct++);
368 buf = le32_to_cpu(*dlct++);
369 entry->user_tid = buf & 0xfff;
370 entry->parent_tid = buf >> 12 & 0xfff;
371 entry->bios_info = buf >> 24;
373 memcpy(&entry->identity_tag, dlct, 8);
376 entry->event_capabilities = le32_to_cpu(*dlct++);
378 /* add new devices, which are new in the LCT */
379 list_for_each_entry_safe(dev, tmp, &c->devices, list) {
380 if (entry->tid == dev->lct_data.tid) {
387 i2o_device_add(c, entry);
393 /* remove devices, which are not in the LCT anymore */
394 list_for_each_entry_safe(dev, tmp, &c->devices, list) {
397 for (i = 0; i < max; i++) {
398 if (lct->lct_entry[i].tid == dev->lct_data.tid) {
405 i2o_device_remove(dev);
415 * Run time support routines
418 /* Issue UTIL_PARAMS_GET or UTIL_PARAMS_SET
420 * This function can be used for all UtilParamsGet/Set operations.
421 * The OperationList is given in oplist-buffer,
422 * and results are returned in reslist-buffer.
423 * Note that the minimum sized reslist is 8 bytes and contains
424 * ResultCount, ErrorInfoSize, BlockStatus and BlockSize.
426 int i2o_parm_issue(struct i2o_device *i2o_dev, int cmd, void *oplist,
427 int oplen, void *reslist, int reslen)
429 struct i2o_message *msg;
433 struct i2o_controller *c = i2o_dev->iop;
434 struct device *dev = &c->pdev->dev;
438 if (i2o_dma_alloc(dev, &res, reslen, GFP_KERNEL))
441 msg = i2o_msg_get_wait(c, I2O_TIMEOUT_MESSAGE_GET);
443 i2o_dma_free(dev, &res);
449 cpu_to_le32(cmd << 24 | HOST_TID << 12 | i2o_dev->lct_data.tid);
450 msg->body[i++] = cpu_to_le32(0x00000000);
451 msg->body[i++] = cpu_to_le32(0x4C000000 | oplen); /* OperationList */
452 memcpy(&msg->body[i], oplist, oplen);
453 i += (oplen / 4 + (oplen % 4 ? 1 : 0));
454 msg->body[i++] = cpu_to_le32(0xD0000000 | res.len); /* ResultList */
455 msg->body[i++] = cpu_to_le32(res.phys);
458 cpu_to_le32(I2O_MESSAGE_SIZE(i + sizeof(struct i2o_message) / 4) |
461 rc = i2o_msg_post_wait_mem(c, msg, 10, &res);
463 /* This only looks like a memory leak - don't "fix" it. */
464 if (rc == -ETIMEDOUT)
467 memcpy(reslist, res.virt, res.len);
468 i2o_dma_free(dev, &res);
474 * Query one field group value or a whole scalar group.
476 int i2o_parm_field_get(struct i2o_device *i2o_dev, int group, int field,
477 void *buf, int buflen)
479 u32 opblk[] = { cpu_to_le32(0x00000001),
480 cpu_to_le32((u16) group << 16 | I2O_PARAMS_FIELD_GET),
481 cpu_to_le32((s16) field << 16 | 0x00000001)
483 u8 *resblk; /* 8 bytes for header */
486 resblk = kmalloc(buflen + 8, GFP_KERNEL | GFP_ATOMIC);
490 rc = i2o_parm_issue(i2o_dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
491 sizeof(opblk), resblk, buflen + 8);
493 memcpy(buf, resblk + 8, buflen); /* cut off header */
501 * if oper == I2O_PARAMS_TABLE_GET, get from all rows
502 * if fieldcount == -1 return all fields
503 * ibuf and ibuflen are unused (use NULL, 0)
504 * else return specific fields
505 * ibuf contains fieldindexes
507 * if oper == I2O_PARAMS_LIST_GET, get from specific rows
508 * if fieldcount == -1 return all fields
509 * ibuf contains rowcount, keyvalues
510 * else return specific fields
511 * fieldcount is # of fieldindexes
512 * ibuf contains fieldindexes, rowcount, keyvalues
514 * You could also use directly function i2o_issue_params().
516 int i2o_parm_table_get(struct i2o_device *dev, int oper, int group,
517 int fieldcount, void *ibuf, int ibuflen, void *resblk,
525 size += 4 - size % 4;
527 opblk = kmalloc(size, GFP_KERNEL);
529 printk(KERN_ERR "i2o: no memory for query buffer.\n");
533 opblk[0] = 1; /* operation count */
534 opblk[1] = 0; /* pad */
537 opblk[4] = fieldcount;
538 memcpy(opblk + 5, ibuf, ibuflen); /* other params */
540 size = i2o_parm_issue(dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
541 size, resblk, reslen);
550 EXPORT_SYMBOL(i2o_device_claim);
551 EXPORT_SYMBOL(i2o_device_claim_release);
552 EXPORT_SYMBOL(i2o_parm_field_get);
553 EXPORT_SYMBOL(i2o_parm_table_get);
554 EXPORT_SYMBOL(i2o_parm_issue);