2 * edac_mc kernel module
3 * (C) 2005, 2006 Linux Networx (http://lnxi.com)
4 * This file may be distributed under the terms of the
5 * GNU General Public License.
7 * Written by Thayne Harbaugh
8 * Based on work by Dan Hollis <goemon at anime dot net> and others.
9 * http://www.anime.net/~goemon/linux-ecc/
11 * Modified by Dave Peterson and Doug Thompson
15 #include <linux/module.h>
16 #include <linux/proc_fs.h>
17 #include <linux/kernel.h>
18 #include <linux/types.h>
19 #include <linux/smp.h>
20 #include <linux/init.h>
21 #include <linux/sysctl.h>
22 #include <linux/highmem.h>
23 #include <linux/timer.h>
24 #include <linux/slab.h>
25 #include <linux/jiffies.h>
26 #include <linux/spinlock.h>
27 #include <linux/list.h>
28 #include <linux/sysdev.h>
29 #include <linux/ctype.h>
30 #include <linux/edac.h>
31 #include <asm/uaccess.h>
34 #include "edac_core.h"
35 #include "edac_module.h"
38 /* lock to memory controller's control array */
39 static DEFINE_MUTEX(mem_ctls_mutex);
40 static struct list_head mc_devices = LIST_HEAD_INIT(mc_devices);
42 #ifdef CONFIG_EDAC_DEBUG
44 static void edac_mc_dump_channel(struct channel_info *chan)
46 debugf4("\tchannel = %p\n", chan);
47 debugf4("\tchannel->chan_idx = %d\n", chan->chan_idx);
48 debugf4("\tchannel->ce_count = %d\n", chan->ce_count);
49 debugf4("\tchannel->label = '%s'\n", chan->label);
50 debugf4("\tchannel->csrow = %p\n\n", chan->csrow);
53 static void edac_mc_dump_csrow(struct csrow_info *csrow)
55 debugf4("\tcsrow = %p\n", csrow);
56 debugf4("\tcsrow->csrow_idx = %d\n", csrow->csrow_idx);
57 debugf4("\tcsrow->first_page = 0x%lx\n",
59 debugf4("\tcsrow->last_page = 0x%lx\n", csrow->last_page);
60 debugf4("\tcsrow->page_mask = 0x%lx\n", csrow->page_mask);
61 debugf4("\tcsrow->nr_pages = 0x%x\n", csrow->nr_pages);
62 debugf4("\tcsrow->nr_channels = %d\n",
64 debugf4("\tcsrow->channels = %p\n", csrow->channels);
65 debugf4("\tcsrow->mci = %p\n\n", csrow->mci);
68 static void edac_mc_dump_mci(struct mem_ctl_info *mci)
70 debugf3("\tmci = %p\n", mci);
71 debugf3("\tmci->mtype_cap = %lx\n", mci->mtype_cap);
72 debugf3("\tmci->edac_ctl_cap = %lx\n", mci->edac_ctl_cap);
73 debugf3("\tmci->edac_cap = %lx\n", mci->edac_cap);
74 debugf4("\tmci->edac_check = %p\n", mci->edac_check);
75 debugf3("\tmci->nr_csrows = %d, csrows = %p\n",
76 mci->nr_csrows, mci->csrows);
77 debugf3("\tdev = %p\n", mci->dev);
78 debugf3("\tmod_name:ctl_name = %s:%s\n",
79 mci->mod_name, mci->ctl_name);
80 debugf3("\tpvt_info = %p\n\n", mci->pvt_info);
83 #endif /* CONFIG_EDAC_DEBUG */
85 /* 'ptr' points to a possibly unaligned item X such that sizeof(X) is 'size'.
86 * Adjust 'ptr' so that its alignment is at least as stringent as what the
87 * compiler would provide for X and return the aligned result.
89 * If 'size' is a constant, the compiler will optimize this whole function
90 * down to either a no-op or the addition of a constant to the value of 'ptr'.
92 char * edac_align_ptr(void *ptr, unsigned size)
96 /* Here we assume that the alignment of a "long long" is the most
97 * stringent alignment that the compiler will ever provide by default.
98 * As far as I know, this is a reasonable assumption.
100 if (size > sizeof(long))
101 align = sizeof(long long);
102 else if (size > sizeof(int))
103 align = sizeof(long);
104 else if (size > sizeof(short))
106 else if (size > sizeof(char))
107 align = sizeof(short);
116 return (char *) (((unsigned long) ptr) + align - r);
120 * edac_mc_alloc: Allocate a struct mem_ctl_info structure
121 * @size_pvt: size of private storage needed
122 * @nr_csrows: Number of CWROWS needed for this MC
123 * @nr_chans: Number of channels for the MC
125 * Everything is kmalloc'ed as one big chunk - more efficient.
126 * Only can be used if all structures have the same lifetime - otherwise
127 * you have to allocate and initialize your own structures.
129 * Use edac_mc_free() to free mc structures allocated by this function.
132 * NULL allocation failed
133 * struct mem_ctl_info pointer
135 struct mem_ctl_info *edac_mc_alloc(unsigned sz_pvt, unsigned nr_csrows,
138 struct mem_ctl_info *mci;
139 struct csrow_info *csi, *csrow;
140 struct channel_info *chi, *chp, *chan;
145 /* Figure out the offsets of the various items from the start of an mc
146 * structure. We want the alignment of each item to be at least as
147 * stringent as what the compiler would provide if we could simply
148 * hardcode everything into a single struct.
150 mci = (struct mem_ctl_info *) 0;
151 csi = (struct csrow_info *)edac_align_ptr(&mci[1], sizeof(*csi));
152 chi = (struct channel_info *)
153 edac_align_ptr(&csi[nr_csrows], sizeof(*chi));
154 pvt = edac_align_ptr(&chi[nr_chans * nr_csrows], sz_pvt);
155 size = ((unsigned long) pvt) + sz_pvt;
157 if ((mci = kmalloc(size, GFP_KERNEL)) == NULL)
160 /* Adjust pointers so they point within the memory we just allocated
161 * rather than an imaginary chunk of memory located at address 0.
163 csi = (struct csrow_info *) (((char *) mci) + ((unsigned long) csi));
164 chi = (struct channel_info *) (((char *) mci) + ((unsigned long) chi));
165 pvt = sz_pvt ? (((char *) mci) + ((unsigned long) pvt)) : NULL;
167 memset(mci, 0, size); /* clear all fields */
170 mci->nr_csrows = nr_csrows;
172 for (row = 0; row < nr_csrows; row++) {
174 csrow->csrow_idx = row;
176 csrow->nr_channels = nr_chans;
177 chp = &chi[row * nr_chans];
178 csrow->channels = chp;
180 for (chn = 0; chn < nr_chans; chn++) {
182 chan->chan_idx = chn;
189 EXPORT_SYMBOL_GPL(edac_mc_alloc);
192 * edac_mc_free: Free a previously allocated 'mci' structure
193 * @mci: pointer to a struct mem_ctl_info structure
195 void edac_mc_free(struct mem_ctl_info *mci)
199 EXPORT_SYMBOL_GPL(edac_mc_free);
201 static struct mem_ctl_info *find_mci_by_dev(struct device *dev)
203 struct mem_ctl_info *mci;
204 struct list_head *item;
206 debugf3("%s()\n", __func__);
208 list_for_each(item, &mc_devices) {
209 mci = list_entry(item, struct mem_ctl_info, link);
218 /* Return 0 on success, 1 on failure.
219 * Before calling this function, caller must
220 * assign a unique value to mci->mc_idx.
222 static int add_mc_to_global_list (struct mem_ctl_info *mci)
224 struct list_head *item, *insert_before;
225 struct mem_ctl_info *p;
227 insert_before = &mc_devices;
229 if (unlikely((p = find_mci_by_dev(mci->dev)) != NULL))
232 list_for_each(item, &mc_devices) {
233 p = list_entry(item, struct mem_ctl_info, link);
235 if (p->mc_idx >= mci->mc_idx) {
236 if (unlikely(p->mc_idx == mci->mc_idx))
239 insert_before = item;
244 list_add_tail_rcu(&mci->link, insert_before);
245 atomic_inc(&edac_handlers);
249 edac_printk(KERN_WARNING, EDAC_MC,
250 "%s (%s) %s %s already assigned %d\n", p->dev->bus_id,
251 dev_name(mci), p->mod_name, p->ctl_name, p->mc_idx);
255 edac_printk(KERN_WARNING, EDAC_MC,
256 "bug in low-level driver: attempt to assign\n"
257 " duplicate mc_idx %d in %s()\n", p->mc_idx, __func__);
261 static void complete_mc_list_del(struct rcu_head *head)
263 struct mem_ctl_info *mci;
265 mci = container_of(head, struct mem_ctl_info, rcu);
266 INIT_LIST_HEAD(&mci->link);
267 complete(&mci->complete);
270 static void del_mc_from_global_list(struct mem_ctl_info *mci)
272 atomic_dec(&edac_handlers);
273 list_del_rcu(&mci->link);
274 init_completion(&mci->complete);
275 call_rcu(&mci->rcu, complete_mc_list_del);
276 wait_for_completion(&mci->complete);
280 * edac_mc_find: Search for a mem_ctl_info structure whose index is 'idx'.
282 * If found, return a pointer to the structure.
285 * Caller must hold mem_ctls_mutex.
287 struct mem_ctl_info * edac_mc_find(int idx)
289 struct list_head *item;
290 struct mem_ctl_info *mci;
292 list_for_each(item, &mc_devices) {
293 mci = list_entry(item, struct mem_ctl_info, link);
295 if (mci->mc_idx >= idx) {
296 if (mci->mc_idx == idx)
305 EXPORT_SYMBOL(edac_mc_find);
308 * edac_mc_add_mc: Insert the 'mci' structure into the mci global list and
309 * create sysfs entries associated with mci structure
310 * @mci: pointer to the mci structure to be added to the list
311 * @mc_idx: A unique numeric identifier to be assigned to the 'mci' structure.
318 /* FIXME - should a warning be printed if no error detection? correction? */
319 int edac_mc_add_mc(struct mem_ctl_info *mci, int mc_idx)
321 debugf0("%s()\n", __func__);
322 mci->mc_idx = mc_idx;
323 #ifdef CONFIG_EDAC_DEBUG
324 if (edac_debug_level >= 3)
325 edac_mc_dump_mci(mci);
327 if (edac_debug_level >= 4) {
330 for (i = 0; i < mci->nr_csrows; i++) {
333 edac_mc_dump_csrow(&mci->csrows[i]);
334 for (j = 0; j < mci->csrows[i].nr_channels; j++)
335 edac_mc_dump_channel(
336 &mci->csrows[i].channels[j]);
340 mutex_lock(&mem_ctls_mutex);
342 if (add_mc_to_global_list(mci))
345 /* set load time so that error rate can be tracked */
346 mci->start_time = jiffies;
348 if (edac_create_sysfs_mci_device(mci)) {
349 edac_mc_printk(mci, KERN_WARNING,
350 "failed to create sysfs device\n");
354 /* Report action taken */
355 edac_mc_printk(mci, KERN_INFO, "Giving out device to %s %s: DEV %s\n",
356 mci->mod_name, mci->ctl_name, dev_name(mci));
358 mutex_unlock(&mem_ctls_mutex);
362 del_mc_from_global_list(mci);
365 mutex_unlock(&mem_ctls_mutex);
368 EXPORT_SYMBOL_GPL(edac_mc_add_mc);
371 * edac_mc_del_mc: Remove sysfs entries for specified mci structure and
372 * remove mci structure from global list
373 * @pdev: Pointer to 'struct device' representing mci structure to remove.
375 * Return pointer to removed mci structure, or NULL if device not found.
377 struct mem_ctl_info * edac_mc_del_mc(struct device *dev)
379 struct mem_ctl_info *mci;
381 debugf0("MC: %s()\n", __func__);
382 mutex_lock(&mem_ctls_mutex);
384 if ((mci = find_mci_by_dev(dev)) == NULL) {
385 mutex_unlock(&mem_ctls_mutex);
389 edac_remove_sysfs_mci_device(mci);
390 del_mc_from_global_list(mci);
391 mutex_unlock(&mem_ctls_mutex);
392 edac_printk(KERN_INFO, EDAC_MC,
393 "Removed device %d for %s %s: DEV %s\n", mci->mc_idx,
394 mci->mod_name, mci->ctl_name, dev_name(mci));
397 EXPORT_SYMBOL_GPL(edac_mc_del_mc);
399 static void edac_mc_scrub_block(unsigned long page, unsigned long offset,
404 unsigned long flags = 0;
406 debugf3("%s()\n", __func__);
408 /* ECC error page was not in our memory. Ignore it. */
412 /* Find the actual page structure then map it and fix */
413 pg = pfn_to_page(page);
416 local_irq_save(flags);
418 virt_addr = kmap_atomic(pg, KM_BOUNCE_READ);
420 /* Perform architecture specific atomic scrub operation */
421 atomic_scrub(virt_addr + offset, size);
423 /* Unmap and complete */
424 kunmap_atomic(virt_addr, KM_BOUNCE_READ);
427 local_irq_restore(flags);
430 /* FIXME - should return -1 */
431 int edac_mc_find_csrow_by_page(struct mem_ctl_info *mci, unsigned long page)
433 struct csrow_info *csrows = mci->csrows;
436 debugf1("MC%d: %s(): 0x%lx\n", mci->mc_idx, __func__, page);
439 for (i = 0; i < mci->nr_csrows; i++) {
440 struct csrow_info *csrow = &csrows[i];
442 if (csrow->nr_pages == 0)
445 debugf3("MC%d: %s(): first(0x%lx) page(0x%lx) last(0x%lx) "
446 "mask(0x%lx)\n", mci->mc_idx, __func__,
447 csrow->first_page, page, csrow->last_page,
450 if ((page >= csrow->first_page) &&
451 (page <= csrow->last_page) &&
452 ((page & csrow->page_mask) ==
453 (csrow->first_page & csrow->page_mask))) {
460 edac_mc_printk(mci, KERN_ERR,
461 "could not look up page error address %lx\n",
462 (unsigned long) page);
466 EXPORT_SYMBOL_GPL(edac_mc_find_csrow_by_page);
468 /* FIXME - setable log (warning/emerg) levels */
469 /* FIXME - integrate with evlog: http://evlog.sourceforge.net/ */
470 void edac_mc_handle_ce(struct mem_ctl_info *mci,
471 unsigned long page_frame_number, unsigned long offset_in_page,
472 unsigned long syndrome, int row, int channel, const char *msg)
474 unsigned long remapped_page;
476 debugf3("MC%d: %s()\n", mci->mc_idx, __func__);
478 /* FIXME - maybe make panic on INTERNAL ERROR an option */
479 if (row >= mci->nr_csrows || row < 0) {
480 /* something is wrong */
481 edac_mc_printk(mci, KERN_ERR,
482 "INTERNAL ERROR: row out of range "
483 "(%d >= %d)\n", row, mci->nr_csrows);
484 edac_mc_handle_ce_no_info(mci, "INTERNAL ERROR");
488 if (channel >= mci->csrows[row].nr_channels || channel < 0) {
489 /* something is wrong */
490 edac_mc_printk(mci, KERN_ERR,
491 "INTERNAL ERROR: channel out of range "
492 "(%d >= %d)\n", channel,
493 mci->csrows[row].nr_channels);
494 edac_mc_handle_ce_no_info(mci, "INTERNAL ERROR");
498 if (edac_get_log_ce())
499 /* FIXME - put in DIMM location */
500 edac_mc_printk(mci, KERN_WARNING,
501 "CE page 0x%lx, offset 0x%lx, grain %d, syndrome "
502 "0x%lx, row %d, channel %d, label \"%s\": %s\n",
503 page_frame_number, offset_in_page,
504 mci->csrows[row].grain, syndrome, row, channel,
505 mci->csrows[row].channels[channel].label, msg);
508 mci->csrows[row].ce_count++;
509 mci->csrows[row].channels[channel].ce_count++;
511 if (mci->scrub_mode & SCRUB_SW_SRC) {
513 * Some MC's can remap memory so that it is still available
514 * at a different address when PCI devices map into memory.
515 * MC's that can't do this lose the memory where PCI devices
516 * are mapped. This mapping is MC dependant and so we call
517 * back into the MC driver for it to map the MC page to
518 * a physical (CPU) page which can then be mapped to a virtual
519 * page - which can then be scrubbed.
521 remapped_page = mci->ctl_page_to_phys ?
522 mci->ctl_page_to_phys(mci, page_frame_number) :
525 edac_mc_scrub_block(remapped_page, offset_in_page,
526 mci->csrows[row].grain);
529 EXPORT_SYMBOL_GPL(edac_mc_handle_ce);
531 void edac_mc_handle_ce_no_info(struct mem_ctl_info *mci, const char *msg)
533 if (edac_get_log_ce())
534 edac_mc_printk(mci, KERN_WARNING,
535 "CE - no information available: %s\n", msg);
537 mci->ce_noinfo_count++;
540 EXPORT_SYMBOL_GPL(edac_mc_handle_ce_no_info);
542 void edac_mc_handle_ue(struct mem_ctl_info *mci,
543 unsigned long page_frame_number, unsigned long offset_in_page,
544 int row, const char *msg)
546 int len = EDAC_MC_LABEL_LEN * 4;
547 char labels[len + 1];
552 debugf3("MC%d: %s()\n", mci->mc_idx, __func__);
554 /* FIXME - maybe make panic on INTERNAL ERROR an option */
555 if (row >= mci->nr_csrows || row < 0) {
556 /* something is wrong */
557 edac_mc_printk(mci, KERN_ERR,
558 "INTERNAL ERROR: row out of range "
559 "(%d >= %d)\n", row, mci->nr_csrows);
560 edac_mc_handle_ue_no_info(mci, "INTERNAL ERROR");
564 chars = snprintf(pos, len + 1, "%s",
565 mci->csrows[row].channels[0].label);
569 for (chan = 1; (chan < mci->csrows[row].nr_channels) && (len > 0);
571 chars = snprintf(pos, len + 1, ":%s",
572 mci->csrows[row].channels[chan].label);
577 if (edac_get_log_ue())
578 edac_mc_printk(mci, KERN_EMERG,
579 "UE page 0x%lx, offset 0x%lx, grain %d, row %d, "
580 "labels \"%s\": %s\n", page_frame_number,
581 offset_in_page, mci->csrows[row].grain, row, labels,
584 if (edac_get_panic_on_ue())
585 panic("EDAC MC%d: UE page 0x%lx, offset 0x%lx, grain %d, "
586 "row %d, labels \"%s\": %s\n", mci->mc_idx,
587 page_frame_number, offset_in_page,
588 mci->csrows[row].grain, row, labels, msg);
591 mci->csrows[row].ue_count++;
593 EXPORT_SYMBOL_GPL(edac_mc_handle_ue);
595 void edac_mc_handle_ue_no_info(struct mem_ctl_info *mci, const char *msg)
597 if (edac_get_panic_on_ue())
598 panic("EDAC MC%d: Uncorrected Error", mci->mc_idx);
600 if (edac_get_log_ue())
601 edac_mc_printk(mci, KERN_WARNING,
602 "UE - no information available: %s\n", msg);
603 mci->ue_noinfo_count++;
606 EXPORT_SYMBOL_GPL(edac_mc_handle_ue_no_info);
609 /*************************************************************
610 * On Fully Buffered DIMM modules, this help function is
611 * called to process UE events
613 void edac_mc_handle_fbd_ue(struct mem_ctl_info *mci,
615 unsigned int channela,
616 unsigned int channelb,
619 int len = EDAC_MC_LABEL_LEN * 4;
620 char labels[len + 1];
624 if (csrow >= mci->nr_csrows) {
625 /* something is wrong */
626 edac_mc_printk(mci, KERN_ERR,
627 "INTERNAL ERROR: row out of range (%d >= %d)\n",
628 csrow, mci->nr_csrows);
629 edac_mc_handle_ue_no_info(mci, "INTERNAL ERROR");
633 if (channela >= mci->csrows[csrow].nr_channels) {
634 /* something is wrong */
635 edac_mc_printk(mci, KERN_ERR,
636 "INTERNAL ERROR: channel-a out of range "
638 channela, mci->csrows[csrow].nr_channels);
639 edac_mc_handle_ue_no_info(mci, "INTERNAL ERROR");
643 if (channelb >= mci->csrows[csrow].nr_channels) {
644 /* something is wrong */
645 edac_mc_printk(mci, KERN_ERR,
646 "INTERNAL ERROR: channel-b out of range "
648 channelb, mci->csrows[csrow].nr_channels);
649 edac_mc_handle_ue_no_info(mci, "INTERNAL ERROR");
654 mci->csrows[csrow].ue_count++;
656 /* Generate the DIMM labels from the specified channels */
657 chars = snprintf(pos, len + 1, "%s",
658 mci->csrows[csrow].channels[channela].label);
659 len -= chars; pos += chars;
660 chars = snprintf(pos, len + 1, "-%s",
661 mci->csrows[csrow].channels[channelb].label);
663 if (edac_get_log_ue())
664 edac_mc_printk(mci, KERN_EMERG,
665 "UE row %d, channel-a= %d channel-b= %d "
666 "labels \"%s\": %s\n", csrow, channela, channelb,
669 if (edac_get_panic_on_ue())
670 panic("UE row %d, channel-a= %d channel-b= %d "
671 "labels \"%s\": %s\n", csrow, channela,
672 channelb, labels, msg);
674 EXPORT_SYMBOL(edac_mc_handle_fbd_ue);
676 /*************************************************************
677 * On Fully Buffered DIMM modules, this help function is
678 * called to process CE events
680 void edac_mc_handle_fbd_ce(struct mem_ctl_info *mci,
682 unsigned int channel,
686 /* Ensure boundary values */
687 if (csrow >= mci->nr_csrows) {
688 /* something is wrong */
689 edac_mc_printk(mci, KERN_ERR,
690 "INTERNAL ERROR: row out of range (%d >= %d)\n",
691 csrow, mci->nr_csrows);
692 edac_mc_handle_ce_no_info(mci, "INTERNAL ERROR");
695 if (channel >= mci->csrows[csrow].nr_channels) {
696 /* something is wrong */
697 edac_mc_printk(mci, KERN_ERR,
698 "INTERNAL ERROR: channel out of range (%d >= %d)\n",
699 channel, mci->csrows[csrow].nr_channels);
700 edac_mc_handle_ce_no_info(mci, "INTERNAL ERROR");
704 if (edac_get_log_ce())
705 /* FIXME - put in DIMM location */
706 edac_mc_printk(mci, KERN_WARNING,
707 "CE row %d, channel %d, label \"%s\": %s\n",
709 mci->csrows[csrow].channels[channel].label,
713 mci->csrows[csrow].ce_count++;
714 mci->csrows[csrow].channels[channel].ce_count++;
716 EXPORT_SYMBOL(edac_mc_handle_fbd_ce);
720 * Iterate over all MC instances and check for ECC, et al, errors
722 void edac_check_mc_devices(void)
724 struct list_head *item;
725 struct mem_ctl_info *mci;
727 debugf3("%s()\n", __func__);
728 mutex_lock(&mem_ctls_mutex);
730 list_for_each(item, &mc_devices) {
731 mci = list_entry(item, struct mem_ctl_info, link);
733 if (mci->edac_check != NULL)
734 mci->edac_check(mci);
737 mutex_unlock(&mem_ctls_mutex);