Commit 5fe8da61 authored by Kim Seer Paller's avatar Kim Seer Paller Committed by Jonathan Cameron
Browse files

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: default avatarKim Seer Paller <kimseer.paller@analog.com>
https://patch.msgid.link/20240718051834.32270-2-kimseer.paller@analog.com


Signed-off-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
parent dd97cdd5

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

0 → 100644
+61 −0
Original line number Diff line number Diff line 
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.

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

+0 −31
Original line number Diff line number Diff line
@@ -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.