xref: /linux/drivers/edac/edac_mc_sysfs.c (revision 092e0e7e520a1fca03e13c9f2d157432a8657ff2)
1 /*
2  * edac_mc kernel module
3  * (C) 2005-2007 Linux Networx (http://lnxi.com)
4  *
5  * This file may be distributed under the terms of the
6  * GNU General Public License.
7  *
8  * Written Doug Thompson <norsk5@xmission.com> www.softwarebitmaker.com
9  *
10  */
11 
12 #include <linux/ctype.h>
13 #include <linux/slab.h>
14 #include <linux/edac.h>
15 #include <linux/bug.h>
16 
17 #include "edac_core.h"
18 #include "edac_module.h"
19 
20 
21 /* MC EDAC Controls, setable by module parameter, and sysfs */
22 static int edac_mc_log_ue = 1;
23 static int edac_mc_log_ce = 1;
24 static int edac_mc_panic_on_ue;
25 static int edac_mc_poll_msec = 1000;
26 
27 /* Getter functions for above */
28 int edac_mc_get_log_ue(void)
29 {
30 	return edac_mc_log_ue;
31 }
32 
33 int edac_mc_get_log_ce(void)
34 {
35 	return edac_mc_log_ce;
36 }
37 
38 int edac_mc_get_panic_on_ue(void)
39 {
40 	return edac_mc_panic_on_ue;
41 }
42 
43 /* this is temporary */
44 int edac_mc_get_poll_msec(void)
45 {
46 	return edac_mc_poll_msec;
47 }
48 
49 static int edac_set_poll_msec(const char *val, struct kernel_param *kp)
50 {
51 	long l;
52 	int ret;
53 
54 	if (!val)
55 		return -EINVAL;
56 
57 	ret = strict_strtol(val, 0, &l);
58 	if (ret == -EINVAL || ((int)l != l))
59 		return -EINVAL;
60 	*((int *)kp->arg) = l;
61 
62 	/* notify edac_mc engine to reset the poll period */
63 	edac_mc_reset_delay_period(l);
64 
65 	return 0;
66 }
67 
68 /* Parameter declarations for above */
69 module_param(edac_mc_panic_on_ue, int, 0644);
70 MODULE_PARM_DESC(edac_mc_panic_on_ue, "Panic on uncorrected error: 0=off 1=on");
71 module_param(edac_mc_log_ue, int, 0644);
72 MODULE_PARM_DESC(edac_mc_log_ue,
73 		 "Log uncorrectable error to console: 0=off 1=on");
74 module_param(edac_mc_log_ce, int, 0644);
75 MODULE_PARM_DESC(edac_mc_log_ce,
76 		 "Log correctable error to console: 0=off 1=on");
77 module_param_call(edac_mc_poll_msec, edac_set_poll_msec, param_get_int,
78 		  &edac_mc_poll_msec, 0644);
79 MODULE_PARM_DESC(edac_mc_poll_msec, "Polling period in milliseconds");
80 
81 /*
82  * various constants for Memory Controllers
83  */
84 static const char *mem_types[] = {
85 	[MEM_EMPTY] = "Empty",
86 	[MEM_RESERVED] = "Reserved",
87 	[MEM_UNKNOWN] = "Unknown",
88 	[MEM_FPM] = "FPM",
89 	[MEM_EDO] = "EDO",
90 	[MEM_BEDO] = "BEDO",
91 	[MEM_SDR] = "Unbuffered-SDR",
92 	[MEM_RDR] = "Registered-SDR",
93 	[MEM_DDR] = "Unbuffered-DDR",
94 	[MEM_RDDR] = "Registered-DDR",
95 	[MEM_RMBS] = "RMBS",
96 	[MEM_DDR2] = "Unbuffered-DDR2",
97 	[MEM_FB_DDR2] = "FullyBuffered-DDR2",
98 	[MEM_RDDR2] = "Registered-DDR2",
99 	[MEM_XDR] = "XDR",
100 	[MEM_DDR3] = "Unbuffered-DDR3",
101 	[MEM_RDDR3] = "Registered-DDR3"
102 };
103 
104 static const char *dev_types[] = {
105 	[DEV_UNKNOWN] = "Unknown",
106 	[DEV_X1] = "x1",
107 	[DEV_X2] = "x2",
108 	[DEV_X4] = "x4",
109 	[DEV_X8] = "x8",
110 	[DEV_X16] = "x16",
111 	[DEV_X32] = "x32",
112 	[DEV_X64] = "x64"
113 };
114 
115 static const char *edac_caps[] = {
116 	[EDAC_UNKNOWN] = "Unknown",
117 	[EDAC_NONE] = "None",
118 	[EDAC_RESERVED] = "Reserved",
119 	[EDAC_PARITY] = "PARITY",
120 	[EDAC_EC] = "EC",
121 	[EDAC_SECDED] = "SECDED",
122 	[EDAC_S2ECD2ED] = "S2ECD2ED",
123 	[EDAC_S4ECD4ED] = "S4ECD4ED",
124 	[EDAC_S8ECD8ED] = "S8ECD8ED",
125 	[EDAC_S16ECD16ED] = "S16ECD16ED"
126 };
127 
128 /* EDAC sysfs CSROW data structures and methods
129  */
130 
131 /* Set of more default csrow<id> attribute show/store functions */
132 static ssize_t csrow_ue_count_show(struct csrow_info *csrow, char *data,
133 				int private)
134 {
135 	return sprintf(data, "%u\n", csrow->ue_count);
136 }
137 
138 static ssize_t csrow_ce_count_show(struct csrow_info *csrow, char *data,
139 				int private)
140 {
141 	return sprintf(data, "%u\n", csrow->ce_count);
142 }
143 
144 static ssize_t csrow_size_show(struct csrow_info *csrow, char *data,
145 				int private)
146 {
147 	return sprintf(data, "%u\n", PAGES_TO_MiB(csrow->nr_pages));
148 }
149 
150 static ssize_t csrow_mem_type_show(struct csrow_info *csrow, char *data,
151 				int private)
152 {
153 	return sprintf(data, "%s\n", mem_types[csrow->mtype]);
154 }
155 
156 static ssize_t csrow_dev_type_show(struct csrow_info *csrow, char *data,
157 				int private)
158 {
159 	return sprintf(data, "%s\n", dev_types[csrow->dtype]);
160 }
161 
162 static ssize_t csrow_edac_mode_show(struct csrow_info *csrow, char *data,
163 				int private)
164 {
165 	return sprintf(data, "%s\n", edac_caps[csrow->edac_mode]);
166 }
167 
168 /* show/store functions for DIMM Label attributes */
169 static ssize_t channel_dimm_label_show(struct csrow_info *csrow,
170 				char *data, int channel)
171 {
172 	/* if field has not been initialized, there is nothing to send */
173 	if (!csrow->channels[channel].label[0])
174 		return 0;
175 
176 	return snprintf(data, EDAC_MC_LABEL_LEN, "%s\n",
177 			csrow->channels[channel].label);
178 }
179 
180 static ssize_t channel_dimm_label_store(struct csrow_info *csrow,
181 					const char *data,
182 					size_t count, int channel)
183 {
184 	ssize_t max_size = 0;
185 
186 	max_size = min((ssize_t) count, (ssize_t) EDAC_MC_LABEL_LEN - 1);
187 	strncpy(csrow->channels[channel].label, data, max_size);
188 	csrow->channels[channel].label[max_size] = '\0';
189 
190 	return max_size;
191 }
192 
193 /* show function for dynamic chX_ce_count attribute */
194 static ssize_t channel_ce_count_show(struct csrow_info *csrow,
195 				char *data, int channel)
196 {
197 	return sprintf(data, "%u\n", csrow->channels[channel].ce_count);
198 }
199 
200 /* csrow specific attribute structure */
201 struct csrowdev_attribute {
202 	struct attribute attr;
203 	 ssize_t(*show) (struct csrow_info *, char *, int);
204 	 ssize_t(*store) (struct csrow_info *, const char *, size_t, int);
205 	int private;
206 };
207 
208 #define to_csrow(k) container_of(k, struct csrow_info, kobj)
209 #define to_csrowdev_attr(a) container_of(a, struct csrowdev_attribute, attr)
210 
211 /* Set of show/store higher level functions for default csrow attributes */
212 static ssize_t csrowdev_show(struct kobject *kobj,
213 			struct attribute *attr, char *buffer)
214 {
215 	struct csrow_info *csrow = to_csrow(kobj);
216 	struct csrowdev_attribute *csrowdev_attr = to_csrowdev_attr(attr);
217 
218 	if (csrowdev_attr->show)
219 		return csrowdev_attr->show(csrow,
220 					buffer, csrowdev_attr->private);
221 	return -EIO;
222 }
223 
224 static ssize_t csrowdev_store(struct kobject *kobj, struct attribute *attr,
225 			const char *buffer, size_t count)
226 {
227 	struct csrow_info *csrow = to_csrow(kobj);
228 	struct csrowdev_attribute *csrowdev_attr = to_csrowdev_attr(attr);
229 
230 	if (csrowdev_attr->store)
231 		return csrowdev_attr->store(csrow,
232 					buffer,
233 					count, csrowdev_attr->private);
234 	return -EIO;
235 }
236 
237 static const struct sysfs_ops csrowfs_ops = {
238 	.show = csrowdev_show,
239 	.store = csrowdev_store
240 };
241 
242 #define CSROWDEV_ATTR(_name,_mode,_show,_store,_private)	\
243 static struct csrowdev_attribute attr_##_name = {			\
244 	.attr = {.name = __stringify(_name), .mode = _mode },	\
245 	.show   = _show,					\
246 	.store  = _store,					\
247 	.private = _private,					\
248 };
249 
250 /* default cwrow<id>/attribute files */
251 CSROWDEV_ATTR(size_mb, S_IRUGO, csrow_size_show, NULL, 0);
252 CSROWDEV_ATTR(dev_type, S_IRUGO, csrow_dev_type_show, NULL, 0);
253 CSROWDEV_ATTR(mem_type, S_IRUGO, csrow_mem_type_show, NULL, 0);
254 CSROWDEV_ATTR(edac_mode, S_IRUGO, csrow_edac_mode_show, NULL, 0);
255 CSROWDEV_ATTR(ue_count, S_IRUGO, csrow_ue_count_show, NULL, 0);
256 CSROWDEV_ATTR(ce_count, S_IRUGO, csrow_ce_count_show, NULL, 0);
257 
258 /* default attributes of the CSROW<id> object */
259 static struct csrowdev_attribute *default_csrow_attr[] = {
260 	&attr_dev_type,
261 	&attr_mem_type,
262 	&attr_edac_mode,
263 	&attr_size_mb,
264 	&attr_ue_count,
265 	&attr_ce_count,
266 	NULL,
267 };
268 
269 /* possible dynamic channel DIMM Label attribute files */
270 CSROWDEV_ATTR(ch0_dimm_label, S_IRUGO | S_IWUSR,
271 	channel_dimm_label_show, channel_dimm_label_store, 0);
272 CSROWDEV_ATTR(ch1_dimm_label, S_IRUGO | S_IWUSR,
273 	channel_dimm_label_show, channel_dimm_label_store, 1);
274 CSROWDEV_ATTR(ch2_dimm_label, S_IRUGO | S_IWUSR,
275 	channel_dimm_label_show, channel_dimm_label_store, 2);
276 CSROWDEV_ATTR(ch3_dimm_label, S_IRUGO | S_IWUSR,
277 	channel_dimm_label_show, channel_dimm_label_store, 3);
278 CSROWDEV_ATTR(ch4_dimm_label, S_IRUGO | S_IWUSR,
279 	channel_dimm_label_show, channel_dimm_label_store, 4);
280 CSROWDEV_ATTR(ch5_dimm_label, S_IRUGO | S_IWUSR,
281 	channel_dimm_label_show, channel_dimm_label_store, 5);
282 
283 /* Total possible dynamic DIMM Label attribute file table */
284 static struct csrowdev_attribute *dynamic_csrow_dimm_attr[] = {
285 	&attr_ch0_dimm_label,
286 	&attr_ch1_dimm_label,
287 	&attr_ch2_dimm_label,
288 	&attr_ch3_dimm_label,
289 	&attr_ch4_dimm_label,
290 	&attr_ch5_dimm_label
291 };
292 
293 /* possible dynamic channel ce_count attribute files */
294 CSROWDEV_ATTR(ch0_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 0);
295 CSROWDEV_ATTR(ch1_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 1);
296 CSROWDEV_ATTR(ch2_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 2);
297 CSROWDEV_ATTR(ch3_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 3);
298 CSROWDEV_ATTR(ch4_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 4);
299 CSROWDEV_ATTR(ch5_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 5);
300 
301 /* Total possible dynamic ce_count attribute file table */
302 static struct csrowdev_attribute *dynamic_csrow_ce_count_attr[] = {
303 	&attr_ch0_ce_count,
304 	&attr_ch1_ce_count,
305 	&attr_ch2_ce_count,
306 	&attr_ch3_ce_count,
307 	&attr_ch4_ce_count,
308 	&attr_ch5_ce_count
309 };
310 
311 #define EDAC_NR_CHANNELS	6
312 
313 /* Create dynamic CHANNEL files, indexed by 'chan',  under specifed CSROW */
314 static int edac_create_channel_files(struct kobject *kobj, int chan)
315 {
316 	int err = -ENODEV;
317 
318 	if (chan >= EDAC_NR_CHANNELS)
319 		return err;
320 
321 	/* create the DIMM label attribute file */
322 	err = sysfs_create_file(kobj,
323 				(struct attribute *)
324 				dynamic_csrow_dimm_attr[chan]);
325 
326 	if (!err) {
327 		/* create the CE Count attribute file */
328 		err = sysfs_create_file(kobj,
329 					(struct attribute *)
330 					dynamic_csrow_ce_count_attr[chan]);
331 	} else {
332 		debugf1("%s()  dimm labels and ce_count files created",
333 			__func__);
334 	}
335 
336 	return err;
337 }
338 
339 /* No memory to release for this kobj */
340 static void edac_csrow_instance_release(struct kobject *kobj)
341 {
342 	struct mem_ctl_info *mci;
343 	struct csrow_info *cs;
344 
345 	debugf1("%s()\n", __func__);
346 
347 	cs = container_of(kobj, struct csrow_info, kobj);
348 	mci = cs->mci;
349 
350 	kobject_put(&mci->edac_mci_kobj);
351 }
352 
353 /* the kobj_type instance for a CSROW */
354 static struct kobj_type ktype_csrow = {
355 	.release = edac_csrow_instance_release,
356 	.sysfs_ops = &csrowfs_ops,
357 	.default_attrs = (struct attribute **)default_csrow_attr,
358 };
359 
360 /* Create a CSROW object under specifed edac_mc_device */
361 static int edac_create_csrow_object(struct mem_ctl_info *mci,
362 					struct csrow_info *csrow, int index)
363 {
364 	struct kobject *kobj_mci = &mci->edac_mci_kobj;
365 	struct kobject *kobj;
366 	int chan;
367 	int err;
368 
369 	/* generate ..../edac/mc/mc<id>/csrow<index>   */
370 	memset(&csrow->kobj, 0, sizeof(csrow->kobj));
371 	csrow->mci = mci;	/* include container up link */
372 
373 	/* bump the mci instance's kobject's ref count */
374 	kobj = kobject_get(&mci->edac_mci_kobj);
375 	if (!kobj) {
376 		err = -ENODEV;
377 		goto err_out;
378 	}
379 
380 	/* Instanstiate the csrow object */
381 	err = kobject_init_and_add(&csrow->kobj, &ktype_csrow, kobj_mci,
382 				   "csrow%d", index);
383 	if (err)
384 		goto err_release_top_kobj;
385 
386 	/* At this point, to release a csrow kobj, one must
387 	 * call the kobject_put and allow that tear down
388 	 * to work the releasing
389 	 */
390 
391 	/* Create the dyanmic attribute files on this csrow,
392 	 * namely, the DIMM labels and the channel ce_count
393 	 */
394 	for (chan = 0; chan < csrow->nr_channels; chan++) {
395 		err = edac_create_channel_files(&csrow->kobj, chan);
396 		if (err) {
397 			/* special case the unregister here */
398 			kobject_put(&csrow->kobj);
399 			goto err_out;
400 		}
401 	}
402 	kobject_uevent(&csrow->kobj, KOBJ_ADD);
403 	return 0;
404 
405 	/* error unwind stack */
406 err_release_top_kobj:
407 	kobject_put(&mci->edac_mci_kobj);
408 
409 err_out:
410 	return err;
411 }
412 
413 /* default sysfs methods and data structures for the main MCI kobject */
414 
415 static ssize_t mci_reset_counters_store(struct mem_ctl_info *mci,
416 					const char *data, size_t count)
417 {
418 	int row, chan;
419 
420 	mci->ue_noinfo_count = 0;
421 	mci->ce_noinfo_count = 0;
422 	mci->ue_count = 0;
423 	mci->ce_count = 0;
424 
425 	for (row = 0; row < mci->nr_csrows; row++) {
426 		struct csrow_info *ri = &mci->csrows[row];
427 
428 		ri->ue_count = 0;
429 		ri->ce_count = 0;
430 
431 		for (chan = 0; chan < ri->nr_channels; chan++)
432 			ri->channels[chan].ce_count = 0;
433 	}
434 
435 	mci->start_time = jiffies;
436 	return count;
437 }
438 
439 /* memory scrubbing */
440 static ssize_t mci_sdram_scrub_rate_store(struct mem_ctl_info *mci,
441 					  const char *data, size_t count)
442 {
443 	unsigned long bandwidth = 0;
444 	int err;
445 
446 	if (!mci->set_sdram_scrub_rate) {
447 		edac_printk(KERN_WARNING, EDAC_MC,
448 			    "Memory scrub rate setting not implemented!\n");
449 		return -EINVAL;
450 	}
451 
452 	if (strict_strtoul(data, 10, &bandwidth) < 0)
453 		return -EINVAL;
454 
455 	err = mci->set_sdram_scrub_rate(mci, (u32)bandwidth);
456 	if (err) {
457 		edac_printk(KERN_DEBUG, EDAC_MC,
458 			    "Failed setting scrub rate to %lu\n", bandwidth);
459 		return -EINVAL;
460 	}
461 	else {
462 		edac_printk(KERN_DEBUG, EDAC_MC,
463 			    "Scrub rate set to: %lu\n", bandwidth);
464 		return count;
465 	}
466 }
467 
468 static ssize_t mci_sdram_scrub_rate_show(struct mem_ctl_info *mci, char *data)
469 {
470 	u32 bandwidth = 0;
471 	int err;
472 
473 	if (!mci->get_sdram_scrub_rate) {
474 		edac_printk(KERN_WARNING, EDAC_MC,
475 			    "Memory scrub rate reading not implemented\n");
476 		return -EINVAL;
477 	}
478 
479 	err = mci->get_sdram_scrub_rate(mci, &bandwidth);
480 	if (err) {
481 		edac_printk(KERN_DEBUG, EDAC_MC, "Error reading scrub rate\n");
482 		return err;
483 	}
484 	else {
485 		edac_printk(KERN_DEBUG, EDAC_MC,
486 			    "Read scrub rate: %d\n", bandwidth);
487 		return sprintf(data, "%d\n", bandwidth);
488 	}
489 }
490 
491 /* default attribute files for the MCI object */
492 static ssize_t mci_ue_count_show(struct mem_ctl_info *mci, char *data)
493 {
494 	return sprintf(data, "%d\n", mci->ue_count);
495 }
496 
497 static ssize_t mci_ce_count_show(struct mem_ctl_info *mci, char *data)
498 {
499 	return sprintf(data, "%d\n", mci->ce_count);
500 }
501 
502 static ssize_t mci_ce_noinfo_show(struct mem_ctl_info *mci, char *data)
503 {
504 	return sprintf(data, "%d\n", mci->ce_noinfo_count);
505 }
506 
507 static ssize_t mci_ue_noinfo_show(struct mem_ctl_info *mci, char *data)
508 {
509 	return sprintf(data, "%d\n", mci->ue_noinfo_count);
510 }
511 
512 static ssize_t mci_seconds_show(struct mem_ctl_info *mci, char *data)
513 {
514 	return sprintf(data, "%ld\n", (jiffies - mci->start_time) / HZ);
515 }
516 
517 static ssize_t mci_ctl_name_show(struct mem_ctl_info *mci, char *data)
518 {
519 	return sprintf(data, "%s\n", mci->ctl_name);
520 }
521 
522 static ssize_t mci_size_mb_show(struct mem_ctl_info *mci, char *data)
523 {
524 	int total_pages, csrow_idx;
525 
526 	for (total_pages = csrow_idx = 0; csrow_idx < mci->nr_csrows;
527 		csrow_idx++) {
528 		struct csrow_info *csrow = &mci->csrows[csrow_idx];
529 
530 		if (!csrow->nr_pages)
531 			continue;
532 
533 		total_pages += csrow->nr_pages;
534 	}
535 
536 	return sprintf(data, "%u\n", PAGES_TO_MiB(total_pages));
537 }
538 
539 #define to_mci(k) container_of(k, struct mem_ctl_info, edac_mci_kobj)
540 #define to_mcidev_attr(a) container_of(a,struct mcidev_sysfs_attribute,attr)
541 
542 /* MCI show/store functions for top most object */
543 static ssize_t mcidev_show(struct kobject *kobj, struct attribute *attr,
544 			char *buffer)
545 {
546 	struct mem_ctl_info *mem_ctl_info = to_mci(kobj);
547 	struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
548 
549 	debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
550 
551 	if (mcidev_attr->show)
552 		return mcidev_attr->show(mem_ctl_info, buffer);
553 
554 	return -EIO;
555 }
556 
557 static ssize_t mcidev_store(struct kobject *kobj, struct attribute *attr,
558 			const char *buffer, size_t count)
559 {
560 	struct mem_ctl_info *mem_ctl_info = to_mci(kobj);
561 	struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
562 
563 	debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
564 
565 	if (mcidev_attr->store)
566 		return mcidev_attr->store(mem_ctl_info, buffer, count);
567 
568 	return -EIO;
569 }
570 
571 /* Intermediate show/store table */
572 static const struct sysfs_ops mci_ops = {
573 	.show = mcidev_show,
574 	.store = mcidev_store
575 };
576 
577 #define MCIDEV_ATTR(_name,_mode,_show,_store)			\
578 static struct mcidev_sysfs_attribute mci_attr_##_name = {			\
579 	.attr = {.name = __stringify(_name), .mode = _mode },	\
580 	.show   = _show,					\
581 	.store  = _store,					\
582 };
583 
584 /* default Control file */
585 MCIDEV_ATTR(reset_counters, S_IWUSR, NULL, mci_reset_counters_store);
586 
587 /* default Attribute files */
588 MCIDEV_ATTR(mc_name, S_IRUGO, mci_ctl_name_show, NULL);
589 MCIDEV_ATTR(size_mb, S_IRUGO, mci_size_mb_show, NULL);
590 MCIDEV_ATTR(seconds_since_reset, S_IRUGO, mci_seconds_show, NULL);
591 MCIDEV_ATTR(ue_noinfo_count, S_IRUGO, mci_ue_noinfo_show, NULL);
592 MCIDEV_ATTR(ce_noinfo_count, S_IRUGO, mci_ce_noinfo_show, NULL);
593 MCIDEV_ATTR(ue_count, S_IRUGO, mci_ue_count_show, NULL);
594 MCIDEV_ATTR(ce_count, S_IRUGO, mci_ce_count_show, NULL);
595 
596 /* memory scrubber attribute file */
597 MCIDEV_ATTR(sdram_scrub_rate, S_IRUGO | S_IWUSR, mci_sdram_scrub_rate_show,
598 	mci_sdram_scrub_rate_store);
599 
600 static struct mcidev_sysfs_attribute *mci_attr[] = {
601 	&mci_attr_reset_counters,
602 	&mci_attr_mc_name,
603 	&mci_attr_size_mb,
604 	&mci_attr_seconds_since_reset,
605 	&mci_attr_ue_noinfo_count,
606 	&mci_attr_ce_noinfo_count,
607 	&mci_attr_ue_count,
608 	&mci_attr_ce_count,
609 	&mci_attr_sdram_scrub_rate,
610 	NULL
611 };
612 
613 
614 /*
615  * Release of a MC controlling instance
616  *
617  *	each MC control instance has the following resources upon entry:
618  *		a) a ref count on the top memctl kobj
619  *		b) a ref count on this module
620  *
621  *	this function must decrement those ref counts and then
622  *	issue a free on the instance's memory
623  */
624 static void edac_mci_control_release(struct kobject *kobj)
625 {
626 	struct mem_ctl_info *mci;
627 
628 	mci = to_mci(kobj);
629 
630 	debugf0("%s() mci instance idx=%d releasing\n", __func__, mci->mc_idx);
631 
632 	/* decrement the module ref count */
633 	module_put(mci->owner);
634 
635 	/* free the mci instance memory here */
636 	kfree(mci);
637 }
638 
639 static struct kobj_type ktype_mci = {
640 	.release = edac_mci_control_release,
641 	.sysfs_ops = &mci_ops,
642 	.default_attrs = (struct attribute **)mci_attr,
643 };
644 
645 /* EDAC memory controller sysfs kset:
646  *	/sys/devices/system/edac/mc
647  */
648 static struct kset *mc_kset;
649 
650 /*
651  * edac_mc_register_sysfs_main_kobj
652  *
653  *	setups and registers the main kobject for each mci
654  */
655 int edac_mc_register_sysfs_main_kobj(struct mem_ctl_info *mci)
656 {
657 	struct kobject *kobj_mci;
658 	int err;
659 
660 	debugf1("%s()\n", __func__);
661 
662 	kobj_mci = &mci->edac_mci_kobj;
663 
664 	/* Init the mci's kobject */
665 	memset(kobj_mci, 0, sizeof(*kobj_mci));
666 
667 	/* Record which module 'owns' this control structure
668 	 * and bump the ref count of the module
669 	 */
670 	mci->owner = THIS_MODULE;
671 
672 	/* bump ref count on this module */
673 	if (!try_module_get(mci->owner)) {
674 		err = -ENODEV;
675 		goto fail_out;
676 	}
677 
678 	/* this instance become part of the mc_kset */
679 	kobj_mci->kset = mc_kset;
680 
681 	/* register the mc<id> kobject to the mc_kset */
682 	err = kobject_init_and_add(kobj_mci, &ktype_mci, NULL,
683 				   "mc%d", mci->mc_idx);
684 	if (err) {
685 		debugf1("%s()Failed to register '.../edac/mc%d'\n",
686 			__func__, mci->mc_idx);
687 		goto kobj_reg_fail;
688 	}
689 	kobject_uevent(kobj_mci, KOBJ_ADD);
690 
691 	/* At this point, to 'free' the control struct,
692 	 * edac_mc_unregister_sysfs_main_kobj() must be used
693 	 */
694 
695 	debugf1("%s() Registered '.../edac/mc%d' kobject\n",
696 		__func__, mci->mc_idx);
697 
698 	return 0;
699 
700 	/* Error exit stack */
701 
702 kobj_reg_fail:
703 	module_put(mci->owner);
704 
705 fail_out:
706 	return err;
707 }
708 
709 /*
710  * edac_mc_register_sysfs_main_kobj
711  *
712  *	tears down and the main mci kobject from the mc_kset
713  */
714 void edac_mc_unregister_sysfs_main_kobj(struct mem_ctl_info *mci)
715 {
716 	/* delete the kobj from the mc_kset */
717 	kobject_put(&mci->edac_mci_kobj);
718 }
719 
720 #define EDAC_DEVICE_SYMLINK	"device"
721 
722 #define grp_to_mci(k) (container_of(k, struct mcidev_sysfs_group_kobj, kobj)->mci)
723 
724 /* MCI show/store functions for top most object */
725 static ssize_t inst_grp_show(struct kobject *kobj, struct attribute *attr,
726 			char *buffer)
727 {
728 	struct mem_ctl_info *mem_ctl_info = grp_to_mci(kobj);
729 	struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
730 
731 	debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
732 
733 	if (mcidev_attr->show)
734 		return mcidev_attr->show(mem_ctl_info, buffer);
735 
736 	return -EIO;
737 }
738 
739 static ssize_t inst_grp_store(struct kobject *kobj, struct attribute *attr,
740 			const char *buffer, size_t count)
741 {
742 	struct mem_ctl_info *mem_ctl_info = grp_to_mci(kobj);
743 	struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
744 
745 	debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
746 
747 	if (mcidev_attr->store)
748 		return mcidev_attr->store(mem_ctl_info, buffer, count);
749 
750 	return -EIO;
751 }
752 
753 /* No memory to release for this kobj */
754 static void edac_inst_grp_release(struct kobject *kobj)
755 {
756 	struct mcidev_sysfs_group_kobj *grp;
757 	struct mem_ctl_info *mci;
758 
759 	debugf1("%s()\n", __func__);
760 
761 	grp = container_of(kobj, struct mcidev_sysfs_group_kobj, kobj);
762 	mci = grp->mci;
763 
764 	kobject_put(&mci->edac_mci_kobj);
765 }
766 
767 /* Intermediate show/store table */
768 static struct sysfs_ops inst_grp_ops = {
769 	.show = inst_grp_show,
770 	.store = inst_grp_store
771 };
772 
773 /* the kobj_type instance for a instance group */
774 static struct kobj_type ktype_inst_grp = {
775 	.release = edac_inst_grp_release,
776 	.sysfs_ops = &inst_grp_ops,
777 };
778 
779 
780 /*
781  * edac_create_mci_instance_attributes
782  *	create MC driver specific attributes bellow an specified kobj
783  * This routine calls itself recursively, in order to create an entire
784  * object tree.
785  */
786 static int edac_create_mci_instance_attributes(struct mem_ctl_info *mci,
787 				struct mcidev_sysfs_attribute *sysfs_attrib,
788 				struct kobject *kobj)
789 {
790 	int err;
791 
792 	debugf1("%s()\n", __func__);
793 
794 	while (sysfs_attrib) {
795 		if (sysfs_attrib->grp) {
796 			struct mcidev_sysfs_group_kobj *grp_kobj;
797 
798 			grp_kobj = kzalloc(sizeof(*grp_kobj), GFP_KERNEL);
799 			if (!grp_kobj)
800 				return -ENOMEM;
801 
802 			list_add_tail(&grp_kobj->list, &mci->grp_kobj_list);
803 
804 			grp_kobj->grp = sysfs_attrib->grp;
805 			grp_kobj->mci = mci;
806 
807 			debugf0("%s() grp %s, mci %p\n", __func__,
808 				sysfs_attrib->grp->name, mci);
809 
810 			err = kobject_init_and_add(&grp_kobj->kobj,
811 						&ktype_inst_grp,
812 						&mci->edac_mci_kobj,
813 						sysfs_attrib->grp->name);
814 			if (err)
815 				return err;
816 
817 			err = edac_create_mci_instance_attributes(mci,
818 					grp_kobj->grp->mcidev_attr,
819 					&grp_kobj->kobj);
820 
821 			if (err)
822 				return err;
823 		} else if (sysfs_attrib->attr.name) {
824 			debugf0("%s() file %s\n", __func__,
825 				sysfs_attrib->attr.name);
826 
827 			err = sysfs_create_file(kobj, &sysfs_attrib->attr);
828 		} else
829 			break;
830 
831 		if (err) {
832 			return err;
833 		}
834 		sysfs_attrib++;
835 	}
836 
837 	return 0;
838 }
839 
840 /*
841  * edac_remove_mci_instance_attributes
842  *	remove MC driver specific attributes at the topmost level
843  *	directory of this mci instance.
844  */
845 static void edac_remove_mci_instance_attributes(struct mem_ctl_info *mci,
846 				struct mcidev_sysfs_attribute *sysfs_attrib,
847 				struct kobject *kobj, int count)
848 {
849 	struct mcidev_sysfs_group_kobj *grp_kobj, *tmp;
850 
851 	debugf1("%s()\n", __func__);
852 
853 	/*
854 	 * loop if there are attributes and until we hit a NULL entry
855 	 * Remove first all the atributes
856 	 */
857 	while (sysfs_attrib) {
858 		if (sysfs_attrib->grp) {
859 			list_for_each_entry(grp_kobj, &mci->grp_kobj_list,
860 					    list)
861 				if (grp_kobj->grp == sysfs_attrib->grp)
862 					edac_remove_mci_instance_attributes(mci,
863 						    grp_kobj->grp->mcidev_attr,
864 						    &grp_kobj->kobj, count + 1);
865 		} else if (sysfs_attrib->attr.name) {
866 			debugf0("%s() file %s\n", __func__,
867 				sysfs_attrib->attr.name);
868 			sysfs_remove_file(kobj, &sysfs_attrib->attr);
869 		} else
870 			break;
871 		sysfs_attrib++;
872 	}
873 
874 	/*
875 	 * Now that all attributes got removed, it is save to remove all groups
876 	 */
877 	if (!count)
878 		list_for_each_entry_safe(grp_kobj, tmp, &mci->grp_kobj_list,
879 					 list) {
880 			debugf0("%s() grp %s\n", __func__, grp_kobj->grp->name);
881 			kobject_put(&grp_kobj->kobj);
882 		}
883 }
884 
885 
886 /*
887  * Create a new Memory Controller kobject instance,
888  *	mc<id> under the 'mc' directory
889  *
890  * Return:
891  *	0	Success
892  *	!0	Failure
893  */
894 int edac_create_sysfs_mci_device(struct mem_ctl_info *mci)
895 {
896 	int i;
897 	int err;
898 	struct csrow_info *csrow;
899 	struct kobject *kobj_mci = &mci->edac_mci_kobj;
900 
901 	debugf0("%s() idx=%d\n", __func__, mci->mc_idx);
902 
903 	INIT_LIST_HEAD(&mci->grp_kobj_list);
904 
905 	/* create a symlink for the device */
906 	err = sysfs_create_link(kobj_mci, &mci->dev->kobj,
907 				EDAC_DEVICE_SYMLINK);
908 	if (err) {
909 		debugf1("%s() failure to create symlink\n", __func__);
910 		goto fail0;
911 	}
912 
913 	/* If the low level driver desires some attributes,
914 	 * then create them now for the driver.
915 	 */
916 	if (mci->mc_driver_sysfs_attributes) {
917 		err = edac_create_mci_instance_attributes(mci,
918 					mci->mc_driver_sysfs_attributes,
919 					&mci->edac_mci_kobj);
920 		if (err) {
921 			debugf1("%s() failure to create mci attributes\n",
922 				__func__);
923 			goto fail0;
924 		}
925 	}
926 
927 	/* Make directories for each CSROW object under the mc<id> kobject
928 	 */
929 	for (i = 0; i < mci->nr_csrows; i++) {
930 		csrow = &mci->csrows[i];
931 
932 		/* Only expose populated CSROWs */
933 		if (csrow->nr_pages > 0) {
934 			err = edac_create_csrow_object(mci, csrow, i);
935 			if (err) {
936 				debugf1("%s() failure: create csrow %d obj\n",
937 					__func__, i);
938 				goto fail1;
939 			}
940 		}
941 	}
942 
943 	return 0;
944 
945 	/* CSROW error: backout what has already been registered,  */
946 fail1:
947 	for (i--; i >= 0; i--) {
948 		if (csrow->nr_pages > 0) {
949 			kobject_put(&mci->csrows[i].kobj);
950 		}
951 	}
952 
953 	/* remove the mci instance's attributes, if any */
954 	edac_remove_mci_instance_attributes(mci,
955 		mci->mc_driver_sysfs_attributes, &mci->edac_mci_kobj, 0);
956 
957 	/* remove the symlink */
958 	sysfs_remove_link(kobj_mci, EDAC_DEVICE_SYMLINK);
959 
960 fail0:
961 	return err;
962 }
963 
964 /*
965  * remove a Memory Controller instance
966  */
967 void edac_remove_sysfs_mci_device(struct mem_ctl_info *mci)
968 {
969 	int i;
970 
971 	debugf0("%s()\n", __func__);
972 
973 	/* remove all csrow kobjects */
974 	for (i = 0; i < mci->nr_csrows; i++) {
975 		if (mci->csrows[i].nr_pages > 0) {
976 			debugf0("%s()  unreg csrow-%d\n", __func__, i);
977 			kobject_put(&mci->csrows[i].kobj);
978 		}
979 	}
980 
981 	debugf0("%s()  remove_link\n", __func__);
982 
983 	/* remove the symlink */
984 	sysfs_remove_link(&mci->edac_mci_kobj, EDAC_DEVICE_SYMLINK);
985 
986 	debugf0("%s()  remove_mci_instance\n", __func__);
987 
988 	/* remove this mci instance's attribtes */
989 	edac_remove_mci_instance_attributes(mci,
990 					    mci->mc_driver_sysfs_attributes,
991 					    &mci->edac_mci_kobj, 0);
992 	debugf0("%s()  unregister this mci kobj\n", __func__);
993 
994 	/* unregister this instance's kobject */
995 	kobject_put(&mci->edac_mci_kobj);
996 }
997 
998 
999 
1000 
1001 /*
1002  * edac_setup_sysfs_mc_kset(void)
1003  *
1004  * Initialize the mc_kset for the 'mc' entry
1005  *	This requires creating the top 'mc' directory with a kset
1006  *	and its controls/attributes.
1007  *
1008  *	To this 'mc' kset, instance 'mci' will be grouped as children.
1009  *
1010  * Return:  0 SUCCESS
1011  *         !0 FAILURE error code
1012  */
1013 int edac_sysfs_setup_mc_kset(void)
1014 {
1015 	int err = -EINVAL;
1016 	struct sysdev_class *edac_class;
1017 
1018 	debugf1("%s()\n", __func__);
1019 
1020 	/* get the /sys/devices/system/edac class reference */
1021 	edac_class = edac_get_sysfs_class();
1022 	if (edac_class == NULL) {
1023 		debugf1("%s() no edac_class error=%d\n", __func__, err);
1024 		goto fail_out;
1025 	}
1026 
1027 	/* Init the MC's kobject */
1028 	mc_kset = kset_create_and_add("mc", NULL, &edac_class->kset.kobj);
1029 	if (!mc_kset) {
1030 		err = -ENOMEM;
1031 		debugf1("%s() Failed to register '.../edac/mc'\n", __func__);
1032 		goto fail_kset;
1033 	}
1034 
1035 	debugf1("%s() Registered '.../edac/mc' kobject\n", __func__);
1036 
1037 	return 0;
1038 
1039 fail_kset:
1040 	edac_put_sysfs_class();
1041 
1042 fail_out:
1043 	return err;
1044 }
1045 
1046 /*
1047  * edac_sysfs_teardown_mc_kset
1048  *
1049  *	deconstruct the mc_ket for memory controllers
1050  */
1051 void edac_sysfs_teardown_mc_kset(void)
1052 {
1053 	kset_unregister(mc_kset);
1054 	edac_put_sysfs_class();
1055 }
1056 
1057