Linux IIO development
 help / color / mirror / Atom feed
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 v5 3/3] Documentation:ABI:testing:admv1013: add ABI docs
Date: Tue, 23 Nov 2021 13:53:36 +0200	[thread overview]
Message-ID: <20211123115336.65827-3-antoniu.miclaus@analog.com> (raw)
In-Reply-To: <20211123115336.65827-1-antoniu.miclaus@analog.com>

Add documentation for the use of the Local Oscillator Feedthrough Offset
calibration.

Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
---
changes in v5:
 - rework the custom device attributes based on the feedback received in v4
 - add frequency translation modes custom attributes.
 .../testing/sysfs-bus-iio-frequency-admv1013  | 55 +++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-frequency-admv1013

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-frequency-admv1013 b/Documentation/ABI/testing/sysfs-bus-iio-frequency-admv1013
new file mode 100644
index 000000000000..3ff80909f007
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-frequency-admv1013
@@ -0,0 +1,55 @@
+What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0-1_phase_i
+KernelVersion:
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Read/write raw value for the Local Oscillatior path quadrature I phase shift.
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0-1_phase_q
+KernelVersion:
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Read/write raw value for the Local Oscillatior path quadrature Q phase shift.
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0_calibbias_i
+KernelVersion:
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Read/write raw value for the Local Oscillatior Feedthrough Offset Calibration I Positive
+		side.
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0_calibbias_q
+KernelVersion:
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Read/write raw value for the Local Oscillatior Feedthrough Offset Calibration Q Positive
+		side.
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage1_calibbias_i
+KernelVersion:
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Read/write raw value for the Local Oscillatior Feedthrough Offset Calibration I Negative
+		side.
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage1_calibbias_q
+KernelVersion:
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Read/write raw value for the Local Oscillatior Feedthrough Offset Calibration Q Negative
+		side.
+
+What:		/sys/bus/iio/devices/iio:deviceX/freq_mode_available
+KernelVersion:
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Reading this returns the valid values that can be written to the freq_mode attribute.
+
+		- if -> Intermediate Frequency
+		- iq -> Quadrature I/Q mode.
+
+What:		/sys/bus/iio/devices/iio:deviceX/freq_mode
+KernelVersion:
+Contact:	linux-iio@vger.kernel.org
+Description:
+		This attribute configures the frequency mode.
+		Reading returns the actual mode.
-- 
2.34.0


  parent reply	other threads:[~2021-11-23 11:54 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-23 11:53 [PATCH v5 1/3] iio: frequency: admv1013: add support for ADMV1013 Antoniu Miclaus
2021-11-23 11:53 ` [PATCH v5 2/3] dt-bindings: iio: frequency: add admv1013 doc Antoniu Miclaus
2021-11-27 17:18   ` Jonathan Cameron
2021-11-23 11:53 ` Antoniu Miclaus [this message]
2021-11-27 17:13   ` [PATCH v5 3/3] Documentation:ABI:testing:admv1013: add ABI docs Jonathan Cameron
2021-11-27 17:28 ` [PATCH v5 1/3] iio: frequency: admv1013: add support for ADMV1013 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=20211123115336.65827-3-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