public inbox for devicetree@vger.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Cameron <jic23@kernel.org>
To: Rodrigo Alencar via B4 Relay
	<devnull+rodrigo.alencar.analog.com@kernel.org>
Cc: rodrigo.alencar@analog.com, linux-kernel@vger.kernel.org,
	linux-iio@vger.kernel.org, devicetree@vger.kernel.org,
	linux-doc@vger.kernel.org, David Lechner <dlechner@baylibre.com>,
	Andy Shevchenko <andy@kernel.org>,
	Lars-Peter Clausen <lars@metafoo.de>,
	Michael Hennerich <Michael.Hennerich@analog.com>,
	Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	Conor Dooley <conor+dt@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Andrew Morton <akpm@linux-foundation.org>,
	Petr Mladek <pmladek@suse.com>,
	Steven Rostedt <rostedt@goodmis.org>,
	Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
	Rasmus Villemoes <linux@rasmusvillemoes.dk>,
	Sergey Senozhatsky <senozhatsky@chromium.org>,
	Shuah Khan <skhan@linuxfoundation.org>
Subject: Re: [PATCH v10 10/11] docs: iio: add documentation for adf41513 driver
Date: Sat, 25 Apr 2026 17:40:22 +0100	[thread overview]
Message-ID: <20260425174022.0d1a6bd9@jic23-huawei> (raw)
In-Reply-To: <20260415-adf41513-iio-driver-v10-10-df61046d5457@analog.com>

On Wed, 15 Apr 2026 10:51:53 +0100
Rodrigo Alencar via B4 Relay <devnull+rodrigo.alencar.analog.com@kernel.org> wrote:

> From: Rodrigo Alencar <rodrigo.alencar@analog.com>
> 
> Add documentation for ADF41513 driver, which describes the device
> driver files and shows how userspace may consume the ABI for various
> tasks.
> 
> Signed-off-by: Rodrigo Alencar <rodrigo.alencar@analog.com>
> ---
>  Documentation/iio/adf41513.rst | 199 +++++++++++++++++++++++++++++++++++++++++
>  Documentation/iio/index.rst    |   1 +
>  MAINTAINERS                    |   1 +
>  3 files changed, 201 insertions(+)
> 
> diff --git a/Documentation/iio/adf41513.rst b/Documentation/iio/adf41513.rst
> new file mode 100644
> index 000000000000..4193c825b532
> --- /dev/null
> +++ b/Documentation/iio/adf41513.rst
> @@ -0,0 +1,199 @@

> +2. Device attributes
> +====================
> +
> +The ADF41513 driver provides the following IIO extended attributes for
> +frequency control and monitoring:
> +
> +Each IIO device has a device folder under ``/sys/bus/iio/devices/iio:deviceX``,
> +where X is the IIO index of the device. Under these folders reside a set of
> +device files that provide access to the synthesizer's functionality.
> +
> +The following table shows the ADF41513 related device files:
> +
> ++----------------------+-------------------------------------------------------+
> +| Device file          | Description                                           |
> ++======================+=======================================================+
> +| frequency            | RF output frequency control and readback (Hz)         |
> ++----------------------+-------------------------------------------------------+
> +| frequency_resolution | Target frequency resolution control (Hz)              |
> ++----------------------+-------------------------------------------------------+
> +| powerdown            | Power management control (0=active, 1=power down)     |
> ++----------------------+-------------------------------------------------------+
> +| phase                | RF output phase adjustment and readback (radians)     |
> ++----------------------+-------------------------------------------------------+

These seem to be truncated as the out_altvoltage0_ prefix isn't mentioned.
Fine to do that but add a note to say that more clearly.
I briefly read this as 'new ABI' though the examples a at the end of the file
make it clear that we are simply missing the prefix.




  reply	other threads:[~2026-04-25 16:40 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-15  9:51 [PATCH v10 00/11] ADF41513/ADF41510 PLL frequency synthesizers Rodrigo Alencar via B4 Relay
2026-04-15  9:51 ` [PATCH v10 01/11] dt-bindings: iio: frequency: add adf41513 Rodrigo Alencar via B4 Relay
2026-04-15  9:51 ` [PATCH v10 02/11] lib: kstrtox: add kstrtoudec64() and kstrtodec64() Rodrigo Alencar via B4 Relay
2026-04-17  8:36   ` Rodrigo Alencar
2026-04-25 15:40     ` Jonathan Cameron
2026-04-25 22:33       ` David Laight
2026-04-26  8:02         ` Rodrigo Alencar
2026-04-27  6:56           ` Andy Shevchenko
2026-04-15  9:51 ` [PATCH v10 03/11] lib: test-kstrtox: tests for kstrtodec64() and kstrtoudec64() Rodrigo Alencar via B4 Relay
2026-04-15  9:51 ` [PATCH v10 04/11] lib: math: div64: add div64_s64_rem() Rodrigo Alencar via B4 Relay
2026-04-15  9:51 ` [PATCH v10 05/11] iio: core: add decimal value formatting into 64-bit value Rodrigo Alencar via B4 Relay
2026-04-15  9:51 ` [PATCH v10 06/11] iio: test: iio-test-format: add test case for decimal format Rodrigo Alencar via B4 Relay
2026-04-15  9:51 ` [PATCH v10 07/11] iio: frequency: adf41513: driver implementation Rodrigo Alencar via B4 Relay
2026-04-25 16:33   ` Jonathan Cameron
2026-04-15  9:51 ` [PATCH v10 08/11] iio: frequency: adf41513: handle LE synchronization feature Rodrigo Alencar via B4 Relay
2026-04-15  9:51 ` [PATCH v10 09/11] iio: frequency: adf41513: features on frequency change Rodrigo Alencar via B4 Relay
2026-04-15  9:51 ` [PATCH v10 10/11] docs: iio: add documentation for adf41513 driver Rodrigo Alencar via B4 Relay
2026-04-25 16:40   ` Jonathan Cameron [this message]
2026-04-15  9:51 ` [PATCH v10 11/11] Documentation: ABI: testing: add common ABI file for iio/frequency Rodrigo Alencar via B4 Relay
2026-04-15 10:24 ` [PATCH v10 00/11] ADF41513/ADF41510 PLL frequency synthesizers Andy Shevchenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260425174022.0d1a6bd9@jic23-huawei \
    --to=jic23@kernel.org \
    --cc=Michael.Hennerich@analog.com \
    --cc=akpm@linux-foundation.org \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=andy@kernel.org \
    --cc=conor+dt@kernel.org \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=devnull+rodrigo.alencar.analog.com@kernel.org \
    --cc=dlechner@baylibre.com \
    --cc=krzk+dt@kernel.org \
    --cc=lars@metafoo.de \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@rasmusvillemoes.dk \
    --cc=pmladek@suse.com \
    --cc=robh@kernel.org \
    --cc=rodrigo.alencar@analog.com \
    --cc=rostedt@goodmis.org \
    --cc=senozhatsky@chromium.org \
    --cc=skhan@linuxfoundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox