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
56 * Do the leg work to assign a device to a given OSM. If the claim succeeds,
57 * the owner is the primary. If the attempt fails a negative errno code
58 * is returned. On success zero is returned.
60 int i2o_device_claim(struct i2o_device
*dev
)
64 mutex_lock(&dev
->lock
);
66 rc
= i2o_device_issue_claim(dev
, I2O_CMD_UTIL_CLAIM
, I2O_CLAIM_PRIMARY
);
68 pr_debug("i2o: claim of device %d succeeded\n",
71 pr_debug("i2o: claim of device %d failed %d\n",
72 dev
->lct_data
.tid
, rc
);
74 mutex_unlock(&dev
->lock
);
80 * i2o_device_claim_release - release a device that the OSM is using
81 * @dev: device to release
83 * Drop a claim by an OSM on a given I2O device.
85 * AC - some devices seem to want to refuse an unclaim until they have
86 * finished internal processing. It makes sense since you don't want a
87 * new device to go reconfiguring the entire system until you are done.
88 * Thus we are prepared to wait briefly.
90 * Returns 0 on success or negative error code on failure.
92 int i2o_device_claim_release(struct i2o_device
*dev
)
97 mutex_lock(&dev
->lock
);
100 * If the controller takes a nonblocking approach to
101 * releases we have to sleep/poll for a few times.
103 for (tries
= 0; tries
< 10; tries
++) {
104 rc
= i2o_device_issue_claim(dev
, I2O_CMD_UTIL_RELEASE
,
113 pr_debug("i2o: claim release of device %d succeeded\n",
116 pr_debug("i2o: claim release of device %d failed %d\n",
117 dev
->lct_data
.tid
, rc
);
119 mutex_unlock(&dev
->lock
);
125 * i2o_device_release - release the memory for a I2O device
126 * @dev: I2O device which should be released
128 * Release the allocated memory. This function is called if refcount of
129 * device reaches 0 automatically.
131 static void i2o_device_release(struct device
*dev
)
133 struct i2o_device
*i2o_dev
= to_i2o_device(dev
);
135 pr_debug("i2o: device %s released\n", dev_name(dev
));
141 * class_id_show - Displays class id of I2O device
142 * @dev: device of which the class id should be displayed
143 * @attr: pointer to device attribute
144 * @buf: buffer into which the class id should be printed
146 * Returns the number of bytes which are printed into the buffer.
148 static ssize_t
class_id_show(struct device
*dev
, struct device_attribute
*attr
,
151 struct i2o_device
*i2o_dev
= to_i2o_device(dev
);
153 sprintf(buf
, "0x%03x\n", i2o_dev
->lct_data
.class_id
);
154 return strlen(buf
) + 1;
156 static DEVICE_ATTR_RO(class_id
);
159 * tid_show - Displays TID of I2O device
160 * @dev: device of which the TID should be displayed
161 * @attr: pointer to device attribute
162 * @buf: buffer into which the TID should be printed
164 * Returns the number of bytes which are printed into the buffer.
166 static ssize_t
tid_show(struct device
*dev
, struct device_attribute
*attr
,
169 struct i2o_device
*i2o_dev
= to_i2o_device(dev
);
171 sprintf(buf
, "0x%03x\n", i2o_dev
->lct_data
.tid
);
172 return strlen(buf
) + 1;
174 static DEVICE_ATTR_RO(tid
);
176 /* I2O device attributes */
177 static struct attribute
*i2o_device_attrs
[] = {
178 &dev_attr_class_id
.attr
,
183 static const struct attribute_group i2o_device_group
= {
184 .attrs
= i2o_device_attrs
,
187 const struct attribute_group
*i2o_device_groups
[] = {
193 * i2o_device_alloc - Allocate a I2O device and initialize it
195 * Allocate the memory for a I2O device and initialize locks and lists
197 * Returns the allocated I2O device or a negative error code if the device
198 * could not be allocated.
200 static struct i2o_device
*i2o_device_alloc(void)
202 struct i2o_device
*dev
;
204 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
206 return ERR_PTR(-ENOMEM
);
208 INIT_LIST_HEAD(&dev
->list
);
209 mutex_init(&dev
->lock
);
211 dev
->device
.bus
= &i2o_bus_type
;
212 dev
->device
.release
= &i2o_device_release
;
218 * i2o_device_add - allocate a new I2O device and add it to the IOP
219 * @c: I2O controller that the device is on
220 * @entry: LCT entry of the I2O device
222 * Allocate a new I2O device and initialize it with the LCT entry. The
223 * device is appended to the device list of the controller.
225 * Returns zero on success, or a -ve errno.
227 static int i2o_device_add(struct i2o_controller
*c
, i2o_lct_entry
*entry
)
229 struct i2o_device
*i2o_dev
, *tmp
;
232 i2o_dev
= i2o_device_alloc();
233 if (IS_ERR(i2o_dev
)) {
234 printk(KERN_ERR
"i2o: unable to allocate i2o device\n");
235 return PTR_ERR(i2o_dev
);
238 i2o_dev
->lct_data
= *entry
;
240 dev_set_name(&i2o_dev
->device
, "%d:%03x", c
->unit
,
241 i2o_dev
->lct_data
.tid
);
244 i2o_dev
->device
.parent
= &c
->device
;
246 rc
= device_register(&i2o_dev
->device
);
250 list_add_tail(&i2o_dev
->list
, &c
->devices
);
252 /* create user entries for this device */
253 tmp
= i2o_iop_find_device(i2o_dev
->iop
, i2o_dev
->lct_data
.user_tid
);
254 if (tmp
&& (tmp
!= i2o_dev
)) {
255 rc
= sysfs_create_link(&i2o_dev
->device
.kobj
,
256 &tmp
->device
.kobj
, "user");
261 /* create user entries referring to this device */
262 list_for_each_entry(tmp
, &c
->devices
, list
)
263 if ((tmp
->lct_data
.user_tid
== i2o_dev
->lct_data
.tid
)
264 && (tmp
!= i2o_dev
)) {
265 rc
= sysfs_create_link(&tmp
->device
.kobj
,
266 &i2o_dev
->device
.kobj
, "user");
271 /* create parent entries for this device */
272 tmp
= i2o_iop_find_device(i2o_dev
->iop
, i2o_dev
->lct_data
.parent_tid
);
273 if (tmp
&& (tmp
!= i2o_dev
)) {
274 rc
= sysfs_create_link(&i2o_dev
->device
.kobj
,
275 &tmp
->device
.kobj
, "parent");
280 /* create parent entries referring to this device */
281 list_for_each_entry(tmp
, &c
->devices
, list
)
282 if ((tmp
->lct_data
.parent_tid
== i2o_dev
->lct_data
.tid
)
283 && (tmp
!= i2o_dev
)) {
284 rc
= sysfs_create_link(&tmp
->device
.kobj
,
285 &i2o_dev
->device
.kobj
, "parent");
290 i2o_driver_notify_device_add_all(i2o_dev
);
292 pr_debug("i2o: device %s added\n", dev_name(&i2o_dev
->device
));
297 /* If link creating failed halfway, we loop whole list to cleanup.
298 * And we don't care wrong removing of link, because sysfs_remove_link
299 * will take care of it.
301 list_for_each_entry(tmp
, &c
->devices
, list
) {
302 if (tmp
->lct_data
.parent_tid
== i2o_dev
->lct_data
.tid
)
303 sysfs_remove_link(&tmp
->device
.kobj
, "parent");
305 sysfs_remove_link(&i2o_dev
->device
.kobj
, "parent");
307 list_for_each_entry(tmp
, &c
->devices
, list
)
308 if (tmp
->lct_data
.user_tid
== i2o_dev
->lct_data
.tid
)
309 sysfs_remove_link(&tmp
->device
.kobj
, "user");
310 sysfs_remove_link(&i2o_dev
->device
.kobj
, "user");
312 list_del(&i2o_dev
->list
);
313 device_unregister(&i2o_dev
->device
);
320 * i2o_device_remove - remove an I2O device from the I2O core
321 * @i2o_dev: I2O device which should be released
323 * Is used on I2O controller removal or LCT modification, when the device
324 * is removed from the system. Note that the device could still hang
325 * around until the refcount reaches 0.
327 void i2o_device_remove(struct i2o_device
*i2o_dev
)
329 struct i2o_device
*tmp
;
330 struct i2o_controller
*c
= i2o_dev
->iop
;
332 i2o_driver_notify_device_remove_all(i2o_dev
);
334 sysfs_remove_link(&i2o_dev
->device
.kobj
, "parent");
335 sysfs_remove_link(&i2o_dev
->device
.kobj
, "user");
337 list_for_each_entry(tmp
, &c
->devices
, list
) {
338 if (tmp
->lct_data
.parent_tid
== i2o_dev
->lct_data
.tid
)
339 sysfs_remove_link(&tmp
->device
.kobj
, "parent");
340 if (tmp
->lct_data
.user_tid
== i2o_dev
->lct_data
.tid
)
341 sysfs_remove_link(&tmp
->device
.kobj
, "user");
343 list_del(&i2o_dev
->list
);
345 device_unregister(&i2o_dev
->device
);
349 * i2o_device_parse_lct - Parse a previously fetched LCT and create devices
350 * @c: I2O controller from which the LCT should be parsed.
352 * The Logical Configuration Table tells us what we can talk to on the
353 * board. For every entry we create an I2O device, which is registered in
356 * Returns 0 on success or negative error code on failure.
358 int i2o_device_parse_lct(struct i2o_controller
*c
)
360 struct i2o_device
*dev
, *tmp
;
362 u32
*dlct
= c
->dlct
.virt
;
367 mutex_lock(&c
->lct_lock
);
371 buf
= le32_to_cpu(*dlct
++);
372 table_size
= buf
& 0xffff;
374 lct
= c
->lct
= kmalloc(table_size
* 4, GFP_KERNEL
);
376 mutex_unlock(&c
->lct_lock
);
380 lct
->lct_ver
= buf
>> 28;
381 lct
->boot_tid
= buf
>> 16 & 0xfff;
382 lct
->table_size
= table_size
;
383 lct
->change_ind
= le32_to_cpu(*dlct
++);
384 lct
->iop_flags
= le32_to_cpu(*dlct
++);
388 pr_debug("%s: LCT has %d entries (LCT size: %d)\n", c
->name
, max
,
391 while (table_size
> 0) {
392 i2o_lct_entry
*entry
= &lct
->lct_entry
[max
];
395 buf
= le32_to_cpu(*dlct
++);
396 entry
->entry_size
= buf
& 0xffff;
397 entry
->tid
= buf
>> 16 & 0xfff;
399 entry
->change_ind
= le32_to_cpu(*dlct
++);
400 entry
->device_flags
= le32_to_cpu(*dlct
++);
402 buf
= le32_to_cpu(*dlct
++);
403 entry
->class_id
= buf
& 0xfff;
404 entry
->version
= buf
>> 12 & 0xf;
405 entry
->vendor_id
= buf
>> 16;
407 entry
->sub_class
= le32_to_cpu(*dlct
++);
409 buf
= le32_to_cpu(*dlct
++);
410 entry
->user_tid
= buf
& 0xfff;
411 entry
->parent_tid
= buf
>> 12 & 0xfff;
412 entry
->bios_info
= buf
>> 24;
414 memcpy(&entry
->identity_tag
, dlct
, 8);
417 entry
->event_capabilities
= le32_to_cpu(*dlct
++);
419 /* add new devices, which are new in the LCT */
420 list_for_each_entry_safe(dev
, tmp
, &c
->devices
, list
) {
421 if (entry
->tid
== dev
->lct_data
.tid
) {
428 i2o_device_add(c
, entry
);
434 /* remove devices, which are not in the LCT anymore */
435 list_for_each_entry_safe(dev
, tmp
, &c
->devices
, list
) {
438 for (i
= 0; i
< max
; i
++) {
439 if (lct
->lct_entry
[i
].tid
== dev
->lct_data
.tid
) {
446 i2o_device_remove(dev
);
449 mutex_unlock(&c
->lct_lock
);
455 * Run time support routines
458 /* Issue UTIL_PARAMS_GET or UTIL_PARAMS_SET
460 * This function can be used for all UtilParamsGet/Set operations.
461 * The OperationList is given in oplist-buffer,
462 * and results are returned in reslist-buffer.
463 * Note that the minimum sized reslist is 8 bytes and contains
464 * ResultCount, ErrorInfoSize, BlockStatus and BlockSize.
466 int i2o_parm_issue(struct i2o_device
*i2o_dev
, int cmd
, void *oplist
,
467 int oplen
, void *reslist
, int reslen
)
469 struct i2o_message
*msg
;
473 struct i2o_controller
*c
= i2o_dev
->iop
;
474 struct device
*dev
= &c
->pdev
->dev
;
478 if (i2o_dma_alloc(dev
, &res
, reslen
))
481 msg
= i2o_msg_get_wait(c
, I2O_TIMEOUT_MESSAGE_GET
);
483 i2o_dma_free(dev
, &res
);
489 cpu_to_le32(cmd
<< 24 | HOST_TID
<< 12 | i2o_dev
->lct_data
.tid
);
490 msg
->body
[i
++] = cpu_to_le32(0x00000000);
491 msg
->body
[i
++] = cpu_to_le32(0x4C000000 | oplen
); /* OperationList */
492 memcpy(&msg
->body
[i
], oplist
, oplen
);
493 i
+= (oplen
/ 4 + (oplen
% 4 ? 1 : 0));
494 msg
->body
[i
++] = cpu_to_le32(0xD0000000 | res
.len
); /* ResultList */
495 msg
->body
[i
++] = cpu_to_le32(res
.phys
);
498 cpu_to_le32(I2O_MESSAGE_SIZE(i
+ sizeof(struct i2o_message
) / 4) |
501 rc
= i2o_msg_post_wait_mem(c
, msg
, 10, &res
);
503 /* This only looks like a memory leak - don't "fix" it. */
504 if (rc
== -ETIMEDOUT
)
507 memcpy(reslist
, res
.virt
, res
.len
);
508 i2o_dma_free(dev
, &res
);
514 * Query one field group value or a whole scalar group.
516 int i2o_parm_field_get(struct i2o_device
*i2o_dev
, int group
, int field
,
517 void *buf
, int buflen
)
519 u32 opblk
[] = { cpu_to_le32(0x00000001),
520 cpu_to_le32((u16
) group
<< 16 | I2O_PARAMS_FIELD_GET
),
521 cpu_to_le32((s16
) field
<< 16 | 0x00000001)
523 u8
*resblk
; /* 8 bytes for header */
526 resblk
= kmalloc(buflen
+ 8, GFP_KERNEL
);
530 rc
= i2o_parm_issue(i2o_dev
, I2O_CMD_UTIL_PARAMS_GET
, opblk
,
531 sizeof(opblk
), resblk
, buflen
+ 8);
533 memcpy(buf
, resblk
+ 8, buflen
); /* cut off header */
541 * if oper == I2O_PARAMS_TABLE_GET, get from all rows
542 * if fieldcount == -1 return all fields
543 * ibuf and ibuflen are unused (use NULL, 0)
544 * else return specific fields
545 * ibuf contains fieldindexes
547 * if oper == I2O_PARAMS_LIST_GET, get from specific rows
548 * if fieldcount == -1 return all fields
549 * ibuf contains rowcount, keyvalues
550 * else return specific fields
551 * fieldcount is # of fieldindexes
552 * ibuf contains fieldindexes, rowcount, keyvalues
554 * You could also use directly function i2o_issue_params().
556 int i2o_parm_table_get(struct i2o_device
*dev
, int oper
, int group
,
557 int fieldcount
, void *ibuf
, int ibuflen
, void *resblk
,
565 size
+= 4 - size
% 4;
567 opblk
= kmalloc(size
, GFP_KERNEL
);
569 printk(KERN_ERR
"i2o: no memory for query buffer.\n");
573 opblk
[0] = 1; /* operation count */
574 opblk
[1] = 0; /* pad */
577 opblk
[4] = fieldcount
;
578 memcpy(opblk
+ 5, ibuf
, ibuflen
); /* other params */
580 size
= i2o_parm_issue(dev
, I2O_CMD_UTIL_PARAMS_GET
, opblk
,
581 size
, resblk
, reslen
);
590 EXPORT_SYMBOL(i2o_device_claim
);
591 EXPORT_SYMBOL(i2o_device_claim_release
);
592 EXPORT_SYMBOL(i2o_parm_field_get
);
593 EXPORT_SYMBOL(i2o_parm_table_get
);
594 EXPORT_SYMBOL(i2o_parm_issue
);