]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
iio: ABI: Generalize ABI documentation for DAC
authorKim Seer Paller <kimseer.paller@analog.com>
Thu, 18 Jul 2024 05:18:29 +0000 (13:18 +0800)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Sat, 3 Aug 2024 09:13:37 +0000 (10:13 +0100)
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>
Documentation/ABI/testing/sysfs-bus-iio-dac [new file with mode: 0644]
Documentation/ABI/testing/sysfs-bus-iio-dac-ltc2688

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-dac b/Documentation/ABI/testing/sysfs-bus-iio-dac
new file mode 100644 (file)
index 0000000..810eaac
--- /dev/null
@@ -0,0 +1,61 @@
+What:          /sys/bus/iio/devices/iio:deviceX/out_currentY_toggle_en
+KernelVersion: 5.18
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Toggle enable. Write 1 to enable toggle or 0 to disable it. This
+               is useful when one wants to change the DAC output codes. For
+               autonomous toggling, the way it should be done is:
+
+               - disable toggle operation;
+               - change out_currentY_rawN, where N is the integer value of the symbol;
+               - enable toggle operation.
+
+What:          /sys/bus/iio/devices/iio:deviceX/out_currentY_rawN
+KernelVersion: 5.18
+Contact:       linux-iio@vger.kernel.org
+Description:
+               This attribute has the same meaning as out_currentY_raw. It is
+               specific to toggle enabled channels and refers to the DAC output
+               code in INPUT_N (_rawN), where N is the integer value of the symbol.
+               The same scale and offset as in out_currentY_raw applies.
+
+What:          /sys/bus/iio/devices/iio:deviceX/out_currentY_symbol
+KernelVersion: 5.18
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Performs a SW switch to a predefined output symbol. This attribute
+               is specific to toggle enabled channels and allows switching between
+               multiple predefined symbols. Each symbol corresponds to a different
+               output, denoted as out_currentY_rawN, where N is the integer value
+               of the symbol. Writing an integer value N will select out_currentY_rawN.
+
+What:          /sys/bus/iio/devices/iio:deviceX/out_voltageY_toggle_en
+KernelVersion: 5.18
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Toggle enable. Write 1 to enable toggle or 0 to disable it. This
+               is useful when one wants to change the DAC output codes. For
+               autonomous toggling, the way it should be done is:
+
+               - disable toggle operation;
+               - change out_voltageY_rawN, where N is the integer value of the symbol;
+               - enable toggle operation.
+
+What:          /sys/bus/iio/devices/iio:deviceX/out_voltageY_rawN
+KernelVersion: 5.18
+Contact:       linux-iio@vger.kernel.org
+Description:
+               This attribute has the same meaning as out_currentY_raw. It is
+               specific to toggle enabled channels and refers to the DAC output
+               code in INPUT_N (_rawN), where N is the integer value of the symbol.
+               The same scale and offset as in out_currentY_raw applies.
+
+What:          /sys/bus/iio/devices/iio:deviceX/out_voltageY_symbol
+KernelVersion: 5.18
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Performs a SW switch to a predefined output symbol. This attribute
+               is specific to toggle enabled channels and allows switching between
+               multiple predefined symbols. Each symbol corresponds to a different
+               output, denoted as out_voltageY_rawN, where N is the integer value
+               of the symbol. Writing an integer value N will select out_voltageY_rawN.
index 1c35971277ba2700cb323549a7c5bdce377eb396..ae95a5477382f2bac4cd39875265bd72ded36586 100644 (file)
@@ -53,34 +53,3 @@ KernelVersion:       5.18
 Contact:       linux-iio@vger.kernel.org
 Description:
                Returns the available values for the dither phase.
-
-What:          /sys/bus/iio/devices/iio:deviceX/out_voltageY_toggle_en
-KernelVersion: 5.18
-Contact:       linux-iio@vger.kernel.org
-Description:
-               Toggle enable. Write 1 to enable toggle or 0 to disable it. This is
-               useful when one wants to change the DAC output codes. The way it should
-               be done is:
-
-               - disable toggle operation;
-               - change out_voltageY_raw0 and out_voltageY_raw1;
-               - enable toggle operation.
-
-What:          /sys/bus/iio/devices/iio:deviceX/out_voltageY_raw0
-What:          /sys/bus/iio/devices/iio:deviceX/out_voltageY_raw1
-KernelVersion: 5.18
-Contact:       linux-iio@vger.kernel.org
-Description:
-               It has the same meaning as out_voltageY_raw. This attribute is
-               specific to toggle enabled channels and refers to the DAC output
-               code in INPUT_A (_raw0) and INPUT_B (_raw1). The same scale and offset
-               as in out_voltageY_raw applies.
-
-What:          /sys/bus/iio/devices/iio:deviceX/out_voltageY_symbol
-KernelVersion: 5.18
-Contact:       linux-iio@vger.kernel.org
-Description:
-               Performs a SW toggle. This attribute is specific to toggle
-               enabled channels and allows to toggle between out_voltageY_raw0
-               and out_voltageY_raw1 through software. Writing 0 will select
-               out_voltageY_raw0 while 1 selects out_voltageY_raw1.