Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Quan Nguyen <quan@os.amperecomputing.com>
To:     macro@orcam.me.uk, Lee Jones <lee@kernel.org>,
        Bagas Sanjaya <bagasdotme@gmail.com>,
        Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Jean Delvare <jdelvare@suse.com>,
        Guenter Roeck <linux@roeck-us.net>,
        Jonathan Corbet <corbet@lwn.net>,
        Derek Kiernan <derek.kiernan@xilinx.com>,
        Dragan Cvetic <dragan.cvetic@xilinx.com>,
        Arnd Bergmann <arnd@arndb.de>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Quan Nguyen <quan@os.amperecomputing.com>,
        Thu Nguyen <thu@os.amperecomputing.com>,
        linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
        linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org,
        OpenBMC Maillist <openbmc@lists.ozlabs.org>,
        Open Source Submission <patches@amperecomputing.com>
Cc:     Phong Vo <phong@os.amperecomputing.com>,
        thang@os.amperecomputing.com
Subject: [PATCH v9 9/9] docs: ABI: testing: Document the Ampere Altra Family's SMpro sysfs interfaces
Date:   Thu, 29 Sep 2022 16:43:21 +0700
Message-Id: <20220929094321.770125-10-quan@os.amperecomputing.com>
In-Reply-To: <20220929094321.770125-1-quan@os.amperecomputing.com>
References: <20220929094321.770125-1-quan@os.amperecomputing.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?SdoqTurq34UZnNLATBE2VblyhZwHkQ7FIUB9fOTIXBNc8pZiYC+ls+yTxOIp?=
 =?us-ascii?Q?tufmkq/+PmyO3gcG2JaMhWapYr68LlDJxz7UIcXgcSVhpUqOpPyGZL/8ObkW?=
 =?us-ascii?Q?TNVEXIyYFyHtav8VBNqObWWUSrXKamDWM4Fl1+TcWAL4sKQacezGibIxa3Tn?=
 =?us-ascii?Q?pLfb0DkyBfXRGHU6TuhxUNN/V8r3pR092+65tbvD5oJ2CJ7JwlqldTpsT7jH?=
 =?us-ascii?Q?kwROp8n+m7D172R2+vzzO/xPtX4PF+Dul8aPdgQe67vcf7TEe+mXHO2tsLLr?=
 =?us-ascii?Q?aOIubY4jjkp7551bygkyfVzX4Cvq5hZExsMB88WwSidCd+X9+pU59Rd39KJB?=
 =?us-ascii?Q?LfIDg/CwM2g+dd3cyCl4H5HA+4lN9I/Z7xz71xJvhJr24Ecn60lAYJodurn7?=
 =?us-ascii?Q?ZD3IWCuzvWVELpX29ST4E471X2zNVG9g7Yvy4EO2Y3gCM6Xv3uVqER2G59jc?=
 =?us-ascii?Q?r1nbMS18PjeT+RpnTFSNel+lEXIQxKp0EAP0NARxHjsJBfiET2XSpK26o8PN?=
 =?us-ascii?Q?BNcbX2d2AZyiz1cRY8O37nvOzHVn0V74k/Q6QKdtHdf65c0Q2gNIggGaaMkx?=
 =?us-ascii?Q?Gx01QRd4DXXinEk3svdYgbelTsPFGfh8Z05f2krOqllZrCCHn//RN1zWvji7?=
 =?us-ascii?Q?PJgwT9phYbGdztAwzqnp24df53pymJElhBS7/h3/7SyQldTnVlLv4YDonusU?=
 =?us-ascii?Q?jiTUZw5P4uoS9QfoyqixEn3UONcpGM+YFMwJjnmMbuJZ8k6CM1E2wzlBWwgO?=
 =?us-ascii?Q?gobybNxO6KfkSuZaTo443RXwSiCA2SQx9SzED3WRuGZbcpzsNmjYTqTgiSAz?=
 =?us-ascii?Q?oxvk60OKOz3kAVPC8+17sRRIbYwSovbDHQ1j5yfEQAxXPbgtMHK04JVxBTnO?=
 =?us-ascii?Q?9hiAnhUGFcO+lDJdixJuqF7YesANgeMxRNbcxOIA35ZX6l/jmmSL1LLVHkor?=
 =?us-ascii?Q?hBHspQfylF0kX/FO1xfVz4OxNHRdfyFmHQFm2vwW7vb+CvDRa7BUGpDX++6u?=
 =?us-ascii?Q?b4bCsOVjkc8yS8K0U6hrIzvQqLB/dCdtyLA4AJ2CF4tz1Juv94YcsCJDm/yV?=
 =?us-ascii?Q?8z4T8Sbrom6oVkJ1WjokJ7cBroWKny7cSkIgEj6k5MAx0ZaI4egezU6K6tu0?=
 =?us-ascii?Q?XQSnJ+6l8pNQpBYuNBuLDTOTecISBWx4iL48g4G3wWEPiK6MImXBNm84UhBa?=
 =?us-ascii?Q?JVaKsftEwxtxvsIhI0wFshRcJNVLxiJApS9CKdVAHCHa97x4zB+6M4Yb2rkM?=
 =?us-ascii?Q?BYkvkkFDfhUgUYls2WXTq2jBed3ifI55cf2YtcEzNGVGEIbNSX1ggqmgT1+T?=
 =?us-ascii?Q?boLq0hIKOS58N43Eon0JdfmzAT/hK9ZGnciOSQJMVUt/JTpE2Crjd9SUink/?=
 =?us-ascii?Q?oVdT4zdWKYeU2oBsVqSXpZMfYwrk1N35Y6NzwpvTrDV9dSJ8ed0N5hY2KC6A?=
 =?us-ascii?Q?eKKN03A8ZXrhKgs3l7uTXpOz4CpUNPlE4iWVxSZAFyibXp5H0OCMXaIwlYGh?=
 =?us-ascii?Q?LTwGqv1U4pAVetnwBrqOFWGaF+lSfLpA+lOnFgMAdt+ygqSoL7KuQJnSd+ST?=
 =?us-ascii?Q?8ZnWsf6YQgCTrQI9K4uhP/XNgdKTjlgX8Uzl9hVCXh6r50eG7rlqfBHFpWEZ?=
 =?us-ascii?Q?alcupiw1GdDVHztd4Kc9vYk=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 00dbd368-f74d-4981-6b0e-08daa1ff3832
X-MS-Exchange-CrossTenant-AuthSource: SJ0PR01MB7282.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 Sep 2022 09:44:36.1968
 (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: k+oQ4dKkbwbZE/UJ5f9JSq3rxqYUEugN7b1+zSXLPru+lLDmUm53+/KZf9MbsZebmt9XaQ+xzTfHM5Bri+c+KpJBQYpVp32L1PfeGi4nmfg=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR01MB5503
X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,
        SPF_HELO_PASS,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Add documentation for the Ampere(R)'s Altra(R) SMpro sysfs interfaces

Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>
---
Changes in v9:
  + Remove unnecessary channel info for VRD and DIMM event  [Quan]
  + Update to align with sysfs changes                      [Quan]

Changes in v8:
  + Sysfs to return single value in hex format              [Greg]
  + Fix KernelVersion info                                  [Greg]
  + Change errors_* to error_*                              [Quan]
  + Added overflow_[core|mem|pcie|other]_[ce|ue]            [Quan]

Changes in v7:
  + First introduce in v7                                   [Greg]

 .../sysfs-bus-platform-devices-ampere-smpro   | 125 ++++++++++++++++++
 1 file changed, 125 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro

diff --git a/Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro b/Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro
new file mode 100644
index 000000000000..d8f82a06570d
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro
@@ -0,0 +1,125 @@
+What:		/sys/bus/platform/devices/smpro-errmon.*/error_[core|mem|pcie|other]_[ce|ue]
+KernelVersion:	5.18
+Contact:	quan@os.amperecomputing.com
+Description:
+		(RO) Contains the 48-byte Ampere (Vendor-Specific) Error Record printed
+		in hex format.
+
+		The detail of each sysfs entries is as below:
+		+-------------+---------------------------------------------------------+
+		|   Error     |                   Sysfs entry                           |
+		+-------------+---------------------------------------------------------+
+		| Core's CE   | /sys/bus/platform/devices/smpro-errmon.*/error_core_ce |
+		| Core's UE   | /sys/bus/platform/devices/smpro-errmon.*/error_core_ue |
+		| Memory's CE | /sys/bus/platform/devices/smpro-errmon.*/error_mem_ce  |
+		| Memory's UE | /sys/bus/platform/devices/smpro-errmon.*/error_mem_ue  |
+		| PCIe's CE   | /sys/bus/platform/devices/smpro-errmon.*/error_pcie_ce |
+		| PCIe's UE   | /sys/bus/platform/devices/smpro-errmon.*/error_pcie_ue |
+		| Other's CE  | /sys/bus/platform/devices/smpro-errmon.*/error_other_ce|
+		| Other's UE  | /sys/bus/platform/devices/smpro-errmon.*/error_other_ue|
+		+-------------+---------------------------------------------------------+
+		UE: Uncorrect-able Error
+		CE: Correct-able Error
+
+		See section 3.3 Ampere (Vendor-Specific) Error Record Formats,
+		Altra Family RAS Supplement.
+
+
+What:		/sys/bus/platform/devices/smpro-errmon.*/overflow_[core|mem|pcie|other]_[ce|ue]
+KernelVersion:	5.18
+Contact:	quan@os.amperecomputing.com
+Description:
+		(RO) Return the overflow status of each type HW error reported:
+		  0      : No overflow
+		  1      : There is an overflow and the oldest HW errors are dropped
+
+		The detail of each sysfs entries is as below:
+		+-------------+-----------------------------------------------------------+
+		|   Overflow  |                   Sysfs entry                             |
+		+-------------+-----------------------------------------------------------+
+		| Core's CE   | /sys/bus/platform/devices/smpro-errmon.*/overflow_core_ce |
+		| Core's UE   | /sys/bus/platform/devices/smpro-errmon.*/overflow_core_ue |
+		| Memory's CE | /sys/bus/platform/devices/smpro-errmon.*/overflow_mem_ce  |
+		| Memory's UE | /sys/bus/platform/devices/smpro-errmon.*/overflow_mem_ue  |
+		| PCIe's CE   | /sys/bus/platform/devices/smpro-errmon.*/overflow_pcie_ce |
+		| PCIe's UE   | /sys/bus/platform/devices/smpro-errmon.*/overflow_pcie_ue |
+		| Other's CE  | /sys/bus/platform/devices/smpro-errmon.*/overflow_other_ce|
+		| Other's UE  | /sys/bus/platform/devices/smpro-errmon.*/overflow_other_ue|
+		+-------------+-----------------------------------------------------------+
+		UE: Uncorrect-able Error
+		CE: Correct-able Error
+
+What:           /sys/bus/platform/devices/smpro-errmon.*/[error|warn]_[smpro|pmpro]
+KernelVersion:	5.18
+Contact:	quan@os.amperecomputing.com
+Description:
+		(RO) Contains the internal firmware error/warning printed as hex format.
+
+		The detail of each sysfs entries is as below:
+		+---------------+------------------------------------------------------+
+		|   Error       |                   Sysfs entry                        |
+		+---------------+------------------------------------------------------+
+		| SMpro error   | /sys/bus/platform/devices/smpro-errmon.*/error_smpro |
+		| SMpro warning | /sys/bus/platform/devices/smpro-errmon.*/warn_smpro  |
+		| PMpro error   | /sys/bus/platform/devices/smpro-errmon.*/error_pmpro |
+		| PMpro warning | /sys/bus/platform/devices/smpro-errmon.*/warn_pmpro  |
+		+---------------+------------------------------------------------------+
+		See more details in section 5.10 RAS Internal Error Register Definitions,
+		Altra Family Soc BMC Interface Specification.
+
+What:           /sys/bus/platform/devices/smpro-errmon.*/event_[vrd_warn_fault|vrd_hot|dimm_hot]
+KernelVersion:	5.18
+Contact:	quan@os.amperecomputing.com
+Description:
+		(RO) Contains the detail information in case of VRD/DIMM warning/hot events
+		in hex format as below:
+
+		AAAA
+		Where:
+		  AAAA: The event detail information data
+
+		See more details in section 5.7 GPI Status Registers,
+		Altra Family Soc BMC Interface Specification.
+
+
+What:		/sys/bus/platform/devices/smpro-misc.*/boot_progress
+KernelVersion:	5.18
+Contact:	quan@os.amperecomputing.com
+Description:
+		(RO) Contains the boot stages information in hex as format below:
+
+		AABBCCCCCCCC
+		Where:
+		  AA      : The boot stages
+		              00: SMpro firmware booting
+		              01: PMpro firmware booting
+		              02: ATF BL1 firmware booting
+		              03: DDR initialization
+		              04: DDR training report status
+		              05: ATF BL2 firmware booting
+		              06: ATF BL31 firmware booting
+		              07: ATF BL32 firmware booting
+		              08: UEFI firmware booting
+		              09: OS booting
+		  BB      : Boot status
+		              00: Not started
+		              01: Started
+		              02: Completed without error
+		              03: Failed.
+		  CCCCCCCC: Boot status information defined for each boot stages
+
+		See more details in section 5.11 Boot Stage Register Definitions,
+		and section 6. Processor Boot Progress Codes, Altra Family Soc BMC
+		Interface Specification.
+
+
+What:           /sys/bus/platform/devices/smpro-misc*/soc_power_limit
+KernelVersion:	5.18
+Contact:	quan@os.amperecomputing.com
+Description:
+		(RW) Contains the desired SoC power limit in Watt.
+		Writes to this sysfs set the desired SoC power limit (W).
+		Reads from this register return the current SoC power limit (W).
+		The value ranges:
+		  Minimum: 120 W
+		  Maximum: Socket TDP power
-- 
2.35.1