linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Marcelo Schmitt <marcelo.schmitt1@gmail.com>
To: lars@metafoo.de, Michael.Hennerich@analog.com, jic23@kernel.org,
	knaack.h@gmx.de, pmeerw@pmeerw.net
Cc: linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
	kernel-usp@googlegroups.com
Subject: [PATCH v3 5/7] staging: iio: ad5933: add ABI documentation
Date: Sun, 10 Mar 2019 14:46:40 -0300	[thread overview]
Message-ID: <20190310174640.dksy7pfkptrbcdgj@smtp.gmail.com> (raw)

Add an ABI documentation for the ad5933 driver.

Signed-off-by: Marcelo Schmitt <marcelo.schmitt1@gmail.com>
---
 .../ABI/testing/sysfs-bus-iio-ad5933          | 39 +++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-ad5933

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-ad5933 b/Documentation/ABI/testing/sysfs-bus-iio-ad5933
new file mode 100644
index 000000000000..8a60dd178b1f
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-ad5933
@@ -0,0 +1,39 @@
+What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_start
+Date:		March 2019
+KernelVersion:	Kernel 4.19
+Contact:	linux-iio@vger.kernel.org
+Description:
+		The start frequency. Set this to define the frequency point at
+		which the device should start the next frequency sweep.
+
+What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_increment
+Date:		March 2019
+KernelVersion:	Kernel 4.19
+Contact:	linux-iio@vger.kernel.org
+Description:
+		The frequency sweep increment. Set this to define the amount by
+		which the frequency is incremented after each scan point. After
+		the measurement at a frequency point is completed, the next
+		measurement will be made at a frequency point 
+		'frequency increment'Hz	higher than the previous one unless a
+		repeat frequency command is issued. This behavior will follow
+		until the defined number of frequency points have been measured
+		or frequency sweep is somewhat reset.
+
+What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_points
+Date:		March 2019
+KernelVersion:	Kernel 4.19
+Contact:	linux-iio@vger.kernel.org
+Description:
+		The number of increments. This defines the number of frequency
+		points in the frequency sweep.
+
+What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_settling_cycles
+Date:		March 2019
+KernelVersion:	Kernel 4.19
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Number of settling time cycles. This sets the delay between a
+		start frequency sweep/increment frequency /repeat frequency to
+		be proportional to the excitation signal frequency times the
+		number of settling time cycles.
-- 
2.20.1


             reply	other threads:[~2019-03-10 17:46 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-10 17:46 Marcelo Schmitt [this message]
2019-03-11  8:59 ` [PATCH v3 5/7] staging: iio: ad5933: add ABI documentation Alexandru Ardelean
2019-03-12 17:31   ` Marcelo Schmitt
2019-03-13  7:08     ` Alexandru Ardelean

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=20190310174640.dksy7pfkptrbcdgj@smtp.gmail.com \
    --to=marcelo.schmitt1@gmail.com \
    --cc=Michael.Hennerich@analog.com \
    --cc=jic23@kernel.org \
    --cc=kernel-usp@googlegroups.com \
    --cc=knaack.h@gmx.de \
    --cc=lars@metafoo.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pmeerw@pmeerw.net \
    /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).