[mirror_ubuntu-bionic-kernel.git] / drivers / edac / edac_module.h

/* SPDX-License-Identifier: GPL-2.0 */

/*
 * edac_module.h
 *
 * For defining functions/data for within the EDAC_CORE module only
 *
 * written by doug thompson <norsk5@xmission.h>
 */

#ifndef	__EDAC_MODULE_H__
#define	__EDAC_MODULE_H__

#include "edac_mc.h"
#include "edac_pci.h"
#include "edac_device.h"

/*
 * INTERNAL EDAC MODULE:
 * EDAC memory controller sysfs create/remove functions
 * and setup/teardown functions
 *
 * edac_mc objects
 */
	/* on edac_mc_sysfs.c */
int edac_mc_sysfs_init(void);
void edac_mc_sysfs_exit(void);
extern int edac_create_sysfs_mci_device(struct mem_ctl_info *mci,
					const struct attribute_group **groups);
extern void edac_remove_sysfs_mci_device(struct mem_ctl_info *mci);
void edac_unregister_sysfs(struct mem_ctl_info *mci);
extern int edac_get_log_ue(void);
extern int edac_get_log_ce(void);
extern int edac_get_panic_on_ue(void);
extern int edac_mc_get_log_ue(void);
extern int edac_mc_get_log_ce(void);
extern int edac_mc_get_panic_on_ue(void);
extern int edac_get_poll_msec(void);
extern int edac_mc_get_poll_msec(void);

unsigned edac_dimm_info_location(struct dimm_info *dimm, char *buf,
				 unsigned len);

	/* on edac_device.c */
extern int edac_device_register_sysfs_main_kobj(
				struct edac_device_ctl_info *edac_dev);
extern void edac_device_unregister_sysfs_main_kobj(
				struct edac_device_ctl_info *edac_dev);
extern int edac_device_create_sysfs(struct edac_device_ctl_info *edac_dev);
extern void edac_device_remove_sysfs(struct edac_device_ctl_info *edac_dev);

/* edac core workqueue: single CPU mode */
int edac_workqueue_setup(void);
void edac_workqueue_teardown(void);
bool edac_queue_work(struct delayed_work *work, unsigned long delay);
bool edac_stop_work(struct delayed_work *work);
bool edac_mod_work(struct delayed_work *work, unsigned long delay);

extern void edac_device_reset_delay_period(struct edac_device_ctl_info
					   *edac_dev, unsigned long value);
extern void edac_mc_reset_delay_period(unsigned long value);

extern void *edac_align_ptr(void **p, unsigned size, int n_elems);

/*
 * EDAC debugfs functions
 */

#define edac_debugfs_remove_recursive debugfs_remove_recursive
#define edac_debugfs_remove debugfs_remove
#ifdef CONFIG_EDAC_DEBUG
int edac_debugfs_init(void);
void edac_debugfs_exit(void);
int edac_create_debugfs_nodes(struct mem_ctl_info *mci);
struct dentry *edac_debugfs_create_dir(const char *dirname);
struct dentry *
edac_debugfs_create_dir_at(const char *dirname, struct dentry *parent);
struct dentry *
edac_debugfs_create_file(const char *name, umode_t mode, struct dentry *parent,
			 void *data, const struct file_operations *fops);
struct dentry *
edac_debugfs_create_x8(const char *name, umode_t mode, struct dentry *parent, u8 *value);
struct dentry *
edac_debugfs_create_x16(const char *name, umode_t mode, struct dentry *parent, u16 *value);
#else
static inline int edac_debugfs_init(void)					{ return -ENODEV; }
static inline void edac_debugfs_exit(void)					{ }
static inline int edac_create_debugfs_nodes(struct mem_ctl_info *mci)		{ return 0; }
static inline struct dentry *edac_debugfs_create_dir(const char *dirname)	{ return NULL; }
static inline struct dentry *
edac_debugfs_create_dir_at(const char *dirname, struct dentry *parent)		{ return NULL; }
static inline struct dentry *
edac_debugfs_create_file(const char *name, umode_t mode, struct dentry *parent,
			 void *data, const struct file_operations *fops)	{ return NULL; }
static inline struct dentry *
edac_debugfs_create_x8(const char *name, umode_t mode,
		       struct dentry *parent, u8 *value)			{ return NULL; }
static inline struct dentry *
edac_debugfs_create_x16(const char *name, umode_t mode,
		       struct dentry *parent, u16 *value)			{ return NULL; }
#endif

/*
 * EDAC PCI functions
 */
#ifdef	CONFIG_PCI
extern void edac_pci_do_parity_check(void);
extern void edac_pci_clear_parity_errors(void);
extern int edac_sysfs_pci_setup(void);
extern void edac_sysfs_pci_teardown(void);
extern int edac_pci_get_check_errors(void);
extern int edac_pci_get_poll_msec(void);
extern void edac_pci_remove_sysfs(struct edac_pci_ctl_info *pci);
extern void edac_pci_handle_pe(struct edac_pci_ctl_info *pci, const char *msg);
extern void edac_pci_handle_npe(struct edac_pci_ctl_info *pci,
				const char *msg);
#else				/* CONFIG_PCI */
/* pre-process these away */
#define edac_pci_do_parity_check()
#define edac_pci_clear_parity_errors()
#define edac_sysfs_pci_setup()  (0)
#define edac_sysfs_pci_teardown()
#define edac_pci_get_check_errors()
#define edac_pci_get_poll_msec()
#define edac_pci_handle_pe()
#define edac_pci_handle_npe()
#endif				/* CONFIG_PCI */

#endif				/* __EDAC_MODULE_H__ */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
7c9281d7 DT	2
	3	/*
	4	* edac_module.h
	5	*
	6	* For defining functions/data for within the EDAC_CORE module only
	7	*
	8	* written by doug thompson <norsk5@xmission.h>
	9	*/
	10
	11	#ifndef __EDAC_MODULE_H__
	12	#define __EDAC_MODULE_H__
	13
78d88e8a MCC	14	#include "edac_mc.h"
	15	#include "edac_pci.h"
	16	#include "edac_device.h"
7c9281d7 DT	17
	18	/*
	19	* INTERNAL EDAC MODULE:
	20	* EDAC memory controller sysfs create/remove functions
	21	* and setup/teardown functions
8096cfaf DT	22	*
8096cfaf DT	23	* edac_mc objects
7c9281d7	24	*/
7a623c03 MCC	25	/* on edac_mc_sysfs.c */
	26	int edac_mc_sysfs_init(void);
	27	void edac_mc_sysfs_exit(void);
4e8d230d TI	28	extern int edac_create_sysfs_mci_device(struct mem_ctl_info *mci,
4e8d230d TI	29	const struct attribute_group **groups);
7c9281d7	30	extern void edac_remove_sysfs_mci_device(struct mem_ctl_info *mci);
7a623c03	31	void edac_unregister_sysfs(struct mem_ctl_info *mci);
7c9281d7 DT	32	extern int edac_get_log_ue(void);
	33	extern int edac_get_log_ce(void);
	34	extern int edac_get_panic_on_ue(void);
4de78c68 DJ	35	extern int edac_mc_get_log_ue(void);
	36	extern int edac_mc_get_log_ce(void);
	37	extern int edac_mc_get_panic_on_ue(void);
7c9281d7	38	extern int edac_get_poll_msec(void);
81d87cb1	39	extern int edac_mc_get_poll_msec(void);
7c9281d7	40
6e84d359 MCC	41	unsigned edac_dimm_info_location(struct dimm_info dimm, char buf,
	42	unsigned len);
	43
7a623c03	44	/* on edac_device.c */
1c3631ff DT	45	extern int edac_device_register_sysfs_main_kobj(
	46	struct edac_device_ctl_info *edac_dev);
	47	extern void edac_device_unregister_sysfs_main_kobj(
	48	struct edac_device_ctl_info *edac_dev);
7c9281d7 DT	49	extern int edac_device_create_sysfs(struct edac_device_ctl_info *edac_dev);
7c9281d7 DT	50	extern void edac_device_remove_sysfs(struct edac_device_ctl_info *edac_dev);
7c9281d7	51
e27e3dac	52	/* edac core workqueue: single CPU mode */
c4cf3b45 BP	53	int edac_workqueue_setup(void);
	54	void edac_workqueue_teardown(void);
	55	bool edac_queue_work(struct delayed_work *work, unsigned long delay);
	56	bool edac_stop_work(struct delayed_work *work);
	57	bool edac_mod_work(struct delayed_work *work, unsigned long delay);
	58
079708b9 DT	59	extern void edac_device_reset_delay_period(struct edac_device_ctl_info
079708b9 DT	60	*edac_dev, unsigned long value);
9da21b15	61	extern void edac_mc_reset_delay_period(unsigned long value);
bce19683	62
93e4fe64	63	extern void edac_align_ptr(void *p, unsigned size, int n_elems);
7c9281d7	64
e7930ba4 RH	65	/*
	66	* EDAC debugfs functions
	67	*/
4397bcb4 BP	68
	69	#define edac_debugfs_remove_recursive debugfs_remove_recursive
	70	#define edac_debugfs_remove debugfs_remove
e7930ba4 RH	71	#ifdef CONFIG_EDAC_DEBUG
	72	int edac_debugfs_init(void);
	73	void edac_debugfs_exit(void);
7ac8bf9b	74	int edac_create_debugfs_nodes(struct mem_ctl_info *mci);
4397bcb4 BP	75	struct dentry edac_debugfs_create_dir(const char dirname);
	76	struct dentry *
	77	edac_debugfs_create_dir_at(const char dirname, struct dentry parent);
	78	struct dentry *
	79	edac_debugfs_create_file(const char name, umode_t mode, struct dentry parent,
	80	void data, const struct file_operations fops);
	81	struct dentry *
	82	edac_debugfs_create_x8(const char name, umode_t mode, struct dentry parent, u8 *value);
	83	struct dentry *
	84	edac_debugfs_create_x16(const char name, umode_t mode, struct dentry parent, u16 *value);
e7930ba4	85	#else
4397bcb4 BP	86	static inline int edac_debugfs_init(void) { return -ENODEV; }
	87	static inline void edac_debugfs_exit(void) { }
	88	static inline int edac_create_debugfs_nodes(struct mem_ctl_info *mci) { return 0; }
	89	static inline struct dentry edac_debugfs_create_dir(const char dirname) { return NULL; }
	90	static inline struct dentry *
	91	edac_debugfs_create_dir_at(const char dirname, struct dentry parent) { return NULL; }
	92	static inline struct dentry *
	93	edac_debugfs_create_file(const char name, umode_t mode, struct dentry parent,
	94	void data, const struct file_operations fops) { return NULL; }
	95	static inline struct dentry *
	96	edac_debugfs_create_x8(const char *name, umode_t mode,
	97	struct dentry parent, u8 value) { return NULL; }
	98	static inline struct dentry *
	99	edac_debugfs_create_x16(const char *name, umode_t mode,
	100	struct dentry parent, u16 value) { return NULL; }
e7930ba4 RH	101	#endif
e7930ba4 RH	102
7c9281d7 DT	103	/*
	104	* EDAC PCI functions
	105	*/
	106	#ifdef CONFIG_PCI
	107	extern void edac_pci_do_parity_check(void);
	108	extern void edac_pci_clear_parity_errors(void);
	109	extern int edac_sysfs_pci_setup(void);
	110	extern void edac_sysfs_pci_teardown(void);
4de78c68 DJ	111	extern int edac_pci_get_check_errors(void);
4de78c68 DJ	112	extern int edac_pci_get_poll_msec(void);
d4c1465b DT	113	extern void edac_pci_remove_sysfs(struct edac_pci_ctl_info *pci);
	114	extern void edac_pci_handle_pe(struct edac_pci_ctl_info pci, const char msg);
	115	extern void edac_pci_handle_npe(struct edac_pci_ctl_info *pci,
	116	const char *msg);
079708b9	117	#else /* CONFIG_PCI */
7c9281d7 DT	118	/* pre-process these away */
	119	#define edac_pci_do_parity_check()
	120	#define edac_pci_clear_parity_errors()
	121	#define edac_sysfs_pci_setup() (0)
	122	#define edac_sysfs_pci_teardown()
4de78c68 DJ	123	#define edac_pci_get_check_errors()
4de78c68 DJ	124	#define edac_pci_get_poll_msec()
d4c1465b DT	125	#define edac_pci_handle_pe()
d4c1465b DT	126	#define edac_pci_handle_npe()
079708b9	127	#endif /* CONFIG_PCI */
7c9281d7	128
079708b9	129	#endif /* __EDAC_MODULE_H__ */