Linux-libre 3.4.9-gnu1
[librecmc/linux-libre.git] / drivers / staging / iio / Documentation / sysfs-bus-iio-dds
1
2 What:           /sys/bus/iio/devices/.../ddsX_freqY
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 ddsX_freqY file, which allows for
8                 pin controlled FSK Frequency Shift Keying
9                 (ddsX_pincontrol_freq_en is active) or the user can control
10                 the desired active tuning word by writing Y to the
11                 ddsX_freqsymbol file.
12
13 What:           /sys/bus/iio/devices/.../ddsX_freqY_scale
14 KernelVersion:  2.6.37
15 Contact:        linux-iio@vger.kernel.org
16 Description:
17                 Scale to be applied to ddsX_freqY in order to obtain the
18                 desired value in Hz. If shared across all frequency registers
19                 Y is not present. It is also possible X is not present if
20                 shared across all channels.
21
22 What:           /sys/bus/iio/devices/.../ddsX_freqsymbol
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 ddsX_freqY. To exit this mode the user
28                 can write ddsX_pincontrol_freq_en or ddsX_out_enable file.
29
30 What:           /sys/bus/iio/devices/.../ddsX_phaseY
31 KernelVersion:  2.6.37
32 Contact:        linux-iio@vger.kernel.org
33 Description:
34                 Stores phase into Y.
35                 There will be more than one ddsX_phaseY file, which allows for
36                 pin controlled PSK Phase Shift Keying
37                 (ddsX_pincontrol_phase_en is active) or the user can
38                 control the desired phase Y which is added to the phase
39                 accumulator output by writing Y to the en_phase file.
40
41 What:           /sys/bus/iio/devices/.../ddsX_phaseY_scale
42 KernelVersion:  2.6.37
43 Contact:        linux-iio@vger.kernel.org
44 Description:
45                 Scale to be applied to ddsX_phaseY in order to obtain the
46                 desired value in rad. If shared across all phase registers
47                 Y is not present. It is also possible X is not present if
48                 shared across all channels.
49
50 What:           /sys/bus/iio/devices/.../ddsX_phasesymbol
51 KernelVersion:  2.6.37
52 Contact:        linux-iio@vger.kernel.org
53 Description:
54                 Specifies the active phase Y which is added to the phase
55                 accumulator output. The value corresponds to the Y in
56                 ddsX_phaseY. To exit this mode the user can write
57                 ddsX_pincontrol_phase_en or disable file.
58
59 What:           /sys/bus/iio/devices/.../ddsX_pincontrol_en
60 What:           /sys/bus/iio/devices/.../ddsX_pincontrol_freq_en
61 What:           /sys/bus/iio/devices/.../ddsX_pincontrol_phase_en
62 KernelVersion:  2.6.37
63 Contact:        linux-iio@vger.kernel.org
64 Description:
65                 ddsX_pincontrol_en: Both, the active frequency and phase is
66                 controlled by the respective phase and frequency control inputs.
67                 In case the device in question allows to independent controls,
68                 then there are dedicated files (ddsX_pincontrol_freq_en,
69                 ddsX_pincontrol_phase_en).
70
71 What:           /sys/bus/iio/devices/.../ddsX_out_enable
72 What:           /sys/bus/iio/devices/.../ddsX_outY_enable
73 KernelVersion:  2.6.37
74 Contact:        linux-iio@vger.kernel.org
75 Description:
76                 ddsX_outY_enable controls signal generation on output Y of
77                 channel X. Y may be suppressed if all channels are
78                 controlled together.
79
80 What:           /sys/bus/iio/devices/.../ddsX_outY_wavetype
81 KernelVersion:  2.6.37
82 Contact:        linux-iio@vger.kernel.org
83 Description:
84                 Specifies the output waveform.
85                 (sine, triangle, ramp, square, ...)
86                 For a list of available output waveform options read
87                 available_output_modes.
88
89 What:           /sys/bus/iio/devices/.../ddsX_outY_wavetype_available
90 KernelVersion:  2.6.37
91 Contact:        linux-iio@vger.kernel.org
92 Description:
93                 Lists all available output waveform options.