]> err.no Git - linux-2.6/blob - drivers/message/i2o/device.c
[PATCH] I2O: Beautifying
[linux-2.6] / drivers / message / i2o / device.c
1 /*
2  *      Functions to handle I2O devices
3  *
4  *      Copyright (C) 2004      Markus Lidel <Markus.Lidel@shadowconnect.com>
5  *
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.
10  *
11  *      Fixes/additions:
12  *              Markus Lidel <Markus.Lidel@shadowconnect.com>
13  *                      initial version.
14  */
15
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>
21 #include "core.h"
22
23 /**
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
28  *
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).
32  *
33  *      Returs 0 on success or negative error code on failure.
34  */
35 static inline int i2o_device_issue_claim(struct i2o_device *dev, u32 cmd,
36                                          u32 type)
37 {
38         struct i2o_message *msg;
39
40         msg = i2o_msg_get_wait(dev->iop, I2O_TIMEOUT_MESSAGE_GET);
41         if (IS_ERR(msg))
42                 return PTR_ERR(msg);
43
44         msg->u.head[0] = cpu_to_le32(FIVE_WORD_MSG_SIZE | SGL_OFFSET_0);
45         msg->u.head[1] =
46                 cpu_to_le32(cmd << 24 | HOST_TID << 12 | dev->lct_data.tid);
47         msg->body[0] = cpu_to_le32(type);
48
49         return i2o_msg_post_wait(dev->iop, msg, 60);
50 }
51
52 /**
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
56  *
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.
60  */
61 int i2o_device_claim(struct i2o_device *dev)
62 {
63         int rc = 0;
64
65         down(&dev->lock);
66
67         rc = i2o_device_issue_claim(dev, I2O_CMD_UTIL_CLAIM, I2O_CLAIM_PRIMARY);
68         if (!rc)
69                 pr_debug("i2o: claim of device %d succeded\n",
70                          dev->lct_data.tid);
71         else
72                 pr_debug("i2o: claim of device %d failed %d\n",
73                          dev->lct_data.tid, rc);
74
75         up(&dev->lock);
76
77         return rc;
78 }
79
80 /**
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
84  *
85  *      Drop a claim by an OSM on a given I2O device.
86  *
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.
91  *
92  *      Returns 0 on success or negative error code on failure.
93  */
94 int i2o_device_claim_release(struct i2o_device *dev)
95 {
96         int tries;
97         int rc = 0;
98
99         down(&dev->lock);
100
101         /*
102          *      If the controller takes a nonblocking approach to
103          *      releases we have to sleep/poll for a few times.
104          */
105         for (tries = 0; tries < 10; tries++) {
106                 rc = i2o_device_issue_claim(dev, I2O_CMD_UTIL_RELEASE,
107                                             I2O_CLAIM_PRIMARY);
108                 if (!rc)
109                         break;
110
111                 ssleep(1);
112         }
113
114         if (!rc)
115                 pr_debug("i2o: claim release of device %d succeded\n",
116                          dev->lct_data.tid);
117         else
118                 pr_debug("i2o: claim release of device %d failed %d\n",
119                          dev->lct_data.tid, rc);
120
121         up(&dev->lock);
122
123         return rc;
124 }
125
126
127 /**
128  *      i2o_device_release - release the memory for a I2O device
129  *      @dev: I2O device which should be released
130  *
131  *      Release the allocated memory. This function is called if refcount of
132  *      device reaches 0 automatically.
133  */
134 static void i2o_device_release(struct device *dev)
135 {
136         struct i2o_device *i2o_dev = to_i2o_device(dev);
137
138         pr_debug("i2o: device %s released\n", dev->bus_id);
139
140         kfree(i2o_dev);
141 }
142
143
144 /**
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
149  *
150  *      Returns the number of bytes which are printed into the buffer.
151  */
152 static ssize_t i2o_device_show_class_id(struct device *dev,
153                                         struct device_attribute *attr,
154                                         char *buf)
155 {
156         struct i2o_device *i2o_dev = to_i2o_device(dev);
157
158         sprintf(buf, "0x%03x\n", i2o_dev->lct_data.class_id);
159         return strlen(buf) + 1;
160 }
161
162 /**
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
167  *
168  *      Returns the number of bytes which are printed into the buffer.
169  */
170 static ssize_t i2o_device_show_tid(struct device *dev,
171                                    struct device_attribute *attr, char *buf)
172 {
173         struct i2o_device *i2o_dev = to_i2o_device(dev);
174
175         sprintf(buf, "0x%03x\n", i2o_dev->lct_data.tid);
176         return strlen(buf) + 1;
177 }
178
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),
183         __ATTR_NULL
184 };
185
186 /**
187  *      i2o_device_alloc - Allocate a I2O device and initialize it
188  *
189  *      Allocate the memory for a I2O device and initialize locks and lists
190  *
191  *      Returns the allocated I2O device or a negative error code if the device
192  *      could not be allocated.
193  */
194 static struct i2o_device *i2o_device_alloc(void)
195 {
196         struct i2o_device *dev;
197
198         dev = kmalloc(sizeof(*dev), GFP_KERNEL);
199         if (!dev)
200                 return ERR_PTR(-ENOMEM);
201
202         memset(dev, 0, sizeof(*dev));
203
204         INIT_LIST_HEAD(&dev->list);
205         init_MUTEX(&dev->lock);
206
207         dev->device.bus = &i2o_bus_type;
208         dev->device.release = &i2o_device_release;
209
210         return dev;
211 }
212
213 /**
214  *      i2o_device_add - allocate a new I2O device and add it to the IOP
215  *      @iop: I2O controller where the device is on
216  *      @entry: LCT entry of the I2O device
217  *
218  *      Allocate a new I2O device and initialize it with the LCT entry. The
219  *      device is appended to the device list of the controller.
220  *
221  *      Returns a pointer to the I2O device on success or negative error code
222  *      on failure.
223  */
224 static struct i2o_device *i2o_device_add(struct i2o_controller *c,
225                                          i2o_lct_entry * entry)
226 {
227         struct i2o_device *i2o_dev, *tmp;
228
229         i2o_dev = i2o_device_alloc();
230         if (IS_ERR(i2o_dev)) {
231                 printk(KERN_ERR "i2o: unable to allocate i2o device\n");
232                 return i2o_dev;
233         }
234
235         i2o_dev->lct_data = *entry;
236
237         snprintf(i2o_dev->device.bus_id, BUS_ID_SIZE, "%d:%03x", c->unit,
238                  i2o_dev->lct_data.tid);
239
240         i2o_dev->iop = c;
241         i2o_dev->device.parent = &c->device;
242
243         device_register(&i2o_dev->device);
244
245         list_add_tail(&i2o_dev->list, &c->devices);
246
247         /* create user entries for this device */
248         tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.user_tid);
249         if (tmp && (tmp != i2o_dev))
250                 sysfs_create_link(&i2o_dev->device.kobj, &tmp->device.kobj,
251                                   "user");
252
253         /* create user entries refering to this device */
254         list_for_each_entry(tmp, &c->devices, list)
255                 if ((tmp->lct_data.user_tid == i2o_dev->lct_data.tid)
256                     && (tmp != i2o_dev))
257                     sysfs_create_link(&tmp->device.kobj,
258                                       &i2o_dev->device.kobj, "user");
259
260         /* create parent entries for this device */
261         tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.parent_tid);
262         if (tmp && (tmp != i2o_dev))
263                 sysfs_create_link(&i2o_dev->device.kobj, &tmp->device.kobj,
264                                   "parent");
265
266         /* create parent entries refering to this device */
267         list_for_each_entry(tmp, &c->devices, list)
268                 if ((tmp->lct_data.parent_tid == i2o_dev->lct_data.tid)
269                     && (tmp != i2o_dev))
270                         sysfs_create_link(&tmp->device.kobj,
271                                           &i2o_dev->device.kobj, "parent");
272
273         i2o_driver_notify_device_add_all(i2o_dev);
274
275         pr_debug("i2o: device %s added\n", i2o_dev->device.bus_id);
276
277         return i2o_dev;
278 }
279
280 /**
281  *      i2o_device_remove - remove an I2O device from the I2O core
282  *      @dev: I2O device which should be released
283  *
284  *      Is used on I2O controller removal or LCT modification, when the device
285  *      is removed from the system. Note that the device could still hang
286  *      around until the refcount reaches 0.
287  */
288 void i2o_device_remove(struct i2o_device *i2o_dev)
289 {
290         struct i2o_device *tmp;
291         struct i2o_controller *c = i2o_dev->iop;
292
293         i2o_driver_notify_device_remove_all(i2o_dev);
294
295         sysfs_remove_link(&i2o_dev->device.kobj, "parent");
296         sysfs_remove_link(&i2o_dev->device.kobj, "user");
297
298         list_for_each_entry(tmp, &c->devices, list) {
299                 if (tmp->lct_data.parent_tid == i2o_dev->lct_data.tid)
300                         sysfs_remove_link(&tmp->device.kobj, "parent");
301                 if (tmp->lct_data.user_tid == i2o_dev->lct_data.tid)
302                         sysfs_remove_link(&tmp->device.kobj, "user");
303         }
304         list_del(&i2o_dev->list);
305
306         device_unregister(&i2o_dev->device);
307 }
308
309 /**
310  *      i2o_device_parse_lct - Parse a previously fetched LCT and create devices
311  *      @c: I2O controller from which the LCT should be parsed.
312  *
313  *      The Logical Configuration Table tells us what we can talk to on the
314  *      board. For every entry we create an I2O device, which is registered in
315  *      the I2O core.
316  *
317  *      Returns 0 on success or negative error code on failure.
318  */
319 int i2o_device_parse_lct(struct i2o_controller *c)
320 {
321         struct i2o_device *dev, *tmp;
322         i2o_lct *lct;
323         u32 *dlct = c->dlct.virt;
324         int max = 0, i = 0;
325         u16 table_size;
326         u32 buf;
327
328         down(&c->lct_lock);
329
330         kfree(c->lct);
331
332         buf = le32_to_cpu(*dlct++);
333         table_size = buf & 0xffff;
334
335         lct = c->lct = kmalloc(table_size * 4, GFP_KERNEL);
336         if (!lct) {
337                 up(&c->lct_lock);
338                 return -ENOMEM;
339         }
340
341         lct->lct_ver = buf >> 28;
342         lct->boot_tid = buf >> 16 & 0xfff;
343         lct->table_size = table_size;
344         lct->change_ind = le32_to_cpu(*dlct++);
345         lct->iop_flags = le32_to_cpu(*dlct++);
346
347         table_size -= 3;
348
349         pr_debug("%s: LCT has %d entries (LCT size: %d)\n", c->name, max,
350                  lct->table_size);
351
352         while (table_size > 0) {
353                 i2o_lct_entry *entry = &lct->lct_entry[max];
354                 int found = 0;
355
356                 buf = le32_to_cpu(*dlct++);
357                 entry->entry_size = buf & 0xffff;
358                 entry->tid = buf >> 16 & 0xfff;
359
360                 entry->change_ind = le32_to_cpu(*dlct++);
361                 entry->device_flags = le32_to_cpu(*dlct++);
362
363                 buf = le32_to_cpu(*dlct++);
364                 entry->class_id = buf & 0xfff;
365                 entry->version = buf >> 12 & 0xf;
366                 entry->vendor_id = buf >> 16;
367
368                 entry->sub_class = le32_to_cpu(*dlct++);
369
370                 buf = le32_to_cpu(*dlct++);
371                 entry->user_tid = buf & 0xfff;
372                 entry->parent_tid = buf >> 12 & 0xfff;
373                 entry->bios_info = buf >> 24;
374
375                 memcpy(&entry->identity_tag, dlct, 8);
376                 dlct += 2;
377
378                 entry->event_capabilities = le32_to_cpu(*dlct++);
379
380                 /* add new devices, which are new in the LCT */
381                 list_for_each_entry_safe(dev, tmp, &c->devices, list) {
382                         if (entry->tid == dev->lct_data.tid) {
383                                 found = 1;
384                                 break;
385                         }
386                 }
387
388                 if (!found)
389                         i2o_device_add(c, entry);
390
391                 table_size -= 9;
392                 max++;
393         }
394
395         /* remove devices, which are not in the LCT anymore */
396         list_for_each_entry_safe(dev, tmp, &c->devices, list) {
397                 int found = 0;
398
399                 for (i = 0; i < max; i++) {
400                         if (lct->lct_entry[i].tid == dev->lct_data.tid) {
401                                 found = 1;
402                                 break;
403                         }
404                 }
405
406                 if (!found)
407                         i2o_device_remove(dev);
408         }
409
410         up(&c->lct_lock);
411
412         return 0;
413 }
414
415
416 /*
417  *      Run time support routines
418  */
419
420 /*      Issue UTIL_PARAMS_GET or UTIL_PARAMS_SET
421  *
422  *      This function can be used for all UtilParamsGet/Set operations.
423  *      The OperationList is given in oplist-buffer,
424  *      and results are returned in reslist-buffer.
425  *      Note that the minimum sized reslist is 8 bytes and contains
426  *      ResultCount, ErrorInfoSize, BlockStatus and BlockSize.
427  */
428 int i2o_parm_issue(struct i2o_device *i2o_dev, int cmd, void *oplist,
429                    int oplen, void *reslist, int reslen)
430 {
431         struct i2o_message *msg;
432         int i = 0;
433         int rc;
434         struct i2o_dma res;
435         struct i2o_controller *c = i2o_dev->iop;
436         struct device *dev = &c->pdev->dev;
437
438         res.virt = NULL;
439
440         if (i2o_dma_alloc(dev, &res, reslen, GFP_KERNEL))
441                 return -ENOMEM;
442
443         msg = i2o_msg_get_wait(c, I2O_TIMEOUT_MESSAGE_GET);
444         if (IS_ERR(msg)) {
445                 i2o_dma_free(dev, &res);
446                 return PTR_ERR(msg);
447         }
448
449         i = 0;
450         msg->u.head[1] =
451             cpu_to_le32(cmd << 24 | HOST_TID << 12 | i2o_dev->lct_data.tid);
452         msg->body[i++] = cpu_to_le32(0x00000000);
453         msg->body[i++] = cpu_to_le32(0x4C000000 | oplen);       /* OperationList */
454         memcpy(&msg->body[i], oplist, oplen);
455         i += (oplen / 4 + (oplen % 4 ? 1 : 0));
456         msg->body[i++] = cpu_to_le32(0xD0000000 | res.len);     /* ResultList */
457         msg->body[i++] = cpu_to_le32(res.phys);
458
459         msg->u.head[0] =
460             cpu_to_le32(I2O_MESSAGE_SIZE(i + sizeof(struct i2o_message) / 4) |
461                         SGL_OFFSET_5);
462
463         rc = i2o_msg_post_wait_mem(c, msg, 10, &res);
464
465         /* This only looks like a memory leak - don't "fix" it. */
466         if (rc == -ETIMEDOUT)
467                 return rc;
468
469         memcpy(reslist, res.virt, res.len);
470         i2o_dma_free(dev, &res);
471
472         return rc;
473 }
474
475 /*
476  *       Query one field group value or a whole scalar group.
477  */
478 int i2o_parm_field_get(struct i2o_device *i2o_dev, int group, int field,
479                        void *buf, int buflen)
480 {
481         u32 opblk[] = { cpu_to_le32(0x00000001),
482                 cpu_to_le32((u16) group << 16 | I2O_PARAMS_FIELD_GET),
483                 cpu_to_le32((s16) field << 16 | 0x00000001)
484         };
485         u8 *resblk;             /* 8 bytes for header */
486         int rc;
487
488         resblk = kmalloc(buflen + 8, GFP_KERNEL | GFP_ATOMIC);
489         if (!resblk)
490                 return -ENOMEM;
491
492         rc = i2o_parm_issue(i2o_dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
493                             sizeof(opblk), resblk, buflen + 8);
494
495         memcpy(buf, resblk + 8, buflen);        /* cut off header */
496
497         kfree(resblk);
498
499         return rc;
500 }
501
502 /*
503  *      if oper == I2O_PARAMS_TABLE_GET, get from all rows
504  *              if fieldcount == -1 return all fields
505  *                      ibuf and ibuflen are unused (use NULL, 0)
506  *              else return specific fields
507  *                      ibuf contains fieldindexes
508  *
509  *      if oper == I2O_PARAMS_LIST_GET, get from specific rows
510  *              if fieldcount == -1 return all fields
511  *                      ibuf contains rowcount, keyvalues
512  *              else return specific fields
513  *                      fieldcount is # of fieldindexes
514  *                      ibuf contains fieldindexes, rowcount, keyvalues
515  *
516  *      You could also use directly function i2o_issue_params().
517  */
518 int i2o_parm_table_get(struct i2o_device *dev, int oper, int group,
519                        int fieldcount, void *ibuf, int ibuflen, void *resblk,
520                        int reslen)
521 {
522         u16 *opblk;
523         int size;
524
525         size = 10 + ibuflen;
526         if (size % 4)
527                 size += 4 - size % 4;
528
529         opblk = kmalloc(size, GFP_KERNEL);
530         if (opblk == NULL) {
531                 printk(KERN_ERR "i2o: no memory for query buffer.\n");
532                 return -ENOMEM;
533         }
534
535         opblk[0] = 1;           /* operation count */
536         opblk[1] = 0;           /* pad */
537         opblk[2] = oper;
538         opblk[3] = group;
539         opblk[4] = fieldcount;
540         memcpy(opblk + 5, ibuf, ibuflen);       /* other params */
541
542         size = i2o_parm_issue(dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
543                               size, resblk, reslen);
544
545         kfree(opblk);
546         if (size > reslen)
547                 return reslen;
548
549         return size;
550 }
551
552 EXPORT_SYMBOL(i2o_device_claim);
553 EXPORT_SYMBOL(i2o_device_claim_release);
554 EXPORT_SYMBOL(i2o_parm_field_get);
555 EXPORT_SYMBOL(i2o_parm_table_get);
556 EXPORT_SYMBOL(i2o_parm_issue);