xref: /openbmc/linux/drivers/edac/edac_mc_sysfs.c (revision df2634f43f5106947f3735a0b61a6527a4b278cd)
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 interface:
440  *
441  * A MC driver can limit the scrubbing bandwidth based on the CPU type.
442  * Therefore, ->set_sdram_scrub_rate should be made to return the actual
443  * bandwidth that is accepted or 0 when scrubbing is to be disabled.
444  *
445  * Negative value still means that an error has occurred while setting
446  * the scrub rate.
447  */
448 static ssize_t mci_sdram_scrub_rate_store(struct mem_ctl_info *mci,
449 					  const char *data, size_t count)
450 {
451 	unsigned long bandwidth = 0;
452 	int new_bw = 0;
453 
454 	if (!mci->set_sdram_scrub_rate)
455 		return -EINVAL;
456 
457 	if (strict_strtoul(data, 10, &bandwidth) < 0)
458 		return -EINVAL;
459 
460 	new_bw = mci->set_sdram_scrub_rate(mci, bandwidth);
461 	if (new_bw >= 0) {
462 		edac_printk(KERN_DEBUG, EDAC_MC, "Scrub rate set to %d\n", new_bw);
463 		return count;
464 	}
465 
466 	edac_printk(KERN_DEBUG, EDAC_MC, "Error setting scrub rate to: %lu\n", bandwidth);
467 	return -EINVAL;
468 }
469 
470 /*
471  * ->get_sdram_scrub_rate() return value semantics same as above.
472  */
473 static ssize_t mci_sdram_scrub_rate_show(struct mem_ctl_info *mci, char *data)
474 {
475 	int bandwidth = 0;
476 
477 	if (!mci->get_sdram_scrub_rate)
478 		return -EINVAL;
479 
480 	bandwidth = mci->get_sdram_scrub_rate(mci);
481 	if (bandwidth < 0) {
482 		edac_printk(KERN_DEBUG, EDAC_MC, "Error reading scrub rate\n");
483 		return bandwidth;
484 	}
485 
486 	edac_printk(KERN_DEBUG, EDAC_MC, "Read scrub rate: %d\n", bandwidth);
487 	return sprintf(data, "%d\n", bandwidth);
488 }
489 
490 /* default attribute files for the MCI object */
491 static ssize_t mci_ue_count_show(struct mem_ctl_info *mci, char *data)
492 {
493 	return sprintf(data, "%d\n", mci->ue_count);
494 }
495 
496 static ssize_t mci_ce_count_show(struct mem_ctl_info *mci, char *data)
497 {
498 	return sprintf(data, "%d\n", mci->ce_count);
499 }
500 
501 static ssize_t mci_ce_noinfo_show(struct mem_ctl_info *mci, char *data)
502 {
503 	return sprintf(data, "%d\n", mci->ce_noinfo_count);
504 }
505 
506 static ssize_t mci_ue_noinfo_show(struct mem_ctl_info *mci, char *data)
507 {
508 	return sprintf(data, "%d\n", mci->ue_noinfo_count);
509 }
510 
511 static ssize_t mci_seconds_show(struct mem_ctl_info *mci, char *data)
512 {
513 	return sprintf(data, "%ld\n", (jiffies - mci->start_time) / HZ);
514 }
515 
516 static ssize_t mci_ctl_name_show(struct mem_ctl_info *mci, char *data)
517 {
518 	return sprintf(data, "%s\n", mci->ctl_name);
519 }
520 
521 static ssize_t mci_size_mb_show(struct mem_ctl_info *mci, char *data)
522 {
523 	int total_pages, csrow_idx;
524 
525 	for (total_pages = csrow_idx = 0; csrow_idx < mci->nr_csrows;
526 		csrow_idx++) {
527 		struct csrow_info *csrow = &mci->csrows[csrow_idx];
528 
529 		if (!csrow->nr_pages)
530 			continue;
531 
532 		total_pages += csrow->nr_pages;
533 	}
534 
535 	return sprintf(data, "%u\n", PAGES_TO_MiB(total_pages));
536 }
537 
538 #define to_mci(k) container_of(k, struct mem_ctl_info, edac_mci_kobj)
539 #define to_mcidev_attr(a) container_of(a,struct mcidev_sysfs_attribute,attr)
540 
541 /* MCI show/store functions for top most object */
542 static ssize_t mcidev_show(struct kobject *kobj, struct attribute *attr,
543 			char *buffer)
544 {
545 	struct mem_ctl_info *mem_ctl_info = to_mci(kobj);
546 	struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
547 
548 	debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
549 
550 	if (mcidev_attr->show)
551 		return mcidev_attr->show(mem_ctl_info, buffer);
552 
553 	return -EIO;
554 }
555 
556 static ssize_t mcidev_store(struct kobject *kobj, struct attribute *attr,
557 			const char *buffer, size_t count)
558 {
559 	struct mem_ctl_info *mem_ctl_info = to_mci(kobj);
560 	struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
561 
562 	debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
563 
564 	if (mcidev_attr->store)
565 		return mcidev_attr->store(mem_ctl_info, buffer, count);
566 
567 	return -EIO;
568 }
569 
570 /* Intermediate show/store table */
571 static const struct sysfs_ops mci_ops = {
572 	.show = mcidev_show,
573 	.store = mcidev_store
574 };
575 
576 #define MCIDEV_ATTR(_name,_mode,_show,_store)			\
577 static struct mcidev_sysfs_attribute mci_attr_##_name = {			\
578 	.attr = {.name = __stringify(_name), .mode = _mode },	\
579 	.show   = _show,					\
580 	.store  = _store,					\
581 };
582 
583 /* default Control file */
584 MCIDEV_ATTR(reset_counters, S_IWUSR, NULL, mci_reset_counters_store);
585 
586 /* default Attribute files */
587 MCIDEV_ATTR(mc_name, S_IRUGO, mci_ctl_name_show, NULL);
588 MCIDEV_ATTR(size_mb, S_IRUGO, mci_size_mb_show, NULL);
589 MCIDEV_ATTR(seconds_since_reset, S_IRUGO, mci_seconds_show, NULL);
590 MCIDEV_ATTR(ue_noinfo_count, S_IRUGO, mci_ue_noinfo_show, NULL);
591 MCIDEV_ATTR(ce_noinfo_count, S_IRUGO, mci_ce_noinfo_show, NULL);
592 MCIDEV_ATTR(ue_count, S_IRUGO, mci_ue_count_show, NULL);
593 MCIDEV_ATTR(ce_count, S_IRUGO, mci_ce_count_show, NULL);
594 
595 /* memory scrubber attribute file */
596 MCIDEV_ATTR(sdram_scrub_rate, S_IRUGO | S_IWUSR, mci_sdram_scrub_rate_show,
597 	mci_sdram_scrub_rate_store);
598 
599 static struct mcidev_sysfs_attribute *mci_attr[] = {
600 	&mci_attr_reset_counters,
601 	&mci_attr_mc_name,
602 	&mci_attr_size_mb,
603 	&mci_attr_seconds_since_reset,
604 	&mci_attr_ue_noinfo_count,
605 	&mci_attr_ce_noinfo_count,
606 	&mci_attr_ue_count,
607 	&mci_attr_ce_count,
608 	&mci_attr_sdram_scrub_rate,
609 	NULL
610 };
611 
612 
613 /*
614  * Release of a MC controlling instance
615  *
616  *	each MC control instance has the following resources upon entry:
617  *		a) a ref count on the top memctl kobj
618  *		b) a ref count on this module
619  *
620  *	this function must decrement those ref counts and then
621  *	issue a free on the instance's memory
622  */
623 static void edac_mci_control_release(struct kobject *kobj)
624 {
625 	struct mem_ctl_info *mci;
626 
627 	mci = to_mci(kobj);
628 
629 	debugf0("%s() mci instance idx=%d releasing\n", __func__, mci->mc_idx);
630 
631 	/* decrement the module ref count */
632 	module_put(mci->owner);
633 }
634 
635 static struct kobj_type ktype_mci = {
636 	.release = edac_mci_control_release,
637 	.sysfs_ops = &mci_ops,
638 	.default_attrs = (struct attribute **)mci_attr,
639 };
640 
641 /* EDAC memory controller sysfs kset:
642  *	/sys/devices/system/edac/mc
643  */
644 static struct kset *mc_kset;
645 
646 /*
647  * edac_mc_register_sysfs_main_kobj
648  *
649  *	setups and registers the main kobject for each mci
650  */
651 int edac_mc_register_sysfs_main_kobj(struct mem_ctl_info *mci)
652 {
653 	struct kobject *kobj_mci;
654 	int err;
655 
656 	debugf1("%s()\n", __func__);
657 
658 	kobj_mci = &mci->edac_mci_kobj;
659 
660 	/* Init the mci's kobject */
661 	memset(kobj_mci, 0, sizeof(*kobj_mci));
662 
663 	/* Record which module 'owns' this control structure
664 	 * and bump the ref count of the module
665 	 */
666 	mci->owner = THIS_MODULE;
667 
668 	/* bump ref count on this module */
669 	if (!try_module_get(mci->owner)) {
670 		err = -ENODEV;
671 		goto fail_out;
672 	}
673 
674 	/* this instance become part of the mc_kset */
675 	kobj_mci->kset = mc_kset;
676 
677 	/* register the mc<id> kobject to the mc_kset */
678 	err = kobject_init_and_add(kobj_mci, &ktype_mci, NULL,
679 				   "mc%d", mci->mc_idx);
680 	if (err) {
681 		debugf1("%s()Failed to register '.../edac/mc%d'\n",
682 			__func__, mci->mc_idx);
683 		goto kobj_reg_fail;
684 	}
685 	kobject_uevent(kobj_mci, KOBJ_ADD);
686 
687 	/* At this point, to 'free' the control struct,
688 	 * edac_mc_unregister_sysfs_main_kobj() must be used
689 	 */
690 
691 	debugf1("%s() Registered '.../edac/mc%d' kobject\n",
692 		__func__, mci->mc_idx);
693 
694 	return 0;
695 
696 	/* Error exit stack */
697 
698 kobj_reg_fail:
699 	module_put(mci->owner);
700 
701 fail_out:
702 	return err;
703 }
704 
705 /*
706  * edac_mc_register_sysfs_main_kobj
707  *
708  *	tears down and the main mci kobject from the mc_kset
709  */
710 void edac_mc_unregister_sysfs_main_kobj(struct mem_ctl_info *mci)
711 {
712 	debugf1("%s()\n", __func__);
713 
714 	/* delete the kobj from the mc_kset */
715 	kobject_put(&mci->edac_mci_kobj);
716 }
717 
718 #define EDAC_DEVICE_SYMLINK	"device"
719 
720 #define grp_to_mci(k) (container_of(k, struct mcidev_sysfs_group_kobj, kobj)->mci)
721 
722 /* MCI show/store functions for top most object */
723 static ssize_t inst_grp_show(struct kobject *kobj, struct attribute *attr,
724 			char *buffer)
725 {
726 	struct mem_ctl_info *mem_ctl_info = grp_to_mci(kobj);
727 	struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
728 
729 	debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
730 
731 	if (mcidev_attr->show)
732 		return mcidev_attr->show(mem_ctl_info, buffer);
733 
734 	return -EIO;
735 }
736 
737 static ssize_t inst_grp_store(struct kobject *kobj, struct attribute *attr,
738 			const char *buffer, size_t count)
739 {
740 	struct mem_ctl_info *mem_ctl_info = grp_to_mci(kobj);
741 	struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
742 
743 	debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
744 
745 	if (mcidev_attr->store)
746 		return mcidev_attr->store(mem_ctl_info, buffer, count);
747 
748 	return -EIO;
749 }
750 
751 /* No memory to release for this kobj */
752 static void edac_inst_grp_release(struct kobject *kobj)
753 {
754 	struct mcidev_sysfs_group_kobj *grp;
755 	struct mem_ctl_info *mci;
756 
757 	debugf1("%s()\n", __func__);
758 
759 	grp = container_of(kobj, struct mcidev_sysfs_group_kobj, kobj);
760 	mci = grp->mci;
761 }
762 
763 /* Intermediate show/store table */
764 static struct sysfs_ops inst_grp_ops = {
765 	.show = inst_grp_show,
766 	.store = inst_grp_store
767 };
768 
769 /* the kobj_type instance for a instance group */
770 static struct kobj_type ktype_inst_grp = {
771 	.release = edac_inst_grp_release,
772 	.sysfs_ops = &inst_grp_ops,
773 };
774 
775 
776 /*
777  * edac_create_mci_instance_attributes
778  *	create MC driver specific attributes bellow an specified kobj
779  * This routine calls itself recursively, in order to create an entire
780  * object tree.
781  */
782 static int edac_create_mci_instance_attributes(struct mem_ctl_info *mci,
783 				const struct mcidev_sysfs_attribute *sysfs_attrib,
784 				struct kobject *kobj)
785 {
786 	int err;
787 
788 	debugf1("%s()\n", __func__);
789 
790 	while (sysfs_attrib) {
791 		debugf1("%s() sysfs_attrib = %p\n",__func__, sysfs_attrib);
792 		if (sysfs_attrib->grp) {
793 			struct mcidev_sysfs_group_kobj *grp_kobj;
794 
795 			grp_kobj = kzalloc(sizeof(*grp_kobj), GFP_KERNEL);
796 			if (!grp_kobj)
797 				return -ENOMEM;
798 
799 			grp_kobj->grp = sysfs_attrib->grp;
800 			grp_kobj->mci = mci;
801 			list_add_tail(&grp_kobj->list, &mci->grp_kobj_list);
802 
803 			debugf0("%s() grp %s, mci %p\n", __func__,
804 				sysfs_attrib->grp->name, mci);
805 
806 			err = kobject_init_and_add(&grp_kobj->kobj,
807 						&ktype_inst_grp,
808 						&mci->edac_mci_kobj,
809 						sysfs_attrib->grp->name);
810 			if (err < 0) {
811 				printk(KERN_ERR "kobject_init_and_add failed: %d\n", err);
812 				return err;
813 			}
814 			err = edac_create_mci_instance_attributes(mci,
815 					grp_kobj->grp->mcidev_attr,
816 					&grp_kobj->kobj);
817 
818 			if (err < 0)
819 				return err;
820 		} else if (sysfs_attrib->attr.name) {
821 			debugf0("%s() file %s\n", __func__,
822 				sysfs_attrib->attr.name);
823 
824 			err = sysfs_create_file(kobj, &sysfs_attrib->attr);
825 			if (err < 0) {
826 				printk(KERN_ERR "sysfs_create_file failed: %d\n", err);
827 				return err;
828 			}
829 		} else
830 			break;
831 
832 		sysfs_attrib++;
833 	}
834 
835 	return 0;
836 }
837 
838 /*
839  * edac_remove_mci_instance_attributes
840  *	remove MC driver specific attributes at the topmost level
841  *	directory of this mci instance.
842  */
843 static void edac_remove_mci_instance_attributes(struct mem_ctl_info *mci,
844 				const struct mcidev_sysfs_attribute *sysfs_attrib,
845 				struct kobject *kobj, int count)
846 {
847 	struct mcidev_sysfs_group_kobj *grp_kobj, *tmp;
848 
849 	debugf1("%s()\n", __func__);
850 
851 	/*
852 	 * loop if there are attributes and until we hit a NULL entry
853 	 * Remove first all the atributes
854 	 */
855 	while (sysfs_attrib) {
856 		debugf1("%s() sysfs_attrib = %p\n",__func__, sysfs_attrib);
857 		if (sysfs_attrib->grp) {
858 			debugf1("%s() seeking for group %s\n",
859 				__func__, sysfs_attrib->grp->name);
860 			list_for_each_entry(grp_kobj,
861 					    &mci->grp_kobj_list, list) {
862 				debugf1("%s() grp_kobj->grp = %p\n",__func__, grp_kobj->grp);
863 				if (grp_kobj->grp == sysfs_attrib->grp) {
864 					edac_remove_mci_instance_attributes(mci,
865 						    grp_kobj->grp->mcidev_attr,
866 						    &grp_kobj->kobj, count + 1);
867 					debugf0("%s() group %s\n", __func__,
868 						sysfs_attrib->grp->name);
869 					kobject_put(&grp_kobj->kobj);
870 				}
871 			}
872 			debugf1("%s() end of seeking for group %s\n",
873 				__func__, sysfs_attrib->grp->name);
874 		} else if (sysfs_attrib->attr.name) {
875 			debugf0("%s() file %s\n", __func__,
876 				sysfs_attrib->attr.name);
877 			sysfs_remove_file(kobj, &sysfs_attrib->attr);
878 		} else
879 			break;
880 		sysfs_attrib++;
881 	}
882 
883 	/* Remove the group objects */
884 	if (count)
885 		return;
886 	list_for_each_entry_safe(grp_kobj, tmp,
887 				 &mci->grp_kobj_list, list) {
888 		list_del(&grp_kobj->list);
889 		kfree(grp_kobj);
890 	}
891 }
892 
893 
894 /*
895  * Create a new Memory Controller kobject instance,
896  *	mc<id> under the 'mc' directory
897  *
898  * Return:
899  *	0	Success
900  *	!0	Failure
901  */
902 int edac_create_sysfs_mci_device(struct mem_ctl_info *mci)
903 {
904 	int i;
905 	int err;
906 	struct csrow_info *csrow;
907 	struct kobject *kobj_mci = &mci->edac_mci_kobj;
908 
909 	debugf0("%s() idx=%d\n", __func__, mci->mc_idx);
910 
911 	INIT_LIST_HEAD(&mci->grp_kobj_list);
912 
913 	/* create a symlink for the device */
914 	err = sysfs_create_link(kobj_mci, &mci->dev->kobj,
915 				EDAC_DEVICE_SYMLINK);
916 	if (err) {
917 		debugf1("%s() failure to create symlink\n", __func__);
918 		goto fail0;
919 	}
920 
921 	/* If the low level driver desires some attributes,
922 	 * then create them now for the driver.
923 	 */
924 	if (mci->mc_driver_sysfs_attributes) {
925 		err = edac_create_mci_instance_attributes(mci,
926 					mci->mc_driver_sysfs_attributes,
927 					&mci->edac_mci_kobj);
928 		if (err) {
929 			debugf1("%s() failure to create mci attributes\n",
930 				__func__);
931 			goto fail0;
932 		}
933 	}
934 
935 	/* Make directories for each CSROW object under the mc<id> kobject
936 	 */
937 	for (i = 0; i < mci->nr_csrows; i++) {
938 		csrow = &mci->csrows[i];
939 
940 		/* Only expose populated CSROWs */
941 		if (csrow->nr_pages > 0) {
942 			err = edac_create_csrow_object(mci, csrow, i);
943 			if (err) {
944 				debugf1("%s() failure: create csrow %d obj\n",
945 					__func__, i);
946 				goto fail1;
947 			}
948 		}
949 	}
950 
951 	return 0;
952 
953 	/* CSROW error: backout what has already been registered,  */
954 fail1:
955 	for (i--; i >= 0; i--) {
956 		if (csrow->nr_pages > 0) {
957 			kobject_put(&mci->csrows[i].kobj);
958 		}
959 	}
960 
961 	/* remove the mci instance's attributes, if any */
962 	edac_remove_mci_instance_attributes(mci,
963 		mci->mc_driver_sysfs_attributes, &mci->edac_mci_kobj, 0);
964 
965 	/* remove the symlink */
966 	sysfs_remove_link(kobj_mci, EDAC_DEVICE_SYMLINK);
967 
968 fail0:
969 	return err;
970 }
971 
972 /*
973  * remove a Memory Controller instance
974  */
975 void edac_remove_sysfs_mci_device(struct mem_ctl_info *mci)
976 {
977 	int i;
978 
979 	debugf0("%s()\n", __func__);
980 
981 	/* remove all csrow kobjects */
982 	debugf0("%s()  unregister this mci kobj\n", __func__);
983 	for (i = 0; i < mci->nr_csrows; i++) {
984 		if (mci->csrows[i].nr_pages > 0) {
985 			debugf0("%s()  unreg csrow-%d\n", __func__, i);
986 			kobject_put(&mci->csrows[i].kobj);
987 		}
988 	}
989 
990 	/* remove this mci instance's attribtes */
991 	if (mci->mc_driver_sysfs_attributes) {
992 		debugf0("%s()  unregister mci private attributes\n", __func__);
993 		edac_remove_mci_instance_attributes(mci,
994 						mci->mc_driver_sysfs_attributes,
995 						&mci->edac_mci_kobj, 0);
996 	}
997 
998 	/* remove the symlink */
999 	debugf0("%s()  remove_link\n", __func__);
1000 	sysfs_remove_link(&mci->edac_mci_kobj, EDAC_DEVICE_SYMLINK);
1001 
1002 	/* unregister this instance's kobject */
1003 	debugf0("%s()  remove_mci_instance\n", __func__);
1004 	kobject_put(&mci->edac_mci_kobj);
1005 }
1006 
1007 
1008 
1009 
1010 /*
1011  * edac_setup_sysfs_mc_kset(void)
1012  *
1013  * Initialize the mc_kset for the 'mc' entry
1014  *	This requires creating the top 'mc' directory with a kset
1015  *	and its controls/attributes.
1016  *
1017  *	To this 'mc' kset, instance 'mci' will be grouped as children.
1018  *
1019  * Return:  0 SUCCESS
1020  *         !0 FAILURE error code
1021  */
1022 int edac_sysfs_setup_mc_kset(void)
1023 {
1024 	int err = -EINVAL;
1025 	struct sysdev_class *edac_class;
1026 
1027 	debugf1("%s()\n", __func__);
1028 
1029 	/* get the /sys/devices/system/edac class reference */
1030 	edac_class = edac_get_sysfs_class();
1031 	if (edac_class == NULL) {
1032 		debugf1("%s() no edac_class error=%d\n", __func__, err);
1033 		goto fail_out;
1034 	}
1035 
1036 	/* Init the MC's kobject */
1037 	mc_kset = kset_create_and_add("mc", NULL, &edac_class->kset.kobj);
1038 	if (!mc_kset) {
1039 		err = -ENOMEM;
1040 		debugf1("%s() Failed to register '.../edac/mc'\n", __func__);
1041 		goto fail_kset;
1042 	}
1043 
1044 	debugf1("%s() Registered '.../edac/mc' kobject\n", __func__);
1045 
1046 	return 0;
1047 
1048 fail_kset:
1049 	edac_put_sysfs_class();
1050 
1051 fail_out:
1052 	return err;
1053 }
1054 
1055 /*
1056  * edac_sysfs_teardown_mc_kset
1057  *
1058  *	deconstruct the mc_ket for memory controllers
1059  */
1060 void edac_sysfs_teardown_mc_kset(void)
1061 {
1062 	kset_unregister(mc_kset);
1063 	edac_put_sysfs_class();
1064 }
1065 
1066