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