From: Quan Nguyen <quan@os.amperecomputing.com>
To: macro@orcam.me.uk, Lee Jones <lee@kernel.org>,
Bagas Sanjaya <bagasdotme@gmail.com>,
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>,
Quan Nguyen <quan@os.amperecomputing.com>,
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>
Cc: Phong Vo <phong@os.amperecomputing.com>, thang@os.amperecomputing.com
Subject: [PATCH v9 2/9] docs: hwmon: (smpro-hwmon) Add documentation
Date: Thu, 29 Sep 2022 16:43:14 +0700 [thread overview]
Message-ID: <20220929094321.770125-3-quan@os.amperecomputing.com> (raw)
In-Reply-To: <20220929094321.770125-1-quan@os.amperecomputing.com>
Add documentation for the Ampere(R)'s Altra(R) SMpro hwmon driver.
Signed-off-by: Thu Nguyen <thu@os.amperecomputing.com>
Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>
Reviewed-by: Guenter Roeck <linux@roeck-us.net>
---
Changes in v9:
+ Update SPDX license [Greg]
Changes from v3=>v8:
+ None
Changes in v2:
+ Removed "virtual" sensors [Guenter]
+ Fixed typo "mili" to "milli", "nanoWatt" to "microWatt" [Guenter]
+ Reported SOC_TDP as "Socket TDP" using max attributes [Guenter]
+ Clarified "highest" meaning in documentation [Guenter]
+ Reported MEM HOT Threshold for all DIMMs as temp*_crit [Guenter]
+ Removed Socket TDP sensor [Quan]
+ Included sensor type and channel in labels [Quan]
Documentation/hwmon/index.rst | 1 +
Documentation/hwmon/smpro-hwmon.rst | 101 ++++++++++++++++++++++++++++
2 files changed, 102 insertions(+)
create mode 100644 Documentation/hwmon/smpro-hwmon.rst
diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
index c1d11cf13eef..ddff3c5713d7 100644
--- a/Documentation/hwmon/index.rst
+++ b/Documentation/hwmon/index.rst
@@ -187,6 +187,7 @@ Hardware Monitoring Kernel Drivers
sis5595
sl28cpld
smm665
+ smpro-hwmon
smsc47b397
smsc47m192
smsc47m1
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
--
2.35.1
next prev parent reply other threads:[~2022-09-29 9:44 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 ` Quan Nguyen [this message]
2022-10-01 12:56 ` [PATCH v9 2/9] docs: hwmon: (smpro-hwmon) Add documentation 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
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=20220929094321.770125-3-quan@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).