Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) client-ip=2620:137:e000::1:18;
From:   Quan Nguyen <quan@os.amperecomputing.com>
To:     Lee Jones <lee.jones@linaro.org>, Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzk+dt@kernel.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>,
        Gustavo Pimentel <Gustavo.Pimentel@synopsys.com>,
        linux-kernel@vger.kernel.org (open list),
        devicetree@vger.kernel.org (open list:OPEN FIRMWARE AND FLATTENED
        DEVICE TREE BINDINGS),
        linux-hwmon@vger.kernel.org (open list:HARDWARE MONITORING),
        linux-doc@vger.kernel.org (open list:DOCUMENTATION),
        OpenBMC Maillist <openbmc@lists.ozlabs.org>
Cc:     Open Source Submission <patches@amperecomputing.com>,
        Phong Vo <phong@os.amperecomputing.com>,
        "Thang Q . Nguyen" <thang@os.amperecomputing.com>
Subject: [PATCH v7 2/9] docs: hwmon: (smpro-hwmon) Add documentation
Date:   Mon, 21 Mar 2022 15:13:48 +0700
Message-Id: <20220321081355.6802-3-quan@os.amperecomputing.com>
In-Reply-To: <20220321081355.6802-1-quan@os.amperecomputing.com>
References: <20220321081355.6802-1-quan@os.amperecomputing.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?tQ80XCb/330diS8nkRlyl8Oof6frapfep23OVNCivdWzH8uHn6tEYRST7Jy+?=
 =?us-ascii?Q?igIIKi3KYtUMHz+61wCj2z8SyNOwBfWYA9UOFre7f7aAcLrNkLDV7oYCpifa?=
 =?us-ascii?Q?XYKdUllW3Wom5YQO3SISkHU+AczaZNEHPdsLNNW6fzdssw0tIQm4XVcsrjP8?=
 =?us-ascii?Q?u0DMcLZUSrGnl1y/s7J/S3oCvSVjvY/rUXbVeQB3JM4xGBeRK2MgrUqSAfQ1?=
 =?us-ascii?Q?WAwqnI7aHVL9KvOaLvCVYExMMLIMkFwtAKPvKz5lRRBkE1/ToOAlt2riesxS?=
 =?us-ascii?Q?Yxg4CCCa92dAgRCMez15lcgiRP5VglesCOBRsIUA/k6RhvjkJZv3U8tB5y5N?=
 =?us-ascii?Q?Cp005W31yJrQZkbkrjsdH0Y19jnrldFsa946CzNi7noL/w6BIKq7fafXVKqz?=
 =?us-ascii?Q?y2EbrLOiUmU08btp43n/AiPbu+gHkFMy9egdXeD2jrsn6lgVFvJ0G5NehsgC?=
 =?us-ascii?Q?S0EsO/zfJ+GHDdQ2kFsV5VguYnb747O5weK1vmQKvdg5SYgRNzkGfeZlFE6e?=
 =?us-ascii?Q?niH+BRxyhSEYnIyoVeFRd5b7tUSctoTJpX1VoBII4wDUINUopseMZA1VHggp?=
 =?us-ascii?Q?J7rYhzXBE/vU8OhcAOIToxFXelLAYIKVt+fj3LfqVsdzyDH3WETOz5VvUF3D?=
 =?us-ascii?Q?n5KiIIsX05yyc3iGYIihpqyofwobDs5p6rCpqW755v9Q+6IDopqw/ZCZpyuc?=
 =?us-ascii?Q?uhiAvn6kpAqqMdfswyNRfI7aXD3M3xYerLHeIpno4yc1Dj6jttifkt1Ts4AC?=
 =?us-ascii?Q?evefsrvQBROYFOjxdEvXbCoIcZtacX9w5aghrcy/Bou807wiqHGJef8hUlHN?=
 =?us-ascii?Q?7G3a8c+XOXdmXgzvCFUccxjTSNTVSWyilTMwgdRlHxm2KjuPU3XBmjyZ0DD2?=
 =?us-ascii?Q?XyABSjNWIlKZAXFoJlo3ju6fqiqwv2DBcK84qmjy57cV4LqVXfTDkH63peT6?=
 =?us-ascii?Q?dzx8Cn/zNhpw9eeIZzzI9oaL+Rj3XZVsBJRC6Zy8bQWoR/vAhwHMKlbRXJrr?=
 =?us-ascii?Q?grIZuoXGcEc6h8xGtzlvdMp2QAws92fHKkAApwblzTxIJqn1YUD6DdV/Ncyg?=
 =?us-ascii?Q?GoIbNee9dT8tkqLrvoI0XCnXMuZYLyE9X9qmWwfEuAn3SIapVhVs9i9Sf82f?=
 =?us-ascii?Q?h6bSBE2rrIfHTM1W9Ar4cdomagVCFn6yS46H+2USx3rJ5Kqley0VhEpyw6P8?=
 =?us-ascii?Q?k/UijtNssJXElvr4BP3i/z/ElZt87q8hv2qL3rpCN+BcQ1xRA58CNsx0NKc7?=
 =?us-ascii?Q?KI9wDfbLV6zlPavlOGhK60AA1uUcsGXawOxlC9hXrdUOuqEjNFwyZv1yg5un?=
 =?us-ascii?Q?XLxVI/dlfQ4kFrYmn4NosIBSAMEbYXH5nDoROFS7ydZQqRnAffrpGBxVlNny?=
 =?us-ascii?Q?bVcxonehPQhLQtSbttHrCP8hHPi0TG/cE0IQzyZMqejhyfvwiXTn4iczwu/V?=
 =?us-ascii?Q?viDA3mi48T9HEDZdFwOHCzaFsG/1yxAC//cq4kDj4T8HxMq9X/Kt2FxNB4Y2?=
 =?us-ascii?Q?7BrPOP5NzXZ+TRo=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 9b185918-72ad-4120-9e84-08da0b12dab0
X-MS-Exchange-CrossTenant-AuthSource: SJ0PR01MB7282.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 21 Mar 2022 08:14:43.6420
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3bc2b170-fd94-476d-b0ce-4229bdc904a7
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: qkHmDltipSR3dBmk3R4ITW4BWOBfXAiJRYkLu8FjW48yy5eDBaLGfOI1Nuv9rlXJWIUkuz8b6J/w2K9pW6opP5Z8QcsFE9Y3wMsDTv10P/o=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN6PR01MB2738
X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,RDNS_NONE,SPF_HELO_NONE,T_SCC_BODY_TEXT_LINE
	autolearn=no autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
	lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

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 v7:
  + None

Changes in v6:
  + None

Changes in v5:
  + None

Changes in v4:
  + None

Changes in v3:
  + 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 863b76289159..833dd38c93a6 100644
--- a/Documentation/hwmon/index.rst
+++ b/Documentation/hwmon/index.rst
@@ -184,6 +184,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..f978b1370e16
--- /dev/null
+++ b/Documentation/hwmon/smpro-hwmon.rst
@@ -0,0 +1,101 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+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