[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20241005183629.6a9cd4da@jic23-huawei>
Date: Sat, 5 Oct 2024 18:36:59 +0100
From: Jonathan Cameron <jic23@...nel.org>
To: Antoniu Miclaus <antoniu.miclaus@...log.com>
Cc: Lars-Peter Clausen <lars@...afoo.de>, Michael Hennerich
<Michael.Hennerich@...log.com>, Rob Herring <robh@...nel.org>, Krzysztof
Kozlowski <krzk+dt@...nel.org>, Conor Dooley <conor+dt@...nel.org>, Nuno Sa
<nuno.sa@...log.com>, Olivier Moysan <olivier.moysan@...s.st.com>, Uwe
Kleine-König <ukleinek@...nel.org>, Andy Shevchenko
<andy@...nel.org>, David Lechner <dlechner@...libre.com>, Marcelo Schmitt
<marcelo.schmitt@...log.com>, AngeloGioacchino Del Regno
<angelogioacchino.delregno@...labora.com>, "Mike Looijmans"
<mike.looijmans@...ic.nl>, Dumitru Ceclan <mitrutzceclan@...il.com>,
João Paulo Gonçalves
<joao.goncalves@...adex.com>, Alisa-Dariana Roman <alisadariana@...il.com>,
Sergiu Cuciurean <sergiu.cuciurean@...log.com>, Dragos Bogdan
<dragos.bogdan@...log.com>, <linux-iio@...r.kernel.org>,
<linux-kernel@...r.kernel.org>, <devicetree@...r.kernel.org>,
<linux-pwm@...r.kernel.org>
Subject: Re: [PATCH v2 7/7] Documentation: ABI: testing: ad485x: add ABI
docs
On Fri, 4 Oct 2024 17:07:56 +0300
Antoniu Miclaus <antoniu.miclaus@...log.com> wrote:
> Add documentation for the packet size.
>
> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@...log.com>
> ---
> changes in v2:
> - improve description for packet_format
> - add kernel version
> .../ABI/testing/sysfs-bus-iio-adc-ad485x | 16 ++++++++++++++++
> 1 file changed, 16 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..5d69a8d30383
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad485x
> @@ -0,0 +1,16 @@
> +What: /sys/bus/iio/devices/iio:deviceX/packet_format_available
> +KernelVersion: 6.13
> +Contact: linux-iio@...r.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: 6.13
> +Contact: linux-iio@...r.kernel.org
> +Description:
> + This attribute configures the frame size on conversion data
> + output bus. See packet_format_available for available sizes
> + based on the device used.
> + Reading returns the actual size used.
This needs to give some guidance to the user on 'why' they might pick a particular
format.
I'm also inclined to suggest that for now we pick a sensible default dependent
on the other options enabled (oversampling etc) and don't expose it to the user.
Eventually it looks like we may have to figure out a solution to describe
metadata packed alongside the channel readings but that may take a while
and I don't want to stall this driver on that discussion.
Thanks,
Jonathan
Powered by blists - more mailing lists