]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
Documentation: ABI: IIO: Re-add sysfs-bus-iio-adc-ad4130
authorMarcelo Schmitt <marcelo.schmitt@analog.com>
Tue, 4 Feb 2025 15:00:57 +0000 (12:00 -0300)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Sat, 8 Feb 2025 15:39:41 +0000 (15:39 +0000)
The ad4130 driver exports in_voltageY-voltageZ_filter_mode and
in_voltage-voltage_filter_mode_available attributes to user space. A
previous patch merged the documentation for those attributes with the
documentation for filter_type/filter_type_available into sysfs-bus-iio.
Filter mode and filter type refer to the same feature which is the digital
filter applied over ADC samples. However, since datasheets use the term
`filter type` and ad4130 driver is the only one using filter_mode,
deprecate the filter_mode ABI in favor of filter_type and keep the docs
separate to avoid confusion and intricate attribute descriptions.

Fixes: 01bb12922b60 ("Documentation: ABI: added filter mode doc in sysfs-bus-iio")
Signed-off-by: Marcelo Schmitt <marcelo.schmitt@analog.com>
Reviewed-by: David Lechner <dlechner@baylibre.com>
Link: https://patch.msgid.link/c77b2d65f1115c1c394582f55944d6f685058f9c.1738680728.git.marcelo.schmitt@analog.com
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Documentation/ABI/testing/sysfs-bus-iio
Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130 [new file with mode: 0644]
MAINTAINERS

index 6a2543aa36eb316caab4c39d059edb9dc231d443..b8838cb92d38d129ff07be29e192e27fa80a9a5e 100644 (file)
@@ -2268,7 +2268,7 @@ Description:
                representing the sensor unique ID number.
 
 What:          /sys/bus/iio/devices/iio:deviceX/filter_type_available
-What:          /sys/bus/iio/devices/iio:deviceX/in_voltage-voltage_filter_mode_available
+What:          /sys/bus/iio/devices/iio:deviceX/in_voltage-voltage_filter_type_available
 KernelVersion: 6.1
 Contact:       linux-iio@vger.kernel.org
 Description:
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130 b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130
new file mode 100644 (file)
index 0000000..d3fad27
--- /dev/null
@@ -0,0 +1,20 @@
+What:          /sys/bus/iio/devices/iio:deviceX/in_voltage-voltage_filter_mode_available
+KernelVersion:  6.2
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Reading returns a list with the possible filter modes.
+
+               This ABI is only kept for backwards compatibility and the values
+               returned are identical to filter_type_available attribute
+               documented in Documentation/ABI/testing/sysfs-bus-iio. Please,
+               use filter_type_available like ABI to provide filter options for
+               new drivers.
+
+What:          /sys/bus/iio/devices/iio:deviceX/in_voltageY-voltageZ_filter_mode
+KernelVersion:  6.2
+Contact:       linux-iio@vger.kernel.org
+Description:
+               This ABI is only kept for backwards compatibility and the values
+               returned are identical to in_voltageY-voltageZ_filter_type
+               attribute documented in Documentation/ABI/testing/sysfs-bus-iio.
+               Please, use in_voltageY-voltageZ_filter_type for new drivers.
index 311675697a82169c03c9df54c2e351aa1c1f5d82..a84fa86716e95aabc31463bc78081968de67e8df 100644 (file)
@@ -1311,6 +1311,7 @@ M:        Cosmin Tanislav <cosmin.tanislav@analog.com>
 L:     linux-iio@vger.kernel.org
 S:     Supported
 W:     https://ez.analog.com/linux-software-drivers
+F:     Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130
 F:     Documentation/devicetree/bindings/iio/adc/adi,ad4130.yaml
 F:     drivers/iio/adc/ad4130.c