This commit was manufactured by cvs2svn to create branch 'vserver'.
[linux-2.6.git] / 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
19 /* Exec OSM functions */
20 extern struct bus_type i2o_bus_type;
21
22 /**
23  *      i2o_device_issue_claim - claim or release a device
24  *      @dev: I2O device to claim or release
25  *      @cmd: claim or release command
26  *      @type: type of claim
27  *
28  *      Issue I2O UTIL_CLAIM or UTIL_RELEASE messages. The message to be sent
29  *      is set by cmd. dev is the I2O device which should be claim or
30  *      released and the type is the claim type (see the I2O spec).
31  *
32  *      Returs 0 on success or negative error code on failure.
33  */
34 static inline int i2o_device_issue_claim(struct i2o_device *dev, u32 cmd,
35                                          u32 type)
36 {
37         struct i2o_message *msg;
38         u32 m;
39
40         m = i2o_msg_get_wait(dev->iop, &msg, I2O_TIMEOUT_MESSAGE_GET);
41         if (m == I2O_QUEUE_EMPTY)
42                 return -ETIMEDOUT;
43
44         writel(FIVE_WORD_MSG_SIZE | SGL_OFFSET_0, &msg->u.head[0]);
45         writel(cmd << 24 | HOST_TID << 12 | dev->lct_data.tid, &msg->u.head[1]);
46         writel(type, &msg->body[0]);
47
48         return i2o_msg_post_wait(dev->iop, m, 60);
49 };
50
51 /**
52  *      i2o_device_claim - claim a device for use by an OSM
53  *      @dev: I2O device to claim
54  *      @drv: I2O driver which wants to claim the device
55  *
56  *      Do the leg work to assign a device to a given OSM. If the claim succeed
57  *      the owner of the rimary. If the attempt fails a negative errno code
58  *      is returned. On success zero is returned.
59  */
60 int i2o_device_claim(struct i2o_device *dev)
61 {
62         int rc = 0;
63
64         down(&dev->lock);
65
66         rc = i2o_device_issue_claim(dev, I2O_CMD_UTIL_CLAIM, I2O_CLAIM_PRIMARY);
67         if (!rc)
68                 pr_debug("claim of device %d succeded\n", dev->lct_data.tid);
69         else
70                 pr_debug("claim of device %d failed %d\n", dev->lct_data.tid,
71                          rc);
72
73         up(&dev->lock);
74
75         return rc;
76 };
77
78 /**
79  *      i2o_device_claim_release - release a device that the OSM is using
80  *      @dev: device to release
81  *      @drv: driver which claimed the device
82  *
83  *      Drop a claim by an OSM on a given I2O device.
84  *
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.
89  *
90  *      Returns 0 on success or negative error code on failure.
91  */
92 int i2o_device_claim_release(struct i2o_device *dev)
93 {
94         int tries;
95         int rc = 0;
96
97         down(&dev->lock);
98
99         /*
100          *      If the controller takes a nonblocking approach to
101          *      releases we have to sleep/poll for a few times.
102          */
103         for (tries = 0; tries < 10; tries++) {
104                 rc = i2o_device_issue_claim(dev, I2O_CMD_UTIL_RELEASE,
105                                             I2O_CLAIM_PRIMARY);
106                 if (!rc)
107                         break;
108
109                 set_current_state(TASK_UNINTERRUPTIBLE);
110                 schedule_timeout(HZ);
111         }
112
113         if (!rc)
114                 pr_debug("claim release of device %d succeded\n",
115                          dev->lct_data.tid);
116         else
117                 pr_debug("claim release of device %d failed %d\n",
118                          dev->lct_data.tid, rc);
119
120         up(&dev->lock);
121
122         return rc;
123 };
124
125 /**
126  *      i2o_device_release - release the memory for a I2O device
127  *      @dev: I2O device which should be released
128  *
129  *      Release the allocated memory. This function is called if refcount of
130  *      device reaches 0 automatically.
131  */
132 static void i2o_device_release(struct device *dev)
133 {
134         struct i2o_device *i2o_dev = to_i2o_device(dev);
135
136         pr_debug("Release I2O device %s\n", dev->bus_id);
137
138         kfree(i2o_dev);
139 };
140
141 /**
142  *      i2o_device_class_release - Remove I2O device attributes
143  *      @cd: I2O class device which is added to the I2O device class
144  *
145  *      Removes attributes from the I2O device again. Also search each device
146  *      on the controller for I2O devices which refert to this device as parent
147  *      or user and remove this links also.
148  */
149 static void i2o_device_class_release(struct class_device *cd)
150 {
151         struct i2o_device *i2o_dev, *tmp;
152         struct i2o_controller *c;
153
154         i2o_dev = to_i2o_device(cd->dev);
155         c = i2o_dev->iop;
156
157         sysfs_remove_link(&i2o_dev->device.kobj, "parent");
158         sysfs_remove_link(&i2o_dev->device.kobj, "user");
159
160         list_for_each_entry(tmp, &c->devices, list) {
161                 if (tmp->lct_data.parent_tid == i2o_dev->lct_data.tid)
162                         sysfs_remove_link(&tmp->device.kobj, "parent");
163                 if (tmp->lct_data.user_tid == i2o_dev->lct_data.tid)
164                         sysfs_remove_link(&tmp->device.kobj, "user");
165         }
166 };
167
168 /* I2O device class */
169 static struct class i2o_device_class = {
170         .name = "i2o_device",
171         .release = i2o_device_class_release
172 };
173
174 /**
175  *      i2o_device_alloc - Allocate a I2O device and initialize it
176  *
177  *      Allocate the memory for a I2O device and initialize locks and lists
178  *
179  *      Returns the allocated I2O device or a negative error code if the device
180  *      could not be allocated.
181  */
182 static struct i2o_device *i2o_device_alloc(void)
183 {
184         struct i2o_device *dev;
185
186         dev = kmalloc(sizeof(*dev), GFP_KERNEL);
187         if (!dev)
188                 return ERR_PTR(-ENOMEM);
189
190         memset(dev, 0, sizeof(*dev));
191
192         INIT_LIST_HEAD(&dev->list);
193         init_MUTEX(&dev->lock);
194
195         dev->device.bus = &i2o_bus_type;
196         dev->device.release = &i2o_device_release;
197         dev->classdev.class = &i2o_device_class;
198         dev->classdev.dev = &dev->device;
199
200         return dev;
201 };
202
203 /**
204  *      i2o_device_add - allocate a new I2O device and add it to the IOP
205  *      @iop: I2O controller where the device is on
206  *      @entry: LCT entry of the I2O device
207  *
208  *      Allocate a new I2O device and initialize it with the LCT entry. The
209  *      device is appended to the device list of the controller.
210  *
211  *      Returns a pointer to the I2O device on success or negative error code
212  *      on failure.
213  */
214 struct i2o_device *i2o_device_add(struct i2o_controller *c,
215                                   i2o_lct_entry * entry)
216 {
217         struct i2o_device *dev;
218
219         dev = i2o_device_alloc();
220         if (IS_ERR(dev)) {
221                 printk(KERN_ERR "i2o: unable to allocate i2o device\n");
222                 return dev;
223         }
224
225         dev->lct_data = *entry;
226
227         snprintf(dev->device.bus_id, BUS_ID_SIZE, "%d:%03x", c->unit,
228                  dev->lct_data.tid);
229
230         snprintf(dev->classdev.class_id, BUS_ID_SIZE, "%d:%03x", c->unit,
231                  dev->lct_data.tid);
232
233         dev->iop = c;
234         dev->device.parent = &c->device;
235
236         device_register(&dev->device);
237
238         list_add_tail(&dev->list, &c->devices);
239
240         class_device_register(&dev->classdev);
241
242         i2o_driver_notify_device_add_all(dev);
243
244         pr_debug("I2O device %s added\n", dev->device.bus_id);
245
246         return dev;
247 };
248
249 /**
250  *      i2o_device_remove - remove an I2O device from the I2O core
251  *      @dev: I2O device which should be released
252  *
253  *      Is used on I2O controller removal or LCT modification, when the device
254  *      is removed from the system. Note that the device could still hang
255  *      around until the refcount reaches 0.
256  */
257 void i2o_device_remove(struct i2o_device *i2o_dev)
258 {
259         i2o_driver_notify_device_remove_all(i2o_dev);
260         class_device_unregister(&i2o_dev->classdev);
261         list_del(&i2o_dev->list);
262         device_unregister(&i2o_dev->device);
263 };
264
265 /**
266  *      i2o_device_parse_lct - Parse a previously fetched LCT and create devices
267  *      @c: I2O controller from which the LCT should be parsed.
268  *
269  *      The Logical Configuration Table tells us what we can talk to on the
270  *      board. For every entry we create an I2O device, which is registered in
271  *      the I2O core.
272  *
273  *      Returns 0 on success or negative error code on failure.
274  */
275 int i2o_device_parse_lct(struct i2o_controller *c)
276 {
277         struct i2o_device *dev, *tmp;
278         i2o_lct *lct;
279         int i;
280         int max;
281
282         down(&c->lct_lock);
283
284         if (c->lct)
285                 kfree(c->lct);
286
287         lct = c->dlct.virt;
288
289         c->lct = kmalloc(lct->table_size * 4, GFP_KERNEL);
290         if (!c->lct) {
291                 up(&c->lct_lock);
292                 return -ENOMEM;
293         }
294
295         if (lct->table_size * 4 > c->dlct.len) {
296                 memcpy_fromio(c->lct, c->dlct.virt, c->dlct.len);
297                 up(&c->lct_lock);
298                 return -EAGAIN;
299         }
300
301         memcpy_fromio(c->lct, c->dlct.virt, lct->table_size * 4);
302
303         lct = c->lct;
304
305         max = (lct->table_size - 3) / 9;
306
307         pr_debug("LCT has %d entries (LCT size: %d)\n", max, lct->table_size);
308
309         /* remove devices, which are not in the LCT anymore */
310         list_for_each_entry_safe(dev, tmp, &c->devices, list) {
311                 int found = 0;
312
313                 for (i = 0; i < max; i++) {
314                         if (lct->lct_entry[i].tid == dev->lct_data.tid) {
315                                 found = 1;
316                                 break;
317                         }
318                 }
319
320                 if (!found)
321                         i2o_device_remove(dev);
322         }
323
324         /* add new devices, which are new in the LCT */
325         for (i = 0; i < max; i++) {
326                 int found = 0;
327
328                 list_for_each_entry_safe(dev, tmp, &c->devices, list) {
329                         if (lct->lct_entry[i].tid == dev->lct_data.tid) {
330                                 found = 1;
331                                 break;
332                         }
333                 }
334
335                 if (!found)
336                         i2o_device_add(c, &lct->lct_entry[i]);
337         }
338         up(&c->lct_lock);
339
340         return 0;
341 };
342
343 /**
344  *      i2o_device_class_show_class_id - Displays class id of I2O device
345  *      @cd: class device of which the class id should be displayed
346  *      @buf: buffer into which the class id should be printed
347  *
348  *      Returns the number of bytes which are printed into the buffer.
349  */
350 static ssize_t i2o_device_class_show_class_id(struct class_device *cd,
351                                               char *buf)
352 {
353         struct i2o_device *dev = to_i2o_device(cd->dev);
354
355         sprintf(buf, "%03x\n", dev->lct_data.class_id);
356         return strlen(buf) + 1;
357 };
358
359 /**
360  *      i2o_device_class_show_tid - Displays TID of I2O device
361  *      @cd: class device of which the TID should be displayed
362  *      @buf: buffer into which the class id should be printed
363  *
364  *      Returns the number of bytes which are printed into the buffer.
365  */
366 static ssize_t i2o_device_class_show_tid(struct class_device *cd, char *buf)
367 {
368         struct i2o_device *dev = to_i2o_device(cd->dev);
369
370         sprintf(buf, "%03x\n", dev->lct_data.tid);
371         return strlen(buf) + 1;
372 };
373
374 /* I2O device class attributes */
375 static CLASS_DEVICE_ATTR(class_id, S_IRUGO, i2o_device_class_show_class_id,
376                          NULL);
377 static CLASS_DEVICE_ATTR(tid, S_IRUGO, i2o_device_class_show_tid, NULL);
378
379 /**
380  *      i2o_device_class_add - Adds attributes to the I2O device
381  *      @cd: I2O class device which is added to the I2O device class
382  *
383  *      This function get called when a I2O device is added to the class. It
384  *      creates the attributes for each device and creates user/parent symlink
385  *      if necessary.
386  *
387  *      Returns 0 on success or negative error code on failure.
388  */
389 static int i2o_device_class_add(struct class_device *cd)
390 {
391         struct i2o_device *i2o_dev, *tmp;
392         struct i2o_controller *c;
393
394         i2o_dev = to_i2o_device(cd->dev);
395         c = i2o_dev->iop;
396
397         class_device_create_file(cd, &class_device_attr_class_id);
398         class_device_create_file(cd, &class_device_attr_tid);
399
400         /* create user entries for this device */
401         tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.user_tid);
402         if (tmp)
403                 sysfs_create_link(&i2o_dev->device.kobj, &tmp->device.kobj,
404                                   "user");
405
406         /* create user entries refering to this device */
407         list_for_each_entry(tmp, &c->devices, list)
408             if (tmp->lct_data.user_tid == i2o_dev->lct_data.tid)
409                 sysfs_create_link(&tmp->device.kobj,
410                                   &i2o_dev->device.kobj, "user");
411
412         /* create parent entries for this device */
413         tmp = i2o_iop_find_device(i2o_dev->iop, i2o_dev->lct_data.parent_tid);
414         if (tmp)
415                 sysfs_create_link(&i2o_dev->device.kobj, &tmp->device.kobj,
416                                   "parent");
417
418         /* create parent entries refering to this device */
419         list_for_each_entry(tmp, &c->devices, list)
420             if (tmp->lct_data.parent_tid == i2o_dev->lct_data.tid)
421                 sysfs_create_link(&tmp->device.kobj,
422                                   &i2o_dev->device.kobj, "parent");
423
424         return 0;
425 };
426
427 /* I2O device class interface */
428 static struct class_interface i2o_device_class_interface = {
429         .class = &i2o_device_class,
430         .add = i2o_device_class_add
431 };
432
433 /*
434  *      Run time support routines
435  */
436
437 /*      Issue UTIL_PARAMS_GET or UTIL_PARAMS_SET
438  *
439  *      This function can be used for all UtilParamsGet/Set operations.
440  *      The OperationList is given in oplist-buffer,
441  *      and results are returned in reslist-buffer.
442  *      Note that the minimum sized reslist is 8 bytes and contains
443  *      ResultCount, ErrorInfoSize, BlockStatus and BlockSize.
444  */
445
446 int i2o_parm_issue(struct i2o_device *i2o_dev, int cmd, void *oplist,
447                    int oplen, void *reslist, int reslen)
448 {
449         struct i2o_message *msg;
450         u32 m;
451         u32 *res32 = (u32 *) reslist;
452         u32 *restmp = (u32 *) reslist;
453         int len = 0;
454         int i = 0;
455         int rc;
456         struct i2o_dma res;
457         struct i2o_controller *c = i2o_dev->iop;
458         struct device *dev = &c->pdev->dev;
459
460         res.virt = NULL;
461
462         if (i2o_dma_alloc(dev, &res, reslen, GFP_KERNEL))
463                 return -ENOMEM;
464
465         m = i2o_msg_get_wait(c, &msg, I2O_TIMEOUT_MESSAGE_GET);
466         if (m == I2O_QUEUE_EMPTY) {
467                 i2o_dma_free(dev, &res);
468                 return -ETIMEDOUT;
469         }
470
471         i = 0;
472         writel(cmd << 24 | HOST_TID << 12 | i2o_dev->lct_data.tid,
473                &msg->u.head[1]);
474         writel(0, &msg->body[i++]);
475         writel(0x4C000000 | oplen, &msg->body[i++]);    /* OperationList */
476         memcpy_toio(&msg->body[i], oplist, oplen);
477         i += (oplen / 4 + (oplen % 4 ? 1 : 0));
478         writel(0xD0000000 | res.len, &msg->body[i++]);  /* ResultList */
479         writel(res.phys, &msg->body[i++]);
480
481         writel(I2O_MESSAGE_SIZE(i + sizeof(struct i2o_message) / 4) |
482                SGL_OFFSET_5, &msg->u.head[0]);
483
484         rc = i2o_msg_post_wait_mem(c, m, 10, &res);
485
486         /* This only looks like a memory leak - don't "fix" it. */
487         if (rc == -ETIMEDOUT)
488                 return rc;
489
490         memcpy_fromio(reslist, res.virt, res.len);
491         i2o_dma_free(dev, &res);
492
493         /* Query failed */
494         if (rc)
495                 return rc;
496         /*
497          * Calculate number of bytes of Result LIST
498          * We need to loop through each Result BLOCK and grab the length
499          */
500         restmp = res32 + 1;
501         len = 1;
502         for (i = 0; i < (res32[0] & 0X0000FFFF); i++) {
503                 if (restmp[0] & 0x00FF0000) {   /* BlockStatus != SUCCESS */
504                         printk(KERN_WARNING
505                                "%s - Error:\n  ErrorInfoSize = 0x%02x, "
506                                "BlockStatus = 0x%02x, BlockSize = 0x%04x\n",
507                                (cmd ==
508                                 I2O_CMD_UTIL_PARAMS_SET) ? "PARAMS_SET" :
509                                "PARAMS_GET", res32[1] >> 24,
510                                (res32[1] >> 16) & 0xFF, res32[1] & 0xFFFF);
511
512                         /*
513                          *      If this is the only request,than we return an error
514                          */
515                         if ((res32[0] & 0x0000FFFF) == 1) {
516                                 return -((res32[1] >> 16) & 0xFF);      /* -BlockStatus */
517                         }
518                 }
519                 len += restmp[0] & 0x0000FFFF;  /* Length of res BLOCK */
520                 restmp += restmp[0] & 0x0000FFFF;       /* Skip to next BLOCK */
521         }
522         return (len << 2);      /* bytes used by result list */
523 }
524
525 /*
526  *       Query one field group value or a whole scalar group.
527  */
528 int i2o_parm_field_get(struct i2o_device *i2o_dev, int group, int field,
529                        void *buf, int buflen)
530 {
531         u16 opblk[] = { 1, 0, I2O_PARAMS_FIELD_GET, group, 1, field };
532         u8 resblk[8 + buflen];  /* 8 bytes for header */
533         int size;
534
535         if (field == -1)        /* whole group */
536                 opblk[4] = -1;
537
538         size = i2o_parm_issue(i2o_dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
539                               sizeof(opblk), resblk, sizeof(resblk));
540
541         memcpy(buf, resblk + 8, buflen);        /* cut off header */
542
543         if (size > buflen)
544                 return buflen;
545
546         return size;
547 }
548
549 /*
550  *      Set a scalar group value or a whole group.
551  */
552 int i2o_parm_field_set(struct i2o_device *i2o_dev, int group, int field,
553                        void *buf, int buflen)
554 {
555         u16 *opblk;
556         u8 resblk[8 + buflen];  /* 8 bytes for header */
557         int size;
558
559         opblk = kmalloc(buflen + 64, GFP_KERNEL);
560         if (opblk == NULL) {
561                 printk(KERN_ERR "i2o: no memory for operation buffer.\n");
562                 return -ENOMEM;
563         }
564
565         opblk[0] = 1;           /* operation count */
566         opblk[1] = 0;           /* pad */
567         opblk[2] = I2O_PARAMS_FIELD_SET;
568         opblk[3] = group;
569
570         if (field == -1) {      /* whole group */
571                 opblk[4] = -1;
572                 memcpy(opblk + 5, buf, buflen);
573         } else {                /* single field */
574
575                 opblk[4] = 1;
576                 opblk[5] = field;
577                 memcpy(opblk + 6, buf, buflen);
578         }
579
580         size = i2o_parm_issue(i2o_dev, I2O_CMD_UTIL_PARAMS_SET, opblk,
581                               12 + buflen, resblk, sizeof(resblk));
582
583         kfree(opblk);
584         if (size > buflen)
585                 return buflen;
586
587         return size;
588 }
589
590 /*
591  *      if oper == I2O_PARAMS_TABLE_GET, get from all rows
592  *              if fieldcount == -1 return all fields
593  *                      ibuf and ibuflen are unused (use NULL, 0)
594  *              else return specific fields
595  *                      ibuf contains fieldindexes
596  *
597  *      if oper == I2O_PARAMS_LIST_GET, get from specific rows
598  *              if fieldcount == -1 return all fields
599  *                      ibuf contains rowcount, keyvalues
600  *              else return specific fields
601  *                      fieldcount is # of fieldindexes
602  *                      ibuf contains fieldindexes, rowcount, keyvalues
603  *
604  *      You could also use directly function i2o_issue_params().
605  */
606 int i2o_parm_table_get(struct i2o_device *dev, int oper, int group,
607                        int fieldcount, void *ibuf, int ibuflen, void *resblk,
608                        int reslen)
609 {
610         u16 *opblk;
611         int size;
612
613         size = 10 + ibuflen;
614         if (size % 4)
615                 size += 4 - size % 4;
616
617         opblk = kmalloc(size, GFP_KERNEL);
618         if (opblk == NULL) {
619                 printk(KERN_ERR "i2o: no memory for query buffer.\n");
620                 return -ENOMEM;
621         }
622
623         opblk[0] = 1;           /* operation count */
624         opblk[1] = 0;           /* pad */
625         opblk[2] = oper;
626         opblk[3] = group;
627         opblk[4] = fieldcount;
628         memcpy(opblk + 5, ibuf, ibuflen);       /* other params */
629
630         size = i2o_parm_issue(dev, I2O_CMD_UTIL_PARAMS_GET, opblk,
631                               size, resblk, reslen);
632
633         kfree(opblk);
634         if (size > reslen)
635                 return reslen;
636
637         return size;
638 }
639
640 /**
641  *      i2o_device_init - Initialize I2O devices
642  *
643  *      Registers the I2O device class.
644  *
645  *      Returns 0 on success or negative error code on failure.
646  */
647 int i2o_device_init(void)
648 {
649         int rc;
650
651         rc = class_register(&i2o_device_class);
652         if (rc)
653                 return rc;
654
655         return class_interface_register(&i2o_device_class_interface);
656 };
657
658 /**
659  *      i2o_device_exit - I2O devices exit function
660  *
661  *      Unregisters the I2O device class.
662  */
663 void i2o_device_exit(void)
664 {
665         class_interface_register(&i2o_device_class_interface);
666         class_unregister(&i2o_device_class);
667 };
668
669 EXPORT_SYMBOL(i2o_device_claim);
670 EXPORT_SYMBOL(i2o_device_claim_release);
671 EXPORT_SYMBOL(i2o_parm_field_get);
672 EXPORT_SYMBOL(i2o_parm_field_set);
673 EXPORT_SYMBOL(i2o_parm_table_get);
674 EXPORT_SYMBOL(i2o_parm_issue);