Linux IIO development
 help / color / mirror / Atom feed
From: Matteo Martelli <matteomartelli3@gmail.com>
To: Jonathan Cameron <jic23@kernel.org>,
	 Lars-Peter Clausen <lars@metafoo.de>
Cc: linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
	 Matteo Martelli <matteomartelli3@gmail.com>
Subject: [PATCH] iio: core: add docs for read_avail_release_resource callback
Date: Tue, 29 Oct 2024 17:11:54 +0100	[thread overview]
Message-ID: <20241029-iio-read-avail-release-docs-v1-1-36919fbd1869@gmail.com> (raw)

The read_avail_release_resource function was introduced in
commit 8a63e3033e72 ("iio: core: add read_avail_release_resource
callback to fix race") without its description. Add it now.

Signed-off-by: Matteo Martelli <matteomartelli3@gmail.com>
---
Link: https://lore.kernel.org/lkml/20241029155022.5f777572@canb.auug.org.au/
---
 include/linux/iio/iio.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
index 747e89975d369f3c76aa49a96a7dc09f185e2557..3e5c1c3d8f7165f3185ae7893d922e42e930853f 100644
--- a/include/linux/iio/iio.h
+++ b/include/linux/iio/iio.h
@@ -434,6 +434,10 @@ struct iio_trigger; /* forward declaration */
  *			type and the number of vals is returned in length. For
  *			ranges, there are always three vals returned; min, step
  *			and max. For lists, all possible values are enumerated.
+ * @read_avail_release_resource: function to release the available values
+ *			potentially allocated during a read_avail() call. Input
+ *			arguments should match those provided in the
+ *			corresponding read_avail() call.
  * @write_raw:		function to write a value to the device.
  *			Parameters are the same as for read_raw.
  * @read_label:		function to request label name for a specified label,

---
base-commit: 9b4071ab8cbe28bd1bc4c533ab944771731fe5f8
change-id: 20241029-iio-read-avail-release-docs-a2b681e77794

Best regards,
-- 
Matteo Martelli <matteomartelli3@gmail.com>


             reply	other threads:[~2024-10-29 16:11 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-29 16:11 Matteo Martelli [this message]
2024-10-29 21:03 ` [PATCH] iio: core: add docs for read_avail_release_resource callback Jonathan Cameron

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241029-iio-read-avail-release-docs-v1-1-36919fbd1869@gmail.com \
    --to=matteomartelli3@gmail.com \
    --cc=jic23@kernel.org \
    --cc=lars@metafoo.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox