blob: 63691cf3a1d69d87b7b2474d108cc2aaa701cdd8 [file] [log] [blame]
Douglas Thompson7c9281d2007-07-19 01:49:33 -07001/*
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>
Douglas Thompsone27e3da2007-07-19 01:49:36 -070035#include <linux/sysdev.h>
36#include <linux/workqueue.h>
37#include <linux/version.h>
Douglas Thompson7c9281d2007-07-19 01:49:33 -070038
39#define EDAC_MC_LABEL_LEN 31
Douglas Thompsone27e3da2007-07-19 01:49:36 -070040#define EDAC_DEVICE_NAME_LEN 31
41#define EDAC_ATTRIB_VALUE_LEN 15
42#define MC_PROC_NAME_MAX_LEN 7
Douglas Thompson7c9281d2007-07-19 01:49:33 -070043
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
Douglas Thompsone27e3da2007-07-19 01:49:36 -070059/* edac_device printk */
60#define edac_device_printk(ctl, level, fmt, arg...) \
61 printk(level "EDAC DEVICE%d: " fmt, ctl->dev_idx, ##arg)
62
Dave Jiang91b99042007-07-19 01:49:52 -070063/* edac_pci printk */
64#define edac_pci_printk(ctl, level, fmt, arg...) \
65 printk(level "EDAC PCI%d: " fmt, ctl->pci_idx, ##arg)
66
Douglas Thompson7c9281d2007-07-19 01:49:33 -070067/* 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
73extern int edac_debug_level;
74
75#define edac_debug_printk(level, fmt, arg...) \
76 do { \
77 if (level <= edac_debug_level) \
Douglas Thompsone27e3da2007-07-19 01:49:36 -070078 edac_printk(KERN_EMERG, EDAC_DEBUG, fmt, ##arg); \
Douglas Thompson7c9281d2007-07-19 01:49:33 -070079 } 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
Douglas Thompson079708b2007-07-19 01:49:58 -070087#else /* !CONFIG_EDAC_DEBUG */
Douglas Thompson7c9281d2007-07-19 01:49:33 -070088
89#define debugf0( ... )
90#define debugf1( ... )
91#define debugf2( ... )
92#define debugf3( ... )
93#define debugf4( ... )
94
Douglas Thompson079708b2007-07-19 01:49:58 -070095#endif /* !CONFIG_EDAC_DEBUG */
Douglas Thompson7c9281d2007-07-19 01:49:33 -070096
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
Dave Jiangc4192702007-07-19 01:49:47 -0700102#define dev_name(dev) (dev)->dev_name
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700103
104/* memory devices */
105enum 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 */
126enum 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 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700138 MEM_DDR2, /* DDR2 RAM */
139 MEM_FB_DDR2, /* fully buffered DDR2 */
140 MEM_RDDR2, /* Registered DDR2 RAM */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700141};
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 */
159enum 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 */
183enum 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)
Douglas Thompson522a94b2007-07-19 01:49:41 -0700197#define SCRUB_FLAG_SW_SRC BIT(SCRUB_SW_SRC)
198#define SCRUB_FLAG_SW_PROG_SRC BIT(SCRUB_SW_PROG_SRC)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700199#define SCRUB_FLAG_SW_TUN BIT(SCRUB_SW_SCRUB_TUNABLE)
200#define SCRUB_FLAG_HW_PROG BIT(SCRUB_HW_PROG)
Douglas Thompson522a94b2007-07-19 01:49:41 -0700201#define SCRUB_FLAG_HW_SRC BIT(SCRUB_HW_SRC)
202#define SCRUB_FLAG_HW_PROG_SRC BIT(SCRUB_HW_PROG_SRC)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700203#define SCRUB_FLAG_HW_TUN BIT(SCRUB_HW_TUNABLE)
204
205/* FIXME - should have notify capabilities: NMI, LOG, PROC, etc */
206
Dave Jiang91b99042007-07-19 01:49:52 -0700207/* 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
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700214/*
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
296struct channel_info {
297 int chan_idx; /* channel index */
298 u32 ce_count; /* Correctable Errors for this CHANNEL */
Douglas Thompson079708b2007-07-19 01:49:58 -0700299 char label[EDAC_MC_LABEL_LEN + 1]; /* DIMM label on motherboard */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700300 struct csrow_info *csrow; /* the parent */
301};
302
303struct 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
Douglas Thompson42a8e392007-07-19 01:50:10 -0700327/* mcidev_sysfs_attribute structure
328 * used for driver sysfs attributes and in mem_ctl_info
329 * sysfs top level entries
330 */
331struct 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 */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700339struct mem_ctl_info {
Douglas Thompson079708b2007-07-19 01:49:58 -0700340 struct list_head link; /* for global list of mem_ctl_info structs */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700341 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.
Douglas Thompson079708b2007-07-19 01:49:58 -0700357 */
358 int (*set_sdram_scrub_rate) (struct mem_ctl_info * mci, u32 * bw);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700359
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.
Douglas Thompson079708b2007-07-19 01:49:58 -0700363 */
364 int (*get_sdram_scrub_rate) (struct mem_ctl_info * mci, u32 * bw);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700365
Douglas Thompson42a8e392007-07-19 01:50:10 -0700366
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700367 /* 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,
Douglas Thompson079708b2007-07-19 01:49:58 -0700376 unsigned long page);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700377 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;
Dave Jiangc4192702007-07-19 01:49:47 -0700389 const char *dev_name;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700390 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;
Dave Jiang81d87cb2007-07-19 01:49:52 -0700407
Douglas Thompson42a8e392007-07-19 01:50:10 -0700408 /* 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
Dave Jiang81d87cb2007-07-19 01:49:52 -0700420 /* work struct for this MC */
Dave Jiang81d87cb2007-07-19 01:49:52 -0700421 struct delayed_work work;
Douglas Thompson86aa8cb2007-07-19 01:50:01 -0700422
Dave Jiang81d87cb2007-07-19 01:49:52 -0700423 /* the internal state of this controller instance */
424 int op_state;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700425};
426
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700427/*
Douglas Thompson42a8e392007-07-19 01:50:10 -0700428 * The following are the structures to provide for a generic
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700429 * 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
466struct edac_device_counter {
Douglas Thompson079708b2007-07-19 01:49:58 -0700467 u32 ue_count;
468 u32 ce_count;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700469};
470
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700471/* forward reference */
472struct edac_device_ctl_info;
473struct edac_device_block;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700474
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700475/* edac_dev_sysfs_attribute structure
476 * used for driver sysfs attributes in mem_ctl_info
477 * for extra controls and attributes:
478 * like high level error Injection controls
479 */
480struct edac_dev_sysfs_attribute {
481 struct attribute attr;
482 ssize_t (*show)(struct edac_device_ctl_info *, char *);
483 ssize_t (*store)(struct edac_device_ctl_info *, const char *, size_t);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700484};
485
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700486/* edac_dev_sysfs_block_attribute structure
487 * used in leaf 'block' nodes for adding controls/attributes
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700488 */
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700489struct edac_dev_sysfs_block_attribute {
490 struct attribute attr;
491 ssize_t (*show)(struct kobject *, struct attribute *, char *);
492 ssize_t (*store)(struct kobject *, struct attribute *,
493 const char *, size_t);
494 struct edac_device_block *block;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700495
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700496 /* low driver use */
497 void *arg;
498 unsigned int value;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700499};
500
501/* device block control structure */
502struct edac_device_block {
503 struct edac_device_instance *instance; /* Up Pointer */
Douglas Thompson079708b2007-07-19 01:49:58 -0700504 char name[EDAC_DEVICE_NAME_LEN + 1];
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700505
506 struct edac_device_counter counters; /* basic UE and CE counters */
507
Douglas Thompson079708b2007-07-19 01:49:58 -0700508 int nr_attribs; /* how many attributes */
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700509
510 /* this block's attributes, could be NULL */
511 struct edac_dev_sysfs_block_attribute *block_attributes;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700512
513 /* edac sysfs device control */
514 struct kobject kobj;
515 struct completion kobj_complete;
516};
517
518/* device instance control structure */
519struct edac_device_instance {
520 struct edac_device_ctl_info *ctl; /* Up pointer */
521 char name[EDAC_DEVICE_NAME_LEN + 4];
522
523 struct edac_device_counter counters; /* instance counters */
524
Douglas Thompson079708b2007-07-19 01:49:58 -0700525 u32 nr_blocks; /* how many blocks */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700526 struct edac_device_block *blocks; /* block array */
527
528 /* edac sysfs device control */
529 struct kobject kobj;
530 struct completion kobj_complete;
531};
532
Douglas Thompson42a8e392007-07-19 01:50:10 -0700533
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700534/*
535 * Abstract edac_device control info structure
536 *
537 */
538struct edac_device_ctl_info {
539 /* for global list of edac_device_ctl_info structs */
540 struct list_head link;
541
542 int dev_idx;
543
544 /* Per instance controls for this edac_device */
545 int log_ue; /* boolean for logging UEs */
546 int log_ce; /* boolean for logging CEs */
547 int panic_on_ue; /* boolean for panic'ing on an UE */
548 unsigned poll_msec; /* number of milliseconds to poll interval */
549 unsigned long delay; /* number of jiffies for poll_msec */
550
Douglas Thompson42a8e392007-07-19 01:50:10 -0700551 /* Additional top controller level attributes, but specified
552 * by the low level driver.
553 *
554 * Set by the low level driver to provide attributes at the
555 * controller level, same level as 'ue_count' and 'ce_count' above.
556 * An array of structures, NULL terminated
557 *
558 * If attributes are desired, then set to array of attributes
559 * If no attributes are desired, leave NULL
560 */
561 struct edac_dev_sysfs_attribute *sysfs_attributes;
562
563 /* pointer to main 'edac' class in sysfs */
564 struct sysdev_class *edac_class;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700565
566 /* the internal state of this controller instance */
567 int op_state;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700568 /* work struct for this instance */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700569 struct delayed_work work;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700570
571 /* pointer to edac polling checking routine:
Douglas Thompson079708b2007-07-19 01:49:58 -0700572 * If NOT NULL: points to polling check routine
573 * If NULL: Then assumes INTERRUPT operation, where
574 * MC driver will receive events
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700575 */
576 void (*edac_check) (struct edac_device_ctl_info * edac_dev);
577
578 struct device *dev; /* pointer to device structure */
579
580 const char *mod_name; /* module name */
581 const char *ctl_name; /* edac controller name */
Dave Jiangc4192702007-07-19 01:49:47 -0700582 const char *dev_name; /* pci/platform/etc... name */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700583
584 void *pvt_info; /* pointer to 'private driver' info */
585
Douglas Thompson079708b2007-07-19 01:49:58 -0700586 unsigned long start_time; /* edac_device load start time (jiffies) */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700587
588 /* these are for safe removal of mc devices from global list while
589 * NMI handlers may be traversing list
590 */
591 struct rcu_head rcu;
592 struct completion complete;
593
594 /* sysfs top name under 'edac' directory
595 * and instance name:
Douglas Thompson079708b2007-07-19 01:49:58 -0700596 * cpu/cpu0/...
597 * cpu/cpu1/...
598 * cpu/cpu2/...
599 * ...
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700600 */
601 char name[EDAC_DEVICE_NAME_LEN + 1];
602
603 /* Number of instances supported on this control structure
604 * and the array of those instances
605 */
606 u32 nr_instances;
607 struct edac_device_instance *instances;
608
609 /* Event counters for the this whole EDAC Device */
610 struct edac_device_counter counters;
611
612 /* edac sysfs device control for the 'name'
613 * device this structure controls
614 */
615 struct kobject kobj;
616 struct completion kobj_complete;
617};
618
619/* To get from the instance's wq to the beginning of the ctl structure */
Dave Jiang81d87cb2007-07-19 01:49:52 -0700620#define to_edac_mem_ctl_work(w) \
621 container_of(w, struct mem_ctl_info, work)
622
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700623#define to_edac_device_ctl_work(w) \
624 container_of(w,struct edac_device_ctl_info,work)
625
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700626/*
627 * The alloc() and free() functions for the 'edac_device' control info
628 * structure. A MC driver will allocate one of these for each edac_device
629 * it is going to control/register with the EDAC CORE.
630 */
631extern struct edac_device_ctl_info *edac_device_alloc_ctl_info(
Douglas Thompson079708b2007-07-19 01:49:58 -0700632 unsigned sizeof_private,
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700633 char *edac_device_name, unsigned nr_instances,
634 char *edac_block_name, unsigned nr_blocks,
Douglas Thompson079708b2007-07-19 01:49:58 -0700635 unsigned offset_value,
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700636 struct edac_dev_sysfs_block_attribute *block_attributes,
Douglas Thompson079708b2007-07-19 01:49:58 -0700637 unsigned nr_attribs);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700638
639/* The offset value can be:
640 * -1 indicating no offset value
641 * 0 for zero-based block numbers
642 * 1 for 1-based block number
643 * other for other-based block number
644 */
645#define BLOCK_OFFSET_VALUE_OFF ((unsigned) -1)
646
Douglas Thompson079708b2007-07-19 01:49:58 -0700647extern void edac_device_free_ctl_info(struct edac_device_ctl_info *ctl_info);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700648
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700649#ifdef CONFIG_PCI
650
Dave Jiang91b99042007-07-19 01:49:52 -0700651struct edac_pci_counter {
Douglas Thompson079708b2007-07-19 01:49:58 -0700652 atomic_t pe_count;
653 atomic_t npe_count;
Dave Jiang91b99042007-07-19 01:49:52 -0700654};
655
656/*
657 * Abstract edac_pci control info structure
658 *
659 */
660struct edac_pci_ctl_info {
661 /* for global list of edac_pci_ctl_info structs */
662 struct list_head link;
663
664 int pci_idx;
665
Dave Jiang91b99042007-07-19 01:49:52 -0700666 struct sysdev_class *edac_class; /* pointer to class */
667
668 /* the internal state of this controller instance */
669 int op_state;
670 /* work struct for this instance */
Dave Jiang91b99042007-07-19 01:49:52 -0700671 struct delayed_work work;
Dave Jiang91b99042007-07-19 01:49:52 -0700672
673 /* pointer to edac polling checking routine:
Douglas Thompson079708b2007-07-19 01:49:58 -0700674 * If NOT NULL: points to polling check routine
675 * If NULL: Then assumes INTERRUPT operation, where
676 * MC driver will receive events
Dave Jiang91b99042007-07-19 01:49:52 -0700677 */
678 void (*edac_check) (struct edac_pci_ctl_info * edac_dev);
679
680 struct device *dev; /* pointer to device structure */
681
682 const char *mod_name; /* module name */
683 const char *ctl_name; /* edac controller name */
684 const char *dev_name; /* pci/platform/etc... name */
685
686 void *pvt_info; /* pointer to 'private driver' info */
687
Douglas Thompson079708b2007-07-19 01:49:58 -0700688 unsigned long start_time; /* edac_pci load start time (jiffies) */
Dave Jiang91b99042007-07-19 01:49:52 -0700689
690 /* these are for safe removal of devices from global list while
691 * NMI handlers may be traversing list
692 */
693 struct rcu_head rcu;
694 struct completion complete;
695
696 /* sysfs top name under 'edac' directory
697 * and instance name:
Douglas Thompson079708b2007-07-19 01:49:58 -0700698 * cpu/cpu0/...
699 * cpu/cpu1/...
700 * cpu/cpu2/...
701 * ...
Dave Jiang91b99042007-07-19 01:49:52 -0700702 */
703 char name[EDAC_DEVICE_NAME_LEN + 1];
704
705 /* Event counters for the this whole EDAC Device */
706 struct edac_pci_counter counters;
707
708 /* edac sysfs device control for the 'name'
709 * device this structure controls
710 */
711 struct kobject kobj;
712 struct completion kobj_complete;
713};
714
715#define to_edac_pci_ctl_work(w) \
716 container_of(w, struct edac_pci_ctl_info,work)
717
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700718/* write all or some bits in a byte-register*/
719static inline void pci_write_bits8(struct pci_dev *pdev, int offset, u8 value,
Douglas Thompson079708b2007-07-19 01:49:58 -0700720 u8 mask)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700721{
722 if (mask != 0xff) {
723 u8 buf;
724
725 pci_read_config_byte(pdev, offset, &buf);
726 value &= mask;
727 buf &= ~mask;
728 value |= buf;
729 }
730
731 pci_write_config_byte(pdev, offset, value);
732}
733
734/* write all or some bits in a word-register*/
735static inline void pci_write_bits16(struct pci_dev *pdev, int offset,
Douglas Thompson079708b2007-07-19 01:49:58 -0700736 u16 value, u16 mask)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700737{
738 if (mask != 0xffff) {
739 u16 buf;
740
741 pci_read_config_word(pdev, offset, &buf);
742 value &= mask;
743 buf &= ~mask;
744 value |= buf;
745 }
746
747 pci_write_config_word(pdev, offset, value);
748}
749
750/* write all or some bits in a dword-register*/
751static inline void pci_write_bits32(struct pci_dev *pdev, int offset,
Douglas Thompson079708b2007-07-19 01:49:58 -0700752 u32 value, u32 mask)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700753{
754 if (mask != 0xffff) {
755 u32 buf;
756
757 pci_read_config_dword(pdev, offset, &buf);
758 value &= mask;
759 buf &= ~mask;
760 value |= buf;
761 }
762
763 pci_write_config_dword(pdev, offset, value);
764}
765
Douglas Thompson079708b2007-07-19 01:49:58 -0700766#endif /* CONFIG_PCI */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700767
Doug Thompsonb8f6f972007-07-19 01:50:26 -0700768extern struct mem_ctl_info *edac_mc_alloc(unsigned sz_pvt, unsigned nr_csrows,
769 unsigned nr_chans, int edac_index);
770extern int edac_mc_add_mc(struct mem_ctl_info *mci);
771extern void edac_mc_free(struct mem_ctl_info *mci);
Douglas Thompson079708b2007-07-19 01:49:58 -0700772extern struct mem_ctl_info *edac_mc_find(int idx);
Douglas Thompson079708b2007-07-19 01:49:58 -0700773extern struct mem_ctl_info *edac_mc_del_mc(struct device *dev);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700774extern int edac_mc_find_csrow_by_page(struct mem_ctl_info *mci,
Douglas Thompson079708b2007-07-19 01:49:58 -0700775 unsigned long page);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700776
777/*
778 * The no info errors are used when error overflows are reported.
779 * There are a limited number of error logging registers that can
780 * be exausted. When all registers are exhausted and an additional
781 * error occurs then an error overflow register records that an
782 * error occured and the type of error, but doesn't have any
783 * further information. The ce/ue versions make for cleaner
784 * reporting logic and function interface - reduces conditional
785 * statement clutter and extra function arguments.
786 */
787extern void edac_mc_handle_ce(struct mem_ctl_info *mci,
Douglas Thompson079708b2007-07-19 01:49:58 -0700788 unsigned long page_frame_number,
789 unsigned long offset_in_page,
790 unsigned long syndrome, int row, int channel,
791 const char *msg);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700792extern void edac_mc_handle_ce_no_info(struct mem_ctl_info *mci,
Douglas Thompson079708b2007-07-19 01:49:58 -0700793 const char *msg);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700794extern void edac_mc_handle_ue(struct mem_ctl_info *mci,
Douglas Thompson079708b2007-07-19 01:49:58 -0700795 unsigned long page_frame_number,
796 unsigned long offset_in_page, int row,
797 const char *msg);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700798extern void edac_mc_handle_ue_no_info(struct mem_ctl_info *mci,
Douglas Thompson079708b2007-07-19 01:49:58 -0700799 const char *msg);
800extern void edac_mc_handle_fbd_ue(struct mem_ctl_info *mci, unsigned int csrow,
801 unsigned int channel0, unsigned int channel1,
802 char *msg);
803extern void edac_mc_handle_fbd_ce(struct mem_ctl_info *mci, unsigned int csrow,
804 unsigned int channel, char *msg);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700805
806/*
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700807 * edac_device APIs
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700808 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700809extern int edac_device_add_device(struct edac_device_ctl_info *edac_dev,
Doug Thompsonb8f6f972007-07-19 01:50:26 -0700810 int dev_idx);
Douglas Thompson079708b2007-07-19 01:49:58 -0700811extern struct edac_device_ctl_info *edac_device_del_device(struct device *dev);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700812extern void edac_device_handle_ue(struct edac_device_ctl_info *edac_dev,
Doug Thompsonb8f6f972007-07-19 01:50:26 -0700813 int inst_nr, int block_nr, const char *msg);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700814extern void edac_device_handle_ce(struct edac_device_ctl_info *edac_dev,
Doug Thompsonb8f6f972007-07-19 01:50:26 -0700815 int inst_nr, int block_nr, const char *msg);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700816
Dave Jiang91b99042007-07-19 01:49:52 -0700817/*
818 * edac_pci APIs
819 */
Doug Thompsonb8f6f972007-07-19 01:50:26 -0700820extern struct edac_pci_ctl_info *edac_pci_alloc_ctl_info(unsigned int sz_pvt,
821 const char *edac_pci_name);
Dave Jiang91b99042007-07-19 01:49:52 -0700822
823extern void edac_pci_free_ctl_info(struct edac_pci_ctl_info *pci);
824
Doug Thompsonb8f6f972007-07-19 01:50:26 -0700825extern void edac_pci_reset_delay_period(struct edac_pci_ctl_info *pci,
826 unsigned long value);
Dave Jiang91b99042007-07-19 01:49:52 -0700827
828extern int edac_pci_add_device(struct edac_pci_ctl_info *pci, int edac_idx);
Douglas Thompson079708b2007-07-19 01:49:58 -0700829extern struct edac_pci_ctl_info *edac_pci_del_device(struct device *dev);
Dave Jiang91b99042007-07-19 01:49:52 -0700830
Doug Thompsonb8f6f972007-07-19 01:50:26 -0700831extern struct edac_pci_ctl_info *edac_pci_create_generic_ctl(
832 struct device *dev,
833 const char *mod_name);
Dave Jiang91b99042007-07-19 01:49:52 -0700834
835extern void edac_pci_release_generic_ctl(struct edac_pci_ctl_info *pci);
836extern int edac_pci_create_sysfs(struct edac_pci_ctl_info *pci);
837extern void edac_pci_remove_sysfs(struct edac_pci_ctl_info *pci);
838
839/*
840 * edac misc APIs
841 */
Douglas Thompson494d0d52007-07-19 01:50:21 -0700842extern char *edac_op_state_to_string(int op_state);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700843
844#endif /* _EDAC_CORE_H_ */