]> www.infradead.org Git - users/jedix/linux-maple.git/commitdiff
iio: ABI: use Y consistently as channel number
authorDavid Lechner <dlechner@baylibre.com>
Mon, 16 Dec 2024 23:29:36 +0000 (17:29 -0600)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Sat, 28 Dec 2024 14:28:13 +0000 (14:28 +0000)
Change X to Y when referring to channel number in the ABI documentation.
There were only a few cases using X (and one using Z). By far, most
documented attributes are using Y for the channel number placeholder.
For consistency, we should follow the same convention throughout.

Signed-off-by: David Lechner <dlechner@baylibre.com>
Link: https://patch.msgid.link/20241216-doc-iio-use-voltagey-consistently-v1-1-9e34a72133bc@baylibre.com
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Documentation/ABI/testing/sysfs-bus-iio

index 9a2aac22010d8749c27139f134b653e9f069bd56..99cc9466cb07a3a92f2ba6a6f55a93d4b4b29331 100644 (file)
@@ -227,7 +227,7 @@ Description:
                same scaling as _raw.
 
 What:          /sys/bus/iio/devices/iio:deviceX/in_temp_raw
-What:          /sys/bus/iio/devices/iio:deviceX/in_tempX_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_tempY_raw
 What:          /sys/bus/iio/devices/iio:deviceX/in_temp_x_raw
 What:          /sys/bus/iio/devices/iio:deviceX/in_temp_y_raw
 What:          /sys/bus/iio/devices/iio:deviceX/in_temp_ambient_raw
@@ -416,11 +416,11 @@ Contact:  linux-iio@vger.kernel.org
 Description:
                Scaled humidity measurement in milli percent.
 
-What:          /sys/bus/iio/devices/iio:deviceX/in_X_mean_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_Y_mean_raw
 KernelVersion: 3.5
 Contact:       linux-iio@vger.kernel.org
 Description:
-               Averaged raw measurement from channel X. The number of values
+               Averaged raw measurement from channel Y. The number of values
                used for averaging is device specific. The converting rules for
                normal raw values also applies to the averaged raw values.
 
@@ -448,7 +448,7 @@ What:               /sys/bus/iio/devices/iio:deviceX/in_humidityrelative_offset
 What:          /sys/bus/iio/devices/iio:deviceX/in_magn_offset
 What:          /sys/bus/iio/devices/iio:deviceX/in_rot_offset
 What:          /sys/bus/iio/devices/iio:deviceX/in_angl_offset
-What:          /sys/bus/iio/devices/iio:deviceX/in_capacitanceX_offset
+What:          /sys/bus/iio/devices/iio:deviceX/in_capacitanceY_offset
 KernelVersion: 2.6.35
 Contact:       linux-iio@vger.kernel.org
 Description:
@@ -663,10 +663,10 @@ What:             /sys/.../iio:deviceX/in_magn_scale_available
 What:          /sys/.../iio:deviceX/in_illuminance_scale_available
 What:          /sys/.../iio:deviceX/in_intensity_scale_available
 What:          /sys/.../iio:deviceX/in_proximity_scale_available
-What:          /sys/.../iio:deviceX/in_voltageX_scale_available
+What:          /sys/.../iio:deviceX/in_voltageY_scale_available
 What:          /sys/.../iio:deviceX/in_voltage-voltage_scale_available
-What:          /sys/.../iio:deviceX/out_voltageX_scale_available
-What:          /sys/.../iio:deviceX/out_altvoltageX_scale_available
+What:          /sys/.../iio:deviceX/out_voltageY_scale_available
+What:          /sys/.../iio:deviceX/out_altvoltageY_scale_available
 What:          /sys/.../iio:deviceX/in_capacitance_scale_available
 What:          /sys/.../iio:deviceX/in_pressure_scale_available
 What:          /sys/.../iio:deviceX/in_pressureY_scale_available
@@ -1565,7 +1565,7 @@ Description:
                This attribute is used to read the amount of quadrature error
                present in the device at a given time.
 
-What:          /sys/.../iio:deviceX/in_accelX_power_mode
+What:          /sys/.../iio:deviceX/in_accelY_power_mode
 KernelVersion: 3.11
 Contact:       linux-iio@vger.kernel.org
 Description:
@@ -1698,13 +1698,13 @@ Description:
                Raw value of rotation from true/magnetic north measured with
                or without compensation from tilt sensors.
 
-What:          /sys/bus/iio/devices/iio:deviceX/in_currentX_raw
-What:          /sys/bus/iio/devices/iio:deviceX/in_currentX_i_raw
-What:          /sys/bus/iio/devices/iio:deviceX/in_currentX_q_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_currentY_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.18
 Contact:       linux-iio@vger.kernel.org
 Description:
-               Raw current measurement from channel X. Units are in milliamps
+               Raw current measurement from channel Y. Units are in milliamps
                after application of scale and offset. If no offset or scale is
                present, output should be considered as processed with the
                unit in milliamps.
@@ -1871,9 +1871,9 @@ Description:
                hardware fifo watermark level.
 
 What:          /sys/bus/iio/devices/iio:deviceX/in_temp_calibemissivity
-What:          /sys/bus/iio/devices/iio:deviceX/in_tempX_calibemissivity
+What:          /sys/bus/iio/devices/iio:deviceX/in_tempY_calibemissivity
 What:          /sys/bus/iio/devices/iio:deviceX/in_temp_object_calibemissivity
-What:          /sys/bus/iio/devices/iio:deviceX/in_tempX_object_calibemissivity
+What:          /sys/bus/iio/devices/iio:deviceX/in_tempY_object_calibemissivity
 KernelVersion: 4.1
 Contact:       linux-iio@vger.kernel.org
 Description:
@@ -1894,17 +1894,17 @@ Description:
                is considered as one sample for <type>[_name]_sampling_frequency.
 
 What:          /sys/bus/iio/devices/iio:deviceX/in_concentration_raw
-What:          /sys/bus/iio/devices/iio:deviceX/in_concentrationX_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_concentrationY_raw
 What:          /sys/bus/iio/devices/iio:deviceX/in_concentration_co2_raw
-What:          /sys/bus/iio/devices/iio:deviceX/in_concentrationX_co2_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_concentrationY_co2_raw
 What:          /sys/bus/iio/devices/iio:deviceX/in_concentration_ethanol_raw
-What:          /sys/bus/iio/devices/iio:deviceX/in_concentrationX_ethanol_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_concentrationY_ethanol_raw
 What:          /sys/bus/iio/devices/iio:deviceX/in_concentration_h2_raw
-What:          /sys/bus/iio/devices/iio:deviceX/in_concentrationX_h2_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_concentrationY_h2_raw
 What:          /sys/bus/iio/devices/iio:deviceX/in_concentration_o2_raw
-What:          /sys/bus/iio/devices/iio:deviceX/in_concentrationX_o2_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_concentrationY_o2_raw
 What:          /sys/bus/iio/devices/iio:deviceX/in_concentration_voc_raw
-What:          /sys/bus/iio/devices/iio:deviceX/in_concentrationX_voc_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_concentrationY_voc_raw
 KernelVersion: 4.3
 Contact:       linux-iio@vger.kernel.org
 Description:
@@ -1912,9 +1912,9 @@ Description:
                after application of scale and offset are percents.
 
 What:          /sys/bus/iio/devices/iio:deviceX/in_resistance_raw
-What:          /sys/bus/iio/devices/iio:deviceX/in_resistanceX_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_resistanceY_raw
 What:          /sys/bus/iio/devices/iio:deviceX/out_resistance_raw
-What:          /sys/bus/iio/devices/iio:deviceX/out_resistanceX_raw
+What:          /sys/bus/iio/devices/iio:deviceX/out_resistanceY_raw
 KernelVersion: 4.3
 Contact:       linux-iio@vger.kernel.org
 Description:
@@ -2103,7 +2103,7 @@ Description:
                One of the following thermocouple types: B, E, J, K, N, R, S, T.
 
 What:          /sys/bus/iio/devices/iio:deviceX/in_temp_object_calibambient
-What:          /sys/bus/iio/devices/iio:deviceX/in_tempX_object_calibambient
+What:          /sys/bus/iio/devices/iio:deviceX/in_tempY_object_calibambient
 KernelVersion: 5.10
 Contact:       linux-iio@vger.kernel.org
 Description:
@@ -2179,9 +2179,9 @@ Description:
 
                - a range specified as "[min step max]"
 
-What:          /sys/bus/iio/devices/iio:deviceX/in_voltageX_sampling_frequency
+What:          /sys/bus/iio/devices/iio:deviceX/in_voltageY_sampling_frequency
 What:          /sys/bus/iio/devices/iio:deviceX/in_powerY_sampling_frequency
-What:          /sys/bus/iio/devices/iio:deviceX/in_currentZ_sampling_frequency
+What:          /sys/bus/iio/devices/iio:deviceX/in_currentY_sampling_frequency
 KernelVersion: 5.20
 Contact:       linux-iio@vger.kernel.org
 Description: