edac_core.h 22 KB

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