iio: ABI: document temperature and humidity peak/trough raw attributes
authorJavier Carrasco <javier.carrasco.cruz@gmail.com>
Mon, 11 Dec 2023 12:28:40 +0000 (20:28 +0800)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Mon, 11 Dec 2023 19:37:10 +0000 (19:37 +0000)
The in_temp_peak_raw attribute is already in use, but its documentation
is still missing. The in_humidityrelative_raw must be documented for a
new iio user that supports this attribute. Add temp and humidityrelative
use cases.
When at it, remove an extra blank space in the description.

For users that support minimum values, a new in_<type>_trough_raw
attribute is required. Add this attribute and document the first uses of
it for temp and humidityrelative types.

Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
Link: https://lore.kernel.org/r/20231211122840.9760-1-579lpy@gmail.com
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Documentation/ABI/testing/sysfs-bus-iio

index 94b8d8461b7c7d4e0e1ca10ed37593658067f5a6..2e6d5ebfd3c73d3c9e394ffb1039b54e73e7544d 100644 (file)
@@ -362,10 +362,21 @@ Description:
 What:          /sys/bus/iio/devices/iio:deviceX/in_accel_x_peak_raw
 What:          /sys/bus/iio/devices/iio:deviceX/in_accel_y_peak_raw
 What:          /sys/bus/iio/devices/iio:deviceX/in_accel_z_peak_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_humidityrelative_peak_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_temp_peak_raw
 KernelVersion: 2.6.36
 Contact:       linux-iio@vger.kernel.org
 Description:
-               Highest value since some reset condition.  These
+               Highest value since some reset condition. These
+               attributes allow access to this and are otherwise
+               the direct equivalent of the <type>Y[_name]_raw attributes.
+
+What:          /sys/bus/iio/devices/iio:deviceX/in_humidityrelative_trough_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_temp_trough_raw
+KernelVersion: 6.7
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Lowest value since some reset condition. These
                attributes allow access to this and are otherwise
                the direct equivalent of the <type>Y[_name]_raw attributes.