iio:Documentation:ABI Add missing elements as used by the adi,ad7150
authorJonathan Cameron <Jonathan.Cameron@huawei.com>
Sun, 14 Mar 2021 18:15:08 +0000 (18:15 +0000)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Wed, 7 Apr 2021 07:36:37 +0000 (08:36 +0100)
Main additions are around thresh_adaptive.  This has been supported
by the core of IIO for a long time, but no driver that uses it has
previously graduated from staging, hence we are missing Docs.

Otherwise, just new entries in existing lists.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Reviewed-by: Alexandru Ardelean <ardeleanalex@gmail.com>
Link: https://lore.kernel.org/r/20210314181511.531414-22-jic23@kernel.org
Documentation/ABI/testing/sysfs-bus-iio

index affd4ce871d7bd7c0559fc3c461c15bf695e7f97..267973541e721a9ef3fc43400fa2943ff5dba3c9 100644 (file)
@@ -371,6 +371,7 @@ What:               /sys/bus/iio/devices/iio:deviceX/in_humidityrelative_offset
 What:          /sys/bus/iio/devices/iio:deviceX/in_magn_offset
 What:          /sys/bus/iio/devices/iio:deviceX/in_rot_offset
 What:          /sys/bus/iio/devices/iio:deviceX/in_angl_offset
+What:          /sys/bus/iio/devices/iio:deviceX/in_capacitanceX_offset
 KernelVersion: 2.6.35
 Contact:       linux-iio@vger.kernel.org
 Description:
@@ -702,6 +703,8 @@ What:               /sys/.../iio:deviceX/events/in_voltageY_thresh_falling_en
 What:          /sys/.../iio:deviceX/events/in_voltageY_thresh_either_en
 What:          /sys/.../iio:deviceX/events/in_tempY_thresh_rising_en
 What:          /sys/.../iio:deviceX/events/in_tempY_thresh_falling_en
+What:          /sys/.../iio:deviceX/events/in_capacitanceY_thresh_rising_en
+What:          /sys/.../iio:deviceX/events/in_capacitanceY_thresh_falling_en
 KernelVersion: 2.6.37
 Contact:       linux-iio@vger.kernel.org
 Description:
@@ -779,6 +782,32 @@ Description:
                a given event type is enabled a future point (and not those for
                whatever event was previously enabled).
 
+What:          /sys/.../events/in_capacitanceY_adaptive_thresh_rising_en
+What:          /sys/.../events/in_capacitanceY_adaptive_thresh_falling_en
+KernelVersion: 5.13
+Contact:       linux-iio@vger.kernel.org
+Descrption:
+               Adaptive thresholds are similar to normal fixed thresholds
+               but the value is expressed as an offset from a value which
+               provides a low frequency approximation of the channel itself.
+               Thus these detect if a rapid change occurs in the specified
+               direction which crosses tracking value + offset.
+               Tracking value calculation is devices specific.
+
+What:          /sys/.../in_capacitanceY_adaptive_thresh_rising_timeout
+What:          /sys/.../in_capacitanceY_adaptive_thresh_falling_timeout
+KernelVersion: 5.11
+Contact:       linux-iio@vger.kernel.org
+Descrption:
+               When adaptive thresholds are used, the tracking signal
+               may adjust too slowly to step changes in the raw signal.
+               *_timeout (in seconds) specifies a time for which the
+               difference between the slow tracking signal and the raw
+               signal is allowed to remain out-of-range before a reset
+               event occurs in which the tracking signal is made equal
+               to the raw signal, allowing slow tracking to resume and the
+               adaptive threshold event detection to function as expected.
+
 What:          /sys/.../events/in_accel_thresh_rising_value
 What:          /sys/.../events/in_accel_thresh_falling_value
 What:          /sys/.../events/in_accel_x_raw_thresh_rising_value
@@ -819,6 +848,10 @@ What:              /sys/.../events/in_proximity0_thresh_falling_value
 What:          /sys/.../events/in_proximity0_thresh_rising_value
 What:          /sys/.../events/in_illuminance_thresh_rising_value
 What:          /sys/.../events/in_illuminance_thresh_falling_value
+What:          /sys/.../events/in_capacitanceY_thresh_rising_value
+What:          /sys/.../events/in_capacitanceY_thresh_falling_value
+What:          /sys/.../events/in_capacitanceY_thresh_adaptive_rising_value
+What:          /sys/.../events/in_capacitanceY_thresh_falling_rising_value
 KernelVersion: 2.6.37
 Contact:       linux-iio@vger.kernel.org
 Description: