linux-acpi.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Huang Ying <ying.huang@intel.com>
To: lenb@kernel.org
Cc: linux-kernel@vger.kernel.org, ying.huang@intel.com,
	andi@firstfloor.org, linux-acpi@vger.kernel.org,
	Andi Kleen <ak@linux.intel.com>
Subject: [PATCH -v5 05/14] ACPI, APEI, Document for APEI
Date: Tue, 18 May 2010 14:35:15 +0800	[thread overview]
Message-ID: <1274164524-6092-6-git-send-email-ying.huang@intel.com> (raw)
In-Reply-To: <1274164524-6092-1-git-send-email-ying.huang@intel.com>

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>
---
 Documentation/acpi/apei/einj.txt    |   49 ++++++++++++++++++++++++++++++++++++
 Documentation/kernel-parameters.txt |    5 +++
 2 files changed, 54 insertions(+)
 create mode 100644 Documentation/acpi/apei/einj.txt

--- /dev/null
+++ b/Documentation/acpi/apei/einj.txt
@@ -0,0 +1,49 @@
+			APEI Error INJection
+			~~~~~~~~~~~~~~~~~~~~
+
+EINJ provides a hardware error injection mechanism, it is very useful
+for debugging and testing of other APEI and RAS features.
+
+To use EINJ, make the following is enabled in your kernel
+configuration:
+
+CONFIG_DEBUG_FS
+CONFIG_ACPI_APEI
+CONFIG_ACPI_APEI_EINJ
+
+The user interface of EINJ is in debug file system, under the
+directory apei/einj. The following files are provided.
+
+- available_error_type
+  Read this file will return the error injection capability of the
+  platform, that is, which error types are supported. The error type
+  definition is as follow, the left field is the error type value, the
+  right field is error description.
+
+    0x00000001	Processor Correctable
+    0x00000002	Processor Uncorrectable non-fatal
+    0x00000004	Processor Uncorrectable fatal
+    0x00000008  Memory Correctable
+    0x00000010  Memory Uncorrectable non-fatal
+    0x00000020  Memory Uncorrectable fatal
+    0x00000040	PCI Express Correctable
+    0x00000080	PCI Express Uncorrectable fatal
+    0x00000100	PCI Express Uncorrectable non-fatal
+    0x00000200	Platform Correctable
+    0x00000400	Platform Uncorrectable non-fatal
+    0x00000800	Platform Uncorrectable fatal
+
+  The format of file contents are as above, except there are only the
+  available error type lines.
+
+- error_type
+  This file is used to set the error type value. The error type value
+  is defined in "available_error_type" description.
+
+- error_inject
+  Write any integer to this file to trigger the error
+  injection. Before this, please specify all necessary error
+  parameters.
+
+For more information about EINJ, please refer to ACPI specification
+version 4.0, section 17.5.
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -843,6 +843,11 @@ and is between 256 and 4096 characters.
 	hd=		[EIDE] (E)IDE hard drive subsystem geometry
 			Format: <cyl>,<head>,<sect>
 
+	hest_disable	[ACPI]
+			Disable Hardware Error Source Table (HEST) support,
+			corresponding firmware-first mode error processing
+			logic will be disabled.
+
 	highmem=nn[KMG]	[KNL,BOOT] forces the highmem zone to have an exact
 			size of <nn>. This works even on boxes that have no
 			highmem otherwise. This also works to reduce highmem

  parent reply	other threads:[~2010-05-18  6:35 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-05-18  6:35 [PATCH -v5 00/14] ACPI, APEI support Huang Ying
2010-05-18  6:35 ` [PATCH -v5 01/14] ACPI, IO memory pre-mapping and atomic accessing Huang Ying
2010-05-18  6:35 ` [PATCH -v5 02/14] ACPI, APEI, APEI supporting infrastructure Huang Ying
2010-05-18  6:35 ` [PATCH -v5 03/14] ACPI, APEI, HEST table parsing Huang Ying
2010-05-18  6:35 ` [PATCH -v5 04/14] ACPI, APEI, EINJ support Huang Ying
2010-05-18  6:35 ` Huang Ying [this message]
2010-05-18 21:51   ` [PATCH -v5 05/14] ACPI, APEI, Document for APEI Randy Dunlap
2010-05-19  3:06     ` Huang Ying
2010-05-20  2:39       ` Len Brown
2010-05-20  2:43         ` Huang Ying
2010-05-18  6:35 ` [PATCH -v5 06/14] ACPI, APEI, PCIE AER, use general HEST table parsing in AER firmware_first setup Huang Ying
2010-05-18  6:35 ` [PATCH -v5 07/14] ACPI Hardware Error Device (PNP0C33) support Huang Ying
2010-05-18  6:35 ` [PATCH -v5 08/14] Unified UUID/GUID definition Huang Ying
2010-05-18  6:35 ` [PATCH -v5 09/14] ACPI, APEI, UEFI Common Platform Error Record (CPER) header Huang Ying
2010-05-18  6:35 ` [PATCH -v5 10/14] ACPI, APEI, Generic Hardware Error Source memory error support Huang Ying
2010-05-18  6:35 ` [PATCH -v5 11/14] ACPI, APEI, Error Record Serialization Table (ERST) support Huang Ying
2010-05-18  6:35 ` [PATCH -v5 12/14] ACPI, APEI, Use ERST for persistent storage of MCE Huang Ying
2010-05-18  6:35 ` [PATCH -v5 13/14] Add x64 support to debugfs Huang Ying
2010-05-18  6:35 ` [PATCH -v5 14/14] ACPI, APEI, EINJ injection parameters support Huang Ying
2010-05-18  8:48 ` [PATCH -v5 00/14] ACPI, APEI support Andi Kleen
2010-05-20  2:44 ` Len Brown

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1274164524-6092-6-git-send-email-ying.huang@intel.com \
    --to=ying.huang@intel.com \
    --cc=ak@linux.intel.com \
    --cc=andi@firstfloor.org \
    --cc=lenb@kernel.org \
    --cc=linux-acpi@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).