[PATCH v7 2/3] Documentation: ABI: added filter mode doc in sysfs-bus-iio

Ramona Alexandra Nechita posted 3 patches 1 month, 1 week ago
[PATCH v7 2/3] Documentation: ABI: added filter mode doc in sysfs-bus-iio
Posted by Ramona Alexandra Nechita 1 month, 1 week ago
The filter mode / filter type property is used for ad4130
and ad7779 drivers, therefore the ABI doc file for ad4130
was removed, merging both of them in the sysfs-bus-iio.
Since one of the drivers is available from 6.1, the version
has been set to 6.1 for these attributes.

Signed-off-by: Ramona Alexandra Nechita <ramona.nechita@analog.com>
---
 Documentation/ABI/testing/sysfs-bus-iio       | 22 +++++++++
 .../ABI/testing/sysfs-bus-iio-adc-ad4130      | 46 -------------------
 MAINTAINERS                                   |  1 -
 3 files changed, 22 insertions(+), 47 deletions(-)
 delete mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130

diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index 89943c2d54e8..541b3a28c1fd 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -2268,6 +2268,28 @@ Description:
 		An example format is 16-bytes, 2-digits-per-byte, HEX-string
 		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
+KernelVersion:	6.1
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Reading returns a list with the possible filter modes. Options
+		for the attribute:
+			* "sinc3"	- The digital sinc3 filter. Moderate 1st conversion time.
+		    Good noise performance.
+			* "sinc4"       - Sinc 4. Excellent noise performance. Long
+			1st conversion time.
+			* "sinc5"	- The digital sinc5 filter. Excellent noise performance
+			* "sinc4+sinc1" - Sinc4 + averaging by 8. Low 1st conversion
+		    time.
+			* "sinc3+rej60" - Sinc3 + 60Hz rejection.
+			* "sinc3+sinc1" - Sinc3 + averaging by 8. Low 1st conversion
+		    time.
+			* "sinc3+pf1"   - Sinc3 + device specific Post Filter 1.
+			* "sinc3+pf2"   - Sinc3 + device specific Post Filter 2.
+			* "sinc3+pf3"   - Sinc3 + device specific Post Filter 3.
+			* "sinc3+pf4"   - Sinc3 + device specific Post Filter 4.
+
 What:		/sys/.../events/in_proximity_thresh_either_runningperiod
 KernelVersion:	6.6
 Contact:	linux-iio@vger.kernel.org
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130 b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130
deleted file mode 100644
index f24ed6687e90..000000000000
--- a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130
+++ /dev/null
@@ -1,46 +0,0 @@
-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.
-
-		  * "sinc4"       - Sinc 4. Excellent noise performance. Long
-                    1st conversion time. No natural 50/60Hz rejection.
-
-		  * "sinc4+sinc1" - Sinc4 + averaging by 8. Low 1st conversion
-		    time.
-
-		  * "sinc3"	      - Sinc3. Moderate 1st conversion time.
-		    Good noise performance.
-
-		  * "sinc3+rej60" - Sinc3 + 60Hz rejection. At a sampling
-		    frequency of 50Hz, achieves simultaneous 50Hz and 60Hz
-		    rejection.
-
-		  * "sinc3+sinc1" - Sinc3 + averaging by 8. Low 1st conversion
-		    time. Best used with a sampling frequency of at least
-		    216.19Hz.
-
-		  * "sinc3+pf1"   - Sinc3 + Post Filter 1. 53dB rejection @
-		    50Hz, 58dB rejection @ 60Hz.
-
-		  * "sinc3+pf2"   - Sinc3 + Post Filter 2. 70dB rejection @
-		    50Hz, 70dB rejection @ 60Hz.
-
-		  * "sinc3+pf3"   - Sinc3 + Post Filter 3. 99dB rejection @
-		    50Hz, 103dB rejection @ 60Hz.
-
-		  * "sinc3+pf4"   - Sinc3 + Post Filter 4. 103dB rejection @
-		    50Hz, 109dB rejection @ 60Hz.
-
-What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY-voltageZ_filter_mode
-KernelVersion:  6.2
-Contact:	linux-iio@vger.kernel.org
-Description:
-		Set the filter mode of the differential channel. When the filter
-		mode changes, the in_voltageY-voltageZ_sampling_frequency and
-		in_voltageY-voltageZ_sampling_frequency_available attributes
-		might also change to accommodate the new filter mode.
-		If the current sampling frequency is out of range for the new
-		filter mode, the sampling frequency will be changed to the
-		closest valid one.
diff --git a/MAINTAINERS b/MAINTAINERS
index 6011af70c12e..2de269df7d3a 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1262,7 +1262,6 @@ 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
 
-- 
2.43.0
Re: [PATCH v7 2/3] Documentation: ABI: added filter mode doc in sysfs-bus-iio
Posted by Jonathan Cameron 1 month, 1 week ago
On Mon, 14 Oct 2024 17:31:59 +0300
Ramona Alexandra Nechita <ramona.nechita@analog.com> wrote:

> The filter mode / filter type property is used for ad4130
> and ad7779 drivers, therefore the ABI doc file for ad4130
> was removed, merging both of them in the sysfs-bus-iio.
> Since one of the drivers is available from 6.1, the version
> has been set to 6.1 for these attributes.
> 
> Signed-off-by: Ramona Alexandra Nechita <ramona.nechita@analog.com>
You didn't pick up Andy's Reviewed-by on an earlier version.

Please be more careful with those in future!
Re: [PATCH v7 2/3] Documentation: ABI: added filter mode doc in sysfs-bus-iio
Posted by Jonathan Cameron 1 month, 1 week ago
On Mon, 14 Oct 2024 17:31:59 +0300
Ramona Alexandra Nechita <ramona.nechita@analog.com> wrote:

> The filter mode / filter type property is used for ad4130
> and ad7779 drivers, therefore the ABI doc file for ad4130
> was removed, merging both of them in the sysfs-bus-iio.
> Since one of the drivers is available from 6.1, the version
> has been set to 6.1 for these attributes.
> 
> Signed-off-by: Ramona Alexandra Nechita <ramona.nechita@analog.com>
> ---

> diff --git a/MAINTAINERS b/MAINTAINERS
> index 6011af70c12e..2de269df7d3a 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -1262,7 +1262,6 @@ 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
?  Spurious change.

>  F:	Documentation/devicetree/bindings/iio/adc/adi,ad4130.yaml
>  F:	drivers/iio/adc/ad4130.c
>
Re: [PATCH v7 2/3] Documentation: ABI: added filter mode doc in sysfs-bus-iio
Posted by Jonathan Cameron 1 month, 1 week ago
On Sun, 20 Oct 2024 12:06:24 +0100
Jonathan Cameron <jic23@kernel.org> wrote:

> On Mon, 14 Oct 2024 17:31:59 +0300
> Ramona Alexandra Nechita <ramona.nechita@analog.com> wrote:
> 
> > The filter mode / filter type property is used for ad4130
> > and ad7779 drivers, therefore the ABI doc file for ad4130
> > was removed, merging both of them in the sysfs-bus-iio.
> > Since one of the drivers is available from 6.1, the version
> > has been set to 6.1 for these attributes.
> > 
> > Signed-off-by: Ramona Alexandra Nechita <ramona.nechita@analog.com>
> > ---  
> 
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index 6011af70c12e..2de269df7d3a 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -1262,7 +1262,6 @@ 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  
> ?  Spurious change.
Ignore that.  Change is correct I'm just being slow this morning!

Jonathan

> 
> >  F:	Documentation/devicetree/bindings/iio/adc/adi,ad4130.yaml
> >  F:	drivers/iio/adc/ad4130.c
> >    
> 
>