From: Quan Nguyen <quan@os.amperecomputing.com>
To: Bagas Sanjaya <bagasdotme@gmail.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 2/9] docs: hwmon: (smpro-hwmon) Add documentation
Date: Thu, 6 Oct 2022 14:47:36 +0700 [thread overview]
Message-ID: <7c0d3614-f501-d398-e023-5754e2ec9528@os.amperecomputing.com> (raw)
In-Reply-To: <Yzg5GM97kM6/Hw82@debian.me>
On 01/10/2022 19:56, Bagas Sanjaya wrote:
> On Thu, Sep 29, 2022 at 04:43:14PM +0700, Quan Nguyen wrote:
>> diff --git a/Documentation/hwmon/smpro-hwmon.rst b/Documentation/hwmon/smpro-hwmon.rst
>> new file mode 100644
>> index 000000000000..3a9b14dacf89
>> --- /dev/null
>> +++ b/Documentation/hwmon/smpro-hwmon.rst
>> @@ -0,0 +1,101 @@
>> +.. SPDX-License-Identifier: GPL-2.0-only
>> +
>> +Kernel driver Ampere(R)'s Altra(R) SMpro hwmon
>> +==============================================
>> +
>> +Supported chips:
>> +
>> + * Ampere(R) Altra(R)
>> +
>> + Prefix: 'smpro'
>> +
>> + Reference: Altra SoC BMC Interface Specification
>> +
>> +Author: Thu Nguyen <thu@os.amperecomputing.com>
>> +
>> +Description
>> +-----------
>> +This driver supports hardware monitoring for Ampere(R) Altra(R) SoC's based on the
>> +SMpro co-processor (SMpro).
>> +The following sensor types are supported by the driver:
>> +
>> + * temperature
>> + * voltage
>> + * current
>> + * power
>> +
>> +The SMpro interface provides the registers to query the various sensors and
>> +their values which are then exported to userspace by this driver.
>> +
>> +Usage Notes
>> +-----------
>> +
>> +SMpro hwmon driver creates at least two sysfs files for each sensor.
>> +
>> +* File ``<sensor_type><idx>_label`` reports the sensor label.
>> +* File ``<sensor_type><idx>_input`` returns the sensor value.
>> +
>> +The sysfs files are allocated in the SMpro root fs folder.
>> +There is one root folder for each SMpro instance.
>> +
>> +When the SoC is turned off, the driver will fail to read registers
>> +and return -ENXIO.
>> +
>> +Sysfs entries
>> +-------------
>> +
>> +The following sysfs files are supported:
>> +
>> +* Ampere(R) Altra(R):
>> +
>> +============ ============= ====== ===============================================
>> +Name Unit Perm Description
>> +temp1_input milli Celsius RO SoC temperature
>> +temp2_input milli Celsius RO Max temperature reported among SoC VRDs
>> +temp2_crit milli Celsius RO SoC VRD HOT Threshold temperature
>> +temp3_input milli Celsius RO Max temperature reported among DIMM VRDs
>> +temp4_input milli Celsius RO Max temperature reported among Core VRDs
>> +temp5_input milli Celsius RO Temperature of DIMM0 on CH0
>> +temp5_crit milli Celsius RO MEM HOT Threshold for all DIMMs
>> +temp6_input milli Celsius RO Temperature of DIMM0 on CH1
>> +temp6_crit milli Celsius RO MEM HOT Threshold for all DIMMs
>> +temp7_input milli Celsius RO Temperature of DIMM0 on CH2
>> +temp7_crit milli Celsius RO MEM HOT Threshold for all DIMMs
>> +temp8_input milli Celsius RO Temperature of DIMM0 on CH3
>> +temp8_crit milli Celsius RO MEM HOT Threshold for all DIMMs
>> +temp9_input milli Celsius RO Temperature of DIMM0 on CH4
>> +temp9_crit milli Celsius RO MEM HOT Threshold for all DIMMs
>> +temp10_input milli Celsius RO Temperature of DIMM0 on CH5
>> +temp10_crit milli Celsius RO MEM HOT Threshold for all DIMMs
>> +temp11_input milli Celsius RO Temperature of DIMM0 on CH6
>> +temp11_crit milli Celsius RO MEM HOT Threshold for all DIMMs
>> +temp12_input milli Celsius RO Temperature of DIMM0 on CH7
>> +temp12_crit milli Celsius RO MEM HOT Threshold for all DIMMs
>> +temp13_input milli Celsius RO Max temperature reported among RCA VRDs
>> +in0_input milli Volts RO Core voltage
>> +in1_input milli Volts RO SoC voltage
>> +in2_input milli Volts RO DIMM VRD1 voltage
>> +in3_input milli Volts RO DIMM VRD2 voltage
>> +in4_input milli Volts RO RCA VRD voltage
>> +cur1_input milli Amperes RO Core VRD current
>> +cur2_input milli Amperes RO SoC VRD current
>> +cur3_input milli Amperes RO DIMM VRD1 current
>> +cur4_input milli Amperes RO DIMM VRD2 current
>> +cur5_input milli Amperes RO RCA VRD current
>> +power1_input micro Watts RO Core VRD power
>> +power2_input micro Watts RO SoC VRD power
>> +power3_input micro Watts RO DIMM VRD1 power
>> +power4_input micro Watts RO DIMM VRD2 power
>> +power5_input micro Watts RO RCA VRD power
>> +============ ============= ====== ===============================================
>> +
>> +Example::
>> +
>> + # cat in0_input
>> + 830
>> + # cat temp1_input
>> + 37000
>> + # cat curr1_input
>> + 9000
>> + # cat power5_input
>> + 19500000
>
> The documentation above can be improved (both grammar and formatting):
>
> ---- >8 ----
>
> diff --git a/Documentation/hwmon/smpro-hwmon.rst b/Documentation/hwmon/smpro-hwmon.rst
> index 3a9b14dacf8975..fb7b3665735bba 100644
> --- a/Documentation/hwmon/smpro-hwmon.rst
> +++ b/Documentation/hwmon/smpro-hwmon.rst
> @@ -7,39 +7,39 @@ Supported chips:
>
> * Ampere(R) Altra(R)
>
> - Prefix: 'smpro'
> + Prefix: ``smpro``
>
> - Reference: Altra SoC BMC Interface Specification
> + Reference: `Altra SoC BMC Interface Specification`
>
> Author: Thu Nguyen <thu@os.amperecomputing.com>
>
> Description
> -----------
> -This driver supports hardware monitoring for Ampere(R) Altra(R) SoC's based on the
> -SMpro co-processor (SMpro).
> -The following sensor types are supported by the driver:
> +The smpro-hwmon driver supports hardware monitoring for Ampere(R) Altra(R)
> +SoCs based on the SMpro co-processor (SMpro). The following sensor metrics
> +are supported by the driver:
>
> * temperature
> * voltage
> * current
> * power
>
> -The SMpro interface provides the registers to query the various sensors and
> +The interface provides the registers to query the various sensors and
> their values which are then exported to userspace by this driver.
>
> Usage Notes
> -----------
>
> -SMpro hwmon driver creates at least two sysfs files for each sensor.
> +The driver creates at least two sysfs files for each sensor.
>
> -* File ``<sensor_type><idx>_label`` reports the sensor label.
> -* File ``<sensor_type><idx>_input`` returns the sensor value.
> +* ``<sensor_type><idx>_label`` reports the sensor label.
> +* ``<sensor_type><idx>_input`` returns the sensor value.
>
> -The sysfs files are allocated in the SMpro root fs folder.
> -There is one root folder for each SMpro instance.
> +The sysfs files are allocated in the SMpro rootfs folder, with one root
> +directory for each instance.
>
> -When the SoC is turned off, the driver will fail to read registers
> -and return -ENXIO.
> +When the SoC is turned off, the driver will fail to read registers and
> +return ``-ENXIO``.
>
> Sysfs entries
> -------------
> @@ -48,48 +48,49 @@ The following sysfs files are supported:
>
> * Ampere(R) Altra(R):
>
> -============ ============= ====== ===============================================
> -Name Unit Perm Description
> -temp1_input milli Celsius RO SoC temperature
> -temp2_input milli Celsius RO Max temperature reported among SoC VRDs
> -temp2_crit milli Celsius RO SoC VRD HOT Threshold temperature
> -temp3_input milli Celsius RO Max temperature reported among DIMM VRDs
> -temp4_input milli Celsius RO Max temperature reported among Core VRDs
> -temp5_input milli Celsius RO Temperature of DIMM0 on CH0
> -temp5_crit milli Celsius RO MEM HOT Threshold for all DIMMs
> -temp6_input milli Celsius RO Temperature of DIMM0 on CH1
> -temp6_crit milli Celsius RO MEM HOT Threshold for all DIMMs
> -temp7_input milli Celsius RO Temperature of DIMM0 on CH2
> -temp7_crit milli Celsius RO MEM HOT Threshold for all DIMMs
> -temp8_input milli Celsius RO Temperature of DIMM0 on CH3
> -temp8_crit milli Celsius RO MEM HOT Threshold for all DIMMs
> -temp9_input milli Celsius RO Temperature of DIMM0 on CH4
> -temp9_crit milli Celsius RO MEM HOT Threshold for all DIMMs
> -temp10_input milli Celsius RO Temperature of DIMM0 on CH5
> -temp10_crit milli Celsius RO MEM HOT Threshold for all DIMMs
> -temp11_input milli Celsius RO Temperature of DIMM0 on CH6
> -temp11_crit milli Celsius RO MEM HOT Threshold for all DIMMs
> -temp12_input milli Celsius RO Temperature of DIMM0 on CH7
> -temp12_crit milli Celsius RO MEM HOT Threshold for all DIMMs
> -temp13_input milli Celsius RO Max temperature reported among RCA VRDs
> -in0_input milli Volts RO Core voltage
> -in1_input milli Volts RO SoC voltage
> -in2_input milli Volts RO DIMM VRD1 voltage
> -in3_input milli Volts RO DIMM VRD2 voltage
> -in4_input milli Volts RO RCA VRD voltage
> -cur1_input milli Amperes RO Core VRD current
> -cur2_input milli Amperes RO SoC VRD current
> -cur3_input milli Amperes RO DIMM VRD1 current
> -cur4_input milli Amperes RO DIMM VRD2 current
> -cur5_input milli Amperes RO RCA VRD current
> -power1_input micro Watts RO Core VRD power
> -power2_input micro Watts RO SoC VRD power
> -power3_input micro Watts RO DIMM VRD1 power
> -power4_input micro Watts RO DIMM VRD2 power
> -power5_input micro Watts RO RCA VRD power
> -============ ============= ====== ===============================================
> + ============ ============= ====== ===============================================
> + Name Unit Perm Description
> + ============ ============= ====== ===============================================
> + temp1_input millicelsius RO SoC temperature
> + temp2_input millicelsius RO Max temperature reported among SoC VRDs
> + temp2_crit millicelsius RO SoC VRD HOT Threshold temperature
> + temp3_input millicelsius RO Max temperature reported among DIMM VRDs
> + temp4_input millicelsius RO Max temperature reported among Core VRDs
> + temp5_input millicelsius RO Temperature of DIMM0 on CH0
> + temp5_crit millicelsius RO MEM HOT Threshold for all DIMMs
> + temp6_input millicelsius RO Temperature of DIMM0 on CH1
> + temp6_crit millicelsius RO MEM HOT Threshold for all DIMMs
> + temp7_input millicelsius RO Temperature of DIMM0 on CH2
> + temp7_crit millicelsius RO MEM HOT Threshold for all DIMMs
> + temp8_input millicelsius RO Temperature of DIMM0 on CH3
> + temp8_crit millicelsius RO MEM HOT Threshold for all DIMMs
> + temp9_input millicelsius RO Temperature of DIMM0 on CH4
> + temp9_crit millicelsius RO MEM HOT Threshold for all DIMMs
> + temp10_input millicelsius RO Temperature of DIMM0 on CH5
> + temp10_crit millicelsius RO MEM HOT Threshold for all DIMMs
> + temp11_input millicelsius RO Temperature of DIMM0 on CH6
> + temp11_crit millicelsius RO MEM HOT Threshold for all DIMMs
> + temp12_input millicelsius RO Temperature of DIMM0 on CH7
> + temp12_crit millicelsius RO MEM HOT Threshold for all DIMMs
> + temp13_input millicelsius RO Max temperature reported among RCA VRDs
> + in0_input millivolts RO Core voltage
> + in1_input millivolts RO SoC voltage
> + in2_input millivolts RO DIMM VRD1 voltage
> + in3_input millivolts RO DIMM VRD2 voltage
> + in4_input millivolts RO RCA VRD voltage
> + cur1_input milliamperes RO Core VRD current
> + cur2_input milliamperes RO SoC VRD current
> + cur3_input milliamperes RO DIMM VRD1 current
> + cur4_input milliamperes RO DIMM VRD2 current
> + cur5_input milliamperes RO RCA VRD current
> + power1_input microwatts RO Core VRD power
> + power2_input microwatts RO SoC VRD power
> + power3_input microwatts RO DIMM VRD1 power
> + power4_input microwatts RO DIMM VRD2 power
> + power5_input microwatts RO RCA VRD power
> + ============ ============= ====== ===============================================
>
> -Example::
> + Example::
>
> # cat in0_input
> 830
>
Thank you Bagas, will apply in next version.
- Quan
next prev parent reply other threads:[~2022-10-06 7:48 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 [this message]
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
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=7c0d3614-f501-d398-e023-5754e2ec9528@os.amperecomputing.com \
--to=quan@os.amperecomputing.com \
--cc=arnd@arndb.de \
--cc=bagasdotme@gmail.com \
--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=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).