]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
iio: ABI: document accelerometer event attributes
authorGustavo Silva <gustavograzs@gmail.com>
Tue, 16 Sep 2025 23:38:24 +0000 (20:38 -0300)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Sun, 19 Oct 2025 10:59:16 +0000 (11:59 +0100)
Add ABI documentation for accelerometer event-related sysfs attributes
exposed by the bmi270 driver. These include threshold, period, and
enable controls for adaptive magnitude (any-motion) and rate of change
(no-motion) event detection.

Signed-off-by: Gustavo Silva <gustavograzs@gmail.com>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Documentation/ABI/testing/sysfs-bus-iio

index 89b4740dcfa14631368fbfc0618e8c6c8235a603..352ab7b8476c4555082950e3e728c268623a74d8 100644 (file)
@@ -926,6 +926,7 @@ What:               /sys/.../iio:deviceX/events/in_accel_y_roc_rising_en
 What:          /sys/.../iio:deviceX/events/in_accel_y_roc_falling_en
 What:          /sys/.../iio:deviceX/events/in_accel_z_roc_rising_en
 What:          /sys/.../iio:deviceX/events/in_accel_z_roc_falling_en
+What:          /sys/.../iio:deviceX/events/in_accel_x&y&z_roc_rising_en
 What:          /sys/.../iio:deviceX/events/in_anglvel_x_roc_rising_en
 What:          /sys/.../iio:deviceX/events/in_anglvel_x_roc_falling_en
 What:          /sys/.../iio:deviceX/events/in_anglvel_y_roc_rising_en
@@ -1001,6 +1002,7 @@ Description:
                to the raw signal, allowing slow tracking to resume and the
                adaptive threshold event detection to function as expected.
 
+What:          /sys/.../events/in_accel_mag_adaptive_rising_value
 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
@@ -1147,6 +1149,7 @@ Description:
                will get activated once in_voltage0_raw goes above 1200 and will become
                deactivated again once the value falls below 1150.
 
+What:          /sys/.../events/in_accel_roc_rising_value
 What:          /sys/.../events/in_accel_x_raw_roc_rising_value
 What:          /sys/.../events/in_accel_x_raw_roc_falling_value
 What:          /sys/.../events/in_accel_y_raw_roc_rising_value
@@ -1193,6 +1196,8 @@ Description:
                value is in raw device units or in processed units (as _raw
                and _input do on sysfs direct channel read attributes).
 
+What:          /sys/.../events/in_accel_mag_adaptive_rising_period
+What:          /sys/.../events/in_accel_roc_rising_period
 What:          /sys/.../events/in_accel_x_thresh_rising_period
 What:          /sys/.../events/in_accel_x_thresh_falling_period
 What:          /sys/.../events/in_accel_x_roc_rising_period
@@ -1362,6 +1367,15 @@ Description:
                number or direction is not specified, applies to all channels of
                this type.
 
+What:          /sys/.../iio:deviceX/events/in_accel_x_mag_adaptive_rising_en
+What:          /sys/.../iio:deviceX/events/in_accel_y_mag_adaptive_rising_en
+What:          /sys/.../iio:deviceX/events/in_accel_z_mag_adaptive_rising_en
+KernelVersion: 2.6.37
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Similar to in_accel_x_thresh[_rising|_falling]_en, but here the
+               magnitude of the channel is compared to the adaptive threshold.
+
 What:          /sys/.../iio:deviceX/events/in_accel_mag_referenced_en
 What:          /sys/.../iio:deviceX/events/in_accel_mag_referenced_rising_en
 What:          /sys/.../iio:deviceX/events/in_accel_mag_referenced_falling_en
@@ -2422,3 +2436,23 @@ Description:
                Value representing the user's attention to the system expressed
                in units as percentage. This usually means if the user is
                looking at the screen or not.
+
+What:          /sys/.../events/in_accel_value_available
+KernelVersion: 6.18
+Contact:       linux-iio@vger.kernel.org
+Description:
+               List of available threshold values for acceleration event
+               generation. Applies to all event types on in_accel channels.
+               Units after application of scale and offset are m/s^2.
+               Expressed as:
+
+               - a range specified as "[min step max]"
+
+What:          /sys/.../events/in_accel_period_available
+KernelVersion: 6.18
+Contact:       linux-iio@vger.kernel.org
+Description:
+               List of available periods for accelerometer event detection in
+               seconds, expressed as:
+
+               - a range specified as "[min step max]"