2021-01-08 18:36:21

by Cristian Pop

Subject: [PATCH v5 2/3] Documentation/ABI/testing: Add documentation for AD5766 new ABI

New interface is proposed for dither functionality. This future allows
composing an external signals to the selected output channel.
The dither signal can be turned on/off, scaled, inverted, or it can be
selected from different sources.

Signed-off-by: Cristian Pop <[email protected]>
---
Changelog v5:
- Rename property to: "in_voltageY_dither_enable"
- Change scale values to: "1 0.75 0.5 0.25"
- Specify KernelVersion
.../ABI/testing/sysfs-bus-iio-dac-ad5766 | 31 +++++++++++++++++++
1 file changed, 31 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-dac-ad5766

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-dac-ad5766 b/Documentation/ABI/testing/sysfs-bus-iio-dac-ad5766
new file mode 100644
index 000000000000..6e5e383b2c53
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-dac-ad5766
@@ -0,0 +1,31 @@
+What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_ennable
+KernelVersion: 5.12
+Contact: [email protected]
+Description:
+ Dither enable. Write 1 to enable dither or 0 to disable it.
+
+What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_invert
+KernelVersion: 5.12
+Contact: [email protected]
+Description:
+ Inverts the dither applied to the selected DAC channel. Dither is not
+ inverted by default. Write "1" to invert dither.
+
+What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_scale_available
+KernelVersion: 5.12
+Contact: [email protected]
+Description:
+ Returns possible scalings available for the current channel.
+
+What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_scale
+KernelVersion: 5.12
+Contact: [email protected]
+Description:
+ Scales the dither before it is applied to the selected channel.
+
+What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_source
+KernelVersion: 5.12
+Contact: [email protected]
+Description:
+ Selects dither source applied to the selected channel. Write "0" to
+ select N0 source, write "1" to select N1 source.
--
2.17.1

2021-01-09 19:10:29

by Jonathan Cameron

Subject: Re: [PATCH v5 2/3] Documentation/ABI/testing: Add documentation for AD5766 new ABI

On Fri, 8 Jan 2021 20:37:38 +0200
Cristian Pop <[email protected]> wrote:

> New interface is proposed for dither functionality. This future allows
> composing an external signals to the selected output channel.
> The dither signal can be turned on/off, scaled, inverted, or it can be
> selected from different sources.
>
> Signed-off-by: Cristian Pop <[email protected]>
Hi Cristian,

One trivial inline to fix if you need to respin. Otherwise I can tidy up whilst
applying.

Jonathan


> ---
> Changelog v5:
> - Rename property to: "in_voltageY_dither_enable"
> - Change scale values to: "1 0.75 0.5 0.25"
> - Specify KernelVersion
> .../ABI/testing/sysfs-bus-iio-dac-ad5766 | 31 +++++++++++++++++++
> 1 file changed, 31 insertions(+)
> create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-dac-ad5766
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-dac-ad5766 b/Documentation/ABI/testing/sysfs-bus-iio-dac-ad5766
> new file mode 100644
> index 000000000000..6e5e383b2c53
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-dac-ad5766
> @@ -0,0 +1,31 @@
> +What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_ennable
Typo, enable but I can fix that whilst applying if there is nothing else.

Jonathan

> +KernelVersion: 5.12
> +Contact: [email protected]
> +Description:
> + Dither enable. Write 1 to enable dither or 0 to disable it.
> +
> +What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_invert
> +KernelVersion: 5.12
> +Contact: [email protected]
> +Description:
> + Inverts the dither applied to the selected DAC channel. Dither is not
> + inverted by default. Write "1" to invert dither.
> +
> +What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_scale_available
> +KernelVersion: 5.12
> +Contact: [email protected]
> +Description:
> + Returns possible scalings available for the current channel.
> +
> +What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_scale
> +KernelVersion: 5.12
> +Contact: [email protected]
> +Description:
> + Scales the dither before it is applied to the selected channel.
> +
> +What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_source
> +KernelVersion: 5.12
> +Contact: [email protected]
> +Description:
> + Selects dither source applied to the selected channel. Write "0" to
> + select N0 source, write "1" to select N1 source.