From: "Borislav Petkov (AMD)" <bp@alien8.de>
Date: Tue, 28 Nov 2023 15:20:49 +0100
Subject: Documentation: Begin a RAS section
Git-commit: cf0573939d3f4ce822ceb742a8179f38697b1953
Patch-mainline: v6.8-rc1
References: jsc#PED-7622
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
Acked-by: Nikolay Borisov <nik.borisov@suse.com>
---
Documentation/RAS/ras.rst | 26 ++++++++++++++++++++++++++
Documentation/index.rst | 1 +
2 files changed, 27 insertions(+)
--- /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>
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -165,6 +165,7 @@ to ReStructured Text format, or are simp
:maxdepth: 2
staging/index
+ RAS/ras
Translations