Received-SPF: pass (google.com: domain of linux-kernel+bounces-186521-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Message-ID: <c68e02f8-2929-4719-a507-d8115523bbd9@amd.com>
Date: Wed, 22 May 2024 11:50:53 -0500
User-Agent: Mozilla Thunderbird
Subject: Re: [RFC PATCH v2 8/8] ACPI: APEI: EINJ: Update the documentation for
 EINJv2 support
To: Zaid Alali <zaidal@os.amperecomputing.com>, rafael@kernel.org,
 lenb@kernel.org, james.morse@arm.com, tony.luck@intel.com, bp@alien8.de,
 robert.moore@intel.com, Jonathan.Cameron@huawei.com,
 dan.j.williams@intel.com, arnd@arndb.de, Avadhut.Naik@amd.com,
 u.kleine-koenig@pengutronix.de, john.allen@amd.com,
 linux-acpi@vger.kernel.org, linux-kernel@vger.kernel.org,
 acpica-devel@lists.linux.dev
References: <20240521211036.227674-1-zaidal@os.amperecomputing.com>
 <20240521211036.227674-9-zaidal@os.amperecomputing.com>
Content-Language: en-US
From: Ben Cheatham <benjamin.cheatham@amd.com>
In-Reply-To: <20240521211036.227674-9-zaidal@os.amperecomputing.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?akNNOXk3UXl6K1phYWF6ZFhEUEJSTis3R0NjNHRrY1FBZ2FFMkJ2eC8vZlly?=
 =?utf-8?B?MUJMR1FlY3g2eHhzT3N0dWZTcWdLeG1sRHk5a0t0VVUxMmkyL0Q3ak15ZE5u?=
 =?utf-8?B?WWZMcUZOSTNiQmIxOEJ4aEVsS0QxUHVEeTR4ZUpET0p1YUVYL0ZyZjNJT1Z1?=
 =?utf-8?B?R2R6TWxHUHYvaWNEdEhURm9WT29oTS9hUU9QL0dObWd5aEtmeFlidXhRQW9D?=
 =?utf-8?B?N3dlOFR0ZGFMemh3c3lCSENoS2hINVdQb3ZOcXhJY0UwcDRqbXNMVXAvSVha?=
 =?utf-8?B?TVFFY2JkSTVmZmN2RVRtRlllamNaSlZwNkZFRW5GY1FnZWExRktOZXFWUElY?=
 =?utf-8?B?eitUZ1kyQU03UHRzRU5MelVPMERTL1NEQ0oveWtraFN1NHl1bXYxZC9INGZt?=
 =?utf-8?B?Y1pQVHVsc0ZIL1dSR2xSNC96czhENmNHRXR1Z3l1SEpvNlFkNUk0MlowTlU4?=
 =?utf-8?B?WklPTEJ0OVJSNngxLytTSWhvNlpScFVkLzduQkN0a2YrWVRwVlgyZ25ISThR?=
 =?utf-8?B?eVFWTnJoME9uNjd5UTZkc2dhR0ZHVERIWkF1czR1SHB4dXF0OVJwNWJjSGlT?=
 =?utf-8?B?UGlJMDF4TEZNalFHY0xBVENyOFdyUmE0WTc3M2dudklRelltVThhbFg2WXBq?=
 =?utf-8?B?UW5wcXhPK2RaSjlTdHkvQmp6TzBtZ1pxNmZObHUvSHNDVVBRRDlhTUpBaFpK?=
 =?utf-8?B?TzFIMkQ3ZXZJK0dBS1JzaVZBeHN1R0w0bnJ4RHMyblJ2RDVjTDNSUU5EdkJm?=
 =?utf-8?B?RWxjRmsvWjZZZzhQWWV2L2ZLd3QrSHV1MjdiRzVDUm1JaFgxclBUZlJvWi9i?=
 =?utf-8?B?QUJmR0RaOFVJc1JzV0lLNC9kRUtvQjVvN242cDZHaEhQRTBLMnBjd202UTgy?=
 =?utf-8?B?QXo2VnpsbWg3cVJSUGhTQWhnb2E4bW1FVUdic29BM0ZjcTBkUmRjdmtDTGpz?=
 =?utf-8?B?bU80V2lmdStvYnJHRFdMVW9sVkR1dHBCMFRZUmJBeGZ3cGFxek1TTVowYmJw?=
 =?utf-8?B?M013QWJyV3lZWTJ3SEdYcUcrR2EwZzFaQW81cDY2Z3J0NmdHOUZFclpFSmZV?=
 =?utf-8?B?TFJsSmYvWUVnNmI0WE1PTXplNmp0T25zNml2NkltTEllRFZydTM0NFdrakxE?=
 =?utf-8?B?NDhkdTlTa3ZaTjdYNW4xN2o2NkJjOXBDNm9YQXU2cnBCZTRZWHphK1ArMi9W?=
 =?utf-8?B?S2wxS3RVRklMSE5hSjh3Y043NDF2ejZVakdpNTY0b3NWM2JuK2FQSFQ0cjI3?=
 =?utf-8?B?TFlyUmFOZ1k0U1BmNzBjYm9VQmRuMEZwc25vSXdQMTFUc3MzakNtdWEvQ1ZE?=
 =?utf-8?B?TWNvSlpwK0luUGVrK0hGV2pjYXd4NnhzYUkyUVVrejN4QVp0eEFTWFNGKzVk?=
 =?utf-8?B?Z0lTVHJvdkF6eEpFdVpsZ2hPeHBJOVljYU5WZ3RRYWNJM2tWbjgxMk8rbHJo?=
 =?utf-8?B?VjVBcTZ5S3orUXNUeXpEMmRVeHM1bjFhRlYyMHhCNkJGNWx2aWVEbFgwNmNp?=
 =?utf-8?B?UjVCNXkzTld6ak5Jb3h0cFRnYjQ4a1BPb2ZWRWVabFVWaklqUVVUVys1SUVV?=
 =?utf-8?B?Z0Ewc3lRTk9rYjdkTUJsTUhVRUpjVzl0YzZZT3BpUFBjQnZVanFsTEdjMVRB?=
 =?utf-8?B?Qk5WUTFrR3BhSjlSVlVHRTVRWVpZdHIxclZxekdsQ0VVY05XNExzR05Za2l6?=
 =?utf-8?B?dkg4M0d1MFd5MHlKbHI3VVJ2ZEo5MGEzak1pd244T0RQMFk5bks1RHBleVlC?=
 =?utf-8?B?dkVDWll4M1JtaVZQM1B0Sy9uVW9nMWt0bDBHdWpLcWM2eGRMNEJOZjArME1Y?=
 =?utf-8?B?WjhVMjg4RGZOelBHb0hqdGVOS2ppMlBValVnYXp4b2V1c1RHVEZmMlhTRjZQ?=
 =?utf-8?B?U3RzTUd0anhSazQxZEQvUk02NDkvTFlWNVZoMVhzMDZZYitlNmpNSWVIa2k4?=
 =?utf-8?B?RzhpTlpqVGZzM3BYcGZxR1dLZWYvM3RKbTd2WXJSZWh5cnhsWWdyUWhQV2Z3?=
 =?utf-8?B?c0t6MmVuR0hjVEN5enNYOThCei9rZ0huT2FGeTFHNmpCam40ZEl1UG52cEdR?=
 =?utf-8?B?WUFVQnZiOFY1WFIyaVVsN3g2OGN3LzNHMlpJZHUvODQ2dFp4ckNJRm1kYncy?=
 =?utf-8?Q?81pOgJ+rge+krFQcj8VqjIsV/?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 3093751b-71b0-43d8-cb72-08dc7a7f58f4
X-MS-Exchange-CrossTenant-AuthSource: CH3PR12MB8535.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 May 2024 16:50:55.2839
 (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: arwg+YkZKfDGJ3UMNs+ujNUqFOUEqz2JH8+YofZiwoc3UfIfi0+/5b32UvKSEYEddXdxNfMhbzZnantzePWb2A==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BL3PR12MB6570

On 5/21/24 4:10 PM, Zaid Alali wrote:
> Add documentation for the updated ACPI specs for EINJv2(1)(2)
> 
> (1)https://bugzilla.tianocore.org/show_bug.cgi?id=4615
> (2)https://bugzilla.tianocore.org/attachment.cgi?id=1446
> 
> Signed-off-by: Zaid Alali <zaidal@os.amperecomputing.com>
> ---
>  .../firmware-guide/acpi/apei/einj.rst         | 51 +++++++++++++++++--
>  1 file changed, 48 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/firmware-guide/acpi/apei/einj.rst b/Documentation/firmware-guide/acpi/apei/einj.rst
> index c52b9da08fa9..f2751cee9698 100644
> --- a/Documentation/firmware-guide/acpi/apei/einj.rst
> +++ b/Documentation/firmware-guide/acpi/apei/einj.rst
> @@ -61,8 +61,18 @@ The following files belong to it:
>    0x00000800        Platform Uncorrectable fatal
>    ================  ===================================
>  
> +  ================  ===================================
> +  Error Type Value      Error Description
> +  ================  ===================================
> +  0x00000001        EINJV2 Processor Error
> +  0x00000002        EINJV2 Memory Error
> +  0x00000004        EINJV2 PCI Express Error
> +  ================  ===================================
> +
>    The format of the file contents are as above, except present are only
> -  the available error types.
> +  the available error types. The available Error types are discovered by
> +  calling GET_ERROR_TYPE command, and if bit 30 is set in the returned
> +  value, then EINJv2 is supported by the system.
>  

I think this is a little too much information. I don't think it's really relevant
to how the available error types are determined since the raw value returned from
GET_ERROR_TYPE isn't user visible.

Thanks,
Ben

>  - error_type
>  
> @@ -85,9 +95,11 @@ The following files belong to it:
>      Bit 0
>        Processor APIC field valid (see param3 below).
>      Bit 1
> -      Memory address and mask valid (param1 and param2).
> +      Memory address and range valid (param1 and param2).
>      Bit 2
>        PCIe (seg,bus,dev,fn) valid (see param4 below).
> +    Bit 3
> +      EINJv2 extension structure is valid
>  
>    If set to zero, legacy behavior is mimicked where the type of
>    injection specifies just one bit set, and param1 is multiplexed.
> @@ -110,6 +122,7 @@ The following files belong to it:
>    Used when the 0x1 bit is set in "flags" to specify the APIC id
>  
>  - param4
> +
>    Used when the 0x4 bit is set in "flags" to specify target PCIe device
>  
>  - notrigger
> @@ -122,6 +135,18 @@ The following files belong to it:
>    this actually works depends on what operations the BIOS actually
>    includes in the trigger phase.
>  
> +- einjv2_component_count
> +
> +  The value from this file is used to set the "Component Array Count"
> +  field of EINJv2 Extension Structure.
> +
> +- einjv2_component_array
> +
> +  The contents of this file are used to set the "Component Array" field
> +  of the EINJv2 Extension Structure. The expected format is hex values
> +  for component id and syndrome separated by space, and multiple
> +  components are separated by new line.
> +
>  CXL error types are supported from ACPI 6.5 onwards (given a CXL port
>  is present). The EINJ user interface for CXL error types is at
>  <debugfs mount point>/cxl. The following files belong to it:
> @@ -139,7 +164,6 @@ is present). The EINJ user interface for CXL error types is at
>    under <debugfs mount point>/apei/einj, while CXL 1.1/1.0 port injections
>    must use this file.
>  
> -
>  BIOS versions based on the ACPI 4.0 specification have limited options
>  in controlling where the errors are injected. Your BIOS may support an
>  extension (enabled with the param_extension=1 module parameter, or boot
> @@ -194,6 +218,27 @@ An error injection example::
>    # echo 0x8 > error_type			# Choose correctable memory error
>    # echo 1 > error_inject			# Inject now
>  
> +An EINJv2 error injection example::
> +
> +  # cd /sys/kernel/debug/apei/einj
> +  # cat available_error_type            # See which errors can be injected
> +  0x00000002    Processor Uncorrectable non-fatal
> +  0x00000008    Memory Correctable
> +  0x00000010    Memory Uncorrectable non-fatal
> +  ==================
> +  0x00000001        EINJV2 Processor Error
> +  0x00000002        EINJV2 Memory Error
> +
> +  # echo 0x12345000 > param1            	# Set memory address for injection
> +  # echo 0xfffffffffffff000 > param2            # Range - anywhere in this page
> +  # comp_arr="0x1 0x2				# Fill in the component array
> +    >0x1 0x4
> +    >0x2 0x4"
> +  # echo "$comp_arr" > einjv2_component_array
> +  # echo 0x2 > error_type                       # Choose EINJv2 memory error
> +  # echo 0xa > flags				# set flags to indicate EINJv2
> +  # echo 1 > error_inject                       # Inject now
> +
>  You should see something like this in dmesg::
>  
>    [22715.830801] EDAC sbridge MC3: HANDLING MCE MEMORY ERROR