From:   Quan Nguyen <quan@os.amperecomputing.com>
To:     Joel Stanley <joel@jms.id.au>, Andrew Jeffery <andrew@aj.id.au>,
        Jean Delvare <jdelvare@suse.com>,
        Guenter Roeck <linux@roeck-us.net>,
        Rob Herring <robh+dt@kernel.org>,
        Lee Jones <lee.jones@linaro.org>,
        Jonathan Corbet <corbet@lwn.net>, linux-hwmon@vger.kernel.org,
        devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
        linux-doc@vger.kernel.org, linux-aspeed@lists.ozlabs.org,
        openbmc@lists.ozlabs.org, Mark Brown <broonie@kernel.org>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        "Rafael J . Wysocki" <rafael@kernel.org>,
        Derek Kiernan <derek.kiernan@xilinx.com>,
        Dragan Cvetic <dragan.cvetic@xilinx.com>,
        Arnd Bergmann <arnd@arndb.de>,
        Gustavo Pimentel <Gustavo.Pimentel@synopsys.com>
Cc:     Open Source Submission <patches@amperecomputing.com>,
        Phong Vo <phong@os.amperecomputing.com>,
        "Thang Q . Nguyen" <thang@os.amperecomputing.com>,
        Quan Nguyen <quan@os.amperecomputing.com>,
        Thu Nguyen <thu@os.amperecomputing.com>
Subject: [PATCH v6 4/9] docs: hwmon: (smpro-hwmon) Add documentation
Date:   Fri, 24 Dec 2021 11:13:47 +0700
Message-Id: <20211224041352.29405-5-quan@os.amperecomputing.com>
In-Reply-To: <20211224041352.29405-1-quan@os.amperecomputing.com>
References: <20211224041352.29405-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?UjSzoc6XbuJd+WnlZJLDTPlXHfsN5fUm6HULIaYTbiPApEiyS5bwfhbQZBpB?=
 =?us-ascii?Q?Ttkg1LkyyJVYEyyNwecb4ff9slW0HCMdIgQ4XmTuSqdnvb0M5v/nyMFBPXCU?=
 =?us-ascii?Q?yAyee9+uxqnP4E2mGdM4ataPlGKLgyVnV3ER4BCZbPe4qT6T+Ts1AKhUsY+g?=
 =?us-ascii?Q?puNX5nGaLcEWvPRIMVAPncvgkKeZsGfslAkA4bEQ9zWvgWt+hpvYyJL1yLwO?=
 =?us-ascii?Q?jUsCAQceyMz/7q2/hodS8L5GYbhYyQiyYAsP4Xr+xu3aijdAnEvKxkz6WD4i?=
 =?us-ascii?Q?IHQ1VoIHHUYaUESUPv5iPZ3XdQ9MNDRlJWTLnJzKdc/d5tOc0tQg6xoaIjVa?=
 =?us-ascii?Q?KmIwjrRRO9VWhkJcfTNmgjO/vwejFD8QdKTIZO4VphhvphQjU+IApb0/L0IH?=
 =?us-ascii?Q?UV3k+JQK1qjmKUnCJ9qdMBnxivS8FAkch49Jwm4LJvS8G2FLX+MlUTjPZ0Ce?=
 =?us-ascii?Q?VQMTPGaqYNnLNj5IUk0d5KoeJAdg7OuThIAfX4oFlqfGWZH19FnZsth1JEC3?=
 =?us-ascii?Q?u+SFoYXjuEnCdcFDyZvc7gNPUtNDwjT4IebXF40oHJLyZpO9pf66qFmS6N7c?=
 =?us-ascii?Q?ML3VzVEnSbKVSviv6IDw02Ia53Q+lJHVS0nQbbcRVDeVPbiqldnBsscDrIos?=
 =?us-ascii?Q?kSSqoxACt2Ul7iZ/Jp9RAjk9FZJ2WjfxIQegUQ9Q+2upkhpnXEJUWLUvzF0n?=
 =?us-ascii?Q?U78yWmnKD16wVSifAwdET9ZUKCOHVRw7ZF0bOgd2gHd7PdH+tu5rhxm1znRd?=
 =?us-ascii?Q?gzTin1J40bykbhTjoSaG4X6GJvZ95C2ypeSFK3iRNStQYRUoSOE0YehMcUeB?=
 =?us-ascii?Q?StZOSGbEoM+8FFM7tC/Wsx/aKtjw/pdY5dykXtZZTOHXTXkL0dZv9aGyua8U?=
 =?us-ascii?Q?b97wztxHEuZxrdM20rUTNGDiF+LKkv/jzp3eoupRKjAMmV2DtdjPWPRqTaXC?=
 =?us-ascii?Q?fCWl7XsZiBg55M8wLaybuCj7vVgr7HYyWy38n3criNVhjCQnDht21ltLp9jC?=
 =?us-ascii?Q?caqG8pod4/bHXpNq07BK0lqLYC6eIK180lpXYBbhrc0BS2mf4Iuxwnqu9H9q?=
 =?us-ascii?Q?SOE5ZUdBWst+avtmJVrKg68yntlTTsd+fhQCn0LFbMSUiiAeg1qzXB7qrje2?=
 =?us-ascii?Q?KEGl1Cte2BmiZpRe584kzxf+ShNOx0QcO2/mf4eWu9CuEUJqHF0ls+PZo+PS?=
 =?us-ascii?Q?cLLqV+ko4rQ1Re4Xuacol0haGJw0U04LyXko4Pfe24WHvvtR2dZjL0ruUxqT?=
 =?us-ascii?Q?a56djdahY9Qq/5637v0osctQxyXfS1LbSKT2h/SNmu1LAaXuI2wIOn3saqcd?=
 =?us-ascii?Q?cGMmcuVT0bfgYTjC7Nfq7gKCB4CWCyayAm0NDMYguKXoIz4qH7il77r+lh+H?=
 =?us-ascii?Q?lBqhyKlGTaA5BWADTTqpLjvpg3gmX35qeA9w8HW3FrKcLEnei4FSuQi3TezX?=
 =?us-ascii?Q?tDB3Te/ezFEyv241jkMO3PqHHS5tFGpvBx14US0DiR2CrJiWT8L1SIdo+P+K?=
 =?us-ascii?Q?0MYZp1Cf6hLXKkt0G8A1B84YaEVEKTmGsFSHY2H101Sh2WEq9qUqYK+fN8cH?=
 =?us-ascii?Q?u7xMLMK4vgQEPk72dZAtaadyxamlY6F/MzR6UagJS5G9/BaMMD/ULTBVPgUO?=
 =?us-ascii?Q?EtrK3L7aX87DjfEyOFNCFnRKk3RSI0NwYOlcqxjXYr79/D1kXRfzAKQ1VcDH?=
 =?us-ascii?Q?M4EHIzKpM8arA2k8bDNB9ADjJgI=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 9f39db4d-fd3b-4cc7-a66c-08d9c693fa57
X-MS-Exchange-CrossTenant-AuthSource: SJ0PR01MB7282.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 24 Dec 2021 04:15:11.8125
 (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: oMSwh/6JoVOi4QYZXClBBIu5TL2sewtSacO5whEPugqxe8mUTprpsOZ++KfrEsAxm418eQ7XuvlXAYRXvz6TnEzWHD3zM7+Am2nuNbGZ7S4=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BYAPR01MB5189
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 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 df20022c741f..79d1b8023186 100644
--- a/Documentation/hwmon/index.rst
+++ b/Documentation/hwmon/index.rst
@@ -180,6 +180,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.28.0