public inbox for linux-acpi@vger.kernel.org
 help / color / mirror / Atom feed
From: Huang Ying <ying.huang@intel.com>
To: lenb@kernel.org
Cc: ak@linux.intel.com, linux-kernel@vger.kernel.org,
	linux-acpi@vger.kernel.org, Huang Ying <ying.huang@intel.com>
Subject: [PATCH 5/5] ACPI, APEI, Document for APEI
Date: Mon, 28 Dec 2009 14:12:24 +0800	[thread overview]
Message-ID: <1261980744-4450-6-git-send-email-ying.huang@intel.com> (raw)
In-Reply-To: <1261980744-4450-5-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>
---
 Documentation/acpi/apei/einj.txt    |   49 +++++++++++++++++++++++++++++++++++
 Documentation/kernel-parameters.txt |    5 +++
 2 files changed, 54 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/acpi/apei/einj.txt

diff --git a/Documentation/acpi/apei/einj.txt b/Documentation/acpi/apei/einj.txt
new file mode 100644
index 0000000..438ef33
--- /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.
diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
index 5ba4d9d..7077cbb 100644
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -338,6 +338,11 @@ and is between 256 and 4096 characters. It is defined in the file
 			not play well with APC CPU idle - disable it if you have
 			APC and your system crashes randomly.
 
+	apei.hest_disable= [ACPI]
+			Disable Hardware Error Source Table (HEST) support,
+			corresponding firmware-first mode error processing
+			logic will be disabled.
+
 	apic=		[APIC,X86-32] Advanced Programmable Interrupt Controller
 			Change the output verbosity whilst booting
 			Format: { quiet (default) | verbose | debug }
-- 
1.6.5


  reply	other threads:[~2009-12-28  6:12 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-12-28  6:12 [PATCH -v3 0/5] ACPI, APEI, APEI basic support Huang Ying
2009-12-28  6:12 ` [PATCH 1/5] ACPI, IO memory pre-mapping and atomic accessing Huang Ying
2009-12-28  6:12   ` [PATCH 2/5] ACPI, APEI, APEI supporting infrastructure Huang Ying
2009-12-28  6:12     ` [PATCH 3/5] ACPI, APEI, HEST table parsing Huang Ying
2009-12-28  6:12       ` [PATCH 4/5] ACPI, APEI, EINJ support Huang Ying
2009-12-28  6:12         ` Huang Ying [this message]
2010-01-06  7:14           ` [PATCH 5/5] ACPI, APEI, Document for APEI Pavel Machek
2010-01-06  7:16             ` Pavel Machek
2010-01-06  7:21               ` Huang Ying
2010-01-07  7:12                 ` Pavel Machek
2010-01-07  7:26                   ` Huang Ying
2010-01-07  7:34                     ` Pavel Machek
2010-01-06  7:08         ` [PATCH 4/5] ACPI, APEI, EINJ support Pavel Machek
2010-01-06  7:16           ` Huang Ying
2010-01-07  7:12             ` Pavel Machek
2009-12-31  1:14     ` git-apply --whitespace (Re: [PATCH 2/5] ACPI, APEI, APEI supporting infrastructure) Len Brown
2009-12-31  1:19       ` Huang Ying
2009-12-31  1:19 ` [PATCH -v3 0/5] ACPI, APEI, APEI basic support 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=1261980744-4450-6-git-send-email-ying.huang@intel.com \
    --to=ying.huang@intel.com \
    --cc=ak@linux.intel.com \
    --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