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_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;
344 u32 *dlct = c->dlct.virt;
353 buf = le32_to_cpu(*dlct++);
354 table_size = buf & 0xffff;
356 lct = c->lct = kmalloc(table_size * 4, GFP_KERNEL);
362 lct->lct_ver = buf >> 28;
363 lct->boot_tid = buf >> 16 & 0xfff;
364 lct->table_size = table_size;
365 lct->change_ind = le32_to_cpu(*dlct++);
366 lct->iop_flags = le32_to_cpu(*dlct++);
370 pr_debug("%s: LCT has %d entries (LCT size: %d)\n", c->name, max,
373 while (table_size > 0) {
374 i2o_lct_entry *entry = &lct->lct_entry[max];
377 buf = le32_to_cpu(*dlct++);
378 entry->entry_size = buf & 0xffff;
379 entry->tid = buf >> 16 & 0xfff;
381 entry->change_ind = le32_to_cpu(*dlct++);
382 entry->device_flags = le32_to_cpu(*dlct++);
384 buf = le32_to_cpu(*dlct++);
385 entry->class_id = buf & 0xfff;
386 entry->version = buf >> 12 & 0xf;
387 entry->vendor_id = buf >> 16;
389 entry->sub_class = le32_to_cpu(*dlct++);
391 buf = le32_to_cpu(*dlct++);
392 entry->user_tid = buf & 0xfff;
393 entry->parent_tid = buf >> 12 & 0xfff;
394 entry->bios_info = buf >> 24;
396 memcpy(&entry->identity_tag, dlct, 8);
399 entry->event_capabilities = le32_to_cpu(*dlct++);
401 /* add new devices, which are new in the LCT */
402 list_for_each_entry_safe(dev, tmp, &c->devices, list) {
403 if (entry->tid == dev->lct_data.tid) {
410 i2o_device_add(c, entry);
416 /* remove devices, which are not in the LCT anymore */
417 list_for_each_entry_safe(dev, tmp, &c->devices, list) {
420 for (i = 0; i < max; i++) {
421 if (lct->lct_entry[i].tid == dev->lct_data.tid) {
428 i2o_device_remove(dev);
438 * Run time support routines
441 /* Issue UTIL_PARAMS_GET or UTIL_PARAMS_SET
443 * This function can be used for all UtilParamsGet/Set operations.
444 * The OperationList is given in oplist-buffer,
445 * and results are returned in reslist-buffer.
446 * Note that the minimum sized reslist is 8 bytes and contains
447 * ResultCount, ErrorInfoSize, BlockStatus and BlockSize.
449 int i2o_parm_issue(struct i2o_device *i2o_dev, int cmd, void *oplist,
450 int oplen, void *reslist, int reslen)
452 struct i2o_message *msg;
456 struct i2o_controller *c = i2o_dev->iop;
457 struct device *dev = &c->pdev->dev;
461 if (i2o_dma_alloc(dev, &res, reslen, GFP_KERNEL))
464 msg = i2o_msg_get_wait(c, I2O_TIMEOUT_MESSAGE_GET);
466 i2o_dma_free(dev, &res);
472 cpu_to_le32(cmd << 24 | HOST_TID << 12 | i2o_dev->lct_data.tid);
473 msg->body[i++] = cpu_to_le32(0x00000000);
474 msg->body[i++] = cpu_to_le32(0x4C000000 | oplen); /* OperationList */
475 memcpy(&msg->body[i], oplist, oplen);
476 i += (oplen / 4 + (oplen % 4 ? 1 : 0));
477 msg->body[i++] = cpu_to_le32(0xD0000000 | res.len); /* ResultList */
478 msg->body[i++] = cpu_to_le32(res.phys);
481 cpu_to_le32(I2O_MESSAGE_SIZE(i + sizeof(struct i2o_message) / 4) |
484 rc = i2o_msg_post_wait_mem(c, msg, 10, &res);
486 /* This only looks like a memory leak - don't "fix" it. */
487 if (rc == -ETIMEDOUT)
490 memcpy(reslist, res.virt, res.len);
491 i2o_dma_free(dev, &res);
497 * Query one field group value or a whole scalar group.
499 int i2o_parm_field_get(struct i2o_device *i2o_dev, int group, int field,
500 void *buf, int buflen)
502 u32 opblk[] = { cpu_to_le32(0x00000001),
503 cpu_to_le32((u16) group << 16 | I2O_PARAMS_FIELD_GET),
504 cpu_to_le32((s16) field << 16 | 0x00000001)
506 u8 *resblk; /* 8 bytes for header */
509 resblk = kmalloc(buflen + 8, GFP_KERNEL | GFP_ATOMIC);
513 rc = i2o_parm_issue(i2o_dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
514 sizeof(opblk), resblk, buflen + 8);
516 memcpy(buf, resblk + 8, buflen); /* cut off header */
524 * if oper == I2O_PARAMS_TABLE_GET, get from all rows
525 * if fieldcount == -1 return all fields
526 * ibuf and ibuflen are unused (use NULL, 0)
527 * else return specific fields
528 * ibuf contains fieldindexes
530 * if oper == I2O_PARAMS_LIST_GET, get from specific rows
531 * if fieldcount == -1 return all fields
532 * ibuf contains rowcount, keyvalues
533 * else return specific fields
534 * fieldcount is # of fieldindexes
535 * ibuf contains fieldindexes, rowcount, keyvalues
537 * You could also use directly function i2o_issue_params().
539 int i2o_parm_table_get(struct i2o_device *dev, int oper, int group,
540 int fieldcount, void *ibuf, int ibuflen, void *resblk,
548 size += 4 - size % 4;
550 opblk = kmalloc(size, GFP_KERNEL);
552 printk(KERN_ERR "i2o: no memory for query buffer.\n");
556 opblk[0] = 1; /* operation count */
557 opblk[1] = 0; /* pad */
560 opblk[4] = fieldcount;
561 memcpy(opblk + 5, ibuf, ibuflen); /* other params */
563 size = i2o_parm_issue(dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
564 size, resblk, reslen);
573 EXPORT_SYMBOL(i2o_device_claim);
574 EXPORT_SYMBOL(i2o_device_claim_release);
575 EXPORT_SYMBOL(i2o_parm_field_get);
576 EXPORT_SYMBOL(i2o_parm_table_get);
577 EXPORT_SYMBOL(i2o_parm_issue);