1			APEI Error INJection
2			~~~~~~~~~~~~~~~~~~~~
3
4EINJ provides a hardware error injection mechanism
5It is very useful for debugging and testing of other APEI and RAS features.
6
7To use EINJ, make sure the following are enabled in your kernel
8configuration:
9
10CONFIG_DEBUG_FS
11CONFIG_ACPI_APEI
12CONFIG_ACPI_APEI_EINJ
13
14The user interface of EINJ is debug file system, under the
15directory apei/einj. The following files are provided.
16
17- available_error_type
18  Reading this file returns the error injection capability of the
19  platform, that is, which error types are supported. The error type
20  definition is as follow, the left field is the error type value, the
21  right field is error description.
22
23    0x00000001	Processor Correctable
24    0x00000002	Processor Uncorrectable non-fatal
25    0x00000004	Processor Uncorrectable fatal
26    0x00000008  Memory Correctable
27    0x00000010  Memory Uncorrectable non-fatal
28    0x00000020  Memory Uncorrectable fatal
29    0x00000040	PCI Express Correctable
30    0x00000080	PCI Express Uncorrectable fatal
31    0x00000100	PCI Express Uncorrectable non-fatal
32    0x00000200	Platform Correctable
33    0x00000400	Platform Uncorrectable non-fatal
34    0x00000800	Platform Uncorrectable fatal
35
36  The format of file contents are as above, except there are only the
37  available error type lines.
38
39- error_type
40  This file is used to set the error type value. The error type value
41  is defined in "available_error_type" description.
42
43- error_inject
44  Write any integer to this file to trigger the error
45  injection. Before this, please specify all necessary error
46  parameters.
47
48- param1
49  This file is used to set the first error parameter value. Effect of
50  parameter depends on error_type specified. For memory error, this is
51  physical memory address.
52
53- param2
54  This file is used to set the second error parameter value. Effect of
55  parameter depends on error_type specified. For memory error, this is
56  physical memory address mask.
57
58For more information about EINJ, please refer to ACPI specification
59version 4.0, section 17.5.
60