From: Antoniu Miclaus <antoniu.miclaus@analog.com>
To: <jic23@kernel.org>, <robh+dt@kernel.org>,
<linux-iio@vger.kernel.org>, <devicetree@vger.kernel.org>,
<linux-kernel@vger.kernel.org>
Cc: Antoniu Miclaus <antoniu.miclaus@analog.com>
Subject: [PATCH 4/4] iio:filter:admv8818: Add sysfs ABI documentation
Date: Tue, 9 Nov 2021 14:31:27 +0200 [thread overview]
Message-ID: <20211109123127.96399-5-antoniu.miclaus@analog.com> (raw)
In-Reply-To: <20211109123127.96399-1-antoniu.miclaus@analog.com>
Add initial ABI documentation for admv8818 filter sysfs interfaces.
Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
---
.../ABI/testing/sysfs-bus-iio-filter-admv8818 | 60 +++++++++++++++++++
1 file changed, 60 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..7fa5b0819055
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-filter-admv8818
@@ -0,0 +1,60 @@
+What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_filter_high_pass_3db_frequency
+KernelVersion:
+Contact: linux-iio@vger.kernel.org
+Description:
+ The cut-off frequency of the ADMV8818 high pass filter. The value is scaled using
+ the `out_altvoltageY_scale` attribute so that GHz frequencies are valid inputs,
+ The accepted range of values for the frequencies is between 1.75GHz and 19.9GHz.
+
+ The default value for the scale is 1000000, therefore MHz frequency values are
+ passed as input.
+
+What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_filter_low_pass_3db_frequency
+KernelVersion:
+Contact: linux-iio@vger.kernel.org
+Description:
+ The cut-off frequency of the ADMV8818 low pass filter. The value is scaled using
+ the `out_altvoltageY_scale` attribute so that GHz frequencies are valid inputs,
+ The accepted range of values for the frequencies is between 2.05GHz and 18.85GHz.
+
+ The default value for the scale is 1000000, therefore MHz frequency values are
+ passed as input.
+
+What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_scale
+KernelVersion:
+Contact: linux-iio@vger.kernel.org
+Description:
+ Scale high pass and lowpass filter frequency values to Hz.
+
+What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_mode_available
+KernelVersion:
+Contact: linux-iio@vger.kernel.org
+Description:
+ Reading this returns the valid values that can be written to the
+ on_altvoltage0_mode attribute:
+
+ - auto -> enable/register the clock rate notifier
+ - manual -> disable/unregister the clock rate notifier
+ - bypass -> bypass LPF/HPF and disable/unregister the clock rate notifier
+
+What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_mode
+KernelVersion:
+Contact: linux-iio@vger.kernel.org
+Description:
+ This attribute configures the filter mode.
+ Reading returns the actual mode.
+
+What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_filter_band_pass_bandwidth_3db_frequency
+KernelVersion:
+Contact: linux-iio@vger.kernel.org
+Description:
+ Store the band pass bandwidth frequency value applied.
+ Reading returns the bandwidth frequency scaled.
+
+
+What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_filter_band_pass_center_frequency
+KernelVersion:
+Contact: linux-iio@vger.kernel.org
+Description:
+ Store the band pass center frequency value applied.
+ Reading returns the center frequency scaled.
--
2.33.1
next prev parent reply other threads:[~2021-11-09 12:32 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-09 12:31 [PATCH 0/4] Add support for ADMV8818 Antoniu Miclaus
2021-11-09 12:31 ` [PATCH 1/4] iio: add filter subfolder Antoniu Miclaus
2021-11-12 17:36 ` Jonathan Cameron
2021-11-12 17:44 ` Jonathan Cameron
2021-11-09 12:31 ` [PATCH 2/4] iio:filter:admv8818: add support for ADMV8818 Antoniu Miclaus
2021-11-12 18:06 ` Jonathan Cameron
2021-11-09 12:31 ` [PATCH 3/4] dt-bindings:iio:filter: add admv8818 doc Antoniu Miclaus
2021-11-10 1:07 ` Rob Herring
2021-11-10 9:39 ` Miclaus, Antoniu
2021-11-12 17:46 ` Jonathan Cameron
2021-11-16 14:43 ` Miclaus, Antoniu
2021-11-21 12:24 ` Jonathan Cameron
2021-11-09 12:31 ` Antoniu Miclaus [this message]
2021-11-12 17:56 ` [PATCH 4/4] iio:filter:admv8818: Add sysfs ABI documentation Jonathan Cameron
2021-11-12 18:05 ` Jonathan Cameron
2021-11-16 14:43 ` Miclaus, Antoniu
2021-11-21 12:32 ` Jonathan Cameron
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=20211109123127.96399-5-antoniu.miclaus@analog.com \
--to=antoniu.miclaus@analog.com \
--cc=devicetree@vger.kernel.org \
--cc=jic23@kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=robh+dt@kernel.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;
as well as URLs for NNTP newsgroup(s).