2 * APEI Error INJection support
4 * EINJ provides a hardware error injection mechanism, this is useful
5 * for debugging and testing of other APEI and RAS features.
7 * For more information about EINJ, please refer to ACPI Specification
8 * version 4.0, section 17.5.
10 * Copyright 2009-2010 Intel Corp.
11 * Author: Huang Ying <ying.huang@intel.com>
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License version
15 * 2 as published by the Free Software Foundation.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/init.h>
31 #include <linux/debugfs.h>
32 #include <linux/seq_file.h>
33 #include <linux/nmi.h>
34 #include <linux/delay.h>
35 #include <acpi/acpi.h>
37 #include "apei-internal.h"
39 #define EINJ_PFX "EINJ: "
41 #define SPIN_UNIT 100 /* 100ns */
42 /* Firmware should respond within 1 milliseconds */
43 #define FIRMWARE_TIMEOUT (1 * NSEC_PER_MSEC)
46 * Some BIOSes allow parameters to the SET_ERROR_TYPE entries in the
47 * EINJ table through an unpublished extension. Use with caution as
48 * most will ignore the parameter and make their own choice of address
49 * for error injection. This extension is used only if
50 * param_extension module parameter is specified.
52 struct einj_parameter {
60 #define EINJ_OP_BUSY 0x1
61 #define EINJ_STATUS_SUCCESS 0x0
62 #define EINJ_STATUS_FAIL 0x1
63 #define EINJ_STATUS_INVAL 0x2
65 #define EINJ_TAB_ENTRY(tab) \
66 ((struct acpi_whea_header *)((char *)(tab) + \
67 sizeof(struct acpi_table_einj)))
69 static bool param_extension;
70 module_param(param_extension, bool, 0);
72 static struct acpi_table_einj *einj_tab;
74 static struct apei_resources einj_resources;
76 static struct apei_exec_ins_type einj_ins_type[] = {
77 [ACPI_EINJ_READ_REGISTER] = {
78 .flags = APEI_EXEC_INS_ACCESS_REGISTER,
79 .run = apei_exec_read_register,
81 [ACPI_EINJ_READ_REGISTER_VALUE] = {
82 .flags = APEI_EXEC_INS_ACCESS_REGISTER,
83 .run = apei_exec_read_register_value,
85 [ACPI_EINJ_WRITE_REGISTER] = {
86 .flags = APEI_EXEC_INS_ACCESS_REGISTER,
87 .run = apei_exec_write_register,
89 [ACPI_EINJ_WRITE_REGISTER_VALUE] = {
90 .flags = APEI_EXEC_INS_ACCESS_REGISTER,
91 .run = apei_exec_write_register_value,
95 .run = apei_exec_noop,
100 * Prevent EINJ interpreter to run simultaneously, because the
101 * corresponding firmware implementation may not work properly when
102 * invoked simultaneously.
104 static DEFINE_MUTEX(einj_mutex);
106 static struct einj_parameter *einj_param;
109 static inline void writeq(__u64 val, volatile void __iomem *addr)
112 writel(val >> 32, addr+4);
116 static void einj_exec_ctx_init(struct apei_exec_context *ctx)
118 apei_exec_ctx_init(ctx, einj_ins_type, ARRAY_SIZE(einj_ins_type),
119 EINJ_TAB_ENTRY(einj_tab), einj_tab->entries);
122 static int __einj_get_available_error_type(u32 *type)
124 struct apei_exec_context ctx;
127 einj_exec_ctx_init(&ctx);
128 rc = apei_exec_run(&ctx, ACPI_EINJ_GET_ERROR_TYPE);
131 *type = apei_exec_ctx_get_output(&ctx);
136 /* Get error injection capabilities of the platform */
137 static int einj_get_available_error_type(u32 *type)
141 mutex_lock(&einj_mutex);
142 rc = __einj_get_available_error_type(type);
143 mutex_unlock(&einj_mutex);
148 static int einj_timedout(u64 *t)
150 if ((s64)*t < SPIN_UNIT) {
151 pr_warning(FW_WARN EINJ_PFX
152 "Firmware does not respond in time\n");
157 touch_nmi_watchdog();
161 static u64 einj_get_parameter_address(void)
165 struct acpi_whea_header *entry;
167 entry = EINJ_TAB_ENTRY(einj_tab);
168 for (i = 0; i < einj_tab->entries; i++) {
169 if (entry->action == ACPI_EINJ_SET_ERROR_TYPE &&
170 entry->instruction == ACPI_EINJ_WRITE_REGISTER &&
171 entry->register_region.space_id ==
172 ACPI_ADR_SPACE_SYSTEM_MEMORY)
173 memcpy(&paddr, &entry->register_region.address,
181 /* do sanity check to trigger table */
182 static int einj_check_trigger_header(struct acpi_einj_trigger *trigger_tab)
184 if (trigger_tab->header_size != sizeof(struct acpi_einj_trigger))
186 if (trigger_tab->table_size > PAGE_SIZE ||
187 trigger_tab->table_size <= trigger_tab->header_size)
189 if (trigger_tab->entry_count !=
190 (trigger_tab->table_size - trigger_tab->header_size) /
191 sizeof(struct acpi_einj_entry))
197 /* Execute instructions in trigger error action table */
198 static int __einj_error_trigger(u64 trigger_paddr)
200 struct acpi_einj_trigger *trigger_tab = NULL;
201 struct apei_exec_context trigger_ctx;
202 struct apei_resources trigger_resources;
203 struct acpi_whea_header *trigger_entry;
208 r = request_mem_region(trigger_paddr, sizeof(*trigger_tab),
209 "APEI EINJ Trigger Table");
212 "Can not request [mem %#010llx-%#010llx] for Trigger table\n",
213 (unsigned long long)trigger_paddr,
214 (unsigned long long)trigger_paddr +
215 sizeof(*trigger_tab) - 1);
218 trigger_tab = ioremap_cache(trigger_paddr, sizeof(*trigger_tab));
220 pr_err(EINJ_PFX "Failed to map trigger table!\n");
223 rc = einj_check_trigger_header(trigger_tab);
225 pr_warning(FW_BUG EINJ_PFX
226 "The trigger error action table is invalid\n");
230 table_size = trigger_tab->table_size;
231 r = request_mem_region(trigger_paddr + sizeof(*trigger_tab),
232 table_size - sizeof(*trigger_tab),
233 "APEI EINJ Trigger Table");
236 "Can not request [mem %#010llx-%#010llx] for Trigger Table Entry\n",
237 (unsigned long long)trigger_paddr + sizeof(*trigger_tab),
238 (unsigned long long)trigger_paddr + table_size - 1);
241 iounmap(trigger_tab);
242 trigger_tab = ioremap_cache(trigger_paddr, table_size);
244 pr_err(EINJ_PFX "Failed to map trigger table!\n");
247 trigger_entry = (struct acpi_whea_header *)
248 ((char *)trigger_tab + sizeof(struct acpi_einj_trigger));
249 apei_resources_init(&trigger_resources);
250 apei_exec_ctx_init(&trigger_ctx, einj_ins_type,
251 ARRAY_SIZE(einj_ins_type),
252 trigger_entry, trigger_tab->entry_count);
253 rc = apei_exec_collect_resources(&trigger_ctx, &trigger_resources);
256 rc = apei_resources_sub(&trigger_resources, &einj_resources);
259 rc = apei_resources_request(&trigger_resources, "APEI EINJ Trigger");
262 rc = apei_exec_pre_map_gars(&trigger_ctx);
266 rc = apei_exec_run(&trigger_ctx, ACPI_EINJ_TRIGGER_ERROR);
268 apei_exec_post_unmap_gars(&trigger_ctx);
270 apei_resources_release(&trigger_resources);
272 apei_resources_fini(&trigger_resources);
274 release_mem_region(trigger_paddr + sizeof(*trigger_tab),
275 table_size - sizeof(*trigger_tab));
277 release_mem_region(trigger_paddr, sizeof(*trigger_tab));
280 iounmap(trigger_tab);
285 static int __einj_error_inject(u32 type, u64 param1, u64 param2)
287 struct apei_exec_context ctx;
288 u64 val, trigger_paddr, timeout = FIRMWARE_TIMEOUT;
291 einj_exec_ctx_init(&ctx);
293 rc = apei_exec_run_optional(&ctx, ACPI_EINJ_BEGIN_OPERATION);
296 apei_exec_ctx_set_input(&ctx, type);
297 rc = apei_exec_run(&ctx, ACPI_EINJ_SET_ERROR_TYPE);
301 writeq(param1, &einj_param->param1);
302 writeq(param2, &einj_param->param2);
304 rc = apei_exec_run(&ctx, ACPI_EINJ_EXECUTE_OPERATION);
308 rc = apei_exec_run(&ctx, ACPI_EINJ_CHECK_BUSY_STATUS);
311 val = apei_exec_ctx_get_output(&ctx);
312 if (!(val & EINJ_OP_BUSY))
314 if (einj_timedout(&timeout))
317 rc = apei_exec_run(&ctx, ACPI_EINJ_GET_COMMAND_STATUS);
320 val = apei_exec_ctx_get_output(&ctx);
321 if (val != EINJ_STATUS_SUCCESS)
324 rc = apei_exec_run(&ctx, ACPI_EINJ_GET_TRIGGER_TABLE);
327 trigger_paddr = apei_exec_ctx_get_output(&ctx);
328 rc = __einj_error_trigger(trigger_paddr);
331 rc = apei_exec_run_optional(&ctx, ACPI_EINJ_END_OPERATION);
336 /* Inject the specified hardware error */
337 static int einj_error_inject(u32 type, u64 param1, u64 param2)
341 mutex_lock(&einj_mutex);
342 rc = __einj_error_inject(type, param1, param2);
343 mutex_unlock(&einj_mutex);
348 static u32 error_type;
349 static u64 error_param1;
350 static u64 error_param2;
351 static struct dentry *einj_debug_dir;
353 static int available_error_type_show(struct seq_file *m, void *v)
356 u32 available_error_type = 0;
358 rc = einj_get_available_error_type(&available_error_type);
361 if (available_error_type & 0x0001)
362 seq_printf(m, "0x00000001\tProcessor Correctable\n");
363 if (available_error_type & 0x0002)
364 seq_printf(m, "0x00000002\tProcessor Uncorrectable non-fatal\n");
365 if (available_error_type & 0x0004)
366 seq_printf(m, "0x00000004\tProcessor Uncorrectable fatal\n");
367 if (available_error_type & 0x0008)
368 seq_printf(m, "0x00000008\tMemory Correctable\n");
369 if (available_error_type & 0x0010)
370 seq_printf(m, "0x00000010\tMemory Uncorrectable non-fatal\n");
371 if (available_error_type & 0x0020)
372 seq_printf(m, "0x00000020\tMemory Uncorrectable fatal\n");
373 if (available_error_type & 0x0040)
374 seq_printf(m, "0x00000040\tPCI Express Correctable\n");
375 if (available_error_type & 0x0080)
376 seq_printf(m, "0x00000080\tPCI Express Uncorrectable non-fatal\n");
377 if (available_error_type & 0x0100)
378 seq_printf(m, "0x00000100\tPCI Express Uncorrectable fatal\n");
379 if (available_error_type & 0x0200)
380 seq_printf(m, "0x00000200\tPlatform Correctable\n");
381 if (available_error_type & 0x0400)
382 seq_printf(m, "0x00000400\tPlatform Uncorrectable non-fatal\n");
383 if (available_error_type & 0x0800)
384 seq_printf(m, "0x00000800\tPlatform Uncorrectable fatal\n");
389 static int available_error_type_open(struct inode *inode, struct file *file)
391 return single_open(file, available_error_type_show, NULL);
394 static const struct file_operations available_error_type_fops = {
395 .open = available_error_type_open,
398 .release = single_release,
401 static int error_type_get(void *data, u64 *val)
408 static int error_type_set(void *data, u64 val)
411 u32 available_error_type = 0;
413 /* Only one error type can be specified */
416 rc = einj_get_available_error_type(&available_error_type);
419 if (!(val & available_error_type))
426 DEFINE_SIMPLE_ATTRIBUTE(error_type_fops, error_type_get,
427 error_type_set, "0x%llx\n");
429 static int error_inject_set(void *data, u64 val)
434 return einj_error_inject(error_type, error_param1, error_param2);
437 DEFINE_SIMPLE_ATTRIBUTE(error_inject_fops, NULL,
438 error_inject_set, "%llu\n");
440 static int einj_check_table(struct acpi_table_einj *einj_tab)
442 if ((einj_tab->header_length !=
443 (sizeof(struct acpi_table_einj) - sizeof(einj_tab->header)))
444 && (einj_tab->header_length != sizeof(struct acpi_table_einj)))
446 if (einj_tab->header.length < sizeof(struct acpi_table_einj))
448 if (einj_tab->entries !=
449 (einj_tab->header.length - sizeof(struct acpi_table_einj)) /
450 sizeof(struct acpi_einj_entry))
456 static int __init einj_init(void)
461 struct dentry *fentry;
462 struct apei_exec_context ctx;
467 status = acpi_get_table(ACPI_SIG_EINJ, 0,
468 (struct acpi_table_header **)&einj_tab);
469 if (status == AE_NOT_FOUND)
471 else if (ACPI_FAILURE(status)) {
472 const char *msg = acpi_format_exception(status);
473 pr_err(EINJ_PFX "Failed to get table, %s\n", msg);
477 rc = einj_check_table(einj_tab);
479 pr_warning(FW_BUG EINJ_PFX "EINJ table is invalid\n");
484 einj_debug_dir = debugfs_create_dir("einj", apei_get_debugfs_dir());
487 fentry = debugfs_create_file("available_error_type", S_IRUSR,
488 einj_debug_dir, NULL,
489 &available_error_type_fops);
492 fentry = debugfs_create_file("error_type", S_IRUSR | S_IWUSR,
493 einj_debug_dir, NULL, &error_type_fops);
496 fentry = debugfs_create_file("error_inject", S_IWUSR,
497 einj_debug_dir, NULL, &error_inject_fops);
501 apei_resources_init(&einj_resources);
502 einj_exec_ctx_init(&ctx);
503 rc = apei_exec_collect_resources(&ctx, &einj_resources);
506 rc = apei_resources_request(&einj_resources, "APEI EINJ");
509 rc = apei_exec_pre_map_gars(&ctx);
512 if (param_extension) {
513 param_paddr = einj_get_parameter_address();
515 einj_param = ioremap(param_paddr, sizeof(*einj_param));
519 fentry = debugfs_create_x64("param1", S_IRUSR | S_IWUSR,
520 einj_debug_dir, &error_param1);
523 fentry = debugfs_create_x64("param2", S_IRUSR | S_IWUSR,
524 einj_debug_dir, &error_param2);
528 pr_warn(EINJ_PFX "Parameter extension is not supported.\n");
531 pr_info(EINJ_PFX "Error INJection is initialized.\n");
538 apei_exec_post_unmap_gars(&ctx);
540 apei_resources_release(&einj_resources);
542 apei_resources_fini(&einj_resources);
544 debugfs_remove_recursive(einj_debug_dir);
549 static void __exit einj_exit(void)
551 struct apei_exec_context ctx;
555 einj_exec_ctx_init(&ctx);
556 apei_exec_post_unmap_gars(&ctx);
557 apei_resources_release(&einj_resources);
558 apei_resources_fini(&einj_resources);
559 debugfs_remove_recursive(einj_debug_dir);
562 module_init(einj_init);
563 module_exit(einj_exit);
565 MODULE_AUTHOR("Huang Ying");
566 MODULE_DESCRIPTION("APEI Error INJection support");
567 MODULE_LICENSE("GPL");