From: Rodrigo Alencar <[email protected]>

Add custom ABI documentation files for the DDS AD9910 with sysfs and
debugfs entries. The sysfs ones control parameters from the Digital Ramp
Generator and OSK engine. The debugfs attributes are read-only and
evalutate into source channel labels for each DDS core parameter.

Signed-off-by: Rodrigo Alencar <[email protected]>
---
 Documentation/ABI/testing/debugfs-iio-ad9910       | 23 ++++++++++++++++
 .../ABI/testing/sysfs-bus-iio-frequency-ad9910     | 31 ++++++++++++++++++++++
 MAINTAINERS                                        |  2 ++
 3 files changed, 56 insertions(+)

diff --git a/Documentation/ABI/testing/debugfs-iio-ad9910 
b/Documentation/ABI/testing/debugfs-iio-ad9910
new file mode 100644
index 000000000000..7083a20d5a40
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-iio-ad9910
@@ -0,0 +1,23 @@
+What:          /sys/kernel/debug/iio/iio:deviceX/frequency_source
+KernelVersion: 7.3
+Contact:       [email protected]
+Description:
+               Read-only. Reports the channel label that is read from the
+               <dir>_<type>[Y]_label attribute, which corresponds to the 
on-chip
+               signal generator that is currently driving the output frequency.
+
+What:          /sys/kernel/debug/iio/iio:deviceX/phase_source
+KernelVersion: 7.3
+Contact:       [email protected]
+Description:
+               Read-only. Reports the channel label that is read from the
+               <dir>_<type>[Y]_label attribute, which corresponds to the 
on-chip
+               signal generator that is currently driving the output phase.
+
+What:          /sys/kernel/debug/iio/iio:deviceX/amplitude_source
+KernelVersion: 7.3
+Contact:       [email protected]
+Description:
+               Read-only. Reports the channel label that is read from the
+               <dir>_<type>[Y]_label attribute, which corresponds to the 
on-chip
+               signal generator that is currently driving the output amplitude.
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-frequency-ad9910 
b/Documentation/ABI/testing/sysfs-bus-iio-frequency-ad9910
new file mode 100644
index 000000000000..4e25f538af4a
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-frequency-ad9910
@@ -0,0 +1,31 @@
+What:          /sys/bus/iio/devices/iio:deviceX/out_altcurrentY_dwell_en
+What:          /sys/bus/iio/devices/iio:deviceX/out_frequencyY_dwell_en
+What:          /sys/bus/iio/devices/iio:deviceX/out_phaseY_dwell_en
+KernelVersion: 7.3
+Contact:       [email protected]
+Description:
+               For a channel that produces parametric sweeps, this attribute 
controls
+               the sweep behavior at the configured limit. It enables dwell 
mode at a
+               sweep limit when set to 1, i.e., after the sweep is complete 
the output
+               value stays at the limit. Otherwise (setting this value to 0), 
the sweep
+               may stop or restart from the initial position, or even continue 
by
+               reversing the sweep direction.
+
+What:          /sys/bus/iio/devices/iio:deviceX/out_altcurrentY_raw_roc
+What:          /sys/bus/iio/devices/iio:deviceX/out_frequencyY_raw_roc
+What:          /sys/bus/iio/devices/iio:deviceX/out_phaseY_raw_roc
+KernelVersion: 7.3
+Contact:       [email protected]
+Description:
+               For a channel that produces parametric sweeps, this attribute 
controls
+               the rate of change of the parameter in raw units per second 
(slope).
+               This value may be influenced by the channel sampling_frequency 
attribute
+               if available. Multiplying this value by the scale attribute of 
the
+               channel yields the rate of change in physical units per second.
+
+What:          
/sys/bus/iio/devices/iio:deviceX/out_altcurrentY_raw_roc_available
+KernelVersion: 7.3
+Contact:       [email protected]
+Description:
+               Lists the available roc values for the channel. Values are
+               space-separated in ascending order.
diff --git a/MAINTAINERS b/MAINTAINERS
index f741b799d383..b923e5b25ddc 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1683,6 +1683,8 @@ M:        Rodrigo Alencar <[email protected]>
 L:     [email protected]
 S:     Supported
 W:     https://ez.analog.com/linux-software-drivers
+F:     Documentation/ABI/testing/debugfs-iio-ad9910
+F:     Documentation/ABI/testing/sysfs-bus-iio-frequency-ad9910
 F:     Documentation/devicetree/bindings/iio/frequency/adi,ad9910.yaml
 F:     drivers/iio/frequency/ad9910.c
 

-- 
2.43.0



Reply via email to