1 /*
2 * file for managing the edac_device subsystem of devices for EDAC
3 *
4 * (C) 2007 SoftwareBitMaker
5 *
6 * This file may be distributed under the terms of the
7 * GNU General Public License.
8 *
9 * Written Doug Thompson <norsk5@xmission.com>
10 *
11 */
12
13 #include <linux/ctype.h>
14 #include <linux/module.h>
15 #include <linux/slab.h>
16 #include <linux/edac.h>
17
18 #include "edac_core.h"
19 #include "edac_module.h"
20
21 #define EDAC_DEVICE_SYMLINK "device"
22
23 #define to_edacdev(k) container_of(k, struct edac_device_ctl_info, kobj)
24 #define to_edacdev_attr(a) container_of(a, struct edacdev_attribute, attr)
25
26
27 /*
28 * Set of edac_device_ctl_info attribute store/show functions
29 */
30
31 /* 'log_ue' */
edac_device_ctl_log_ue_show(struct edac_device_ctl_info * ctl_info,char * data)32 static ssize_t edac_device_ctl_log_ue_show(struct edac_device_ctl_info
33 *ctl_info, char *data)
34 {
35 return sprintf(data, "%u\n", ctl_info->log_ue);
36 }
37
edac_device_ctl_log_ue_store(struct edac_device_ctl_info * ctl_info,const char * data,size_t count)38 static ssize_t edac_device_ctl_log_ue_store(struct edac_device_ctl_info
39 *ctl_info, const char *data,
40 size_t count)
41 {
42 /* if parameter is zero, turn off flag, if non-zero turn on flag */
43 ctl_info->log_ue = (simple_strtoul(data, NULL, 0) != 0);
44
45 return count;
46 }
47
48 /* 'log_ce' */
edac_device_ctl_log_ce_show(struct edac_device_ctl_info * ctl_info,char * data)49 static ssize_t edac_device_ctl_log_ce_show(struct edac_device_ctl_info
50 *ctl_info, char *data)
51 {
52 return sprintf(data, "%u\n", ctl_info->log_ce);
53 }
54
edac_device_ctl_log_ce_store(struct edac_device_ctl_info * ctl_info,const char * data,size_t count)55 static ssize_t edac_device_ctl_log_ce_store(struct edac_device_ctl_info
56 *ctl_info, const char *data,
57 size_t count)
58 {
59 /* if parameter is zero, turn off flag, if non-zero turn on flag */
60 ctl_info->log_ce = (simple_strtoul(data, NULL, 0) != 0);
61
62 return count;
63 }
64
65 /* 'panic_on_ue' */
edac_device_ctl_panic_on_ue_show(struct edac_device_ctl_info * ctl_info,char * data)66 static ssize_t edac_device_ctl_panic_on_ue_show(struct edac_device_ctl_info
67 *ctl_info, char *data)
68 {
69 return sprintf(data, "%u\n", ctl_info->panic_on_ue);
70 }
71
edac_device_ctl_panic_on_ue_store(struct edac_device_ctl_info * ctl_info,const char * data,size_t count)72 static ssize_t edac_device_ctl_panic_on_ue_store(struct edac_device_ctl_info
73 *ctl_info, const char *data,
74 size_t count)
75 {
76 /* if parameter is zero, turn off flag, if non-zero turn on flag */
77 ctl_info->panic_on_ue = (simple_strtoul(data, NULL, 0) != 0);
78
79 return count;
80 }
81
82 /* 'poll_msec' show and store functions*/
edac_device_ctl_poll_msec_show(struct edac_device_ctl_info * ctl_info,char * data)83 static ssize_t edac_device_ctl_poll_msec_show(struct edac_device_ctl_info
84 *ctl_info, char *data)
85 {
86 return sprintf(data, "%u\n", ctl_info->poll_msec);
87 }
88
edac_device_ctl_poll_msec_store(struct edac_device_ctl_info * ctl_info,const char * data,size_t count)89 static ssize_t edac_device_ctl_poll_msec_store(struct edac_device_ctl_info
90 *ctl_info, const char *data,
91 size_t count)
92 {
93 unsigned long value;
94
95 /* get the value and enforce that it is non-zero, must be at least
96 * one millisecond for the delay period, between scans
97 * Then cancel last outstanding delay for the work request
98 * and set a new one.
99 */
100 value = simple_strtoul(data, NULL, 0);
101 edac_device_reset_delay_period(ctl_info, value);
102
103 return count;
104 }
105
106 /* edac_device_ctl_info specific attribute structure */
107 struct ctl_info_attribute {
108 struct attribute attr;
109 ssize_t(*show) (struct edac_device_ctl_info *, char *);
110 ssize_t(*store) (struct edac_device_ctl_info *, const char *, size_t);
111 };
112
113 #define to_ctl_info(k) container_of(k, struct edac_device_ctl_info, kobj)
114 #define to_ctl_info_attr(a) container_of(a,struct ctl_info_attribute,attr)
115
116 /* Function to 'show' fields from the edac_dev 'ctl_info' structure */
edac_dev_ctl_info_show(struct kobject * kobj,struct attribute * attr,char * buffer)117 static ssize_t edac_dev_ctl_info_show(struct kobject *kobj,
118 struct attribute *attr, char *buffer)
119 {
120 struct edac_device_ctl_info *edac_dev = to_ctl_info(kobj);
121 struct ctl_info_attribute *ctl_info_attr = to_ctl_info_attr(attr);
122
123 if (ctl_info_attr->show)
124 return ctl_info_attr->show(edac_dev, buffer);
125 return -EIO;
126 }
127
128 /* Function to 'store' fields into the edac_dev 'ctl_info' structure */
edac_dev_ctl_info_store(struct kobject * kobj,struct attribute * attr,const char * buffer,size_t count)129 static ssize_t edac_dev_ctl_info_store(struct kobject *kobj,
130 struct attribute *attr,
131 const char *buffer, size_t count)
132 {
133 struct edac_device_ctl_info *edac_dev = to_ctl_info(kobj);
134 struct ctl_info_attribute *ctl_info_attr = to_ctl_info_attr(attr);
135
136 if (ctl_info_attr->store)
137 return ctl_info_attr->store(edac_dev, buffer, count);
138 return -EIO;
139 }
140
141 /* edac_dev file operations for an 'ctl_info' */
142 static const struct sysfs_ops device_ctl_info_ops = {
143 .show = edac_dev_ctl_info_show,
144 .store = edac_dev_ctl_info_store
145 };
146
147 #define CTL_INFO_ATTR(_name,_mode,_show,_store) \
148 static struct ctl_info_attribute attr_ctl_info_##_name = { \
149 .attr = {.name = __stringify(_name), .mode = _mode }, \
150 .show = _show, \
151 .store = _store, \
152 };
153
154 /* Declare the various ctl_info attributes here and their respective ops */
155 CTL_INFO_ATTR(log_ue, S_IRUGO | S_IWUSR,
156 edac_device_ctl_log_ue_show, edac_device_ctl_log_ue_store);
157 CTL_INFO_ATTR(log_ce, S_IRUGO | S_IWUSR,
158 edac_device_ctl_log_ce_show, edac_device_ctl_log_ce_store);
159 CTL_INFO_ATTR(panic_on_ue, S_IRUGO | S_IWUSR,
160 edac_device_ctl_panic_on_ue_show,
161 edac_device_ctl_panic_on_ue_store);
162 CTL_INFO_ATTR(poll_msec, S_IRUGO | S_IWUSR,
163 edac_device_ctl_poll_msec_show, edac_device_ctl_poll_msec_store);
164
165 /* Base Attributes of the EDAC_DEVICE ECC object */
166 static struct ctl_info_attribute *device_ctrl_attr[] = {
167 &attr_ctl_info_panic_on_ue,
168 &attr_ctl_info_log_ue,
169 &attr_ctl_info_log_ce,
170 &attr_ctl_info_poll_msec,
171 NULL,
172 };
173
174 /*
175 * edac_device_ctrl_master_release
176 *
177 * called when the reference count for the 'main' kobj
178 * for a edac_device control struct reaches zero
179 *
180 * Reference count model:
181 * One 'main' kobject for each control structure allocated.
182 * That main kobj is initially set to one AND
183 * the reference count for the EDAC 'core' module is
184 * bumped by one, thus added 'keep in memory' dependency.
185 *
186 * Each new internal kobj (in instances and blocks) then
187 * bumps the 'main' kobject.
188 *
189 * When they are released their release functions decrement
190 * the 'main' kobj.
191 *
192 * When the main kobj reaches zero (0) then THIS function
193 * is called which then decrements the EDAC 'core' module.
194 * When the module reference count reaches zero then the
195 * module no longer has dependency on keeping the release
196 * function code in memory and module can be unloaded.
197 *
198 * This will support several control objects as well, each
199 * with its own 'main' kobj.
200 */
edac_device_ctrl_master_release(struct kobject * kobj)201 static void edac_device_ctrl_master_release(struct kobject *kobj)
202 {
203 struct edac_device_ctl_info *edac_dev = to_edacdev(kobj);
204
205 edac_dbg(4, "control index=%d\n", edac_dev->dev_idx);
206
207 /* decrement the EDAC CORE module ref count */
208 module_put(edac_dev->owner);
209
210 /* free the control struct containing the 'main' kobj
211 * passed in to this routine
212 */
213 kfree(edac_dev);
214 }
215
216 /* ktype for the main (master) kobject */
217 static struct kobj_type ktype_device_ctrl = {
218 .release = edac_device_ctrl_master_release,
219 .sysfs_ops = &device_ctl_info_ops,
220 .default_attrs = (struct attribute **)device_ctrl_attr,
221 };
222
223 /*
224 * edac_device_register_sysfs_main_kobj
225 *
226 * perform the high level setup for the new edac_device instance
227 *
228 * Return: 0 SUCCESS
229 * !0 FAILURE
230 */
edac_device_register_sysfs_main_kobj(struct edac_device_ctl_info * edac_dev)231 int edac_device_register_sysfs_main_kobj(struct edac_device_ctl_info *edac_dev)
232 {
233 struct bus_type *edac_subsys;
234 int err;
235
236 edac_dbg(1, "\n");
237
238 /* get the /sys/devices/system/edac reference */
239 edac_subsys = edac_get_sysfs_subsys();
240 if (edac_subsys == NULL) {
241 edac_dbg(1, "no edac_subsys error\n");
242 err = -ENODEV;
243 goto err_out;
244 }
245
246 /* Point to the 'edac_subsys' this instance 'reports' to */
247 edac_dev->edac_subsys = edac_subsys;
248
249 /* Init the devices's kobject */
250 memset(&edac_dev->kobj, 0, sizeof(struct kobject));
251
252 /* Record which module 'owns' this control structure
253 * and bump the ref count of the module
254 */
255 edac_dev->owner = THIS_MODULE;
256
257 if (!try_module_get(edac_dev->owner)) {
258 err = -ENODEV;
259 goto err_mod_get;
260 }
261
262 /* register */
263 err = kobject_init_and_add(&edac_dev->kobj, &ktype_device_ctrl,
264 &edac_subsys->dev_root->kobj,
265 "%s", edac_dev->name);
266 if (err) {
267 edac_dbg(1, "Failed to register '.../edac/%s'\n",
268 edac_dev->name);
269 goto err_kobj_reg;
270 }
271 kobject_uevent(&edac_dev->kobj, KOBJ_ADD);
272
273 /* At this point, to 'free' the control struct,
274 * edac_device_unregister_sysfs_main_kobj() must be used
275 */
276
277 edac_dbg(4, "Registered '.../edac/%s' kobject\n", edac_dev->name);
278
279 return 0;
280
281 /* Error exit stack */
282 err_kobj_reg:
283 kobject_put(&edac_dev->kobj);
284 module_put(edac_dev->owner);
285
286 err_mod_get:
287 edac_put_sysfs_subsys();
288
289 err_out:
290 return err;
291 }
292
293 /*
294 * edac_device_unregister_sysfs_main_kobj:
295 * the '..../edac/<name>' kobject
296 */
edac_device_unregister_sysfs_main_kobj(struct edac_device_ctl_info * dev)297 void edac_device_unregister_sysfs_main_kobj(struct edac_device_ctl_info *dev)
298 {
299 edac_dbg(0, "\n");
300 edac_dbg(4, "name of kobject is: %s\n", kobject_name(&dev->kobj));
301
302 /*
303 * Unregister the edac device's kobject and
304 * allow for reference count to reach 0 at which point
305 * the callback will be called to:
306 * a) module_put() this module
307 * b) 'kfree' the memory
308 */
309 kobject_put(&dev->kobj);
310 edac_put_sysfs_subsys();
311 }
312
313 /* edac_dev -> instance information */
314
315 /*
316 * Set of low-level instance attribute show functions
317 */
instance_ue_count_show(struct edac_device_instance * instance,char * data)318 static ssize_t instance_ue_count_show(struct edac_device_instance *instance,
319 char *data)
320 {
321 return sprintf(data, "%u\n", instance->counters.ue_count);
322 }
323
instance_ce_count_show(struct edac_device_instance * instance,char * data)324 static ssize_t instance_ce_count_show(struct edac_device_instance *instance,
325 char *data)
326 {
327 return sprintf(data, "%u\n", instance->counters.ce_count);
328 }
329
330 #define to_instance(k) container_of(k, struct edac_device_instance, kobj)
331 #define to_instance_attr(a) container_of(a,struct instance_attribute,attr)
332
333 /* DEVICE instance kobject release() function */
edac_device_ctrl_instance_release(struct kobject * kobj)334 static void edac_device_ctrl_instance_release(struct kobject *kobj)
335 {
336 struct edac_device_instance *instance;
337
338 edac_dbg(1, "\n");
339
340 /* map from this kobj to the main control struct
341 * and then dec the main kobj count
342 */
343 instance = to_instance(kobj);
344 kobject_put(&instance->ctl->kobj);
345 }
346
347 /* instance specific attribute structure */
348 struct instance_attribute {
349 struct attribute attr;
350 ssize_t(*show) (struct edac_device_instance *, char *);
351 ssize_t(*store) (struct edac_device_instance *, const char *, size_t);
352 };
353
354 /* Function to 'show' fields from the edac_dev 'instance' structure */
edac_dev_instance_show(struct kobject * kobj,struct attribute * attr,char * buffer)355 static ssize_t edac_dev_instance_show(struct kobject *kobj,
356 struct attribute *attr, char *buffer)
357 {
358 struct edac_device_instance *instance = to_instance(kobj);
359 struct instance_attribute *instance_attr = to_instance_attr(attr);
360
361 if (instance_attr->show)
362 return instance_attr->show(instance, buffer);
363 return -EIO;
364 }
365
366 /* Function to 'store' fields into the edac_dev 'instance' structure */
edac_dev_instance_store(struct kobject * kobj,struct attribute * attr,const char * buffer,size_t count)367 static ssize_t edac_dev_instance_store(struct kobject *kobj,
368 struct attribute *attr,
369 const char *buffer, size_t count)
370 {
371 struct edac_device_instance *instance = to_instance(kobj);
372 struct instance_attribute *instance_attr = to_instance_attr(attr);
373
374 if (instance_attr->store)
375 return instance_attr->store(instance, buffer, count);
376 return -EIO;
377 }
378
379 /* edac_dev file operations for an 'instance' */
380 static const struct sysfs_ops device_instance_ops = {
381 .show = edac_dev_instance_show,
382 .store = edac_dev_instance_store
383 };
384
385 #define INSTANCE_ATTR(_name,_mode,_show,_store) \
386 static struct instance_attribute attr_instance_##_name = { \
387 .attr = {.name = __stringify(_name), .mode = _mode }, \
388 .show = _show, \
389 .store = _store, \
390 };
391
392 /*
393 * Define attributes visible for the edac_device instance object
394 * Each contains a pointer to a show and an optional set
395 * function pointer that does the low level output/input
396 */
397 INSTANCE_ATTR(ce_count, S_IRUGO, instance_ce_count_show, NULL);
398 INSTANCE_ATTR(ue_count, S_IRUGO, instance_ue_count_show, NULL);
399
400 /* list of edac_dev 'instance' attributes */
401 static struct instance_attribute *device_instance_attr[] = {
402 &attr_instance_ce_count,
403 &attr_instance_ue_count,
404 NULL,
405 };
406
407 /* The 'ktype' for each edac_dev 'instance' */
408 static struct kobj_type ktype_instance_ctrl = {
409 .release = edac_device_ctrl_instance_release,
410 .sysfs_ops = &device_instance_ops,
411 .default_attrs = (struct attribute **)device_instance_attr,
412 };
413
414 /* edac_dev -> instance -> block information */
415
416 #define to_block(k) container_of(k, struct edac_device_block, kobj)
417 #define to_block_attr(a) \
418 container_of(a, struct edac_dev_sysfs_block_attribute, attr)
419
420 /*
421 * Set of low-level block attribute show functions
422 */
block_ue_count_show(struct kobject * kobj,struct attribute * attr,char * data)423 static ssize_t block_ue_count_show(struct kobject *kobj,
424 struct attribute *attr, char *data)
425 {
426 struct edac_device_block *block = to_block(kobj);
427
428 return sprintf(data, "%u\n", block->counters.ue_count);
429 }
430
block_ce_count_show(struct kobject * kobj,struct attribute * attr,char * data)431 static ssize_t block_ce_count_show(struct kobject *kobj,
432 struct attribute *attr, char *data)
433 {
434 struct edac_device_block *block = to_block(kobj);
435
436 return sprintf(data, "%u\n", block->counters.ce_count);
437 }
438
439 /* DEVICE block kobject release() function */
edac_device_ctrl_block_release(struct kobject * kobj)440 static void edac_device_ctrl_block_release(struct kobject *kobj)
441 {
442 struct edac_device_block *block;
443
444 edac_dbg(1, "\n");
445
446 /* get the container of the kobj */
447 block = to_block(kobj);
448
449 /* map from 'block kobj' to 'block->instance->controller->main_kobj'
450 * now 'release' the block kobject
451 */
452 kobject_put(&block->instance->ctl->kobj);
453 }
454
455
456 /* Function to 'show' fields from the edac_dev 'block' structure */
edac_dev_block_show(struct kobject * kobj,struct attribute * attr,char * buffer)457 static ssize_t edac_dev_block_show(struct kobject *kobj,
458 struct attribute *attr, char *buffer)
459 {
460 struct edac_dev_sysfs_block_attribute *block_attr =
461 to_block_attr(attr);
462
463 if (block_attr->show)
464 return block_attr->show(kobj, attr, buffer);
465 return -EIO;
466 }
467
468 /* Function to 'store' fields into the edac_dev 'block' structure */
edac_dev_block_store(struct kobject * kobj,struct attribute * attr,const char * buffer,size_t count)469 static ssize_t edac_dev_block_store(struct kobject *kobj,
470 struct attribute *attr,
471 const char *buffer, size_t count)
472 {
473 struct edac_dev_sysfs_block_attribute *block_attr;
474
475 block_attr = to_block_attr(attr);
476
477 if (block_attr->store)
478 return block_attr->store(kobj, attr, buffer, count);
479 return -EIO;
480 }
481
482 /* edac_dev file operations for a 'block' */
483 static const struct sysfs_ops device_block_ops = {
484 .show = edac_dev_block_show,
485 .store = edac_dev_block_store
486 };
487
488 #define BLOCK_ATTR(_name,_mode,_show,_store) \
489 static struct edac_dev_sysfs_block_attribute attr_block_##_name = { \
490 .attr = {.name = __stringify(_name), .mode = _mode }, \
491 .show = _show, \
492 .store = _store, \
493 };
494
495 BLOCK_ATTR(ce_count, S_IRUGO, block_ce_count_show, NULL);
496 BLOCK_ATTR(ue_count, S_IRUGO, block_ue_count_show, NULL);
497
498 /* list of edac_dev 'block' attributes */
499 static struct edac_dev_sysfs_block_attribute *device_block_attr[] = {
500 &attr_block_ce_count,
501 &attr_block_ue_count,
502 NULL,
503 };
504
505 /* The 'ktype' for each edac_dev 'block' */
506 static struct kobj_type ktype_block_ctrl = {
507 .release = edac_device_ctrl_block_release,
508 .sysfs_ops = &device_block_ops,
509 .default_attrs = (struct attribute **)device_block_attr,
510 };
511
512 /* block ctor/dtor code */
513
514 /*
515 * edac_device_create_block
516 */
edac_device_create_block(struct edac_device_ctl_info * edac_dev,struct edac_device_instance * instance,struct edac_device_block * block)517 static int edac_device_create_block(struct edac_device_ctl_info *edac_dev,
518 struct edac_device_instance *instance,
519 struct edac_device_block *block)
520 {
521 int i;
522 int err;
523 struct edac_dev_sysfs_block_attribute *sysfs_attrib;
524 struct kobject *main_kobj;
525
526 edac_dbg(4, "Instance '%s' inst_p=%p block '%s' block_p=%p\n",
527 instance->name, instance, block->name, block);
528 edac_dbg(4, "block kobj=%p block kobj->parent=%p\n",
529 &block->kobj, &block->kobj.parent);
530
531 /* init this block's kobject */
532 memset(&block->kobj, 0, sizeof(struct kobject));
533
534 /* bump the main kobject's reference count for this controller
535 * and this instance is dependent on the main
536 */
537 main_kobj = kobject_get(&edac_dev->kobj);
538 if (!main_kobj) {
539 err = -ENODEV;
540 goto err_out;
541 }
542
543 /* Add this block's kobject */
544 err = kobject_init_and_add(&block->kobj, &ktype_block_ctrl,
545 &instance->kobj,
546 "%s", block->name);
547 if (err) {
548 edac_dbg(1, "Failed to register instance '%s'\n", block->name);
549 kobject_put(main_kobj);
550 err = -ENODEV;
551 goto err_out;
552 }
553
554 /* If there are driver level block attributes, then added them
555 * to the block kobject
556 */
557 sysfs_attrib = block->block_attributes;
558 if (sysfs_attrib && block->nr_attribs) {
559 for (i = 0; i < block->nr_attribs; i++, sysfs_attrib++) {
560
561 edac_dbg(4, "creating block attrib='%s' attrib->%p to kobj=%p\n",
562 sysfs_attrib->attr.name,
563 sysfs_attrib, &block->kobj);
564
565 /* Create each block_attribute file */
566 err = sysfs_create_file(&block->kobj,
567 &sysfs_attrib->attr);
568 if (err)
569 goto err_on_attrib;
570 }
571 }
572 kobject_uevent(&block->kobj, KOBJ_ADD);
573
574 return 0;
575
576 /* Error unwind stack */
577 err_on_attrib:
578 kobject_put(&block->kobj);
579
580 err_out:
581 return err;
582 }
583
584 /*
585 * edac_device_delete_block(edac_dev,block);
586 */
edac_device_delete_block(struct edac_device_ctl_info * edac_dev,struct edac_device_block * block)587 static void edac_device_delete_block(struct edac_device_ctl_info *edac_dev,
588 struct edac_device_block *block)
589 {
590 struct edac_dev_sysfs_block_attribute *sysfs_attrib;
591 int i;
592
593 /* if this block has 'attributes' then we need to iterate over the list
594 * and 'remove' the attributes on this block
595 */
596 sysfs_attrib = block->block_attributes;
597 if (sysfs_attrib && block->nr_attribs) {
598 for (i = 0; i < block->nr_attribs; i++, sysfs_attrib++) {
599
600 /* remove each block_attrib file */
601 sysfs_remove_file(&block->kobj,
602 (struct attribute *) sysfs_attrib);
603 }
604 }
605
606 /* unregister this block's kobject, SEE:
607 * edac_device_ctrl_block_release() callback operation
608 */
609 kobject_put(&block->kobj);
610 }
611
612 /* instance ctor/dtor code */
613
614 /*
615 * edac_device_create_instance
616 * create just one instance of an edac_device 'instance'
617 */
edac_device_create_instance(struct edac_device_ctl_info * edac_dev,int idx)618 static int edac_device_create_instance(struct edac_device_ctl_info *edac_dev,
619 int idx)
620 {
621 int i, j;
622 int err;
623 struct edac_device_instance *instance;
624 struct kobject *main_kobj;
625
626 instance = &edac_dev->instances[idx];
627
628 /* Init the instance's kobject */
629 memset(&instance->kobj, 0, sizeof(struct kobject));
630
631 instance->ctl = edac_dev;
632
633 /* bump the main kobject's reference count for this controller
634 * and this instance is dependent on the main
635 */
636 main_kobj = kobject_get(&edac_dev->kobj);
637 if (!main_kobj) {
638 err = -ENODEV;
639 goto err_out;
640 }
641
642 /* Formally register this instance's kobject under the edac_device */
643 err = kobject_init_and_add(&instance->kobj, &ktype_instance_ctrl,
644 &edac_dev->kobj, "%s", instance->name);
645 if (err != 0) {
646 edac_dbg(2, "Failed to register instance '%s'\n",
647 instance->name);
648 kobject_put(main_kobj);
649 goto err_out;
650 }
651
652 edac_dbg(4, "now register '%d' blocks for instance %d\n",
653 instance->nr_blocks, idx);
654
655 /* register all blocks of this instance */
656 for (i = 0; i < instance->nr_blocks; i++) {
657 err = edac_device_create_block(edac_dev, instance,
658 &instance->blocks[i]);
659 if (err) {
660 /* If any fail, remove all previous ones */
661 for (j = 0; j < i; j++)
662 edac_device_delete_block(edac_dev,
663 &instance->blocks[j]);
664 goto err_release_instance_kobj;
665 }
666 }
667 kobject_uevent(&instance->kobj, KOBJ_ADD);
668
669 edac_dbg(4, "Registered instance %d '%s' kobject\n",
670 idx, instance->name);
671
672 return 0;
673
674 /* error unwind stack */
675 err_release_instance_kobj:
676 kobject_put(&instance->kobj);
677
678 err_out:
679 return err;
680 }
681
682 /*
683 * edac_device_remove_instance
684 * remove an edac_device instance
685 */
edac_device_delete_instance(struct edac_device_ctl_info * edac_dev,int idx)686 static void edac_device_delete_instance(struct edac_device_ctl_info *edac_dev,
687 int idx)
688 {
689 struct edac_device_instance *instance;
690 int i;
691
692 instance = &edac_dev->instances[idx];
693
694 /* unregister all blocks in this instance */
695 for (i = 0; i < instance->nr_blocks; i++)
696 edac_device_delete_block(edac_dev, &instance->blocks[i]);
697
698 /* unregister this instance's kobject, SEE:
699 * edac_device_ctrl_instance_release() for callback operation
700 */
701 kobject_put(&instance->kobj);
702 }
703
704 /*
705 * edac_device_create_instances
706 * create the first level of 'instances' for this device
707 * (ie 'cache' might have 'cache0', 'cache1', 'cache2', etc
708 */
edac_device_create_instances(struct edac_device_ctl_info * edac_dev)709 static int edac_device_create_instances(struct edac_device_ctl_info *edac_dev)
710 {
711 int i, j;
712 int err;
713
714 edac_dbg(0, "\n");
715
716 /* iterate over creation of the instances */
717 for (i = 0; i < edac_dev->nr_instances; i++) {
718 err = edac_device_create_instance(edac_dev, i);
719 if (err) {
720 /* unwind previous instances on error */
721 for (j = 0; j < i; j++)
722 edac_device_delete_instance(edac_dev, j);
723 return err;
724 }
725 }
726
727 return 0;
728 }
729
730 /*
731 * edac_device_delete_instances(edac_dev);
732 * unregister all the kobjects of the instances
733 */
edac_device_delete_instances(struct edac_device_ctl_info * edac_dev)734 static void edac_device_delete_instances(struct edac_device_ctl_info *edac_dev)
735 {
736 int i;
737
738 /* iterate over creation of the instances */
739 for (i = 0; i < edac_dev->nr_instances; i++)
740 edac_device_delete_instance(edac_dev, i);
741 }
742
743 /* edac_dev sysfs ctor/dtor code */
744
745 /*
746 * edac_device_add_main_sysfs_attributes
747 * add some attributes to this instance's main kobject
748 */
edac_device_add_main_sysfs_attributes(struct edac_device_ctl_info * edac_dev)749 static int edac_device_add_main_sysfs_attributes(
750 struct edac_device_ctl_info *edac_dev)
751 {
752 struct edac_dev_sysfs_attribute *sysfs_attrib;
753 int err = 0;
754
755 sysfs_attrib = edac_dev->sysfs_attributes;
756 if (sysfs_attrib) {
757 /* iterate over the array and create an attribute for each
758 * entry in the list
759 */
760 while (sysfs_attrib->attr.name != NULL) {
761 err = sysfs_create_file(&edac_dev->kobj,
762 (struct attribute*) sysfs_attrib);
763 if (err)
764 goto err_out;
765
766 sysfs_attrib++;
767 }
768 }
769
770 err_out:
771 return err;
772 }
773
774 /*
775 * edac_device_remove_main_sysfs_attributes
776 * remove any attributes to this instance's main kobject
777 */
edac_device_remove_main_sysfs_attributes(struct edac_device_ctl_info * edac_dev)778 static void edac_device_remove_main_sysfs_attributes(
779 struct edac_device_ctl_info *edac_dev)
780 {
781 struct edac_dev_sysfs_attribute *sysfs_attrib;
782
783 /* if there are main attributes, defined, remove them. First,
784 * point to the start of the array and iterate over it
785 * removing each attribute listed from this device's instance's kobject
786 */
787 sysfs_attrib = edac_dev->sysfs_attributes;
788 if (sysfs_attrib) {
789 while (sysfs_attrib->attr.name != NULL) {
790 sysfs_remove_file(&edac_dev->kobj,
791 (struct attribute *) sysfs_attrib);
792 sysfs_attrib++;
793 }
794 }
795 }
796
797 /*
798 * edac_device_create_sysfs() Constructor
799 *
800 * accept a created edac_device control structure
801 * and 'export' it to sysfs. The 'main' kobj should already have been
802 * created. 'instance' and 'block' kobjects should be registered
803 * along with any 'block' attributes from the low driver. In addition,
804 * the main attributes (if any) are connected to the main kobject of
805 * the control structure.
806 *
807 * Return:
808 * 0 Success
809 * !0 Failure
810 */
edac_device_create_sysfs(struct edac_device_ctl_info * edac_dev)811 int edac_device_create_sysfs(struct edac_device_ctl_info *edac_dev)
812 {
813 int err;
814 struct kobject *edac_kobj = &edac_dev->kobj;
815
816 edac_dbg(0, "idx=%d\n", edac_dev->dev_idx);
817
818 /* go create any main attributes callers wants */
819 err = edac_device_add_main_sysfs_attributes(edac_dev);
820 if (err) {
821 edac_dbg(0, "failed to add sysfs attribs\n");
822 goto err_out;
823 }
824
825 /* create a symlink from the edac device
826 * to the platform 'device' being used for this
827 */
828 err = sysfs_create_link(edac_kobj,
829 &edac_dev->dev->kobj, EDAC_DEVICE_SYMLINK);
830 if (err) {
831 edac_dbg(0, "sysfs_create_link() returned err= %d\n", err);
832 goto err_remove_main_attribs;
833 }
834
835 /* Create the first level instance directories
836 * In turn, the nested blocks beneath the instances will
837 * be registered as well
838 */
839 err = edac_device_create_instances(edac_dev);
840 if (err) {
841 edac_dbg(0, "edac_device_create_instances() returned err= %d\n",
842 err);
843 goto err_remove_link;
844 }
845
846
847 edac_dbg(4, "create-instances done, idx=%d\n", edac_dev->dev_idx);
848
849 return 0;
850
851 /* Error unwind stack */
852 err_remove_link:
853 /* remove the sym link */
854 sysfs_remove_link(&edac_dev->kobj, EDAC_DEVICE_SYMLINK);
855
856 err_remove_main_attribs:
857 edac_device_remove_main_sysfs_attributes(edac_dev);
858
859 err_out:
860 return err;
861 }
862
863 /*
864 * edac_device_remove_sysfs() destructor
865 *
866 * given an edac_device struct, tear down the kobject resources
867 */
edac_device_remove_sysfs(struct edac_device_ctl_info * edac_dev)868 void edac_device_remove_sysfs(struct edac_device_ctl_info *edac_dev)
869 {
870 edac_dbg(0, "\n");
871
872 /* remove any main attributes for this device */
873 edac_device_remove_main_sysfs_attributes(edac_dev);
874
875 /* remove the device sym link */
876 sysfs_remove_link(&edac_dev->kobj, EDAC_DEVICE_SYMLINK);
877
878 /* walk the instance/block kobject tree, deconstructing it */
879 edac_device_delete_instances(edac_dev);
880 }
881