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
18struct 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
34struct 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
43struct 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
51enum {
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 */
66int 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 */
73void ghes_unregister_vendor_record_notifier(struct notifier_block *nb);
74
75struct list_head *ghes_get_devices(void);
76
77void ghes_estatus_pool_region_free(unsigned long addr, u32 size);
78#else
79static inline struct list_head *ghes_get_devices(void) { return NULL; }
80
81static inline void ghes_estatus_pool_region_free(unsigned long addr, u32 size) { return; }
82#endif
83
84int ghes_estatus_pool_init(unsigned int num_ghes);
85
86static inline int acpi_hest_get_version(struct acpi_hest_generic_data *gdata)
87{
88 return gdata->revision >> 8;
89}
90
91static inline void *acpi_hest_get_payload(struct acpi_hest_generic_data *gdata)
92{
93 if (acpi_hest_get_version(gdata) >= 3)
94 return (void *)(((struct acpi_hest_generic_data_v300 *)(gdata)) + 1);
95
96 return gdata + 1;
97}
98
99static inline int acpi_hest_get_error_length(struct acpi_hest_generic_data *gdata)
100{
101 return ((struct acpi_hest_generic_data *)(gdata))->error_data_length;
102}
103
104static inline int acpi_hest_get_size(struct acpi_hest_generic_data *gdata)
105{
106 if (acpi_hest_get_version(gdata) >= 3)
107 return sizeof(struct acpi_hest_generic_data_v300);
108
109 return sizeof(struct acpi_hest_generic_data);
110}
111
112static inline int acpi_hest_get_record_size(struct acpi_hest_generic_data *gdata)
113{
114 return (acpi_hest_get_size(gdata) + acpi_hest_get_error_length(gdata));
115}
116
117static inline void *acpi_hest_get_next(struct acpi_hest_generic_data *gdata)
118{
119 return (void *)(gdata) + acpi_hest_get_record_size(gdata);
120}
121
122#define apei_estatus_for_each_section(estatus, section) \
123 for (section = (struct acpi_hest_generic_data *)(estatus + 1); \
124 (void *)section - (void *)(estatus + 1) < estatus->data_length; \
125 section = acpi_hest_get_next(section))
126
127#ifdef CONFIG_ACPI_APEI_SEA
128int ghes_notify_sea(void);
129#else
130static inline int ghes_notify_sea(void) { return -ENOENT; }
131#endif
132
133struct notifier_block;
134extern void ghes_register_report_chain(struct notifier_block *nb);
135extern void ghes_unregister_report_chain(struct notifier_block *nb);
136#endif /* GHES_H */
137

source code of linux/include/acpi/ghes.h