Skip to content

Commit b568482

Browse files
kseerpnunojsa
authored andcommitted
iio: ABI: Generalize ABI documentation for DAC
Introduces a more generalized ABI documentation for DAC. Instead of having separate ABI files for each DAC, we now have a single ABI file that covers the common sysfs interface for all DAC. Signed-off-by: Kim Seer Paller <kimseer.paller@analog.com> https://patch.msgid.link/20240718051834.32270-2-kimseer.paller@analog.com Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
1 parent 16f3076 commit b568482

File tree

2 files changed

+61
-31
lines changed

2 files changed

+61
-31
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
What: /sys/bus/iio/devices/iio:deviceX/out_currentY_toggle_en
2+
KernelVersion: 5.18
3+
Contact: linux-iio@vger.kernel.org
4+
Description:
5+
Toggle enable. Write 1 to enable toggle or 0 to disable it. This
6+
is useful when one wants to change the DAC output codes. For
7+
autonomous toggling, the way it should be done is:
8+
9+
- disable toggle operation;
10+
- change out_currentY_rawN, where N is the integer value of the symbol;
11+
- enable toggle operation.
12+
13+
What: /sys/bus/iio/devices/iio:deviceX/out_currentY_rawN
14+
KernelVersion: 5.18
15+
Contact: linux-iio@vger.kernel.org
16+
Description:
17+
This attribute has the same meaning as out_currentY_raw. It is
18+
specific to toggle enabled channels and refers to the DAC output
19+
code in INPUT_N (_rawN), where N is the integer value of the symbol.
20+
The same scale and offset as in out_currentY_raw applies.
21+
22+
What: /sys/bus/iio/devices/iio:deviceX/out_currentY_symbol
23+
KernelVersion: 5.18
24+
Contact: linux-iio@vger.kernel.org
25+
Description:
26+
Performs a SW switch to a predefined output symbol. This attribute
27+
is specific to toggle enabled channels and allows switching between
28+
multiple predefined symbols. Each symbol corresponds to a different
29+
output, denoted as out_currentY_rawN, where N is the integer value
30+
of the symbol. Writing an integer value N will select out_currentY_rawN.
31+
32+
What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_toggle_en
33+
KernelVersion: 5.18
34+
Contact: linux-iio@vger.kernel.org
35+
Description:
36+
Toggle enable. Write 1 to enable toggle or 0 to disable it. This
37+
is useful when one wants to change the DAC output codes. For
38+
autonomous toggling, the way it should be done is:
39+
40+
- disable toggle operation;
41+
- change out_voltageY_rawN, where N is the integer value of the symbol;
42+
- enable toggle operation.
43+
44+
What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_rawN
45+
KernelVersion: 5.18
46+
Contact: linux-iio@vger.kernel.org
47+
Description:
48+
This attribute has the same meaning as out_currentY_raw. It is
49+
specific to toggle enabled channels and refers to the DAC output
50+
code in INPUT_N (_rawN), where N is the integer value of the symbol.
51+
The same scale and offset as in out_currentY_raw applies.
52+
53+
What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_symbol
54+
KernelVersion: 5.18
55+
Contact: linux-iio@vger.kernel.org
56+
Description:
57+
Performs a SW switch to a predefined output symbol. This attribute
58+
is specific to toggle enabled channels and allows switching between
59+
multiple predefined symbols. Each symbol corresponds to a different
60+
output, denoted as out_voltageY_rawN, where N is the integer value
61+
of the symbol. Writing an integer value N will select out_voltageY_rawN.

Documentation/ABI/testing/sysfs-bus-iio-dac-ltc2688

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -53,34 +53,3 @@ KernelVersion: 5.18
5353
Contact: linux-iio@vger.kernel.org
5454
Description:
5555
Returns the available values for the dither phase.
56-
57-
What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_toggle_en
58-
KernelVersion: 5.18
59-
Contact: linux-iio@vger.kernel.org
60-
Description:
61-
Toggle enable. Write 1 to enable toggle or 0 to disable it. This is
62-
useful when one wants to change the DAC output codes. The way it should
63-
be done is:
64-
65-
- disable toggle operation;
66-
- change out_voltageY_raw0 and out_voltageY_raw1;
67-
- enable toggle operation.
68-
69-
What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_raw0
70-
What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_raw1
71-
KernelVersion: 5.18
72-
Contact: linux-iio@vger.kernel.org
73-
Description:
74-
It has the same meaning as out_voltageY_raw. This attribute is
75-
specific to toggle enabled channels and refers to the DAC output
76-
code in INPUT_A (_raw0) and INPUT_B (_raw1). The same scale and offset
77-
as in out_voltageY_raw applies.
78-
79-
What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_symbol
80-
KernelVersion: 5.18
81-
Contact: linux-iio@vger.kernel.org
82-
Description:
83-
Performs a SW toggle. This attribute is specific to toggle
84-
enabled channels and allows to toggle between out_voltageY_raw0
85-
and out_voltageY_raw1 through software. Writing 0 will select
86-
out_voltageY_raw0 while 1 selects out_voltageY_raw1.

0 commit comments

Comments
 (0)