CRED: Fix RCU warning due to previous patch fixing __task_cred()'s checks
[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/slab.h>
14 #include <linux/bug.h>
15
16 #include "edac_core.h"
17 #include "edac_module.h"
18
19
20 /* MC EDAC Controls, setable by module parameter, and sysfs */
21 static int edac_mc_log_ue = 1;
22 static int edac_mc_log_ce = 1;
23 static int edac_mc_panic_on_ue;
24 static int edac_mc_poll_msec = 1000;
25
26 /* Getter functions for above */
27 int edac_mc_get_log_ue(void)
28 {
29         return edac_mc_log_ue;
30 }
31
32 int edac_mc_get_log_ce(void)
33 {
34         return edac_mc_log_ce;
35 }
36
37 int edac_mc_get_panic_on_ue(void)
38 {
39         return edac_mc_panic_on_ue;
40 }
41
42 /* this is temporary */
43 int edac_mc_get_poll_msec(void)
44 {
45         return edac_mc_poll_msec;
46 }
47
48 static int edac_set_poll_msec(const char *val, struct kernel_param *kp)
49 {
50         long l;
51         int ret;
52
53         if (!val)
54                 return -EINVAL;
55
56         ret = strict_strtol(val, 0, &l);
57         if (ret == -EINVAL || ((int)l != l))
58                 return -EINVAL;
59         *((int *)kp->arg) = l;
60
61         /* notify edac_mc engine to reset the poll period */
62         edac_mc_reset_delay_period(l);
63
64         return 0;
65 }
66
67 /* Parameter declarations for above */
68 module_param(edac_mc_panic_on_ue, int, 0644);
69 MODULE_PARM_DESC(edac_mc_panic_on_ue, "Panic on uncorrected error: 0=off 1=on");
70 module_param(edac_mc_log_ue, int, 0644);
71 MODULE_PARM_DESC(edac_mc_log_ue,
72                  "Log uncorrectable error to console: 0=off 1=on");
73 module_param(edac_mc_log_ce, int, 0644);
74 MODULE_PARM_DESC(edac_mc_log_ce,
75                  "Log correctable error to console: 0=off 1=on");
76 module_param_call(edac_mc_poll_msec, edac_set_poll_msec, param_get_int,
77                   &edac_mc_poll_msec, 0644);
78 MODULE_PARM_DESC(edac_mc_poll_msec, "Polling period in milliseconds");
79
80 /*
81  * various constants for Memory Controllers
82  */
83 static const char *mem_types[] = {
84         [MEM_EMPTY] = "Empty",
85         [MEM_RESERVED] = "Reserved",
86         [MEM_UNKNOWN] = "Unknown",
87         [MEM_FPM] = "FPM",
88         [MEM_EDO] = "EDO",
89         [MEM_BEDO] = "BEDO",
90         [MEM_SDR] = "Unbuffered-SDR",
91         [MEM_RDR] = "Registered-SDR",
92         [MEM_DDR] = "Unbuffered-DDR",
93         [MEM_RDDR] = "Registered-DDR",
94         [MEM_RMBS] = "RMBS",
95         [MEM_DDR2] = "Unbuffered-DDR2",
96         [MEM_FB_DDR2] = "FullyBuffered-DDR2",
97         [MEM_RDDR2] = "Registered-DDR2",
98         [MEM_XDR] = "XDR",
99         [MEM_DDR3] = "Unbuffered-DDR3",
100         [MEM_RDDR3] = "Registered-DDR3"
101 };
102
103 static const char *dev_types[] = {
104         [DEV_UNKNOWN] = "Unknown",
105         [DEV_X1] = "x1",
106         [DEV_X2] = "x2",
107         [DEV_X4] = "x4",
108         [DEV_X8] = "x8",
109         [DEV_X16] = "x16",
110         [DEV_X32] = "x32",
111         [DEV_X64] = "x64"
112 };
113
114 static const char *edac_caps[] = {
115         [EDAC_UNKNOWN] = "Unknown",
116         [EDAC_NONE] = "None",
117         [EDAC_RESERVED] = "Reserved",
118         [EDAC_PARITY] = "PARITY",
119         [EDAC_EC] = "EC",
120         [EDAC_SECDED] = "SECDED",
121         [EDAC_S2ECD2ED] = "S2ECD2ED",
122         [EDAC_S4ECD4ED] = "S4ECD4ED",
123         [EDAC_S8ECD8ED] = "S8ECD8ED",
124         [EDAC_S16ECD16ED] = "S16ECD16ED"
125 };
126
127
128
129 static ssize_t memctrl_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         return count;
137 }
138
139
140 /* EDAC sysfs CSROW data structures and methods
141  */
142
143 /* Set of more default csrow<id> attribute show/store functions */
144 static ssize_t csrow_ue_count_show(struct csrow_info *csrow, char *data,
145                                 int private)
146 {
147         return sprintf(data, "%u\n", csrow->ue_count);
148 }
149
150 static ssize_t csrow_ce_count_show(struct csrow_info *csrow, char *data,
151                                 int private)
152 {
153         return sprintf(data, "%u\n", csrow->ce_count);
154 }
155
156 static ssize_t csrow_size_show(struct csrow_info *csrow, char *data,
157                                 int private)
158 {
159         return sprintf(data, "%u\n", PAGES_TO_MiB(csrow->nr_pages));
160 }
161
162 static ssize_t csrow_mem_type_show(struct csrow_info *csrow, char *data,
163                                 int private)
164 {
165         return sprintf(data, "%s\n", mem_types[csrow->mtype]);
166 }
167
168 static ssize_t csrow_dev_type_show(struct csrow_info *csrow, char *data,
169                                 int private)
170 {
171         return sprintf(data, "%s\n", dev_types[csrow->dtype]);
172 }
173
174 static ssize_t csrow_edac_mode_show(struct csrow_info *csrow, char *data,
175                                 int private)
176 {
177         return sprintf(data, "%s\n", edac_caps[csrow->edac_mode]);
178 }
179
180 /* show/store functions for DIMM Label attributes */
181 static ssize_t channel_dimm_label_show(struct csrow_info *csrow,
182                                 char *data, int channel)
183 {
184         /* if field has not been initialized, there is nothing to send */
185         if (!csrow->channels[channel].label[0])
186                 return 0;
187
188         return snprintf(data, EDAC_MC_LABEL_LEN, "%s\n",
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 const 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         debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
561
562         if (mcidev_attr->show)
563                 return mcidev_attr->show(mem_ctl_info, buffer);
564
565         return -EIO;
566 }
567
568 static ssize_t mcidev_store(struct kobject *kobj, struct attribute *attr,
569                         const char *buffer, size_t count)
570 {
571         struct mem_ctl_info *mem_ctl_info = to_mci(kobj);
572         struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
573
574         debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
575
576         if (mcidev_attr->store)
577                 return mcidev_attr->store(mem_ctl_info, buffer, count);
578
579         return -EIO;
580 }
581
582 /* Intermediate show/store table */
583 static const struct sysfs_ops mci_ops = {
584         .show = mcidev_show,
585         .store = mcidev_store
586 };
587
588 #define MCIDEV_ATTR(_name,_mode,_show,_store)                   \
589 static struct mcidev_sysfs_attribute mci_attr_##_name = {                       \
590         .attr = {.name = __stringify(_name), .mode = _mode },   \
591         .show   = _show,                                        \
592         .store  = _store,                                       \
593 };
594
595 /* default Control file */
596 MCIDEV_ATTR(reset_counters, S_IWUSR, NULL, mci_reset_counters_store);
597
598 /* default Attribute files */
599 MCIDEV_ATTR(mc_name, S_IRUGO, mci_ctl_name_show, NULL);
600 MCIDEV_ATTR(size_mb, S_IRUGO, mci_size_mb_show, NULL);
601 MCIDEV_ATTR(seconds_since_reset, S_IRUGO, mci_seconds_show, NULL);
602 MCIDEV_ATTR(ue_noinfo_count, S_IRUGO, mci_ue_noinfo_show, NULL);
603 MCIDEV_ATTR(ce_noinfo_count, S_IRUGO, mci_ce_noinfo_show, NULL);
604 MCIDEV_ATTR(ue_count, S_IRUGO, mci_ue_count_show, NULL);
605 MCIDEV_ATTR(ce_count, S_IRUGO, mci_ce_count_show, NULL);
606
607 /* memory scrubber attribute file */
608 MCIDEV_ATTR(sdram_scrub_rate, S_IRUGO | S_IWUSR, mci_sdram_scrub_rate_show,
609         mci_sdram_scrub_rate_store);
610
611 static struct mcidev_sysfs_attribute *mci_attr[] = {
612         &mci_attr_reset_counters,
613         &mci_attr_mc_name,
614         &mci_attr_size_mb,
615         &mci_attr_seconds_since_reset,
616         &mci_attr_ue_noinfo_count,
617         &mci_attr_ce_noinfo_count,
618         &mci_attr_ue_count,
619         &mci_attr_ce_count,
620         &mci_attr_sdram_scrub_rate,
621         NULL
622 };
623
624
625 /*
626  * Release of a MC controlling instance
627  *
628  *      each MC control instance has the following resources upon entry:
629  *              a) a ref count on the top memctl kobj
630  *              b) a ref count on this module
631  *
632  *      this function must decrement those ref counts and then
633  *      issue a free on the instance's memory
634  */
635 static void edac_mci_control_release(struct kobject *kobj)
636 {
637         struct mem_ctl_info *mci;
638
639         mci = to_mci(kobj);
640
641         debugf0("%s() mci instance idx=%d releasing\n", __func__, mci->mc_idx);
642
643         /* decrement the module ref count */
644         module_put(mci->owner);
645
646         /* free the mci instance memory here */
647         kfree(mci);
648 }
649
650 static struct kobj_type ktype_mci = {
651         .release = edac_mci_control_release,
652         .sysfs_ops = &mci_ops,
653         .default_attrs = (struct attribute **)mci_attr,
654 };
655
656 /* EDAC memory controller sysfs kset:
657  *      /sys/devices/system/edac/mc
658  */
659 static struct kset *mc_kset;
660
661 /*
662  * edac_mc_register_sysfs_main_kobj
663  *
664  *      setups and registers the main kobject for each mci
665  */
666 int edac_mc_register_sysfs_main_kobj(struct mem_ctl_info *mci)
667 {
668         struct kobject *kobj_mci;
669         int err;
670
671         debugf1("%s()\n", __func__);
672
673         kobj_mci = &mci->edac_mci_kobj;
674
675         /* Init the mci's kobject */
676         memset(kobj_mci, 0, sizeof(*kobj_mci));
677
678         /* Record which module 'owns' this control structure
679          * and bump the ref count of the module
680          */
681         mci->owner = THIS_MODULE;
682
683         /* bump ref count on this module */
684         if (!try_module_get(mci->owner)) {
685                 err = -ENODEV;
686                 goto fail_out;
687         }
688
689         /* this instance become part of the mc_kset */
690         kobj_mci->kset = mc_kset;
691
692         /* register the mc<id> kobject to the mc_kset */
693         err = kobject_init_and_add(kobj_mci, &ktype_mci, NULL,
694                                    "mc%d", mci->mc_idx);
695         if (err) {
696                 debugf1("%s()Failed to register '.../edac/mc%d'\n",
697                         __func__, mci->mc_idx);
698                 goto kobj_reg_fail;
699         }
700         kobject_uevent(kobj_mci, KOBJ_ADD);
701
702         /* At this point, to 'free' the control struct,
703          * edac_mc_unregister_sysfs_main_kobj() must be used
704          */
705
706         debugf1("%s() Registered '.../edac/mc%d' kobject\n",
707                 __func__, mci->mc_idx);
708
709         return 0;
710
711         /* Error exit stack */
712
713 kobj_reg_fail:
714         module_put(mci->owner);
715
716 fail_out:
717         return err;
718 }
719
720 /*
721  * edac_mc_register_sysfs_main_kobj
722  *
723  *      tears down and the main mci kobject from the mc_kset
724  */
725 void edac_mc_unregister_sysfs_main_kobj(struct mem_ctl_info *mci)
726 {
727         /* delete the kobj from the mc_kset */
728         kobject_put(&mci->edac_mci_kobj);
729 }
730
731 #define EDAC_DEVICE_SYMLINK     "device"
732
733 #define grp_to_mci(k) (container_of(k, struct mcidev_sysfs_group_kobj, kobj)->mci)
734
735 /* MCI show/store functions for top most object */
736 static ssize_t inst_grp_show(struct kobject *kobj, struct attribute *attr,
737                         char *buffer)
738 {
739         struct mem_ctl_info *mem_ctl_info = grp_to_mci(kobj);
740         struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
741
742         debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
743
744         if (mcidev_attr->show)
745                 return mcidev_attr->show(mem_ctl_info, buffer);
746
747         return -EIO;
748 }
749
750 static ssize_t inst_grp_store(struct kobject *kobj, struct attribute *attr,
751                         const char *buffer, size_t count)
752 {
753         struct mem_ctl_info *mem_ctl_info = grp_to_mci(kobj);
754         struct mcidev_sysfs_attribute *mcidev_attr = to_mcidev_attr(attr);
755
756         debugf1("%s() mem_ctl_info %p\n", __func__, mem_ctl_info);
757
758         if (mcidev_attr->store)
759                 return mcidev_attr->store(mem_ctl_info, buffer, count);
760
761         return -EIO;
762 }
763
764 /* No memory to release for this kobj */
765 static void edac_inst_grp_release(struct kobject *kobj)
766 {
767         struct mcidev_sysfs_group_kobj *grp;
768         struct mem_ctl_info *mci;
769
770         debugf1("%s()\n", __func__);
771
772         grp = container_of(kobj, struct mcidev_sysfs_group_kobj, kobj);
773         mci = grp->mci;
774
775         kobject_put(&mci->edac_mci_kobj);
776 }
777
778 /* Intermediate show/store table */
779 static struct sysfs_ops inst_grp_ops = {
780         .show = inst_grp_show,
781         .store = inst_grp_store
782 };
783
784 /* the kobj_type instance for a instance group */
785 static struct kobj_type ktype_inst_grp = {
786         .release = edac_inst_grp_release,
787         .sysfs_ops = &inst_grp_ops,
788 };
789
790
791 /*
792  * edac_create_mci_instance_attributes
793  *      create MC driver specific attributes bellow an specified kobj
794  * This routine calls itself recursively, in order to create an entire
795  * object tree.
796  */
797 static int edac_create_mci_instance_attributes(struct mem_ctl_info *mci,
798                                 struct mcidev_sysfs_attribute *sysfs_attrib,
799                                 struct kobject *kobj)
800 {
801         int err;
802
803         debugf1("%s()\n", __func__);
804
805         while (sysfs_attrib) {
806                 if (sysfs_attrib->grp) {
807                         struct mcidev_sysfs_group_kobj *grp_kobj;
808
809                         grp_kobj = kzalloc(sizeof(*grp_kobj), GFP_KERNEL);
810                         if (!grp_kobj)
811                                 return -ENOMEM;
812
813                         list_add_tail(&grp_kobj->list, &mci->grp_kobj_list);
814
815                         grp_kobj->grp = sysfs_attrib->grp;
816                         grp_kobj->mci = mci;
817
818                         debugf0("%s() grp %s, mci %p\n", __func__,
819                                 sysfs_attrib->grp->name, mci);
820
821                         err = kobject_init_and_add(&grp_kobj->kobj,
822                                                 &ktype_inst_grp,
823                                                 &mci->edac_mci_kobj,
824                                                 sysfs_attrib->grp->name);
825                         if (err)
826                                 return err;
827
828                         err = edac_create_mci_instance_attributes(mci,
829                                         grp_kobj->grp->mcidev_attr,
830                                         &grp_kobj->kobj);
831
832                         if (err)
833                                 return err;
834                 } else if (sysfs_attrib->attr.name) {
835                         debugf0("%s() file %s\n", __func__,
836                                 sysfs_attrib->attr.name);
837
838                         err = sysfs_create_file(kobj, &sysfs_attrib->attr);
839                 } else
840                         break;
841
842                 if (err) {
843                         return err;
844                 }
845                 sysfs_attrib++;
846         }
847
848         return 0;
849 }
850
851 /*
852  * edac_remove_mci_instance_attributes
853  *      remove MC driver specific attributes at the topmost level
854  *      directory of this mci instance.
855  */
856 static void edac_remove_mci_instance_attributes(struct mem_ctl_info *mci,
857                                 struct mcidev_sysfs_attribute *sysfs_attrib,
858                                 struct kobject *kobj, int count)
859 {
860         struct mcidev_sysfs_group_kobj *grp_kobj, *tmp;
861
862         debugf1("%s()\n", __func__);
863
864         /*
865          * loop if there are attributes and until we hit a NULL entry
866          * Remove first all the atributes
867          */
868         while (sysfs_attrib) {
869                 if (sysfs_attrib->grp) {
870                         list_for_each_entry(grp_kobj, &mci->grp_kobj_list,
871                                             list)
872                                 if (grp_kobj->grp == sysfs_attrib->grp)
873                                         edac_remove_mci_instance_attributes(mci,
874                                                     grp_kobj->grp->mcidev_attr,
875                                                     &grp_kobj->kobj, count + 1);
876                 } else if (sysfs_attrib->attr.name) {
877                         debugf0("%s() file %s\n", __func__,
878                                 sysfs_attrib->attr.name);
879                         sysfs_remove_file(kobj, &sysfs_attrib->attr);
880                 } else
881                         break;
882                 sysfs_attrib++;
883         }
884
885         /*
886          * Now that all attributes got removed, it is save to remove all groups
887          */
888         if (!count)
889                 list_for_each_entry_safe(grp_kobj, tmp, &mci->grp_kobj_list,
890                                          list) {
891                         debugf0("%s() grp %s\n", __func__, grp_kobj->grp->name);
892                         kobject_put(&grp_kobj->kobj);
893                 }
894 }
895
896
897 /*
898  * Create a new Memory Controller kobject instance,
899  *      mc<id> under the 'mc' directory
900  *
901  * Return:
902  *      0       Success
903  *      !0      Failure
904  */
905 int edac_create_sysfs_mci_device(struct mem_ctl_info *mci)
906 {
907         int i;
908         int err;
909         struct csrow_info *csrow;
910         struct kobject *kobj_mci = &mci->edac_mci_kobj;
911
912         debugf0("%s() idx=%d\n", __func__, mci->mc_idx);
913
914         INIT_LIST_HEAD(&mci->grp_kobj_list);
915
916         /* create a symlink for the device */
917         err = sysfs_create_link(kobj_mci, &mci->dev->kobj,
918                                 EDAC_DEVICE_SYMLINK);
919         if (err) {
920                 debugf1("%s() failure to create symlink\n", __func__);
921                 goto fail0;
922         }
923
924         /* If the low level driver desires some attributes,
925          * then create them now for the driver.
926          */
927         if (mci->mc_driver_sysfs_attributes) {
928                 err = edac_create_mci_instance_attributes(mci,
929                                         mci->mc_driver_sysfs_attributes,
930                                         &mci->edac_mci_kobj);
931                 if (err) {
932                         debugf1("%s() failure to create mci attributes\n",
933                                 __func__);
934                         goto fail0;
935                 }
936         }
937
938         /* Make directories for each CSROW object under the mc<id> kobject
939          */
940         for (i = 0; i < mci->nr_csrows; i++) {
941                 csrow = &mci->csrows[i];
942
943                 /* Only expose populated CSROWs */
944                 if (csrow->nr_pages > 0) {
945                         err = edac_create_csrow_object(mci, csrow, i);
946                         if (err) {
947                                 debugf1("%s() failure: create csrow %d obj\n",
948                                         __func__, i);
949                                 goto fail1;
950                         }
951                 }
952         }
953
954         return 0;
955
956         /* CSROW error: backout what has already been registered,  */
957 fail1:
958         for (i--; i >= 0; i--) {
959                 if (csrow->nr_pages > 0) {
960                         kobject_put(&mci->csrows[i].kobj);
961                 }
962         }
963
964         /* remove the mci instance's attributes, if any */
965         edac_remove_mci_instance_attributes(mci,
966                 mci->mc_driver_sysfs_attributes, &mci->edac_mci_kobj, 0);
967
968         /* remove the symlink */
969         sysfs_remove_link(kobj_mci, EDAC_DEVICE_SYMLINK);
970
971 fail0:
972         return err;
973 }
974
975 /*
976  * remove a Memory Controller instance
977  */
978 void edac_remove_sysfs_mci_device(struct mem_ctl_info *mci)
979 {
980         int i;
981
982         debugf0("%s()\n", __func__);
983
984         /* remove all csrow kobjects */
985         for (i = 0; i < mci->nr_csrows; i++) {
986                 if (mci->csrows[i].nr_pages > 0) {
987                         debugf0("%s()  unreg csrow-%d\n", __func__, i);
988                         kobject_put(&mci->csrows[i].kobj);
989                 }
990         }
991
992         debugf0("%s()  remove_link\n", __func__);
993
994         /* remove the symlink */
995         sysfs_remove_link(&mci->edac_mci_kobj, EDAC_DEVICE_SYMLINK);
996
997         debugf0("%s()  remove_mci_instance\n", __func__);
998
999         /* remove this mci instance's attribtes */
1000         edac_remove_mci_instance_attributes(mci,
1001                                             mci->mc_driver_sysfs_attributes,
1002                                             &mci->edac_mci_kobj, 0);
1003         debugf0("%s()  unregister this mci kobj\n", __func__);
1004
1005         /* unregister this instance's kobject */
1006         kobject_put(&mci->edac_mci_kobj);
1007 }
1008
1009
1010
1011
1012 /*
1013  * edac_setup_sysfs_mc_kset(void)
1014  *
1015  * Initialize the mc_kset for the 'mc' entry
1016  *      This requires creating the top 'mc' directory with a kset
1017  *      and its controls/attributes.
1018  *
1019  *      To this 'mc' kset, instance 'mci' will be grouped as children.
1020  *
1021  * Return:  0 SUCCESS
1022  *         !0 FAILURE error code
1023  */
1024 int edac_sysfs_setup_mc_kset(void)
1025 {
1026         int err = 0;
1027         struct sysdev_class *edac_class;
1028
1029         debugf1("%s()\n", __func__);
1030
1031         /* get the /sys/devices/system/edac class reference */
1032         edac_class = edac_get_edac_class();
1033         if (edac_class == NULL) {
1034                 debugf1("%s() no edac_class error=%d\n", __func__, err);
1035                 goto fail_out;
1036         }
1037
1038         /* Init the MC's kobject */
1039         mc_kset = kset_create_and_add("mc", NULL, &edac_class->kset.kobj);
1040         if (!mc_kset) {
1041                 err = -ENOMEM;
1042                 debugf1("%s() Failed to register '.../edac/mc'\n", __func__);
1043                 goto fail_out;
1044         }
1045
1046         debugf1("%s() Registered '.../edac/mc' kobject\n", __func__);
1047
1048         return 0;
1049
1050
1051         /* error unwind stack */
1052 fail_out:
1053         return err;
1054 }
1055
1056 /*
1057  * edac_sysfs_teardown_mc_kset
1058  *
1059  *      deconstruct the mc_ket for memory controllers
1060  */
1061 void edac_sysfs_teardown_mc_kset(void)
1062 {
1063         kset_unregister(mc_kset);
1064 }
1065