diff mbox series

[2/2] Added documentation for Maxim Integrated max20754 hwmon userspace sysfs.

Message ID a8d037609be3e6f81bc15e2a6c24cb7809e3226b.1657204859.git.atif.ofluoglu@analog.com (mailing list archive)
State Changes Requested
Headers show
Series Adding MAX20754 support | expand

Commit Message

Atif Ofluoglu July 7, 2022, 3:29 p.m. UTC 
From: Atif Ofluoglu <atif.ofluoglu@analog.com>

Signed-off-by: Atif Ofluoglu <atif.ofluoglu@analog.com>
---
 Documentation/hwmon/max20754.rst | 122 +++++++++++++++++++++++++++++++
 1 file changed, 122 insertions(+)
 create mode 100644 Documentation/hwmon/max20754.rst

Comments

kernel test robot July 8, 2022, 6:41 a.m. UTC | #1 
Hi Atif,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on groeck-staging/hwmon-next]
[also build test WARNING on linus/master v5.19-rc5 next-20220707]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Atif-Ofluoglu/Adding-MAX20754-support/20220707-233249
base:   https://git.kernel.org/pub/scm/linux/kernel/git/groeck/linux-staging.git hwmon-next
reproduce: make htmldocs

If you fix the issue, kindly add following tag where applicable
Reported-by: kernel test robot <lkp@intel.com>

All warnings (new ones prefixed by >>):

>> Documentation/hwmon/max20754.rst: WARNING: document isn't included in any toctree
>> Documentation/hwmon/max20754.rst:49: WARNING: Malformed table.
diff mbox series

Patch

diff --git a/Documentation/hwmon/max20754.rst b/Documentation/hwmon/max20754.rst
new file mode 100644
index 000000000000..30cb1356cabf
--- /dev/null
+++ b/Documentation/hwmon/max20754.rst
@@ -0,0 +1,122 @@ 
+.. SPDX-License-Identifier: GPL-2.0
+
+Kernel driver MAX20754
+======================
+
+Supported chips:
+
+  * Maxim MAX20754
+
+    Prefix: 'max20754'
+
+    Addresses scanned: -
+
+    Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX20754.pdf
+    Application Note: 
+
+Author: Atif Emre Ofluoglu  <Atif.Ofluoglu@analog.com>
+
+
+Description
+-----------
+
+This driver supports MAX20754 Dual-Output, Configurable Multiphase 
+Power-Supply Controller with PMBus Interface and Internal Buck Converter.
+
+The driver is a client driver to the core PMBus driver.
+Please see Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
+
+
+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.
+
+
+Platform data support
+---------------------
+
+The driver supports standard PMBus driver platform data.
+
+
+Sysfs entries
+-------------
+
+The following attributes are supported.
+
+=============================== ===============================================
+in1_input   Measured voltage on Supply Voltage. 
+in1_label   "vin1"
+in1_alarm   Input voltage under-voltage alarm
+
+in2_label		"vout1"
+in2_input		Measured voltage on RAIL1.
+in2_min			Minimum output voltage.
+in2_max			Maximum output voltage.
+in2_lcrit		Critical minimum output voltage.
+in2_crit		Critical maximum output voltage.
+in2_lcrit_alarm		Output voltage critical low alarm.
+in2_crit_alarm    Output voltage critical high alarm.
+in2_min_alarm		Output voltage low alarm.
+in2_max_alarm		Output voltage high alarm.
+in2_rated_max   Maximum rated output voltage
+in2_rated_min   Minimum rated output voltage
+
+in3_label		"vout2"
+in3_input		Measured voltage on RAIL2.
+in3_min			Minimum output voltage.
+in3_max			Maximum output voltage.
+in3_lcrit		Critical minimum output voltage.
+in3_crit		Critical maximum output voltage.
+in3_lcrit_alarm		Output voltage critical low alarm.
+in3_crit_alarm    Output voltage critical high alarm.
+in3_min_alarm		Output voltage low alarm.
+in3_max_alarm		Output voltage high alarm.
+in3_rated_max   Maximum rated output voltage
+in3_rated_min   Minimum rated output voltage
+
+curr1_input Measured output current  on RAIL1.
+curr1_label "iout1"
+curr1_max		Maximum output current.
+curr1_max_alarm   Output current high alarm.
+curr1_crit    Critical maximum current
+curr1_crit_alarm    Current critical high alarm
+
+curr2_input   Measured output current on RAIL2.
+curr2_label   "iout2"
+curr2_max   Maximum output current.
+curr2_max_alarm   Output current high alarm.
+curr2_crit    Critical maximum current
+curr2_crit_alarm    Current critical high alarm
+
+temp1_input   Measured Temperature value of Die Core
+temp1_crit    Maximum Temperature value of Die Core
+temp1_crit_alarm    Maximum Temperature Alarm of Die Core
+temp1_max   Over Temperature Warning value of Die Core
+temp1_max_alarm Over Temperature Warning value of Die Core
+temp1_min  Under Temperature value of Die Core
+temp1_min_alarm Under Temperature Alarm of Die Core
+
+temp1_input   Measured Temperature value of Temperature Sense 1
+temp1_crit    Maximum Temperature value of Temperature Sense 1
+temp1_crit_alarm    Maximum Temperature Alarm of Temperature Sense 1
+temp1_max   Over Temperature Warning value of Temperature Sense 1
+temp1_max_alarm Over Temperature Warning value of Temperature Sense 1
+temp1_min  Under Temperature value of Temperature Sense 1
+temp1_min_alarm Under Temperature Alarm of Temperature Sense 1
+
+temp1_input   Measured Temperature value of Temperature Sense 1
+temp1_crit    Maximum Temperature value of Temperature Sense 1
+temp1_crit_alarm    Maximum Temperature Alarm of Temperature Sense 1
+temp1_max   Over Temperature Warning value ofTemperature Sense 1
+temp1_max_alarm Over Temperature Warning Temperature Sense 1
+temp1_min  Under Temperature value of Temperature Sense 1
+temp1_min_alarm Under Temperature Alarm of Temperature Sense 1
+
+vout1_command   Determine Voltage read format of RAIL1
+vout2_command   Determine Voltage read format of RAIL2
+
+on_off_config   Configures Power On/Off behavior.
+operation   Configures Power Supply Operation Mode.
\ No newline at end of file