ath5k: Use new dma_stop function on base.c
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / edac / edac_mc_sysfs.c
blobdce61f7ba38ba9094d9e300f62fe542312a623b1
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 return sprintf(data, "%u\n", PAGES_TO_MiB(csrow->nr_pages));
150 static ssize_t csrow_mem_type_show(struct csrow_info *csrow, char *data,
151 int private)
153 return sprintf(data, "%s\n", mem_types[csrow->mtype]);
156 static ssize_t csrow_dev_type_show(struct csrow_info *csrow, char *data,
157 int private)
159 return sprintf(data, "%s\n", dev_types[csrow->dtype]);
162 static ssize_t csrow_edac_mode_show(struct csrow_info *csrow, char *data,
163 int private)
165 return sprintf(data, "%s\n", edac_caps[csrow->edac_mode]);
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)
172 /* if field has not been initialized, there is nothing to send */
173 if (!csrow->channels[channel].label[0])
174 return 0;
176 return snprintf(data, EDAC_MC_LABEL_LEN, "%s\n",
177 csrow->channels[channel].label);
180 static ssize_t channel_dimm_label_store(struct csrow_info *csrow,
181 const char *data,
182 size_t count, int channel)
184 ssize_t max_size = 0;
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';
190 return max_size;
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)
197 return sprintf(data, "%u\n", csrow->channels[channel].ce_count);
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;
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)
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)
215 struct csrow_info *csrow = to_csrow(kobj);
216 struct csrowdev_attribute *csrowdev_attr = to_csrowdev_attr(attr);
218 if (csrowdev_attr->show)
219 return csrowdev_attr->show(csrow,
220 buffer, csrowdev_attr->private);
221 return -EIO;
224 static ssize_t csrowdev_store(struct kobject *kobj, struct attribute *attr,
225 const char *buffer, size_t count)
227 struct csrow_info *csrow = to_csrow(kobj);
228 struct csrowdev_attribute *csrowdev_attr = to_csrowdev_attr(attr);
230 if (csrowdev_attr->store)
231 return csrowdev_attr->store(csrow,
232 buffer,
233 count, csrowdev_attr->private);
234 return -EIO;
237 static const struct sysfs_ops csrowfs_ops = {
238 .show = csrowdev_show,
239 .store = csrowdev_store
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, \
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);
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,
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);
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
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);
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
311 #define EDAC_NR_CHANNELS 6
313 /* Create dynamic CHANNEL files, indexed by 'chan', under specifed CSROW */
314 static int edac_create_channel_files(struct kobject *kobj, int chan)
316 int err = -ENODEV;
318 if (chan >= EDAC_NR_CHANNELS)
319 return err;
321 /* create the DIMM label attribute file */
322 err = sysfs_create_file(kobj,
323 (struct attribute *)
324 dynamic_csrow_dimm_attr[chan]);
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__);
336 return err;
339 /* No memory to release for this kobj */
340 static void edac_csrow_instance_release(struct kobject *kobj)
342 struct mem_ctl_info *mci;
343 struct csrow_info *cs;
345 debugf1("%s()\n", __func__);
347 cs = container_of(kobj, struct csrow_info, kobj);
348 mci = cs->mci;
350 kobject_put(&mci->edac_mci_kobj);
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,
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)
364 struct kobject *kobj_mci = &mci->edac_mci_kobj;
365 struct kobject *kobj;
366 int chan;
367 int err;
369 /* generate ..../edac/mc/mc<id>/csrow<index> */
370 memset(&csrow->kobj, 0, sizeof(csrow->kobj));
371 csrow->mci = mci; /* include container up link */
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;
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;
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
391 /* Create the dyanmic attribute files on this csrow,
392 * namely, the DIMM labels and the channel ce_count
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;
402 kobject_uevent(&csrow->kobj, KOBJ_ADD);
403 return 0;
405 /* error unwind stack */
406 err_release_top_kobj:
407 kobject_put(&mci->edac_mci_kobj);
409 err_out:
410 return err;
413 /* default sysfs methods and data structures for the main MCI kobject */
415 static ssize_t mci_reset_counters_store(struct mem_ctl_info *mci,
416 const char *data, size_t count)
418 int row, chan;
420 mci->ue_noinfo_count = 0;
421 mci->ce_noinfo_count = 0;
422 mci->ue_count = 0;
423 mci->ce_count = 0;
425 for (row = 0; row < mci->nr_csrows; row++) {
426 struct csrow_info *ri = &mci->csrows[row];
428 ri->ue_count = 0;
429 ri->ce_count = 0;
431 for (chan = 0; chan < ri->nr_channels; chan++)
432 ri->channels[chan].ce_count = 0;
435 mci->start_time = jiffies;
436 return count;
439 /* memory scrubbing */
440 static ssize_t mci_sdram_scrub_rate_store(struct mem_ctl_info *mci,
441 const char *data, size_t count)
443 unsigned long bandwidth = 0;
444 int err;
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;
452 if (strict_strtoul(data, 10, &bandwidth) < 0)
453 return -EINVAL;
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;
461 else {
462 edac_printk(KERN_DEBUG, EDAC_MC,
463 "Scrub rate set to: %lu\n", bandwidth);
464 return count;
468 static ssize_t mci_sdram_scrub_rate_show(struct mem_ctl_info *mci, char *data)
470 u32 bandwidth = 0;
471 int err;
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;
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;
484 else {
485 edac_printk(KERN_DEBUG, EDAC_MC,
486 "Read scrub rate: %d\n", bandwidth);
487 return sprintf(data, "%d\n", bandwidth);
491 /* default attribute files for the MCI object */
492 static ssize_t mci_ue_count_show(struct mem_ctl_info *mci, char *data)
494 return sprintf(data, "%d\n", mci->ue_count);
497 static ssize_t mci_ce_count_show(struct mem_ctl_info *mci, char *data)
499 return sprintf(data, "%d\n", mci->ce_count);
502 static ssize_t mci_ce_noinfo_show(struct mem_ctl_info *mci, char *data)
504 return sprintf(data, "%d\n", mci->ce_noinfo_count);
507 static ssize_t mci_ue_noinfo_show(struct mem_ctl_info *mci, char *data)
509 return sprintf(data, "%d\n", mci->ue_noinfo_count);
512 static ssize_t mci_seconds_show(struct mem_ctl_info *mci, char *data)
514 return sprintf(data, "%ld\n", (jiffies - mci->start_time) / HZ);
517 static ssize_t mci_ctl_name_show(struct mem_ctl_info *mci, char *data)
519 return sprintf(data, "%s\n", mci->ctl_name);
522 static ssize_t mci_size_mb_show(struct mem_ctl_info *mci, char *data)
524 int total_pages, csrow_idx;
526 for (total_pages = csrow_idx = 0; csrow_idx < mci->nr_csrows;
527 csrow_idx++) {
528 struct csrow_info *csrow = &mci->csrows[csrow_idx];
530 if (!csrow->nr_pages)
531 continue;
533 total_pages += csrow->nr_pages;
536 return sprintf(data, "%u\n", PAGES_TO_MiB(total_pages));
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)
542 /* MCI show/store functions for top most object */
543 static ssize_t mcidev_show(struct kobject *kobj, struct attribute *attr,
544 char *buffer)
546 struct mem_ctl_info *mem_ctl_info = to_mci(kobj);
547 struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
549 debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
551 if (mcidev_attr->show)
552 return mcidev_attr->show(mem_ctl_info, buffer);
554 return -EIO;
557 static ssize_t mcidev_store(struct kobject *kobj, struct attribute *attr,
558 const char *buffer, size_t count)
560 struct mem_ctl_info *mem_ctl_info = to_mci(kobj);
561 struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
563 debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
565 if (mcidev_attr->store)
566 return mcidev_attr->store(mem_ctl_info, buffer, count);
568 return -EIO;
571 /* Intermediate show/store table */
572 static const struct sysfs_ops mci_ops = {
573 .show = mcidev_show,
574 .store = mcidev_store
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, \
584 /* default Control file */
585 MCIDEV_ATTR(reset_counters, S_IWUSR, NULL, mci_reset_counters_store);
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);
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);
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
615 * Release of a MC controlling instance
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
621 * this function must decrement those ref counts and then
622 * issue a free on the instance's memory
624 static void edac_mci_control_release(struct kobject *kobj)
626 struct mem_ctl_info *mci;
628 mci = to_mci(kobj);
630 debugf0("%s() mci instance idx=%d releasing\n", __func__, mci->mc_idx);
632 /* decrement the module ref count */
633 module_put(mci->owner);
636 static struct kobj_type ktype_mci = {
637 .release = edac_mci_control_release,
638 .sysfs_ops = &mci_ops,
639 .default_attrs = (struct attribute **)mci_attr,
642 /* EDAC memory controller sysfs kset:
643 * /sys/devices/system/edac/mc
645 static struct kset *mc_kset;
648 * edac_mc_register_sysfs_main_kobj
650 * setups and registers the main kobject for each mci
652 int edac_mc_register_sysfs_main_kobj(struct mem_ctl_info *mci)
654 struct kobject *kobj_mci;
655 int err;
657 debugf1("%s()\n", __func__);
659 kobj_mci = &mci->edac_mci_kobj;
661 /* Init the mci's kobject */
662 memset(kobj_mci, 0, sizeof(*kobj_mci));
664 /* Record which module 'owns' this control structure
665 * and bump the ref count of the module
667 mci->owner = THIS_MODULE;
669 /* bump ref count on this module */
670 if (!try_module_get(mci->owner)) {
671 err = -ENODEV;
672 goto fail_out;
675 /* this instance become part of the mc_kset */
676 kobj_mci->kset = mc_kset;
678 /* register the mc<id> kobject to the mc_kset */
679 err = kobject_init_and_add(kobj_mci, &ktype_mci, NULL,
680 "mc%d", mci->mc_idx);
681 if (err) {
682 debugf1("%s()Failed to register '.../edac/mc%d'\n",
683 __func__, mci->mc_idx);
684 goto kobj_reg_fail;
686 kobject_uevent(kobj_mci, KOBJ_ADD);
688 /* At this point, to 'free' the control struct,
689 * edac_mc_unregister_sysfs_main_kobj() must be used
692 debugf1("%s() Registered '.../edac/mc%d' kobject\n",
693 __func__, mci->mc_idx);
695 return 0;
697 /* Error exit stack */
699 kobj_reg_fail:
700 module_put(mci->owner);
702 fail_out:
703 return err;
707 * edac_mc_register_sysfs_main_kobj
709 * tears down and the main mci kobject from the mc_kset
711 void edac_mc_unregister_sysfs_main_kobj(struct mem_ctl_info *mci)
713 debugf1("%s()\n", __func__);
715 /* delete the kobj from the mc_kset */
716 kobject_put(&mci->edac_mci_kobj);
719 #define EDAC_DEVICE_SYMLINK "device"
721 #define grp_to_mci(k) (container_of(k, struct mcidev_sysfs_group_kobj, kobj)->mci)
723 /* MCI show/store functions for top most object */
724 static ssize_t inst_grp_show(struct kobject *kobj, struct attribute *attr,
725 char *buffer)
727 struct mem_ctl_info *mem_ctl_info = grp_to_mci(kobj);
728 struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
730 debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
732 if (mcidev_attr->show)
733 return mcidev_attr->show(mem_ctl_info, buffer);
735 return -EIO;
738 static ssize_t inst_grp_store(struct kobject *kobj, struct attribute *attr,
739 const char *buffer, size_t count)
741 struct mem_ctl_info *mem_ctl_info = grp_to_mci(kobj);
742 struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
744 debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
746 if (mcidev_attr->store)
747 return mcidev_attr->store(mem_ctl_info, buffer, count);
749 return -EIO;
752 /* No memory to release for this kobj */
753 static void edac_inst_grp_release(struct kobject *kobj)
755 struct mcidev_sysfs_group_kobj *grp;
756 struct mem_ctl_info *mci;
758 debugf1("%s()\n", __func__);
760 grp = container_of(kobj, struct mcidev_sysfs_group_kobj, kobj);
761 mci = grp->mci;
764 /* Intermediate show/store table */
765 static struct sysfs_ops inst_grp_ops = {
766 .show = inst_grp_show,
767 .store = inst_grp_store
770 /* the kobj_type instance for a instance group */
771 static struct kobj_type ktype_inst_grp = {
772 .release = edac_inst_grp_release,
773 .sysfs_ops = &inst_grp_ops,
778 * edac_create_mci_instance_attributes
779 * create MC driver specific attributes bellow an specified kobj
780 * This routine calls itself recursively, in order to create an entire
781 * object tree.
783 static int edac_create_mci_instance_attributes(struct mem_ctl_info *mci,
784 const struct mcidev_sysfs_attribute *sysfs_attrib,
785 struct kobject *kobj)
787 int err;
789 debugf1("%s()\n", __func__);
791 while (sysfs_attrib) {
792 debugf1("%s() sysfs_attrib = %p\n",__func__, sysfs_attrib);
793 if (sysfs_attrib->grp) {
794 struct mcidev_sysfs_group_kobj *grp_kobj;
796 grp_kobj = kzalloc(sizeof(*grp_kobj), GFP_KERNEL);
797 if (!grp_kobj)
798 return -ENOMEM;
800 grp_kobj->grp = sysfs_attrib->grp;
801 grp_kobj->mci = mci;
802 list_add_tail(&grp_kobj->list, &mci->grp_kobj_list);
804 debugf0("%s() grp %s, mci %p\n", __func__,
805 sysfs_attrib->grp->name, mci);
807 err = kobject_init_and_add(&grp_kobj->kobj,
808 &ktype_inst_grp,
809 &mci->edac_mci_kobj,
810 sysfs_attrib->grp->name);
811 if (err < 0) {
812 printk(KERN_ERR "kobject_init_and_add failed: %d\n", err);
813 return err;
815 err = edac_create_mci_instance_attributes(mci,
816 grp_kobj->grp->mcidev_attr,
817 &grp_kobj->kobj);
819 if (err < 0)
820 return err;
821 } else if (sysfs_attrib->attr.name) {
822 debugf0("%s() file %s\n", __func__,
823 sysfs_attrib->attr.name);
825 err = sysfs_create_file(kobj, &sysfs_attrib->attr);
826 if (err < 0) {
827 printk(KERN_ERR "sysfs_create_file failed: %d\n", err);
828 return err;
830 } else
831 break;
833 sysfs_attrib++;
836 return 0;
840 * edac_remove_mci_instance_attributes
841 * remove MC driver specific attributes at the topmost level
842 * directory of this mci instance.
844 static void edac_remove_mci_instance_attributes(struct mem_ctl_info *mci,
845 const struct mcidev_sysfs_attribute *sysfs_attrib,
846 struct kobject *kobj, int count)
848 struct mcidev_sysfs_group_kobj *grp_kobj, *tmp;
850 debugf1("%s()\n", __func__);
853 * loop if there are attributes and until we hit a NULL entry
854 * Remove first all the atributes
856 while (sysfs_attrib) {
857 debugf1("%s() sysfs_attrib = %p\n",__func__, sysfs_attrib);
858 if (sysfs_attrib->grp) {
859 debugf1("%s() seeking for group %s\n",
860 __func__, sysfs_attrib->grp->name);
861 list_for_each_entry(grp_kobj,
862 &mci->grp_kobj_list, list) {
863 debugf1("%s() grp_kobj->grp = %p\n",__func__, grp_kobj->grp);
864 if (grp_kobj->grp == sysfs_attrib->grp) {
865 edac_remove_mci_instance_attributes(mci,
866 grp_kobj->grp->mcidev_attr,
867 &grp_kobj->kobj, count + 1);
868 debugf0("%s() group %s\n", __func__,
869 sysfs_attrib->grp->name);
870 kobject_put(&grp_kobj->kobj);
873 debugf1("%s() end of seeking for group %s\n",
874 __func__, sysfs_attrib->grp->name);
875 } else if (sysfs_attrib->attr.name) {
876 debugf0("%s() file %s\n", __func__,
877 sysfs_attrib->attr.name);
878 sysfs_remove_file(kobj, &sysfs_attrib->attr);
879 } else
880 break;
881 sysfs_attrib++;
884 /* Remove the group objects */
885 if (count)
886 return;
887 list_for_each_entry_safe(grp_kobj, tmp,
888 &mci->grp_kobj_list, list) {
889 list_del(&grp_kobj->list);
890 kfree(grp_kobj);
896 * Create a new Memory Controller kobject instance,
897 * mc<id> under the 'mc' directory
899 * Return:
900 * 0 Success
901 * !0 Failure
903 int edac_create_sysfs_mci_device(struct mem_ctl_info *mci)
905 int i;
906 int err;
907 struct csrow_info *csrow;
908 struct kobject *kobj_mci = &mci->edac_mci_kobj;
910 debugf0("%s() idx=%d\n", __func__, mci->mc_idx);
912 INIT_LIST_HEAD(&mci->grp_kobj_list);
914 /* create a symlink for the device */
915 err = sysfs_create_link(kobj_mci, &mci->dev->kobj,
916 EDAC_DEVICE_SYMLINK);
917 if (err) {
918 debugf1("%s() failure to create symlink\n", __func__);
919 goto fail0;
922 /* If the low level driver desires some attributes,
923 * then create them now for the driver.
925 if (mci->mc_driver_sysfs_attributes) {
926 err = edac_create_mci_instance_attributes(mci,
927 mci->mc_driver_sysfs_attributes,
928 &mci->edac_mci_kobj);
929 if (err) {
930 debugf1("%s() failure to create mci attributes\n",
931 __func__);
932 goto fail0;
936 /* Make directories for each CSROW object under the mc<id> kobject
938 for (i = 0; i < mci->nr_csrows; i++) {
939 csrow = &mci->csrows[i];
941 /* Only expose populated CSROWs */
942 if (csrow->nr_pages > 0) {
943 err = edac_create_csrow_object(mci, csrow, i);
944 if (err) {
945 debugf1("%s() failure: create csrow %d obj\n",
946 __func__, i);
947 goto fail1;
952 return 0;
954 /* CSROW error: backout what has already been registered, */
955 fail1:
956 for (i--; i >= 0; i--) {
957 if (csrow->nr_pages > 0) {
958 kobject_put(&mci->csrows[i].kobj);
962 /* remove the mci instance's attributes, if any */
963 edac_remove_mci_instance_attributes(mci,
964 mci->mc_driver_sysfs_attributes, &mci->edac_mci_kobj, 0);
966 /* remove the symlink */
967 sysfs_remove_link(kobj_mci, EDAC_DEVICE_SYMLINK);
969 fail0:
970 return err;
974 * remove a Memory Controller instance
976 void edac_remove_sysfs_mci_device(struct mem_ctl_info *mci)
978 int i;
980 debugf0("%s()\n", __func__);
982 /* remove all csrow kobjects */
983 debugf0("%s() unregister this mci kobj\n", __func__);
984 for (i = 0; i < mci->nr_csrows; i++) {
985 if (mci->csrows[i].nr_pages > 0) {
986 debugf0("%s() unreg csrow-%d\n", __func__, i);
987 kobject_put(&mci->csrows[i].kobj);
991 /* remove this mci instance's attribtes */
992 if (mci->mc_driver_sysfs_attributes) {
993 debugf0("%s() unregister mci private attributes\n", __func__);
994 edac_remove_mci_instance_attributes(mci,
995 mci->mc_driver_sysfs_attributes,
996 &mci->edac_mci_kobj, 0);
999 /* remove the symlink */
1000 debugf0("%s() remove_link\n", __func__);
1001 sysfs_remove_link(&mci->edac_mci_kobj, EDAC_DEVICE_SYMLINK);
1003 /* unregister this instance's kobject */
1004 debugf0("%s() remove_mci_instance\n", __func__);
1005 kobject_put(&mci->edac_mci_kobj);
1012 * edac_setup_sysfs_mc_kset(void)
1014 * Initialize the mc_kset for the 'mc' entry
1015 * This requires creating the top 'mc' directory with a kset
1016 * and its controls/attributes.
1018 * To this 'mc' kset, instance 'mci' will be grouped as children.
1020 * Return: 0 SUCCESS
1021 * !0 FAILURE error code
1023 int edac_sysfs_setup_mc_kset(void)
1025 int err = -EINVAL;
1026 struct sysdev_class *edac_class;
1028 debugf1("%s()\n", __func__);
1030 /* get the /sys/devices/system/edac class reference */
1031 edac_class = edac_get_sysfs_class();
1032 if (edac_class == NULL) {
1033 debugf1("%s() no edac_class error=%d\n", __func__, err);
1034 goto fail_out;
1037 /* Init the MC's kobject */
1038 mc_kset = kset_create_and_add("mc", NULL, &edac_class->kset.kobj);
1039 if (!mc_kset) {
1040 err = -ENOMEM;
1041 debugf1("%s() Failed to register '.../edac/mc'\n", __func__);
1042 goto fail_kset;
1045 debugf1("%s() Registered '.../edac/mc' kobject\n", __func__);
1047 return 0;
1049 fail_kset:
1050 edac_put_sysfs_class();
1052 fail_out:
1053 return err;
1057 * edac_sysfs_teardown_mc_kset
1059 * deconstruct the mc_ket for memory controllers
1061 void edac_sysfs_teardown_mc_kset(void)
1063 kset_unregister(mc_kset);
1064 edac_put_sysfs_class();