]> asedeno.scripts.mit.edu Git - linux.git/commitdiff
Documentation: hwmon: Add descriptions for ina2xx sysfs entries
authorNicolin Chen <nicoleotsuka@gmail.com>
Mon, 19 Nov 2018 20:31:16 +0000 (12:31 -0800)
committerGuenter Roeck <linux@roeck-us.net>
Sun, 16 Dec 2018 23:13:15 +0000 (15:13 -0800)
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>
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Documentation/hwmon/ina2xx

index b8df81f6d6bcf995e098ebb4dce0a57a483bba66..0f36c021192d8e2b7d6d0464cb6160252c5ffea5 100644 (file)
@@ -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.