diff mbox series

Documentation: hwmon: Add descriptions for ina2xx sysfs entries

Message ID 20181119203116.25589-1-nicoleotsuka@gmail.com (mailing list archive)
State Accepted
Headers show
Series Documentation: hwmon: Add descriptions for ina2xx sysfs entries | expand

Commit Message

Nicolin Chen Nov. 19, 2018, 8:31 p.m. UTC 
There are a few sysfs entries being exposed to user space by the
ina2xx hwmon driver while not getting explicitly documented. So
this patch just adds a description section for them.

Signed-off-by: Nicolin Chen <nicoleotsuka@gmail.com>
---
 Documentation/hwmon/ina2xx | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

Guenter Roeck Nov. 21, 2018, 11:42 p.m. UTC | #1 
On Mon, Nov 19, 2018 at 12:31:16PM -0800, Nicolin Chen wrote:
> There are a few sysfs entries being exposed to user space by the
> ina2xx hwmon driver while not getting explicitly documented. So
> this patch just adds a description section for them.
> 
> Signed-off-by: Nicolin Chen <nicoleotsuka@gmail.com>

Applied to hwmon-next.

Thanks,
Guenter
diff mbox series

Patch

diff --git a/Documentation/hwmon/ina2xx b/Documentation/hwmon/ina2xx
index b8df81f6d6bc..0f36c021192d 100644
--- a/Documentation/hwmon/ina2xx
+++ b/Documentation/hwmon/ina2xx
@@ -62,3 +62,18 @@  bus and shunt voltage conversion times multiplied by the averaging rate. We
 don't touch the conversion times and only modify the number of averages. The
 lower limit of the update_interval is 2 ms, the upper limit is 2253 ms.
 The actual programmed interval may vary from the desired value.
+
+General sysfs entries
+-------------
+
+in0_input		Shunt voltage(mV) channel
+in1_input		Bus voltage(mV) channel
+curr1_input		Current(mA) measurement channel
+power1_input		Power(uW) measurement channel
+shunt_resistor		Shunt resistance(uOhm) channel
+
+Sysfs entries for ina226, ina230 and ina231 only
+-------------
+
+update_interval		data conversion time; affects number of samples used
+			to average results for shunt and bus voltages.