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;
Date:   Sat, 1 Oct 2022 11:11:28 +0700
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 6/9] docs: misc-devices: (smpro-misc) Add documentation
Message-ID: <Yze98CgmGuNA0uGr@debian.me>
References: <20220929094321.770125-1-quan@os.amperecomputing.com>
 <20220929094321.770125-7-quan@os.amperecomputing.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha256;
        protocol="application/pgp-signature"; boundary="zsOt5hDHQ+A0q34n"
Content-Disposition: inline
In-Reply-To: <20220929094321.770125-7-quan@os.amperecomputing.com>
Precedence: bulk


--zsOt5hDHQ+A0q34n
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Thu, Sep 29, 2022 at 04:43:18PM +0700, Quan Nguyen wrote:
> Adds documentation for the Ampere(R)'s Altra(R) SMpro misc driver.
>=20

s/Adds/Add/

> Signed-off-by: Thu Nguyen <thu@os.amperecomputing.com>
> Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>

Does this patch originally authored by Thu? If so, add From: line before
the patch description.

> diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-de=
vices/index.rst
> index b74b3b34a235..b40cd1b402f7 100644
> --- a/Documentation/misc-devices/index.rst
> +++ b/Documentation/misc-devices/index.rst
> @@ -28,6 +28,7 @@ fit into other categories.
>     oxsemi-tornado
>     pci-endpoint-test
>     smpro-errmon
> +   smpro-misc
>     spear-pcie-gadget
>     uacce
>     xilinx_sdfec
> diff --git a/Documentation/misc-devices/smpro-misc.rst b/Documentation/mi=
sc-devices/smpro-misc.rst
> new file mode 100644
> index 000000000000..d21be4a09e69
> --- /dev/null
> +++ b/Documentation/misc-devices/smpro-misc.rst
> @@ -0,0 +1,82 @@
> +.. SPDX-License-Identifier: GPL-2.0-only
> +
> +Kernel driver Ampere(R) Altra(R) SMpro miscellaneous
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D
> +
> +Supported chips:
> +
> +  * Ampere(R) Altra(R)
> +
> +    Prefix: 'smpro'
> +
> +    Reference: Altra SoC BMC Interface Specification
> +
> +Author: Thu Nguyen <thu@os.amperecomputing.com>
> +
> +Description
> +-----------
> +
> +This driver support the monitoring and configuration of various miscella=
neous
> +data provided by Ampere(R) Altra(R) SMpro processor.
> +At this time, these include:
> +
> +  * Reading Boot Progress information
> +  * Configuring SoC Power Limit
> +
> +Sysfs entries
> +-------------
> +
> +1) Boot progress
> +
> +SMpro misc driver creates the sysfs files ``boot_progress``.
> +The format of ``boot_progress`` file is as below::
> +
> +<boot stage><boot status><boot progress>
> +
> +Where:
> +
> +* Boot stage::
> +
> +    0: SMpro firmware booting.
> +    1: PMpro firmware booting.
> +    2: ATF BL1 firmware booting.
> +    3: DDR initialization.
> +    4: DDR training report status.
> +    5: ATF BL2 firmware booting.
> +    6: ATF BL31 firmware booting.
> +    7: ATF BL32 firmware booting.
> +    8: UEFI firmware booting.
> +    9: OS booting.
> +
> +* Boot status::
> +
> +    0: Not started.
> +    1: Started.
> +    2: Complete without error.
> +    3: Failure.
> +
> +* boot progress: 32 bits boot progress code
> +
> +The sysfs ``boot_progress`` only reports the boot state when the host is=
 booting.
> +If the host is already booted, it returns latest state.
> +
> +Example::
> +
> +    #cat boot_progress
> +    0102808454A8
> +
> +2) SoC Power Limit
> +
> +SMpro misc driver creates the sysfs file ``soc_power_limit`` to get/set =
the SoC Power Limit.
> +
> +Reading this sysfs return the current setting of SoC Power Limit (W) in =
decimal string.
> +Writing the desired value in decimal string to set the SoC Power Limit i=
n Watt (W).
> +The range of SoC Power Limit is 90-500(W) and will be ignored if out of =
range.
> +
> +Example::
> +
> +    #cat soc_power_limit
> +    90
> +    #echo 95 > soc_power_limit
> +    #cat soc_power_limit
> +    95

The documentation above can be improved (both grammatical and
formatting):

---- >8 ----

diff --git a/Documentation/misc-devices/smpro-misc.rst b/Documentation/misc=
-devices/smpro-misc.rst
index d21be4a09e69c4..f33466152ac402 100644
--- a/Documentation/misc-devices/smpro-misc.rst
+++ b/Documentation/misc-devices/smpro-misc.rst
@@ -7,76 +7,77 @@ Supported chips:
=20
   * Ampere(R) Altra(R)
=20
-    Prefix: 'smpro'
+    Prefix: ``smpro``
=20
-    Reference: Altra SoC BMC Interface Specification
+    Reference: `Altra SoC BMC Interface Specification`
=20
 Author: Thu Nguyen <thu@os.amperecomputing.com>
=20
 Description
 -----------
=20
-This driver support the monitoring and configuration of various miscellane=
ous
-data provided by Ampere(R) Altra(R) SMpro processor.
-At this time, these include:
+The smpro-misc driver supports monitoring and configuration of various
+miscellaneous data provided by Ampere(R) Altra(R) SMpro processor.
+Currently, the driver supports:
=20
-  * Reading Boot Progress information
-  * Configuring SoC Power Limit
+  * reading boot progress information
+  * configuring SoC power limit
=20
 Sysfs entries
 -------------
=20
 1) Boot progress
=20
-SMpro misc driver creates the sysfs files ``boot_progress``.
-The format of ``boot_progress`` file is as below::
+   The driver creates ``boot_progress`` sysfs file. Its format is described
+   as::
=20
-<boot stage><boot status><boot progress>
+     <boot stage><boot status><boot progress>
=20
-Where:
+   where:
=20
-* Boot stage::
+   * ``<boot stage>`` can be:
=20
-    0: SMpro firmware booting.
-    1: PMpro firmware booting.
-    2: ATF BL1 firmware booting.
-    3: DDR initialization.
-    4: DDR training report status.
-    5: ATF BL2 firmware booting.
-    6: ATF BL31 firmware booting.
-    7: ATF BL32 firmware booting.
-    8: UEFI firmware booting.
-    9: OS booting.
+     * 0: SMpro firmware booting.
+     * 1: PMpro firmware booting.
+     * 2: ATF BL1 firmware booting.
+     * 3: DDR initialization.
+     * 4: DDR training report status.
+     * 5: ATF BL2 firmware booting.
+     * 6: ATF BL31 firmware booting.
+     * 7: ATF BL32 firmware booting.
+     * 8: UEFI firmware booting.
+     * 9: OS booting.
=20
-* Boot status::
+  * ``<boot status>`` can be:
=20
-    0: Not started.
-    1: Started.
-    2: Complete without error.
-    3: Failure.
+     * 0: Not started.
+     * 1: Started.
+     * 2: Complete without error.
+     * 3: Failure.
=20
-* boot progress: 32 bits boot progress code
+  * ``<boot progress>``: 32-bit boot progress code
=20
-The sysfs ``boot_progress`` only reports the boot state when the host is b=
ooting.
-If the host is already booted, it returns latest state.
+  The sysfs file  only reports the boot state when the host is booting. If
+  the host is already booted, it returns the latest state.
=20
-Example::
+  Example::
=20
     #cat boot_progress
     0102808454A8
=20
-2) SoC Power Limit
+2) SoC power limit
=20
-SMpro misc driver creates the sysfs file ``soc_power_limit`` to get/set th=
e SoC Power Limit.
+   The driver creates ``soc_power_limit`` sysfs file to get/set the SoC
+   power limit.
=20
-Reading this sysfs return the current setting of SoC Power Limit (W) in de=
cimal string.
-Writing the desired value in decimal string to set the SoC Power Limit in =
Watt (W).
-The range of SoC Power Limit is 90-500(W) and will be ignored if out of ra=
nge.
+   Reading the file returns the current limit. Write the desired value in
+   decimal to set the limit (in watts).  The valid limit range is 90-500 W.
+   If the value is out of range, it will be ignored.
=20
-Example::
+   Example::
=20
-    #cat soc_power_limit
-    90
-    #echo 95 > soc_power_limit
-    #cat soc_power_limit
-    95
+     #cat soc_power_limit
+     90
+     #echo 95 > soc_power_limit
+     #cat soc_power_limit
+     95

Thanks.

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

--zsOt5hDHQ+A0q34n
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYIAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCYze96AAKCRD2uYlJVVFO
owcpAP0SzTkhr29W2c7tfiTwIYHWalYjmZY5EzVRjxQmi/J9sAD/WNg/Verj9bSP
Po+V7JVmI96xpkLGdOLqpermfOky3Q8=
=qEoH
-----END PGP SIGNATURE-----

--zsOt5hDHQ+A0q34n--