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 #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 attribute *device_ctrl_attrs[] = {
167 	&attr_ctl_info_panic_on_ue.attr,
168 	&attr_ctl_info_log_ue.attr,
169 	&attr_ctl_info_log_ce.attr,
170 	&attr_ctl_info_poll_msec.attr,
171 	NULL,
172 };
173 ATTRIBUTE_GROUPS(device_ctrl);
174 
175 /*
176  * edac_device_ctrl_master_release
177  *
178  *	called when the reference count for the 'main' kobj
179  *	for a edac_device control struct reaches zero
180  *
181  *	Reference count model:
182  *		One 'main' kobject for each control structure allocated.
183  *		That main kobj is initially set to one AND
184  *		the reference count for the EDAC 'core' module is
185  *		bumped by one, thus added 'keep in memory' dependency.
186  *
187  *		Each new internal kobj (in instances and blocks) then
188  *		bumps the 'main' kobject.
189  *
190  *		When they are released their release functions decrement
191  *		the 'main' kobj.
192  *
193  *		When the main kobj reaches zero (0) then THIS function
194  *		is called which then decrements the EDAC 'core' module.
195  *		When the module reference count reaches zero then the
196  *		module no longer has dependency on keeping the release
197  *		function code in memory and module can be unloaded.
198  *
199  *		This will support several control objects as well, each
200  *		with its own 'main' kobj.
201  */
edac_device_ctrl_master_release(struct kobject * kobj)202 static void edac_device_ctrl_master_release(struct kobject *kobj)
203 {
204 	struct edac_device_ctl_info *edac_dev = to_edacdev(kobj);
205 
206 	edac_dbg(4, "control index=%d\n", edac_dev->dev_idx);
207 
208 	/* decrement the EDAC CORE module ref count */
209 	module_put(edac_dev->owner);
210 
211 	__edac_device_free_ctl_info(edac_dev);
212 }
213 
214 /* ktype for the main (master) kobject */
215 static struct kobj_type ktype_device_ctrl = {
216 	.release = edac_device_ctrl_master_release,
217 	.sysfs_ops = &device_ctl_info_ops,
218 	.default_groups = device_ctrl_groups,
219 };
220 
221 /*
222  * edac_device_register_sysfs_main_kobj
223  *
224  *	perform the high level setup for the new edac_device instance
225  *
226  * Return:  0 SUCCESS
227  *         !0 FAILURE
228  */
edac_device_register_sysfs_main_kobj(struct edac_device_ctl_info * edac_dev)229 int edac_device_register_sysfs_main_kobj(struct edac_device_ctl_info *edac_dev)
230 {
231 	struct bus_type *edac_subsys;
232 	int err;
233 
234 	edac_dbg(1, "\n");
235 
236 	/* get the /sys/devices/system/edac reference */
237 	edac_subsys = edac_get_sysfs_subsys();
238 
239 	/* Point to the 'edac_subsys' this instance 'reports' to */
240 	edac_dev->edac_subsys = edac_subsys;
241 
242 	/* Init the devices's kobject */
243 	memset(&edac_dev->kobj, 0, sizeof(struct kobject));
244 
245 	/* Record which module 'owns' this control structure
246 	 * and bump the ref count of the module
247 	 */
248 	edac_dev->owner = THIS_MODULE;
249 
250 	if (!try_module_get(edac_dev->owner)) {
251 		err = -ENODEV;
252 		goto err_out;
253 	}
254 
255 	/* register */
256 	err = kobject_init_and_add(&edac_dev->kobj, &ktype_device_ctrl,
257 				   &edac_subsys->dev_root->kobj,
258 				   "%s", edac_dev->name);
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  */
edac_device_unregister_sysfs_main_kobj(struct edac_device_ctl_info * dev)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  */
instance_ue_count_show(struct edac_device_instance * instance,char * data)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 
instance_ce_count_show(struct edac_device_instance * instance,char * data)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 */
edac_device_ctrl_instance_release(struct kobject * kobj)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 */
edac_dev_instance_show(struct kobject * kobj,struct attribute * attr,char * buffer)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 */
edac_dev_instance_store(struct kobject * kobj,struct attribute * attr,const char * buffer,size_t count)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  */
block_ue_count_show(struct kobject * kobj,struct attribute * attr,char * data)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 
block_ce_count_show(struct kobject * kobj,struct attribute * attr,char * data)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 */
edac_device_ctrl_block_release(struct kobject * kobj)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 */
edac_dev_block_show(struct kobject * kobj,struct attribute * attr,char * buffer)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 /* 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)459 static ssize_t edac_dev_block_store(struct kobject *kobj,
460 				struct attribute *attr,
461 				const char *buffer, size_t count)
462 {
463 	struct edac_dev_sysfs_block_attribute *block_attr;
464 
465 	block_attr = to_block_attr(attr);
466 
467 	if (block_attr->store)
468 		return block_attr->store(kobj, attr, buffer, count);
469 	return -EIO;
470 }
471 
472 /* edac_dev file operations for a 'block' */
473 static const struct sysfs_ops device_block_ops = {
474 	.show = edac_dev_block_show,
475 	.store = edac_dev_block_store
476 };
477 
478 #define BLOCK_ATTR(_name,_mode,_show,_store)        \
479 static struct edac_dev_sysfs_block_attribute attr_block_##_name = {	\
480 	.attr = {.name = __stringify(_name), .mode = _mode },   \
481 	.show   = _show,                                        \
482 	.store  = _store,                                       \
483 };
484 
485 BLOCK_ATTR(ce_count, S_IRUGO, block_ce_count_show, NULL);
486 BLOCK_ATTR(ue_count, S_IRUGO, block_ue_count_show, NULL);
487 
488 /* list of edac_dev 'block' attributes */
489 static struct attribute *device_block_attrs[] = {
490 	&attr_block_ce_count.attr,
491 	&attr_block_ue_count.attr,
492 	NULL,
493 };
494 ATTRIBUTE_GROUPS(device_block);
495 
496 /* The 'ktype' for each edac_dev 'block' */
497 static struct kobj_type ktype_block_ctrl = {
498 	.release = edac_device_ctrl_block_release,
499 	.sysfs_ops = &device_block_ops,
500 	.default_groups = device_block_groups,
501 };
502 
503 /* block ctor/dtor  code */
504 
505 /*
506  * edac_device_create_block
507  */
edac_device_create_block(struct edac_device_ctl_info * edac_dev,struct edac_device_instance * instance,struct edac_device_block * block)508 static int edac_device_create_block(struct edac_device_ctl_info *edac_dev,
509 				struct edac_device_instance *instance,
510 				struct edac_device_block *block)
511 {
512 	int i;
513 	int err;
514 	struct edac_dev_sysfs_block_attribute *sysfs_attrib;
515 	struct kobject *main_kobj;
516 
517 	edac_dbg(4, "Instance '%s' inst_p=%p  block '%s'  block_p=%p\n",
518 		 instance->name, instance, block->name, block);
519 	edac_dbg(4, "block kobj=%p  block kobj->parent=%p\n",
520 		 &block->kobj, &block->kobj.parent);
521 
522 	/* init this block's kobject */
523 	memset(&block->kobj, 0, sizeof(struct kobject));
524 
525 	/* bump the main kobject's reference count for this controller
526 	 * and this instance is dependent on the main
527 	 */
528 	main_kobj = kobject_get(&edac_dev->kobj);
529 	if (!main_kobj) {
530 		err = -ENODEV;
531 		goto err_out;
532 	}
533 
534 	/* Add this block's kobject */
535 	err = kobject_init_and_add(&block->kobj, &ktype_block_ctrl,
536 				   &instance->kobj,
537 				   "%s", block->name);
538 	if (err) {
539 		edac_dbg(1, "Failed to register instance '%s'\n", block->name);
540 		kobject_put(main_kobj);
541 		err = -ENODEV;
542 		goto err_out;
543 	}
544 
545 	/* If there are driver level block attributes, then added them
546 	 * to the block kobject
547 	 */
548 	sysfs_attrib = block->block_attributes;
549 	if (sysfs_attrib && block->nr_attribs) {
550 		for (i = 0; i < block->nr_attribs; i++, sysfs_attrib++) {
551 
552 			edac_dbg(4, "creating block attrib='%s' attrib->%p to kobj=%p\n",
553 				 sysfs_attrib->attr.name,
554 				 sysfs_attrib, &block->kobj);
555 
556 			/* Create each block_attribute file */
557 			err = sysfs_create_file(&block->kobj,
558 				&sysfs_attrib->attr);
559 			if (err)
560 				goto err_on_attrib;
561 		}
562 	}
563 	kobject_uevent(&block->kobj, KOBJ_ADD);
564 
565 	return 0;
566 
567 	/* Error unwind stack */
568 err_on_attrib:
569 	kobject_put(&block->kobj);
570 
571 err_out:
572 	return err;
573 }
574 
575 /*
576  * edac_device_delete_block(edac_dev,block);
577  */
edac_device_delete_block(struct edac_device_ctl_info * edac_dev,struct edac_device_block * block)578 static void edac_device_delete_block(struct edac_device_ctl_info *edac_dev,
579 				struct edac_device_block *block)
580 {
581 	struct edac_dev_sysfs_block_attribute *sysfs_attrib;
582 	int i;
583 
584 	/* if this block has 'attributes' then we need to iterate over the list
585 	 * and 'remove' the attributes on this block
586 	 */
587 	sysfs_attrib = block->block_attributes;
588 	if (sysfs_attrib && block->nr_attribs) {
589 		for (i = 0; i < block->nr_attribs; i++, sysfs_attrib++) {
590 
591 			/* remove each block_attrib file */
592 			sysfs_remove_file(&block->kobj,
593 				(struct attribute *) sysfs_attrib);
594 		}
595 	}
596 
597 	/* unregister this block's kobject, SEE:
598 	 *	edac_device_ctrl_block_release() callback operation
599 	 */
600 	kobject_put(&block->kobj);
601 }
602 
603 /* instance ctor/dtor code */
604 
605 /*
606  * edac_device_create_instance
607  *	create just one instance of an edac_device 'instance'
608  */
edac_device_create_instance(struct edac_device_ctl_info * edac_dev,int idx)609 static int edac_device_create_instance(struct edac_device_ctl_info *edac_dev,
610 				int idx)
611 {
612 	int i, j;
613 	int err;
614 	struct edac_device_instance *instance;
615 	struct kobject *main_kobj;
616 
617 	instance = &edac_dev->instances[idx];
618 
619 	/* Init the instance's kobject */
620 	memset(&instance->kobj, 0, sizeof(struct kobject));
621 
622 	instance->ctl = edac_dev;
623 
624 	/* bump the main kobject's reference count for this controller
625 	 * and this instance is dependent on the main
626 	 */
627 	main_kobj = kobject_get(&edac_dev->kobj);
628 	if (!main_kobj) {
629 		err = -ENODEV;
630 		goto err_out;
631 	}
632 
633 	/* Formally register this instance's kobject under the edac_device */
634 	err = kobject_init_and_add(&instance->kobj, &ktype_instance_ctrl,
635 				   &edac_dev->kobj, "%s", instance->name);
636 	if (err != 0) {
637 		edac_dbg(2, "Failed to register instance '%s'\n",
638 			 instance->name);
639 		kobject_put(main_kobj);
640 		goto err_out;
641 	}
642 
643 	edac_dbg(4, "now register '%d' blocks for instance %d\n",
644 		 instance->nr_blocks, idx);
645 
646 	/* register all blocks of this instance */
647 	for (i = 0; i < instance->nr_blocks; i++) {
648 		err = edac_device_create_block(edac_dev, instance,
649 						&instance->blocks[i]);
650 		if (err) {
651 			/* If any fail, remove all previous ones */
652 			for (j = 0; j < i; j++)
653 				edac_device_delete_block(edac_dev,
654 							&instance->blocks[j]);
655 			goto err_release_instance_kobj;
656 		}
657 	}
658 	kobject_uevent(&instance->kobj, KOBJ_ADD);
659 
660 	edac_dbg(4, "Registered instance %d '%s' kobject\n",
661 		 idx, instance->name);
662 
663 	return 0;
664 
665 	/* error unwind stack */
666 err_release_instance_kobj:
667 	kobject_put(&instance->kobj);
668 
669 err_out:
670 	return err;
671 }
672 
673 /*
674  * edac_device_remove_instance
675  *	remove an edac_device instance
676  */
edac_device_delete_instance(struct edac_device_ctl_info * edac_dev,int idx)677 static void edac_device_delete_instance(struct edac_device_ctl_info *edac_dev,
678 					int idx)
679 {
680 	struct edac_device_instance *instance;
681 	int i;
682 
683 	instance = &edac_dev->instances[idx];
684 
685 	/* unregister all blocks in this instance */
686 	for (i = 0; i < instance->nr_blocks; i++)
687 		edac_device_delete_block(edac_dev, &instance->blocks[i]);
688 
689 	/* unregister this instance's kobject, SEE:
690 	 *	edac_device_ctrl_instance_release() for callback operation
691 	 */
692 	kobject_put(&instance->kobj);
693 }
694 
695 /*
696  * edac_device_create_instances
697  *	create the first level of 'instances' for this device
698  *	(ie  'cache' might have 'cache0', 'cache1', 'cache2', etc
699  */
edac_device_create_instances(struct edac_device_ctl_info * edac_dev)700 static int edac_device_create_instances(struct edac_device_ctl_info *edac_dev)
701 {
702 	int i, j;
703 	int err;
704 
705 	edac_dbg(0, "\n");
706 
707 	/* iterate over creation of the instances */
708 	for (i = 0; i < edac_dev->nr_instances; i++) {
709 		err = edac_device_create_instance(edac_dev, i);
710 		if (err) {
711 			/* unwind previous instances on error */
712 			for (j = 0; j < i; j++)
713 				edac_device_delete_instance(edac_dev, j);
714 			return err;
715 		}
716 	}
717 
718 	return 0;
719 }
720 
721 /*
722  * edac_device_delete_instances(edac_dev);
723  *	unregister all the kobjects of the instances
724  */
edac_device_delete_instances(struct edac_device_ctl_info * edac_dev)725 static void edac_device_delete_instances(struct edac_device_ctl_info *edac_dev)
726 {
727 	int i;
728 
729 	/* iterate over creation of the instances */
730 	for (i = 0; i < edac_dev->nr_instances; i++)
731 		edac_device_delete_instance(edac_dev, i);
732 }
733 
734 /* edac_dev sysfs ctor/dtor  code */
735 
736 /*
737  * edac_device_add_main_sysfs_attributes
738  *	add some attributes to this instance's main kobject
739  */
edac_device_add_main_sysfs_attributes(struct edac_device_ctl_info * edac_dev)740 static int edac_device_add_main_sysfs_attributes(
741 			struct edac_device_ctl_info *edac_dev)
742 {
743 	struct edac_dev_sysfs_attribute *sysfs_attrib;
744 	int err = 0;
745 
746 	sysfs_attrib = edac_dev->sysfs_attributes;
747 	if (sysfs_attrib) {
748 		/* iterate over the array and create an attribute for each
749 		 * entry in the list
750 		 */
751 		while (sysfs_attrib->attr.name != NULL) {
752 			err = sysfs_create_file(&edac_dev->kobj,
753 				(struct attribute*) sysfs_attrib);
754 			if (err)
755 				goto err_out;
756 
757 			sysfs_attrib++;
758 		}
759 	}
760 
761 err_out:
762 	return err;
763 }
764 
765 /*
766  * edac_device_remove_main_sysfs_attributes
767  *	remove any attributes to this instance's main kobject
768  */
edac_device_remove_main_sysfs_attributes(struct edac_device_ctl_info * edac_dev)769 static void edac_device_remove_main_sysfs_attributes(
770 			struct edac_device_ctl_info *edac_dev)
771 {
772 	struct edac_dev_sysfs_attribute *sysfs_attrib;
773 
774 	/* if there are main attributes, defined, remove them. First,
775 	 * point to the start of the array and iterate over it
776 	 * removing each attribute listed from this device's instance's kobject
777 	 */
778 	sysfs_attrib = edac_dev->sysfs_attributes;
779 	if (sysfs_attrib) {
780 		while (sysfs_attrib->attr.name != NULL) {
781 			sysfs_remove_file(&edac_dev->kobj,
782 					(struct attribute *) sysfs_attrib);
783 			sysfs_attrib++;
784 		}
785 	}
786 }
787 
788 /*
789  * edac_device_create_sysfs() Constructor
790  *
791  * accept a created edac_device control structure
792  * and 'export' it to sysfs. The 'main' kobj should already have been
793  * created. 'instance' and 'block' kobjects should be registered
794  * along with any 'block' attributes from the low driver. In addition,
795  * the main attributes (if any) are connected to the main kobject of
796  * the control structure.
797  *
798  * Return:
799  *	0	Success
800  *	!0	Failure
801  */
edac_device_create_sysfs(struct edac_device_ctl_info * edac_dev)802 int edac_device_create_sysfs(struct edac_device_ctl_info *edac_dev)
803 {
804 	int err;
805 	struct kobject *edac_kobj = &edac_dev->kobj;
806 
807 	edac_dbg(0, "idx=%d\n", edac_dev->dev_idx);
808 
809 	/*  go create any main attributes callers wants */
810 	err = edac_device_add_main_sysfs_attributes(edac_dev);
811 	if (err) {
812 		edac_dbg(0, "failed to add sysfs attribs\n");
813 		goto err_out;
814 	}
815 
816 	/* create a symlink from the edac device
817 	 * to the platform 'device' being used for this
818 	 */
819 	err = sysfs_create_link(edac_kobj,
820 				&edac_dev->dev->kobj, EDAC_DEVICE_SYMLINK);
821 	if (err) {
822 		edac_dbg(0, "sysfs_create_link() returned err= %d\n", err);
823 		goto err_remove_main_attribs;
824 	}
825 
826 	/* Create the first level instance directories
827 	 * In turn, the nested blocks beneath the instances will
828 	 * be registered as well
829 	 */
830 	err = edac_device_create_instances(edac_dev);
831 	if (err) {
832 		edac_dbg(0, "edac_device_create_instances() returned err= %d\n",
833 			 err);
834 		goto err_remove_link;
835 	}
836 
837 
838 	edac_dbg(4, "create-instances done, idx=%d\n", edac_dev->dev_idx);
839 
840 	return 0;
841 
842 	/* Error unwind stack */
843 err_remove_link:
844 	/* remove the sym link */
845 	sysfs_remove_link(&edac_dev->kobj, EDAC_DEVICE_SYMLINK);
846 
847 err_remove_main_attribs:
848 	edac_device_remove_main_sysfs_attributes(edac_dev);
849 
850 err_out:
851 	return err;
852 }
853 
854 /*
855  * edac_device_remove_sysfs() destructor
856  *
857  * given an edac_device struct, tear down the kobject resources
858  */
edac_device_remove_sysfs(struct edac_device_ctl_info * edac_dev)859 void edac_device_remove_sysfs(struct edac_device_ctl_info *edac_dev)
860 {
861 	edac_dbg(0, "\n");
862 
863 	/* remove any main attributes for this device */
864 	edac_device_remove_main_sysfs_attributes(edac_dev);
865 
866 	/* remove the device sym link */
867 	sysfs_remove_link(&edac_dev->kobj, EDAC_DEVICE_SYMLINK);
868 
869 	/* walk the instance/block kobject tree, deconstructing it */
870 	edac_device_delete_instances(edac_dev);
871 }
872