linux-kernel - [PATCH v3 5/7] staging: iio: ad5933: add 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-next>] [day] [month] [year] [list]

Message-ID: <20190310174640.dksy7pfkptrbcdgj@smtp.gmail.com>
Date:   Sun, 10 Mar 2019 14:46:40 -0300
From:   Marcelo Schmitt <marcelo.schmitt1@...il.com>
To:     lars@...afoo.de, Michael.Hennerich@...log.com, jic23@...nel.org,
        knaack.h@....de, pmeerw@...erw.net
Cc:     linux-iio@...r.kernel.org, linux-kernel@...r.kernel.org,
        kernel-usp@...glegroups.com
Subject: [PATCH v3 5/7] staging: iio: ad5933: add ABI documentation

Add an ABI documentation for the ad5933 driver.

Signed-off-by: Marcelo Schmitt <marcelo.schmitt1@...il.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@...r.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@...r.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@...r.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@...r.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