diff mbox series

[v4,3/3] Documentation: ABI: testing: add max11410 doc

Message ID 20220908144924.205547-4-Ibrahim.Tilki@analog.com (mailing list archive)
State Changes Requested
Headers show
Series iio: adc: add max11410 adc driver | expand

Commit Message

Tilki, Ibrahim Sept. 8, 2022, 2:49 p.m. UTC
Adding documentation for Analog Devices max11410 adc userspace sysfs.

Signed-off-by: Ibrahim Tilki <Ibrahim.Tilki@analog.com>
---
 .../ABI/testing/sysfs-bus-iio-adc-max11410          | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-max11410

Comments

Jonathan Cameron Sept. 18, 2022, 3:26 p.m. UTC | #1
On Thu, 8 Sep 2022 17:49:24 +0300
Ibrahim Tilki <Ibrahim.Tilki@analog.com> wrote:

> Adding documentation for Analog Devices max11410 adc userspace sysfs.
> 
> Signed-off-by: Ibrahim Tilki <Ibrahim.Tilki@analog.com>

I debated a bit with myself when reviewing the driver this time on whether
we wanted
filter_notchY_en or as you have it filterY_notch_en

It's a bit similar to channel naming in which we potentially allow
in_accel0_x_raw
in_accel1_x_raw
in_accel0_y_raw

or
in_accel0_x_raw
in_accel1_x_raw
in_accel2_y_raw

etc depending on whether the index is considered global across all modifiers
or not.  We decided long ago that either was fine as they are uniquely
identifiable either by channel index, or by index + modifier.

Anyhow, upshot is I'm fine with the ordering you have here - but if anyone
else has time to take a look and comment on why one option is better than
the other that would be great.

Thanks,

Jonathan
 

> ---
>  .../ABI/testing/sysfs-bus-iio-adc-max11410          | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-max11410
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-max11410 b/Documentation/ABI/testing/sysfs-bus-iio-adc-max11410
> new file mode 100644
> index 000000000..2a53c6b37
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-max11410
> @@ -0,0 +1,13 @@
> +What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_filterY_notch_en
> +Date:		September 2022
> +KernelVersion:  6.0
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Enable or disable a notch filter.
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_filterY_notch_center
> +Date:		September 2022
> +KernelVersion:  6.0
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Center frequency of the notch filter in Hz.
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-max11410 b/Documentation/ABI/testing/sysfs-bus-iio-adc-max11410
new file mode 100644
index 000000000..2a53c6b37
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-max11410
@@ -0,0 +1,13 @@ 
+What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_filterY_notch_en
+Date:		September 2022
+KernelVersion:  6.0
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Enable or disable a notch filter.
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_filterY_notch_center
+Date:		September 2022
+KernelVersion:  6.0
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Center frequency of the notch filter in Hz.