From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 0C7011547FF; Sat, 5 Oct 2024 17:37:42 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1728149863; cv=none; b=pzpm8+chXBSKkxc627+DtUTWsdeKpEoXnC4j+D5zTc5V+vS84YffI4UE1B/Jh6jzDtSBCS+1H9a+QgYTGiUem787pPmmx/jSmxrBYEwvrMXvcplz5+KQdCDywa+Iy3sSrVZeExTRss6xWYl8i4T1ih/OixEa+v7OjDng+IP9I8Q= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1728149863; c=relaxed/simple; bh=vjiiFuJu6wOFYX0q5xESLaDhHDPwUR8bj4MRO3SmJ9U=; h=Date:From:To:Cc:Subject:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=r9FGQeQXqJaUjRWiREuTZ7nESFFmV2v3czrN1XppkvbuEoSQGW/ZJh7L2sNhRW4aVLCUxl36xzKUr96GJIhAiBnSQzp9pUst+B2G+er0VUIob1mN52GGqcObNPCfmYoVnVUqhhtEbIpaPsGIjsvn/L3NvYu81fw6iV/qz48aNsQ= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=FA4Chn6s; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="FA4Chn6s" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 77A17C4CEC2; Sat, 5 Oct 2024 17:37:12 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1728149862; bh=vjiiFuJu6wOFYX0q5xESLaDhHDPwUR8bj4MRO3SmJ9U=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=FA4Chn6s+XGCtBb9qPaJxNo8pi7AhYc43uWXEJTGFWAVdKUXKo8PWdnxulu2Y6Xi1 0eozqzR8SVaW3SbBERfusJu/HSncS0OwPhEMrDsPNSsxgcJ0bgzA0x940itkdchPjL 93macIIsGQqC9E2HJPTrCzJ4T+CLlLoztTKDkyNYZdWoN6l5t7QNsgXN4YZnfM+1D7 huat2SpRJDWuLLKmHGAii2qiuA12dmzqRvE2crHxwBNpOarpmQ9RAjZ7YTLs6VVHFw cXi9tYRZ/RpWcVZb1lnubnqb28zcRX5bS8nZAXGVSQTFDva33podlBzOy3CFRk8cfo VzPqakJCEk+jQ== Date: Sat, 5 Oct 2024 18:36:59 +0100 From: Jonathan Cameron To: Antoniu Miclaus Cc: Lars-Peter Clausen , Michael Hennerich , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Nuno Sa , Olivier Moysan , Uwe =?UTF-8?B?S2xlaW5lLUvDtm5pZw==?= , Andy Shevchenko , David Lechner , Marcelo Schmitt , AngeloGioacchino Del Regno , "Mike Looijmans" , Dumitru Ceclan , =?UTF-8?B?Sm/Do28=?= Paulo =?UTF-8?B?R29uw6dhbHZlcw==?= , Alisa-Dariana Roman , Sergiu Cuciurean , Dragos Bogdan , , , , Subject: Re: [PATCH v2 7/7] Documentation: ABI: testing: ad485x: add ABI docs Message-ID: <20241005183629.6a9cd4da@jic23-huawei> In-Reply-To: <20241004140922.233939-7-antoniu.miclaus@analog.com> References: <20241004140922.233939-1-antoniu.miclaus@analog.com> <20241004140922.233939-7-antoniu.miclaus@analog.com> X-Mailer: Claws Mail 4.3.0 (GTK 3.24.43; x86_64-pc-linux-gnu) Precedence: bulk X-Mailing-List: devicetree@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit On Fri, 4 Oct 2024 17:07:56 +0300 Antoniu Miclaus wrote: > Add documentation for the packet size. > > Signed-off-by: Antoniu Miclaus > --- > 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@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: 6.13 > +Contact: linux-iio@vger.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