1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef GHES_H
3 #define GHES_H
4 
5 #include <acpi/apei.h>
6 #include <acpi/hed.h>
7 
8 /*
9  * One struct ghes is created for each generic hardware error source.
10  * It provides the context for APEI hardware error timer/IRQ/SCI/NMI
11  * handler.
12  *
13  * estatus: memory buffer for error status block, allocated during
14  * HEST parsing.
15  */
16 #define GHES_EXITING		0x0002
17 
18 struct ghes {
19 	union {
20 		struct acpi_hest_generic *generic;
21 		struct acpi_hest_generic_v2 *generic_v2;
22 	};
23 	struct acpi_hest_generic_status *estatus;
24 	unsigned long flags;
25 	union {
26 		struct list_head list;
27 		struct timer_list timer;
28 		unsigned int irq;
29 	};
30 	struct device *dev;
31 	struct list_head elist;
32 };
33 
34 struct ghes_estatus_node {
35 	struct llist_node llnode;
36 	struct acpi_hest_generic *generic;
37 	struct ghes *ghes;
38 
39 	int task_work_cpu;
40 	struct callback_head task_work;
41 };
42 
43 struct ghes_estatus_cache {
44 	u32 estatus_len;
45 	atomic_t count;
46 	struct acpi_hest_generic *generic;
47 	unsigned long long time_in;
48 	struct rcu_head rcu;
49 };
50 
51 enum {
52 	GHES_SEV_NO = 0x0,
53 	GHES_SEV_CORRECTED = 0x1,
54 	GHES_SEV_RECOVERABLE = 0x2,
55 	GHES_SEV_PANIC = 0x3,
56 };
57 
58 #ifdef CONFIG_ACPI_APEI_GHES
59 /**
60  * ghes_register_vendor_record_notifier - register a notifier for vendor
61  * records that the kernel would otherwise ignore.
62  * @nb: pointer to the notifier_block structure of the event handler.
63  *
64  * return 0 : SUCCESS, non-zero : FAIL
65  */
66 int ghes_register_vendor_record_notifier(struct notifier_block *nb);
67 
68 /**
69  * ghes_unregister_vendor_record_notifier - unregister the previously
70  * registered vendor record notifier.
71  * @nb: pointer to the notifier_block structure of the vendor record handler.
72  */
73 void ghes_unregister_vendor_record_notifier(struct notifier_block *nb);
74 
75 struct list_head *ghes_get_devices(void);
76 #else
ghes_get_devices(void)77 static inline struct list_head *ghes_get_devices(void) { return NULL; }
78 #endif
79 
80 int ghes_estatus_pool_init(unsigned int num_ghes);
81 
acpi_hest_get_version(struct acpi_hest_generic_data * gdata)82 static inline int acpi_hest_get_version(struct acpi_hest_generic_data *gdata)
83 {
84 	return gdata->revision >> 8;
85 }
86 
acpi_hest_get_payload(struct acpi_hest_generic_data * gdata)87 static inline void *acpi_hest_get_payload(struct acpi_hest_generic_data *gdata)
88 {
89 	if (acpi_hest_get_version(gdata) >= 3)
90 		return (void *)(((struct acpi_hest_generic_data_v300 *)(gdata)) + 1);
91 
92 	return gdata + 1;
93 }
94 
acpi_hest_get_error_length(struct acpi_hest_generic_data * gdata)95 static inline int acpi_hest_get_error_length(struct acpi_hest_generic_data *gdata)
96 {
97 	return ((struct acpi_hest_generic_data *)(gdata))->error_data_length;
98 }
99 
acpi_hest_get_size(struct acpi_hest_generic_data * gdata)100 static inline int acpi_hest_get_size(struct acpi_hest_generic_data *gdata)
101 {
102 	if (acpi_hest_get_version(gdata) >= 3)
103 		return sizeof(struct acpi_hest_generic_data_v300);
104 
105 	return sizeof(struct acpi_hest_generic_data);
106 }
107 
acpi_hest_get_record_size(struct acpi_hest_generic_data * gdata)108 static inline int acpi_hest_get_record_size(struct acpi_hest_generic_data *gdata)
109 {
110 	return (acpi_hest_get_size(gdata) + acpi_hest_get_error_length(gdata));
111 }
112 
acpi_hest_get_next(struct acpi_hest_generic_data * gdata)113 static inline void *acpi_hest_get_next(struct acpi_hest_generic_data *gdata)
114 {
115 	return (void *)(gdata) + acpi_hest_get_record_size(gdata);
116 }
117 
118 #define apei_estatus_for_each_section(estatus, section)			\
119 	for (section = (struct acpi_hest_generic_data *)(estatus + 1);	\
120 	     (void *)section - (void *)(estatus + 1) < estatus->data_length; \
121 	     section = acpi_hest_get_next(section))
122 
123 #ifdef CONFIG_ACPI_APEI_SEA
124 int ghes_notify_sea(void);
125 #else
ghes_notify_sea(void)126 static inline int ghes_notify_sea(void) { return -ENOENT; }
127 #endif
128 
129 struct notifier_block;
130 extern void ghes_register_report_chain(struct notifier_block *nb);
131 extern void ghes_unregister_report_chain(struct notifier_block *nb);
132 #endif /* GHES_H */
133