Add the rt linux 4.1.3-rt3 as base
[kvmfornfv.git] / kernel / drivers / staging / iio / Documentation / sysfs-bus-iio-dds
1
2 What:           /sys/bus/iio/devices/.../out_altvoltageX_frequencyY
3 KernelVersion:  2.6.37
4 Contact:        linux-iio@vger.kernel.org
5 Description:
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
13 What:           /sys/bus/iio/devices/.../out_altvoltageX_frequencyY_scale
14 KernelVersion:  2.6.37
15 Contact:        linux-iio@vger.kernel.org
16 Description:
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
22 What:           /sys/bus/iio/devices/.../out_altvoltageX_frequencysymbol
23 KernelVersion:  2.6.37
24 Contact:        linux-iio@vger.kernel.org
25 Description:
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
32 What:           /sys/bus/iio/devices/.../out_altvoltageX_phaseY
33 KernelVersion:  2.6.37
34 Contact:        linux-iio@vger.kernel.org
35 Description:
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
43 What:           /sys/bus/iio/devices/.../out_altvoltageX_phaseY_scale
44 KernelVersion:  2.6.37
45 Contact:        linux-iio@vger.kernel.org
46 Description:
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
52 What:           /sys/bus/iio/devices/.../out_altvoltageX_phasesymbol
53 KernelVersion:  2.6.37
54 Contact:        linux-iio@vger.kernel.org
55 Description:
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
61 What:           /sys/bus/iio/devices/.../out_altvoltageX_pincontrol_en
62 What:           /sys/bus/iio/devices/.../out_altvoltageX_pincontrol_frequency_en
63 What:           /sys/bus/iio/devices/.../out_altvoltageX_pincontrol_phase_en
64 KernelVersion:  2.6.37
65 Contact:        linux-iio@vger.kernel.org
66 Description:
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
74 What:           /sys/bus/iio/devices/.../out_altvoltageX_out_enable
75 What:           /sys/bus/iio/devices/.../out_altvoltageX_outY_enable
76 KernelVersion:  2.6.37
77 Contact:        linux-iio@vger.kernel.org
78 Description:
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
83 What:           /sys/bus/iio/devices/.../out_altvoltageX_outY_wavetype
84 KernelVersion:  2.6.37
85 Contact:        linux-iio@vger.kernel.org
86 Description:
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
92 What:           /sys/bus/iio/devices/.../out_altvoltageX_outY_wavetype_available
93 KernelVersion:  2.6.37
94 Contact:        linux-iio@vger.kernel.org
95 Description:
96                 Lists all available output waveform options.