From: David Lechner <dlechner@baylibre.com>
To: Kurt Borja <kuurtb@gmail.com>,
Andy Shevchenko <andriy.shevchenko@intel.com>,
Lars-Peter Clausen <lars@metafoo.de>,
Michael Hennerich <Michael.Hennerich@analog.com>,
Jonathan Cameron <jic23@kernel.org>,
Benson Leung <bleung@chromium.org>,
Antoniu Miclaus <antoniu.miclaus@analog.com>,
Gwendal Grignou <gwendal@chromium.org>,
Shrikant Raskar <raskar.shree97@gmail.com>,
Per-Daniel Olsson <perdaniel.olsson@axis.com>
Cc: "Nuno Sá" <nuno.sa@analog.com>,
"Andy Shevchenko" <andy@kernel.org>,
"Guenter Roeck" <groeck@chromium.org>,
"Jonathan Cameron" <Jonathan.Cameron@huawei.com>,
linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
chrome-platform@lists.linux.dev
Subject: Re: [PATCH v4 4/7] iio: core: Add cleanup.h support for iio_device_claim_*()
Date: Sun, 18 Jan 2026 13:35:37 -0600 [thread overview]
Message-ID: <fef660dc-8c81-420c-95b6-cc8649971894@baylibre.com> (raw)
In-Reply-To: <20260118-lock-impr-v4-4-6c8d0aee8ed2@gmail.com>
On 1/18/26 9:44 AM, Kurt Borja wrote:
> Add guard classes for iio_device_claim_*() conditional locks. This will
> aid drivers write safer and cleaner code when dealing with some common
> patterns.
>
> These classes are not meant to be used directly by drivers (hence the
> __priv__ prefix). Instead, documented wrapper macros are provided to
> enforce the use of ACQUIRE() or guard() semantics and avoid the
> problematic scoped guard.
>
> Suggested-by: Andy Shevchenko <andriy.shevchenko@intel.com>
> Reviewed-by: David Lechner <dlechner@baylibre.com>
> Reviewed-by: Nuno Sá <nuno.sa@analog.com>
> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
> ---
> include/linux/iio/iio.h | 65 +++++++++++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 65 insertions(+)
>
> diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
> index fa671e120e95..4a0a77fcfa8d 100644
> --- a/include/linux/iio/iio.h
> +++ b/include/linux/iio/iio.h
> @@ -10,6 +10,7 @@
> #include <linux/align.h>
> #include <linux/device.h>
> #include <linux/cdev.h>
> +#include <linux/cleanup.h>
> #include <linux/compiler_types.h>
> #include <linux/minmax.h>
> #include <linux/slab.h>
> @@ -740,6 +741,70 @@ static inline bool iio_device_try_claim_buffer_mode(struct iio_dev *indio_dev)
> */
> #define iio_device_release_buffer_mode(indio_dev) __iio_dev_mode_unlock(indio_dev)
>
> +/*
> + * These classes are not meant to be used directly by drivers (hence the
> + * __priv__ prefix). Instead, documented wrapper macros are provided below to
> + * enforce the use of ACQUIRE() or guard() semantics and avoid the problematic
> + * scoped guard variants.
> + */
> +DEFINE_GUARD(__priv__iio_dev_mode_lock, struct iio_dev *,
> + __iio_dev_mode_lock(_T), __iio_dev_mode_unlock(_T));
> +DEFINE_GUARD_COND(__priv__iio_dev_mode_lock, _try_direct,
> + iio_device_claim_direct(_T));
> +
> +/**
> + * IIO_DEV_ACQUIRE_DIRECT_MODE(dev, var) - Tries to acquire the direct mode
> + * lock with automatic release
Should be just IIO_DEV_ACQUIRE_DIRECT_MODE()
> + * @dev: IIO device instance
> + * @claim: Variable identifier to store acquire result
> + *
> + * Tries to acquire the direct mode lock with cleanup ACQUIRE() semantics and
> + * automatically releases it at the end of the scope. It most be always paired
> + * with IIO_DEV_ACQUIRE_ERR(), for example (notice the scope braces)::
> + *
> + * switch() {
> + * case IIO_CHAN_INFO_RAW: {
> + * IIO_DEV_ACQUIRE_DIRECT_MODE(indio_dev, claim);
> + * if (IIO_DEV_ACQUIRE_FAILED(claim))
> + * return -EBUSY;
> + *
> + * ...
> + * }
> + * case IIO_CHAN_INFO_SCALE:
> + * ...
> + * ...
> + * }
> + *
> + * Context: Can sleep
> + */
> +#define IIO_DEV_ACQUIRE_DIRECT_MODE(dev, claim) \
> + ACQUIRE(__priv__iio_dev_mode_lock_try_direct, claim)(dev)
> +
> +/**
> + * IIO_DEV_ACQUIRE_FAILED() - ACQUIRE_ERR() wrapper
This one is correct style.
> + * @claim: The claim variable passed to IIO_DEV_ACQUIRE_*_MODE()
> + *
> + * Return: true if failed to acquire the mode, otherwise false.
> + */
> +#define IIO_DEV_ACQUIRE_FAILED(claim) \
> + ACQUIRE_ERR(__priv__iio_dev_mode_lock_try_direct, &(claim))
> +
> +/**
> + * IIO_DEV_GUARD_CURRENT_MODE - Acquires the mode lock with automatic release
Missing ()
> + * @dev: IIO device instance
> + *
> + * Acquires the mode lock with cleanup guard() semantics. It is usually paired
> + * with iio_buffer_enabled().
> + *
> + * This should *not* be used to protect internal driver state and it's use in
> + * general is *strongly* discouraged. Use any of the IIO_DEV_ACQUIRE_*_MODE()
> + * variants.
> + *
> + * Context: Can sleep
> + */
> +#define IIO_DEV_GUARD_CURRENT_MODE(dev) \
> + guard(__priv__iio_dev_mode_lock)(dev)
> +
> extern const struct bus_type iio_bus_type;
>
> /**
>
next prev parent reply other threads:[~2026-01-18 19:35 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-18 15:44 [PATCH v4 0/7] iio: core: Introduce cleanup.h support for mode locks Kurt Borja
2026-01-18 15:44 ` [PATCH v4 1/7] iio: core: Add and export __iio_dev_mode_lock() Kurt Borja
2026-01-18 15:44 ` [PATCH v4 2/7] iio: core: Refactor iio_device_claim_direct() implementation Kurt Borja
2026-01-18 15:44 ` [PATCH v4 3/7] iio: core: Match iio_device_claim_*() semantics and implementation Kurt Borja
2026-01-18 15:44 ` [PATCH v4 4/7] iio: core: Add cleanup.h support for iio_device_claim_*() Kurt Borja
2026-01-18 19:35 ` David Lechner [this message]
2026-01-19 19:30 ` Kurt Borja
2026-01-19 8:15 ` Andy Shevchenko
2026-01-19 19:31 ` Kurt Borja
2026-01-18 15:44 ` [PATCH v4 5/7] iio: light: vcnl4000: Use IIO cleanup helpers Kurt Borja
2026-01-18 15:44 ` [PATCH v4 6/7] iio: health: max30102: " Kurt Borja
2026-01-18 15:44 ` [PATCH v4 7/7] iio: light: opt4060: " Kurt Borja
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=fef660dc-8c81-420c-95b6-cc8649971894@baylibre.com \
--to=dlechner@baylibre.com \
--cc=Jonathan.Cameron@huawei.com \
--cc=Michael.Hennerich@analog.com \
--cc=andriy.shevchenko@intel.com \
--cc=andy@kernel.org \
--cc=antoniu.miclaus@analog.com \
--cc=bleung@chromium.org \
--cc=chrome-platform@lists.linux.dev \
--cc=groeck@chromium.org \
--cc=gwendal@chromium.org \
--cc=jic23@kernel.org \
--cc=kuurtb@gmail.com \
--cc=lars@metafoo.de \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=nuno.sa@analog.com \
--cc=perdaniel.olsson@axis.com \
--cc=raskar.shree97@gmail.com \
/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
all inboxes | Powered by JetHome®