Commit ea8c071cad789b1919355fc7a67182a5c9994e6b

Authored by Huang Ying
Committed by Len Brown
1 parent e40213450b

ACPI, APEI, Document for APEI

Add document for APEI, including kernel parameters and EINJ debug file
sytem interface.

Signed-off-by: Huang Ying <ying.huang@intel.com>
Signed-off-by: Andi Kleen <ak@linux.intel.com>
Signed-off-by: Len Brown <len.brown@intel.com>

Showing 2 changed files with 54 additions and 0 deletions Side-by-side Diff

Documentation/acpi/apei/einj.txt
  1 + APEI Error INJection
  2 + ~~~~~~~~~~~~~~~~~~~~
  3 +
  4 +EINJ provides a hardware error injection mechanism
  5 +It is very useful for debugging and testing of other APEI and RAS features.
  6 +
  7 +To use EINJ, make sure the following are enabled in your kernel
  8 +configuration:
  9 +
  10 +CONFIG_DEBUG_FS
  11 +CONFIG_ACPI_APEI
  12 +CONFIG_ACPI_APEI_EINJ
  13 +
  14 +The user interface of EINJ is debug file system, under the
  15 +directory 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 +For more information about EINJ, please refer to ACPI specification
  49 +version 4.0, section 17.5.
Documentation/kernel-parameters.txt
... ... @@ -843,6 +843,11 @@
843 843 hd= [EIDE] (E)IDE hard drive subsystem geometry
844 844 Format: <cyl>,<head>,<sect>
845 845  
  846 + hest_disable [ACPI]
  847 + Disable Hardware Error Source Table (HEST) support;
  848 + corresponding firmware-first mode error processing
  849 + logic will be disabled.
  850 +
846 851 highmem=nn[KMG] [KNL,BOOT] forces the highmem zone to have an exact
847 852 size of <nn>. This works even on boxes that have no
848 853 highmem otherwise. This also works to reduce highmem