Re: [PATCH v6 8/8] Documentation: ABI: testing: add common ABI file for iio/frequency

[Jonathan Cameron]

On Wed, 11 Feb 2026 13:52:18 +0000
Rodrigo Alencar <455.rodrigo.alencar@xxxxxxxxx> wrote:

> On 26/02/07 05:24PM, Jonathan Cameron wrote:
> > On Fri, 30 Jan 2026 10:06:49 +0000
> > Rodrigo Alencar via B4 Relay <devnull+rodrigo.alencar.analog.com@xxxxxxxxxx> wrote:
> >   
> > > From: Rodrigo Alencar <rodrigo.alencar@xxxxxxxxxx>
> > > 
> > > Add ABI documentation file for PLL/DDS devices with frequency_resolution
> > > sysfs entry attribute used by ADF4350 and ADF41513.  
> 
> Here it mentions that this would also work for ADF4350.
> 
> > > 
> > > Signed-off-by: Rodrigo Alencar <rodrigo.alencar@xxxxxxxxxx>
> > > ---
> > >  Documentation/ABI/testing/sysfs-bus-iio-frequency | 11 +++++++++++
> > >  MAINTAINERS                                       |  1 +
> > >  2 files changed, 12 insertions(+)
> > > 
> > > diff --git a/Documentation/ABI/testing/sysfs-bus-iio-frequency b/Documentation/ABI/testing/sysfs-bus-iio-frequency
> > > new file mode 100644
> > > index 000000000000..1ce8ae578fd6
> > > --- /dev/null
> > > +++ b/Documentation/ABI/testing/sysfs-bus-iio-frequency
> > > @@ -0,0 +1,11 @@
> > > +What:		/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_resolution
> > > +KernelVersion:	6.20
> > > +Contact:	linux-iio@xxxxxxxxxxxxxxx
> > > +Description:
> > > +		Stores channel Y frequency resolution/channel spacing in Hz for PLL
> > > +		devices. The given value directly influences the operating mode when
> > > +		fractional-N synthesis is required, as it derives values for
> > > +		configurable modulus parameters used in the calculation of the output
> > > +		frequency. 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.
> > > diff --git a/MAINTAINERS b/MAINTAINERS
> > > index 0d9b7cf86aec..748eeb6f5bd2 100644
> > > --- a/MAINTAINERS
> > > +++ b/MAINTAINERS
> > > @@ -1639,6 +1639,7 @@ M:	Rodrigo Alencar <rodrigo.alencar@xxxxxxxxxx>
> > >  L:	linux-iio@xxxxxxxxxxxxxxx
> > >  S:	Supported
> > >  W:	https://ez.analog.com/linux-software-drivers
> > > +F:	Documentation/ABI/testing/sysfs-bus-iio-frequency  
> > I wouldn't add this here. Whilst for now we only use the defined
> > ABI in this one driver, I'd not expect it to stay that way.
> > 
> > If we do think it is very drive specific move the file to
> > sysfs-bus-iio-frequency-adf41513  
> 
> The file Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4350
> contains the same ABI description, should that be removed there
> in favor or this one? If so, in MAINTAINERS, what is the best place
> for this ABI file?

For sysfs ABI we can't have repeats in multiple files (it breaks the
docs generation IIRC).  So if we have it used in multiple drivers
then it needs to go in the more generic files as you have it.

For maintainers, either don't bother with an explicit entry  (the subsystem
ones will catch it) or add I suppose we could have one for
drivers/iio/frequency/ that calls out this specific file + all the drivers
in that directory.   I'm not sure that's worthwhile - so I'd go with just
not listing it (ignore the checkpatch warning).

Jonathan


> If not, for simplicity, I may just rename the file to
> sysfs-bus-iio-frequency-adf41513, as you suggested.
>