diff mbox series

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

Message ID 20240926135418.8342-3-ramona.nechita@analog.com (mailing list archive)
State Changes Requested
Headers show
Series add support for ad777x family | expand

Commit Message

Ramona Alexandra Nechita Sept. 26, 2024, 1:53 p.m. UTC 
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

Comments

Andy Shevchenko Sept. 26, 2024, 2:12 p.m. UTC | #1 
On Thu, Sep 26, 2024 at 04:53:56PM +0300, Ramona Alexandra Nechita 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.

...

> +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.

I still think that a compromise to leave the existing values as an example in
the existing bindings is a good to have.

But if Jonathan thinks otherwise, I'm not against it.
For the rest
Reviewed-by: Andy Shevchenko <andy@kernel.org>
Andy Shevchenko Sept. 26, 2024, 2:12 p.m. UTC | #2 
On Thu, Sep 26, 2024 at 05:12:02PM +0300, Andy Shevchenko wrote:
> On Thu, Sep 26, 2024 at 04:53:56PM +0300, Ramona Alexandra Nechita wrote:

...

> > +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.
> 
> I still think that a compromise to leave the existing values as an example in

> the existing bindings is a good to have.

s/existing/generic/
Jonathan Cameron Sept. 28, 2024, 5:52 p.m. UTC | #3 
On Thu, 26 Sep 2024 17:12:50 +0300
Andy Shevchenko <andy@kernel.org> wrote:

> On Thu, Sep 26, 2024 at 05:12:02PM +0300, Andy Shevchenko wrote:
> > On Thu, Sep 26, 2024 at 04:53:56PM +0300, Ramona Alexandra Nechita wrote:  
> 
> ...
> 
> > > +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.  
> > 
> > I still think that a compromise to leave the existing values as an example in  
> 
> > the existing bindings is a good to have.
  
It gets hard to do really quickly because we end up with effectively a full set
of docs for each one.  I'd like to capture that information but I'm not sure ABI
docs are the right place because we don't want each entry to followed by pages
of specific examples. 

I'd have loved the option for ABI docs to have extra info in a per device
file that doesn't end up in the main docs build but we don't have that yet.

Jonathan

> 
> s/existing/generic/
> 
>
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index 345d58535dc9..aac41e69aa43 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -2265,6 +2265,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 417c6751c0dc..3e72010b45a3 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1228,7 +1228,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