Re: [PATCH v2 6/6] Documentation: ABI: testing: add support for ADF41513

Rodrigo Alencar
2025-12-22T09:24:20Z

On 25/12/21 05:52PM, Jonathan Cameron wrote:
> On Fri, 19 Dec 2025 12:34:53 +0000
> Rodrigo Alencar via B4 Relay <devnull+rodrigo.alencar.analog.com@kernel.org> wrote:
>
> > From: Rodrigo Alencar <rodrigo.alencar@analog.com>
> >
> > Add ABI documentation for ADF41513 PLL sysfs interfaces
> >
> > Signed-off-by: Rodrigo Alencar <rodrigo.alencar@analog.com>
> Do this in the patches that add the ABI, or in a patch before them.
>
> Also try building docs. Unless something changed recently that will
> moan about duplication.
>
> When ABI is generalized from one driver to many we have to move
> the documentation (and make it generic) such that is is shared by
> the relevant drivers. In this case
> sysfs-bus-iio-frequency is probably the appropriate file.

that makes sense, will do. thanks.

> > ---
> > .../ABI/testing/sysfs-bus-iio-frequency-adf41513 | 27 ++++++++++++++++++++++
> > MAINTAINERS | 1 +
> > 2 files changed, 28 insertions(+)
> >
> > diff --git a/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf41513 b/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf41513
> > new file mode 100644
> > index 000000000000..11ffd248eedb
> > --- /dev/null
> > +++ b/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf41513
> > @@ -0,0 +1,27 @@
> > +What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_resolution
> > +KernelVersion: 6.20
> > +Contact: linux-iio@vger.kernel.org
> > +Description:
> > + Stores channel Y frequency resolution/channel spacing in Hz.
> > + The value given directly influences the choice of operation:
> > +
> > + - integer-N: requested frequency is a multiple of the Phase Detector
> > + frequency.
> > + - fixed modulus: fractional-N mode with fixed modulus.
> > + - variable modulus: dual-modulus fractional-N mode with extra variable
> > + modulus added on top of the fixed one.
> > +
> > + It is assumed that the algorithm that is used to compute the various
> > + dividers, is able to generate proper values for multiples of channel
> > + spacing.
> > +
> > +What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_refin_frequency
> > +KernelVersion: 6.20
> > +Contact: linux-iio@vger.kernel.org
> > +Description:
> > + Sets channel Y REFin frequency in Hz. In some clock chained
> > + applications, the reference frequency used by the PLL may change during
> > + runtime. This attribute allows the user to adjust the reference
> > + frequency accordingly.
> > + To avoid glitches in the RF output, consider using out_altvoltageY_powerdown
> > + to power down the PLL and its RFOut buffers during REFin changes.
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index c536c3afc1ae..48fa1011b797 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -1606,6 +1606,7 @@ M: Rodrigo Alencar <rodrigo.alencar@analog.com>
> > L: linux-iio@vger.kernel.org
> > S: Supported
> > W: https://ez.analog.com/linux-software-drivers
> > +F: Documentation/ABI/testing/sysfs-bus-iio-frequency-adf41513
> > F: Documentation/devicetree/bindings/iio/frequency/adi,adf41513.yaml
> > F: Documentation/iio/adf41513.rst
> > F: drivers/iio/frequency/adf41513.c
> >
>