Merge branch 'x86-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6/libata-dev.git] / drivers / edac / edac_mc_sysfs.c
blobf6a29b0eedc8535bb33769ca81cf8f88abe602e8
1 /*
2 * edac_mc kernel module
3 * (C) 2005-2007 Linux Networx (http://lnxi.com)
5 * This file may be distributed under the terms of the
6 * GNU General Public License.
8 * Written Doug Thompson <norsk5@xmission.com> www.softwarebitmaker.com
12 #include <linux/ctype.h>
13 #include <linux/slab.h>
14 #include <linux/edac.h>
15 #include <linux/bug.h>
17 #include "edac_core.h"
18 #include "edac_module.h"
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;
27 /* Getter functions for above */
28 int edac_mc_get_log_ue(void)
30 return edac_mc_log_ue;
33 int edac_mc_get_log_ce(void)
35 return edac_mc_log_ce;
38 int edac_mc_get_panic_on_ue(void)
40 return edac_mc_panic_on_ue;
43 /* this is temporary */
44 int edac_mc_get_poll_msec(void)
46 return edac_mc_poll_msec;
49 static int edac_set_poll_msec(const char *val, struct kernel_param *kp)
51 long l;
52 int ret;
54 if (!val)
55 return -EINVAL;
57 ret = strict_strtol(val, 0, &l);
58 if (ret == -EINVAL || ((int)l != l))
59 return -EINVAL;
60 *((int *)kp->arg) = l;
62 /* notify edac_mc engine to reset the poll period */
63 edac_mc_reset_delay_period(l);
65 return 0;
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");
82 * various constants for Memory Controllers
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"
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"
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"
128 /* EDAC sysfs CSROW data structures and methods
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)
135 return sprintf(data, "%u\n", csrow->ue_count);
138 static ssize_t csrow_ce_count_show(struct csrow_info *csrow, char *data,
139 int private)
141 return sprintf(data, "%u\n", csrow->ce_count);
144 static ssize_t csrow_size_show(struct csrow_info *csrow, char *data,
145 int private)
147 int i;
148 u32 nr_pages = 0;
150 for (i = 0; i < csrow->nr_channels; i++)
151 nr_pages += csrow->channels[i].dimm->nr_pages;
153 return sprintf(data, "%u\n", PAGES_TO_MiB(nr_pages));
156 static ssize_t csrow_mem_type_show(struct csrow_info *csrow, char *data,
157 int private)
159 return sprintf(data, "%s\n", mem_types[csrow->channels[0].dimm->mtype]);
162 static ssize_t csrow_dev_type_show(struct csrow_info *csrow, char *data,
163 int private)
165 return sprintf(data, "%s\n", dev_types[csrow->channels[0].dimm->dtype]);
168 static ssize_t csrow_edac_mode_show(struct csrow_info *csrow, char *data,
169 int private)
171 return sprintf(data, "%s\n", edac_caps[csrow->channels[0].dimm->edac_mode]);
174 /* show/store functions for DIMM Label attributes */
175 static ssize_t channel_dimm_label_show(struct csrow_info *csrow,
176 char *data, int channel)
178 /* if field has not been initialized, there is nothing to send */
179 if (!csrow->channels[channel].dimm->label[0])
180 return 0;
182 return snprintf(data, EDAC_MC_LABEL_LEN, "%s\n",
183 csrow->channels[channel].dimm->label);
186 static ssize_t channel_dimm_label_store(struct csrow_info *csrow,
187 const char *data,
188 size_t count, int channel)
190 ssize_t max_size = 0;
192 max_size = min((ssize_t) count, (ssize_t) EDAC_MC_LABEL_LEN - 1);
193 strncpy(csrow->channels[channel].dimm->label, data, max_size);
194 csrow->channels[channel].dimm->label[max_size] = '\0';
196 return max_size;
199 /* show function for dynamic chX_ce_count attribute */
200 static ssize_t channel_ce_count_show(struct csrow_info *csrow,
201 char *data, int channel)
203 return sprintf(data, "%u\n", csrow->channels[channel].ce_count);
206 /* csrow specific attribute structure */
207 struct csrowdev_attribute {
208 struct attribute attr;
209 ssize_t(*show) (struct csrow_info *, char *, int);
210 ssize_t(*store) (struct csrow_info *, const char *, size_t, int);
211 int private;
214 #define to_csrow(k) container_of(k, struct csrow_info, kobj)
215 #define to_csrowdev_attr(a) container_of(a, struct csrowdev_attribute, attr)
217 /* Set of show/store higher level functions for default csrow attributes */
218 static ssize_t csrowdev_show(struct kobject *kobj,
219 struct attribute *attr, char *buffer)
221 struct csrow_info *csrow = to_csrow(kobj);
222 struct csrowdev_attribute *csrowdev_attr = to_csrowdev_attr(attr);
224 if (csrowdev_attr->show)
225 return csrowdev_attr->show(csrow,
226 buffer, csrowdev_attr->private);
227 return -EIO;
230 static ssize_t csrowdev_store(struct kobject *kobj, struct attribute *attr,
231 const char *buffer, size_t count)
233 struct csrow_info *csrow = to_csrow(kobj);
234 struct csrowdev_attribute *csrowdev_attr = to_csrowdev_attr(attr);
236 if (csrowdev_attr->store)
237 return csrowdev_attr->store(csrow,
238 buffer,
239 count, csrowdev_attr->private);
240 return -EIO;
243 static const struct sysfs_ops csrowfs_ops = {
244 .show = csrowdev_show,
245 .store = csrowdev_store
248 #define CSROWDEV_ATTR(_name,_mode,_show,_store,_private) \
249 static struct csrowdev_attribute attr_##_name = { \
250 .attr = {.name = __stringify(_name), .mode = _mode }, \
251 .show = _show, \
252 .store = _store, \
253 .private = _private, \
256 /* default cwrow<id>/attribute files */
257 CSROWDEV_ATTR(size_mb, S_IRUGO, csrow_size_show, NULL, 0);
258 CSROWDEV_ATTR(dev_type, S_IRUGO, csrow_dev_type_show, NULL, 0);
259 CSROWDEV_ATTR(mem_type, S_IRUGO, csrow_mem_type_show, NULL, 0);
260 CSROWDEV_ATTR(edac_mode, S_IRUGO, csrow_edac_mode_show, NULL, 0);
261 CSROWDEV_ATTR(ue_count, S_IRUGO, csrow_ue_count_show, NULL, 0);
262 CSROWDEV_ATTR(ce_count, S_IRUGO, csrow_ce_count_show, NULL, 0);
264 /* default attributes of the CSROW<id> object */
265 static struct csrowdev_attribute *default_csrow_attr[] = {
266 &attr_dev_type,
267 &attr_mem_type,
268 &attr_edac_mode,
269 &attr_size_mb,
270 &attr_ue_count,
271 &attr_ce_count,
272 NULL,
275 /* possible dynamic channel DIMM Label attribute files */
276 CSROWDEV_ATTR(ch0_dimm_label, S_IRUGO | S_IWUSR,
277 channel_dimm_label_show, channel_dimm_label_store, 0);
278 CSROWDEV_ATTR(ch1_dimm_label, S_IRUGO | S_IWUSR,
279 channel_dimm_label_show, channel_dimm_label_store, 1);
280 CSROWDEV_ATTR(ch2_dimm_label, S_IRUGO | S_IWUSR,
281 channel_dimm_label_show, channel_dimm_label_store, 2);
282 CSROWDEV_ATTR(ch3_dimm_label, S_IRUGO | S_IWUSR,
283 channel_dimm_label_show, channel_dimm_label_store, 3);
284 CSROWDEV_ATTR(ch4_dimm_label, S_IRUGO | S_IWUSR,
285 channel_dimm_label_show, channel_dimm_label_store, 4);
286 CSROWDEV_ATTR(ch5_dimm_label, S_IRUGO | S_IWUSR,
287 channel_dimm_label_show, channel_dimm_label_store, 5);
289 /* Total possible dynamic DIMM Label attribute file table */
290 static struct csrowdev_attribute *dynamic_csrow_dimm_attr[] = {
291 &attr_ch0_dimm_label,
292 &attr_ch1_dimm_label,
293 &attr_ch2_dimm_label,
294 &attr_ch3_dimm_label,
295 &attr_ch4_dimm_label,
296 &attr_ch5_dimm_label
299 /* possible dynamic channel ce_count attribute files */
300 CSROWDEV_ATTR(ch0_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 0);
301 CSROWDEV_ATTR(ch1_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 1);
302 CSROWDEV_ATTR(ch2_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 2);
303 CSROWDEV_ATTR(ch3_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 3);
304 CSROWDEV_ATTR(ch4_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 4);
305 CSROWDEV_ATTR(ch5_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 5);
307 /* Total possible dynamic ce_count attribute file table */
308 static struct csrowdev_attribute *dynamic_csrow_ce_count_attr[] = {
309 &attr_ch0_ce_count,
310 &attr_ch1_ce_count,
311 &attr_ch2_ce_count,
312 &attr_ch3_ce_count,
313 &attr_ch4_ce_count,
314 &attr_ch5_ce_count
317 #define EDAC_NR_CHANNELS 6
319 /* Create dynamic CHANNEL files, indexed by 'chan', under specifed CSROW */
320 static int edac_create_channel_files(struct kobject *kobj, int chan)
322 int err = -ENODEV;
324 if (chan >= EDAC_NR_CHANNELS)
325 return err;
327 /* create the DIMM label attribute file */
328 err = sysfs_create_file(kobj,
329 (struct attribute *)
330 dynamic_csrow_dimm_attr[chan]);
332 if (!err) {
333 /* create the CE Count attribute file */
334 err = sysfs_create_file(kobj,
335 (struct attribute *)
336 dynamic_csrow_ce_count_attr[chan]);
337 } else {
338 debugf1("%s() dimm labels and ce_count files created",
339 __func__);
342 return err;
345 /* No memory to release for this kobj */
346 static void edac_csrow_instance_release(struct kobject *kobj)
348 struct mem_ctl_info *mci;
349 struct csrow_info *cs;
351 debugf1("%s()\n", __func__);
353 cs = container_of(kobj, struct csrow_info, kobj);
354 mci = cs->mci;
356 kobject_put(&mci->edac_mci_kobj);
359 /* the kobj_type instance for a CSROW */
360 static struct kobj_type ktype_csrow = {
361 .release = edac_csrow_instance_release,
362 .sysfs_ops = &csrowfs_ops,
363 .default_attrs = (struct attribute **)default_csrow_attr,
366 /* Create a CSROW object under specifed edac_mc_device */
367 static int edac_create_csrow_object(struct mem_ctl_info *mci,
368 struct csrow_info *csrow, int index)
370 struct kobject *kobj_mci = &mci->edac_mci_kobj;
371 struct kobject *kobj;
372 int chan;
373 int err;
375 /* generate ..../edac/mc/mc<id>/csrow<index> */
376 memset(&csrow->kobj, 0, sizeof(csrow->kobj));
377 csrow->mci = mci; /* include container up link */
379 /* bump the mci instance's kobject's ref count */
380 kobj = kobject_get(&mci->edac_mci_kobj);
381 if (!kobj) {
382 err = -ENODEV;
383 goto err_out;
386 /* Instanstiate the csrow object */
387 err = kobject_init_and_add(&csrow->kobj, &ktype_csrow, kobj_mci,
388 "csrow%d", index);
389 if (err)
390 goto err_release_top_kobj;
392 /* At this point, to release a csrow kobj, one must
393 * call the kobject_put and allow that tear down
394 * to work the releasing
397 /* Create the dyanmic attribute files on this csrow,
398 * namely, the DIMM labels and the channel ce_count
400 for (chan = 0; chan < csrow->nr_channels; chan++) {
401 err = edac_create_channel_files(&csrow->kobj, chan);
402 if (err) {
403 /* special case the unregister here */
404 kobject_put(&csrow->kobj);
405 goto err_out;
408 kobject_uevent(&csrow->kobj, KOBJ_ADD);
409 return 0;
411 /* error unwind stack */
412 err_release_top_kobj:
413 kobject_put(&mci->edac_mci_kobj);
415 err_out:
416 return err;
419 /* default sysfs methods and data structures for the main MCI kobject */
421 static ssize_t mci_reset_counters_store(struct mem_ctl_info *mci,
422 const char *data, size_t count)
424 int row, chan;
426 mci->ue_noinfo_count = 0;
427 mci->ce_noinfo_count = 0;
428 mci->ue_mc = 0;
429 mci->ce_mc = 0;
431 for (row = 0; row < mci->nr_csrows; row++) {
432 struct csrow_info *ri = &mci->csrows[row];
434 ri->ue_count = 0;
435 ri->ce_count = 0;
437 for (chan = 0; chan < ri->nr_channels; chan++)
438 ri->channels[chan].ce_count = 0;
441 mci->start_time = jiffies;
442 return count;
445 /* Memory scrubbing interface:
447 * A MC driver can limit the scrubbing bandwidth based on the CPU type.
448 * Therefore, ->set_sdram_scrub_rate should be made to return the actual
449 * bandwidth that is accepted or 0 when scrubbing is to be disabled.
451 * Negative value still means that an error has occurred while setting
452 * the scrub rate.
454 static ssize_t mci_sdram_scrub_rate_store(struct mem_ctl_info *mci,
455 const char *data, size_t count)
457 unsigned long bandwidth = 0;
458 int new_bw = 0;
460 if (!mci->set_sdram_scrub_rate)
461 return -ENODEV;
463 if (strict_strtoul(data, 10, &bandwidth) < 0)
464 return -EINVAL;
466 new_bw = mci->set_sdram_scrub_rate(mci, bandwidth);
467 if (new_bw < 0) {
468 edac_printk(KERN_WARNING, EDAC_MC,
469 "Error setting scrub rate to: %lu\n", bandwidth);
470 return -EINVAL;
473 return count;
477 * ->get_sdram_scrub_rate() return value semantics same as above.
479 static ssize_t mci_sdram_scrub_rate_show(struct mem_ctl_info *mci, char *data)
481 int bandwidth = 0;
483 if (!mci->get_sdram_scrub_rate)
484 return -ENODEV;
486 bandwidth = mci->get_sdram_scrub_rate(mci);
487 if (bandwidth < 0) {
488 edac_printk(KERN_DEBUG, EDAC_MC, "Error reading scrub rate\n");
489 return bandwidth;
492 return sprintf(data, "%d\n", bandwidth);
495 /* default attribute files for the MCI object */
496 static ssize_t mci_ue_count_show(struct mem_ctl_info *mci, char *data)
498 return sprintf(data, "%d\n", mci->ue_mc);
501 static ssize_t mci_ce_count_show(struct mem_ctl_info *mci, char *data)
503 return sprintf(data, "%d\n", mci->ce_mc);
506 static ssize_t mci_ce_noinfo_show(struct mem_ctl_info *mci, char *data)
508 return sprintf(data, "%d\n", mci->ce_noinfo_count);
511 static ssize_t mci_ue_noinfo_show(struct mem_ctl_info *mci, char *data)
513 return sprintf(data, "%d\n", mci->ue_noinfo_count);
516 static ssize_t mci_seconds_show(struct mem_ctl_info *mci, char *data)
518 return sprintf(data, "%ld\n", (jiffies - mci->start_time) / HZ);
521 static ssize_t mci_ctl_name_show(struct mem_ctl_info *mci, char *data)
523 return sprintf(data, "%s\n", mci->ctl_name);
526 static ssize_t mci_size_mb_show(struct mem_ctl_info *mci, char *data)
528 int total_pages = 0, csrow_idx, j;
530 for (csrow_idx = 0; csrow_idx < mci->nr_csrows; csrow_idx++) {
531 struct csrow_info *csrow = &mci->csrows[csrow_idx];
533 for (j = 0; j < csrow->nr_channels; j++) {
534 struct dimm_info *dimm = csrow->channels[j].dimm;
536 total_pages += dimm->nr_pages;
540 return sprintf(data, "%u\n", PAGES_TO_MiB(total_pages));
543 #define to_mci(k) container_of(k, struct mem_ctl_info, edac_mci_kobj)
544 #define to_mcidev_attr(a) container_of(a,struct mcidev_sysfs_attribute,attr)
546 /* MCI show/store functions for top most object */
547 static ssize_t mcidev_show(struct kobject *kobj, struct attribute *attr,
548 char *buffer)
550 struct mem_ctl_info *mem_ctl_info = to_mci(kobj);
551 struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
553 debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
555 if (mcidev_attr->show)
556 return mcidev_attr->show(mem_ctl_info, buffer);
558 return -EIO;
561 static ssize_t mcidev_store(struct kobject *kobj, struct attribute *attr,
562 const char *buffer, size_t count)
564 struct mem_ctl_info *mem_ctl_info = to_mci(kobj);
565 struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
567 debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
569 if (mcidev_attr->store)
570 return mcidev_attr->store(mem_ctl_info, buffer, count);
572 return -EIO;
575 /* Intermediate show/store table */
576 static const struct sysfs_ops mci_ops = {
577 .show = mcidev_show,
578 .store = mcidev_store
581 #define MCIDEV_ATTR(_name,_mode,_show,_store) \
582 static struct mcidev_sysfs_attribute mci_attr_##_name = { \
583 .attr = {.name = __stringify(_name), .mode = _mode }, \
584 .show = _show, \
585 .store = _store, \
588 /* default Control file */
589 MCIDEV_ATTR(reset_counters, S_IWUSR, NULL, mci_reset_counters_store);
591 /* default Attribute files */
592 MCIDEV_ATTR(mc_name, S_IRUGO, mci_ctl_name_show, NULL);
593 MCIDEV_ATTR(size_mb, S_IRUGO, mci_size_mb_show, NULL);
594 MCIDEV_ATTR(seconds_since_reset, S_IRUGO, mci_seconds_show, NULL);
595 MCIDEV_ATTR(ue_noinfo_count, S_IRUGO, mci_ue_noinfo_show, NULL);
596 MCIDEV_ATTR(ce_noinfo_count, S_IRUGO, mci_ce_noinfo_show, NULL);
597 MCIDEV_ATTR(ue_count, S_IRUGO, mci_ue_count_show, NULL);
598 MCIDEV_ATTR(ce_count, S_IRUGO, mci_ce_count_show, NULL);
600 /* memory scrubber attribute file */
601 MCIDEV_ATTR(sdram_scrub_rate, S_IRUGO | S_IWUSR, mci_sdram_scrub_rate_show,
602 mci_sdram_scrub_rate_store);
604 static struct mcidev_sysfs_attribute *mci_attr[] = {
605 &mci_attr_reset_counters,
606 &mci_attr_mc_name,
607 &mci_attr_size_mb,
608 &mci_attr_seconds_since_reset,
609 &mci_attr_ue_noinfo_count,
610 &mci_attr_ce_noinfo_count,
611 &mci_attr_ue_count,
612 &mci_attr_ce_count,
613 &mci_attr_sdram_scrub_rate,
614 NULL
619 * Release of a MC controlling instance
621 * each MC control instance has the following resources upon entry:
622 * a) a ref count on the top memctl kobj
623 * b) a ref count on this module
625 * this function must decrement those ref counts and then
626 * issue a free on the instance's memory
628 static void edac_mci_control_release(struct kobject *kobj)
630 struct mem_ctl_info *mci;
632 mci = to_mci(kobj);
634 debugf0("%s() mci instance idx=%d releasing\n", __func__, mci->mc_idx);
636 /* decrement the module ref count */
637 module_put(mci->owner);
640 static struct kobj_type ktype_mci = {
641 .release = edac_mci_control_release,
642 .sysfs_ops = &mci_ops,
643 .default_attrs = (struct attribute **)mci_attr,
646 /* EDAC memory controller sysfs kset:
647 * /sys/devices/system/edac/mc
649 static struct kset *mc_kset;
652 * edac_mc_register_sysfs_main_kobj
654 * setups and registers the main kobject for each mci
656 int edac_mc_register_sysfs_main_kobj(struct mem_ctl_info *mci)
658 struct kobject *kobj_mci;
659 int err;
661 debugf1("%s()\n", __func__);
663 kobj_mci = &mci->edac_mci_kobj;
665 /* Init the mci's kobject */
666 memset(kobj_mci, 0, sizeof(*kobj_mci));
668 /* Record which module 'owns' this control structure
669 * and bump the ref count of the module
671 mci->owner = THIS_MODULE;
673 /* bump ref count on this module */
674 if (!try_module_get(mci->owner)) {
675 err = -ENODEV;
676 goto fail_out;
679 /* this instance become part of the mc_kset */
680 kobj_mci->kset = mc_kset;
682 /* register the mc<id> kobject to the mc_kset */
683 err = kobject_init_and_add(kobj_mci, &ktype_mci, NULL,
684 "mc%d", mci->mc_idx);
685 if (err) {
686 debugf1("%s()Failed to register '.../edac/mc%d'\n",
687 __func__, mci->mc_idx);
688 goto kobj_reg_fail;
690 kobject_uevent(kobj_mci, KOBJ_ADD);
692 /* At this point, to 'free' the control struct,
693 * edac_mc_unregister_sysfs_main_kobj() must be used
696 debugf1("%s() Registered '.../edac/mc%d' kobject\n",
697 __func__, mci->mc_idx);
699 return 0;
701 /* Error exit stack */
703 kobj_reg_fail:
704 module_put(mci->owner);
706 fail_out:
707 return err;
711 * edac_mc_register_sysfs_main_kobj
713 * tears down and the main mci kobject from the mc_kset
715 void edac_mc_unregister_sysfs_main_kobj(struct mem_ctl_info *mci)
717 debugf1("%s()\n", __func__);
719 /* delete the kobj from the mc_kset */
720 kobject_put(&mci->edac_mci_kobj);
723 #define EDAC_DEVICE_SYMLINK "device"
725 #define grp_to_mci(k) (container_of(k, struct mcidev_sysfs_group_kobj, kobj)->mci)
727 /* MCI show/store functions for top most object */
728 static ssize_t inst_grp_show(struct kobject *kobj, struct attribute *attr,
729 char *buffer)
731 struct mem_ctl_info *mem_ctl_info = grp_to_mci(kobj);
732 struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
734 debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
736 if (mcidev_attr->show)
737 return mcidev_attr->show(mem_ctl_info, buffer);
739 return -EIO;
742 static ssize_t inst_grp_store(struct kobject *kobj, struct attribute *attr,
743 const char *buffer, size_t count)
745 struct mem_ctl_info *mem_ctl_info = grp_to_mci(kobj);
746 struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
748 debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
750 if (mcidev_attr->store)
751 return mcidev_attr->store(mem_ctl_info, buffer, count);
753 return -EIO;
756 /* No memory to release for this kobj */
757 static void edac_inst_grp_release(struct kobject *kobj)
759 struct mcidev_sysfs_group_kobj *grp;
760 struct mem_ctl_info *mci;
762 debugf1("%s()\n", __func__);
764 grp = container_of(kobj, struct mcidev_sysfs_group_kobj, kobj);
765 mci = grp->mci;
768 /* Intermediate show/store table */
769 static struct sysfs_ops inst_grp_ops = {
770 .show = inst_grp_show,
771 .store = inst_grp_store
774 /* the kobj_type instance for a instance group */
775 static struct kobj_type ktype_inst_grp = {
776 .release = edac_inst_grp_release,
777 .sysfs_ops = &inst_grp_ops,
782 * edac_create_mci_instance_attributes
783 * create MC driver specific attributes bellow an specified kobj
784 * This routine calls itself recursively, in order to create an entire
785 * object tree.
787 static int edac_create_mci_instance_attributes(struct mem_ctl_info *mci,
788 const struct mcidev_sysfs_attribute *sysfs_attrib,
789 struct kobject *kobj)
791 int err;
793 debugf4("%s()\n", __func__);
795 while (sysfs_attrib) {
796 debugf4("%s() sysfs_attrib = %p\n",__func__, sysfs_attrib);
797 if (sysfs_attrib->grp) {
798 struct mcidev_sysfs_group_kobj *grp_kobj;
800 grp_kobj = kzalloc(sizeof(*grp_kobj), GFP_KERNEL);
801 if (!grp_kobj)
802 return -ENOMEM;
804 grp_kobj->grp = sysfs_attrib->grp;
805 grp_kobj->mci = mci;
806 list_add_tail(&grp_kobj->list, &mci->grp_kobj_list);
808 debugf0("%s() grp %s, mci %p\n", __func__,
809 sysfs_attrib->grp->name, mci);
811 err = kobject_init_and_add(&grp_kobj->kobj,
812 &ktype_inst_grp,
813 &mci->edac_mci_kobj,
814 sysfs_attrib->grp->name);
815 if (err < 0) {
816 printk(KERN_ERR "kobject_init_and_add failed: %d\n", err);
817 return err;
819 err = edac_create_mci_instance_attributes(mci,
820 grp_kobj->grp->mcidev_attr,
821 &grp_kobj->kobj);
823 if (err < 0)
824 return err;
825 } else if (sysfs_attrib->attr.name) {
826 debugf4("%s() file %s\n", __func__,
827 sysfs_attrib->attr.name);
829 err = sysfs_create_file(kobj, &sysfs_attrib->attr);
830 if (err < 0) {
831 printk(KERN_ERR "sysfs_create_file failed: %d\n", err);
832 return err;
834 } else
835 break;
837 sysfs_attrib++;
840 return 0;
844 * edac_remove_mci_instance_attributes
845 * remove MC driver specific attributes at the topmost level
846 * directory of this mci instance.
848 static void edac_remove_mci_instance_attributes(struct mem_ctl_info *mci,
849 const struct mcidev_sysfs_attribute *sysfs_attrib,
850 struct kobject *kobj, int count)
852 struct mcidev_sysfs_group_kobj *grp_kobj, *tmp;
854 debugf1("%s()\n", __func__);
857 * loop if there are attributes and until we hit a NULL entry
858 * Remove first all the attributes
860 while (sysfs_attrib) {
861 debugf4("%s() sysfs_attrib = %p\n",__func__, sysfs_attrib);
862 if (sysfs_attrib->grp) {
863 debugf4("%s() seeking for group %s\n",
864 __func__, sysfs_attrib->grp->name);
865 list_for_each_entry(grp_kobj,
866 &mci->grp_kobj_list, list) {
867 debugf4("%s() grp_kobj->grp = %p\n",__func__, grp_kobj->grp);
868 if (grp_kobj->grp == sysfs_attrib->grp) {
869 edac_remove_mci_instance_attributes(mci,
870 grp_kobj->grp->mcidev_attr,
871 &grp_kobj->kobj, count + 1);
872 debugf4("%s() group %s\n", __func__,
873 sysfs_attrib->grp->name);
874 kobject_put(&grp_kobj->kobj);
877 debugf4("%s() end of seeking for group %s\n",
878 __func__, sysfs_attrib->grp->name);
879 } else if (sysfs_attrib->attr.name) {
880 debugf4("%s() file %s\n", __func__,
881 sysfs_attrib->attr.name);
882 sysfs_remove_file(kobj, &sysfs_attrib->attr);
883 } else
884 break;
885 sysfs_attrib++;
888 /* Remove the group objects */
889 if (count)
890 return;
891 list_for_each_entry_safe(grp_kobj, tmp,
892 &mci->grp_kobj_list, list) {
893 list_del(&grp_kobj->list);
894 kfree(grp_kobj);
900 * Create a new Memory Controller kobject instance,
901 * mc<id> under the 'mc' directory
903 * Return:
904 * 0 Success
905 * !0 Failure
907 int edac_create_sysfs_mci_device(struct mem_ctl_info *mci)
909 int i, j;
910 int err;
911 struct csrow_info *csrow;
912 struct kobject *kobj_mci = &mci->edac_mci_kobj;
914 debugf0("%s() idx=%d\n", __func__, mci->mc_idx);
916 INIT_LIST_HEAD(&mci->grp_kobj_list);
918 /* create a symlink for the device */
919 err = sysfs_create_link(kobj_mci, &mci->dev->kobj,
920 EDAC_DEVICE_SYMLINK);
921 if (err) {
922 debugf1("%s() failure to create symlink\n", __func__);
923 goto fail0;
926 /* If the low level driver desires some attributes,
927 * then create them now for the driver.
929 if (mci->mc_driver_sysfs_attributes) {
930 err = edac_create_mci_instance_attributes(mci,
931 mci->mc_driver_sysfs_attributes,
932 &mci->edac_mci_kobj);
933 if (err) {
934 debugf1("%s() failure to create mci attributes\n",
935 __func__);
936 goto fail0;
940 /* Make directories for each CSROW object under the mc<id> kobject
942 for (i = 0; i < mci->nr_csrows; i++) {
943 int nr_pages = 0;
945 csrow = &mci->csrows[i];
946 for (j = 0; j < csrow->nr_channels; j++)
947 nr_pages += csrow->channels[j].dimm->nr_pages;
949 if (nr_pages > 0) {
950 err = edac_create_csrow_object(mci, csrow, i);
951 if (err) {
952 debugf1("%s() failure: create csrow %d obj\n",
953 __func__, i);
954 goto fail1;
959 return 0;
961 fail1:
962 for (i--; i >= 0; i--) {
963 int nr_pages = 0;
965 csrow = &mci->csrows[i];
966 for (j = 0; j < csrow->nr_channels; j++)
967 nr_pages += csrow->channels[j].dimm->nr_pages;
968 if (nr_pages > 0)
969 kobject_put(&mci->csrows[i].kobj);
972 /* remove the mci instance's attributes, if any */
973 edac_remove_mci_instance_attributes(mci,
974 mci->mc_driver_sysfs_attributes, &mci->edac_mci_kobj, 0);
976 /* remove the symlink */
977 sysfs_remove_link(kobj_mci, EDAC_DEVICE_SYMLINK);
979 fail0:
980 return err;
984 * remove a Memory Controller instance
986 void edac_remove_sysfs_mci_device(struct mem_ctl_info *mci)
988 struct csrow_info *csrow;
989 int i, j;
991 debugf0("%s()\n", __func__);
993 /* remove all csrow kobjects */
994 debugf4("%s() unregister this mci kobj\n", __func__);
995 for (i = 0; i < mci->nr_csrows; i++) {
996 int nr_pages = 0;
998 csrow = &mci->csrows[i];
999 for (j = 0; j < csrow->nr_channels; j++)
1000 nr_pages += csrow->channels[j].dimm->nr_pages;
1001 if (nr_pages > 0) {
1002 debugf0("%s() unreg csrow-%d\n", __func__, i);
1003 kobject_put(&mci->csrows[i].kobj);
1007 /* remove this mci instance's attribtes */
1008 if (mci->mc_driver_sysfs_attributes) {
1009 debugf4("%s() unregister mci private attributes\n", __func__);
1010 edac_remove_mci_instance_attributes(mci,
1011 mci->mc_driver_sysfs_attributes,
1012 &mci->edac_mci_kobj, 0);
1015 /* remove the symlink */
1016 debugf4("%s() remove_link\n", __func__);
1017 sysfs_remove_link(&mci->edac_mci_kobj, EDAC_DEVICE_SYMLINK);
1019 /* unregister this instance's kobject */
1020 debugf4("%s() remove_mci_instance\n", __func__);
1021 kobject_put(&mci->edac_mci_kobj);
1028 * edac_setup_sysfs_mc_kset(void)
1030 * Initialize the mc_kset for the 'mc' entry
1031 * This requires creating the top 'mc' directory with a kset
1032 * and its controls/attributes.
1034 * To this 'mc' kset, instance 'mci' will be grouped as children.
1036 * Return: 0 SUCCESS
1037 * !0 FAILURE error code
1039 int edac_sysfs_setup_mc_kset(void)
1041 int err = -EINVAL;
1042 struct bus_type *edac_subsys;
1044 debugf1("%s()\n", __func__);
1046 /* get the /sys/devices/system/edac subsys reference */
1047 edac_subsys = edac_get_sysfs_subsys();
1048 if (edac_subsys == NULL) {
1049 debugf1("%s() no edac_subsys error=%d\n", __func__, err);
1050 goto fail_out;
1053 /* Init the MC's kobject */
1054 mc_kset = kset_create_and_add("mc", NULL, &edac_subsys->dev_root->kobj);
1055 if (!mc_kset) {
1056 err = -ENOMEM;
1057 debugf1("%s() Failed to register '.../edac/mc'\n", __func__);
1058 goto fail_kset;
1061 debugf1("%s() Registered '.../edac/mc' kobject\n", __func__);
1063 return 0;
1065 fail_kset:
1066 edac_put_sysfs_subsys();
1068 fail_out:
1069 return err;
1073 * edac_sysfs_teardown_mc_kset
1075 * deconstruct the mc_ket for memory controllers
1077 void edac_sysfs_teardown_mc_kset(void)
1079 kset_unregister(mc_kset);
1080 edac_put_sysfs_subsys();