linux-kernel - Re: [PATCH v3 3/4] Documentation:ABI:testing:admv1014: add ABI docs

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] [thread-next>] [day] [month] [year] [list]

Date:   Sat, 22 Jan 2022 17:38:31 +0000
From:   Jonathan Cameron <jic23@...nel.org>
To:     Antoniu Miclaus <antoniu.miclaus@...log.com>
Cc:     <robh+dt@...nel.org>, <linux-iio@...r.kernel.org>,
        <devicetree@...r.kernel.org>, <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH v3 3/4] Documentation:ABI:testing:admv1014: add ABI docs

On Wed, 19 Jan 2022 10:18:37 +0200
Antoniu Miclaus <antoniu.miclaus@...log.com> wrote:

> Add documentation for the use of the Digital Attenuator gain.
> 
> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@...log.com>
One entry that should be in the generic docs rather than here.

Given the documentation generation scripts don't support multiple
entries for a given attribute name an that one is 'standard'
we should just add it to the main file as otherwise the chances
are very high of accidentally getting duplication when it
turns up in another driver ABI doc.

We may need to move some of the others later if they turn out
to occur in multiple drivers but they are obscure enough to
be fine in this file for now.

Thanks,

Jonathan

> ---
> changes in v3:
>  - add description for calibscale in I/Q mode
>  .../testing/sysfs-bus-iio-frequency-admv1014  | 29 +++++++++++++++++++
>  1 file changed, 29 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-frequency-admv1014
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-frequency-admv1014 b/Documentation/ABI/testing/sysfs-bus-iio-frequency-admv1014
> new file mode 100644
> index 000000000000..77c1691e6910
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-frequency-admv1014
> @@ -0,0 +1,29 @@
> +What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0_i_calibscale_coarse
> +KernelVersion:
> +Contact:	linux-iio@...r.kernel.org
> +Description:
> +		Read/write value for the digital attenuator gain (IF_I) with coarse steps.
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0_q_calibscale_coarse
> +KernelVersion:
> +Contact:	linux-iio@...r.kernel.org
> +Description:
> +		Read/write value for the digital attenuator gain (IF_Q) with coarse steps.
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0_i_calibscale_fine
> +KernelVersion:
> +Contact:	linux-iio@...r.kernel.org
> +Description:
> +		Read/write value for the digital attenuator gain (IF_I) with fine steps.
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0_q_calibscale_fine
> +KernelVersion:
> +Contact:	linux-iio@...r.kernel.org
> +Description:
> +		Read/write value for the digital attenuator gain (IF_Q) with fine steps.
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage_calibscale

This particular one is normal ABI, so should just be added to the list
in sysfs-bus-iio alongside all the other calibscale entries.


> +KernelVersion:
> +Contact:	linux-iio@...r.kernel.org
> +Description:
> +		Read/write value for the digital attenuator gain (I/Q).