iio: Documentation: update definitions for bufferY and scan_elements
authorAlexandru Ardelean <alexandru.ardelean@analog.com>
Wed, 17 Feb 2021 08:34:34 +0000 (10:34 +0200)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Thu, 11 Mar 2021 20:47:11 +0000 (20:47 +0000)
Since the new change to the IIO buffer infrastructure, the buffer/ and
scan_elements/ directories have been merged into bufferY/ to have some
attributes available per-buffer.

This change updates the ABI docs to reflect this change.

The hwfifo attributes are not updated, as for now these should be used
via the legacy buffer/ directory until they are moved into core.

Signed-off-by: Alexandru Ardelean <alexandru.ardelean@analog.com>
Link: https://lore.kernel.org/r/20210217083438.37865-2-alexandru.ardelean@analog.com
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Documentation/ABI/testing/sysfs-bus-iio

index d709a51819806f64e207f8a7dee0e72afdc15dd0..affd4ce871d7bd7c0559fc3c461c15bf695e7f97 100644 (file)
@@ -1164,12 +1164,16 @@ Description:
 
 What:          /sys/bus/iio/devices/iio:deviceX/buffer/length
 KernelVersion: 2.6.35
+What:          /sys/bus/iio/devices/iio:deviceX/bufferY/length
+KernelVersion: 5.11
 Contact:       linux-iio@vger.kernel.org
 Description:
                Number of scans contained by the buffer.
 
 What:          /sys/bus/iio/devices/iio:deviceX/buffer/enable
 KernelVersion: 2.6.35
+What:          /sys/bus/iio/devices/iio:deviceX/bufferY/enable
+KernelVersion: 5.11
 Contact:       linux-iio@vger.kernel.org
 Description:
                Actually start the buffer capture up.  Will start trigger
@@ -1177,11 +1181,16 @@ Description:
 
 What:          /sys/bus/iio/devices/iio:deviceX/scan_elements
 KernelVersion: 2.6.37
+What:          /sys/bus/iio/devices/iio:deviceX/bufferY
+KernelVersion: 5.11
 Contact:       linux-iio@vger.kernel.org
 Description:
                Directory containing interfaces for elements that will be
                captured for a single triggered sample set in the buffer.
 
+               Since kernel 5.11 the scan_elements attributes are merged into
+               the bufferY directory, to be configurable per buffer.
+
 What:          /sys/.../iio:deviceX/scan_elements/in_accel_x_en
 What:          /sys/.../iio:deviceX/scan_elements/in_accel_y_en
 What:          /sys/.../iio:deviceX/scan_elements/in_accel_z_en
@@ -1210,6 +1219,34 @@ What:            /sys/.../iio:deviceX/scan_elements/in_pressure_en
 What:          /sys/.../iio:deviceX/scan_elements/in_rot_quaternion_en
 What:          /sys/.../iio:deviceX/scan_elements/in_proximity_en
 KernelVersion: 2.6.37
+What:          /sys/.../iio:deviceX/bufferY/in_accel_x_en
+What:          /sys/.../iio:deviceX/bufferY/in_accel_y_en
+What:          /sys/.../iio:deviceX/bufferY/in_accel_z_en
+What:          /sys/.../iio:deviceX/bufferY/in_anglvel_x_en
+What:          /sys/.../iio:deviceX/bufferY/in_anglvel_y_en
+What:          /sys/.../iio:deviceX/bufferY/in_anglvel_z_en
+What:          /sys/.../iio:deviceX/bufferY/in_magn_x_en
+What:          /sys/.../iio:deviceX/bufferY/in_magn_y_en
+What:          /sys/.../iio:deviceX/bufferY/in_magn_z_en
+What:          /sys/.../iio:deviceX/bufferY/in_rot_from_north_magnetic_en
+What:          /sys/.../iio:deviceX/bufferY/in_rot_from_north_true_en
+What:          /sys/.../iio:deviceX/bufferY/in_rot_from_north_magnetic_tilt_comp_en
+What:          /sys/.../iio:deviceX/bufferY/in_rot_from_north_true_tilt_comp_en
+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
+What:          /sys/.../iio:deviceX/bufferY/in_pressure_en
+What:          /sys/.../iio:deviceX/bufferY/in_rot_quaternion_en
+What:          /sys/.../iio:deviceX/bufferY/in_proximity_en
+KernelVersion: 5.11
 Contact:       linux-iio@vger.kernel.org
 Description:
                Scan element control for triggered data capture.
@@ -1231,6 +1268,23 @@ What:            /sys/.../iio:deviceX/scan_elements/in_pressure_type
 What:          /sys/.../iio:deviceX/scan_elements/in_rot_quaternion_type
 What:          /sys/.../iio:deviceX/scan_elements/in_proximity_type
 KernelVersion: 2.6.37
+What:          /sys/.../iio:deviceX/bufferY/in_accel_type
+What:          /sys/.../iio:deviceX/bufferY/in_anglvel_type
+What:          /sys/.../iio:deviceX/bufferY/in_magn_type
+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
+What:          /sys/.../iio:deviceX/bufferY/in_rot_quaternion_type
+What:          /sys/.../iio:deviceX/bufferY/in_proximity_type
+KernelVersion: 5.11
 Contact:       linux-iio@vger.kernel.org
 Description:
                Description of the scan element data storage within the buffer
@@ -1287,6 +1341,33 @@ What:            /sys/.../iio:deviceX/scan_elements/in_pressure_index
 What:          /sys/.../iio:deviceX/scan_elements/in_rot_quaternion_index
 What:          /sys/.../iio:deviceX/scan_elements/in_proximity_index
 KernelVersion: 2.6.37
+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
+What:          /sys/.../iio:deviceX/bufferY/in_anglvel_x_index
+What:          /sys/.../iio:deviceX/bufferY/in_anglvel_y_index
+What:          /sys/.../iio:deviceX/bufferY/in_anglvel_z_index
+What:          /sys/.../iio:deviceX/bufferY/in_magn_x_index
+What:          /sys/.../iio:deviceX/bufferY/in_magn_y_index
+What:          /sys/.../iio:deviceX/bufferY/in_magn_z_index
+What:          /sys/.../iio:deviceX/bufferY/in_rot_from_north_magnetic_index
+What:          /sys/.../iio:deviceX/bufferY/in_rot_from_north_true_index
+What:          /sys/.../iio:deviceX/bufferY/in_rot_from_north_magnetic_tilt_comp_index
+What:          /sys/.../iio:deviceX/bufferY/in_rot_from_north_true_tilt_comp_index
+What:          /sys/.../iio:deviceX/bufferY/in_incli_x_index
+What:          /sys/.../iio:deviceX/bufferY/in_incli_y_index
+What:          /sys/.../iio:deviceX/bufferY/in_timestamp_index
+What:          /sys/.../iio:deviceX/bufferY/in_pressureY_index
+What:          /sys/.../iio:deviceX/bufferY/in_pressure_index
+What:          /sys/.../iio:deviceX/bufferY/in_rot_quaternion_index
+What:          /sys/.../iio:deviceX/bufferY/in_proximity_index
+KernelVersion: 5.11
 Contact:       linux-iio@vger.kernel.org
 Description:
                A single positive integer specifying the position of this
@@ -1501,6 +1582,8 @@ Description:
 
 What:          /sys/bus/iio/devices/iio:deviceX/buffer/watermark
 KernelVersion: 4.2
+What:          /sys/bus/iio/devices/iio:deviceX/bufferY/watermark
+KernelVersion: 5.11
 Contact:       linux-iio@vger.kernel.org
 Description:
                A single positive integer specifying the maximum number of scan
@@ -1519,6 +1602,8 @@ Description:
 
 What:          /sys/bus/iio/devices/iio:deviceX/buffer/data_available
 KernelVersion: 4.16
+What:          /sys/bus/iio/devices/iio:deviceX/bufferY/data_available
+KernelVersion: 5.11
 Contact:       linux-iio@vger.kernel.org
 Description:
                A read-only value indicating the bytes of data available in the