Skip to contentSkip to conversation

docs: abi: document the debugfs interface for ad9467

PATCH In review Nuno Sa 2 participants 4 messages Aug 6, 2024

Subsystems (2)
lore
Share & tools
lore

Nuno Sa

author maintainer
#0 lore raw

cover docs: abi: document the debugfs interface for ad9467

Hi Jonathan,

Here it goes the follow up for the ad9467 debugfs interface. While at it, I realized there was no entry in MAINTAINERS for this driver so the first patch is about that.

---
Nuno Sa (2):
MAINTAINERS: add entry for ad9467
ABI: debugfs-iio-ad9467: document the debugfs interface

 Documentation/ABI/testing/debugfs-iio-ad9467 | 39 ++++++++++++++++++++++++++++
 MAINTAINERS                                  | 10 +++++++
 2 files changed, 49 insertions(+)

---
base-commit: 593737c18ae789dc6e4b493510a0c00977972e2e
change-id: 20240806-dev-ad-debugfs-doc-90d6b64d01b8 --

Thanks!
- Nuno Sá

author maintainer
#1 lore raw

PATCH 1/2 MAINTAINERS: add entry for ad9467

Document the maintainers for the IIO ad9467 high speed ADC.

---
 MAINTAINERS | 9 +++++++++
 1 file changed, 9 insertions(+)
MAINTAINERS +9 -0
index 2708a9e9fc95..ff62a4c2ce9e 100644
@@ -1310,6 +1310,15 @@ W:	https://ez.analog.com/linux-software-drivers
 F:	Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
 F:	drivers/iio/adc/ad7780.c
 
+ANALOG DEVICES INC AD9467 DRIVER
+M:	Michael Hennerich <[email protected]>
+M:	Nuno Sa <[email protected]>
+L:	[email protected]
+S:	Supported
+W:	https://ez.analog.com/linux-software-drivers
+F:	Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml
+F:	drivers/iio/adc/ad9467.c
+
 ANALOG DEVICES INC AD9739a DRIVER
 M:	Nuno Sa <[email protected]>
 M:	Dragos Bogdan <[email protected]>
Signature · 1 line
2.45.2
author maintainer
#2 lore raw

PATCH 2/2 ABI: debugfs-iio-ad9467: document the debugfs interface

In reply to Nuno Sa

Document the debugfs interface for the IIO ad9467 high speed ADC.

---
 Documentation/ABI/testing/debugfs-iio-ad9467 | 39 ++++++++++++++++++++++++++++
 MAINTAINERS                                  |  1 +
 2 files changed, 40 insertions(+)
Documentation/ABI/testing/debugfs-iio-ad9467 new file +39 -0
new file mode 100644
index 000000000000..0352fca1f7f2
@@ -0,0 +1,39 @@
+What:		/sys/kernel/debug/iio/iio:deviceX/calibration_table_dump
+KernelVersion:	6.11
+Contact:	[email protected]
+Description:
+		This dumps the calibration table that was filled during the
+		digital interface tuning process.
+
+What:		/sys/kernel/debug/iio/iio:deviceX/in_voltage_test_mode_available
+KernelVersion:	6.11
+Contact:	[email protected]
+Description:
+		List all the available test tones:
+		- off
+		- midscale_short
+		- pos_fullscale
+		- neg_fullscale
+		- checkerboard
+		- prbs23
+		- prbs9
+		- one_zero_toggle
+		- user
+		- bit_toggle
+		- sync
+		- one_bit_high
+		- mixed_bit_frequency
+		- ramp
+
+		Note that depending on the actual device being used, some of the
+		above might not be available (and they won't be listed when
+		reading the file).
+
+What:		/sys/kernel/debug/iio/iio:deviceX/in_voltageY_test_mode
+KernelVersion:	6.11
+Contact:	[email protected]
+Description:
+		Writing to this file will initiate one of available test tone on
+		channel Y. Reading it, shows which test is running. In cases
+		where an IIO backend is available and supports the test tone,
+		additional information about the data correctness is given.
MAINTAINERS +1 -0
index ff62a4c2ce9e..417c6751c0dc 100644
@@ -1316,6 +1316,7 @@ M:	Nuno Sa <[email protected]>
 L:	[email protected]
 S:	Supported
 W:	https://ez.analog.com/linux-software-drivers
+F:	Documentation/ABI/testing/debugfs-iio-ad9467
 F:	Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml
 F:	drivers/iio/adc/ad9467.c
 
Signature · 1 line
2.45.2
maintainer
#3 lore raw
In reply to Nuno Sa
Quoted 6 lines · On Tue, 06 Aug 2024 15:10:38 +0200 Nuno Sa via B4 Relay…

Hi Jonathan,

Here it goes the follow up for the ad9467 debugfs interface. While at it, I realized there was no entry in MAINTAINERS for this driver so the first patch is about that.

LGTM.

Applied to the togreg branch of iio.git and pushed out as testing. If anyone else has comments or wants to give tags, then there is still time.

Thanks,

Jonathan

Quoted 18 lines

---
Nuno Sa (2):
MAINTAINERS: add entry for ad9467
ABI: debugfs-iio-ad9467: document the debugfs interface

 Documentation/ABI/testing/debugfs-iio-ad9467 | 39 ++++++++++++++++++++++++++++
 MAINTAINERS                                  | 10 +++++++
 2 files changed, 49 insertions(+)

---
base-commit: 593737c18ae789dc6e4b493510a0c00977972e2e
change-id: 20240806-dev-ad-debugfs-doc-90d6b64d01b8 --

Thanks!
- Nuno Sá