aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorShuai Xue <xueshuai@linux.alibaba.com>2022-10-12 21:41:43 +0800
committerTony Luck <tony.luck@intel.com>2022-10-13 10:03:28 -0700
commitae751087afe12f98c573581eb06ee0583245f5fd (patch)
treef70fa59625a6de28ce63fa73f32a2379ada8cf83
parent7424ca7e42b45115462d8c9bfe89364c3ec33d2b (diff)
downloadras-tools-ae751087afe12f98c573581eb06ee0583245f5fd.tar.gz
README: add a brief introduction of ras-tools
Tony: Cherry-picked from https://gitee.com/anolis/ras-tools.git with the last paragraph about being a clone of this repo dropped. Signed-off-by: Shuai Xue <xueshuai@linux.alibaba.com> Signed-off-by: Tony Luck <tony.luck@intel.com>
-rw-r--r--README21
1 files changed, 21 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..da17edd
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+## ras-tools
+
+ras-tools are an excellent set of tools to inject and test RAS ability on X86
+and Arm platform through APEI EINJ interface.
+
+## Brief Introduction
+
+Common tools on both X86 and Arm platform:
+
+- rep_ce_page: injects and consumes corrected errors from a single page
+until either the page is taken offline (and replaced) by the OS, or
+a limit of 30 tries is reached.
+- mca-recover: an example recovery application shows how to setup a SIGBUS handler for recoverable machine checks.
+- cmcistorm: inject a bunch of corrected errors, then trigger them all quickly.
+- hornet: inject a UC memory error into some other process.
+- einj_mem_uc: inject an error and then trigger it in one of a variety of ways.
+
+Arm platform specific drivers:
+
+- memattr: a test suit to poison specific memory attribute.
+- ras-tolerance: a driver to overwrite error severity to a lower level at runtime.