Linux IIO development
 help / color / mirror / Atom feed
From: Antoniu Miclaus <antoniu.miclaus@analog.com>
To: <jic23@kernel.org>, <robh@kernel.org>, <conor+dt@kernel.org>,
	<linux-iio@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
	<devicetree@vger.kernel.org>
Cc: Antoniu Miclaus <antoniu.miclaus@analog.com>
Subject: [PATCH v3 3/3] Documentation: ABI: adl8113: add documentation
Date: Fri, 14 Nov 2025 11:57:25 +0000	[thread overview]
Message-ID: <20251114115725.5660-4-antoniu.miclaus@analog.com> (raw)
In-Reply-To: <20251114115725.5660-1-antoniu.miclaus@analog.com>

Add ABI documentation for the ADL8113 Low Noise Amplifier,
covering the 4 pin-selectable operating modes.

Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
---

Changes in v3:
- Replace "mode" attribute documentation with "signal_path" attribute
- Update descriptions to reflect separation of gain control (hardwaregain) and path control (signal_path)
- Add explanation of automatic bypass mode switching when selecting external paths
- Update attribute names from mode/mode_available to signal_path/signal_path_available
- Clarify that external paths enable connection of external components for filtering or amplification
---
 .../testing/sysfs-bus-iio-amplifiers-adl8113  | 30 +++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-amplifiers-adl8113

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-amplifiers-adl8113 b/Documentation/ABI/testing/sysfs-bus-iio-amplifiers-adl8113
new file mode 100644
index 000000000000..31fb1e6e80fc
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-amplifiers-adl8113
@@ -0,0 +1,30 @@
+What:		/sys/bus/iio/devices/iio:deviceX/signal_path
+Date:		January 2025
+KernelVersion:	6.14
+Contact:	linux-iio@vger.kernel.org
+Description:
+		This attribute controls the signal routing path for the ADL8113
+		Low Noise Amplifier. The supported signal paths are:
+
+		* internal - Signal passes through internal path. Can be used with
+		  either amplifier mode (14dB gain) or bypass mode (0dB gain).
+
+		* external_a - Signal routes from RFIN to OUT_A and from IN_A to RFOUT
+		  (VA=0, VB=1). External components can be connected for filtering or
+		  additional amplification. Automatically switches to bypass mode (0dB).
+
+		* external_b - Signal routes from RFIN to OUT_B and from IN_B to RFOUT
+		  (VA=1, VB=0). External components can be connected for filtering or
+		  additional amplification. Automatically switches to bypass mode (0dB).
+
+		Note: Selecting an external path automatically sets the hardware gain
+		to 0dB (bypass mode) since external paths require bypass operation.
+
+What:		/sys/bus/iio/devices/iio:deviceX/signal_path_available
+Date:		January 2025
+KernelVersion:	6.14
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Reading this attribute returns a space-separated list of all
+		available signal paths for the ADL8113 device. The available paths
+		may depend on the current gain mode (hardwaregain setting).
-- 
2.43.0


  parent reply	other threads:[~2025-11-14 11:59 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-14 11:57 [PATCH v3 0/3] iio: amplifiers: add support for ADL8113 Low Noise Amplifier Antoniu Miclaus
2025-11-14 11:57 ` [PATCH v3 1/3] dt-bindings: iio: amplifiers: add adl8113 Antoniu Miclaus
2025-11-17 19:22   ` Conor Dooley
2025-11-17 23:42   ` David Lechner
2025-11-14 11:57 ` [PATCH v3 2/3] iio: amplifiers: adl8113: add driver support Antoniu Miclaus
2025-11-16 15:38   ` Jonathan Cameron
2025-11-14 11:57 ` Antoniu Miclaus [this message]
2025-11-16 15:50   ` [PATCH v3 3/3] Documentation: ABI: adl8113: add documentation Jonathan Cameron
2025-11-17 23:59     ` David Lechner
2025-11-18  8:08       ` Nuno Sá
2025-11-19  9:09     ` Miclaus, Antoniu

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=20251114115725.5660-4-antoniu.miclaus@analog.com \
    --to=antoniu.miclaus@analog.com \
    --cc=conor+dt@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=jic23@kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=robh@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