Commit 9b71d269 authored by David Lechner's avatar David Lechner Committed by Jonathan Cameron
Browse files

iio: ABI: fix correctness of I and Q modifiers 



Update the IIO ABI documentation to reflect the actual usage of channels
with I and Q modifiers. These are currently only used in a few drivers:

frequency/admv1013 (kernel v5.17):
- in_altvoltageY-altvoltageZ_i_calibphase
- in_altvoltageY-altvoltageZ_q_calibphase
- in_altvoltageY_i_calibbias
- in_altvoltageY_q_calibbias
frequency/admv1014 (kernel v5.18):
- in_altvoltageY_i_phase
- in_altvoltageY_q_phase
- in_altvoltageY_i_offset
- in_altvoltageY_q_offset
- in_altvoltageY_i_calibscale_course
- in_altvoltageY_i_calibscale_fine
- in_altvoltageY_q_calibscale_course
- in_altvoltageY_q_calibscale_fine
frequency/adrf6780 (kernel v5.16):
- out_altvoltageY_i_phase
- out_altvoltageY_q_phase

There are no _raw or _scale attributes in use, so those are all removed.
There are no currentY attributes in use with these modifiers, so those
are also removed. All of the voltageY are changed to altvoltageY since
that is how they are actually used. None of these channels are used
with scan buffers, so all of those attributes are removed as well. And
the {in,out}_altvoltageY_{i,q}_phase attributes were missing so those
are added.

The differential channel names for admv1013 are fixed.

Signed-off-by: default avatarDavid Lechner <dlechner@baylibre.com>
Reviewed-by: default avatarNuno Sá <nuno.sa@analog.com>
Link: https://patch.msgid.link/20250711-iio-abi-fix-i-and-q-modifiers-v1-1-35963c9c8c01@baylibre.com


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

Documentation/ABI/obsolete/sysfs-bus-iio

+0 −12
Original line number Diff line number Diff line
@@ -48,10 +48,6 @@ What: /sys/.../iio:deviceX/scan_elements/in_timestamp_en 
What:		/sys/.../iio:deviceX/scan_elements/in_voltageY_supply_en

What:		/sys/.../iio:deviceX/scan_elements/in_voltageY_en

What:		/sys/.../iio:deviceX/scan_elements/in_voltageY-voltageZ_en

What:		/sys/.../iio:deviceX/scan_elements/in_voltageY_i_en

What:		/sys/.../iio:deviceX/scan_elements/in_voltageY_q_en

What:		/sys/.../iio:deviceX/scan_elements/in_voltage_i_en

What:		/sys/.../iio:deviceX/scan_elements/in_voltage_q_en

What:		/sys/.../iio:deviceX/scan_elements/in_incli_x_en

What:		/sys/.../iio:deviceX/scan_elements/in_incli_y_en

What:		/sys/.../iio:deviceX/scan_elements/in_pressureY_en
@@ -73,10 +69,6 @@ What: /sys/.../iio:deviceX/scan_elements/in_incli_type 
What:		/sys/.../iio:deviceX/scan_elements/in_voltageY_type

What:		/sys/.../iio:deviceX/scan_elements/in_voltage_type

What:		/sys/.../iio:deviceX/scan_elements/in_voltageY_supply_type

What:		/sys/.../iio:deviceX/scan_elements/in_voltageY_i_type

What:		/sys/.../iio:deviceX/scan_elements/in_voltageY_q_type

What:		/sys/.../iio:deviceX/scan_elements/in_voltage_i_type

What:		/sys/.../iio:deviceX/scan_elements/in_voltage_q_type

What:		/sys/.../iio:deviceX/scan_elements/in_timestamp_type

What:		/sys/.../iio:deviceX/scan_elements/in_pressureY_type

What:		/sys/.../iio:deviceX/scan_elements/in_pressure_type
@@ -110,10 +102,6 @@ Description: 


What:		/sys/.../iio:deviceX/scan_elements/in_voltageY_index

What:		/sys/.../iio:deviceX/scan_elements/in_voltageY_supply_index

What:		/sys/.../iio:deviceX/scan_elements/in_voltageY_i_index

What:		/sys/.../iio:deviceX/scan_elements/in_voltageY_q_index

What:		/sys/.../iio:deviceX/scan_elements/in_voltage_i_index

What:		/sys/.../iio:deviceX/scan_elements/in_voltage_q_index

What:		/sys/.../iio:deviceX/scan_elements/in_accel_x_index

What:		/sys/.../iio:deviceX/scan_elements/in_accel_y_index

What:		/sys/.../iio:deviceX/scan_elements/in_accel_z_index

Documentation/ABI/testing/sysfs-bus-iio

+6 −32
Original line number Diff line number Diff line
@@ -141,8 +141,6 @@ Description: 


What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_raw

What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_raw

What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_i_raw

What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_q_raw

KernelVersion:	2.6.35

Contact:	linux-iio@vger.kernel.org

Description:
@@ -417,18 +415,14 @@ What: /sys/bus/iio/devices/iio:deviceX/in_accel_offset 
What:		/sys/bus/iio/devices/iio:deviceX/in_accel_x_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_accel_y_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_accel_z_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage_q_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage_i_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_i_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_q_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_q_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_i_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_current_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_i_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_q_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_current_q_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_current_i_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_tempY_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_temp_offset

What:		/sys/bus/iio/devices/iio:deviceX/in_pressureY_offset
@@ -456,21 +450,15 @@ Description: 
		to the _raw output.



What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_i_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_q_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_i_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_q_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltage-voltage_scale

What:		/sys/bus/iio/devices/iio:deviceX/out_voltageY_scale

What:		/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_supply_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_current_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_i_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_q_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_current_i_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_current_q_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_accel_scale

What:		/sys/bus/iio/devices/iio:deviceX/in_accel_peak_scale
@@ -603,11 +591,7 @@ What: /sys/bus/iio/devices/iio:deviceX/in_pressure_calibscale 
What:		/sys/bus/iio/devices/iio:deviceX/in_pressureY_calibscale

What:		/sys/bus/iio/devices/iio:deviceX/in_proximity0_calibscale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_calibscale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_i_calibscale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_q_calibscale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_calibscale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_i_calibscale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_q_calibscale

What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_calibscale

What:		/sys/bus/iio/devices/iio:deviceX/out_currentY_calibscale

What:		/sys/bus/iio/devices/iio:deviceX/out_voltageY_calibscale
@@ -829,7 +813,11 @@ Description: 
		all the other channels, since it involves changing the VCO

		fundamental output frequency.



What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltageY_i_phase

What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltageY_q_phase

What:		/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_phase

What:		/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_i_phase

What:		/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_q_phase

KernelVersion:	3.4.0

Contact:	linux-iio@vger.kernel.org

Description:
@@ -1458,10 +1446,6 @@ What: /sys/.../iio:deviceX/bufferY/in_timestamp_en 
What:		/sys/.../iio:deviceX/bufferY/in_voltageY_supply_en

What:		/sys/.../iio:deviceX/bufferY/in_voltageY_en

What:		/sys/.../iio:deviceX/bufferY/in_voltageY-voltageZ_en

What:		/sys/.../iio:deviceX/bufferY/in_voltageY_i_en

What:		/sys/.../iio:deviceX/bufferY/in_voltageY_q_en

What:		/sys/.../iio:deviceX/bufferY/in_voltage_i_en

What:		/sys/.../iio:deviceX/bufferY/in_voltage_q_en

What:		/sys/.../iio:deviceX/bufferY/in_incli_x_en

What:		/sys/.../iio:deviceX/bufferY/in_incli_y_en

What:		/sys/.../iio:deviceX/bufferY/in_pressureY_en
@@ -1482,10 +1466,6 @@ What: /sys/.../iio:deviceX/bufferY/in_incli_type 
What:		/sys/.../iio:deviceX/bufferY/in_voltageY_type

What:		/sys/.../iio:deviceX/bufferY/in_voltage_type

What:		/sys/.../iio:deviceX/bufferY/in_voltageY_supply_type

What:		/sys/.../iio:deviceX/bufferY/in_voltageY_i_type

What:		/sys/.../iio:deviceX/bufferY/in_voltageY_q_type

What:		/sys/.../iio:deviceX/bufferY/in_voltage_i_type

What:		/sys/.../iio:deviceX/bufferY/in_voltage_q_type

What:		/sys/.../iio:deviceX/bufferY/in_timestamp_type

What:		/sys/.../iio:deviceX/bufferY/in_pressureY_type

What:		/sys/.../iio:deviceX/bufferY/in_pressure_type
@@ -1523,10 +1503,6 @@ Description: 


What:		/sys/.../iio:deviceX/bufferY/in_voltageY_index

What:		/sys/.../iio:deviceX/bufferY/in_voltageY_supply_index

What:		/sys/.../iio:deviceX/bufferY/in_voltageY_i_index

What:		/sys/.../iio:deviceX/bufferY/in_voltageY_q_index

What:		/sys/.../iio:deviceX/bufferY/in_voltage_i_index

What:		/sys/.../iio:deviceX/bufferY/in_voltage_q_index

What:		/sys/.../iio:deviceX/bufferY/in_accel_x_index

What:		/sys/.../iio:deviceX/bufferY/in_accel_y_index

What:		/sys/.../iio:deviceX/bufferY/in_accel_z_index
@@ -1716,8 +1692,6 @@ Description: 


What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_raw

What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_supply_raw

What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_i_raw

What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_q_raw

KernelVersion:	3.17

Contact:	linux-iio@vger.kernel.org

Description:

Documentation/ABI/testing/sysfs-bus-iio-frequency-admv1013

+2 −2
Original line number Diff line number Diff line 
What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0-1_i_calibphase

What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0-altvoltage1_i_calibphase

KernelVersion:

Contact:	linux-iio@vger.kernel.org

Description:

		Read/write unscaled value for the Local Oscillatior path quadrature I phase shift.



What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0-1_q_calibphase

What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0-altvoltage1_q_calibphase

KernelVersion:

Contact:	linux-iio@vger.kernel.org

Description: