Skip to contentSkip to conversation

staging: iio: ad5933: add ABI documentation

PATCH Superseded Marcelo Schmitt 2 participants 4 messages Mar 10, 2019 – Mar 13, 2019 IIO

v3 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 5/7 staging: iio: ad5933: add ABI documentation

Add an ABI documentation for the ad5933 driver.

---
 .../ABI/testing/sysfs-bus-iio-ad5933          | 39 +++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-ad5933
Documentation/ABI/testing/sysfs-bus-iio-ad5933 new file +39 -0
new file mode 100644
index 000000000000..8a60dd178b1f
@@ -0,0 +1,39 @@
+What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_start
+Date:		March 2019
+KernelVersion:	Kernel 4.19
+Contact:	[email protected]
+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:	[email protected]
+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:	[email protected]
+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:	[email protected]
+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.
Signature · 1 line
2.20.1
#1 lore raw
Quoted 2 lines · Marcelo Schmitt

Add an ABI documentation for the ad5933 driver.

There's already an ABI documentation for this driver. See:
https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git/tree/drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933

Apologies for not mentioning this sooner.

Could you check for other references for ad5933 in the kernel (in staging) ? I don't think I missed other stuff, but it's good to check.

Quoted 55 lines
---
 .../ABI/testing/sysfs-bus-iio-ad5933          | 39 +++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-ad5933
Documentation/ABI/testing/sysfs-bus-iio-ad5933 new file +39 -1
new file mode 100644
index 000000000000..8a60dd178b1f
@@ -0,0 +1,39 @@
+What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_start
+Date:          March 2019
+KernelVersion: Kernel 4.19
+Contact:       [email protected]
+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:       [email protected]
+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:       [email protected]
+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:       [email protected]
+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

#2 lore raw
Quoted 5 lines · Alexandru Ardelean
Quoted 2 lines · Marcelo Schmitt

Add an ABI documentation for the ad5933 driver.

Quoted 9 lines

There's already an ABI documentation for this driver. See:
https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git/tree/drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933

Apologies for not mentioning this sooner.

Could you check for other references for ad5933 in the kernel (in staging) ? I don't think I missed other stuff, but it's good to check.

Didn't see any other reference for ad5933 with find and grep inside iio, neither on general documentation. I'll replace mine ABI doc by yours and add your sign-off-by on my next patch set. OK?

Quoted 55 lines
Quoted 55 lines
---
 .../ABI/testing/sysfs-bus-iio-ad5933          | 39 +++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-ad5933
Documentation/ABI/testing/sysfs-bus-iio-ad5933 new file +39 -1
new file mode 100644
index 000000000000..8a60dd178b1f
@@ -0,0 +1,39 @@
+What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_start
+Date:          March 2019
+KernelVersion: Kernel 4.19
+Contact:       [email protected]
+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:       [email protected]
+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:       [email protected]
+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:       [email protected]
+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

#3 lore raw
Quoted 13 lines · Marcelo Schmitt
Quoted 11 lines · Alexandru Ardelean
Quoted 2 lines · Marcelo Schmitt

Add an ABI documentation for the ad5933 driver.

There's already an ABI documentation for this driver. See:
https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git/tree/drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933

Apologies for not mentioning this sooner.

Quoted 7 lines
Quoted 3 lines

Could you check for other references for ad5933 in the kernel (in staging) ? I don't think I missed other stuff, but it's good to check.

Didn't see any other reference for ad5933 with find and grep inside iio, neither on general documentation. I'll replace mine ABI doc by yours and add your sign-off-by on my next patch set. OK?

You don't need to add me anywhere :)
I did not contribute anything to that ABI doc.
I just raised a note about it.

But, that doc should be taken care of; whether you update it, remove it, or anything.
It's good to not forget it in staging.

Quoted 56 lines
Quoted 56 lines
Quoted 56 lines
---
 .../ABI/testing/sysfs-bus-iio-ad5933          | 39 +++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-ad5933
Documentation/ABI/testing/sysfs-bus-iio-ad5933 new file +39 -1
new file mode 100644
index 000000000000..8a60dd178b1f
@@ -0,0 +1,39 @@
+What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_start
+Date:          March 2019
+KernelVersion: Kernel 4.19
+Contact:       [email protected]
+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:       [email protected]
+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:       [email protected]
+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:       [email protected]
+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