[PATCH 2/2] Documentation: ABI: add oversampling frequency in sysfs-bus-iio

From: Jorge Marques
Date: Fri Mar 21 2025 - 10:52:37 EST


Some devices have an internal clock used to space out the conversion
trigger for the oversampling filter,
Consider an ADC with conversion and data ready pins topology:

Sampling trigger | | | | |
ADC conversion ++++ ++++ ++++ ++++ ++++
ADC data ready * * * * *

With the oversampling frequency, conversions can be evenly space between
the sampling edge:

Sampling trigger | | | | |
ADC conversion + + + + + + + + + + + + + + + + + + + +
ADC data ready * * * * *

Signed-off-by: Jorge Marques <jorge.marques@xxxxxxxxxx>
---
Documentation/ABI/testing/sysfs-bus-iio | 17 +++++++++++++++++
1 file changed, 17 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index 33c09c4ac60a4feec82308461643134f5ba84b66..2317bacf6a2884691a08725d6f01d18555a96227 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -139,6 +139,23 @@ Contact: linux-iio@xxxxxxxxxxxxxxx
Description:
Hardware dependent values supported by the oversampling filter.

+What: /sys/bus/iio/devices/iio:deviceX/oversampling_frequency
+KernelVersion: 6.15
+Contact: linux-iio@xxxxxxxxxxxxxxx
+Description:
+ Some devices have internal clocks for the ADC oversampling.
+ Sets the resulting sampling frequency to trigger a conversion
+ used by the oversampling filter.
+ Can be used to evenly space conversion between the sampling edge
+ on some devices.
+
+What: /sys/bus/iio/devices/iio:deviceX/oversampling_frequency_available
+KernelVersion: 6.15
+Contact: linux-iio@xxxxxxxxxxxxxxx
+Description:
+ Hardware dependent values supported by the oversampling
+ frequency.
+
What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_raw
What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_raw
What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_i_raw

--
2.48.1