From:   Lakshmi Yadlapati <lakshmiy@us.ibm.com>
To:     robh+dt@kernel.org, linux@roeck-us.net, jdelvare@suse.com,
        krzysztof.kozlowski+dt@linaro.org, joel@jms.id.au, andrew@aj.id.au,
        eajames@linux.ibm.com
Cc:     linux-kernel@vger.kernel.org, linux-hwmon@vger.kernel.org,
        devicetree@vger.kernel.org, Lakshmi Yadlapati <lakshmiy@us.ibm.com>
Subject: [PATCH v2 4/5] docs: hwmon: Add documenttaion for acbel-crps PSU
Date:   Mon, 20 Mar 2023 10:40:18 -0500
Message-Id: <20230320154019.1943770-5-lakshmiy@us.ibm.com>
In-Reply-To: <20230320154019.1943770-1-lakshmiy@us.ibm.com>
References: <20230320154019.1943770-1-lakshmiy@us.ibm.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

Add documentation changes for acbel-crps psu

Signed-off-by: Lakshmi Yadlapati <lakshmiy@us.ibm.com>
---
 Documentation/hwmon/acbel-crps.rst | 81 ++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)
 create mode 100644 Documentation/hwmon/acbel-crps.rst

diff --git a/Documentation/hwmon/acbel-crps.rst b/Documentation/hwmon/acbel-crps.rst
new file mode 100644
index 000000000000..89a43fb88c8c
--- /dev/null
+++ b/Documentation/hwmon/acbel-crps.rst
@@ -0,0 +1,81 @@
+Kernel driver acbel-crps
+=======================
+
+Supported chips:
+
+  * ACBEL Common Redundant Power Supply.
+  Supported models: FSG032-00xG
+
+Author: Lakshmi Yadlapati <lakshmiy@us.ibm.com>
+
+Description
+-----------
+
+This driver supports ACBEL Common Redundant Power Supply. This driver
+is a client to the core PMBus driver.
+
+Usage Notes
+-----------
+
+This driver does not auto-detect devices. You will have to instantiate the
+devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
+details.
+
+Sysfs entries
+-------------
+
+The following attributes are supported:
+
+======================= ======================================================
+curr1_crit          Critical maximum current.
+curr1_crit_alarm    Input current critical alarm.
+curr1_input         Measured output current.
+curr1_label         "iin"
+curr1_max           Maximum input current.
+curr1_max_alarm     Maximum input current high alarm.
+curr1_rated_max     Maximum rated input current.
+curr2_crit          Critical maximum current.
+curr2_crit_alarm    Output current critical alarm.
+curr2_input         Measured output current.
+curr2_label         "iout1"
+curr2_max           Maximum output current.
+curr2_max_alarm     Output current high alarm.
+curr2_rated_max     Maximum rated output current.
+
+
+fan1_alarm          Fan 1 warning.
+fan1_fault	    Fan 1 fault.
+fan1_input	    Fan 1 speed in RPM.
+fan1_target         Set fan speed reference.
+
+in1_alarm           Input voltage under-voltage alarm.
+in1_input           Measured input voltage.
+in1_label           "vin"
+in1_rated_max       Maximum rated input voltage.
+in1_rated_min       Minimum rated input voltage.
+in2_crit            Critical maximum output voltage.
+in2_crit_alarm      Output voltage critical high alarm.
+in2_input           Measured output voltage.
+in2_label           "vout1"
+in2_lcrit           Critical minimum output voltage.
+in2_lcrit_alarm     Output voltage critical low alarm.
+in2_rated_max       Maximum rated output voltage.
+in2_rated_min       Minimum rated output voltage.
+
+power1_alarm        Input fault or alarm.
+power1_input        Measured input power.
+power1_label        "pin"
+power1_max          Input power limit.
+power1_rated_max    Maximum rated input power.
+power2_crit         Critical output power limit.
+power2_crit_alarm   Output power crit alarm limit exceeded.
+power2_input        Measured output power.
+power2_label        "pout"
+power2_max          Output power limit.
+power2_max_alarm    Output power high alarm.
+power2_rated_max    Maximum rated output power.
+
+temp[1-3]_input     Measured temperature.
+temp[1-2]_max       Maximum temperature.
+temp[1-3]_rated_max Temperature high alarm.
+======================= ======================================================
-- 
2.37.2