summaryrefslogtreecommitdiff
path: root/Documentation/RAS
diff options
context:
space:
mode:
authorBorislav Petkov (AMD) <bp@alien8.de>2023-11-28 17:20:49 +0300
committerBorislav Petkov (AMD) <bp@alien8.de>2023-12-06 23:07:52 +0300
commitcf0573939d3f4ce822ceb742a8179f38697b1953 (patch)
treecf377b3f9cd1be13362d476ba55ef787bda667d0 /Documentation/RAS
parent47b744ea5e3cf855087951a74ba9f89180fa1ba5 (diff)
downloadlinux-cf0573939d3f4ce822ceb742a8179f38697b1953.tar.xz
Documentation: Begin a RAS section
Add some initial RAS documentation. The expectation is for this to collect, among others, all the user-visible features for interaction with the RAS features of the kernel. Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de> Link: https://lore.kernel.org/r/20231128142049.GTZWX3QQTSaQk/+u53@fat_crate.local
Diffstat (limited to 'Documentation/RAS')
-rw-r--r--Documentation/RAS/ras.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/Documentation/RAS/ras.rst b/Documentation/RAS/ras.rst
new file mode 100644
index 000000000000..2556b397cd27
--- /dev/null
+++ b/Documentation/RAS/ras.rst
@@ -0,0 +1,26 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Reliability, Availability and Serviceability features
+=====================================================
+
+This documents different aspects of the RAS functionality present in the
+kernel.
+
+Error decoding
+---------------
+
+* x86
+
+Error decoding on AMD systems should be done using the rasdaemon tool:
+https://github.com/mchehab/rasdaemon/
+
+While the daemon is running, it would automatically log and decode
+errors. If not, one can still decode such errors by supplying the
+hardware information from the error::
+
+ $ rasdaemon -p --status <STATUS> --ipid <IPID> --smca
+
+Also, the user can pass particular family and model to decode the error
+string::
+
+ $ rasdaemon -p --status <STATUS> --ipid <IPID> --smca --family <CPU Family> --model <CPU Model> --bank <BANK_NUM>