xref: /linux/drivers/edac/edac_module.h (revision 630ae80ea1dd253609cb50cff87f3248f901aca3)
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_mc_get_log_ue(void);
32 extern int edac_mc_get_log_ce(void);
33 extern int edac_mc_get_panic_on_ue(void);
34 extern unsigned int edac_mc_get_poll_msec(void);
35 
36 unsigned edac_dimm_info_location(struct dimm_info *dimm, char *buf,
37 				 unsigned len);
38 
39 	/* on edac_device.c */
40 extern int edac_device_register_sysfs_main_kobj(
41 				struct edac_device_ctl_info *edac_dev);
42 extern void edac_device_unregister_sysfs_main_kobj(
43 				struct edac_device_ctl_info *edac_dev);
44 extern int edac_device_create_sysfs(struct edac_device_ctl_info *edac_dev);
45 extern void edac_device_remove_sysfs(struct edac_device_ctl_info *edac_dev);
46 
47 /* edac core workqueue: single CPU mode */
48 int edac_workqueue_setup(void);
49 void edac_workqueue_teardown(void);
50 bool edac_queue_work(struct delayed_work *work, unsigned long delay);
51 bool edac_stop_work(struct delayed_work *work);
52 bool edac_mod_work(struct delayed_work *work, unsigned long delay);
53 
54 extern void edac_device_reset_delay_period(struct edac_device_ctl_info
55 					   *edac_dev, unsigned long value);
56 extern void edac_mc_reset_delay_period(unsigned long value);
57 
58 /*
59  * EDAC debugfs functions
60  */
61 
62 #define edac_debugfs_remove_recursive debugfs_remove_recursive
63 #define edac_debugfs_remove debugfs_remove
64 #ifdef CONFIG_EDAC_DEBUG
65 void edac_debugfs_init(void);
66 void edac_debugfs_exit(void);
67 void edac_create_debugfs_nodes(struct mem_ctl_info *mci);
68 struct dentry *edac_debugfs_create_dir(const char *dirname);
69 struct dentry *
70 edac_debugfs_create_dir_at(const char *dirname, struct dentry *parent);
71 struct dentry *
72 edac_debugfs_create_file(const char *name, umode_t mode, struct dentry *parent,
73 			 void *data, const struct file_operations *fops);
74 void edac_debugfs_create_x8(const char *name, umode_t mode,
75 			    struct dentry *parent, u8 *value);
76 void edac_debugfs_create_x16(const char *name, umode_t mode,
77 			     struct dentry *parent, u16 *value);
78 void edac_debugfs_create_x32(const char *name, umode_t mode,
79 			     struct dentry *parent, u32 *value);
80 #else
81 static inline void edac_debugfs_init(void)					{ }
82 static inline void edac_debugfs_exit(void)					{ }
83 static inline void edac_create_debugfs_nodes(struct mem_ctl_info *mci)		{ }
84 static inline struct dentry *edac_debugfs_create_dir(const char *dirname)	{ return NULL; }
85 static inline struct dentry *
86 edac_debugfs_create_dir_at(const char *dirname, struct dentry *parent)		{ return NULL; }
87 static inline struct dentry *
88 edac_debugfs_create_file(const char *name, umode_t mode, struct dentry *parent,
89 			 void *data, const struct file_operations *fops)	{ return NULL; }
90 static inline void edac_debugfs_create_x8(const char *name, umode_t mode,
91 					  struct dentry *parent, u8 *value)	{ }
92 static inline void edac_debugfs_create_x16(const char *name, umode_t mode,
93 					   struct dentry *parent, u16 *value)	{ }
94 static inline void edac_debugfs_create_x32(const char *name, umode_t mode,
95 		       struct dentry *parent, u32 *value)			{ }
96 #endif
97 
98 /*
99  * EDAC PCI functions
100  */
101 #ifdef	CONFIG_PCI
102 extern void edac_pci_do_parity_check(void);
103 extern void edac_pci_clear_parity_errors(void);
104 extern int edac_sysfs_pci_setup(void);
105 extern void edac_sysfs_pci_teardown(void);
106 extern int edac_pci_get_check_errors(void);
107 extern int edac_pci_get_poll_msec(void);
108 extern void edac_pci_remove_sysfs(struct edac_pci_ctl_info *pci);
109 extern void edac_pci_handle_pe(struct edac_pci_ctl_info *pci, const char *msg);
110 extern void edac_pci_handle_npe(struct edac_pci_ctl_info *pci,
111 				const char *msg);
112 #else				/* CONFIG_PCI */
113 /* pre-process these away */
114 #define edac_pci_do_parity_check()
115 #define edac_pci_clear_parity_errors()
116 #define edac_sysfs_pci_setup()  (0)
117 #define edac_sysfs_pci_teardown()
118 #define edac_pci_get_check_errors()
119 #define edac_pci_get_poll_msec()
120 #define edac_pci_handle_pe()
121 #define edac_pci_handle_npe()
122 #endif				/* CONFIG_PCI */
123 
124 #endif				/* __EDAC_MODULE_H__ */
125