[PATCH 7/7] Documentation: ABI: testing: ad485x: add ABI docs

Antoniu Miclaus posted 7 patches 2 months ago
There is a newer version of this series
[PATCH 7/7] Documentation: ABI: testing: ad485x: add ABI docs
Posted by Antoniu Miclaus 2 months ago
Add documentation for the packet size.

Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
---
 Documentation/ABI/testing/sysfs-bus-iio-adc-ad485x | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-ad485x

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad485x b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad485x
new file mode 100644
index 000000000000..80aaef4eb750
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad485x
@@ -0,0 +1,14 @@
+What:		/sys/bus/iio/devices/iio:deviceX/packet_format_available
+KernelVersion:
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Packet sizes on the CMOS or LVDS conversion data output bus.
+		Reading this returns the valid values that can be written to the
+		packet_format.
+
+What:		/sys/bus/iio/devices/iio:deviceX/packet_format
+KernelVersion:
+Contact:	linux-iio@vger.kernel.org
+Description:
+		This attribute configures the packet size.
+		Reading returns the actual size used.
-- 
2.46.0
Re: [PATCH 7/7] Documentation: ABI: testing: ad485x: add ABI docs
Posted by Jonathan Cameron 2 months ago
On Mon, 23 Sep 2024 13:10:24 +0300
Antoniu Miclaus <antoniu.miclaus@analog.com> wrote:

> Add documentation for the packet size.
> 
> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
> ---
>  Documentation/ABI/testing/sysfs-bus-iio-adc-ad485x | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-ad485x
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad485x b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad485x
> new file mode 100644
> index 000000000000..80aaef4eb750
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad485x
> @@ -0,0 +1,14 @@
> +What:		/sys/bus/iio/devices/iio:deviceX/packet_format_available
> +KernelVersion:
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Packet sizes on the CMOS or LVDS conversion data output bus.
> +		Reading this returns the valid values that can be written to the
> +		packet_format.
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/packet_format
> +KernelVersion:
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		This attribute configures the packet size.
> +		Reading returns the actual size used.
This was touched upon by David's review of the driver.
These docs tell us nothing useful unfortunately so a user would have
no idea how to set them...
Re: [PATCH 7/7] Documentation: ABI: testing: ad485x: add ABI docs
Posted by Andy Shevchenko 2 months ago
On Mon, Sep 23, 2024 at 01:10:24PM +0300, Antoniu Miclaus wrote:
> Add documentation for the packet size.

...

> +KernelVersion:

Hmm...
Can't you use https://hansen.beer/~dave/phb/ (for v6.13)?

> +KernelVersion:

-- 
With Best Regards,
Andy Shevchenko