[linux.git] / drivers / edac / edac_core.h

/*
 * Defines, structures, APIs for edac_core module
 *
 * (C) 2007 Linux Networx (http://lnxi.com)
 * This file may be distributed under the terms of the
 * GNU General Public License.
 *
 * Written by Thayne Harbaugh
 * Based on work by Dan Hollis <goemon at anime dot net> and others.
 *	http://www.anime.net/~goemon/linux-ecc/
 *
 * NMI handling support added by
 *     Dave Peterson <[email protected]> <[email protected]>
 *
 * Refactored for multi-source files:
 *	Doug Thompson <[email protected]>
 *
 */

#ifndef _EDAC_CORE_H_
#define _EDAC_CORE_H_

#include <linux/kernel.h>
#include <linux/types.h>
#include <linux/module.h>
#include <linux/spinlock.h>
#include <linux/smp.h>
#include <linux/pci.h>
#include <linux/time.h>
#include <linux/nmi.h>
#include <linux/rcupdate.h>
#include <linux/completion.h>
#include <linux/kobject.h>
#include <linux/platform_device.h>
#include <linux/workqueue.h>
#include <linux/edac.h>

#define EDAC_DEVICE_NAME_LEN	31
#define EDAC_ATTRIB_VALUE_LEN	15

#if PAGE_SHIFT < 20
#define PAGES_TO_MiB(pages)	((pages) >> (20 - PAGE_SHIFT))
#define MiB_TO_PAGES(mb)	((mb) << (20 - PAGE_SHIFT))
#else				/* PAGE_SHIFT > 20 */
#define PAGES_TO_MiB(pages)	((pages) << (PAGE_SHIFT - 20))
#define MiB_TO_PAGES(mb)	((mb) >> (PAGE_SHIFT - 20))
#endif

#define edac_printk(level, prefix, fmt, arg...) \
	printk(level "EDAC " prefix ": " fmt, ##arg)

#define edac_mc_printk(mci, level, fmt, arg...) \
	printk(level "EDAC MC%d: " fmt, mci->mc_idx, ##arg)

#define edac_mc_chipset_printk(mci, level, prefix, fmt, arg...) \
	printk(level "EDAC " prefix " MC%d: " fmt, mci->mc_idx, ##arg)

#define edac_device_printk(ctl, level, fmt, arg...) \
	printk(level "EDAC DEVICE%d: " fmt, ctl->dev_idx, ##arg)

#define edac_pci_printk(ctl, level, fmt, arg...) \
	printk(level "EDAC PCI%d: " fmt, ctl->pci_idx, ##arg)

/* prefixes for edac_printk() and edac_mc_printk() */
#define EDAC_MC "MC"
#define EDAC_PCI "PCI"
#define EDAC_DEBUG "DEBUG"

extern const char *edac_mem_types[];

#ifdef CONFIG_EDAC_DEBUG
extern int edac_debug_level;

#define edac_dbg(level, fmt, ...)					\
do {									\
	if (level <= edac_debug_level)					\
		edac_printk(KERN_DEBUG, EDAC_DEBUG,			\
			    "%s: " fmt, __func__, ##__VA_ARGS__);	\
} while (0)

#else				/* !CONFIG_EDAC_DEBUG */

#define edac_dbg(level, fmt, ...)					\
do {									\
	if (0)								\
		edac_printk(KERN_DEBUG, EDAC_DEBUG,			\
			    "%s: " fmt, __func__, ##__VA_ARGS__);	\
} while (0)

#endif				/* !CONFIG_EDAC_DEBUG */

#define PCI_VEND_DEV(vend, dev) PCI_VENDOR_ID_ ## vend, \
	PCI_DEVICE_ID_ ## vend ## _ ## dev

#define edac_dev_name(dev) (dev)->dev_name

/*
 * The following are the structures to provide for a generic
 * or abstract 'edac_device'. This set of structures and the
 * code that implements the APIs for the same, provide for
 * registering EDAC type devices which are NOT standard memory.
 *
 * CPU caches (L1 and L2)
 * DMA engines
 * Core CPU swithces
 * Fabric switch units
 * PCIe interface controllers
 * other EDAC/ECC type devices that can be monitored for
 * errors, etc.
 *
 * It allows for a 2 level set of hiearchry. For example:
 *
 * cache could be composed of L1, L2 and L3 levels of cache.
 * Each CPU core would have its own L1 cache, while sharing
 * L2 and maybe L3 caches.
 *
 * View them arranged, via the sysfs presentation:
 * /sys/devices/system/edac/..
 *
 *	mc/		<existing memory device directory>
 *	cpu/cpu0/..	<L1 and L2 block directory>
 *		/L1-cache/ce_count
 *			 /ue_count
 *		/L2-cache/ce_count
 *			 /ue_count
 *	cpu/cpu1/..	<L1 and L2 block directory>
 *		/L1-cache/ce_count
 *			 /ue_count
 *		/L2-cache/ce_count
 *			 /ue_count
 *	...
 *
 *	the L1 and L2 directories would be "edac_device_block's"
 */

struct edac_device_counter {
	u32 ue_count;
	u32 ce_count;
};

/* forward reference */
struct edac_device_ctl_info;
struct edac_device_block;

/* edac_dev_sysfs_attribute structure
 *	used for driver sysfs attributes in mem_ctl_info
 *	for extra controls and attributes:
 *		like high level error Injection controls
 */
struct edac_dev_sysfs_attribute {
	struct attribute attr;
	ssize_t (*show)(struct edac_device_ctl_info *, char *);
	ssize_t (*store)(struct edac_device_ctl_info *, const char *, size_t);
};

/* edac_dev_sysfs_block_attribute structure
 *
 *	used in leaf 'block' nodes for adding controls/attributes
 *
 *	each block in each instance of the containing control structure
 *	can have an array of the following. The show and store functions
 *	will be filled in with the show/store function in the
 *	low level driver.
 *
 *	The 'value' field will be the actual value field used for
 *	counting
 */
struct edac_dev_sysfs_block_attribute {
	struct attribute attr;
	ssize_t (*show)(struct kobject *, struct attribute *, char *);
	ssize_t (*store)(struct kobject *, struct attribute *,
			const char *, size_t);
	struct edac_device_block *block;

	unsigned int value;
};

/* device block control structure */
struct edac_device_block {
	struct edac_device_instance *instance;	/* Up Pointer */
	char name[EDAC_DEVICE_NAME_LEN + 1];

	struct edac_device_counter counters;	/* basic UE and CE counters */

	int nr_attribs;		/* how many attributes */

	/* this block's attributes, could be NULL */
	struct edac_dev_sysfs_block_attribute *block_attributes;

	/* edac sysfs device control */
	struct kobject kobj;
};

/* device instance control structure */
struct edac_device_instance {
	struct edac_device_ctl_info *ctl;	/* Up pointer */
	char name[EDAC_DEVICE_NAME_LEN + 4];

	struct edac_device_counter counters;	/* instance counters */

	u32 nr_blocks;		/* how many blocks */
	struct edac_device_block *blocks;	/* block array */

	/* edac sysfs device control */
	struct kobject kobj;
};


/*
 * Abstract edac_device control info structure
 *
 */
struct edac_device_ctl_info {
	/* for global list of edac_device_ctl_info structs */
	struct list_head link;

	struct module *owner;	/* Module owner of this control struct */

	int dev_idx;

	/* Per instance controls for this edac_device */
	int log_ue;		/* boolean for logging UEs */
	int log_ce;		/* boolean for logging CEs */
	int panic_on_ue;	/* boolean for panic'ing on an UE */
	unsigned poll_msec;	/* number of milliseconds to poll interval */
	unsigned long delay;	/* number of jiffies for poll_msec */

	/* Additional top controller level attributes, but specified
	 * by the low level driver.
	 *
	 * Set by the low level driver to provide attributes at the
	 * controller level, same level as 'ue_count' and 'ce_count' above.
	 * An array of structures, NULL terminated
	 *
	 * If attributes are desired, then set to array of attributes
	 * If no attributes are desired, leave NULL
	 */
	struct edac_dev_sysfs_attribute *sysfs_attributes;

	/* pointer to main 'edac' subsys in sysfs */
	struct bus_type *edac_subsys;

	/* the internal state of this controller instance */
	int op_state;
	/* work struct for this instance */
	struct delayed_work work;

	/* pointer to edac polling checking routine:
	 *      If NOT NULL: points to polling check routine
	 *      If NULL: Then assumes INTERRUPT operation, where
	 *              MC driver will receive events
	 */
	void (*edac_check) (struct edac_device_ctl_info * edac_dev);

	struct device *dev;	/* pointer to device structure */

	const char *mod_name;	/* module name */
	const char *ctl_name;	/* edac controller  name */
	const char *dev_name;	/* pci/platform/etc... name */

	void *pvt_info;		/* pointer to 'private driver' info */

	unsigned long start_time;	/* edac_device load start time (jiffies) */

	struct completion removal_complete;

	/* sysfs top name under 'edac' directory
	 * and instance name:
	 *      cpu/cpu0/...
	 *      cpu/cpu1/...
	 *      cpu/cpu2/...
	 *      ...
	 */
	char name[EDAC_DEVICE_NAME_LEN + 1];

	/* Number of instances supported on this control structure
	 * and the array of those instances
	 */
	u32 nr_instances;
	struct edac_device_instance *instances;

	/* Event counters for the this whole EDAC Device */
	struct edac_device_counter counters;

	/* edac sysfs device control for the 'name'
	 * device this structure controls
	 */
	struct kobject kobj;
};

/* To get from the instance's wq to the beginning of the ctl structure */
#define to_edac_mem_ctl_work(w) \
		container_of(w, struct mem_ctl_info, work)

#define to_edac_device_ctl_work(w) \
		container_of(w,struct edac_device_ctl_info,work)

/*
 * The alloc() and free() functions for the 'edac_device' control info
 * structure. A MC driver will allocate one of these for each edac_device
 * it is going to control/register with the EDAC CORE.
 */
extern struct edac_device_ctl_info *edac_device_alloc_ctl_info(
		unsigned sizeof_private,
		char *edac_device_name, unsigned nr_instances,
		char *edac_block_name, unsigned nr_blocks,
		unsigned offset_value,
		struct edac_dev_sysfs_block_attribute *block_attributes,
		unsigned nr_attribs,
		int device_index);

/* The offset value can be:
 *	-1 indicating no offset value
 *	0 for zero-based block numbers
 *	1 for 1-based block number
 *	other for other-based block number
 */
#define	BLOCK_OFFSET_VALUE_OFF	((unsigned) -1)

extern void edac_device_free_ctl_info(struct edac_device_ctl_info *ctl_info);

#ifdef CONFIG_PCI

struct edac_pci_counter {
	atomic_t pe_count;
	atomic_t npe_count;
};

/*
 * Abstract edac_pci control info structure
 *
 */
struct edac_pci_ctl_info {
	/* for global list of edac_pci_ctl_info structs */
	struct list_head link;

	int pci_idx;

	struct bus_type *edac_subsys;	/* pointer to subsystem */

	/* the internal state of this controller instance */
	int op_state;
	/* work struct for this instance */
	struct delayed_work work;

	/* pointer to edac polling checking routine:
	 *      If NOT NULL: points to polling check routine
	 *      If NULL: Then assumes INTERRUPT operation, where
	 *              MC driver will receive events
	 */
	void (*edac_check) (struct edac_pci_ctl_info * edac_dev);

	struct device *dev;	/* pointer to device structure */

	const char *mod_name;	/* module name */
	const char *ctl_name;	/* edac controller  name */
	const char *dev_name;	/* pci/platform/etc... name */

	void *pvt_info;		/* pointer to 'private driver' info */

	unsigned long start_time;	/* edac_pci load start time (jiffies) */

	struct completion complete;

	/* sysfs top name under 'edac' directory
	 * and instance name:
	 *      cpu/cpu0/...
	 *      cpu/cpu1/...
	 *      cpu/cpu2/...
	 *      ...
	 */
	char name[EDAC_DEVICE_NAME_LEN + 1];

	/* Event counters for the this whole EDAC Device */
	struct edac_pci_counter counters;

	/* edac sysfs device control for the 'name'
	 * device this structure controls
	 */
	struct kobject kobj;
	struct completion kobj_complete;
};

#define to_edac_pci_ctl_work(w) \
		container_of(w, struct edac_pci_ctl_info,work)

/* write all or some bits in a byte-register*/
static inline void pci_write_bits8(struct pci_dev *pdev, int offset, u8 value,
				   u8 mask)
{
	if (mask != 0xff) {
		u8 buf;

		pci_read_config_byte(pdev, offset, &buf);
		value &= mask;
		buf &= ~mask;
		value |= buf;
	}

	pci_write_config_byte(pdev, offset, value);
}

/* write all or some bits in a word-register*/
static inline void pci_write_bits16(struct pci_dev *pdev, int offset,
				    u16 value, u16 mask)
{
	if (mask != 0xffff) {
		u16 buf;

		pci_read_config_word(pdev, offset, &buf);
		value &= mask;
		buf &= ~mask;
		value |= buf;
	}

	pci_write_config_word(pdev, offset, value);
}

/*
 * pci_write_bits32
 *
 * edac local routine to do pci_write_config_dword, but adds
 * a mask parameter. If mask is all ones, ignore the mask.
 * Otherwise utilize the mask to isolate specified bits
 *
 * write all or some bits in a dword-register
 */
static inline void pci_write_bits32(struct pci_dev *pdev, int offset,
				    u32 value, u32 mask)
{
	if (mask != 0xffffffff) {
		u32 buf;

		pci_read_config_dword(pdev, offset, &buf);
		value &= mask;
		buf &= ~mask;
		value |= buf;
	}

	pci_write_config_dword(pdev, offset, value);
}

#endif				/* CONFIG_PCI */

struct mem_ctl_info *edac_mc_alloc(unsigned mc_num,
				   unsigned n_layers,
				   struct edac_mc_layer *layers,
				   unsigned sz_pvt);
extern int edac_mc_add_mc(struct mem_ctl_info *mci);
extern void edac_mc_free(struct mem_ctl_info *mci);
extern struct mem_ctl_info *edac_mc_find(int idx);
extern struct mem_ctl_info *find_mci_by_dev(struct device *dev);
extern struct mem_ctl_info *edac_mc_del_mc(struct device *dev);
extern int edac_mc_find_csrow_by_page(struct mem_ctl_info *mci,
				      unsigned long page);
void edac_mc_handle_error(const enum hw_event_mc_err_type type,
			  struct mem_ctl_info *mci,
			  const unsigned long page_frame_number,
			  const unsigned long offset_in_page,
			  const unsigned long syndrome,
			  const int top_layer,
			  const int mid_layer,
			  const int low_layer,
			  const char *msg,
			  const char *other_detail,
			  const void *arch_log);

/*
 * edac_device APIs
 */
extern int edac_device_add_device(struct edac_device_ctl_info *edac_dev);
extern struct edac_device_ctl_info *edac_device_del_device(struct device *dev);
extern void edac_device_handle_ue(struct edac_device_ctl_info *edac_dev,
				int inst_nr, int block_nr, const char *msg);
extern void edac_device_handle_ce(struct edac_device_ctl_info *edac_dev,
				int inst_nr, int block_nr, const char *msg);
extern int edac_device_alloc_index(void);
extern const char *edac_layer_name[];

/*
 * edac_pci APIs
 */
extern struct edac_pci_ctl_info *edac_pci_alloc_ctl_info(unsigned int sz_pvt,
				const char *edac_pci_name);

extern void edac_pci_free_ctl_info(struct edac_pci_ctl_info *pci);

extern void edac_pci_reset_delay_period(struct edac_pci_ctl_info *pci,
				unsigned long value);

extern int edac_pci_alloc_index(void);
extern int edac_pci_add_device(struct edac_pci_ctl_info *pci, int edac_idx);
extern struct edac_pci_ctl_info *edac_pci_del_device(struct device *dev);

extern struct edac_pci_ctl_info *edac_pci_create_generic_ctl(
				struct device *dev,
				const char *mod_name);

extern void edac_pci_release_generic_ctl(struct edac_pci_ctl_info *pci);
extern int edac_pci_create_sysfs(struct edac_pci_ctl_info *pci);
extern void edac_pci_remove_sysfs(struct edac_pci_ctl_info *pci);

/*
 * edac misc APIs
 */
extern char *edac_op_state_to_string(int op_state);

#endif				/* _EDAC_CORE_H_ */
Commit	Line	Data
7c9281d7 DT	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 <[email protected]> <[email protected]>
	14	*
	15	* Refactored for multi-source files:
	16	* Doug Thompson <[email protected]>
	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>
e27e3dac	35	#include <linux/workqueue.h>
ddeb3547	36	#include <linux/edac.h>
7c9281d7	37
e27e3dac DT	38	#define EDAC_DEVICE_NAME_LEN 31
e27e3dac DT	39	#define EDAC_ATTRIB_VALUE_LEN 15
7c9281d7 DT	40
7c9281d7 DT	41	#if PAGE_SHIFT < 20
76f04f25 AK	42	#define PAGES_TO_MiB(pages) ((pages) >> (20 - PAGE_SHIFT))
76f04f25 AK	43	#define MiB_TO_PAGES(mb) ((mb) << (20 - PAGE_SHIFT))
7c9281d7	44	#else /* PAGE_SHIFT > 20 */
76f04f25	45	#define PAGES_TO_MiB(pages) ((pages) << (PAGE_SHIFT - 20))
e9144601	46	#define MiB_TO_PAGES(mb) ((mb) >> (PAGE_SHIFT - 20))
7c9281d7 DT	47	#endif
	48
	49	#define edac_printk(level, prefix, fmt, arg...) \
	50	printk(level "EDAC " prefix ": " fmt, ##arg)
	51
	52	#define edac_mc_printk(mci, level, fmt, arg...) \
	53	printk(level "EDAC MC%d: " fmt, mci->mc_idx, ##arg)
	54
	55	#define edac_mc_chipset_printk(mci, level, prefix, fmt, arg...) \
	56	printk(level "EDAC " prefix " MC%d: " fmt, mci->mc_idx, ##arg)
	57
e27e3dac DT	58	#define edac_device_printk(ctl, level, fmt, arg...) \
	59	printk(level "EDAC DEVICE%d: " fmt, ctl->dev_idx, ##arg)
	60
91b99041 DJ	61	#define edac_pci_printk(ctl, level, fmt, arg...) \
	62	printk(level "EDAC PCI%d: " fmt, ctl->pci_idx, ##arg)
	63
7c9281d7 DT	64	/* prefixes for edac_printk() and edac_mc_printk() */
	65	#define EDAC_MC "MC"
	66	#define EDAC_PCI "PCI"
	67	#define EDAC_DEBUG "DEBUG"
	68
24f9a7fe BP	69	extern const char *edac_mem_types[];
24f9a7fe BP	70
7c9281d7 DT	71	#ifdef CONFIG_EDAC_DEBUG
	72	extern int edac_debug_level;
	73
956b9ba1	74	#define edac_dbg(level, fmt, ...) \
7e881856 JP	75	do { \
	76	if (level <= edac_debug_level) \
	77	edac_printk(KERN_DEBUG, EDAC_DEBUG, \
	78	"%s: " fmt, __func__, ##__VA_ARGS__); \
	79	} while (0)
7c9281d7	80
079708b9	81	#else /* !CONFIG_EDAC_DEBUG */
7c9281d7	82
956b9ba1	83	#define edac_dbg(level, fmt, ...) \
7e881856 JP	84	do { \
	85	if (0) \
	86	edac_printk(KERN_DEBUG, EDAC_DEBUG, \
	87	"%s: " fmt, __func__, ##__VA_ARGS__); \
	88	} while (0)
7c9281d7	89
079708b9	90	#endif /* !CONFIG_EDAC_DEBUG */
7c9281d7	91
7c9281d7 DT	92	#define PCI_VEND_DEV(vend, dev) PCI_VENDOR_ID_ ## vend, \
	93	PCI_DEVICE_ID_ ## vend ## _ ## dev
	94
17aa7e03	95	#define edac_dev_name(dev) (dev)->dev_name
7c9281d7	96
e27e3dac	97	/*
42a8e397	98	* The following are the structures to provide for a generic
e27e3dac DT	99	* or abstract 'edac_device'. This set of structures and the
	100	* code that implements the APIs for the same, provide for
	101	* registering EDAC type devices which are NOT standard memory.
	102	*
	103	* CPU caches (L1 and L2)
	104	* DMA engines
	105	* Core CPU swithces
	106	* Fabric switch units
	107	* PCIe interface controllers
	108	* other EDAC/ECC type devices that can be monitored for
	109	* errors, etc.
	110	*
	111	* It allows for a 2 level set of hiearchry. For example:
	112	*
	113	* cache could be composed of L1, L2 and L3 levels of cache.
	114	* Each CPU core would have its own L1 cache, while sharing
	115	* L2 and maybe L3 caches.
	116	*
	117	* View them arranged, via the sysfs presentation:
	118	* /sys/devices/system/edac/..
	119	*
	120	* mc/ <existing memory device directory>
	121	* cpu/cpu0/.. <L1 and L2 block directory>
	122	* /L1-cache/ce_count
	123	* /ue_count
	124	* /L2-cache/ce_count
	125	* /ue_count
	126	* cpu/cpu1/.. <L1 and L2 block directory>
	127	* /L1-cache/ce_count
	128	* /ue_count
	129	* /L2-cache/ce_count
	130	* /ue_count
	131	* ...
	132	*
	133	* the L1 and L2 directories would be "edac_device_block's"
	134	*/
	135
	136	struct edac_device_counter {
079708b9 DT	137	u32 ue_count;
079708b9 DT	138	u32 ce_count;
e27e3dac DT	139	};
e27e3dac DT	140
fd309a9d DT	141	/* forward reference */
	142	struct edac_device_ctl_info;
	143	struct edac_device_block;
e27e3dac	144
fd309a9d DT	145	/* edac_dev_sysfs_attribute structure
	146	* used for driver sysfs attributes in mem_ctl_info
	147	* for extra controls and attributes:
	148	* like high level error Injection controls
	149	*/
	150	struct edac_dev_sysfs_attribute {
	151	struct attribute attr;
	152	ssize_t (show)(struct edac_device_ctl_info , char *);
	153	ssize_t (store)(struct edac_device_ctl_info , const char *, size_t);
e27e3dac DT	154	};
e27e3dac DT	155
fd309a9d	156	/* edac_dev_sysfs_block_attribute structure
b2a4ac0c	157	*
fd309a9d	158	* used in leaf 'block' nodes for adding controls/attributes
b2a4ac0c DT	159	*
	160	* each block in each instance of the containing control structure
	161	* can have an array of the following. The show and store functions
	162	* will be filled in with the show/store function in the
	163	* low level driver.
	164	*
	165	* The 'value' field will be the actual value field used for
	166	* counting
e27e3dac	167	*/
fd309a9d DT	168	struct edac_dev_sysfs_block_attribute {
	169	struct attribute attr;
	170	ssize_t (show)(struct kobject , struct attribute , char );
	171	ssize_t (store)(struct kobject , struct attribute *,
	172	const char *, size_t);
	173	struct edac_device_block *block;
	174
fd309a9d	175	unsigned int value;
e27e3dac DT	176	};
	177
	178	/* device block control structure */
	179	struct edac_device_block {
	180	struct edac_device_instance instance; / Up Pointer */
079708b9	181	char name[EDAC_DEVICE_NAME_LEN + 1];
e27e3dac DT	182
	183	struct edac_device_counter counters; /* basic UE and CE counters */
	184
079708b9	185	int nr_attribs; /* how many attributes */
fd309a9d DT	186
	187	/* this block's attributes, could be NULL */
	188	struct edac_dev_sysfs_block_attribute *block_attributes;
e27e3dac DT	189
	190	/* edac sysfs device control */
	191	struct kobject kobj;
e27e3dac DT	192	};
	193
	194	/* device instance control structure */
	195	struct edac_device_instance {
	196	struct edac_device_ctl_info ctl; / Up pointer */
	197	char name[EDAC_DEVICE_NAME_LEN + 4];
	198
	199	struct edac_device_counter counters; /* instance counters */
	200
079708b9	201	u32 nr_blocks; /* how many blocks */
e27e3dac DT	202	struct edac_device_block blocks; / block array */
	203
	204	/* edac sysfs device control */
	205	struct kobject kobj;
e27e3dac DT	206	};
e27e3dac DT	207
42a8e397	208
e27e3dac DT	209	/*
	210	* Abstract edac_device control info structure
	211	*
	212	*/
	213	struct edac_device_ctl_info {
	214	/* for global list of edac_device_ctl_info structs */
	215	struct list_head link;
	216
1c3631ff DT	217	struct module owner; / Module owner of this control struct */
1c3631ff DT	218
e27e3dac DT	219	int dev_idx;
	220
	221	/* Per instance controls for this edac_device */
	222	int log_ue; /* boolean for logging UEs */
	223	int log_ce; /* boolean for logging CEs */
	224	int panic_on_ue; /* boolean for panic'ing on an UE */
	225	unsigned poll_msec; /* number of milliseconds to poll interval */
	226	unsigned long delay; /* number of jiffies for poll_msec */
	227
42a8e397 DT	228	/* Additional top controller level attributes, but specified
	229	* by the low level driver.
	230	*
	231	* Set by the low level driver to provide attributes at the
	232	* controller level, same level as 'ue_count' and 'ce_count' above.
	233	* An array of structures, NULL terminated
	234	*
	235	* If attributes are desired, then set to array of attributes
	236	* If no attributes are desired, leave NULL
	237	*/
	238	struct edac_dev_sysfs_attribute *sysfs_attributes;
	239
fe5ff8b8 KS	240	/* pointer to main 'edac' subsys in sysfs */
fe5ff8b8 KS	241	struct bus_type *edac_subsys;
e27e3dac DT	242
	243	/* the internal state of this controller instance */
	244	int op_state;
e27e3dac	245	/* work struct for this instance */
e27e3dac	246	struct delayed_work work;
e27e3dac DT	247
e27e3dac DT	248	/* pointer to edac polling checking routine:
079708b9 DT	249	* If NOT NULL: points to polling check routine
	250	* If NULL: Then assumes INTERRUPT operation, where
	251	* MC driver will receive events
e27e3dac DT	252	*/
	253	void (edac_check) (struct edac_device_ctl_info edac_dev);
	254
	255	struct device dev; / pointer to device structure */
	256
	257	const char mod_name; / module name */
	258	const char ctl_name; / edac controller name */
c4192705	259	const char dev_name; / pci/platform/etc... name */
e27e3dac DT	260
	261	void pvt_info; / pointer to 'private driver' info */
	262
079708b9	263	unsigned long start_time; /* edac_device load start time (jiffies) */
e27e3dac	264
1c3631ff	265	struct completion removal_complete;
e27e3dac DT	266
	267	/* sysfs top name under 'edac' directory
	268	* and instance name:
079708b9 DT	269	* cpu/cpu0/...
	270	* cpu/cpu1/...
	271	* cpu/cpu2/...
	272	* ...
e27e3dac DT	273	*/
	274	char name[EDAC_DEVICE_NAME_LEN + 1];
	275
	276	/* Number of instances supported on this control structure
	277	* and the array of those instances
	278	*/
	279	u32 nr_instances;
	280	struct edac_device_instance *instances;
	281
	282	/* Event counters for the this whole EDAC Device */
	283	struct edac_device_counter counters;
	284
	285	/* edac sysfs device control for the 'name'
	286	* device this structure controls
	287	*/
	288	struct kobject kobj;
e27e3dac DT	289	};
	290
	291	/* To get from the instance's wq to the beginning of the ctl structure */
81d87cb1 DJ	292	#define to_edac_mem_ctl_work(w) \
	293	container_of(w, struct mem_ctl_info, work)
	294
e27e3dac DT	295	#define to_edac_device_ctl_work(w) \
	296	container_of(w,struct edac_device_ctl_info,work)
	297
e27e3dac DT	298	/*
	299	* The alloc() and free() functions for the 'edac_device' control info
	300	* structure. A MC driver will allocate one of these for each edac_device
	301	* it is going to control/register with the EDAC CORE.
	302	*/
	303	extern struct edac_device_ctl_info *edac_device_alloc_ctl_info(
079708b9	304	unsigned sizeof_private,
fd309a9d DT	305	char *edac_device_name, unsigned nr_instances,
fd309a9d DT	306	char *edac_block_name, unsigned nr_blocks,
079708b9	307	unsigned offset_value,
fd309a9d	308	struct edac_dev_sysfs_block_attribute *block_attributes,
d45e7823 DT	309	unsigned nr_attribs,
d45e7823 DT	310	int device_index);
e27e3dac DT	311
	312	/* The offset value can be:
	313	* -1 indicating no offset value
	314	* 0 for zero-based block numbers
	315	* 1 for 1-based block number
	316	* other for other-based block number
	317	*/
	318	#define BLOCK_OFFSET_VALUE_OFF ((unsigned) -1)
	319
079708b9	320	extern void edac_device_free_ctl_info(struct edac_device_ctl_info *ctl_info);
e27e3dac	321
7c9281d7 DT	322	#ifdef CONFIG_PCI
7c9281d7 DT	323
91b99041	324	struct edac_pci_counter {
079708b9 DT	325	atomic_t pe_count;
079708b9 DT	326	atomic_t npe_count;
91b99041 DJ	327	};
	328
	329	/*
	330	* Abstract edac_pci control info structure
	331	*
	332	*/
	333	struct edac_pci_ctl_info {
	334	/* for global list of edac_pci_ctl_info structs */
	335	struct list_head link;
	336
	337	int pci_idx;
	338
fe5ff8b8	339	struct bus_type edac_subsys; / pointer to subsystem */
91b99041 DJ	340
	341	/* the internal state of this controller instance */
	342	int op_state;
	343	/* work struct for this instance */
91b99041	344	struct delayed_work work;
91b99041 DJ	345
91b99041 DJ	346	/* pointer to edac polling checking routine:
079708b9 DT	347	* If NOT NULL: points to polling check routine
	348	* If NULL: Then assumes INTERRUPT operation, where
	349	* MC driver will receive events
91b99041 DJ	350	*/
	351	void (edac_check) (struct edac_pci_ctl_info edac_dev);
	352
	353	struct device dev; / pointer to device structure */
	354
	355	const char mod_name; / module name */
	356	const char ctl_name; / edac controller name */
	357	const char dev_name; / pci/platform/etc... name */
	358
	359	void pvt_info; / pointer to 'private driver' info */
	360
079708b9	361	unsigned long start_time; /* edac_pci load start time (jiffies) */
91b99041	362
91b99041 DJ	363	struct completion complete;
	364
	365	/* sysfs top name under 'edac' directory
	366	* and instance name:
079708b9 DT	367	* cpu/cpu0/...
	368	* cpu/cpu1/...
	369	* cpu/cpu2/...
	370	* ...
91b99041 DJ	371	*/
	372	char name[EDAC_DEVICE_NAME_LEN + 1];
	373
	374	/* Event counters for the this whole EDAC Device */
	375	struct edac_pci_counter counters;
	376
	377	/* edac sysfs device control for the 'name'
	378	* device this structure controls
	379	*/
	380	struct kobject kobj;
	381	struct completion kobj_complete;
	382	};
	383
	384	#define to_edac_pci_ctl_work(w) \
	385	container_of(w, struct edac_pci_ctl_info,work)
	386
7c9281d7 DT	387	/* write all or some bits in a byte-register*/
7c9281d7 DT	388	static inline void pci_write_bits8(struct pci_dev *pdev, int offset, u8 value,
079708b9	389	u8 mask)
7c9281d7 DT	390	{
	391	if (mask != 0xff) {
	392	u8 buf;
	393
	394	pci_read_config_byte(pdev, offset, &buf);
	395	value &= mask;
	396	buf &= ~mask;
	397	value \|= buf;
	398	}
	399
	400	pci_write_config_byte(pdev, offset, value);
	401	}
	402
	403	/* write all or some bits in a word-register*/
	404	static inline void pci_write_bits16(struct pci_dev *pdev, int offset,
079708b9	405	u16 value, u16 mask)
7c9281d7 DT	406	{
	407	if (mask != 0xffff) {
	408	u16 buf;
	409
	410	pci_read_config_word(pdev, offset, &buf);
	411	value &= mask;
	412	buf &= ~mask;
	413	value \|= buf;
	414	}
	415
	416	pci_write_config_word(pdev, offset, value);
	417	}
	418
e6da46b2 JH	419	/*
	420	* pci_write_bits32
	421	*
	422	* edac local routine to do pci_write_config_dword, but adds
	423	* a mask parameter. If mask is all ones, ignore the mask.
	424	* Otherwise utilize the mask to isolate specified bits
	425	*
	426	* write all or some bits in a dword-register
	427	*/
7c9281d7	428	static inline void pci_write_bits32(struct pci_dev *pdev, int offset,
079708b9	429	u32 value, u32 mask)
7c9281d7	430	{
e6da46b2	431	if (mask != 0xffffffff) {
7c9281d7 DT	432	u32 buf;
	433
	434	pci_read_config_dword(pdev, offset, &buf);
	435	value &= mask;
	436	buf &= ~mask;
	437	value \|= buf;
	438	}
	439
	440	pci_write_config_dword(pdev, offset, value);
	441	}
	442
079708b9	443	#endif /* CONFIG_PCI */
7c9281d7	444
ca0907b9	445	struct mem_ctl_info *edac_mc_alloc(unsigned mc_num,
4275be63 MCC	446	unsigned n_layers,
	447	struct edac_mc_layer *layers,
	448	unsigned sz_pvt);
b8f6f975 DT	449	extern int edac_mc_add_mc(struct mem_ctl_info *mci);
b8f6f975 DT	450	extern void edac_mc_free(struct mem_ctl_info *mci);
079708b9	451	extern struct mem_ctl_info *edac_mc_find(int idx);
939747bd	452	extern struct mem_ctl_info find_mci_by_dev(struct device dev);
079708b9	453	extern struct mem_ctl_info edac_mc_del_mc(struct device dev);
7c9281d7	454	extern int edac_mc_find_csrow_by_page(struct mem_ctl_info *mci,
079708b9	455	unsigned long page);
4275be63 MCC	456	void edac_mc_handle_error(const enum hw_event_mc_err_type type,
	457	struct mem_ctl_info *mci,
	458	const unsigned long page_frame_number,
	459	const unsigned long offset_in_page,
	460	const unsigned long syndrome,
53f2d028 MCC	461	const int top_layer,
	462	const int mid_layer,
	463	const int low_layer,
4275be63 MCC	464	const char *msg,
4275be63 MCC	465	const char *other_detail,
53f2d028	466	const void *arch_log);
4275be63	467
7c9281d7	468	/*
e27e3dac	469	* edac_device APIs
7c9281d7	470	*/
d45e7823	471	extern int edac_device_add_device(struct edac_device_ctl_info *edac_dev);
079708b9	472	extern struct edac_device_ctl_info edac_device_del_device(struct device dev);
e27e3dac	473	extern void edac_device_handle_ue(struct edac_device_ctl_info *edac_dev,
b8f6f975	474	int inst_nr, int block_nr, const char *msg);
e27e3dac	475	extern void edac_device_handle_ce(struct edac_device_ctl_info *edac_dev,
b8f6f975	476	int inst_nr, int block_nr, const char *msg);
1dc9b70d	477	extern int edac_device_alloc_index(void);
4275be63	478	extern const char *edac_layer_name[];
e27e3dac	479
91b99041 DJ	480	/*
	481	* edac_pci APIs
	482	*/
b8f6f975 DT	483	extern struct edac_pci_ctl_info *edac_pci_alloc_ctl_info(unsigned int sz_pvt,
b8f6f975 DT	484	const char *edac_pci_name);
91b99041 DJ	485
	486	extern void edac_pci_free_ctl_info(struct edac_pci_ctl_info *pci);
	487
b8f6f975 DT	488	extern void edac_pci_reset_delay_period(struct edac_pci_ctl_info *pci,
b8f6f975 DT	489	unsigned long value);
91b99041	490
8641a384	491	extern int edac_pci_alloc_index(void);
91b99041	492	extern int edac_pci_add_device(struct edac_pci_ctl_info *pci, int edac_idx);
079708b9	493	extern struct edac_pci_ctl_info edac_pci_del_device(struct device dev);
91b99041	494
b8f6f975 DT	495	extern struct edac_pci_ctl_info *edac_pci_create_generic_ctl(
	496	struct device *dev,
	497	const char *mod_name);
91b99041 DJ	498
	499	extern void edac_pci_release_generic_ctl(struct edac_pci_ctl_info *pci);
	500	extern int edac_pci_create_sysfs(struct edac_pci_ctl_info *pci);
	501	extern void edac_pci_remove_sysfs(struct edac_pci_ctl_info *pci);
	502
	503	/*
	504	* edac misc APIs
	505	*/
494d0d55	506	extern char *edac_op_state_to_string(int op_state);
7c9281d7 DT	507
7c9281d7 DT	508	#endif /* _EDAC_CORE_H_ */