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 | */ | |
9 | ||
10 | #include <linux/kernel.h> | |
11 | #include <linux/module.h> | |
12 | #include <linux/idr.h> | |
13 | #include <linux/err.h> | |
14 | #include <linux/device.h> | |
15 | #include <linux/interrupt.h> | |
16 | #include <linux/list.h> | |
5a0e3ad6 | 17 | #include <linux/slab.h> |
1637db44 JC |
18 | |
19 | #include "iio.h" | |
20 | #include "trigger.h" | |
74112d3f | 21 | #include "trigger_consumer.h" |
1637db44 JC |
22 | |
23 | /* RFC - Question of approach | |
24 | * Make the common case (single sensor single trigger) | |
25 | * simple by starting trigger capture from when first sensors | |
26 | * is added. | |
27 | * | |
28 | * Complex simultaneous start requires use of 'hold' functionality | |
29 | * of the trigger. (not implemented) | |
30 | * | |
31 | * Any other suggestions? | |
32 | */ | |
33 | ||
1637db44 JC |
34 | static DEFINE_IDR(iio_trigger_idr); |
35 | static DEFINE_SPINLOCK(iio_trigger_idr_lock); | |
36 | ||
37 | /* Single list of all available triggers */ | |
38 | static LIST_HEAD(iio_trigger_list); | |
39 | static DEFINE_MUTEX(iio_trigger_list_lock); | |
40 | ||
41 | /** | |
42 | * iio_trigger_register_sysfs() - create a device for this trigger | |
43 | * @trig_info: the trigger | |
44 | * | |
45 | * Also adds any control attribute registered by the trigger driver | |
46 | **/ | |
47 | static int iio_trigger_register_sysfs(struct iio_trigger *trig_info) | |
48 | { | |
49 | int ret = 0; | |
50 | ||
51 | if (trig_info->control_attrs) | |
52 | ret = sysfs_create_group(&trig_info->dev.kobj, | |
53 | trig_info->control_attrs); | |
54 | ||
55 | return ret; | |
56 | } | |
57 | ||
58 | static void iio_trigger_unregister_sysfs(struct iio_trigger *trig_info) | |
59 | { | |
60 | if (trig_info->control_attrs) | |
61 | sysfs_remove_group(&trig_info->dev.kobj, | |
62 | trig_info->control_attrs); | |
63 | } | |
64 | ||
65 | ||
66 | /** | |
67 | * iio_trigger_register_id() - get a unique id for this trigger | |
68 | * @trig_info: the trigger | |
69 | **/ | |
70 | static int iio_trigger_register_id(struct iio_trigger *trig_info) | |
71 | { | |
72 | int ret = 0; | |
73 | ||
74 | idr_again: | |
75 | if (unlikely(idr_pre_get(&iio_trigger_idr, GFP_KERNEL) == 0)) | |
76 | return -ENOMEM; | |
77 | ||
78 | spin_lock(&iio_trigger_idr_lock); | |
79 | ret = idr_get_new(&iio_trigger_idr, NULL, &trig_info->id); | |
80 | spin_unlock(&iio_trigger_idr_lock); | |
81 | if (unlikely(ret == -EAGAIN)) | |
82 | goto idr_again; | |
83 | else if (likely(!ret)) | |
84 | trig_info->id = trig_info->id & MAX_ID_MASK; | |
85 | ||
86 | return ret; | |
87 | } | |
88 | ||
89 | /** | |
90 | * iio_trigger_unregister_id() - free up unique id for use by another trigger | |
91 | * @trig_info: the trigger | |
92 | **/ | |
93 | static void iio_trigger_unregister_id(struct iio_trigger *trig_info) | |
94 | { | |
74112d3f GKH |
95 | spin_lock(&iio_trigger_idr_lock); |
96 | idr_remove(&iio_trigger_idr, trig_info->id); | |
97 | spin_unlock(&iio_trigger_idr_lock); | |
1637db44 JC |
98 | } |
99 | ||
100 | int iio_trigger_register(struct iio_trigger *trig_info) | |
101 | { | |
102 | int ret; | |
103 | ||
104 | ret = iio_trigger_register_id(trig_info); | |
105 | if (ret) | |
106 | goto error_ret; | |
107 | /* Set the name used for the sysfs directory etc */ | |
108 | dev_set_name(&trig_info->dev, "trigger%ld", | |
109 | (unsigned long) trig_info->id); | |
110 | ||
111 | ret = device_add(&trig_info->dev); | |
112 | if (ret) | |
113 | goto error_unregister_id; | |
114 | ||
115 | ret = iio_trigger_register_sysfs(trig_info); | |
116 | if (ret) | |
117 | goto error_device_del; | |
118 | ||
119 | /* Add to list of available triggers held by the IIO core */ | |
120 | mutex_lock(&iio_trigger_list_lock); | |
121 | list_add_tail(&trig_info->list, &iio_trigger_list); | |
122 | mutex_unlock(&iio_trigger_list_lock); | |
123 | ||
124 | return 0; | |
125 | ||
126 | error_device_del: | |
127 | device_del(&trig_info->dev); | |
128 | error_unregister_id: | |
129 | iio_trigger_unregister_id(trig_info); | |
130 | error_ret: | |
131 | return ret; | |
132 | } | |
133 | EXPORT_SYMBOL(iio_trigger_register); | |
134 | ||
135 | void iio_trigger_unregister(struct iio_trigger *trig_info) | |
136 | { | |
1637db44 | 137 | mutex_lock(&iio_trigger_list_lock); |
582e5489 | 138 | list_del(&trig_info->list); |
1637db44 JC |
139 | mutex_unlock(&iio_trigger_list_lock); |
140 | ||
141 | iio_trigger_unregister_sysfs(trig_info); | |
142 | iio_trigger_unregister_id(trig_info); | |
143 | /* Possible issue in here */ | |
144 | device_unregister(&trig_info->dev); | |
145 | } | |
146 | EXPORT_SYMBOL(iio_trigger_unregister); | |
147 | ||
f6517f22 JC |
148 | static struct iio_trigger *iio_trigger_find_by_name(const char *name, |
149 | size_t len) | |
1637db44 | 150 | { |
f6517f22 | 151 | struct iio_trigger *trig = NULL, *iter; |
7c327857 | 152 | |
1637db44 | 153 | mutex_lock(&iio_trigger_list_lock); |
f6517f22 JC |
154 | list_for_each_entry(iter, &iio_trigger_list, list) |
155 | if (sysfs_streq(iter->name, name)) { | |
156 | trig = iter; | |
1637db44 JC |
157 | break; |
158 | } | |
1637db44 JC |
159 | mutex_unlock(&iio_trigger_list_lock); |
160 | ||
f6517f22 | 161 | return trig; |
5f87404d | 162 | } |
1637db44 | 163 | |
7b2c33b1 | 164 | void iio_trigger_poll(struct iio_trigger *trig, s64 time) |
1637db44 | 165 | { |
d96d1337 | 166 | int i; |
1637db44 JC |
167 | struct iio_poll_func *pf_cursor; |
168 | ||
169 | list_for_each_entry(pf_cursor, &trig->pollfunc_list, list) { | |
170 | if (pf_cursor->poll_func_immediate) { | |
171 | pf_cursor->poll_func_immediate(pf_cursor->private_data); | |
172 | trig->use_count++; | |
173 | } | |
174 | } | |
175 | list_for_each_entry(pf_cursor, &trig->pollfunc_list, list) { | |
176 | if (pf_cursor->poll_func_main) { | |
7b2c33b1 JC |
177 | pf_cursor->poll_func_main(pf_cursor->private_data, |
178 | time); | |
1637db44 JC |
179 | trig->use_count++; |
180 | } | |
181 | } | |
d96d1337 JC |
182 | if (!trig->use_count) { |
183 | for (i = 0; i < CONFIG_IIO_CONSUMERS_PER_TRIGGER; i++) | |
184 | if (trig->subirqs[i].enabled) { | |
185 | trig->use_count++; | |
186 | generic_handle_irq(trig->subirq_base + i); | |
187 | } | |
188 | } | |
1637db44 JC |
189 | } |
190 | EXPORT_SYMBOL(iio_trigger_poll); | |
8384d957 JC |
191 | |
192 | irqreturn_t iio_trigger_generic_data_rdy_poll(int irq, void *private) | |
193 | { | |
194 | iio_trigger_poll(private, iio_get_time_ns()); | |
195 | return IRQ_HANDLED; | |
196 | } | |
197 | EXPORT_SYMBOL(iio_trigger_generic_data_rdy_poll); | |
1637db44 JC |
198 | |
199 | void iio_trigger_notify_done(struct iio_trigger *trig) | |
200 | { | |
201 | trig->use_count--; | |
202 | if (trig->use_count == 0 && trig->try_reenable) | |
203 | if (trig->try_reenable(trig)) { | |
204 | /* Missed and interrupt so launch new poll now */ | |
7b2c33b1 | 205 | iio_trigger_poll(trig, 0); |
1637db44 JC |
206 | } |
207 | } | |
208 | EXPORT_SYMBOL(iio_trigger_notify_done); | |
209 | ||
210 | /** | |
211 | * iio_trigger_read_name() - retrieve useful identifying name | |
212 | **/ | |
213 | ssize_t iio_trigger_read_name(struct device *dev, | |
214 | struct device_attribute *attr, | |
215 | char *buf) | |
216 | { | |
217 | struct iio_trigger *trig = dev_get_drvdata(dev); | |
218 | return sprintf(buf, "%s\n", trig->name); | |
219 | } | |
220 | EXPORT_SYMBOL(iio_trigger_read_name); | |
221 | ||
222 | /* Trigger Consumer related functions */ | |
223 | ||
224 | /* Complexity in here. With certain triggers (datardy) an acknowledgement | |
225 | * may be needed if the pollfuncs do not include the data read for the | |
226 | * triggering device. | |
227 | * This is not currently handled. Alternative of not enabling trigger unless | |
228 | * the relevant function is in there may be the best option. | |
229 | */ | |
230 | /* Worth protecting against double additions?*/ | |
231 | int iio_trigger_attach_poll_func(struct iio_trigger *trig, | |
232 | struct iio_poll_func *pf) | |
233 | { | |
234 | int ret = 0; | |
235 | unsigned long flags; | |
236 | ||
d96d1337 JC |
237 | if (pf->thread) { |
238 | bool notinuse | |
239 | = bitmap_empty(trig->pool, | |
240 | CONFIG_IIO_CONSUMERS_PER_TRIGGER); | |
241 | ||
242 | pf->irq = iio_trigger_get_irq(trig); | |
243 | ret = request_threaded_irq(pf->irq, pf->h, pf->thread, | |
244 | pf->type, pf->name, | |
245 | pf); | |
246 | if (trig->set_trigger_state && notinuse) { | |
247 | ret = trig->set_trigger_state(trig, true); | |
248 | } else { | |
249 | spin_lock_irqsave(&trig->pollfunc_list_lock, flags); | |
250 | list_add_tail(&pf->list, &trig->pollfunc_list); | |
251 | spin_unlock_irqrestore(&trig->pollfunc_list_lock, flags); | |
252 | ||
253 | if (trig->set_trigger_state) | |
254 | ret = trig->set_trigger_state(trig, true); | |
255 | } | |
256 | if (ret) { | |
257 | printk(KERN_ERR "set trigger state failed\n"); | |
258 | list_del(&pf->list); | |
259 | } | |
1637db44 | 260 | } |
d96d1337 | 261 | |
1637db44 JC |
262 | return ret; |
263 | } | |
264 | EXPORT_SYMBOL(iio_trigger_attach_poll_func); | |
265 | ||
266 | int iio_trigger_dettach_poll_func(struct iio_trigger *trig, | |
267 | struct iio_poll_func *pf) | |
268 | { | |
269 | struct iio_poll_func *pf_cursor; | |
270 | unsigned long flags; | |
271 | int ret = -EINVAL; | |
272 | ||
d96d1337 JC |
273 | if (pf->thread) { |
274 | bool no_other_users | |
275 | = (bitmap_weight(trig->pool, | |
276 | CONFIG_IIO_CONSUMERS_PER_TRIGGER) | |
277 | == 1); | |
278 | if (trig->set_trigger_state && no_other_users) { | |
1637db44 JC |
279 | ret = trig->set_trigger_state(trig, false); |
280 | if (ret) | |
281 | goto error_ret; | |
d96d1337 JC |
282 | } else |
283 | ret = 0; | |
284 | iio_trigger_put_irq(trig, pf->irq); | |
285 | free_irq(pf->irq, pf); | |
286 | } else { | |
287 | spin_lock_irqsave(&trig->pollfunc_list_lock, flags); | |
288 | list_for_each_entry(pf_cursor, &trig->pollfunc_list, list) | |
289 | if (pf_cursor == pf) { | |
290 | ret = 0; | |
291 | break; | |
292 | } | |
293 | if (!ret) { | |
294 | if (list_is_singular(&trig->pollfunc_list) | |
295 | && trig->set_trigger_state) { | |
296 | spin_unlock_irqrestore(&trig | |
297 | ->pollfunc_list_lock, | |
298 | flags); | |
299 | /* May sleep hence cannot hold the spin lock */ | |
300 | ret = trig->set_trigger_state(trig, false); | |
301 | if (ret) | |
302 | goto error_ret; | |
303 | spin_lock_irqsave(&trig->pollfunc_list_lock, | |
304 | flags); | |
305 | } | |
306 | /* | |
307 | * Now we can delete safe in the knowledge that, if | |
308 | * this is the last pollfunc then we have disabled | |
309 | * the trigger anyway and so nothing should be able | |
310 | * to call the pollfunc. | |
311 | */ | |
312 | list_del(&pf_cursor->list); | |
1637db44 | 313 | } |
d96d1337 | 314 | spin_unlock_irqrestore(&trig->pollfunc_list_lock, flags); |
1637db44 | 315 | } |
1637db44 JC |
316 | |
317 | error_ret: | |
318 | return ret; | |
319 | } | |
320 | EXPORT_SYMBOL(iio_trigger_dettach_poll_func); | |
321 | ||
d96d1337 JC |
322 | irqreturn_t iio_pollfunc_store_time(int irq, void *p) |
323 | { | |
324 | struct iio_poll_func *pf = p; | |
325 | pf->timestamp = iio_get_time_ns(); | |
326 | return IRQ_WAKE_THREAD; | |
327 | } | |
328 | EXPORT_SYMBOL(iio_pollfunc_store_time); | |
329 | ||
1637db44 | 330 | /** |
751a3700 | 331 | * iio_trigger_read_currrent() - trigger consumer sysfs query which trigger |
1637db44 JC |
332 | * |
333 | * For trigger consumers the current_trigger interface allows the trigger | |
334 | * used by the device to be queried. | |
335 | **/ | |
336 | static ssize_t iio_trigger_read_current(struct device *dev, | |
337 | struct device_attribute *attr, | |
338 | char *buf) | |
339 | { | |
340 | struct iio_dev *dev_info = dev_get_drvdata(dev); | |
341 | int len = 0; | |
342 | if (dev_info->trig) | |
3c9bbf58 JC |
343 | len = sprintf(buf, |
344 | "%s\n", | |
345 | dev_info->trig->name); | |
1637db44 JC |
346 | return len; |
347 | } | |
348 | ||
349 | /** | |
350 | * iio_trigger_write_current() trigger consumer sysfs set current trigger | |
351 | * | |
352 | * For trigger consumers the current_trigger interface allows the trigger | |
353 | * used for this device to be specified at run time based on the triggers | |
354 | * name. | |
355 | **/ | |
356 | static ssize_t iio_trigger_write_current(struct device *dev, | |
357 | struct device_attribute *attr, | |
358 | const char *buf, | |
359 | size_t len) | |
360 | { | |
361 | struct iio_dev *dev_info = dev_get_drvdata(dev); | |
362 | struct iio_trigger *oldtrig = dev_info->trig; | |
363 | mutex_lock(&dev_info->mlock); | |
364 | if (dev_info->currentmode == INDIO_RING_TRIGGERED) { | |
365 | mutex_unlock(&dev_info->mlock); | |
366 | return -EBUSY; | |
367 | } | |
368 | mutex_unlock(&dev_info->mlock); | |
369 | ||
1637db44 JC |
370 | dev_info->trig = iio_trigger_find_by_name(buf, len); |
371 | if (oldtrig && dev_info->trig != oldtrig) | |
372 | iio_put_trigger(oldtrig); | |
373 | if (dev_info->trig) | |
374 | iio_get_trigger(dev_info->trig); | |
375 | ||
376 | return len; | |
377 | } | |
378 | ||
74112d3f GKH |
379 | static DEVICE_ATTR(current_trigger, S_IRUGO | S_IWUSR, |
380 | iio_trigger_read_current, | |
381 | iio_trigger_write_current); | |
1637db44 JC |
382 | |
383 | static struct attribute *iio_trigger_consumer_attrs[] = { | |
384 | &dev_attr_current_trigger.attr, | |
385 | NULL, | |
386 | }; | |
387 | ||
388 | static const struct attribute_group iio_trigger_consumer_attr_group = { | |
389 | .name = "trigger", | |
390 | .attrs = iio_trigger_consumer_attrs, | |
391 | }; | |
392 | ||
393 | static void iio_trig_release(struct device *device) | |
394 | { | |
395 | struct iio_trigger *trig = to_iio_trigger(device); | |
d96d1337 JC |
396 | int i; |
397 | ||
398 | if (trig->subirq_base) { | |
399 | for (i = 0; i < CONFIG_IIO_CONSUMERS_PER_TRIGGER; i++) { | |
400 | irq_modify_status(trig->subirq_base + i, | |
401 | IRQ_NOAUTOEN, | |
402 | IRQ_NOREQUEST | IRQ_NOPROBE); | |
403 | irq_set_chip(trig->subirq_base + i, | |
404 | NULL); | |
405 | irq_set_handler(trig->subirq_base + i, | |
406 | NULL); | |
407 | } | |
408 | ||
409 | irq_free_descs(trig->subirq_base, | |
410 | CONFIG_IIO_CONSUMERS_PER_TRIGGER); | |
411 | } | |
1637db44 JC |
412 | kfree(trig); |
413 | iio_put(); | |
414 | } | |
415 | ||
416 | static struct device_type iio_trig_type = { | |
417 | .release = iio_trig_release, | |
418 | }; | |
419 | ||
d96d1337 JC |
420 | static void iio_trig_subirqmask(struct irq_data *d) |
421 | { | |
422 | struct irq_chip *chip = irq_data_get_irq_chip(d); | |
423 | struct iio_trigger *trig | |
424 | = container_of(chip, | |
425 | struct iio_trigger, subirq_chip); | |
426 | trig->subirqs[d->irq - trig->subirq_base].enabled = false; | |
427 | } | |
428 | ||
429 | static void iio_trig_subirqunmask(struct irq_data *d) | |
430 | { | |
431 | struct irq_chip *chip = irq_data_get_irq_chip(d); | |
432 | struct iio_trigger *trig | |
433 | = container_of(chip, | |
434 | struct iio_trigger, subirq_chip); | |
435 | trig->subirqs[d->irq - trig->subirq_base].enabled = true; | |
436 | } | |
437 | ||
438 | struct iio_trigger *iio_allocate_trigger_named(const char *name) | |
1637db44 JC |
439 | { |
440 | struct iio_trigger *trig; | |
441 | trig = kzalloc(sizeof *trig, GFP_KERNEL); | |
442 | if (trig) { | |
d96d1337 | 443 | int i; |
1637db44 | 444 | trig->dev.type = &iio_trig_type; |
5aaaeba8 | 445 | trig->dev.bus = &iio_bus_type; |
1637db44 JC |
446 | device_initialize(&trig->dev); |
447 | dev_set_drvdata(&trig->dev, (void *)trig); | |
448 | spin_lock_init(&trig->pollfunc_list_lock); | |
449 | INIT_LIST_HEAD(&trig->list); | |
450 | INIT_LIST_HEAD(&trig->pollfunc_list); | |
d96d1337 JC |
451 | |
452 | if (name) { | |
453 | mutex_init(&trig->pool_lock); | |
454 | trig->subirq_base | |
455 | = irq_alloc_descs(-1, 0, | |
456 | CONFIG_IIO_CONSUMERS_PER_TRIGGER, | |
457 | 0); | |
458 | if (trig->subirq_base < 0) { | |
459 | kfree(trig); | |
460 | return NULL; | |
461 | } | |
462 | trig->name = name; | |
463 | trig->subirq_chip.name = name; | |
464 | trig->subirq_chip.irq_mask = &iio_trig_subirqmask; | |
465 | trig->subirq_chip.irq_unmask = &iio_trig_subirqunmask; | |
466 | for (i = 0; i < CONFIG_IIO_CONSUMERS_PER_TRIGGER; i++) { | |
467 | irq_set_chip(trig->subirq_base + i, | |
468 | &trig->subirq_chip); | |
469 | irq_set_handler(trig->subirq_base + i, | |
470 | &handle_simple_irq); | |
471 | irq_modify_status(trig->subirq_base + i, | |
472 | IRQ_NOREQUEST | IRQ_NOAUTOEN, | |
473 | IRQ_NOPROBE); | |
474 | } | |
475 | } | |
1637db44 JC |
476 | iio_get(); |
477 | } | |
478 | return trig; | |
479 | } | |
d96d1337 JC |
480 | EXPORT_SYMBOL(iio_allocate_trigger_named); |
481 | ||
482 | struct iio_trigger *iio_allocate_trigger(void) | |
483 | { | |
484 | return iio_allocate_trigger_named(NULL); | |
485 | } | |
1637db44 JC |
486 | EXPORT_SYMBOL(iio_allocate_trigger); |
487 | ||
488 | void iio_free_trigger(struct iio_trigger *trig) | |
489 | { | |
490 | if (trig) | |
491 | put_device(&trig->dev); | |
492 | } | |
493 | EXPORT_SYMBOL(iio_free_trigger); | |
494 | ||
495 | int iio_device_register_trigger_consumer(struct iio_dev *dev_info) | |
496 | { | |
497 | int ret; | |
498 | ret = sysfs_create_group(&dev_info->dev.kobj, | |
499 | &iio_trigger_consumer_attr_group); | |
500 | return ret; | |
501 | } | |
502 | EXPORT_SYMBOL(iio_device_register_trigger_consumer); | |
503 | ||
504 | int iio_device_unregister_trigger_consumer(struct iio_dev *dev_info) | |
505 | { | |
506 | sysfs_remove_group(&dev_info->dev.kobj, | |
507 | &iio_trigger_consumer_attr_group); | |
508 | return 0; | |
509 | } | |
510 | EXPORT_SYMBOL(iio_device_unregister_trigger_consumer); | |
511 | ||
15744090 JC |
512 | int iio_alloc_pollfunc(struct iio_dev *indio_dev, |
513 | void (*immediate)(struct iio_dev *indio_dev), | |
7b2c33b1 | 514 | void (*main)(struct iio_dev *private_data, s64 time)) |
15744090 JC |
515 | { |
516 | indio_dev->pollfunc = kzalloc(sizeof(*indio_dev->pollfunc), GFP_KERNEL); | |
517 | if (indio_dev->pollfunc == NULL) | |
518 | return -ENOMEM; | |
519 | indio_dev->pollfunc->poll_func_immediate = immediate; | |
520 | indio_dev->pollfunc->poll_func_main = main; | |
521 | indio_dev->pollfunc->private_data = indio_dev; | |
522 | return 0; | |
523 | } | |
524 | EXPORT_SYMBOL(iio_alloc_pollfunc); | |
c3db00cc JC |
525 | |
526 | int iio_triggered_ring_postenable(struct iio_dev *indio_dev) | |
527 | { | |
528 | return indio_dev->trig | |
529 | ? iio_trigger_attach_poll_func(indio_dev->trig, | |
530 | indio_dev->pollfunc) | |
531 | : 0; | |
532 | } | |
533 | EXPORT_SYMBOL(iio_triggered_ring_postenable); | |
534 | ||
535 | int iio_triggered_ring_predisable(struct iio_dev *indio_dev) | |
536 | { | |
537 | return indio_dev->trig | |
538 | ? iio_trigger_dettach_poll_func(indio_dev->trig, | |
539 | indio_dev->pollfunc) | |
540 | : 0; | |
541 | } | |
542 | EXPORT_SYMBOL(iio_triggered_ring_predisable); |