1 /* SPDX-License-Identifier: GPL-2.0-only */ <<
2 /* The industrial I/O core, trigger handling f 1 /* The industrial I/O core, trigger handling functions
3 * 2 *
4 * Copyright (c) 2008 Jonathan Cameron 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.
5 */ 8 */
6 #include <linux/irq.h> 9 #include <linux/irq.h>
7 #include <linux/module.h> 10 #include <linux/module.h>
8 #include <linux/atomic.h> 11 #include <linux/atomic.h>
9 12
10 #ifndef _IIO_TRIGGER_H_ 13 #ifndef _IIO_TRIGGER_H_
11 #define _IIO_TRIGGER_H_ 14 #define _IIO_TRIGGER_H_
12 15
13 #ifdef CONFIG_IIO_TRIGGER 16 #ifdef CONFIG_IIO_TRIGGER
14 struct iio_subirq { 17 struct iio_subirq {
15 bool enabled; 18 bool enabled;
16 }; 19 };
17 20
18 struct iio_dev; 21 struct iio_dev;
19 struct iio_trigger; 22 struct iio_trigger;
20 23
21 /** 24 /**
22 * struct iio_trigger_ops - operations structu 25 * struct iio_trigger_ops - operations structure for an iio_trigger.
>> 26 * @owner: used to monitor usage count of the trigger.
23 * @set_trigger_state: switch on/off the trig 27 * @set_trigger_state: switch on/off the trigger on demand
24 * @reenable: function to reenable t !! 28 * @try_reenable: function to reenable the trigger when the
25 * use count is zero (may 29 * use count is zero (may be NULL)
26 * @validate_device: function to validate t 30 * @validate_device: function to validate the device when the
27 * current trigger gets c 31 * current trigger gets changed.
28 * 32 *
29 * This is typically static const within a dri 33 * This is typically static const within a driver and shared by
30 * instances of a given device. 34 * instances of a given device.
31 **/ 35 **/
32 struct iio_trigger_ops { 36 struct iio_trigger_ops {
>> 37 struct module *owner;
33 int (*set_trigger_state)(struct iio_tr 38 int (*set_trigger_state)(struct iio_trigger *trig, bool state);
34 void (*reenable)(struct iio_trigger *t !! 39 int (*try_reenable)(struct iio_trigger *trig);
35 int (*validate_device)(struct iio_trig 40 int (*validate_device)(struct iio_trigger *trig,
36 struct iio_dev 41 struct iio_dev *indio_dev);
37 }; 42 };
38 43
39 44
40 /** 45 /**
41 * struct iio_trigger - industrial I/O trigger 46 * struct iio_trigger - industrial I/O trigger device
42 * @ops: [DRIVER] operations st 47 * @ops: [DRIVER] operations structure
43 * @owner: [INTERN] owner of this <<
44 * @id: [INTERN] unique id num 48 * @id: [INTERN] unique id number
45 * @name: [DRIVER] unique name 49 * @name: [DRIVER] unique name
46 * @dev: [DRIVER] associated de 50 * @dev: [DRIVER] associated device (if relevant)
47 * @list: [INTERN] used in maint 51 * @list: [INTERN] used in maintenance of global trigger list
48 * @alloc_list: [DRIVER] used for driv 52 * @alloc_list: [DRIVER] used for driver specific trigger list
49 * @use_count: [INTERN] use count for !! 53 * @use_count: use count for the trigger
50 * @subirq_chip: [INTERN] associate 'vi 54 * @subirq_chip: [INTERN] associate 'virtual' irq chip.
51 * @subirq_base: [INTERN] base number f 55 * @subirq_base: [INTERN] base number for irqs provided by trigger.
52 * @subirqs: [INTERN] information a 56 * @subirqs: [INTERN] information about the 'child' irqs.
53 * @pool: [INTERN] bitmap of irq 57 * @pool: [INTERN] bitmap of irqs currently in use.
54 * @pool_lock: [INTERN] protection of 58 * @pool_lock: [INTERN] protection of the irq pool.
55 * @attached_own_device:[INTERN] if we are usi 59 * @attached_own_device:[INTERN] if we are using our own device as trigger,
56 * i.e. if we registered 60 * i.e. if we registered a poll function to the same
57 * device as the one prov 61 * device as the one providing the trigger.
58 * @reenable_work: [INTERN] work item use <<
59 **/ 62 **/
60 struct iio_trigger { 63 struct iio_trigger {
61 const struct iio_trigger_ops *ops; 64 const struct iio_trigger_ops *ops;
62 struct module *owner <<
63 int id; 65 int id;
64 const char *name; 66 const char *name;
65 struct device dev; 67 struct device dev;
66 68
67 struct list_head list; 69 struct list_head list;
68 struct list_head alloc_ 70 struct list_head alloc_list;
69 atomic_t use_co 71 atomic_t use_count;
70 72
71 struct irq_chip subirq 73 struct irq_chip subirq_chip;
72 int subirq 74 int subirq_base;
73 75
74 struct iio_subirq subirqs[CONFIG_IIO_C 76 struct iio_subirq subirqs[CONFIG_IIO_CONSUMERS_PER_TRIGGER];
75 unsigned long pool[BITS_TO_LONGS(CONFI 77 unsigned long pool[BITS_TO_LONGS(CONFIG_IIO_CONSUMERS_PER_TRIGGER)];
76 struct mutex pool_l 78 struct mutex pool_lock;
77 bool attach 79 bool attached_own_device;
78 struct work_struct reenab <<
79 }; 80 };
80 81
81 82
82 static inline struct iio_trigger *to_iio_trigg 83 static inline struct iio_trigger *to_iio_trigger(struct device *d)
83 { 84 {
84 return container_of(d, struct iio_trig 85 return container_of(d, struct iio_trigger, dev);
85 } 86 }
86 87
87 static inline void iio_trigger_put(struct iio_ 88 static inline void iio_trigger_put(struct iio_trigger *trig)
88 { 89 {
89 module_put(trig->owner); !! 90 module_put(trig->ops->owner);
90 put_device(&trig->dev); 91 put_device(&trig->dev);
91 } 92 }
92 93
93 static inline struct iio_trigger *iio_trigger_ 94 static inline struct iio_trigger *iio_trigger_get(struct iio_trigger *trig)
94 { 95 {
95 get_device(&trig->dev); 96 get_device(&trig->dev);
96 !! 97 __module_get(trig->ops->owner);
97 WARN_ONCE(list_empty(&trig->list), <<
98 "Getting non-registered iio <<
99 trig->name); <<
100 <<
101 __module_get(trig->owner); <<
102 98
103 return trig; 99 return trig;
104 } 100 }
105 101
106 /** 102 /**
107 * iio_trigger_set_drvdata() - Set trigger dri !! 103 * iio_device_set_drvdata() - Set trigger driver data
108 * @trig: IIO trigger structure 104 * @trig: IIO trigger structure
109 * @data: Driver specific data 105 * @data: Driver specific data
110 * 106 *
111 * Allows to attach an arbitrary pointer to an 107 * Allows to attach an arbitrary pointer to an IIO trigger, which can later be
112 * retrieved by iio_trigger_get_drvdata(). 108 * retrieved by iio_trigger_get_drvdata().
113 */ 109 */
114 static inline void iio_trigger_set_drvdata(str 110 static inline void iio_trigger_set_drvdata(struct iio_trigger *trig, void *data)
115 { 111 {
116 dev_set_drvdata(&trig->dev, data); 112 dev_set_drvdata(&trig->dev, data);
117 } 113 }
118 114
119 /** 115 /**
120 * iio_trigger_get_drvdata() - Get trigger dri 116 * iio_trigger_get_drvdata() - Get trigger driver data
121 * @trig: IIO trigger structure 117 * @trig: IIO trigger structure
122 * 118 *
123 * Returns the data previously set with iio_tr 119 * Returns the data previously set with iio_trigger_set_drvdata()
124 */ 120 */
125 static inline void *iio_trigger_get_drvdata(st 121 static inline void *iio_trigger_get_drvdata(struct iio_trigger *trig)
126 { 122 {
127 return dev_get_drvdata(&trig->dev); 123 return dev_get_drvdata(&trig->dev);
128 } 124 }
129 125
130 /** 126 /**
131 * iio_trigger_register() - register a trigger 127 * iio_trigger_register() - register a trigger with the IIO core
132 * @trig_info: trigger to be registered 128 * @trig_info: trigger to be registered
133 **/ 129 **/
134 int iio_trigger_register(struct iio_trigger *t 130 int iio_trigger_register(struct iio_trigger *trig_info);
135 131
136 int devm_iio_trigger_register(struct device *d 132 int devm_iio_trigger_register(struct device *dev,
137 struct iio_trigg 133 struct iio_trigger *trig_info);
138 134
139 /** 135 /**
140 * iio_trigger_unregister() - unregister a tri 136 * iio_trigger_unregister() - unregister a trigger from the core
141 * @trig_info: trigger to be unregistered 137 * @trig_info: trigger to be unregistered
142 **/ 138 **/
143 void iio_trigger_unregister(struct iio_trigger 139 void iio_trigger_unregister(struct iio_trigger *trig_info);
144 140
>> 141 void devm_iio_trigger_unregister(struct device *dev,
>> 142 struct iio_trigger *trig_info);
>> 143
145 /** 144 /**
146 * iio_trigger_set_immutable() - set an immuta 145 * iio_trigger_set_immutable() - set an immutable trigger on destination
147 * 146 *
148 * @indio_dev: IIO device structure containing 147 * @indio_dev: IIO device structure containing the device
149 * @trig: trigger to assign to device 148 * @trig: trigger to assign to device
150 * 149 *
151 **/ 150 **/
152 int iio_trigger_set_immutable(struct iio_dev * 151 int iio_trigger_set_immutable(struct iio_dev *indio_dev, struct iio_trigger *trig);
153 152
>> 153 /**
>> 154 * iio_trigger_poll() - called on a trigger occurring
>> 155 * @trig: trigger which occurred
>> 156 *
>> 157 * Typically called in relevant hardware interrupt handler.
>> 158 **/
154 void iio_trigger_poll(struct iio_trigger *trig 159 void iio_trigger_poll(struct iio_trigger *trig);
155 void iio_trigger_poll_nested(struct iio_trigge !! 160 void iio_trigger_poll_chained(struct iio_trigger *trig);
156 161
157 irqreturn_t iio_trigger_generic_data_rdy_poll( 162 irqreturn_t iio_trigger_generic_data_rdy_poll(int irq, void *private);
158 163
159 #define iio_trigger_alloc(parent, fmt, ...) \ !! 164 __printf(1, 2) struct iio_trigger *iio_trigger_alloc(const char *fmt, ...);
160 __iio_trigger_alloc((parent), THIS_MOD <<
161 <<
162 __printf(3, 4) <<
163 struct iio_trigger *__iio_trigger_alloc(struct <<
164 struct <<
165 const <<
166 void iio_trigger_free(struct iio_trigger *trig 165 void iio_trigger_free(struct iio_trigger *trig);
167 166
168 /** 167 /**
169 * iio_trigger_using_own() - tells us if we us 168 * iio_trigger_using_own() - tells us if we use our own HW trigger ourselves
170 * @indio_dev: device to check 169 * @indio_dev: device to check
171 */ 170 */
172 bool iio_trigger_using_own(struct iio_dev *ind 171 bool iio_trigger_using_own(struct iio_dev *indio_dev);
173 172
174 int iio_validate_own_trigger(struct iio_dev *i <<
175 int iio_trigger_validate_own_device(struct iio 173 int iio_trigger_validate_own_device(struct iio_trigger *trig,
176 struct ii 174 struct iio_dev *indio_dev);
177 175
178 #else 176 #else
179 struct iio_trigger; 177 struct iio_trigger;
180 struct iio_trigger_ops; 178 struct iio_trigger_ops;
181 #endif 179 #endif
182 #endif /* _IIO_TRIGGER_H_ */ 180 #endif /* _IIO_TRIGGER_H_ */
183 181
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.