Re: [v3 08/13] iio: document bno055 private sysfs attributes

From: Jonathan Cameron <jic23@kernel.org>
To: Andrea Merello <andrea.merello@gmail.com>
Cc: mchehab+huawei@kernel.org, linux-iio@vger.kernel.org,
	linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
	lars@metafoo.de, robh+dt@kernel.org, andy.shevchenko@gmail.com,
	matt.ranostay@konsulko.com, ardeleanalex@gmail.com,
	jacopo@jmondi.org, Andrea Merello <andrea.merello@iit.it>
Subject: Re: [v3 08/13] iio: document bno055 private sysfs attributes
Date: Sat, 19 Feb 2022 16:50:00 +0000	[thread overview]
Message-ID: <20220219165000.56877005@jic23-huawei> (raw)
In-Reply-To: <20220217162710.33615-9-andrea.merello@gmail.com>

On Thu, 17 Feb 2022 17:27:05 +0100
Andrea Merello <andrea.merello@gmail.com> wrote:

> This patch adds ABI documentation for bno055 driver private sysfs
> attributes.
> 
> Signed-off-by: Andrea Merello <andrea.merello@iit.it>
> ---
>  .../ABI/testing/sysfs-bus-iio-bno055          | 81 +++++++++++++++++++
>  1 file changed, 81 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-bno055
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-bno055 b/Documentation/ABI/testing/sysfs-bus-iio-bno055
> new file mode 100644
> index 000000000000..c239276f2b0f
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-bno055
> @@ -0,0 +1,81 @@
> +What:		/sys/bus/iio/devices/iio:deviceX/in_accel_raw_range
> +KernelVersion:	5.17

Update this to 5.18 as hopefully we'll resolve remaining questions in
time to make the merge window.

> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Range for acceleration readings in m/s^2. 

If it is in m/s^2 then we need to not call it _raw_ as that implies application
of offset and scale.  I didn't think this through in earlier discussion...

If it's in m/s^2 then in_accel_input_range would be appropriate.
Same for the other similar cases that follow.

> 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_anglvel_raw_range
> +KernelVersion:	5.17
> +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:	5.17
> +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:	5.17
> +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:	5.17
> +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:	5.17
> +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:	5.17
> +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:	5.17
> +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:	5.17
> +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:	5.17
> +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:	5.17
> +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.