Received-SPF: pass (google.com: domain of linux-kernel+bounces-185465-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
From: Zaid Alali <zaidal@os.amperecomputing.com>
To: 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,
	Benjamin.Cheatham@amd.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
Subject: [RFC PATCH v2 8/8] ACPI: APEI: EINJ: Update the documentation for EINJv2 support
Date: Tue, 21 May 2024 14:10:36 -0700
Message-Id: <20240521211036.227674-9-zaidal@os.amperecomputing.com>
In-Reply-To: <20240521211036.227674-1-zaidal@os.amperecomputing.com>
References: <20240521211036.227674-1-zaidal@os.amperecomputing.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?huFoXxV++igu/XjaV6Svd9B4c43+gu9t/fWZdPgCCMt95RivO52G367iVMAQ?=
 =?us-ascii?Q?2/1O/IYWHxoPXaj5Mj56xn0gPT8d0ClXWcaFCFUImro+pO9ewv8HG5i6h9FZ?=
 =?us-ascii?Q?5sctE5HTTarDWCdHW1WjvVon8bNHQcFqImha7egKPTVRcYLPHZuxoMpyuG1Q?=
 =?us-ascii?Q?XYOWw19K71yFMTdG7K0+bEdwq1MoK9qODKh/hncxOoPpyXsrij3GPKNket+N?=
 =?us-ascii?Q?9L09QAlj35knt+m0h85gfji2JXV8yz91ZH24njcM8DuhZJ25IuaIouhPv5kv?=
 =?us-ascii?Q?RoW3nbBQkc7t+zT+hS71xtudZZy3wR0ZNbJREsL8fGhJpjiWGNpmt9xJn9gS?=
 =?us-ascii?Q?JIQXUdoYgDGPqDROHcfFnfmFbiC7hisUjFPXT5MCvFxzVatvWcniVFQwABn+?=
 =?us-ascii?Q?WXuyDOJmPpq7eMw/gcHXcSRl8fcAoUMAJIsf0lTXU4X/y2ZpsfG8rZUoJBrK?=
 =?us-ascii?Q?pvE9Zty0Pw3RKjfG0Frxh1Mrw+wzXd9J0GkgZy4v4B+hAclKGXNACPJH+mif?=
 =?us-ascii?Q?h0NLv2d1Ljtx9Pp4gSpfKY1TdE4vE5+1wMdSk5B2u9sa9JQ0+t9j/tD8HfDs?=
 =?us-ascii?Q?mPL+iqcaUWR+8G/0fsiW8lGeYE47T76BMDQQt7/Z4TSB9KordJpmAkSG1TQW?=
 =?us-ascii?Q?wrqq6falwmPwjmk/WGee0LW3xk6au1gXtS1+v1MbZBtl1YpHUmy4EbgtOavV?=
 =?us-ascii?Q?YEcyb5savw2xnJ5+VH+O6DCNYZ/e1zSA/I5QJKlzt/+juahsb9LB5d05ScnA?=
 =?us-ascii?Q?458o94XiR9AiUxc999lTmOkqJK49k6XKVQkUhtIdQklANoEemGWvjPanhhIp?=
 =?us-ascii?Q?yTM0O7+kUMNgySvbZW70UPqPzE5KU6LcMvVIDj0TFEcfITzTNETM4Ur/UzN+?=
 =?us-ascii?Q?zzo105AVJy4a6+dq1PXnCcncU4Oeo6JrwyVQ+ttW4Foly2v/992ZovqEsbkg?=
 =?us-ascii?Q?o8UInqy28QT+UXP50i7OrAUVCp2LgMaK3hASWF4b2tkVRWRyWqjKPyGLxHG7?=
 =?us-ascii?Q?2yVTaSgkGk5ItIwmwUx1jGk90fVszekR0bw8Xl27jDSdCLLxLSaVAgKMwrzj?=
 =?us-ascii?Q?uxP/0doeI7DlIiKhlqB66bK5DhHbYvMkYaAS1VeFMZPy3MmmY7kDMiYeXbyS?=
 =?us-ascii?Q?BSSaF6w83vBP4eOCse0/qBiCEvIWlkqt2nGXAOpeuA83BZwEq9QrHTux273W?=
 =?us-ascii?Q?BrkGDYPWxkgkceKjK5hxI8HLaWKMab2YA+zWqb/g1Jbh+tTvciTxpBsyGltX?=
 =?us-ascii?Q?i6ukvA8Tc8pzdQoEokX4nUBOu+aQLPJ7FrYtQZuYBCFzyoV9Mhenx86hmLwR?=
 =?us-ascii?Q?uOvAnRZyHIScFf7qTZTSIzG/DOEEbLyeBR6gJVZpJeXo7m4YE5C1IU7QEqYm?=
 =?us-ascii?Q?U45fwCrCPNUDyemsi0WkMJOee8OxhC8J8Brzj4j5eb6U4BrmeHB1NazhtuoH?=
 =?us-ascii?Q?PG/KYZR1bh5qJ+qDyIJhrdUhFqR7Cbvo/QMiPj3W0P8EaPgXjKYmIAgU7d2z?=
 =?us-ascii?Q?UTMX/eWViuw9CL/kWvQ+zjzxVW/aUoFCd0jOoI2BRWzkQPpJJlnPZuhTAuAC?=
 =?us-ascii?Q?+d0ln+ab0dmTPaYeF1glAQBy7AMO02y6BtnicJfIqnTzU7SaZmgb6tCgdDv0?=
 =?us-ascii?Q?blNxcyWEBjCKUJbS8S2bwzA=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 2f5d6aa9-0922-4d14-3e0f-08dc79da8771
X-MS-Exchange-CrossTenant-AuthSource: SN7PR01MB7903.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 21 May 2024 21:11:06.3133
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3bc2b170-fd94-476d-b0ce-4229bdc904a7
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: zMVQxIDGqO+/45Q50cQcGgreP93HY8Eo3fKSYQ2meTW/wAMWcGdq23wDRoFz4RB4uDw+57/wprl5f+l5HVS3hZTrEQ9Ya6Pzbz819vrbiGYsC3ioc6T/C8fb+JcO2Ay2
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW6PR01MB8627

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.
 
 - 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
-- 
2.34.1