| Message ID | 20220929094321.770125-10-quan@os.amperecomputing.com |
|---|---|
| State | New |
| Headers | show |
| Series | Add Ampere's Altra SMPro MFD and its child drivers | expand |
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@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 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@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@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@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.
Hi Quan,
I love your patch! Perhaps something to improve:
[auto build test WARNING on char-misc/char-misc-testing]
[also build test WARNING on groeck-staging/hwmon-next lee-mfd/for-mfd-next linus/master v6.0-rc7 next-20220929]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Quan-Nguyen/Add-Ampere-s-Altra-SMPro-MFD-and-its-child-drivers/20220929-174756
base: https://git.kernel.org/pub/scm/linux/kernel/git/gregkh/char-misc.git 3aa12610b481f99b5e4e3f801ff7f9b7629e4ecf
reproduce:
# https://github.com/intel-lab-lkp/linux/commit/a829e50ba00cfed243970c8a3250a6824c1371e4
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Quan-Nguyen/Add-Ampere-s-Altra-SMPro-MFD-and-its-child-drivers/20220929-174756
git checkout a829e50ba00cfed243970c8a3250a6824c1371e4
make menuconfig
# enable CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS
make htmldocs
If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <lkp@intel.com>
All warnings (new ones prefixed by >>):
>> Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro:71: WARNING: Unexpected indentation.
>> Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro:86: WARNING: Definition list ends without a blank line; unexpected unindent.
vim +71 Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro
> 71 KernelVersion: 5.18
72 Contact: quan@os.amperecomputing.com
73 Description:
74 (RO) Contains the detail information in case of VRD/DIMM warning/hot events
75 in hex format as below:
76
77 AAAA
78 Where:
79 AAAA: The event detail information data
80
81 See more details in section 5.7 GPI Status Registers,
82 Altra Family Soc BMC Interface Specification.
83
84
85 What: /sys/bus/platform/devices/smpro-misc.*/boot_progress
> 86 KernelVersion: 5.18
87 Contact: quan@os.amperecomputing.com
88 Description:
89 (RO) Contains the boot stages information in hex as format below:
90
91 AABBCCCCCCCC
92 Where:
93 AA : The boot stages
94 00: SMpro firmware booting
95 01: PMpro firmware booting
96 02: ATF BL1 firmware booting
97 03: DDR initialization
98 04: DDR training report status
99 05: ATF BL2 firmware booting
100 06: ATF BL31 firmware booting
101 07: ATF BL32 firmware booting
102 08: UEFI firmware booting
103 09: OS booting
104 BB : Boot status
105 00: Not started
106 01: Started
107 02: Completed without error
108 03: Failed.
109 CCCCCCCC: Boot status information defined for each boot stages
110
111 See more details in section 5.11 Boot Stage Register Definitions,
112 and section 6. Processor Boot Progress Codes, Altra Family Soc BMC
113 Interface Specification.
114
115
On 30/09/2022 16:38, Bagas Sanjaya wrote: > 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@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 > > 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@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@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@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 > Will apply in next version. And thank you a lot for the details changes. Thank you, - Quan
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
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