Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.33 as permitted sender) client-ip=23.128.96.33;
Message-ID: <5ddaa55a-a979-447b-a12b-31a76eeba104@amd.com>
Date:   Tue, 28 Nov 2023 10:23:21 -0500
User-Agent: Mozilla Thunderbird
Cc:     yazen.ghannam@amd.com, Muralidhara M K <muralimk@amd.com>,
        linux-edac@vger.kernel.org, linux-kernel@vger.kernel.org,
        Muralidhara M K <muralidhara.mk@amd.com>,
        linux-doc@vger.kernel.org
Subject: Re: [PATCH] Documentation: Begin a RAS section
Content-Language: en-US
To:     Borislav Petkov <bp@alien8.de>, Tony Luck <tony.luck@intel.com>
References: <20231102114225.2006878-1-muralimk@amd.com>
 <20231102114225.2006878-2-muralimk@amd.com>
 <20231128142049.GTZWX3QQTSaQk/+u53@fat_crate.local>
From:   Yazen Ghannam <yazen.ghannam@amd.com>
In-Reply-To: <20231128142049.GTZWX3QQTSaQk/+u53@fat_crate.local>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?bEs0N09JeUJzdGRoajZ6WkRTczgrbFMzemVKWVFYTkxhYlBsYjh0c0FtcUhD?=
 =?utf-8?B?UFk4dTNwcEpGQlhDTFF0VmJ1L2NQK0pDT0FOSUs1Tzc1OHpGa2taQjNXVUhC?=
 =?utf-8?B?dzViVVV5N1BRUXZYRVg4NXZHYndjRC9jbk1QMGx0RkU4ckcxaW5tY2Q5R1pM?=
 =?utf-8?B?Qnk0NlpaT1gyWjVCdDk5K1N1Z0dtajJVZEg5aHkvLzBwZGM5OFp4OFd2aHhO?=
 =?utf-8?B?ckxIZHhPZnM0dkxMTHhhY1JHK1IrTmVBNXdxRzlSczNBb2lRY29LTkhNZTB5?=
 =?utf-8?B?djNseDZrbVhUTjFOa3c3ZnpxU1VabmRnbEVQZTJRVEQ1Wnd0dURMT2JLbTBG?=
 =?utf-8?B?ck5mVUxKcndxS1VpWW9BRFN0elNPS2VrV2phNU1NQ2l1SEVnMGhISnZTcmhG?=
 =?utf-8?B?elA4aERqUG1CUlRWc3FEUnNOOHlaTXVESXZLMXNGZmtLNG9CWnFNbi9qZlpa?=
 =?utf-8?B?aE9HTUhXMTVWTEVQejBrUWhjOHZzNk14SjhUbUIzK2p4ZXMvOUZseWtOaTUy?=
 =?utf-8?B?M1ZWdDZKd3UyTVBzMzFMRlhWMTQvSkttek44VFhvU1lZSVExTWpaWXhHZVpD?=
 =?utf-8?B?cTlRU2kyN0xtTlByQ0pzd2gzL0MxTVpSajBaU0U1YmIrSkU4dElBQ2ZESFVr?=
 =?utf-8?B?eENSMTRWOFNSckFPYVJtMjUzSWk0UHVxRVFSZFJ0R3NMaUJpTDFVODQ3eTc0?=
 =?utf-8?B?NlV3TWcrTzJISjB6UmNOV0ZOSG56TURMS05Vbjdtb1VmVlVISVlRY2M0TGd5?=
 =?utf-8?B?Vlo3UkRpMnhaOFp4ZHdYdjlQN2pWa3NqWmtZMllhWThqVU0rVzRlQ2w2Q3Rl?=
 =?utf-8?B?WG50c2Noc0JqN0MwSXo5dWJoZmVxZjU3NDlNaS91bDBFUHVPWmxKYmdSS2hG?=
 =?utf-8?B?QTVac25scU9HVTJaYzBDOTc1MnpuZGRnSStSRTM3VUhock9Fd010Q2ZFVkxM?=
 =?utf-8?B?bnBTeXNwdkFTbUlLTTdzQ3M4WndJL0tad2tkeElTS1NLbFdkbnVYQ0RLTGhz?=
 =?utf-8?B?MzdEbm1LL2xwajBpK1N4Rzl1QlRMM2VvU2lPNGtJN1RPY29KMFdrUEhzS1Z4?=
 =?utf-8?B?QTBEdHZ1SDFhRUNqREl5VW1zbTIvWlZFVjlYL2E2MjJCSElsbFVPbndvSWJF?=
 =?utf-8?B?WGpiRG82YUxNUGZPQjVwYkxZNGxEMGV2aUVEL1drQ3B5emhVZGZ5WDloemNO?=
 =?utf-8?B?bnkyYUYvOHhwaXNiWHhGMGRlOUV4eXB0MmtpUHViencrNnBIZ1BKZFNEZnZF?=
 =?utf-8?B?MjNyMXVjSXpZMjMvdFRLUkJjbHlhTGhNUGs2WU1VTmwyazJWUFBkK3FHUUo4?=
 =?utf-8?B?VTd5eWZ3aTc3RDhPNjdOQ3hTaDdmYWl0azNJTTk2TGgxeXJ5YXFDU3BnRzVH?=
 =?utf-8?B?aDlhTnloSUUwbVZkY2tXcEYzS2M2MFdSV0RtMmhQVnJaVFJhWCtWN3lTRHkv?=
 =?utf-8?B?QTZHcTlqNkhEb2JXRXZDc3h6eFAwVlk3YVQ4UVFqYkFzdnF4Nk0yanAzMnRP?=
 =?utf-8?B?NjNSMjFGc3M0UFhicUp3WEVhemNkcjRpQStveTgwOW5xc0Q5VmRPOXE3Vksx?=
 =?utf-8?B?UHJ4eUFkU2o1VWs4SEo0b3hHR0drNlNabDdSWEpwLzRkYUtsWk9zeGk0RlZa?=
 =?utf-8?B?dzc1bHlGVWIwckZIZEhmY0l0YmNLcllFd2c3QW95RTRaekhwdU9JcXpsMms2?=
 =?utf-8?B?OWdxUC9ZOXFEVDZmekFHaW1hcHRFeWduaTh0RWQySXBack9xenJHZXBVWUlX?=
 =?utf-8?B?RXFqVldvM1hpSm5aSjB6TE1QdFN2QUJ0bVc3KzljbDhxVFVXT0RqRG92ZjRs?=
 =?utf-8?B?TERzOVh1bTlOa05JWm0ycG1oUmFqOVV2SW5Fd0E2aURoTDlYWG9sbmUyZGlm?=
 =?utf-8?B?azNpS25SUHVGN2pxUUtkUXZJcHM4T2VmL3VUaSttYzNYQ2RCanZIY2NnVUlW?=
 =?utf-8?B?ejROaXZ4R0djaG5JTHdvQjRyajF0M2IrNW5Eb0hvTnd4ZDVjbHFuWmtVRlhy?=
 =?utf-8?B?OFJEbDNXa1JHVFlTdklldkt2bWxncDlQbDhwcjEwOHNJckM0T1FNdERvNURS?=
 =?utf-8?B?SnRGWnpibmk0VkRFbEg0b1hrUVhyOUpSRmFzaU41Wjd3TWNXeWphWFdCNG5V?=
 =?utf-8?Q?iA2roo/DExcBC8H1o8EipBzhw?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: a47fea2e-66b6-4f45-4fe8-08dbf025f602
X-MS-Exchange-CrossTenant-AuthSource: BN8PR12MB3108.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 Nov 2023 15:23:23.7808
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: fUgPTNaj81BhKgDMqdvWSXgrrFm2F1Ya6zuNk9gjOnAAXBxT5JLMMwMntvT5D9TvwSrCm5d31R1CnQGyZubEKQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS0PR12MB8575
X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE
	autolearn=unavailable autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lipwig.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (lipwig.vger.email [0.0.0.0]); Tue, 28 Nov 2023 07:23:39 -0800 (PST)

On 11/28/2023 9:20 AM, Borislav Petkov wrote:
> On Thu, Nov 02, 2023 at 11:42:22AM +0000, Muralidhara M K wrote:
>> From: Muralidhara M K <muralidhara.mk@amd.com>
>>
>> AMD systems with Scalable MCA, each machine check error of a SMCA bank
>> type has an associated bit position in the bank's control (CTL) register.
> 
> Ontop of this. It is long overdue:
> 
> ---
> From: "Borislav Petkov (AMD)" <bp@alien8.de>
> Date: Tue, 28 Nov 2023 14:37:56 +0100
> 
> Add some initial RAS documentation. The expectation is for this to
> collect all the user-visible features for interacting with the RAS
> features of the kernel.
> 
> Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de>
> ---
>   Documentation/RAS/ras.rst | 26 ++++++++++++++++++++++++++
>   Documentation/index.rst   |  1 +
>   2 files changed, 27 insertions(+)
>   create mode 100644 Documentation/RAS/ras.rst
> 
> 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>
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 9dfdc826618c..36e61783437c 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

Thanks for starting this. I'll add some notes for the AMD Address 
Translation Library in the next revision.

Thanks,
Yazen