linux-kernel - Documentation of iio_read_channel

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <DE3I8OHQQD0F.2VTQS2PET9MI0@fairphone.com>
Date: Sat, 08 Nov 2025 18:55:08 +0100
From: "Luca Weiss" <luca.weiss@...rphone.com>
To: "Jonathan Cameron" <jic23@...nel.org>, "David Lechner"
 <dlechner@...libre.com>, Nuno Sá <nuno.sa@...log.com>,
 "Andy Shevchenko" <andy@...nel.org>, <linux-iio@...r.kernel.org>,
 <linux-kernel@...r.kernel.org>
Subject: Documentation of iio_read_channel_processed return value

Hi all,

I've noticed that the docstring in include/linux/iio/consumer.h for
iio_read_channel_processed (and likely some other functions in there) is
wrong because it's saying "Returns an error code or 0." while often it's
returning e.g. IIO_VAL_INT. In some code paths it's actually returning 0
but it seems in standard cases it's not.

Could the docstring please be updated so this is clear to users of this
function? I don't understand IIO well enough to confidently propose
changes there myself.

Thanks and kind regards
Luca