einj.txt 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. APEI Error INJection
  2. ~~~~~~~~~~~~~~~~~~~~
  3. EINJ provides a hardware error injection mechanism
  4. It is very useful for debugging and testing of other APEI and RAS features.
  5. To use EINJ, make sure the following are enabled in your kernel
  6. configuration:
  7. CONFIG_DEBUG_FS
  8. CONFIG_ACPI_APEI
  9. CONFIG_ACPI_APEI_EINJ
  10. The user interface of EINJ is debug file system, under the
  11. directory apei/einj. The following files are provided.
  12. - available_error_type
  13. Reading this file returns the error injection capability of the
  14. platform, that is, which error types are supported. The error type
  15. definition is as follow, the left field is the error type value, the
  16. right field is error description.
  17. 0x00000001 Processor Correctable
  18. 0x00000002 Processor Uncorrectable non-fatal
  19. 0x00000004 Processor Uncorrectable fatal
  20. 0x00000008 Memory Correctable
  21. 0x00000010 Memory Uncorrectable non-fatal
  22. 0x00000020 Memory Uncorrectable fatal
  23. 0x00000040 PCI Express Correctable
  24. 0x00000080 PCI Express Uncorrectable fatal
  25. 0x00000100 PCI Express Uncorrectable non-fatal
  26. 0x00000200 Platform Correctable
  27. 0x00000400 Platform Uncorrectable non-fatal
  28. 0x00000800 Platform Uncorrectable fatal
  29. The format of file contents are as above, except there are only the
  30. available error type lines.
  31. - error_type
  32. This file is used to set the error type value. The error type value
  33. is defined in "available_error_type" description.
  34. - error_inject
  35. Write any integer to this file to trigger the error
  36. injection. Before this, please specify all necessary error
  37. parameters.
  38. - param1
  39. This file is used to set the first error parameter value. Effect of
  40. parameter depends on error_type specified.
  41. - param2
  42. This file is used to set the second error parameter value. Effect of
  43. parameter depends on error_type specified.
  44. - notrigger
  45. The EINJ mechanism is a two step process. First inject the error, then
  46. perform some actions to trigger it. Setting "notrigger" to 1 skips the
  47. trigger phase, which *may* allow the user to cause the error in some other
  48. context by a simple access to the cpu, memory location, or device that is
  49. the target of the error injection. Whether this actually works depends
  50. on what operations the BIOS actually includes in the trigger phase.
  51. BIOS versions based in the ACPI 4.0 specification have limited options
  52. to control where the errors are injected. Your BIOS may support an
  53. extension (enabled with the param_extension=1 module parameter, or
  54. boot command line einj.param_extension=1). This allows the address
  55. and mask for memory injections to be specified by the param1 and
  56. param2 files in apei/einj.
  57. BIOS versions using the ACPI 5.0 specification have more control over
  58. the target of the injection. For processor related errors (type 0x1,
  59. 0x2 and 0x4) the APICID of the target should be provided using the
  60. param1 file in apei/einj. For memory errors (type 0x8, 0x10 and 0x20)
  61. the address is set using param1 with a mask in param2 (0x0 is equivalent
  62. to all ones). For PCI express errors (type 0x40, 0x80 and 0x100) the
  63. segment, bus, device and function are specified using param1:
  64. 31 24 23 16 15 11 10 8 7 0
  65. +-------------------------------------------------+
  66. | segment | bus | device | function | reserved |
  67. +-------------------------------------------------+
  68. An ACPI 5.0 BIOS may also allow vendor specific errors to be injected.
  69. In this case a file named vendor will contain identifying information
  70. from the BIOS that hopefully will allow an application wishing to use
  71. the vendor specific extension to tell that they are running on a BIOS
  72. that supports it. All vendor extensions have the 0x80000000 bit set in
  73. error_type. A file vendor_flags controls the interpretation of param1
  74. and param2 (1 = PROCESSOR, 2 = MEMORY, 4 = PCI). See your BIOS vendor
  75. documentation for details (and expect changes to this API if vendors
  76. creativity in using this feature expands beyond our expectations).
  77. Example:
  78. # cd /sys/kernel/debug/apei/einj
  79. # cat available_error_type # See which errors can be injected
  80. 0x00000002 Processor Uncorrectable non-fatal
  81. 0x00000008 Memory Correctable
  82. 0x00000010 Memory Uncorrectable non-fatal
  83. # echo 0x12345000 > param1 # Set memory address for injection
  84. # echo 0xfffffffffffff000 > param2 # Mask - anywhere in this page
  85. # echo 0x8 > error_type # Choose correctable memory error
  86. # echo 1 > error_inject # Inject now
  87. For more information about EINJ, please refer to ACPI specification
  88. version 4.0, section 17.5 and ACPI 5.0, section 18.6.