linux-kernel - Re: [PATCH v3 3/3] docs: iio: add documentation for adis16475 driver

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20240210180809.1a01733e@jic23-huawei>
Date: Sat, 10 Feb 2024 18:08:09 +0000
From: Jonathan Cameron <jic23@...nel.org>
To: Ramona Gradinariu <ramona.gradinariu@...log.com>
Cc: <corbet@....net>, <linux-doc@...r.kernel.org>,
 <linux-kernel@...r.kernel.org>, <nuno.sa@...log.com>,
 <linux-iio@...r.kernel.org>
Subject: Re: [PATCH v3 3/3] docs: iio: add documentation for adis16475
 driver

On Thu, 8 Feb 2024 12:01:26 +0200
Ramona Gradinariu <ramona.gradinariu@...log.com> wrote:

> Add documentation for adis16475 driver which describes
> the driver device files and shows how the user may use the
> ABI for various scenarios (configuration, measurement, etc.).
> 
> Signed-off-by: Ramona Gradinariu <ramona.gradinariu@...log.com>
> ---
> changes in v3:
>  - fixed wrapping
>  - added sentence showing device files location
>  - fixed typo in device file names by adding the in_ prefix
>  - added new section for channels processed values
>  - rephrased the trigger setting section
>  - gave reference to iio_devbuf documentation for raw data
>  Documentation/iio/adis16475.rst | 381 ++++++++++++++++++++++++++++++++
>  Documentation/iio/index.rst     |   1 +
>  2 files changed, 382 insertions(+)
>  create mode 100644 Documentation/iio/adis16475.rst
> 
> diff --git a/Documentation/iio/adis16475.rst b/Documentation/iio/adis16475.rst
> new file mode 100644
> index 000000000000..192ec1225de5
> --- /dev/null
> +++ b/Documentation/iio/adis16475.rst
> @@ -0,0 +1,381 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +================
> +ADIS16475 driver
> +================
> +
> +This driver supports Analog Device's IMUs on SPI bus.
> +
> +1. Supported devices
> +====================
> +
> +* `ADIS16465 <https://www.analog.com/ADIS16465>`_
> +* `ADIS16467 <https://www.analog.com/ADIS16467>`_
> +* `ADIS16470 <https://www.analog.com/ADIS16470>`_
> +* `ADIS16475 <https://www.analog.com/ADIS16475>`_
> +* `ADIS16477 <https://www.analog.com/ADIS16477>`_
> +* `ADIS16500 <https://www.analog.com/ADIS16500>`_
> +* `ADIS16505 <https://www.analog.com/ADIS16505>`_
> +* `ADIS16507 <https://www.analog.com/ADIS16507>`_
> +
> +Each supported device is a precision, miniature microelectromechanical system
> +(MEMS) inertial measurement unit (IMU) that includes a triaxial gyroscope and a
> +triaxial accelerometer. Each inertial sensor in the IMU device combines with
> +signal conditioning that optimizes dynamic performance. The factory calibration
> +characterizes each sensor for sensitivity, bias, alignment, linear acceleration
> +(gyroscope bias), and point of percussion (accelerometer location). As a result,
> +each sensor has dynamic compensation formulas that provide accurate sensor
> +measurements over a broad set of conditions.
> +
> +2. Device attributes
> +====================
> +
> +Accelerometer, gyroscope measures are always provided. Furthermore, the driver
measurements (probably what you mean)

> +offers the capability to retrieve the delta angle and the delta velocity
> +measurements computed by the device.
> +
> +The delta angle measurements represent a calculation of angular displacement
> +between each sample update, while  the delta velocity measurements represent a

looks like an accidental extra space after while.

> +calculation of linear velocity change between each sample update.
> +
> +Finally, temperature data are provided which show a coarse measurement of
> +the temperature inside of the IMU device. This data is most useful for
> +monitoring relative changes in the thermal environment.
>> +
> +Usage examples
> +--------------

Whilst useful to lay this out, perhaps reference some standard tools that do all this
for you? (either the really simple one in the kernel tree and/or libiio etc)

Overall very nice docs.

Thanks,

Jonathan