1 // SPDX-License-Identifier: GPL-2.0-only
3 * APEI Hardware Error Source Table support
5 * HEST describes error sources in detail; communicates operational
6 * parameters (i.e. severity levels, masking bits, and threshold
7 * values) to Linux as necessary. It also allows the BIOS to report
8 * non-standard error sources to Linux (for example, chipset-specific
11 * For more information about HEST, please refer to ACPI Specification
12 * version 4.0, section 17.3.2.
14 * Copyright 2009 Intel Corp.
15 * Author: Huang Ying <ying.huang@intel.com>
18 #include <linux/kernel.h>
19 #include <linux/module.h>
20 #include <linux/init.h>
21 #include <linux/acpi.h>
22 #include <linux/kdebug.h>
23 #include <linux/highmem.h>
25 #include <linux/platform_device.h>
26 #include <acpi/apei.h>
27 #include <acpi/ghes.h>
29 #include "apei-internal.h"
31 #define HEST_PFX "HEST: "
34 EXPORT_SYMBOL_GPL(hest_disable);
36 /* HEST table parsing */
38 static struct acpi_table_hest *__read_mostly hest_tab;
40 static const int hest_esrc_len_tab[ACPI_HEST_TYPE_RESERVED] = {
41 [ACPI_HEST_TYPE_IA32_CHECK] = -1, /* need further calculation */
42 [ACPI_HEST_TYPE_IA32_CORRECTED_CHECK] = -1,
43 [ACPI_HEST_TYPE_IA32_NMI] = sizeof(struct acpi_hest_ia_nmi),
44 [ACPI_HEST_TYPE_AER_ROOT_PORT] = sizeof(struct acpi_hest_aer_root),
45 [ACPI_HEST_TYPE_AER_ENDPOINT] = sizeof(struct acpi_hest_aer),
46 [ACPI_HEST_TYPE_AER_BRIDGE] = sizeof(struct acpi_hest_aer_bridge),
47 [ACPI_HEST_TYPE_GENERIC_ERROR] = sizeof(struct acpi_hest_generic),
48 [ACPI_HEST_TYPE_GENERIC_ERROR_V2] = sizeof(struct acpi_hest_generic_v2),
49 [ACPI_HEST_TYPE_IA32_DEFERRED_CHECK] = -1,
52 static inline bool is_generic_error(struct acpi_hest_header *hest_hdr)
54 return hest_hdr->type == ACPI_HEST_TYPE_GENERIC_ERROR ||
55 hest_hdr->type == ACPI_HEST_TYPE_GENERIC_ERROR_V2;
58 static int hest_esrc_len(struct acpi_hest_header *hest_hdr)
60 u16 hest_type = hest_hdr->type;
63 if (hest_type >= ACPI_HEST_TYPE_RESERVED)
66 len = hest_esrc_len_tab[hest_type];
68 if (hest_type == ACPI_HEST_TYPE_IA32_CORRECTED_CHECK) {
69 struct acpi_hest_ia_corrected *cmc;
70 cmc = (struct acpi_hest_ia_corrected *)hest_hdr;
71 len = sizeof(*cmc) + cmc->num_hardware_banks *
72 sizeof(struct acpi_hest_ia_error_bank);
73 } else if (hest_type == ACPI_HEST_TYPE_IA32_CHECK) {
74 struct acpi_hest_ia_machine_check *mc;
75 mc = (struct acpi_hest_ia_machine_check *)hest_hdr;
76 len = sizeof(*mc) + mc->num_hardware_banks *
77 sizeof(struct acpi_hest_ia_error_bank);
78 } else if (hest_type == ACPI_HEST_TYPE_IA32_DEFERRED_CHECK) {
79 struct acpi_hest_ia_deferred_check *mc;
80 mc = (struct acpi_hest_ia_deferred_check *)hest_hdr;
81 len = sizeof(*mc) + mc->num_hardware_banks *
82 sizeof(struct acpi_hest_ia_error_bank);
89 typedef int (*apei_hest_func_t)(struct acpi_hest_header *hest_hdr, void *data);
91 static int apei_hest_parse(apei_hest_func_t func, void *data)
93 struct acpi_hest_header *hest_hdr;
96 if (hest_disable || !hest_tab)
99 hest_hdr = (struct acpi_hest_header *)(hest_tab + 1);
100 for (i = 0; i < hest_tab->error_source_count; i++) {
101 len = hest_esrc_len(hest_hdr);
103 pr_warn(FW_WARN HEST_PFX
104 "Unknown or unused hardware error source "
105 "type: %d for hardware error source: %d.\n",
106 hest_hdr->type, hest_hdr->source_id);
109 if ((void *)hest_hdr + len >
110 (void *)hest_tab + hest_tab->header.length) {
111 pr_warn(FW_BUG HEST_PFX
112 "Table contents overflow for hardware error source: %d.\n",
113 hest_hdr->source_id);
117 rc = func(hest_hdr, data);
121 hest_hdr = (void *)hest_hdr + len;
128 * Check if firmware advertises firmware first mode. We need FF bit to be set
129 * along with a set of MC banks which work in FF mode.
131 static int __init hest_parse_cmc(struct acpi_hest_header *hest_hdr, void *data)
133 if (hest_hdr->type != ACPI_HEST_TYPE_IA32_CORRECTED_CHECK)
136 if (!acpi_disable_cmcff)
137 return !arch_apei_enable_cmcff(hest_hdr, data);
143 struct platform_device **ghes_devs;
147 static int __init hest_parse_ghes_count(struct acpi_hest_header *hest_hdr, void *data)
151 if (is_generic_error(hest_hdr))
156 static int __init hest_parse_ghes(struct acpi_hest_header *hest_hdr, void *data)
158 struct platform_device *ghes_dev;
159 struct ghes_arr *ghes_arr = data;
162 if (!is_generic_error(hest_hdr))
165 if (!((struct acpi_hest_generic *)hest_hdr)->enabled)
167 for (i = 0; i < ghes_arr->count; i++) {
168 struct acpi_hest_header *hdr;
169 ghes_dev = ghes_arr->ghes_devs[i];
170 hdr = *(struct acpi_hest_header **)ghes_dev->dev.platform_data;
171 if (hdr->source_id == hest_hdr->source_id) {
172 pr_warn(FW_WARN HEST_PFX "Duplicated hardware error source ID: %d.\n",
177 ghes_dev = platform_device_alloc("GHES", hest_hdr->source_id);
181 rc = platform_device_add_data(ghes_dev, &hest_hdr, sizeof(void *));
185 rc = platform_device_add(ghes_dev);
188 ghes_arr->ghes_devs[ghes_arr->count++] = ghes_dev;
192 platform_device_put(ghes_dev);
196 static int __init hest_ghes_dev_register(unsigned int ghes_count)
199 struct ghes_arr ghes_arr;
202 ghes_arr.ghes_devs = kmalloc_array(ghes_count, sizeof(void *),
204 if (!ghes_arr.ghes_devs)
207 rc = apei_hest_parse(hest_parse_ghes, &ghes_arr);
211 rc = ghes_estatus_pool_init(ghes_count);
216 kfree(ghes_arr.ghes_devs);
219 for (i = 0; i < ghes_arr.count; i++)
220 platform_device_unregister(ghes_arr.ghes_devs[i]);
224 static int __init setup_hest_disable(char *str)
226 hest_disable = HEST_DISABLED;
230 __setup("hest_disable", setup_hest_disable);
232 void __init acpi_hest_init(void)
236 unsigned int ghes_count = 0;
239 pr_info(HEST_PFX "Table parsing disabled.\n");
243 status = acpi_get_table(ACPI_SIG_HEST, 0,
244 (struct acpi_table_header **)&hest_tab);
245 if (status == AE_NOT_FOUND) {
246 hest_disable = HEST_NOT_FOUND;
248 } else if (ACPI_FAILURE(status)) {
249 const char *msg = acpi_format_exception(status);
250 pr_err(HEST_PFX "Failed to get table, %s\n", msg);
251 hest_disable = HEST_DISABLED;
255 rc = apei_hest_parse(hest_parse_cmc, NULL);
260 rc = apei_hest_parse(hest_parse_ghes_count, &ghes_count);
265 rc = hest_ghes_dev_register(ghes_count);
270 pr_info(HEST_PFX "Table parsing has been initialized.\n");
273 hest_disable = HEST_DISABLED;
274 acpi_put_table((struct acpi_table_header *)hest_tab);