Add the rt linux 4.1.3-rt3 as base

[kvmfornfv.git] / kernel / drivers / staging / iio / Documentation / sysfs-bus-iio-dds

diff --git a/kernel/drivers/staging/iio/Documentation/sysfs-bus-iio-dds b/kernel/drivers/staging/iio/Documentation/sysfs-bus-iio-dds
new file mode 100644 (file)
index 0000000..ee8c509
--- /dev/null
+++ b/kernel/drivers/staging/iio/Documentation/sysfs-bus-iio-dds
@@ -0,0 +1,96 @@
+
+What:          /sys/bus/iio/devices/.../out_altvoltageX_frequencyY
+KernelVersion: 2.6.37
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Stores frequency into tuning word Y.
+               There will be more than one out_altvoltageX_frequencyY file,
+               which allows for pin controlled FSK Frequency Shift Keying
+               (out_altvoltageX_pincontrol_frequency_en is active) or the user
+               can control the desired active tuning word by writing Y to the
+               out_altvoltageX_frequencysymbol file.
+
+What:          /sys/bus/iio/devices/.../out_altvoltageX_frequencyY_scale
+KernelVersion: 2.6.37
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Scale to be applied to out_altvoltageX_frequencyY in order to
+               obtain the desired value in Hz. If shared across all frequency
+               registers Y is not present. It is also possible X is not present
+               if shared across all channels.
+
+What:          /sys/bus/iio/devices/.../out_altvoltageX_frequencysymbol
+KernelVersion: 2.6.37
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Specifies the active output frequency tuning word. The value
+               corresponds to the Y in out_altvoltageX_frequencyY.
+               To exit this mode the user can write
+               out_altvoltageX_pincontrol_frequency_en or
+               out_altvoltageX_out_enable file.
+
+What:          /sys/bus/iio/devices/.../out_altvoltageX_phaseY
+KernelVersion: 2.6.37
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Stores phase into Y.
+               There will be more than one out_altvoltageX_phaseY file, which
+               allows for pin controlled PSK Phase Shift Keying
+               (out_altvoltageX_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 phase_en file.
+
+What:          /sys/bus/iio/devices/.../out_altvoltageX_phaseY_scale
+KernelVersion: 2.6.37
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Scale to be applied to out_altvoltageX_phaseY in order to obtain
+               the desired value in rad. If shared across all phase registers
+               Y is not present. It is also possible X is not present if
+               shared across all channels.
+
+What:          /sys/bus/iio/devices/.../out_altvoltageX_phasesymbol
+KernelVersion: 2.6.37
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Specifies the active phase Y which is added to the phase
+               accumulator output. The value corresponds to the Y in
+               out_altvoltageX_phaseY. To exit this mode the user can write
+               out_altvoltageX_pincontrol_phase_en or disable file.
+
+What:          /sys/bus/iio/devices/.../out_altvoltageX_pincontrol_en
+What:          /sys/bus/iio/devices/.../out_altvoltageX_pincontrol_frequency_en
+What:          /sys/bus/iio/devices/.../out_altvoltageX_pincontrol_phase_en
+KernelVersion: 2.6.37
+Contact:       linux-iio@vger.kernel.org
+Description:
+               out_altvoltageX_pincontrol_en: Both, the active frequency and
+               phase is controlled by the respective phase and frequency
+               control inputs. In case the device in features independent
+               controls, then there are dedicated files
+               (out_altvoltageX_pincontrol_frequency_en,
+               out_altvoltageX_pincontrol_phase_en).
+
+What:          /sys/bus/iio/devices/.../out_altvoltageX_out_enable
+What:          /sys/bus/iio/devices/.../out_altvoltageX_outY_enable
+KernelVersion: 2.6.37
+Contact:       linux-iio@vger.kernel.org
+Description:
+               out_altvoltageX_outY_enable controls signal generation on
+               output Y of channel X. Y may be suppressed if all channels are
+               controlled together.
+
+What:          /sys/bus/iio/devices/.../out_altvoltageX_outY_wavetype
+KernelVersion: 2.6.37
+Contact:       linux-iio@vger.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/.../out_altvoltageX_outY_wavetype_available
+KernelVersion: 2.6.37
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Lists all available output waveform options.