1 // SPDX-License-Identifier: GPL-2.0-only
2 /* The industrial I/O core, trigger handling functions
4 * Copyright (c) 2008 Jonathan Cameron
7 #include <linux/kernel.h>
10 #include <linux/device.h>
11 #include <linux/interrupt.h>
12 #include <linux/list.h>
13 #include <linux/slab.h>
15 #include <linux/iio/iio.h>
16 #include <linux/iio/iio-opaque.h>
17 #include <linux/iio/trigger.h>
19 #include "iio_core_trigger.h"
20 #include <linux/iio/trigger_consumer.h>
22 /* RFC - Question of approach
23 * Make the common case (single sensor single trigger)
24 * simple by starting trigger capture from when first sensors
27 * Complex simultaneous start requires use of 'hold' functionality
28 * of the trigger. (not implemented)
30 * Any other suggestions?
33 static DEFINE_IDA(iio_trigger_ida);
35 /* Single list of all available triggers */
36 static LIST_HEAD(iio_trigger_list);
37 static DEFINE_MUTEX(iio_trigger_list_lock);
40 * name_show() - retrieve useful identifying name
41 * @dev: device associated with the iio_trigger
42 * @attr: pointer to the device_attribute structure that is
44 * @buf: buffer to print the name into
46 * Return: a negative number on failure or the number of written
47 * characters on success.
49 static ssize_t name_show(struct device *dev, struct device_attribute *attr,
52 struct iio_trigger *trig = to_iio_trigger(dev);
54 return sysfs_emit(buf, "%s\n", trig->name);
57 static DEVICE_ATTR_RO(name);
59 static struct attribute *iio_trig_dev_attrs[] = {
63 ATTRIBUTE_GROUPS(iio_trig_dev);
65 static struct iio_trigger *__iio_trigger_find_by_name(const char *name);
67 int iio_trigger_register(struct iio_trigger *trig_info)
71 trig_info->id = ida_alloc(&iio_trigger_ida, GFP_KERNEL);
72 if (trig_info->id < 0)
75 /* Set the name used for the sysfs directory etc */
76 dev_set_name(&trig_info->dev, "trigger%d", trig_info->id);
78 ret = device_add(&trig_info->dev);
80 goto error_unregister_id;
82 /* Add to list of available triggers held by the IIO core */
83 mutex_lock(&iio_trigger_list_lock);
84 if (__iio_trigger_find_by_name(trig_info->name)) {
85 pr_err("Duplicate trigger name '%s'\n", trig_info->name);
87 goto error_device_del;
89 list_add_tail(&trig_info->list, &iio_trigger_list);
90 mutex_unlock(&iio_trigger_list_lock);
95 mutex_unlock(&iio_trigger_list_lock);
96 device_del(&trig_info->dev);
98 ida_free(&iio_trigger_ida, trig_info->id);
101 EXPORT_SYMBOL(iio_trigger_register);
103 void iio_trigger_unregister(struct iio_trigger *trig_info)
105 mutex_lock(&iio_trigger_list_lock);
106 list_del(&trig_info->list);
107 mutex_unlock(&iio_trigger_list_lock);
109 ida_free(&iio_trigger_ida, trig_info->id);
110 /* Possible issue in here */
111 device_del(&trig_info->dev);
113 EXPORT_SYMBOL(iio_trigger_unregister);
115 int iio_trigger_set_immutable(struct iio_dev *indio_dev, struct iio_trigger *trig)
117 struct iio_dev_opaque *iio_dev_opaque;
119 if (!indio_dev || !trig)
122 iio_dev_opaque = to_iio_dev_opaque(indio_dev);
123 mutex_lock(&iio_dev_opaque->mlock);
124 WARN_ON(iio_dev_opaque->trig_readonly);
126 indio_dev->trig = iio_trigger_get(trig);
127 iio_dev_opaque->trig_readonly = true;
128 mutex_unlock(&iio_dev_opaque->mlock);
132 EXPORT_SYMBOL(iio_trigger_set_immutable);
134 /* Search for trigger by name, assuming iio_trigger_list_lock held */
135 static struct iio_trigger *__iio_trigger_find_by_name(const char *name)
137 struct iio_trigger *iter;
139 list_for_each_entry(iter, &iio_trigger_list, list)
140 if (!strcmp(iter->name, name))
146 static struct iio_trigger *iio_trigger_acquire_by_name(const char *name)
148 struct iio_trigger *trig = NULL, *iter;
150 mutex_lock(&iio_trigger_list_lock);
151 list_for_each_entry(iter, &iio_trigger_list, list)
152 if (sysfs_streq(iter->name, name)) {
154 iio_trigger_get(trig);
157 mutex_unlock(&iio_trigger_list_lock);
162 static void iio_reenable_work_fn(struct work_struct *work)
164 struct iio_trigger *trig = container_of(work, struct iio_trigger,
168 * This 'might' occur after the trigger state is set to disabled -
169 * in that case the driver should skip reenabling.
171 trig->ops->reenable(trig);
175 * In general, reenable callbacks may need to sleep and this path is
176 * not performance sensitive, so just queue up a work item
177 * to reneable the trigger for us.
179 * Races that can cause this.
180 * 1) A handler occurs entirely in interrupt context so the counter
181 * the final decrement is still in this interrupt.
182 * 2) The trigger has been removed, but one last interrupt gets through.
184 * For (1) we must call reenable, but not in atomic context.
185 * For (2) it should be safe to call reenanble, if drivers never blindly
186 * reenable after state is off.
188 static void iio_trigger_notify_done_atomic(struct iio_trigger *trig)
190 if (atomic_dec_and_test(&trig->use_count) && trig->ops &&
192 schedule_work(&trig->reenable_work);
196 * iio_trigger_poll() - Call the IRQ trigger handler of the consumers
197 * @trig: trigger which occurred
199 * This function should only be called from a hard IRQ context.
201 void iio_trigger_poll(struct iio_trigger *trig)
205 if (!atomic_read(&trig->use_count)) {
206 atomic_set(&trig->use_count, CONFIG_IIO_CONSUMERS_PER_TRIGGER);
208 for (i = 0; i < CONFIG_IIO_CONSUMERS_PER_TRIGGER; i++) {
209 if (trig->subirqs[i].enabled)
210 generic_handle_irq(trig->subirq_base + i);
212 iio_trigger_notify_done_atomic(trig);
216 EXPORT_SYMBOL(iio_trigger_poll);
218 irqreturn_t iio_trigger_generic_data_rdy_poll(int irq, void *private)
220 iio_trigger_poll(private);
223 EXPORT_SYMBOL(iio_trigger_generic_data_rdy_poll);
226 * iio_trigger_poll_nested() - Call the threaded trigger handler of the
228 * @trig: trigger which occurred
230 * This function should only be called from a kernel thread context.
232 void iio_trigger_poll_nested(struct iio_trigger *trig)
236 if (!atomic_read(&trig->use_count)) {
237 atomic_set(&trig->use_count, CONFIG_IIO_CONSUMERS_PER_TRIGGER);
239 for (i = 0; i < CONFIG_IIO_CONSUMERS_PER_TRIGGER; i++) {
240 if (trig->subirqs[i].enabled)
241 handle_nested_irq(trig->subirq_base + i);
243 iio_trigger_notify_done(trig);
247 EXPORT_SYMBOL(iio_trigger_poll_nested);
249 void iio_trigger_notify_done(struct iio_trigger *trig)
251 if (atomic_dec_and_test(&trig->use_count) && trig->ops &&
253 trig->ops->reenable(trig);
255 EXPORT_SYMBOL(iio_trigger_notify_done);
257 /* Trigger Consumer related functions */
258 static int iio_trigger_get_irq(struct iio_trigger *trig)
262 mutex_lock(&trig->pool_lock);
263 ret = bitmap_find_free_region(trig->pool,
264 CONFIG_IIO_CONSUMERS_PER_TRIGGER,
266 mutex_unlock(&trig->pool_lock);
268 ret += trig->subirq_base;
273 static void iio_trigger_put_irq(struct iio_trigger *trig, int irq)
275 mutex_lock(&trig->pool_lock);
276 clear_bit(irq - trig->subirq_base, trig->pool);
277 mutex_unlock(&trig->pool_lock);
280 /* Complexity in here. With certain triggers (datardy) an acknowledgement
281 * may be needed if the pollfuncs do not include the data read for the
283 * This is not currently handled. Alternative of not enabling trigger unless
284 * the relevant function is in there may be the best option.
286 /* Worth protecting against double additions? */
287 int iio_trigger_attach_poll_func(struct iio_trigger *trig,
288 struct iio_poll_func *pf)
290 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(pf->indio_dev);
292 bitmap_empty(trig->pool, CONFIG_IIO_CONSUMERS_PER_TRIGGER);
295 /* Prevent the module from being removed whilst attached to a trigger */
296 __module_get(iio_dev_opaque->driver_module);
299 pf->irq = iio_trigger_get_irq(trig);
301 pr_err("Could not find an available irq for trigger %s, CONFIG_IIO_CONSUMERS_PER_TRIGGER=%d limit might be exceeded\n",
302 trig->name, CONFIG_IIO_CONSUMERS_PER_TRIGGER);
307 ret = request_threaded_irq(pf->irq, pf->h, pf->thread,
313 /* Enable trigger in driver */
314 if (trig->ops && trig->ops->set_trigger_state && notinuse) {
315 ret = trig->ops->set_trigger_state(trig, true);
321 * Check if we just registered to our own trigger: we determine that
322 * this is the case if the IIO device and the trigger device share the
323 * same parent device.
325 if (iio_validate_own_trigger(pf->indio_dev, trig))
326 trig->attached_own_device = true;
331 free_irq(pf->irq, pf);
333 iio_trigger_put_irq(trig, pf->irq);
335 module_put(iio_dev_opaque->driver_module);
339 int iio_trigger_detach_poll_func(struct iio_trigger *trig,
340 struct iio_poll_func *pf)
342 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(pf->indio_dev);
343 bool no_other_users =
344 bitmap_weight(trig->pool, CONFIG_IIO_CONSUMERS_PER_TRIGGER) == 1;
347 if (trig->ops && trig->ops->set_trigger_state && no_other_users) {
348 ret = trig->ops->set_trigger_state(trig, false);
352 if (pf->indio_dev->dev.parent == trig->dev.parent)
353 trig->attached_own_device = false;
354 iio_trigger_put_irq(trig, pf->irq);
355 free_irq(pf->irq, pf);
356 module_put(iio_dev_opaque->driver_module);
361 irqreturn_t iio_pollfunc_store_time(int irq, void *p)
363 struct iio_poll_func *pf = p;
365 pf->timestamp = iio_get_time_ns(pf->indio_dev);
366 return IRQ_WAKE_THREAD;
368 EXPORT_SYMBOL(iio_pollfunc_store_time);
371 *iio_alloc_pollfunc(irqreturn_t (*h)(int irq, void *p),
372 irqreturn_t (*thread)(int irq, void *p),
374 struct iio_dev *indio_dev,
379 struct iio_poll_func *pf;
381 pf = kmalloc(sizeof(*pf), GFP_KERNEL);
384 va_start(vargs, fmt);
385 pf->name = kvasprintf(GFP_KERNEL, fmt, vargs);
387 if (pf->name == NULL) {
394 pf->indio_dev = indio_dev;
398 EXPORT_SYMBOL_GPL(iio_alloc_pollfunc);
400 void iio_dealloc_pollfunc(struct iio_poll_func *pf)
405 EXPORT_SYMBOL_GPL(iio_dealloc_pollfunc);
408 * current_trigger_show() - trigger consumer sysfs query current trigger
409 * @dev: device associated with an industrial I/O device
410 * @attr: pointer to the device_attribute structure that
412 * @buf: buffer where the current trigger name will be printed into
414 * For trigger consumers the current_trigger interface allows the trigger
415 * used by the device to be queried.
417 * Return: a negative number on failure, the number of characters written
418 * on success or 0 if no trigger is available
420 static ssize_t current_trigger_show(struct device *dev,
421 struct device_attribute *attr, char *buf)
423 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
426 return sysfs_emit(buf, "%s\n", indio_dev->trig->name);
431 * current_trigger_store() - trigger consumer sysfs set current trigger
432 * @dev: device associated with an industrial I/O device
433 * @attr: device attribute that is being processed
434 * @buf: string buffer that holds the name of the trigger
435 * @len: length of the trigger name held by buf
437 * For trigger consumers the current_trigger interface allows the trigger
438 * used for this device to be specified at run time based on the trigger's
441 * Return: negative error code on failure or length of the buffer
444 static ssize_t current_trigger_store(struct device *dev,
445 struct device_attribute *attr,
446 const char *buf, size_t len)
448 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
449 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
450 struct iio_trigger *oldtrig = indio_dev->trig;
451 struct iio_trigger *trig;
454 mutex_lock(&iio_dev_opaque->mlock);
455 if (iio_dev_opaque->currentmode == INDIO_BUFFER_TRIGGERED) {
456 mutex_unlock(&iio_dev_opaque->mlock);
459 if (iio_dev_opaque->trig_readonly) {
460 mutex_unlock(&iio_dev_opaque->mlock);
463 mutex_unlock(&iio_dev_opaque->mlock);
465 trig = iio_trigger_acquire_by_name(buf);
466 if (oldtrig == trig) {
468 goto out_trigger_put;
471 if (trig && indio_dev->info->validate_trigger) {
472 ret = indio_dev->info->validate_trigger(indio_dev, trig);
474 goto out_trigger_put;
477 if (trig && trig->ops && trig->ops->validate_device) {
478 ret = trig->ops->validate_device(trig, indio_dev);
480 goto out_trigger_put;
483 indio_dev->trig = trig;
486 if (indio_dev->modes & INDIO_EVENT_TRIGGERED)
487 iio_trigger_detach_poll_func(oldtrig,
488 indio_dev->pollfunc_event);
489 iio_trigger_put(oldtrig);
491 if (indio_dev->trig) {
492 if (indio_dev->modes & INDIO_EVENT_TRIGGERED)
493 iio_trigger_attach_poll_func(indio_dev->trig,
494 indio_dev->pollfunc_event);
501 iio_trigger_put(trig);
505 static DEVICE_ATTR_RW(current_trigger);
507 static struct attribute *iio_trigger_consumer_attrs[] = {
508 &dev_attr_current_trigger.attr,
512 static const struct attribute_group iio_trigger_consumer_attr_group = {
514 .attrs = iio_trigger_consumer_attrs,
517 static void iio_trig_release(struct device *device)
519 struct iio_trigger *trig = to_iio_trigger(device);
522 if (trig->subirq_base) {
523 for (i = 0; i < CONFIG_IIO_CONSUMERS_PER_TRIGGER; i++) {
524 irq_modify_status(trig->subirq_base + i,
526 IRQ_NOREQUEST | IRQ_NOPROBE);
527 irq_set_chip(trig->subirq_base + i,
529 irq_set_handler(trig->subirq_base + i,
533 irq_free_descs(trig->subirq_base,
534 CONFIG_IIO_CONSUMERS_PER_TRIGGER);
540 static const struct device_type iio_trig_type = {
541 .release = iio_trig_release,
542 .groups = iio_trig_dev_groups,
545 static void iio_trig_subirqmask(struct irq_data *d)
547 struct irq_chip *chip = irq_data_get_irq_chip(d);
548 struct iio_trigger *trig = container_of(chip, struct iio_trigger, subirq_chip);
550 trig->subirqs[d->irq - trig->subirq_base].enabled = false;
553 static void iio_trig_subirqunmask(struct irq_data *d)
555 struct irq_chip *chip = irq_data_get_irq_chip(d);
556 struct iio_trigger *trig = container_of(chip, struct iio_trigger, subirq_chip);
558 trig->subirqs[d->irq - trig->subirq_base].enabled = true;
561 static __printf(3, 0)
562 struct iio_trigger *viio_trigger_alloc(struct device *parent,
563 struct module *this_mod,
567 struct iio_trigger *trig;
570 trig = kzalloc(sizeof(*trig), GFP_KERNEL);
574 trig->dev.parent = parent;
575 trig->dev.type = &iio_trig_type;
576 trig->dev.bus = &iio_bus_type;
577 device_initialize(&trig->dev);
578 INIT_WORK(&trig->reenable_work, iio_reenable_work_fn);
580 mutex_init(&trig->pool_lock);
581 trig->subirq_base = irq_alloc_descs(-1, 0,
582 CONFIG_IIO_CONSUMERS_PER_TRIGGER,
584 if (trig->subirq_base < 0)
587 trig->name = kvasprintf(GFP_KERNEL, fmt, vargs);
588 if (trig->name == NULL)
591 INIT_LIST_HEAD(&trig->list);
593 trig->owner = this_mod;
595 trig->subirq_chip.name = trig->name;
596 trig->subirq_chip.irq_mask = &iio_trig_subirqmask;
597 trig->subirq_chip.irq_unmask = &iio_trig_subirqunmask;
598 for (i = 0; i < CONFIG_IIO_CONSUMERS_PER_TRIGGER; i++) {
599 irq_set_chip(trig->subirq_base + i, &trig->subirq_chip);
600 irq_set_handler(trig->subirq_base + i, &handle_simple_irq);
601 irq_modify_status(trig->subirq_base + i,
602 IRQ_NOREQUEST | IRQ_NOAUTOEN, IRQ_NOPROBE);
608 irq_free_descs(trig->subirq_base, CONFIG_IIO_CONSUMERS_PER_TRIGGER);
615 * __iio_trigger_alloc - Allocate a trigger
616 * @parent: Device to allocate iio_trigger for
617 * @this_mod: module allocating the trigger
618 * @fmt: trigger name format. If it includes format
619 * specifiers, the additional arguments following
620 * format are formatted and inserted in the resulting
621 * string replacing their respective specifiers.
623 * Pointer to allocated iio_trigger on success, NULL on failure.
625 struct iio_trigger *__iio_trigger_alloc(struct device *parent,
626 struct module *this_mod,
627 const char *fmt, ...)
629 struct iio_trigger *trig;
632 va_start(vargs, fmt);
633 trig = viio_trigger_alloc(parent, this_mod, fmt, vargs);
638 EXPORT_SYMBOL(__iio_trigger_alloc);
640 void iio_trigger_free(struct iio_trigger *trig)
643 put_device(&trig->dev);
645 EXPORT_SYMBOL(iio_trigger_free);
647 static void devm_iio_trigger_release(struct device *dev, void *res)
649 iio_trigger_free(*(struct iio_trigger **)res);
653 * __devm_iio_trigger_alloc - Resource-managed iio_trigger_alloc()
654 * Managed iio_trigger_alloc. iio_trigger allocated with this function is
655 * automatically freed on driver detach.
656 * @parent: Device to allocate iio_trigger for
657 * @this_mod: module allocating the trigger
658 * @fmt: trigger name format. If it includes format
659 * specifiers, the additional arguments following
660 * format are formatted and inserted in the resulting
661 * string replacing their respective specifiers.
665 * Pointer to allocated iio_trigger on success, NULL on failure.
667 struct iio_trigger *__devm_iio_trigger_alloc(struct device *parent,
668 struct module *this_mod,
669 const char *fmt, ...)
671 struct iio_trigger **ptr, *trig;
674 ptr = devres_alloc(devm_iio_trigger_release, sizeof(*ptr),
679 /* use raw alloc_dr for kmalloc caller tracing */
680 va_start(vargs, fmt);
681 trig = viio_trigger_alloc(parent, this_mod, fmt, vargs);
685 devres_add(parent, ptr);
692 EXPORT_SYMBOL_GPL(__devm_iio_trigger_alloc);
694 static void devm_iio_trigger_unreg(void *trigger_info)
696 iio_trigger_unregister(trigger_info);
700 * devm_iio_trigger_register - Resource-managed iio_trigger_register()
701 * @dev: device this trigger was allocated for
702 * @trig_info: trigger to register
704 * Managed iio_trigger_register(). The IIO trigger registered with this
705 * function is automatically unregistered on driver detach. This function
706 * calls iio_trigger_register() internally. Refer to that function for more
710 * 0 on success, negative error number on failure.
712 int devm_iio_trigger_register(struct device *dev,
713 struct iio_trigger *trig_info)
717 ret = iio_trigger_register(trig_info);
721 return devm_add_action_or_reset(dev, devm_iio_trigger_unreg, trig_info);
723 EXPORT_SYMBOL_GPL(devm_iio_trigger_register);
725 bool iio_trigger_using_own(struct iio_dev *indio_dev)
727 return indio_dev->trig->attached_own_device;
729 EXPORT_SYMBOL(iio_trigger_using_own);
732 * iio_validate_own_trigger - Check if a trigger and IIO device belong to
734 * @idev: the IIO device to check
735 * @trig: the IIO trigger to check
737 * This function can be used as the validate_trigger callback for triggers that
738 * can only be attached to their own device.
740 * Return: 0 if both the trigger and the IIO device belong to the same
741 * device, -EINVAL otherwise.
743 int iio_validate_own_trigger(struct iio_dev *idev, struct iio_trigger *trig)
745 if (idev->dev.parent != trig->dev.parent)
749 EXPORT_SYMBOL_GPL(iio_validate_own_trigger);
752 * iio_trigger_validate_own_device - Check if a trigger and IIO device belong to
754 * @trig: The IIO trigger to check
755 * @indio_dev: the IIO device to check
757 * This function can be used as the validate_device callback for triggers that
758 * can only be attached to their own device.
760 * Return: 0 if both the trigger and the IIO device belong to the same
761 * device, -EINVAL otherwise.
763 int iio_trigger_validate_own_device(struct iio_trigger *trig,
764 struct iio_dev *indio_dev)
766 if (indio_dev->dev.parent != trig->dev.parent)
770 EXPORT_SYMBOL(iio_trigger_validate_own_device);
772 int iio_device_register_trigger_consumer(struct iio_dev *indio_dev)
774 return iio_device_register_sysfs_group(indio_dev,
775 &iio_trigger_consumer_attr_group);
778 void iio_device_unregister_trigger_consumer(struct iio_dev *indio_dev)
780 /* Clean up an associated but not attached trigger reference */
782 iio_trigger_put(indio_dev->trig);