hwmon: Document the samples attributes
authorAdamski, Krzysztof (Nokia - PL/Wroclaw) <krzysztof.adamski@nokia.com>
Sun, 14 Apr 2019 21:58:40 +0000 (21:58 +0000)
committerGuenter Roeck <linux@roeck-us.net>
Tue, 16 Apr 2019 00:19:53 +0000 (17:19 -0700)
Document new ABI attributes: {in,power,curr,temp}_samples and samples.

Signed-off-by: Krzysztof Adamski <krzysztof.adamski@nokia.com>
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Documentation/hwmon/sysfs-interface

index 2b9e100..7b91706 100644 (file)
@@ -756,6 +756,24 @@ intrusion[0-*]_beep
                1: enable
                RW
 
+********************************
+* Average sample configuration *
+********************************
+
+Devices allowing for reading {in,power,curr,temp}_average values may export
+attributes for controlling number of samples used to compute average.
+
+samples                Sets number of average samples for all types of measurements.
+               RW
+
+in_samples
+power_samples
+curr_samples
+temp_samples    Sets number of average samples for specific type of measurements.
+               Note that on some devices it won't be possible to set all of them
+               to different values so changing one might also change some others.
+               RW
+
 
 sysfs attribute writes interpretation
 -------------------------------------