linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Quan Nguyen <quan@os.amperecomputing.com>
Cc: macro@orcam.me.uk, Lee Jones <lee@kernel.org>,
	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>,
	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>,
	Phong Vo <phong@os.amperecomputing.com>,
	thang@os.amperecomputing.com
Subject: Re: [PATCH v9 9/9] docs: ABI: testing: Document the Ampere Altra Family's SMpro sysfs interfaces
Date: Fri, 30 Sep 2022 16:38:11 +0700	[thread overview]
Message-ID: <Yza5AyTDyM5yo7HG@debian.me> (raw)
In-Reply-To: <20220929094321.770125-10-quan@os.amperecomputing.com>

[-- Attachment #1: Type: text/plain, Size: 16661 bytes --]

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.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

  reply	other threads:[~2022-09-30  9:38 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-29  9:43 [PATCH v9 0/9] Add Ampere's Altra SMPro MFD and its child drivers Quan Nguyen
2022-09-29  9:43 ` [PATCH v9 1/9] hwmon: smpro: Add Ampere's Altra smpro-hwmon driver Quan Nguyen
2022-10-01 12:59   ` Bagas Sanjaya
2022-10-06  7:47     ` Quan Nguyen
2022-10-26 15:00   ` Guenter Roeck
2022-10-27  3:39     ` Quan Nguyen
2022-09-29  9:43 ` [PATCH v9 2/9] docs: hwmon: (smpro-hwmon) Add documentation Quan Nguyen
2022-10-01 12:56   ` Bagas Sanjaya
2022-10-06  7:47     ` Quan Nguyen
2022-09-29  9:43 ` [PATCH v9 3/9] misc: smpro-errmon: Add Ampere's SMpro error monitor driver Quan Nguyen
2022-09-29  9:53   ` Greg Kroah-Hartman
2022-10-06  7:44     ` Quan Nguyen
2022-09-29  9:43 ` [PATCH v9 4/9] docs: misc-devices: (smpro-errmon) Add documentation Quan Nguyen
2022-09-29  9:56   ` Greg Kroah-Hartman
2022-10-06  7:46     ` Quan Nguyen
2022-09-30  6:07   ` kernel test robot
2022-09-30 13:13   ` Bagas Sanjaya
2022-10-06  7:46     ` Quan Nguyen
2022-09-29  9:43 ` [PATCH v9 5/9] misc: smpro-misc: Add Ampere's Altra SMpro misc driver Quan Nguyen
2022-09-29  9:55   ` Greg Kroah-Hartman
2022-10-06  7:45     ` Quan Nguyen
2022-09-29  9:43 ` [PATCH v9 6/9] docs: misc-devices: (smpro-misc) Add documentation Quan Nguyen
2022-09-29  9:56   ` Greg Kroah-Hartman
2022-10-06  7:45     ` Quan Nguyen
2022-10-01  4:11   ` Bagas Sanjaya
2022-10-06  7:47     ` Quan Nguyen
2022-09-29  9:43 ` [PATCH v9 7/9] dt-bindings: mfd: Add bindings for Ampere Altra SMPro MFD driver Quan Nguyen
2022-09-29  9:43 ` [PATCH v9 8/9] mfd: Add Ampere's Altra SMpro " Quan Nguyen
2022-10-01 10:11   ` kernel test robot
2022-10-24 12:39   ` Lee Jones
2022-10-27  3:39     ` Quan Nguyen
2022-09-29  9:43 ` [PATCH v9 9/9] docs: ABI: testing: Document the Ampere Altra Family's SMpro sysfs interfaces Quan Nguyen
2022-09-30  9:38   ` Bagas Sanjaya [this message]
2022-10-06  7:46     ` Quan Nguyen
2022-09-30 19:41   ` kernel test robot

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=Yza5AyTDyM5yo7HG@debian.me \
    --to=bagasdotme@gmail.com \
    --cc=arnd@arndb.de \
    --cc=corbet@lwn.net \
    --cc=derek.kiernan@xilinx.com \
    --cc=devicetree@vger.kernel.org \
    --cc=dragan.cvetic@xilinx.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=jdelvare@suse.com \
    --cc=krzysztof.kozlowski+dt@linaro.org \
    --cc=lee@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=macro@orcam.me.uk \
    --cc=openbmc@lists.ozlabs.org \
    --cc=patches@amperecomputing.com \
    --cc=phong@os.amperecomputing.com \
    --cc=quan@os.amperecomputing.com \
    --cc=robh+dt@kernel.org \
    --cc=thang@os.amperecomputing.com \
    --cc=thu@os.amperecomputing.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).