Commit | Line | Data |
---|---|---|
1637db44 JC |
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 | */ | |
d96d1337 | 9 | #include <linux/irq.h> |
99c97852 | 10 | #include <linux/module.h> |
d96d1337 | 11 | |
1637db44 JC |
12 | #ifndef _IIO_TRIGGER_H_ |
13 | #define _IIO_TRIGGER_H_ | |
1637db44 | 14 | |
d96d1337 JC |
15 | struct iio_subirq { |
16 | bool enabled; | |
17 | }; | |
18 | ||
d29f73db JC |
19 | /** |
20 | * struct iio_trigger_ops - operations structure for an iio_trigger. | |
21 | * @owner: used to monitor usage count of the trigger. | |
22 | * @set_trigger_state: switch on/off the trigger on demand | |
23 | * @try_reenable: function to reenable the trigger when the | |
24 | * use count is zero (may be NULL) | |
25 | * @validate_device: function to validate the device when the | |
26 | * current trigger gets changed. | |
27 | * | |
28 | * This is typically static const within a driver and shared by | |
29 | * instances of a given device. | |
30 | **/ | |
31 | struct iio_trigger_ops { | |
99698b45 | 32 | struct module *owner; |
d29f73db JC |
33 | int (*set_trigger_state)(struct iio_trigger *trig, bool state); |
34 | int (*try_reenable)(struct iio_trigger *trig); | |
35 | int (*validate_device)(struct iio_trigger *trig, | |
36 | struct iio_dev *indio_dev); | |
37 | }; | |
38 | ||
39 | ||
1637db44 JC |
40 | /** |
41 | * struct iio_trigger - industrial I/O trigger device | |
c3668a0f | 42 | * @ops: [DRIVER] operations structure |
1637db44 JC |
43 | * @id: [INTERN] unique id number |
44 | * @name: [DRIVER] unique name | |
45 | * @dev: [DRIVER] associated device (if relevant) | |
1637db44 JC |
46 | * @private_data: [DRIVER] device specific data |
47 | * @list: [INTERN] used in maintenance of global trigger list | |
48 | * @alloc_list: [DRIVER] used for driver specific trigger list | |
4c572605 | 49 | * @use_count: use count for the trigger |
59c85e82 JC |
50 | * @subirq_chip: [INTERN] associate 'virtual' irq chip. |
51 | * @subirq_base: [INTERN] base number for irqs provided by trigger. | |
52 | * @subirqs: [INTERN] information about the 'child' irqs. | |
53 | * @pool: [INTERN] bitmap of irqs currently in use. | |
54 | * @pool_lock: [INTERN] protection of the irq pool. | |
1637db44 JC |
55 | **/ |
56 | struct iio_trigger { | |
d29f73db | 57 | const struct iio_trigger_ops *ops; |
1637db44 JC |
58 | int id; |
59 | const char *name; | |
60 | struct device dev; | |
61 | ||
62 | void *private_data; | |
63 | struct list_head list; | |
64 | struct list_head alloc_list; | |
1637db44 JC |
65 | int use_count; |
66 | ||
d96d1337 JC |
67 | struct irq_chip subirq_chip; |
68 | int subirq_base; | |
69 | ||
70 | struct iio_subirq subirqs[CONFIG_IIO_CONSUMERS_PER_TRIGGER]; | |
71 | unsigned long pool[BITS_TO_LONGS(CONFIG_IIO_CONSUMERS_PER_TRIGGER)]; | |
72 | struct mutex pool_lock; | |
1637db44 JC |
73 | }; |
74 | ||
03e1672a | 75 | |
1637db44 JC |
76 | static inline struct iio_trigger *to_iio_trigger(struct device *d) |
77 | { | |
78 | return container_of(d, struct iio_trigger, dev); | |
99698b45 | 79 | } |
1637db44 | 80 | |
7cbb7537 | 81 | static inline void iio_trigger_put(struct iio_trigger *trig) |
1637db44 | 82 | { |
d29f73db | 83 | module_put(trig->ops->owner); |
82db4249 | 84 | put_device(&trig->dev); |
99698b45 | 85 | } |
1637db44 | 86 | |
7cbb7537 | 87 | static inline void iio_trigger_get(struct iio_trigger *trig) |
1637db44 | 88 | { |
1637db44 | 89 | get_device(&trig->dev); |
82db4249 | 90 | __module_get(trig->ops->owner); |
99698b45 | 91 | } |
1637db44 | 92 | |
1637db44 JC |
93 | /** |
94 | * iio_trigger_register() - register a trigger with the IIO core | |
95 | * @trig_info: trigger to be registered | |
96 | **/ | |
97 | int iio_trigger_register(struct iio_trigger *trig_info); | |
98 | ||
99 | /** | |
100 | * iio_trigger_unregister() - unregister a trigger from the core | |
4c572605 | 101 | * @trig_info: trigger to be unregistered |
1637db44 JC |
102 | **/ |
103 | void iio_trigger_unregister(struct iio_trigger *trig_info); | |
104 | ||
1637db44 | 105 | /** |
4c572605 | 106 | * iio_trigger_poll() - called on a trigger occurring |
c3668a0f PM |
107 | * @trig: trigger which occurred |
108 | * @time: timestamp when trigger occurred | |
4c572605 | 109 | * |
1637db44 JC |
110 | * Typically called in relevant hardware interrupt handler. |
111 | **/ | |
7b2c33b1 | 112 | void iio_trigger_poll(struct iio_trigger *trig, s64 time); |
1f785681 | 113 | void iio_trigger_poll_chained(struct iio_trigger *trig, s64 time); |
3f72395e | 114 | |
8384d957 JC |
115 | irqreturn_t iio_trigger_generic_data_rdy_poll(int irq, void *private); |
116 | ||
7cbb7537 LPC |
117 | __printf(1, 2) struct iio_trigger *iio_trigger_alloc(const char *fmt, ...); |
118 | void iio_trigger_free(struct iio_trigger *trig); | |
1637db44 | 119 | |
1637db44 | 120 | #endif /* _IIO_TRIGGER_H_ */ |