Re: [PATCH v2 2/3] Documentation: ABI: iio: Add offsets for some sensors

Jonathan Cameron
2020-09-06T15:43:47Z

On Mon, 31 Aug 2020 20:00:16 -0700
Gwendal Grignou <gwendal@chromium.org> wrote:

> Add offsets for magnetometer and gyroscope.
> They can be use to represent online calibration to offset
> hard iron or drift.
>
> Signed-off-by: Gwendal Grignou <gwendal@chromium.org>
For these, please put them after the catchall offset block.
It's probably also worth moving the
in_magn_offset from the catch all to this specific one.

Have a go at figuring out when these were introduced as ABI
as well and fill in the version number.

Thanks,

Jonathan

> ---
> Changes since v1:
> - New, split from 3/3 patch.
> Documentation/ABI/testing/sysfs-bus-iio | 19 +++++++++++++++++++
> 1 file changed, 19 insertions(+)
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> index 47df16c87862d..f77aee8886c66 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio
> +++ b/Documentation/ABI/testing/sysfs-bus-iio
> @@ -1716,3 +1716,22 @@ Description:
> Mass concentration reading of particulate matter in ug / m3.
> pmX consists of particles with aerodynamic diameter less or
> equal to X micrometers.
> +
> +What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_offset
> +What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_offset
> +What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_offset
> +KernelVersion: x.y
> +Contact: linux-iio@vger.kernel.org
> +Description:
> + Gyroscope drift calculated by the sensor. In addition to factory
> + calibration, sensor or sensorhub can
> + detect gyroscope drift and report it to userspace.
> +
> +What: /sys/bus/iio/devices/iio:deviceX/in_magn_x_offset
> +What: /sys/bus/iio/devices/iio:deviceX/in_magn_y_offset
> +What: /sys/bus/iio/devices/iio:deviceX/in_magn_z_offset
> +KernelVersion: x.y
> +Contact: linux-iio@vger.kernel.org
> +Description:
> + Hard Iron bias calculated by the sensor or sensorhub. To be applied by
> + user space application to the raw data to obtain the geomagnetic field.