[PATCH 01/35] iio: core: add default_trigger and take reference in iio_device_register()
From: Jonathan Cameron
Date: Sun Nov 15 2026 - 20:49:05 EST
From: Jonathan Cameron <jonathan.cameron@xxxxxxxxxxxxxxxx>
Some drivers choose to set a default trigger in probe() via
indio_dev->trig = iio_trigger_get(trig). The matching iio_trigger_put()
is in iio_device_unregister_trigger_consumer(), called from
iio_dev_release() only if indio_dev->modes includes one of the triggered
modes. If probe() fails after the reference is taken but before
INDIO_BUFFER_TRIGGERED is set (e.g. by iio_triggered_buffer_setup()),
the reference is leaked. In devm managed flows there is no simple way
for the driver to drop the reference on error. Whilst it is possible
to have enforce strict registration order so that the reference is
only taken once conditions for tear down are met, the requirements are
not intuitive. So move the point of reference acquire later in sequence
to a point where cleanup will always happen.
Add struct iio_dev::default_trigger. Drivers then set this without taking
a reference. The reference is instead taken in
iio_device_register_trigger_consumer(), which pairs with the existing put
under the same modes check, so they always balance.
Also check the return value of iio_device_register_trigger_consumer(),
add an error_unreg_trigger_consumer unwind path for failures that occur
later in registration, and clear indio_dev->trig after the put so the
subsequent call from iio_dev_release() does not drop it again.
Immutable triggers are a little more complex and left for a follow
on patch.
Signed-off-by: Jonathan Cameron <jonathan.cameron@xxxxxxxxxxxxxxxx>
---
drivers/iio/industrialio-core.c | 15 ++++++++++++---
drivers/iio/industrialio-trigger.c | 21 ++++++++++++++++++---
include/linux/iio/iio.h | 4 ++++
3 files changed, 34 insertions(+), 6 deletions(-)
diff --git a/drivers/iio/industrialio-core.c b/drivers/iio/industrialio-core.c
index ed7aa7fd9391..6c704920d619 100644
--- a/drivers/iio/industrialio-core.c
+++ b/drivers/iio/industrialio-core.c
@@ -2180,8 +2180,14 @@ int __iio_device_register(struct iio_dev *indio_dev, struct module *this_mod)
"Failed to register event set\n");
goto error_free_sysfs;
}
- if (indio_dev->modes & INDIO_ALL_TRIGGERED_MODES)
- iio_device_register_trigger_consumer(indio_dev);
+ if (indio_dev->modes & INDIO_ALL_TRIGGERED_MODES) {
+ ret = iio_device_register_trigger_consumer(indio_dev);
+ if (ret) {
+ dev_err(indio_dev->dev.parent,
+ "Failed to register trigger consumer\n");
+ goto error_unreg_eventset;
+ }
+ }
if ((indio_dev->modes & INDIO_ALL_BUFFER_MODES) &&
indio_dev->setup_ops == NULL)
@@ -2202,10 +2208,13 @@ int __iio_device_register(struct iio_dev *indio_dev, struct module *this_mod)
ret = cdev_device_add(&iio_dev_opaque->chrdev, &indio_dev->dev);
if (ret < 0)
- goto error_unreg_eventset;
+ goto error_unreg_trigger_consumer;
return 0;
+error_unreg_trigger_consumer:
+ if (indio_dev->modes & INDIO_ALL_TRIGGERED_MODES)
+ iio_device_unregister_trigger_consumer(indio_dev);
error_unreg_eventset:
iio_device_unregister_eventset(indio_dev);
error_free_sysfs:
diff --git a/drivers/iio/industrialio-trigger.c b/drivers/iio/industrialio-trigger.c
index 76926fee0f84..a0149a5d0163 100644
--- a/drivers/iio/industrialio-trigger.c
+++ b/drivers/iio/industrialio-trigger.c
@@ -760,15 +760,30 @@ EXPORT_SYMBOL(iio_trigger_validate_own_device);
int iio_device_register_trigger_consumer(struct iio_dev *indio_dev)
{
- return iio_device_register_sysfs_group(indio_dev,
- &iio_trigger_consumer_attr_group);
+ int ret;
+
+ /* Drivers must not both set a default trigger and take a reference */
+ if (indio_dev->default_trigger && WARN_ON(indio_dev->trig))
+ return -EINVAL;
+
+ ret = iio_device_register_sysfs_group(indio_dev,
+ &iio_trigger_consumer_attr_group);
+ if (ret)
+ return ret;
+
+ if (indio_dev->default_trigger)
+ indio_dev->trig = iio_trigger_get(indio_dev->default_trigger);
+
+ return 0;
}
void iio_device_unregister_trigger_consumer(struct iio_dev *indio_dev)
{
/* Clean up an associated but not attached trigger reference */
- if (indio_dev->trig)
+ if (indio_dev->trig) {
iio_trigger_put(indio_dev->trig);
+ indio_dev->trig = NULL;
+ }
}
int iio_device_suspend_triggering(struct iio_dev *indio_dev)
diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
index 67718f3b9b7d..8b3fd7673293 100644
--- a/include/linux/iio/iio.h
+++ b/include/linux/iio/iio.h
@@ -632,6 +632,9 @@ struct iio_buffer_setup_ops {
* @active_scan_mask: [INTERN] union of all scan masks requested by buffers
* @scan_timestamp: [INTERN] set if any buffers have requested timestamp
* @trig: [INTERN] current device trigger (buffer modes)
+ * @default_trigger: [DRIVER] optional trigger to use by default. The driver
+ * does not hold a reference to it; the IIO core takes
+ * one in iio_device_register().
* @pollfunc: [DRIVER] function run on trigger being received
* @pollfunc_event: [DRIVER] function run on events trigger being received
* @channels: [DRIVER] channel specification structure table
@@ -657,6 +660,7 @@ struct iio_dev {
const unsigned long *active_scan_mask;
bool __private scan_timestamp;
struct iio_trigger *trig;
+ struct iio_trigger *default_trigger;
struct iio_poll_func *pollfunc;
struct iio_poll_func *pollfunc_event;
--
2.56.1