drivers/edac: mod edac_align_ptr function
[linux-2.6.git] / 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/sysdev.h>
36 #include <linux/workqueue.h>
37 #include <linux/version.h>
38
39 #define EDAC_MC_LABEL_LEN       31
40 #define EDAC_DEVICE_NAME_LEN    31
41 #define EDAC_ATTRIB_VALUE_LEN   15
42 #define MC_PROC_NAME_MAX_LEN    7
43
44 #if PAGE_SHIFT < 20
45 #define PAGES_TO_MiB( pages )   ( ( pages ) >> ( 20 - PAGE_SHIFT ) )
46 #else                           /* PAGE_SHIFT > 20 */
47 #define PAGES_TO_MiB( pages )   ( ( pages ) << ( PAGE_SHIFT - 20 ) )
48 #endif
49
50 #define edac_printk(level, prefix, fmt, arg...) \
51         printk(level "EDAC " prefix ": " fmt, ##arg)
52
53 #define edac_mc_printk(mci, level, fmt, arg...) \
54         printk(level "EDAC MC%d: " fmt, mci->mc_idx, ##arg)
55
56 #define edac_mc_chipset_printk(mci, level, prefix, fmt, arg...) \
57         printk(level "EDAC " prefix " MC%d: " fmt, mci->mc_idx, ##arg)
58
59 /* edac_device printk */
60 #define edac_device_printk(ctl, level, fmt, arg...) \
61         printk(level "EDAC DEVICE%d: " fmt, ctl->dev_idx, ##arg)
62
63 /* edac_pci printk */
64 #define edac_pci_printk(ctl, level, fmt, arg...) \
65         printk(level "EDAC PCI%d: " fmt, ctl->pci_idx, ##arg)
66
67 /* prefixes for edac_printk() and edac_mc_printk() */
68 #define EDAC_MC "MC"
69 #define EDAC_PCI "PCI"
70 #define EDAC_DEBUG "DEBUG"
71
72 #ifdef CONFIG_EDAC_DEBUG
73 extern int edac_debug_level;
74
75 #define edac_debug_printk(level, fmt, arg...)                            \
76         do {                                                             \
77                 if (level <= edac_debug_level)                           \
78                         edac_printk(KERN_EMERG, EDAC_DEBUG, fmt, ##arg); \
79         } while(0)
80
81 #define debugf0( ... ) edac_debug_printk(0, __VA_ARGS__ )
82 #define debugf1( ... ) edac_debug_printk(1, __VA_ARGS__ )
83 #define debugf2( ... ) edac_debug_printk(2, __VA_ARGS__ )
84 #define debugf3( ... ) edac_debug_printk(3, __VA_ARGS__ )
85 #define debugf4( ... ) edac_debug_printk(4, __VA_ARGS__ )
86
87 #else                           /* !CONFIG_EDAC_DEBUG */
88
89 #define debugf0( ... )
90 #define debugf1( ... )
91 #define debugf2( ... )
92 #define debugf3( ... )
93 #define debugf4( ... )
94
95 #endif                          /* !CONFIG_EDAC_DEBUG */
96
97 #define BIT(x) (1 << (x))
98
99 #define PCI_VEND_DEV(vend, dev) PCI_VENDOR_ID_ ## vend, \
100         PCI_DEVICE_ID_ ## vend ## _ ## dev
101
102 #define dev_name(dev) (dev)->dev_name
103
104 /* memory devices */
105 enum dev_type {
106         DEV_UNKNOWN = 0,
107         DEV_X1,
108         DEV_X2,
109         DEV_X4,
110         DEV_X8,
111         DEV_X16,
112         DEV_X32,                /* Do these parts exist? */
113         DEV_X64                 /* Do these parts exist? */
114 };
115
116 #define DEV_FLAG_UNKNOWN        BIT(DEV_UNKNOWN)
117 #define DEV_FLAG_X1             BIT(DEV_X1)
118 #define DEV_FLAG_X2             BIT(DEV_X2)
119 #define DEV_FLAG_X4             BIT(DEV_X4)
120 #define DEV_FLAG_X8             BIT(DEV_X8)
121 #define DEV_FLAG_X16            BIT(DEV_X16)
122 #define DEV_FLAG_X32            BIT(DEV_X32)
123 #define DEV_FLAG_X64            BIT(DEV_X64)
124
125 /* memory types */
126 enum mem_type {
127         MEM_EMPTY = 0,          /* Empty csrow */
128         MEM_RESERVED,           /* Reserved csrow type */
129         MEM_UNKNOWN,            /* Unknown csrow type */
130         MEM_FPM,                /* Fast page mode */
131         MEM_EDO,                /* Extended data out */
132         MEM_BEDO,               /* Burst Extended data out */
133         MEM_SDR,                /* Single data rate SDRAM */
134         MEM_RDR,                /* Registered single data rate SDRAM */
135         MEM_DDR,                /* Double data rate SDRAM */
136         MEM_RDDR,               /* Registered Double data rate SDRAM */
137         MEM_RMBS,               /* Rambus DRAM */
138         MEM_DDR2,               /* DDR2 RAM */
139         MEM_FB_DDR2,            /* fully buffered DDR2 */
140         MEM_RDDR2,              /* Registered DDR2 RAM */
141 };
142
143 #define MEM_FLAG_EMPTY          BIT(MEM_EMPTY)
144 #define MEM_FLAG_RESERVED       BIT(MEM_RESERVED)
145 #define MEM_FLAG_UNKNOWN        BIT(MEM_UNKNOWN)
146 #define MEM_FLAG_FPM            BIT(MEM_FPM)
147 #define MEM_FLAG_EDO            BIT(MEM_EDO)
148 #define MEM_FLAG_BEDO           BIT(MEM_BEDO)
149 #define MEM_FLAG_SDR            BIT(MEM_SDR)
150 #define MEM_FLAG_RDR            BIT(MEM_RDR)
151 #define MEM_FLAG_DDR            BIT(MEM_DDR)
152 #define MEM_FLAG_RDDR           BIT(MEM_RDDR)
153 #define MEM_FLAG_RMBS           BIT(MEM_RMBS)
154 #define MEM_FLAG_DDR2           BIT(MEM_DDR2)
155 #define MEM_FLAG_FB_DDR2        BIT(MEM_FB_DDR2)
156 #define MEM_FLAG_RDDR2          BIT(MEM_RDDR2)
157
158 /* chipset Error Detection and Correction capabilities and mode */
159 enum edac_type {
160         EDAC_UNKNOWN = 0,       /* Unknown if ECC is available */
161         EDAC_NONE,              /* Doesnt support ECC */
162         EDAC_RESERVED,          /* Reserved ECC type */
163         EDAC_PARITY,            /* Detects parity errors */
164         EDAC_EC,                /* Error Checking - no correction */
165         EDAC_SECDED,            /* Single bit error correction, Double detection */
166         EDAC_S2ECD2ED,          /* Chipkill x2 devices - do these exist? */
167         EDAC_S4ECD4ED,          /* Chipkill x4 devices */
168         EDAC_S8ECD8ED,          /* Chipkill x8 devices */
169         EDAC_S16ECD16ED,        /* Chipkill x16 devices */
170 };
171
172 #define EDAC_FLAG_UNKNOWN       BIT(EDAC_UNKNOWN)
173 #define EDAC_FLAG_NONE          BIT(EDAC_NONE)
174 #define EDAC_FLAG_PARITY        BIT(EDAC_PARITY)
175 #define EDAC_FLAG_EC            BIT(EDAC_EC)
176 #define EDAC_FLAG_SECDED        BIT(EDAC_SECDED)
177 #define EDAC_FLAG_S2ECD2ED      BIT(EDAC_S2ECD2ED)
178 #define EDAC_FLAG_S4ECD4ED      BIT(EDAC_S4ECD4ED)
179 #define EDAC_FLAG_S8ECD8ED      BIT(EDAC_S8ECD8ED)
180 #define EDAC_FLAG_S16ECD16ED    BIT(EDAC_S16ECD16ED)
181
182 /* scrubbing capabilities */
183 enum scrub_type {
184         SCRUB_UNKNOWN = 0,      /* Unknown if scrubber is available */
185         SCRUB_NONE,             /* No scrubber */
186         SCRUB_SW_PROG,          /* SW progressive (sequential) scrubbing */
187         SCRUB_SW_SRC,           /* Software scrub only errors */
188         SCRUB_SW_PROG_SRC,      /* Progressive software scrub from an error */
189         SCRUB_SW_TUNABLE,       /* Software scrub frequency is tunable */
190         SCRUB_HW_PROG,          /* HW progressive (sequential) scrubbing */
191         SCRUB_HW_SRC,           /* Hardware scrub only errors */
192         SCRUB_HW_PROG_SRC,      /* Progressive hardware scrub from an error */
193         SCRUB_HW_TUNABLE        /* Hardware scrub frequency is tunable */
194 };
195
196 #define SCRUB_FLAG_SW_PROG      BIT(SCRUB_SW_PROG)
197 #define SCRUB_FLAG_SW_SRC       BIT(SCRUB_SW_SRC)
198 #define SCRUB_FLAG_SW_PROG_SRC  BIT(SCRUB_SW_PROG_SRC)
199 #define SCRUB_FLAG_SW_TUN       BIT(SCRUB_SW_SCRUB_TUNABLE)
200 #define SCRUB_FLAG_HW_PROG      BIT(SCRUB_HW_PROG)
201 #define SCRUB_FLAG_HW_SRC       BIT(SCRUB_HW_SRC)
202 #define SCRUB_FLAG_HW_PROG_SRC  BIT(SCRUB_HW_PROG_SRC)
203 #define SCRUB_FLAG_HW_TUN       BIT(SCRUB_HW_TUNABLE)
204
205 /* FIXME - should have notify capabilities: NMI, LOG, PROC, etc */
206
207 /* EDAC internal operation states */
208 #define OP_ALLOC                0x100
209 #define OP_RUNNING_POLL         0x201
210 #define OP_RUNNING_INTERRUPT    0x202
211 #define OP_RUNNING_POLL_INTR    0x203
212 #define OP_OFFLINE              0x300
213
214 /*
215  * There are several things to be aware of that aren't at all obvious:
216  *
217  *
218  * SOCKETS, SOCKET SETS, BANKS, ROWS, CHIP-SELECT ROWS, CHANNELS, etc..
219  *
220  * These are some of the many terms that are thrown about that don't always
221  * mean what people think they mean (Inconceivable!).  In the interest of
222  * creating a common ground for discussion, terms and their definitions
223  * will be established.
224  *
225  * Memory devices:      The individual chip on a memory stick.  These devices
226  *                      commonly output 4 and 8 bits each.  Grouping several
227  *                      of these in parallel provides 64 bits which is common
228  *                      for a memory stick.
229  *
230  * Memory Stick:        A printed circuit board that agregates multiple
231  *                      memory devices in parallel.  This is the atomic
232  *                      memory component that is purchaseable by Joe consumer
233  *                      and loaded into a memory socket.
234  *
235  * Socket:              A physical connector on the motherboard that accepts
236  *                      a single memory stick.
237  *
238  * Channel:             Set of memory devices on a memory stick that must be
239  *                      grouped in parallel with one or more additional
240  *                      channels from other memory sticks.  This parallel
241  *                      grouping of the output from multiple channels are
242  *                      necessary for the smallest granularity of memory access.
243  *                      Some memory controllers are capable of single channel -
244  *                      which means that memory sticks can be loaded
245  *                      individually.  Other memory controllers are only
246  *                      capable of dual channel - which means that memory
247  *                      sticks must be loaded as pairs (see "socket set").
248  *
249  * Chip-select row:     All of the memory devices that are selected together.
250  *                      for a single, minimum grain of memory access.
251  *                      This selects all of the parallel memory devices across
252  *                      all of the parallel channels.  Common chip-select rows
253  *                      for single channel are 64 bits, for dual channel 128
254  *                      bits.
255  *
256  * Single-Ranked stick: A Single-ranked stick has 1 chip-select row of memmory.
257  *                      Motherboards commonly drive two chip-select pins to
258  *                      a memory stick. A single-ranked stick, will occupy
259  *                      only one of those rows. The other will be unused.
260  *
261  * Double-Ranked stick: A double-ranked stick has two chip-select rows which
262  *                      access different sets of memory devices.  The two
263  *                      rows cannot be accessed concurrently.
264  *
265  * Double-sided stick:  DEPRECATED TERM, see Double-Ranked stick.
266  *                      A double-sided stick has two chip-select rows which
267  *                      access different sets of memory devices.  The two
268  *                      rows cannot be accessed concurrently.  "Double-sided"
269  *                      is irrespective of the memory devices being mounted
270  *                      on both sides of the memory stick.
271  *
272  * Socket set:          All of the memory sticks that are required for for
273  *                      a single memory access or all of the memory sticks
274  *                      spanned by a chip-select row.  A single socket set
275  *                      has two chip-select rows and if double-sided sticks
276  *                      are used these will occupy those chip-select rows.
277  *
278  * Bank:                This term is avoided because it is unclear when
279  *                      needing to distinguish between chip-select rows and
280  *                      socket sets.
281  *
282  * Controller pages:
283  *
284  * Physical pages:
285  *
286  * Virtual pages:
287  *
288  *
289  * STRUCTURE ORGANIZATION AND CHOICES
290  *
291  *
292  *
293  * PS - I enjoyed writing all that about as much as you enjoyed reading it.
294  */
295
296 struct channel_info {
297         int chan_idx;           /* channel index */
298         u32 ce_count;           /* Correctable Errors for this CHANNEL */
299         char label[EDAC_MC_LABEL_LEN + 1];      /* DIMM label on motherboard */
300         struct csrow_info *csrow;       /* the parent */
301 };
302
303 struct csrow_info {
304         unsigned long first_page;       /* first page number in dimm */
305         unsigned long last_page;        /* last page number in dimm */
306         unsigned long page_mask;        /* used for interleaving -
307                                          * 0UL for non intlv
308                                          */
309         u32 nr_pages;           /* number of pages in csrow */
310         u32 grain;              /* granularity of reported error in bytes */
311         int csrow_idx;          /* the chip-select row */
312         enum dev_type dtype;    /* memory device type */
313         u32 ue_count;           /* Uncorrectable Errors for this csrow */
314         u32 ce_count;           /* Correctable Errors for this csrow */
315         enum mem_type mtype;    /* memory csrow type */
316         enum edac_type edac_mode;       /* EDAC mode for this csrow */
317         struct mem_ctl_info *mci;       /* the parent */
318
319         struct kobject kobj;    /* sysfs kobject for this csrow */
320         struct completion kobj_complete;
321
322         /* FIXME the number of CHANNELs might need to become dynamic */
323         u32 nr_channels;
324         struct channel_info *channels;
325 };
326
327 /* mcidev_sysfs_attribute structure
328  *      used for driver sysfs attributes and in mem_ctl_info
329  *      sysfs top level entries
330  */
331 struct mcidev_sysfs_attribute {
332         struct attribute attr;
333         ssize_t (*show)(struct mem_ctl_info *,char *);
334         ssize_t (*store)(struct mem_ctl_info *, const char *,size_t);
335 };
336
337 /* MEMORY controller information structure
338  */
339 struct mem_ctl_info {
340         struct list_head link;  /* for global list of mem_ctl_info structs */
341         unsigned long mtype_cap;        /* memory types supported by mc */
342         unsigned long edac_ctl_cap;     /* Mem controller EDAC capabilities */
343         unsigned long edac_cap; /* configuration capabilities - this is
344                                  * closely related to edac_ctl_cap.  The
345                                  * difference is that the controller may be
346                                  * capable of s4ecd4ed which would be listed
347                                  * in edac_ctl_cap, but if channels aren't
348                                  * capable of s4ecd4ed then the edac_cap would
349                                  * not have that capability.
350                                  */
351         unsigned long scrub_cap;        /* chipset scrub capabilities */
352         enum scrub_type scrub_mode;     /* current scrub mode */
353
354         /* Translates sdram memory scrub rate given in bytes/sec to the
355            internal representation and configures whatever else needs
356            to be configured.
357          */
358         int (*set_sdram_scrub_rate) (struct mem_ctl_info * mci, u32 * bw);
359
360         /* Get the current sdram memory scrub rate from the internal
361            representation and converts it to the closest matching
362            bandwith in bytes/sec.
363          */
364         int (*get_sdram_scrub_rate) (struct mem_ctl_info * mci, u32 * bw);
365
366
367         /* pointer to edac checking routine */
368         void (*edac_check) (struct mem_ctl_info * mci);
369
370         /*
371          * Remaps memory pages: controller pages to physical pages.
372          * For most MC's, this will be NULL.
373          */
374         /* FIXME - why not send the phys page to begin with? */
375         unsigned long (*ctl_page_to_phys) (struct mem_ctl_info * mci,
376                                            unsigned long page);
377         int mc_idx;
378         int nr_csrows;
379         struct csrow_info *csrows;
380         /*
381          * FIXME - what about controllers on other busses? - IDs must be
382          * unique.  dev pointer should be sufficiently unique, but
383          * BUS:SLOT.FUNC numbers may not be unique.
384          */
385         struct device *dev;
386         const char *mod_name;
387         const char *mod_ver;
388         const char *ctl_name;
389         const char *dev_name;
390         char proc_name[MC_PROC_NAME_MAX_LEN + 1];
391         void *pvt_info;
392         u32 ue_noinfo_count;    /* Uncorrectable Errors w/o info */
393         u32 ce_noinfo_count;    /* Correctable Errors w/o info */
394         u32 ue_count;           /* Total Uncorrectable Errors for this MC */
395         u32 ce_count;           /* Total Correctable Errors for this MC */
396         unsigned long start_time;       /* mci load start time (in jiffies) */
397
398         /* this stuff is for safe removal of mc devices from global list while
399          * NMI handlers may be traversing list
400          */
401         struct rcu_head rcu;
402         struct completion complete;
403
404         /* edac sysfs device control */
405         struct kobject edac_mci_kobj;
406         struct completion kobj_complete;
407
408         /* Additional top controller level attributes, but specified
409          * by the low level driver.
410          *
411          * Set by the low level driver to provide attributes at the
412          * controller level, same level as 'ue_count' and 'ce_count' above.
413          * An array of structures, NULL terminated
414          *
415          * If attributes are desired, then set to array of attributes
416          * If no attributes are desired, leave NULL
417          */
418         struct mcidev_sysfs_attribute *mc_driver_sysfs_attributes;
419
420         /* work struct for this MC */
421         struct delayed_work work;
422
423         /* the internal state of this controller instance */
424         int op_state;
425 };
426
427 /*
428  * The following are the structures to provide for a generic
429  * or abstract 'edac_device'. This set of structures and the
430  * code that implements the APIs for the same, provide for
431  * registering EDAC type devices which are NOT standard memory.
432  *
433  * CPU caches (L1 and L2)
434  * DMA engines
435  * Core CPU swithces
436  * Fabric switch units
437  * PCIe interface controllers
438  * other EDAC/ECC type devices that can be monitored for
439  * errors, etc.
440  *
441  * It allows for a 2 level set of hiearchry. For example:
442  *
443  * cache could be composed of L1, L2 and L3 levels of cache.
444  * Each CPU core would have its own L1 cache, while sharing
445  * L2 and maybe L3 caches.
446  *
447  * View them arranged, via the sysfs presentation:
448  * /sys/devices/system/edac/..
449  *
450  *      mc/             <existing memory device directory>
451  *      cpu/cpu0/..     <L1 and L2 block directory>
452  *              /L1-cache/ce_count
453  *                       /ue_count
454  *              /L2-cache/ce_count
455  *                       /ue_count
456  *      cpu/cpu1/..     <L1 and L2 block directory>
457  *              /L1-cache/ce_count
458  *                       /ue_count
459  *              /L2-cache/ce_count
460  *                       /ue_count
461  *      ...
462  *
463  *      the L1 and L2 directories would be "edac_device_block's"
464  */
465
466 struct edac_device_counter {
467         u32 ue_count;
468         u32 ce_count;
469 };
470
471 /*
472  * An array of these is passed to the alloc() function
473  * to specify attributes of the edac_block
474  */
475 struct edac_attrib_spec {
476         char name[EDAC_DEVICE_NAME_LEN + 1];
477
478         int type;
479 #define EDAC_ATTR_INT           0x01
480 #define EDAC_ATTR_CHAR          0x02
481 };
482
483 /* Attribute control structure
484  * In this structure is a pointer to the driver's edac_attrib_spec
485  * The life of this pointer is inclusive in the life of the driver's
486  * life cycle.
487  */
488 struct edac_attrib {
489         struct edac_device_block *block;        /* Up Pointer */
490
491         struct edac_attrib_spec *spec;  /* ptr to module spec entry */
492
493         union {                 /* actual value */
494                 int edac_attrib_int_value;
495                 char edac_attrib_char_value[EDAC_ATTRIB_VALUE_LEN + 1];
496         } edac_attrib_value;
497 };
498
499 /* device block control structure */
500 struct edac_device_block {
501         struct edac_device_instance *instance;  /* Up Pointer */
502         char name[EDAC_DEVICE_NAME_LEN + 1];
503
504         struct edac_device_counter counters;    /* basic UE and CE counters */
505
506         int nr_attribs;         /* how many attributes */
507         struct edac_attrib *attribs;    /* this block's attributes */
508
509         /* edac sysfs device control */
510         struct kobject kobj;
511         struct completion kobj_complete;
512 };
513
514 /* device instance control structure */
515 struct edac_device_instance {
516         struct edac_device_ctl_info *ctl;       /* Up pointer */
517         char name[EDAC_DEVICE_NAME_LEN + 4];
518
519         struct edac_device_counter counters;    /* instance counters */
520
521         u32 nr_blocks;          /* how many blocks */
522         struct edac_device_block *blocks;       /* block array */
523
524         /* edac sysfs device control */
525         struct kobject kobj;
526         struct completion kobj_complete;
527 };
528
529 /* edac_dev_sysfs_attribute structure
530  *     used for driver sysfs attributes and in mem_ctl_info
531  *     sysfs top level entries
532  */
533 struct edac_dev_sysfs_attribute {
534         struct attribute attr;
535         ssize_t (*show)(struct edac_device_ctl_info *,char *);
536         ssize_t (*store)(struct edac_device_ctl_info *, const char *,size_t);
537 };
538
539 /*
540  * Abstract edac_device control info structure
541  *
542  */
543 struct edac_device_ctl_info {
544         /* for global list of edac_device_ctl_info structs */
545         struct list_head link;
546
547         int dev_idx;
548
549         /* Per instance controls for this edac_device */
550         int log_ue;             /* boolean for logging UEs */
551         int log_ce;             /* boolean for logging CEs */
552         int panic_on_ue;        /* boolean for panic'ing on an UE */
553         unsigned poll_msec;     /* number of milliseconds to poll interval */
554         unsigned long delay;    /* number of jiffies for poll_msec */
555
556         /* Additional top controller level attributes, but specified
557          * by the low level driver.
558          *
559          * Set by the low level driver to provide attributes at the
560          * controller level, same level as 'ue_count' and 'ce_count' above.
561          * An array of structures, NULL terminated
562          *
563          * If attributes are desired, then set to array of attributes
564          * If no attributes are desired, leave NULL
565          */
566         struct edac_dev_sysfs_attribute *sysfs_attributes;
567
568         /* pointer to main 'edac' class in sysfs */
569         struct sysdev_class *edac_class;
570
571         /* the internal state of this controller instance */
572         int op_state;
573         /* work struct for this instance */
574         struct delayed_work work;
575
576         /* pointer to edac polling checking routine:
577          *      If NOT NULL: points to polling check routine
578          *      If NULL: Then assumes INTERRUPT operation, where
579          *              MC driver will receive events
580          */
581         void (*edac_check) (struct edac_device_ctl_info * edac_dev);
582
583         struct device *dev;     /* pointer to device structure */
584
585         const char *mod_name;   /* module name */
586         const char *ctl_name;   /* edac controller  name */
587         const char *dev_name;   /* pci/platform/etc... name */
588
589         void *pvt_info;         /* pointer to 'private driver' info */
590
591         unsigned long start_time;       /* edac_device load start time (jiffies) */
592
593         /* these are for safe removal of mc devices from global list while
594          * NMI handlers may be traversing list
595          */
596         struct rcu_head rcu;
597         struct completion complete;
598
599         /* sysfs top name under 'edac' directory
600          * and instance name:
601          *      cpu/cpu0/...
602          *      cpu/cpu1/...
603          *      cpu/cpu2/...
604          *      ...
605          */
606         char name[EDAC_DEVICE_NAME_LEN + 1];
607
608         /* Number of instances supported on this control structure
609          * and the array of those instances
610          */
611         u32 nr_instances;
612         struct edac_device_instance *instances;
613
614         /* Event counters for the this whole EDAC Device */
615         struct edac_device_counter counters;
616
617         /* edac sysfs device control for the 'name'
618          * device this structure controls
619          */
620         struct kobject kobj;
621         struct completion kobj_complete;
622 };
623
624 /* To get from the instance's wq to the beginning of the ctl structure */
625 #define to_edac_mem_ctl_work(w) \
626                 container_of(w, struct mem_ctl_info, work)
627
628 #define to_edac_device_ctl_work(w) \
629                 container_of(w,struct edac_device_ctl_info,work)
630
631 /*
632  * The alloc() and free() functions for the 'edac_device' control info
633  * structure. A MC driver will allocate one of these for each edac_device
634  * it is going to control/register with the EDAC CORE.
635  */
636 extern struct edac_device_ctl_info *edac_device_alloc_ctl_info(
637                 unsigned sizeof_private,
638                 char *edac_device_name,
639                 unsigned nr_instances,
640                 char *edac_block_name,
641                 unsigned nr_blocks,
642                 unsigned offset_value,
643                 struct edac_attrib_spec *attrib_spec,
644                 unsigned nr_attribs);
645
646 /* The offset value can be:
647  *      -1 indicating no offset value
648  *      0 for zero-based block numbers
649  *      1 for 1-based block number
650  *      other for other-based block number
651  */
652 #define BLOCK_OFFSET_VALUE_OFF  ((unsigned) -1)
653
654 extern void edac_device_free_ctl_info(struct edac_device_ctl_info *ctl_info);
655
656 #ifdef CONFIG_PCI
657
658 struct edac_pci_counter {
659         atomic_t pe_count;
660         atomic_t npe_count;
661 };
662
663 /*
664  * Abstract edac_pci control info structure
665  *
666  */
667 struct edac_pci_ctl_info {
668         /* for global list of edac_pci_ctl_info structs */
669         struct list_head link;
670
671         int pci_idx;
672
673         struct sysdev_class *edac_class;        /* pointer to class */
674
675         /* the internal state of this controller instance */
676         int op_state;
677         /* work struct for this instance */
678         struct delayed_work work;
679
680         /* pointer to edac polling checking routine:
681          *      If NOT NULL: points to polling check routine
682          *      If NULL: Then assumes INTERRUPT operation, where
683          *              MC driver will receive events
684          */
685         void (*edac_check) (struct edac_pci_ctl_info * edac_dev);
686
687         struct device *dev;     /* pointer to device structure */
688
689         const char *mod_name;   /* module name */
690         const char *ctl_name;   /* edac controller  name */
691         const char *dev_name;   /* pci/platform/etc... name */
692
693         void *pvt_info;         /* pointer to 'private driver' info */
694
695         unsigned long start_time;       /* edac_pci load start time (jiffies) */
696
697         /* these are for safe removal of devices from global list while
698          * NMI handlers may be traversing list
699          */
700         struct rcu_head rcu;
701         struct completion complete;
702
703         /* sysfs top name under 'edac' directory
704          * and instance name:
705          *      cpu/cpu0/...
706          *      cpu/cpu1/...
707          *      cpu/cpu2/...
708          *      ...
709          */
710         char name[EDAC_DEVICE_NAME_LEN + 1];
711
712         /* Event counters for the this whole EDAC Device */
713         struct edac_pci_counter counters;
714
715         /* edac sysfs device control for the 'name'
716          * device this structure controls
717          */
718         struct kobject kobj;
719         struct completion kobj_complete;
720 };
721
722 #define to_edac_pci_ctl_work(w) \
723                 container_of(w, struct edac_pci_ctl_info,work)
724
725 /* write all or some bits in a byte-register*/
726 static inline void pci_write_bits8(struct pci_dev *pdev, int offset, u8 value,
727                                    u8 mask)
728 {
729         if (mask != 0xff) {
730                 u8 buf;
731
732                 pci_read_config_byte(pdev, offset, &buf);
733                 value &= mask;
734                 buf &= ~mask;
735                 value |= buf;
736         }
737
738         pci_write_config_byte(pdev, offset, value);
739 }
740
741 /* write all or some bits in a word-register*/
742 static inline void pci_write_bits16(struct pci_dev *pdev, int offset,
743                                     u16 value, u16 mask)
744 {
745         if (mask != 0xffff) {
746                 u16 buf;
747
748                 pci_read_config_word(pdev, offset, &buf);
749                 value &= mask;
750                 buf &= ~mask;
751                 value |= buf;
752         }
753
754         pci_write_config_word(pdev, offset, value);
755 }
756
757 /* write all or some bits in a dword-register*/
758 static inline void pci_write_bits32(struct pci_dev *pdev, int offset,
759                                     u32 value, u32 mask)
760 {
761         if (mask != 0xffff) {
762                 u32 buf;
763
764                 pci_read_config_dword(pdev, offset, &buf);
765                 value &= mask;
766                 buf &= ~mask;
767                 value |= buf;
768         }
769
770         pci_write_config_dword(pdev, offset, value);
771 }
772
773 #endif                          /* CONFIG_PCI */
774
775 extern struct mem_ctl_info *edac_mc_find(int idx);
776 extern int edac_mc_add_mc(struct mem_ctl_info *mci, int mc_idx);
777 extern struct mem_ctl_info *edac_mc_del_mc(struct device *dev);
778 extern int edac_mc_find_csrow_by_page(struct mem_ctl_info *mci,
779                                       unsigned long page);
780
781 /*
782  * The no info errors are used when error overflows are reported.
783  * There are a limited number of error logging registers that can
784  * be exausted.  When all registers are exhausted and an additional
785  * error occurs then an error overflow register records that an
786  * error occured and the type of error, but doesn't have any
787  * further information.  The ce/ue versions make for cleaner
788  * reporting logic and function interface - reduces conditional
789  * statement clutter and extra function arguments.
790  */
791 extern void edac_mc_handle_ce(struct mem_ctl_info *mci,
792                               unsigned long page_frame_number,
793                               unsigned long offset_in_page,
794                               unsigned long syndrome, int row, int channel,
795                               const char *msg);
796 extern void edac_mc_handle_ce_no_info(struct mem_ctl_info *mci,
797                                       const char *msg);
798 extern void edac_mc_handle_ue(struct mem_ctl_info *mci,
799                               unsigned long page_frame_number,
800                               unsigned long offset_in_page, int row,
801                               const char *msg);
802 extern void edac_mc_handle_ue_no_info(struct mem_ctl_info *mci,
803                                       const char *msg);
804 extern void edac_mc_handle_fbd_ue(struct mem_ctl_info *mci, unsigned int csrow,
805                                   unsigned int channel0, unsigned int channel1,
806                                   char *msg);
807 extern void edac_mc_handle_fbd_ce(struct mem_ctl_info *mci, unsigned int csrow,
808                                   unsigned int channel, char *msg);
809
810 /*
811  * edac_device APIs
812  */
813 extern struct mem_ctl_info *edac_mc_alloc(unsigned sz_pvt, unsigned nr_csrows,
814                                           unsigned nr_chans);
815 extern void edac_mc_free(struct mem_ctl_info *mci);
816 extern int edac_device_add_device(struct edac_device_ctl_info *edac_dev,
817                                   int edac_idx);
818 extern struct edac_device_ctl_info *edac_device_del_device(struct device *dev);
819 extern void edac_device_handle_ue(struct edac_device_ctl_info *edac_dev,
820                                   int inst_nr, int block_nr, const char *msg);
821 extern void edac_device_handle_ce(struct edac_device_ctl_info *edac_dev,
822                                   int inst_nr, int block_nr, const char *msg);
823
824 /*
825  * edac_pci APIs
826  */
827 extern struct edac_pci_ctl_info *edac_pci_alloc_ctl_info(unsigned int sz_pvt, const char
828                                                          *edac_pci_name);
829
830 extern void edac_pci_free_ctl_info(struct edac_pci_ctl_info *pci);
831
832 extern void
833 edac_pci_reset_delay_period(struct edac_pci_ctl_info *pci, unsigned long value);
834
835 extern int edac_pci_add_device(struct edac_pci_ctl_info *pci, int edac_idx);
836 extern struct edac_pci_ctl_info *edac_pci_del_device(struct device *dev);
837
838 extern struct edac_pci_ctl_info *edac_pci_create_generic_ctl(struct device *dev, const char
839                                                              *mod_name);
840
841 extern void edac_pci_release_generic_ctl(struct edac_pci_ctl_info *pci);
842 extern int edac_pci_create_sysfs(struct edac_pci_ctl_info *pci);
843 extern void edac_pci_remove_sysfs(struct edac_pci_ctl_info *pci);
844
845 /*
846  * edac misc APIs
847  */
848 extern char *edac_op_state_toString(int op_state);
849
850 #endif                          /* _EDAC_CORE_H_ */