linux-kernel - Re: [PATCH v3 4/4] iio:filter:admv8818: Add sysfs ABI documentation

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]

Message-ID: <20211216172127.74371d2e@jic23-huawei>
Date:   Thu, 16 Dec 2021 17:21:27 +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 4/4] iio:filter:admv8818: Add sysfs ABI documentation

On Tue, 7 Dec 2021 17:54:45 +0200
Antoniu Miclaus <antoniu.miclaus@...log.com> wrote:

> Add initial ABI documentation for admv8818 filter sysfs interfaces.
> 
> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@...log.com>

Hi Antoniu

Please make sure to include change logs for all the patches - or a summary in
a cover letter is also fine.
> ---

I made an unclear comment in v2 review.
What I meant to request for the 3db_frequency was that you added a
line to the main sysfs-bus-iio documentation in the 3db_frequency block to
cover it's use with out_altvoltageX_filter_high_base_3db_frequency


>  .../ABI/testing/sysfs-bus-iio-filter-admv8818    | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-filter-admv8818
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-filter-admv8818 b/Documentation/ABI/testing/sysfs-bus-iio-filter-admv8818
> new file mode 100644
> index 000000000000..f6c035752639
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-filter-admv8818
> @@ -0,0 +1,16 @@
> +What:		/sys/bus/iio/devices/iio:deviceX/filter_mode_available
> +KernelVersion:

As per other review, please fill these in.  I'll never remember to do it whilst
applying so just take a guess and update if we cross into the next cycle during review.

> +Contact:	linux-iio@...r.kernel.org
> +Description:
> +		Reading this returns the valid values that can be written to the
> +		on_altvoltage0_mode attribute:
> +
> +		- auto -> Adjust bandpass filter to track changes in input clock rate.
> +		- manual -> disable/unregister the clock rate notifier / input clock tracking.
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/filter_mode
> +KernelVersion:
> +Contact:	linux-iio@...r.kernel.org
> +Description:
> +		This attribute configures the filter mode.
> +		Reading returns the actual mode.