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