edac: core fix redundant sysfs controls to parameters
[linux-2.6.git] / drivers / edac / edac_mc_sysfs.c
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/bug.h>
14
15 #include "edac_core.h"
16 #include "edac_module.h"
17
18
19 /* MC EDAC Controls, setable by module parameter, and sysfs */
20 static int edac_mc_log_ue = 1;
21 static int edac_mc_log_ce = 1;
22 static int edac_mc_panic_on_ue;
23 static int edac_mc_poll_msec = 1000;
24
25 /* Getter functions for above */
26 int edac_mc_get_log_ue(void)
27 {
28         return edac_mc_log_ue;
29 }
30
31 int edac_mc_get_log_ce(void)
32 {
33         return edac_mc_log_ce;
34 }
35
36 int edac_mc_get_panic_on_ue(void)
37 {
38         return edac_mc_panic_on_ue;
39 }
40
41 /* this is temporary */
42 int edac_mc_get_poll_msec(void)
43 {
44         return edac_mc_poll_msec;
45 }
46
47 static int edac_set_poll_msec(const char *val, struct kernel_param *kp)
48 {
49         long l;
50         int ret;
51
52         if (!val)
53                 return -EINVAL;
54
55         ret = strict_strtol(val, 0, &l);
56         if (ret == -EINVAL || ((int)l != l))
57                 return -EINVAL;
58         *((int *)kp->arg) = l;
59
60         /* notify edac_mc engine to reset the poll period */
61         edac_mc_reset_delay_period(l);
62
63         return 0;
64 }
65
66 /* Parameter declarations for above */
67 module_param(edac_mc_panic_on_ue, int, 0644);
68 MODULE_PARM_DESC(edac_mc_panic_on_ue, "Panic on uncorrected error: 0=off 1=on");
69 module_param(edac_mc_log_ue, int, 0644);
70 MODULE_PARM_DESC(edac_mc_log_ue,
71                  "Log uncorrectable error to console: 0=off 1=on");
72 module_param(edac_mc_log_ce, int, 0644);
73 MODULE_PARM_DESC(edac_mc_log_ce,
74                  "Log correctable error to console: 0=off 1=on");
75 module_param_call(edac_mc_poll_msec, edac_set_poll_msec, param_get_int,
76                   &edac_mc_poll_msec, 0644);
77 MODULE_PARM_DESC(edac_mc_poll_msec, "Polling period in milliseconds");
78
79 /*
80  * various constants for Memory Controllers
81  */
82 static const char *mem_types[] = {
83         [MEM_EMPTY] = "Empty",
84         [MEM_RESERVED] = "Reserved",
85         [MEM_UNKNOWN] = "Unknown",
86         [MEM_FPM] = "FPM",
87         [MEM_EDO] = "EDO",
88         [MEM_BEDO] = "BEDO",
89         [MEM_SDR] = "Unbuffered-SDR",
90         [MEM_RDR] = "Registered-SDR",
91         [MEM_DDR] = "Unbuffered-DDR",
92         [MEM_RDDR] = "Registered-DDR",
93         [MEM_RMBS] = "RMBS",
94         [MEM_DDR2] = "Unbuffered-DDR2",
95         [MEM_FB_DDR2] = "FullyBuffered-DDR2",
96         [MEM_RDDR2] = "Registered-DDR2",
97         [MEM_XDR] = "XDR"
98 };
99
100 static const char *dev_types[] = {
101         [DEV_UNKNOWN] = "Unknown",
102         [DEV_X1] = "x1",
103         [DEV_X2] = "x2",
104         [DEV_X4] = "x4",
105         [DEV_X8] = "x8",
106         [DEV_X16] = "x16",
107         [DEV_X32] = "x32",
108         [DEV_X64] = "x64"
109 };
110
111 static const char *edac_caps[] = {
112         [EDAC_UNKNOWN] = "Unknown",
113         [EDAC_NONE] = "None",
114         [EDAC_RESERVED] = "Reserved",
115         [EDAC_PARITY] = "PARITY",
116         [EDAC_EC] = "EC",
117         [EDAC_SECDED] = "SECDED",
118         [EDAC_S2ECD2ED] = "S2ECD2ED",
119         [EDAC_S4ECD4ED] = "S4ECD4ED",
120         [EDAC_S8ECD8ED] = "S8ECD8ED",
121         [EDAC_S16ECD16ED] = "S16ECD16ED"
122 };
123
124
125
126 static ssize_t memctrl_int_store(void *ptr, const char *buffer, size_t count)
127 {
128         int *value = (int *)ptr;
129
130         if (isdigit(*buffer))
131                 *value = simple_strtoul(buffer, NULL, 0);
132
133         return count;
134 }
135
136
137 /* EDAC sysfs CSROW data structures and methods
138  */
139
140 /* Set of more default csrow<id> attribute show/store functions */
141 static ssize_t csrow_ue_count_show(struct csrow_info *csrow, char *data,
142                                 int private)
143 {
144         return sprintf(data, "%u\n", csrow->ue_count);
145 }
146
147 static ssize_t csrow_ce_count_show(struct csrow_info *csrow, char *data,
148                                 int private)
149 {
150         return sprintf(data, "%u\n", csrow->ce_count);
151 }
152
153 static ssize_t csrow_size_show(struct csrow_info *csrow, char *data,
154                                 int private)
155 {
156         return sprintf(data, "%u\n", PAGES_TO_MiB(csrow->nr_pages));
157 }
158
159 static ssize_t csrow_mem_type_show(struct csrow_info *csrow, char *data,
160                                 int private)
161 {
162         return sprintf(data, "%s\n", mem_types[csrow->mtype]);
163 }
164
165 static ssize_t csrow_dev_type_show(struct csrow_info *csrow, char *data,
166                                 int private)
167 {
168         return sprintf(data, "%s\n", dev_types[csrow->dtype]);
169 }
170
171 static ssize_t csrow_edac_mode_show(struct csrow_info *csrow, char *data,
172                                 int private)
173 {
174         return sprintf(data, "%s\n", edac_caps[csrow->edac_mode]);
175 }
176
177 /* show/store functions for DIMM Label attributes */
178 static ssize_t channel_dimm_label_show(struct csrow_info *csrow,
179                                 char *data, int channel)
180 {
181         return snprintf(data, EDAC_MC_LABEL_LEN, "%s",
182                         csrow->channels[channel].label);
183 }
184
185 static ssize_t channel_dimm_label_store(struct csrow_info *csrow,
186                                         const char *data,
187                                         size_t count, int channel)
188 {
189         ssize_t max_size = 0;
190
191         max_size = min((ssize_t) count, (ssize_t) EDAC_MC_LABEL_LEN - 1);
192         strncpy(csrow->channels[channel].label, data, max_size);
193         csrow->channels[channel].label[max_size] = '\0';
194
195         return max_size;
196 }
197
198 /* show function for dynamic chX_ce_count attribute */
199 static ssize_t channel_ce_count_show(struct csrow_info *csrow,
200                                 char *data, int channel)
201 {
202         return sprintf(data, "%u\n", csrow->channels[channel].ce_count);
203 }
204
205 /* csrow specific attribute structure */
206 struct csrowdev_attribute {
207         struct attribute attr;
208          ssize_t(*show) (struct csrow_info *, char *, int);
209          ssize_t(*store) (struct csrow_info *, const char *, size_t, int);
210         int private;
211 };
212
213 #define to_csrow(k) container_of(k, struct csrow_info, kobj)
214 #define to_csrowdev_attr(a) container_of(a, struct csrowdev_attribute, attr)
215
216 /* Set of show/store higher level functions for default csrow attributes */
217 static ssize_t csrowdev_show(struct kobject *kobj,
218                         struct attribute *attr, char *buffer)
219 {
220         struct csrow_info *csrow = to_csrow(kobj);
221         struct csrowdev_attribute *csrowdev_attr = to_csrowdev_attr(attr);
222
223         if (csrowdev_attr->show)
224                 return csrowdev_attr->show(csrow,
225                                         buffer, csrowdev_attr->private);
226         return -EIO;
227 }
228
229 static ssize_t csrowdev_store(struct kobject *kobj, struct attribute *attr,
230                         const char *buffer, size_t count)
231 {
232         struct csrow_info *csrow = to_csrow(kobj);
233         struct csrowdev_attribute *csrowdev_attr = to_csrowdev_attr(attr);
234
235         if (csrowdev_attr->store)
236                 return csrowdev_attr->store(csrow,
237                                         buffer,
238                                         count, csrowdev_attr->private);
239         return -EIO;
240 }
241
242 static struct sysfs_ops csrowfs_ops = {
243         .show = csrowdev_show,
244         .store = csrowdev_store
245 };
246
247 #define CSROWDEV_ATTR(_name,_mode,_show,_store,_private)        \
248 static struct csrowdev_attribute attr_##_name = {                       \
249         .attr = {.name = __stringify(_name), .mode = _mode },   \
250         .show   = _show,                                        \
251         .store  = _store,                                       \
252         .private = _private,                                    \
253 };
254
255 /* default cwrow<id>/attribute files */
256 CSROWDEV_ATTR(size_mb, S_IRUGO, csrow_size_show, NULL, 0);
257 CSROWDEV_ATTR(dev_type, S_IRUGO, csrow_dev_type_show, NULL, 0);
258 CSROWDEV_ATTR(mem_type, S_IRUGO, csrow_mem_type_show, NULL, 0);
259 CSROWDEV_ATTR(edac_mode, S_IRUGO, csrow_edac_mode_show, NULL, 0);
260 CSROWDEV_ATTR(ue_count, S_IRUGO, csrow_ue_count_show, NULL, 0);
261 CSROWDEV_ATTR(ce_count, S_IRUGO, csrow_ce_count_show, NULL, 0);
262
263 /* default attributes of the CSROW<id> object */
264 static struct csrowdev_attribute *default_csrow_attr[] = {
265         &attr_dev_type,
266         &attr_mem_type,
267         &attr_edac_mode,
268         &attr_size_mb,
269         &attr_ue_count,
270         &attr_ce_count,
271         NULL,
272 };
273
274 /* possible dynamic channel DIMM Label attribute files */
275 CSROWDEV_ATTR(ch0_dimm_label, S_IRUGO | S_IWUSR,
276         channel_dimm_label_show, channel_dimm_label_store, 0);
277 CSROWDEV_ATTR(ch1_dimm_label, S_IRUGO | S_IWUSR,
278         channel_dimm_label_show, channel_dimm_label_store, 1);
279 CSROWDEV_ATTR(ch2_dimm_label, S_IRUGO | S_IWUSR,
280         channel_dimm_label_show, channel_dimm_label_store, 2);
281 CSROWDEV_ATTR(ch3_dimm_label, S_IRUGO | S_IWUSR,
282         channel_dimm_label_show, channel_dimm_label_store, 3);
283 CSROWDEV_ATTR(ch4_dimm_label, S_IRUGO | S_IWUSR,
284         channel_dimm_label_show, channel_dimm_label_store, 4);
285 CSROWDEV_ATTR(ch5_dimm_label, S_IRUGO | S_IWUSR,
286         channel_dimm_label_show, channel_dimm_label_store, 5);
287
288 /* Total possible dynamic DIMM Label attribute file table */
289 static struct csrowdev_attribute *dynamic_csrow_dimm_attr[] = {
290         &attr_ch0_dimm_label,
291         &attr_ch1_dimm_label,
292         &attr_ch2_dimm_label,
293         &attr_ch3_dimm_label,
294         &attr_ch4_dimm_label,
295         &attr_ch5_dimm_label
296 };
297
298 /* possible dynamic channel ce_count attribute files */
299 CSROWDEV_ATTR(ch0_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 0);
300 CSROWDEV_ATTR(ch1_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 1);
301 CSROWDEV_ATTR(ch2_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 2);
302 CSROWDEV_ATTR(ch3_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 3);
303 CSROWDEV_ATTR(ch4_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 4);
304 CSROWDEV_ATTR(ch5_ce_count, S_IRUGO | S_IWUSR, channel_ce_count_show, NULL, 5);
305
306 /* Total possible dynamic ce_count attribute file table */
307 static struct csrowdev_attribute *dynamic_csrow_ce_count_attr[] = {
308         &attr_ch0_ce_count,
309         &attr_ch1_ce_count,
310         &attr_ch2_ce_count,
311         &attr_ch3_ce_count,
312         &attr_ch4_ce_count,
313         &attr_ch5_ce_count
314 };
315
316 #define EDAC_NR_CHANNELS        6
317
318 /* Create dynamic CHANNEL files, indexed by 'chan',  under specifed CSROW */
319 static int edac_create_channel_files(struct kobject *kobj, int chan)
320 {
321         int err = -ENODEV;
322
323         if (chan >= EDAC_NR_CHANNELS)
324                 return err;
325
326         /* create the DIMM label attribute file */
327         err = sysfs_create_file(kobj,
328                                 (struct attribute *)
329                                 dynamic_csrow_dimm_attr[chan]);
330
331         if (!err) {
332                 /* create the CE Count attribute file */
333                 err = sysfs_create_file(kobj,
334                                         (struct attribute *)
335                                         dynamic_csrow_ce_count_attr[chan]);
336         } else {
337                 debugf1("%s()  dimm labels and ce_count files created",
338                         __func__);
339         }
340
341         return err;
342 }
343
344 /* No memory to release for this kobj */
345 static void edac_csrow_instance_release(struct kobject *kobj)
346 {
347         struct mem_ctl_info *mci;
348         struct csrow_info *cs;
349
350         debugf1("%s()\n", __func__);
351
352         cs = container_of(kobj, struct csrow_info, kobj);
353         mci = cs->mci;
354
355         kobject_put(&mci->edac_mci_kobj);
356 }
357
358 /* the kobj_type instance for a CSROW */
359 static struct kobj_type ktype_csrow = {
360         .release = edac_csrow_instance_release,
361         .sysfs_ops = &csrowfs_ops,
362         .default_attrs = (struct attribute **)default_csrow_attr,
363 };
364
365 /* Create a CSROW object under specifed edac_mc_device */
366 static int edac_create_csrow_object(struct mem_ctl_info *mci,
367                                         struct csrow_info *csrow, int index)
368 {
369         struct kobject *kobj_mci = &mci->edac_mci_kobj;
370         struct kobject *kobj;
371         int chan;
372         int err;
373
374         /* generate ..../edac/mc/mc<id>/csrow<index>   */
375         memset(&csrow->kobj, 0, sizeof(csrow->kobj));
376         csrow->mci = mci;       /* include container up link */
377
378         /* bump the mci instance's kobject's ref count */
379         kobj = kobject_get(&mci->edac_mci_kobj);
380         if (!kobj) {
381                 err = -ENODEV;
382                 goto err_out;
383         }
384
385         /* Instanstiate the csrow object */
386         err = kobject_init_and_add(&csrow->kobj, &ktype_csrow, kobj_mci,
387                                    "csrow%d", index);
388         if (err)
389                 goto err_release_top_kobj;
390
391         /* At this point, to release a csrow kobj, one must
392          * call the kobject_put and allow that tear down
393          * to work the releasing
394          */
395
396         /* Create the dyanmic attribute files on this csrow,
397          * namely, the DIMM labels and the channel ce_count
398          */
399         for (chan = 0; chan < csrow->nr_channels; chan++) {
400                 err = edac_create_channel_files(&csrow->kobj, chan);
401                 if (err) {
402                         /* special case the unregister here */
403                         kobject_put(&csrow->kobj);
404                         goto err_out;
405                 }
406         }
407         kobject_uevent(&csrow->kobj, KOBJ_ADD);
408         return 0;
409
410         /* error unwind stack */
411 err_release_top_kobj:
412         kobject_put(&mci->edac_mci_kobj);
413
414 err_out:
415         return err;
416 }
417
418 /* default sysfs methods and data structures for the main MCI kobject */
419
420 static ssize_t mci_reset_counters_store(struct mem_ctl_info *mci,
421                                         const char *data, size_t count)
422 {
423         int row, chan;
424
425         mci->ue_noinfo_count = 0;
426         mci->ce_noinfo_count = 0;
427         mci->ue_count = 0;
428         mci->ce_count = 0;
429
430         for (row = 0; row < mci->nr_csrows; row++) {
431                 struct csrow_info *ri = &mci->csrows[row];
432
433                 ri->ue_count = 0;
434                 ri->ce_count = 0;
435
436                 for (chan = 0; chan < ri->nr_channels; chan++)
437                         ri->channels[chan].ce_count = 0;
438         }
439
440         mci->start_time = jiffies;
441         return count;
442 }
443
444 /* memory scrubbing */
445 static ssize_t mci_sdram_scrub_rate_store(struct mem_ctl_info *mci,
446                                         const char *data, size_t count)
447 {
448         u32 bandwidth = -1;
449
450         if (mci->set_sdram_scrub_rate) {
451
452                 memctrl_int_store(&bandwidth, data, count);
453
454                 if (!(*mci->set_sdram_scrub_rate) (mci, &bandwidth)) {
455                         edac_printk(KERN_DEBUG, EDAC_MC,
456                                 "Scrub rate set successfully, applied: %d\n",
457                                 bandwidth);
458                 } else {
459                         /* FIXME: error codes maybe? */
460                         edac_printk(KERN_DEBUG, EDAC_MC,
461                                 "Scrub rate set FAILED, could not apply: %d\n",
462                                 bandwidth);
463                 }
464         } else {
465                 /* FIXME: produce "not implemented" ERROR for user-side. */
466                 edac_printk(KERN_WARNING, EDAC_MC,
467                         "Memory scrubbing 'set'control is not implemented!\n");
468         }
469         return count;
470 }
471
472 static ssize_t mci_sdram_scrub_rate_show(struct mem_ctl_info *mci, char *data)
473 {
474         u32 bandwidth = -1;
475
476         if (mci->get_sdram_scrub_rate) {
477                 if (!(*mci->get_sdram_scrub_rate) (mci, &bandwidth)) {
478                         edac_printk(KERN_DEBUG, EDAC_MC,
479                                 "Scrub rate successfully, fetched: %d\n",
480                                 bandwidth);
481                 } else {
482                         /* FIXME: error codes maybe? */
483                         edac_printk(KERN_DEBUG, EDAC_MC,
484                                 "Scrub rate fetch FAILED, got: %d\n",
485                                 bandwidth);
486                 }
487         } else {
488                 /* FIXME: produce "not implemented" ERROR for user-side.  */
489                 edac_printk(KERN_WARNING, EDAC_MC,
490                         "Memory scrubbing 'get' control is not implemented\n");
491         }
492         return sprintf(data, "%d\n", bandwidth);
493 }
494
495 /* default attribute files for the MCI object */
496 static ssize_t mci_ue_count_show(struct mem_ctl_info *mci, char *data)
497 {
498         return sprintf(data, "%d\n", mci->ue_count);
499 }
500
501 static ssize_t mci_ce_count_show(struct mem_ctl_info *mci, char *data)
502 {
503         return sprintf(data, "%d\n", mci->ce_count);
504 }
505
506 static ssize_t mci_ce_noinfo_show(struct mem_ctl_info *mci, char *data)
507 {
508         return sprintf(data, "%d\n", mci->ce_noinfo_count);
509 }
510
511 static ssize_t mci_ue_noinfo_show(struct mem_ctl_info *mci, char *data)
512 {
513         return sprintf(data, "%d\n", mci->ue_noinfo_count);
514 }
515
516 static ssize_t mci_seconds_show(struct mem_ctl_info *mci, char *data)
517 {
518         return sprintf(data, "%ld\n", (jiffies - mci->start_time) / HZ);
519 }
520
521 static ssize_t mci_ctl_name_show(struct mem_ctl_info *mci, char *data)
522 {
523         return sprintf(data, "%s\n", mci->ctl_name);
524 }
525
526 static ssize_t mci_size_mb_show(struct mem_ctl_info *mci, char *data)
527 {
528         int total_pages, csrow_idx;
529
530         for (total_pages = csrow_idx = 0; csrow_idx < mci->nr_csrows;
531                 csrow_idx++) {
532                 struct csrow_info *csrow = &mci->csrows[csrow_idx];
533
534                 if (!csrow->nr_pages)
535                         continue;
536
537                 total_pages += csrow->nr_pages;
538         }
539
540         return sprintf(data, "%u\n", PAGES_TO_MiB(total_pages));
541 }
542
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)
545
546 /* MCI show/store functions for top most object */
547 static ssize_t mcidev_show(struct kobject *kobj, struct attribute *attr,
548                         char *buffer)
549 {
550         struct mem_ctl_info *mem_ctl_info = to_mci(kobj);
551         struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
552
553         if (mcidev_attr->show)
554                 return mcidev_attr->show(mem_ctl_info, buffer);
555
556         return -EIO;
557 }
558
559 static ssize_t mcidev_store(struct kobject *kobj, struct attribute *attr,
560                         const char *buffer, size_t count)
561 {
562         struct mem_ctl_info *mem_ctl_info = to_mci(kobj);
563         struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
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 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 /*
723  * edac_create_mci_instance_attributes
724  *      create MC driver specific attributes at the topmost level
725  *      directory of this mci instance.
726  */
727 static int edac_create_mci_instance_attributes(struct mem_ctl_info *mci)
728 {
729         int err;
730         struct mcidev_sysfs_attribute *sysfs_attrib;
731
732         /* point to the start of the array and iterate over it
733          * adding each attribute listed to this mci instance's kobject
734          */
735         sysfs_attrib = mci->mc_driver_sysfs_attributes;
736
737         while (sysfs_attrib && sysfs_attrib->attr.name) {
738                 err = sysfs_create_file(&mci->edac_mci_kobj,
739                                         (struct attribute*) sysfs_attrib);
740                 if (err) {
741                         return err;
742                 }
743
744                 sysfs_attrib++;
745         }
746
747         return 0;
748 }
749
750 /*
751  * edac_remove_mci_instance_attributes
752  *      remove MC driver specific attributes at the topmost level
753  *      directory of this mci instance.
754  */
755 static void edac_remove_mci_instance_attributes(struct mem_ctl_info *mci)
756 {
757         struct mcidev_sysfs_attribute *sysfs_attrib;
758
759         /* point to the start of the array and iterate over it
760          * adding each attribute listed to this mci instance's kobject
761          */
762         sysfs_attrib = mci->mc_driver_sysfs_attributes;
763
764         /* loop if there are attributes and until we hit a NULL entry */
765         while (sysfs_attrib && sysfs_attrib->attr.name) {
766                 sysfs_remove_file(&mci->edac_mci_kobj,
767                                         (struct attribute *) sysfs_attrib);
768                 sysfs_attrib++;
769         }
770 }
771
772
773 /*
774  * Create a new Memory Controller kobject instance,
775  *      mc<id> under the 'mc' directory
776  *
777  * Return:
778  *      0       Success
779  *      !0      Failure
780  */
781 int edac_create_sysfs_mci_device(struct mem_ctl_info *mci)
782 {
783         int i;
784         int err;
785         struct csrow_info *csrow;
786         struct kobject *kobj_mci = &mci->edac_mci_kobj;
787
788         debugf0("%s() idx=%d\n", __func__, mci->mc_idx);
789
790         /* create a symlink for the device */
791         err = sysfs_create_link(kobj_mci, &mci->dev->kobj,
792                                 EDAC_DEVICE_SYMLINK);
793         if (err) {
794                 debugf1("%s() failure to create symlink\n", __func__);
795                 goto fail0;
796         }
797
798         /* If the low level driver desires some attributes,
799          * then create them now for the driver.
800          */
801         if (mci->mc_driver_sysfs_attributes) {
802                 err = edac_create_mci_instance_attributes(mci);
803                 if (err) {
804                         debugf1("%s() failure to create mci attributes\n",
805                                 __func__);
806                         goto fail0;
807                 }
808         }
809
810         /* Make directories for each CSROW object under the mc<id> kobject
811          */
812         for (i = 0; i < mci->nr_csrows; i++) {
813                 csrow = &mci->csrows[i];
814
815                 /* Only expose populated CSROWs */
816                 if (csrow->nr_pages > 0) {
817                         err = edac_create_csrow_object(mci, csrow, i);
818                         if (err) {
819                                 debugf1("%s() failure: create csrow %d obj\n",
820                                         __func__, i);
821                                 goto fail1;
822                         }
823                 }
824         }
825
826         return 0;
827
828         /* CSROW error: backout what has already been registered,  */
829 fail1:
830         for (i--; i >= 0; i--) {
831                 if (csrow->nr_pages > 0) {
832                         kobject_put(&mci->csrows[i].kobj);
833                 }
834         }
835
836         /* remove the mci instance's attributes, if any */
837         edac_remove_mci_instance_attributes(mci);
838
839         /* remove the symlink */
840         sysfs_remove_link(kobj_mci, EDAC_DEVICE_SYMLINK);
841
842 fail0:
843         return err;
844 }
845
846 /*
847  * remove a Memory Controller instance
848  */
849 void edac_remove_sysfs_mci_device(struct mem_ctl_info *mci)
850 {
851         int i;
852
853         debugf0("%s()\n", __func__);
854
855         /* remove all csrow kobjects */
856         for (i = 0; i < mci->nr_csrows; i++) {
857                 if (mci->csrows[i].nr_pages > 0) {
858                         debugf0("%s()  unreg csrow-%d\n", __func__, i);
859                         kobject_put(&mci->csrows[i].kobj);
860                 }
861         }
862
863         debugf0("%s()  remove_link\n", __func__);
864
865         /* remove the symlink */
866         sysfs_remove_link(&mci->edac_mci_kobj, EDAC_DEVICE_SYMLINK);
867
868         debugf0("%s()  remove_mci_instance\n", __func__);
869
870         /* remove this mci instance's attribtes */
871         edac_remove_mci_instance_attributes(mci);
872
873         debugf0("%s()  unregister this mci kobj\n", __func__);
874
875         /* unregister this instance's kobject */
876         kobject_put(&mci->edac_mci_kobj);
877 }
878
879
880
881
882 /*
883  * edac_setup_sysfs_mc_kset(void)
884  *
885  * Initialize the mc_kset for the 'mc' entry
886  *      This requires creating the top 'mc' directory with a kset
887  *      and its controls/attributes.
888  *
889  *      To this 'mc' kset, instance 'mci' will be grouped as children.
890  *
891  * Return:  0 SUCCESS
892  *         !0 FAILURE error code
893  */
894 int edac_sysfs_setup_mc_kset(void)
895 {
896         int err = 0;
897         struct sysdev_class *edac_class;
898
899         debugf1("%s()\n", __func__);
900
901         /* get the /sys/devices/system/edac class reference */
902         edac_class = edac_get_edac_class();
903         if (edac_class == NULL) {
904                 debugf1("%s() no edac_class error=%d\n", __func__, err);
905                 goto fail_out;
906         }
907
908         /* Init the MC's kobject */
909         kobject_set_name(&mc_kset.kobj, "mc");
910         mc_kset.kobj.parent = &edac_class->kset.kobj;
911
912         /* register the mc_kset */
913         err = kset_register(&mc_kset);
914         if (err) {
915                 debugf1("%s() Failed to register '.../edac/mc'\n", __func__);
916                 goto fail_out;
917         }
918
919         debugf1("%s() Registered '.../edac/mc' kobject\n", __func__);
920
921         return 0;
922
923
924         /* error unwind stack */
925 fail_out:
926         return err;
927 }
928
929 /*
930  * edac_sysfs_teardown_mc_kset
931  *
932  *      deconstruct the mc_ket for memory controllers
933  */
934 void edac_sysfs_teardown_mc_kset(void)
935 {
936         kset_unregister(&mc_kset);
937 }
938