2019-03-16 15:10:26

by Marcelo Schmitt

[permalink] [raw]
Subject: [PATCH v4 5/7] staging: iio: ad5933: add ABI documentation

Add an ABI documentation for the ad5933 driver.

Signed-off-by: Marcelo Schmitt <[email protected]>
---
.../sysfs-bus-iio-impedance-analyzer-ad5933 | 35 +++++++++++++++++++
.../sysfs-bus-iio-impedance-analyzer-ad5933 | 30 ----------------
2 files changed, 35 insertions(+), 30 deletions(-)
create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-impedance-analyzer-ad5933
delete mode 100644 drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-impedance-analyzer-ad5933 b/Documentation/ABI/testing/sysfs-bus-iio-impedance-analyzer-ad5933
new file mode 100644
index 000000000000..a50aada68e1e
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-impedance-analyzer-ad5933
@@ -0,0 +1,35 @@
+What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_start
+Date: March 2019
+KernelVersion: 3.1.0
+Contact: [email protected]
+Description:
+ Frequency sweep start frequency in Hz.
+
+What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_increment
+Date: March 2019
+KernelVersion: 3.1.0
+Contact: [email protected]
+Description:
+ Frequency increment in Hz (step size) between consecutive
+ frequency points along the sweep.
+
+What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_points
+Date: March 2019
+KernelVersion: 3.1.0
+Contact: [email protected]
+Description:
+ Number of frequency points (steps) in the frequency sweep.
+ This value, in conjunction with the
+ out_altvoltageY_frequency_start and the
+ out_altvoltageY_frequency_increment, determines the frequency
+ sweep range for the sweep operation.
+
+What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_settling_cycles
+Date: March 2019
+KernelVersion: 3.1.0
+Contact: [email protected]
+Description:
+ Number of output excitation cycles (settling time cycles)
+ that are allowed to pass through the unknown impedance,
+ after each frequency increment, and before the ADC is triggered
+ to perform a conversion sequence of the response signal.
diff --git a/drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933 b/drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933
deleted file mode 100644
index 79c7e88c64cd..000000000000
--- a/drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933
+++ /dev/null
@@ -1,30 +0,0 @@
-What: /sys/bus/iio/devices/iio:deviceX/outY_freq_start
-KernelVersion: 3.1.0
-Contact: [email protected]
-Description:
- Frequency sweep start frequency in Hz.
-
-What: /sys/bus/iio/devices/iio:deviceX/outY_freq_increment
-KernelVersion: 3.1.0
-Contact: [email protected]
-Description:
- Frequency increment in Hz (step size) between consecutive
- frequency points along the sweep.
-
-What: /sys/bus/iio/devices/iio:deviceX/outY_freq_points
-KernelVersion: 3.1.0
-Contact: [email protected]
-Description:
- Number of frequency points (steps) in the frequency sweep.
- This value, in conjunction with the outY_freq_start and the
- outY_freq_increment, determines the frequency sweep range
- for the sweep operation.
-
-What: /sys/bus/iio/devices/iio:deviceX/outY_settling_cycles
-KernelVersion: 3.1.0
-Contact: [email protected]
-Description:
- Number of output excitation cycles (settling time cycles)
- that are allowed to pass through the unknown impedance,
- after each frequency increment, and before the ADC is triggered
- to perform a conversion sequence of the response signal.
--
2.20.1



2019-03-16 18:42:49

by Jonathan Cameron

[permalink] [raw]
Subject: Re: [PATCH v4 5/7] staging: iio: ad5933: add ABI documentation

On Sat, 16 Mar 2019 12:07:32 -0300
Marcelo Schmitt <[email protected]> wrote:

> Add an ABI documentation for the ad5933 driver.
>
> Signed-off-by: Marcelo Schmitt <[email protected]>
Some stray whitespace in here. I cleaned it up.

Thanks,

Jonathan

> ---
> .../sysfs-bus-iio-impedance-analyzer-ad5933 | 35 +++++++++++++++++++
> .../sysfs-bus-iio-impedance-analyzer-ad5933 | 30 ----------------
> 2 files changed, 35 insertions(+), 30 deletions(-)
> create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-impedance-analyzer-ad5933
> delete mode 100644 drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-impedance-analyzer-ad5933 b/Documentation/ABI/testing/sysfs-bus-iio-impedance-analyzer-ad5933
> new file mode 100644
> index 000000000000..a50aada68e1e
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-impedance-analyzer-ad5933
> @@ -0,0 +1,35 @@
> +What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_start
> +Date: March 2019
> +KernelVersion: 3.1.0
> +Contact: [email protected]
> +Description:
> + Frequency sweep start frequency in Hz.
> +
> +What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_increment
> +Date: March 2019
> +KernelVersion: 3.1.0
> +Contact: [email protected]
> +Description:
> + Frequency increment in Hz (step size) between consecutive
> + frequency points along the sweep.
> +
> +What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_points
> +Date: March 2019
> +KernelVersion: 3.1.0
> +Contact: [email protected]
> +Description:
> + Number of frequency points (steps) in the frequency sweep.
> + This value, in conjunction with the
> + out_altvoltageY_frequency_start and the
> + out_altvoltageY_frequency_increment, determines the frequency
> + sweep range for the sweep operation.
> +
> +What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_settling_cycles
> +Date: March 2019
> +KernelVersion: 3.1.0
> +Contact: [email protected]
> +Description:
> + Number of output excitation cycles (settling time cycles)
> + that are allowed to pass through the unknown impedance,
> + after each frequency increment, and before the ADC is triggered
> + to perform a conversion sequence of the response signal.
> diff --git a/drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933 b/drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933
> deleted file mode 100644
> index 79c7e88c64cd..000000000000
> --- a/drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933
> +++ /dev/null
> @@ -1,30 +0,0 @@
> -What: /sys/bus/iio/devices/iio:deviceX/outY_freq_start
> -KernelVersion: 3.1.0
> -Contact: [email protected]
> -Description:
> - Frequency sweep start frequency in Hz.
> -
> -What: /sys/bus/iio/devices/iio:deviceX/outY_freq_increment
> -KernelVersion: 3.1.0
> -Contact: [email protected]
> -Description:
> - Frequency increment in Hz (step size) between consecutive
> - frequency points along the sweep.
> -
> -What: /sys/bus/iio/devices/iio:deviceX/outY_freq_points
> -KernelVersion: 3.1.0
> -Contact: [email protected]
> -Description:
> - Number of frequency points (steps) in the frequency sweep.
> - This value, in conjunction with the outY_freq_start and the
> - outY_freq_increment, determines the frequency sweep range
> - for the sweep operation.
> -
> -What: /sys/bus/iio/devices/iio:deviceX/outY_settling_cycles
> -KernelVersion: 3.1.0
> -Contact: [email protected]
> -Description:
> - Number of output excitation cycles (settling time cycles)
> - that are allowed to pass through the unknown impedance,
> - after each frequency increment, and before the ADC is triggered
> - to perform a conversion sequence of the response signal.