drivers/edac/edac_core.h

   1 /*
   2  * Defines, structures, APIs for edac_core module
   3  *
   4  * (C) 2007 Linux Networx (http://lnxi.com)
   5  * This file may be distributed under the terms of the
   6  * GNU General Public License.
   7  *
   8  * Written by Thayne Harbaugh
   9  * Based on work by Dan Hollis <goemon at anime dot net> and others.
  10  *      http://www.anime.net/~goemon/linux-ecc/
  11  *
  12  * NMI handling support added by
  13  *     Dave Peterson <dsp@llnl.gov> <dave_peterson@pobox.com>
  14  *
  15  * Refactored for multi-source files:
  16  *      Doug Thompson <norsk5@xmission.com>
  17  *
  18  */
  19
  20 #ifndef _EDAC_CORE_H_
  21 #define _EDAC_CORE_H_
  22
  23 #include <linux/kernel.h>
  24 #include <linux/types.h>
  25 #include <linux/module.h>
  26 #include <linux/spinlock.h>
  27 #include <linux/smp.h>
  28 #include <linux/pci.h>
  29 #include <linux/time.h>
  30 #include <linux/nmi.h>
  31 #include <linux/rcupdate.h>
  32 #include <linux/completion.h>
  33 #include <linux/kobject.h>
  34 #include <linux/platform_device.h>
  35 #include <linux/workqueue.h>
  36 #include <linux/edac.h>
  37
  38 #include "edac_pci.h"
  39 #include "edac_device.h"
  40
  41 #if PAGE_SHIFT < 20
  42 #define PAGES_TO_MiB(pages)     ((pages) >> (20 - PAGE_SHIFT))
  43 #define MiB_TO_PAGES(mb)        ((mb) << (20 - PAGE_SHIFT))
  44 #else                           /* PAGE_SHIFT > 20 */
  45 #define PAGES_TO_MiB(pages)     ((pages) << (PAGE_SHIFT - 20))
  46 #define MiB_TO_PAGES(mb)        ((mb) >> (PAGE_SHIFT - 20))
  47 #endif
  48
  49 #define edac_printk(level, prefix, fmt, arg...) \
  50         printk(level "EDAC " prefix ": " fmt, ##arg)
  51
  52 #define edac_mc_printk(mci, level, fmt, arg...) \
  53         printk(level "EDAC MC%d: " fmt, mci->mc_idx, ##arg)
  54
  55 #define edac_mc_chipset_printk(mci, level, prefix, fmt, arg...) \
  56         printk(level "EDAC " prefix " MC%d: " fmt, mci->mc_idx, ##arg)
  57
  58 #define edac_device_printk(ctl, level, fmt, arg...) \
  59         printk(level "EDAC DEVICE%d: " fmt, ctl->dev_idx, ##arg)
  60
  61 #define edac_pci_printk(ctl, level, fmt, arg...) \
  62         printk(level "EDAC PCI%d: " fmt, ctl->pci_idx, ##arg)
  63
  64 /* prefixes for edac_printk() and edac_mc_printk() */
  65 #define EDAC_MC "MC"
  66 #define EDAC_PCI "PCI"
  67 #define EDAC_DEBUG "DEBUG"
  68
  69 extern const char * const edac_mem_types[];
  70
  71 #ifdef CONFIG_EDAC_DEBUG
  72 extern int edac_debug_level;
  73
  74 #define edac_dbg(level, fmt, ...)                                       \
  75 do {                                                                    \
  76         if (level <= edac_debug_level)                                  \
  77                 edac_printk(KERN_DEBUG, EDAC_DEBUG,                     \
  78                             "%s: " fmt, __func__, ##__VA_ARGS__);       \
  79 } while (0)
  80
  81 #else                           /* !CONFIG_EDAC_DEBUG */
  82
  83 #define edac_dbg(level, fmt, ...)                                       \
  84 do {                                                                    \
  85         if (0)                                                          \
  86                 edac_printk(KERN_DEBUG, EDAC_DEBUG,                     \
  87                             "%s: " fmt, __func__, ##__VA_ARGS__);       \
  88 } while (0)
  89
  90 #endif                          /* !CONFIG_EDAC_DEBUG */
  91
  92 #define PCI_VEND_DEV(vend, dev) PCI_VENDOR_ID_ ## vend, \
  93         PCI_DEVICE_ID_ ## vend ## _ ## dev
  94
  95 #define edac_dev_name(dev) (dev)->dev_name
  96
  97 #define to_mci(k) container_of(k, struct mem_ctl_info, dev)
  98
  99 struct mem_ctl_info *edac_mc_alloc(unsigned mc_num,
 100                                    unsigned n_layers,
 101                                    struct edac_mc_layer *layers,
 102                                    unsigned sz_pvt);
 103 extern int edac_mc_add_mc_with_groups(struct mem_ctl_info *mci,
 104                                       const struct attribute_group **groups);
 105 #define edac_mc_add_mc(mci)     edac_mc_add_mc_with_groups(mci, NULL)
 106 extern void edac_mc_free(struct mem_ctl_info *mci);
 107 extern struct mem_ctl_info *edac_mc_find(int idx);
 108 extern struct mem_ctl_info *find_mci_by_dev(struct device *dev);
 109 extern struct mem_ctl_info *edac_mc_del_mc(struct device *dev);
 110 extern int edac_mc_find_csrow_by_page(struct mem_ctl_info *mci,
 111                                       unsigned long page);
 112
 113 void edac_raw_mc_handle_error(const enum hw_event_mc_err_type type,
 114                               struct mem_ctl_info *mci,
 115                               struct edac_raw_error_desc *e);
 116
 117 void edac_mc_handle_error(const enum hw_event_mc_err_type type,
 118                           struct mem_ctl_info *mci,
 119                           const u16 error_count,
 120                           const unsigned long page_frame_number,
 121                           const unsigned long offset_in_page,
 122                           const unsigned long syndrome,
 123                           const int top_layer,
 124                           const int mid_layer,
 125                           const int low_layer,
 126                           const char *msg,
 127                           const char *other_detail);
 128
 129 /*
 130  * edac misc APIs
 131  */
 132 extern char *edac_op_state_to_string(int op_state);
 133
 134 #endif                          /* _EDAC_CORE_H_ */