diff mbox series

[tip:,ras/core] Documentation: Begin a RAS section

Message ID 170189506697.398.1918586195547486556.tip-bot2@tip-bot2
State New
Headers
Series [tip:,ras/core] Documentation: Begin a RAS section |

Commit Message

tip-bot2 for Thomas Gleixner Dec. 6, 2023, 8:37 p.m. UTC 
  The following commit has been merged into the ras/core branch of tip:

Commit-ID:     cf0573939d3f4ce822ceb742a8179f38697b1953
Gitweb:        https://git.kernel.org/tip/cf0573939d3f4ce822ceb742a8179f38697b1953
Author:        Borislav Petkov (AMD) <bp@alien8.de>
AuthorDate:    Tue, 28 Nov 2023 15:20:49 +01:00
Committer:     Borislav Petkov (AMD) <bp@alien8.de>
CommitterDate: Wed, 06 Dec 2023 21:07:52 +01:00

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
---
 Documentation/RAS/ras.rst | 26 ++++++++++++++++++++++++++
 Documentation/index.rst   |  1 +
 2 files changed, 27 insertions(+)
 create mode 100644 Documentation/RAS/ras.rst
diff mbox series

Patch

diff --git a/Documentation/RAS/ras.rst b/Documentation/RAS/ras.rst
new file mode 100644
index 0000000..2556b39
--- /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>
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 9dfdc82..36e6178 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -113,6 +113,7 @@  to ReStructured Text format, or are simply too old.
    :maxdepth: 1
 
    staging/index
+   RAS/ras
 
 
 Translations