iio: core: add docs for read_avail_release_resource callback

[PATCH] iio: core: add docs for read_avail_release_resource callback

Posted by Matteo Martelli 3 weeks, 5 days ago

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>

Re: [PATCH] iio: core: add docs for read_avail_release_resource callback

Posted by Jonathan Cameron 3 weeks, 5 days ago

On Tue, 29 Oct 2024 17:11:54 +0100
Matteo Martelli <matteomartelli3@gmail.com> wrote:

> 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>
Excellent thanks.  Squashed into the original commit and fresh tree pushed out.

> ---
> 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,