linux-kernel - Re: [PATCH v3 7/7] docs: iio: add documentation for adis16550 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: <20241219173905.7bad1f71@jic23-huawei>
Date: Thu, 19 Dec 2024 17:39:05 +0000
From: Jonathan Cameron <jic23@...nel.org>
To: Robert Budai <robert.budai@...log.com>
Cc: Lars-Peter Clausen <lars@...afoo.de>, Michael Hennerich
 <Michael.Hennerich@...log.com>, Nuno Sa <nuno.sa@...log.com>, Ramona
 Gradinariu <ramona.gradinariu@...log.com>, Antoniu Miclaus
 <antoniu.miclaus@...log.com>, Rob Herring <robh@...nel.org>, Krzysztof
 Kozlowski <krzk+dt@...nel.org>, Conor Dooley <conor+dt@...nel.org>,
 Jonathan Corbet <corbet@....net>, Shen Jianping
 <Jianping.Shen@...bosch.com>, Alex Lanzano <lanzano.alex@...il.com>,
 <linux-iio@...r.kernel.org>, <devicetree@...r.kernel.org>,
 <linux-kernel@...r.kernel.org>, <linux-doc@...r.kernel.org>,
 <robi_budai@...oo.com>
Subject: Re: [PATCH v3 7/7] docs: iio: add documentation for adis16550
 driver

On Mon, 16 Dec 2024 16:48:13 +0200
Robert Budai <robert.budai@...log.com> wrote:

> Add documentation for adis16550 driver which describes the driver
> device files and shows how the user may use the ABI for various
> scenarios (configuration, measurement, etc.).
> 
> Co-developed-by: Antoniu Miclaus <antoniu.miclaus@...log.com>
> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@...log.com>
> Signed-off-by: Ramona Gradinariu <ramona.gradinariu@...log.com>
> Signed-off-by: Robert Budai <robert.budai@...log.com>
> ---
>  Documentation/iio/adis16550.rst | 389 ++++++++++++++++++++++++++++++++
>  Documentation/iio/index.rst     |   1 +
>  2 files changed, 390 insertions(+)
>  create mode 100644 Documentation/iio/adis16550.rst
> 
> diff --git a/Documentation/iio/adis16550.rst b/Documentation/iio/adis16550.rst
> new file mode 100644
> index 000000000000..fde38060f8fe
> --- /dev/null
> +++ b/Documentation/iio/adis16550.rst
> @@ -0,0 +1,389 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +================
> +ADIS16550 driver
> +================
> +
> +This driver supports Analog Device's IMUs on SPI bus.
> +
> +1. Supported devices
> +====================
> +
> +* `ADIS16550 <https://www.analog.com/ADIS16550>`_
> +
> +The ADIS16550 is a complete inertial system that includes a triaxis gyroscope
> +and a triaxis accelerometer. Each inertial sensor in the ADIS16550 combines
> +industry leading MEMS only technology with signal conditioning that optimizes

Trim out the marketing bits.  So just loose this sentence.

> +dynamic performance. The factory calibration characterizes each sensor for
> +sensitivity, bias, and alignment. As a result, each sensor has its own dynamic
> +compensation formulas that provide accurate sensor measurements.
> +
> +The ADIS16550 provides a simple, cost-effective method for integrating accurate,
> +multiaxis inertial sensing into industrial systems, especially when compared
> +with the complexity and investment associated with discrete designs. All
> +necessary motion testing and calibration are part of the production process at
> +the factory, greatly reducing system integration time. Tight orthogonal
> +alignment simplifies inertial frame alignment in navigation systems. The serial
> +peripheral interface (SPI) and register structure provide a simple interface for
> +data collection and configuration control.
Drop this whole paragraph for similar reasons.

Otherwise LGTM

Thanks,

Jonathan