xref: /openbmc/linux/drivers/edac/edac_module.h (revision bef7a78d)
1 /* SPDX-License-Identifier: GPL-2.0 */
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 
14 #include "edac_mc.h"
15 #include "edac_pci.h"
16 #include "edac_device.h"
17 
18 /*
19  * INTERNAL EDAC MODULE:
20  * EDAC memory controller sysfs create/remove functions
21  * and setup/teardown functions
22  *
23  * edac_mc objects
24  */
25 	/* on edac_mc_sysfs.c */
26 int edac_mc_sysfs_init(void);
27 void edac_mc_sysfs_exit(void);
28 extern int edac_create_sysfs_mci_device(struct mem_ctl_info *mci,
29 					const struct attribute_group **groups);
30 extern void edac_remove_sysfs_mci_device(struct mem_ctl_info *mci);
31 extern int edac_get_log_ue(void);
32 extern int edac_get_log_ce(void);
33 extern int edac_get_panic_on_ue(void);
34 extern int edac_mc_get_log_ue(void);
35 extern int edac_mc_get_log_ce(void);
36 extern int edac_mc_get_panic_on_ue(void);
37 extern int edac_get_poll_msec(void);
38 extern unsigned int edac_mc_get_poll_msec(void);
39 
40 unsigned edac_dimm_info_location(struct dimm_info *dimm, char *buf,
41 				 unsigned len);
42 
43 	/* on edac_device.c */
44 extern int edac_device_register_sysfs_main_kobj(
45 				struct edac_device_ctl_info *edac_dev);
46 extern void edac_device_unregister_sysfs_main_kobj(
47 				struct edac_device_ctl_info *edac_dev);
48 extern int edac_device_create_sysfs(struct edac_device_ctl_info *edac_dev);
49 extern void edac_device_remove_sysfs(struct edac_device_ctl_info *edac_dev);
50 
51 /* edac core workqueue: single CPU mode */
52 int edac_workqueue_setup(void);
53 void edac_workqueue_teardown(void);
54 bool edac_queue_work(struct delayed_work *work, unsigned long delay);
55 bool edac_stop_work(struct delayed_work *work);
56 bool edac_mod_work(struct delayed_work *work, unsigned long delay);
57 
58 extern void edac_device_reset_delay_period(struct edac_device_ctl_info
59 					   *edac_dev, unsigned long value);
60 extern void edac_mc_reset_delay_period(unsigned long value);
61 
62 extern void *edac_align_ptr(void **p, unsigned size, int n_elems);
63 
64 /*
65  * EDAC debugfs functions
66  */
67 
68 #define edac_debugfs_remove_recursive debugfs_remove_recursive
69 #define edac_debugfs_remove debugfs_remove
70 #ifdef CONFIG_EDAC_DEBUG
71 void edac_debugfs_init(void);
72 void edac_debugfs_exit(void);
73 void edac_create_debugfs_nodes(struct mem_ctl_info *mci);
74 struct dentry *edac_debugfs_create_dir(const char *dirname);
75 struct dentry *
76 edac_debugfs_create_dir_at(const char *dirname, struct dentry *parent);
77 struct dentry *
78 edac_debugfs_create_file(const char *name, umode_t mode, struct dentry *parent,
79 			 void *data, const struct file_operations *fops);
80 void edac_debugfs_create_x8(const char *name, umode_t mode,
81 			    struct dentry *parent, u8 *value);
82 void edac_debugfs_create_x16(const char *name, umode_t mode,
83 			     struct dentry *parent, u16 *value);
84 void edac_debugfs_create_x32(const char *name, umode_t mode,
85 			     struct dentry *parent, u32 *value);
86 #else
87 static inline void edac_debugfs_init(void)					{ }
88 static inline void edac_debugfs_exit(void)					{ }
89 static inline void edac_create_debugfs_nodes(struct mem_ctl_info *mci)		{ }
90 static inline struct dentry *edac_debugfs_create_dir(const char *dirname)	{ return NULL; }
91 static inline struct dentry *
92 edac_debugfs_create_dir_at(const char *dirname, struct dentry *parent)		{ return NULL; }
93 static inline struct dentry *
94 edac_debugfs_create_file(const char *name, umode_t mode, struct dentry *parent,
95 			 void *data, const struct file_operations *fops)	{ return NULL; }
96 static inline void edac_debugfs_create_x8(const char *name, umode_t mode,
97 					  struct dentry *parent, u8 *value)	{ }
98 static inline void edac_debugfs_create_x16(const char *name, umode_t mode,
99 					   struct dentry *parent, u16 *value)	{ }
100 static inline void edac_debugfs_create_x32(const char *name, umode_t mode,
101 		       struct dentry *parent, u32 *value)			{ }
102 #endif
103 
104 /*
105  * EDAC PCI functions
106  */
107 #ifdef	CONFIG_PCI
108 extern void edac_pci_do_parity_check(void);
109 extern void edac_pci_clear_parity_errors(void);
110 extern int edac_sysfs_pci_setup(void);
111 extern void edac_sysfs_pci_teardown(void);
112 extern int edac_pci_get_check_errors(void);
113 extern int edac_pci_get_poll_msec(void);
114 extern void edac_pci_remove_sysfs(struct edac_pci_ctl_info *pci);
115 extern void edac_pci_handle_pe(struct edac_pci_ctl_info *pci, const char *msg);
116 extern void edac_pci_handle_npe(struct edac_pci_ctl_info *pci,
117 				const char *msg);
118 #else				/* CONFIG_PCI */
119 /* pre-process these away */
120 #define edac_pci_do_parity_check()
121 #define edac_pci_clear_parity_errors()
122 #define edac_sysfs_pci_setup()  (0)
123 #define edac_sysfs_pci_teardown()
124 #define edac_pci_get_check_errors()
125 #define edac_pci_get_poll_msec()
126 #define edac_pci_handle_pe()
127 #define edac_pci_handle_npe()
128 #endif				/* CONFIG_PCI */
129 
130 #endif				/* __EDAC_MODULE_H__ */
131