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