[PATCH v9 9/9] docs: ABI: testing: Document the Ampere Altra Family's SMpro sysfs interfaces

From: Quan Nguyen
Date: Thu Sep 29 2022 - 05:46:12 EST

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

Signed-off-by: Quan Nguyen <quan@xxxxxxxxxxxxxxxxxxxxxx>
---
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@xxxxxxxxxxxxxxxxxxxxxx
+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@xxxxxxxxxxxxxxxxxxxxxx
+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@xxxxxxxxxxxxxxxxxxxxxx
+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@xxxxxxxxxxxxxxxxxxxxxx
+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@xxxxxxxxxxxxxxxxxxxxxx
+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@xxxxxxxxxxxxxxxxxxxxxx
+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