Skip to content

Commit cf05739

Browse files
committed
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
1 parent 47b744e commit cf05739

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

Documentation/RAS/ras.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
Reliability, Availability and Serviceability features
4+
=====================================================
5+
6+
This documents different aspects of the RAS functionality present in the
7+
kernel.
8+
9+
Error decoding
10+
---------------
11+
12+
* x86
13+
14+
Error decoding on AMD systems should be done using the rasdaemon tool:
15+
https://github.com/mchehab/rasdaemon/
16+
17+
While the daemon is running, it would automatically log and decode
18+
errors. If not, one can still decode such errors by supplying the
19+
hardware information from the error::
20+
21+
$ rasdaemon -p --status <STATUS> --ipid <IPID> --smca
22+
23+
Also, the user can pass particular family and model to decode the error
24+
string::
25+
26+
$ rasdaemon -p --status <STATUS> --ipid <IPID> --smca --family <CPU Family> --model <CPU Model> --bank <BANK_NUM>

Documentation/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ to ReStructured Text format, or are simply too old.
113113
:maxdepth: 1
114114

115115
staging/index
116+
RAS/ras
116117

117118

118119
Translations

0 commit comments

Comments
 (0)