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