[v2,3/3] Documentation: ABI: testing: adf4377: add ABI docs

Message ID 20221107120243.57344-3-antoniu.miclaus@analog.com
State New
Headers
Series [v2,1/3] dt-bindings: iio: frequency: add adf4377 doc |

Commit Message

Antoniu Miclaus Nov. 7, 2022, 12:02 p.m. UTC
  Add documentation for the use of the output frequency and muxout select.

Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
---
changes in v2:
 - remove muxout selectdocumentation, since it is done in the devicetree now
 Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377 | 6 ++++++
 1 file changed, 6 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
  

Comments

Jonathan Cameron Nov. 13, 2022, 1 p.m. UTC | #1
On Mon, 7 Nov 2022 14:02:43 +0200
Antoniu Miclaus <antoniu.miclaus@analog.com> wrote:

> Add documentation for the use of the output frequency and muxout select.
> 
> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>

The docs system doesn't support more specific definitions of ABI for individual drivers
if there is already an entry in another doc.

Here we have the same entry in sysfs-bus-iio

We can add extra info to that top level description related to an individual part, but
I don't think that's necessary here.

So I suggest dropping this patch.

Thanks,

Jonathan

> ---
> changes in v2:
>  - remove muxout selectdocumentation, since it is done in the devicetree now
>  Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377 | 6 ++++++
>  1 file changed, 6 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377 b/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
> new file mode 100644
> index 000000000000..8888be49754c
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
> @@ -0,0 +1,6 @@
> +What:		/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency
> +KernelVersion:
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Stores the PLL frequency in Hz for output channels.
> +		Reading returns the frequency in Hz.
  

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377 b/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
new file mode 100644
index 000000000000..8888be49754c
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
@@ -0,0 +1,6 @@ 
+What:		/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency
+KernelVersion:
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Stores the PLL frequency in Hz for output channels.
+		Reading returns the frequency in Hz.