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