xref: /linux/drivers/staging/iio/Documentation/sysfs-bus-iio-dds (revision 4413e16d9d21673bb5048a2e542f1aaa00015c2e)
1
2What:		/sys/bus/iio/devices/.../out_altvoltageX_frequencyY
3KernelVersion:	2.6.37
4Contact:	linux-iio@vger.kernel.org
5Description:
6		Stores frequency into tuning word Y.
7		There will be more than one out_altvoltageX_frequencyY file,
8		which allows for pin controlled FSK Frequency Shift Keying
9		(out_altvoltageX_pincontrol_frequency_en is active) or the user
10		can control the desired active tuning word by writing Y to the
11		out_altvoltageX_frequencysymbol file.
12
13What:		/sys/bus/iio/devices/.../out_altvoltageX_frequencyY_scale
14KernelVersion:	2.6.37
15Contact:	linux-iio@vger.kernel.org
16Description:
17		Scale to be applied to out_altvoltageX_frequencyY in order to
18		obtain the desired value in Hz. If shared across all frequency
19		registers Y is not present. It is also possible X is not present
20		if shared across all channels.
21
22What:		/sys/bus/iio/devices/.../out_altvoltageX_frequencysymbol
23KernelVersion:	2.6.37
24Contact:	linux-iio@vger.kernel.org
25Description:
26		Specifies the active output frequency tuning word. The value
27		corresponds to the Y in out_altvoltageX_frequencyY.
28		To exit this mode the user can write
29		out_altvoltageX_pincontrol_frequency_en or
30		out_altvoltageX_out_enable file.
31
32What:		/sys/bus/iio/devices/.../out_altvoltageX_phaseY
33KernelVersion:	2.6.37
34Contact:	linux-iio@vger.kernel.org
35Description:
36		Stores phase into Y.
37		There will be more than one out_altvoltageX_phaseY file, which
38		allows for pin controlled PSK Phase Shift Keying
39		(out_altvoltageX_pincontrol_phase_en is active) or the user can
40		control the desired phase Y which is added to the phase
41		accumulator output by writing Y to the phase_en file.
42
43What:		/sys/bus/iio/devices/.../out_altvoltageX_phaseY_scale
44KernelVersion:	2.6.37
45Contact:	linux-iio@vger.kernel.org
46Description:
47		Scale to be applied to out_altvoltageX_phaseY in order to obtain
48		the desired value in rad. If shared across all phase registers
49		Y is not present. It is also possible X is not present if
50		shared across all channels.
51
52What:		/sys/bus/iio/devices/.../out_altvoltageX_phasesymbol
53KernelVersion:	2.6.37
54Contact:	linux-iio@vger.kernel.org
55Description:
56		Specifies the active phase Y which is added to the phase
57		accumulator output. The value corresponds to the Y in
58		out_altvoltageX_phaseY. To exit this mode the user can write
59		out_altvoltageX_pincontrol_phase_en or disable file.
60
61What:		/sys/bus/iio/devices/.../out_altvoltageX_pincontrol_en
62What:		/sys/bus/iio/devices/.../out_altvoltageX_pincontrol_frequency_en
63What:		/sys/bus/iio/devices/.../out_altvoltageX_pincontrol_phase_en
64KernelVersion:	2.6.37
65Contact:	linux-iio@vger.kernel.org
66Description:
67		out_altvoltageX_pincontrol_en: Both, the active frequency and
68		phase is controlled by the respective phase and frequency
69		control inputs. In case the device in features independent
70		controls, then there are dedicated files
71		(out_altvoltageX_pincontrol_frequency_en,
72		out_altvoltageX_pincontrol_phase_en).
73
74What:		/sys/bus/iio/devices/.../out_altvoltageX_out_enable
75What:		/sys/bus/iio/devices/.../out_altvoltageX_outY_enable
76KernelVersion:	2.6.37
77Contact:	linux-iio@vger.kernel.org
78Description:
79		out_altvoltageX_outY_enable controls signal generation on
80		output Y of channel X. Y may be suppressed if all channels are
81		controlled together.
82
83What:		/sys/bus/iio/devices/.../out_altvoltageX_outY_wavetype
84KernelVersion:	2.6.37
85Contact:	linux-iio@vger.kernel.org
86Description:
87		Specifies the output waveform.
88		(sine, triangle, ramp, square, ...)
89		For a list of available output waveform options read
90		available_output_modes.
91
92What:		/sys/bus/iio/devices/.../out_altvoltageX_outY_wavetype_available
93KernelVersion:	2.6.37
94Contact:	linux-iio@vger.kernel.org
95Description:
96		Lists all available output waveform options.
97