[PATCH v9 9/9] docs: ABI: testing: Document the Ampere Altra Family's SMpro sysfs interfaces
Bagas Sanjaya
bagasdotme at gmail.com
Fri Sep 30 19:38:11 AEST 2022
On Thu, Sep 29, 2022 at 04:43:21PM +0700, Quan Nguyen wrote:
> 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 at 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 at 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 at 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 at 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 at 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 at 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
The documentation above produces htmldocs warnings:
Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro:71: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro:117: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro:86: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro:86: WARNING: Definition list ends without a blank line; unexpected unindent.
I have applied the fixup (with fixes to technical references):
---- >8 ----
diff --git a/Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro b/Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro
index d8f82a06570d88..39cf222fb6510a 100644
--- a/Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro
+++ b/Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro
@@ -6,23 +6,32 @@ Description:
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|
+ | 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.
+ For details, 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]
@@ -30,24 +39,36 @@ KernelVersion: 5.18
Contact: quan at 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
+
+ - 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
+
+ where:
+
+ - UE: Uncorrect-able Error
+ - CE: Correct-able Error
What: /sys/bus/platform/devices/smpro-errmon.*/[error|warn]_[smpro|pmpro]
KernelVersion: 5.18
@@ -56,61 +77,74 @@ 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.
+
+ For details, see 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 at os.amperecomputing.com
Description:
(RO) Contains the detail information in case of VRD/DIMM warning/hot events
- in hex format as below:
+ in hex format as below::
- AAAA
- Where:
- AAAA: The event detail information data
+ AAAA
- See more details in section 5.7 GPI Status Registers,
- Altra Family Soc BMC Interface Specification.
+ where:
+
+ - ``AAAA``: The event detail information data
+
+ For more details, see 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 at os.amperecomputing.com
Description:
- (RO) Contains the boot stages information in hex as format below:
+ (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
+ AABBCCCCCCCC
- See more details in section 5.11 Boot Stage Register Definitions,
- and section 6. Processor Boot Progress Codes, Altra Family Soc BMC
- Interface Specification.
+ 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
+
+ For details, see 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
@@ -121,5 +155,6 @@ Description:
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
+
+ - Minimum: 120 W
+ - Maximum: Socket TDP power
Thanks.
--
An old man doll... just what I always wanted! - Clara
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 228 bytes
Desc: not available
URL: <http://lists.ozlabs.org/pipermail/openbmc/attachments/20220930/69a58c24/attachment-0001.sig>
More information about the openbmc
mailing list