[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <1291292489-32362-2-git-send-email-michael.hennerich@analog.com>
Date: Thu, 2 Dec 2010 13:21:27 +0100
From: <michael.hennerich@...log.com>
To: linux-iio@...r.kernel.org, linux-kernel@...r.kernel.org
CC: drivers@...log.com, jic23@....ac.uk,
device-drivers-devel@...ckfin.uclinux.org,
Michael Hennerich <michael.hennerich@...log.com>
Subject: [RFC 1/3] IIO: Direct digital synthesis abi documentation
From: Michael Hennerich <michael.hennerich@...log.com>
Proposed ABI documentation
Signed-off-by: Michael Hennerich <michael.hennerich@...log.com>
---
.../staging/iio/Documentation/sysfs-bus-iio-dds | 103 ++++++++++++++++++++
1 files changed, 103 insertions(+), 0 deletions(-)
create mode 100644 drivers/staging/iio/Documentation/sysfs-bus-iio-dds
diff --git a/drivers/staging/iio/Documentation/sysfs-bus-iio-dds b/drivers/staging/iio/Documentation/sysfs-bus-iio-dds
new file mode 100644
index 0000000..2c99889
--- /dev/null
+++ b/drivers/staging/iio/Documentation/sysfs-bus-iio-dds
@@ -0,0 +1,103 @@
+
+What: /sys/bus/iio/devices/device[n]/ddsX_freqY
+KernelVersion: 2.6.37
+Contact: linux-iio@...r.kernel.org
+Description:
+ Stores frequency into tuning word register Y.
+ There can be more than one ddsX_freqY file, which allows for
+ pin controlled FSK Frequency Shift Keying
+ (ddsX_pincontrol_freq_en is active) or the user can control
+ the desired active tuning word by writing Y to the
+ ddsX_freqsymbol file.
+
+What: /sys/bus/iio/devices/device[n]/ddsX_freq_scaleY
+KernelVersion: 2.6.37
+Contact: linux-iio@...r.kernel.org
+Description:
+ Scale to be applied to ddsX_freqY in order to obtain the
+ desired value in Hz. If shared across all frequency registers
+ Y is not present.
+
+What: /sys/bus/iio/devices/device[n]/ddsX_freqsymbol
+KernelVersion: 2.6.37
+Contact: linux-iio@...r.kernel.org
+Description:
+ Specifies the active output frequency tuning word. The value
+ corresponds to the Y in ddsX_freqY. To exit this mode the user
+ can write ddsX_pincontrol_freq_en or ddsX_out_disable file.
+
+What: /sys/bus/iio/devices/device[n]/ddsX_phaseY
+KernelVersion: 2.6.37
+Contact: linux-iio@...r.kernel.org
+Description:
+ Stores phase into phase register Y.
+ There can be more than one ddsX_phaseY file, which allows for
+ pin controlled PSK Phase Shift Keying
+ (ddsX_pincontrol_phase_en is active) or the user can
+ control the desired phase Y which is added to the phase
+ accumulator output by writing Y to the en_phase file.
+
+What: /sys/bus/iio/devices/device[n]/ddsX_phase_scaleY
+KernelVersion: 2.6.37
+Contact: linux-iio@...r.kernel.org
+Description:
+ Scale to be applied to ddsX_phaseY in order to obtain the
+ desired value in rad. If shared across all phase registers
+ Y is not present.
+
+What: /sys/bus/iio/devices/device[n]/ddsX_phasesymbol
+KernelVersion: 2.6.37
+Contact: linux-iio@...r.kernel.org
+Description:
+ Specifies the active phase Y which is added to the phase
+ accumulator output. The value corresponds to the Y in
+ ddsX_phaseY. To exit this mode the user can write
+ ddsX_pincontrol_phase_en or disable file.
+
+What: /sys/bus/iio/devices/device[n]/ddsX_pincontrol_en
+KernelVersion: 2.6.37
+Contact: linux-iio@...r.kernel.org
+Description:
+ Both, the active frequency and phase is controlled by the
+ respective phase and frequency control inputs.
+
+What: /sys/bus/iio/devices/device[n]/ddsX_pincontrol_freq_en
+KernelVersion: 2.6.37
+Contact: linux-iio@...r.kernel.org
+Description:
+ The active frequency is controlled by the respective
+ frequency control/select inputs.
+
+What: /sys/bus/iio/devices/device[n]/ddsX_pincontrol_phase_en
+KernelVersion: 2.6.37
+Contact: linux-iio@...r.kernel.org
+Description:
+ The active phase is controlled by the respective
+ phase control/select inputs.
+
+What: /sys/bus/iio/devices/device[n]/ddsX_out_disable
+KernelVersion: 2.6.37
+Contact: linux-iio@...r.kernel.org
+Description:
+ Disables any signal generation on all outputs.
+
+What: /sys/bus/iio/devices/device[n]/ddsX_outY_disable
+KernelVersion: 2.6.37
+Contact: linux-iio@...r.kernel.org
+Description:
+ Disables any signal generation on output Y.
+
+What: /sys/bus/iio/devices/device[n]/ddsX_outY_wavetype
+KernelVersion: 2.6.37
+Contact: linux-iio@...r.kernel.org
+Description:
+ Specifies the output waveform.
+ (sine, triangle, ramp, square, ...)
+ For a list of available output waveform options read
+ available_output_modes.
+
+What: /sys/bus/iio/devices/device[n]/ddsX_outY_available_wavetypes
+KernelVersion: 2.6.37
+Contact: linux-iio@...r.kernel.org
+Description:
+ Lists all available output waveform options.
--
1.6.0.2
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
Powered by blists - more mailing lists