iio: document bno055 private sysfs attributes
authorAndrea Merello <andrea.merello@iit.it>
Wed, 7 Sep 2022 13:22:00 +0000 (15:22 +0200)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Wed, 21 Sep 2022 17:42:56 +0000 (18:42 +0100)
Add ABI documentation for bno055 driver private sysfs attributes.

Signed-off-by: Andrea Merello <andrea.merello@iit.it>
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Link: https://lore.kernel.org/r/20220907132205.28021-10-andrea.merello@iit.it
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Documentation/ABI/testing/sysfs-bus-iio-bno055 [new file with mode: 0644]

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-bno055 b/Documentation/ABI/testing/sysfs-bus-iio-bno055
new file mode 100644 (file)
index 0000000..f32b164
--- /dev/null
@@ -0,0 +1,81 @@
+What:          /sys/bus/iio/devices/iio:deviceX/in_accel_raw_range
+KernelVersion: 6.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Raw (unscaled) range for acceleration readings. Unit after
+               application of scale is m/s^2. Note that this doesn't affects
+               the scale (which should be used when changing the maximum and
+               minimum readable value affects also the reading scaling factor).
+
+What:          /sys/bus/iio/devices/iio:deviceX/in_anglvel_raw_range
+KernelVersion: 6.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Range for angular velocity readings in radians per second. Note
+               that this does not affects the scale (which should be used when
+               changing the maximum and minimum readable value affects also the
+               reading scaling factor).
+
+What:          /sys/bus/iio/devices/iio:deviceX/in_accel_raw_range_available
+KernelVersion: 6.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               List of allowed values for in_accel_raw_range attribute
+
+What:          /sys/bus/iio/devices/iio:deviceX/in_anglvel_raw_range_available
+KernelVersion: 6.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               List of allowed values for in_anglvel_raw_range attribute
+
+What:          /sys/bus/iio/devices/iio:deviceX/in_magn_calibration_fast_enable
+KernelVersion: 6.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Can be 1 or 0. Enables/disables the "Fast Magnetometer
+               Calibration" HW function.
+
+What:          /sys/bus/iio/devices/iio:deviceX/fusion_enable
+KernelVersion: 6.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Can be 1 or 0. Enables/disables the "sensor fusion" (a.k.a.
+               NDOF) HW function.
+
+What:          /sys/bus/iio/devices/iio:deviceX/calibration_data
+KernelVersion: 6.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Reports the binary calibration data blob for the IMU sensors.
+
+What:          /sys/bus/iio/devices/iio:deviceX/in_accel_calibration_auto_status
+KernelVersion: 6.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Reports the autocalibration status for the accelerometer sensor.
+               Can be 0 (calibration non even enabled) or 1 to 5 where the greater
+               the number, the better the calibration status.
+
+What:          /sys/bus/iio/devices/iio:deviceX/in_gyro_calibration_auto_status
+KernelVersion: 6.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Reports the autocalibration status for the gyroscope sensor.
+               Can be 0 (calibration non even enabled) or 1 to 5 where the greater
+               the number, the better the calibration status.
+
+What:          /sys/bus/iio/devices/iio:deviceX/in_magn_calibration_auto_status
+KernelVersion: 6.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Reports the autocalibration status for the magnetometer sensor.
+               Can be 0 (calibration non even enabled) or 1 to 5 where the greater
+               the number, the better the calibration status.
+
+What:          /sys/bus/iio/devices/iio:deviceX/sys_calibration_auto_status
+KernelVersion: 6.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Reports the status for the IMU overall autocalibration.
+               Can be 0 (calibration non even enabled) or 1 to 5 where the greater
+               the number, the better the calibration status.