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