Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 1 | /* The industrial I/O core, trigger handling functions |
| 2 | * |
| 3 | * Copyright (c) 2008 Jonathan Cameron |
| 4 | * |
| 5 | * This program is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 as published by |
| 7 | * the Free Software Foundation. |
| 8 | */ |
Jonathan Cameron | d96d133 | 2011-05-18 14:41:18 +0100 | [diff] [blame] | 9 | #include <linux/irq.h> |
Paul Gortmaker | 99c9785 | 2011-07-03 15:49:50 -0400 | [diff] [blame] | 10 | #include <linux/module.h> |
Lars-Peter Clausen | a1a8e1d | 2013-07-16 15:28:00 +0100 | [diff] [blame] | 11 | #include <linux/atomic.h> |
Jonathan Cameron | d96d133 | 2011-05-18 14:41:18 +0100 | [diff] [blame] | 12 | |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 13 | #ifndef _IIO_TRIGGER_H_ |
| 14 | #define _IIO_TRIGGER_H_ |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 15 | |
Jonathan Cameron | aaa3002 | 2013-02-09 10:49:00 +0000 | [diff] [blame] | 16 | #ifdef CONFIG_IIO_TRIGGER |
Jonathan Cameron | d96d133 | 2011-05-18 14:41:18 +0100 | [diff] [blame] | 17 | struct iio_subirq { |
| 18 | bool enabled; |
| 19 | }; |
| 20 | |
Pengyu Ma | ad30bad | 2015-08-04 16:32:18 +0800 | [diff] [blame] | 21 | struct iio_dev; |
| 22 | struct iio_trigger; |
| 23 | |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 24 | /** |
Jonathan Cameron | d29f73d | 2011-08-12 17:08:38 +0100 | [diff] [blame] | 25 | * struct iio_trigger_ops - operations structure for an iio_trigger. |
| 26 | * @owner: used to monitor usage count of the trigger. |
| 27 | * @set_trigger_state: switch on/off the trigger on demand |
| 28 | * @try_reenable: function to reenable the trigger when the |
| 29 | * use count is zero (may be NULL) |
| 30 | * @validate_device: function to validate the device when the |
| 31 | * current trigger gets changed. |
| 32 | * |
| 33 | * This is typically static const within a driver and shared by |
| 34 | * instances of a given device. |
| 35 | **/ |
| 36 | struct iio_trigger_ops { |
Peter Meerwald | 99698b4 | 2012-08-26 13:43:00 +0100 | [diff] [blame] | 37 | struct module *owner; |
Jonathan Cameron | d29f73d | 2011-08-12 17:08:38 +0100 | [diff] [blame] | 38 | int (*set_trigger_state)(struct iio_trigger *trig, bool state); |
| 39 | int (*try_reenable)(struct iio_trigger *trig); |
| 40 | int (*validate_device)(struct iio_trigger *trig, |
| 41 | struct iio_dev *indio_dev); |
| 42 | }; |
| 43 | |
| 44 | |
| 45 | /** |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 46 | * struct iio_trigger - industrial I/O trigger device |
Peter Meerwald | c3668a0 | 2012-08-26 13:43:00 +0100 | [diff] [blame] | 47 | * @ops: [DRIVER] operations structure |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 48 | * @id: [INTERN] unique id number |
| 49 | * @name: [DRIVER] unique name |
| 50 | * @dev: [DRIVER] associated device (if relevant) |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 51 | * @list: [INTERN] used in maintenance of global trigger list |
| 52 | * @alloc_list: [DRIVER] used for driver specific trigger list |
Randy Dunlap | 4c57260 | 2009-10-04 19:34:02 -0700 | [diff] [blame] | 53 | * @use_count: use count for the trigger |
Jonathan Cameron | 59c85e8 | 2011-05-18 14:42:22 +0100 | [diff] [blame] | 54 | * @subirq_chip: [INTERN] associate 'virtual' irq chip. |
| 55 | * @subirq_base: [INTERN] base number for irqs provided by trigger. |
| 56 | * @subirqs: [INTERN] information about the 'child' irqs. |
| 57 | * @pool: [INTERN] bitmap of irqs currently in use. |
| 58 | * @pool_lock: [INTERN] protection of the irq pool. |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 59 | **/ |
| 60 | struct iio_trigger { |
Jonathan Cameron | d29f73d | 2011-08-12 17:08:38 +0100 | [diff] [blame] | 61 | const struct iio_trigger_ops *ops; |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 62 | int id; |
| 63 | const char *name; |
| 64 | struct device dev; |
| 65 | |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 66 | struct list_head list; |
| 67 | struct list_head alloc_list; |
Lars-Peter Clausen | a1a8e1d | 2013-07-16 15:28:00 +0100 | [diff] [blame] | 68 | atomic_t use_count; |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 69 | |
Jonathan Cameron | d96d133 | 2011-05-18 14:41:18 +0100 | [diff] [blame] | 70 | struct irq_chip subirq_chip; |
| 71 | int subirq_base; |
| 72 | |
| 73 | struct iio_subirq subirqs[CONFIG_IIO_CONSUMERS_PER_TRIGGER]; |
| 74 | unsigned long pool[BITS_TO_LONGS(CONFIG_IIO_CONSUMERS_PER_TRIGGER)]; |
| 75 | struct mutex pool_lock; |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 76 | }; |
| 77 | |
Michael Hennerich | 03e1672 | 2011-06-27 13:07:08 +0100 | [diff] [blame] | 78 | |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 79 | static inline struct iio_trigger *to_iio_trigger(struct device *d) |
| 80 | { |
| 81 | return container_of(d, struct iio_trigger, dev); |
Peter Meerwald | 99698b4 | 2012-08-26 13:43:00 +0100 | [diff] [blame] | 82 | } |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 83 | |
Lars-Peter Clausen | 7cbb753 | 2012-04-26 13:35:01 +0200 | [diff] [blame] | 84 | static inline void iio_trigger_put(struct iio_trigger *trig) |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 85 | { |
Jonathan Cameron | d29f73d | 2011-08-12 17:08:38 +0100 | [diff] [blame] | 86 | module_put(trig->ops->owner); |
Jonathan Cameron | 82db424 | 2011-08-24 17:28:34 +0100 | [diff] [blame] | 87 | put_device(&trig->dev); |
Peter Meerwald | 99698b4 | 2012-08-26 13:43:00 +0100 | [diff] [blame] | 88 | } |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 89 | |
Srinivas Pandruvada | f153566 | 2014-08-22 21:48:00 +0100 | [diff] [blame] | 90 | static inline struct iio_trigger *iio_trigger_get(struct iio_trigger *trig) |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 91 | { |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 92 | get_device(&trig->dev); |
Jonathan Cameron | 82db424 | 2011-08-24 17:28:34 +0100 | [diff] [blame] | 93 | __module_get(trig->ops->owner); |
Srinivas Pandruvada | f153566 | 2014-08-22 21:48:00 +0100 | [diff] [blame] | 94 | |
| 95 | return trig; |
Peter Meerwald | 99698b4 | 2012-08-26 13:43:00 +0100 | [diff] [blame] | 96 | } |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 97 | |
| 98 | /** |
Lars-Peter Clausen | 1e9663c | 2013-03-25 08:58:00 +0000 | [diff] [blame] | 99 | * iio_device_set_drvdata() - Set trigger driver data |
| 100 | * @trig: IIO trigger structure |
| 101 | * @data: Driver specific data |
| 102 | * |
| 103 | * Allows to attach an arbitrary pointer to an IIO trigger, which can later be |
| 104 | * retrieved by iio_trigger_get_drvdata(). |
| 105 | */ |
| 106 | static inline void iio_trigger_set_drvdata(struct iio_trigger *trig, void *data) |
| 107 | { |
Lars-Peter Clausen | 5034bfc9 | 2013-03-25 08:58:00 +0000 | [diff] [blame] | 108 | dev_set_drvdata(&trig->dev, data); |
Lars-Peter Clausen | 1e9663c | 2013-03-25 08:58:00 +0000 | [diff] [blame] | 109 | } |
| 110 | |
| 111 | /** |
| 112 | * iio_trigger_get_drvdata() - Get trigger driver data |
| 113 | * @trig: IIO trigger structure |
| 114 | * |
| 115 | * Returns the data previously set with iio_trigger_set_drvdata() |
| 116 | */ |
| 117 | static inline void *iio_trigger_get_drvdata(struct iio_trigger *trig) |
| 118 | { |
Lars-Peter Clausen | 5034bfc9 | 2013-03-25 08:58:00 +0000 | [diff] [blame] | 119 | return dev_get_drvdata(&trig->dev); |
Lars-Peter Clausen | 1e9663c | 2013-03-25 08:58:00 +0000 | [diff] [blame] | 120 | } |
| 121 | |
| 122 | /** |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 123 | * iio_trigger_register() - register a trigger with the IIO core |
| 124 | * @trig_info: trigger to be registered |
| 125 | **/ |
| 126 | int iio_trigger_register(struct iio_trigger *trig_info); |
| 127 | |
| 128 | /** |
| 129 | * iio_trigger_unregister() - unregister a trigger from the core |
Randy Dunlap | 4c57260 | 2009-10-04 19:34:02 -0700 | [diff] [blame] | 130 | * @trig_info: trigger to be unregistered |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 131 | **/ |
| 132 | void iio_trigger_unregister(struct iio_trigger *trig_info); |
| 133 | |
| 134 | /** |
Randy Dunlap | 4c57260 | 2009-10-04 19:34:02 -0700 | [diff] [blame] | 135 | * iio_trigger_poll() - called on a trigger occurring |
Peter Meerwald | c3668a0 | 2012-08-26 13:43:00 +0100 | [diff] [blame] | 136 | * @trig: trigger which occurred |
Randy Dunlap | 4c57260 | 2009-10-04 19:34:02 -0700 | [diff] [blame] | 137 | * |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 138 | * Typically called in relevant hardware interrupt handler. |
| 139 | **/ |
Peter Meerwald | 398fd22 | 2014-12-06 06:46:00 +0000 | [diff] [blame] | 140 | void iio_trigger_poll(struct iio_trigger *trig); |
| 141 | void iio_trigger_poll_chained(struct iio_trigger *trig); |
Jonathan Cameron | 3f72395 | 2011-08-24 17:28:39 +0100 | [diff] [blame] | 142 | |
Jonathan Cameron | 8384d95 | 2011-05-18 14:41:21 +0100 | [diff] [blame] | 143 | irqreturn_t iio_trigger_generic_data_rdy_poll(int irq, void *private); |
| 144 | |
Lars-Peter Clausen | 7cbb753 | 2012-04-26 13:35:01 +0200 | [diff] [blame] | 145 | __printf(1, 2) struct iio_trigger *iio_trigger_alloc(const char *fmt, ...); |
| 146 | void iio_trigger_free(struct iio_trigger *trig); |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 147 | |
Jonathan Cameron | aaa3002 | 2013-02-09 10:49:00 +0000 | [diff] [blame] | 148 | #else |
| 149 | struct iio_trigger; |
| 150 | struct iio_trigger_ops; |
| 151 | #endif |
Jonathan Cameron | 1637db4 | 2009-08-18 18:06:26 +0100 | [diff] [blame] | 152 | #endif /* _IIO_TRIGGER_H_ */ |