blob: 30affa533a1f77162f13a5ba1288ed1b602a74a4 [file] [log] [blame]
Jonathan Cameron7d438172011-08-12 17:47:53 +01001
Jonathan Cameron847ec802009-08-18 18:06:19 +01002/* The industrial I/O core
3 *
4 * Copyright (c) 2008 Jonathan Cameron
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published by
8 * the Free Software Foundation.
9 */
Jonathan Cameron847ec802009-08-18 18:06:19 +010010#ifndef _INDUSTRIAL_IO_H_
11#define _INDUSTRIAL_IO_H_
12
13#include <linux/device.h>
14#include <linux/cdev.h>
Jonathan Cameron06458e22012-04-25 15:54:58 +010015#include <linux/iio/types.h>
Jonathan Cameron847ec802009-08-18 18:06:19 +010016/* IIO TODO LIST */
Jonathan Cameron751a3702010-06-26 12:54:19 +010017/*
Jonathan Cameron847ec802009-08-18 18:06:19 +010018 * Provide means of adjusting timer accuracy.
19 * Currently assumes nano seconds.
20 */
21
Jonathan Cameron1d892712011-05-18 14:40:51 +010022enum iio_chan_info_enum {
Jonathan Cameron5ccb3ad2012-04-15 17:41:16 +010023 IIO_CHAN_INFO_RAW = 0,
24 IIO_CHAN_INFO_PROCESSED,
25 IIO_CHAN_INFO_SCALE,
Jonathan Cameronc8a9f802011-10-26 17:41:36 +010026 IIO_CHAN_INFO_OFFSET,
27 IIO_CHAN_INFO_CALIBSCALE,
28 IIO_CHAN_INFO_CALIBBIAS,
29 IIO_CHAN_INFO_PEAK,
30 IIO_CHAN_INFO_PEAK_SCALE,
31 IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW,
32 IIO_CHAN_INFO_AVERAGE_RAW,
Jonathan Camerondf94aba2011-11-27 11:39:12 +000033 IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY,
Laxman Dewangance85a1c2012-04-13 16:03:31 +053034 IIO_CHAN_INFO_SAMP_FREQ,
Michael Hennericha6b12852012-04-27 10:58:34 +020035 IIO_CHAN_INFO_FREQUENCY,
36 IIO_CHAN_INFO_PHASE,
Michael Hennerichb65d6212012-05-11 11:36:53 +020037 IIO_CHAN_INFO_HARDWAREGAIN,
srinivas pandruvada7c9ab032012-09-05 13:56:00 +010038 IIO_CHAN_INFO_HYSTERESIS,
Jonathan Cameron1d892712011-05-18 14:40:51 +010039};
40
Jonathan Cameronc8a9f802011-10-26 17:41:36 +010041#define IIO_CHAN_INFO_SHARED_BIT(type) BIT(type*2)
42#define IIO_CHAN_INFO_SEPARATE_BIT(type) BIT(type*2 + 1)
43
Jonathan Cameron5ccb3ad2012-04-15 17:41:16 +010044#define IIO_CHAN_INFO_RAW_SEPARATE_BIT \
45 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_RAW)
46#define IIO_CHAN_INFO_PROCESSED_SEPARATE_BIT \
47 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PROCESSED)
Jonathan Cameronc8a9f802011-10-26 17:41:36 +010048#define IIO_CHAN_INFO_SCALE_SEPARATE_BIT \
49 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_SCALE)
50#define IIO_CHAN_INFO_SCALE_SHARED_BIT \
51 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_SCALE)
52#define IIO_CHAN_INFO_OFFSET_SEPARATE_BIT \
53 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_OFFSET)
54#define IIO_CHAN_INFO_OFFSET_SHARED_BIT \
55 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_OFFSET)
56#define IIO_CHAN_INFO_CALIBSCALE_SEPARATE_BIT \
57 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBSCALE)
58#define IIO_CHAN_INFO_CALIBSCALE_SHARED_BIT \
59 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBSCALE)
60#define IIO_CHAN_INFO_CALIBBIAS_SEPARATE_BIT \
61 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBBIAS)
62#define IIO_CHAN_INFO_CALIBBIAS_SHARED_BIT \
63 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBBIAS)
64#define IIO_CHAN_INFO_PEAK_SEPARATE_BIT \
65 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAK)
66#define IIO_CHAN_INFO_PEAK_SHARED_BIT \
67 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAK)
68#define IIO_CHAN_INFO_PEAKSCALE_SEPARATE_BIT \
69 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAKSCALE)
70#define IIO_CHAN_INFO_PEAKSCALE_SHARED_BIT \
71 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAKSCALE)
72#define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SEPARATE_BIT \
73 IIO_CHAN_INFO_SEPARATE_BIT( \
74 IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW)
75#define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SHARED_BIT \
76 IIO_CHAN_INFO_SHARED_BIT( \
77 IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW)
78#define IIO_CHAN_INFO_AVERAGE_RAW_SEPARATE_BIT \
79 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_AVERAGE_RAW)
80#define IIO_CHAN_INFO_AVERAGE_RAW_SHARED_BIT \
81 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_AVERAGE_RAW)
Jonathan Camerondf94aba2011-11-27 11:39:12 +000082#define IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY_SHARED_BIT \
83 IIO_CHAN_INFO_SHARED_BIT( \
84 IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY)
85#define IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY_SEPARATE_BIT \
86 IIO_CHAN_INFO_SEPARATE_BIT( \
87 IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY)
Laxman Dewangance85a1c2012-04-13 16:03:31 +053088#define IIO_CHAN_INFO_SAMP_FREQ_SEPARATE_BIT \
89 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_SAMP_FREQ)
90#define IIO_CHAN_INFO_SAMP_FREQ_SHARED_BIT \
91 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_SAMP_FREQ)
Michael Hennericha6b12852012-04-27 10:58:34 +020092#define IIO_CHAN_INFO_FREQUENCY_SEPARATE_BIT \
93 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_FREQUENCY)
94#define IIO_CHAN_INFO_FREQUENCY_SHARED_BIT \
95 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_FREQUENCY)
96#define IIO_CHAN_INFO_PHASE_SEPARATE_BIT \
97 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PHASE)
98#define IIO_CHAN_INFO_PHASE_SHARED_BIT \
99 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PHASE)
Michael Hennerichb65d6212012-05-11 11:36:53 +0200100#define IIO_CHAN_INFO_HARDWAREGAIN_SEPARATE_BIT \
101 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_HARDWAREGAIN)
102#define IIO_CHAN_INFO_HARDWAREGAIN_SHARED_BIT \
103 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_HARDWAREGAIN)
srinivas pandruvada7c9ab032012-09-05 13:56:00 +0100104#define IIO_CHAN_INFO_HYSTERESIS_SEPARATE_BIT \
105 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_HYSTERESIS)
106#define IIO_CHAN_INFO_HYSTERESIS_SHARED_BIT \
107 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_HYSTERESIS)
Jonathan Cameronc8a9f802011-10-26 17:41:36 +0100108
Jonathan Cameron8310b862011-09-02 17:14:36 +0100109enum iio_endian {
110 IIO_CPU,
111 IIO_BE,
112 IIO_LE,
113};
114
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +0100115struct iio_chan_spec;
116struct iio_dev;
117
118/**
119 * struct iio_chan_spec_ext_info - Extended channel info attribute
120 * @name: Info attribute name
121 * @shared: Whether this attribute is shared between all channels.
122 * @read: Read callback for this info attribute, may be NULL.
123 * @write: Write callback for this info attribute, may be NULL.
Michael Hennerichfc6d1132012-04-27 10:58:36 +0200124 * @private: Data private to the driver.
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +0100125 */
126struct iio_chan_spec_ext_info {
127 const char *name;
128 bool shared;
Michael Hennerichfc6d1132012-04-27 10:58:36 +0200129 ssize_t (*read)(struct iio_dev *, uintptr_t private,
130 struct iio_chan_spec const *, char *buf);
131 ssize_t (*write)(struct iio_dev *, uintptr_t private,
132 struct iio_chan_spec const *, const char *buf,
133 size_t len);
134 uintptr_t private;
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +0100135};
136
Jonathan Cameron1d892712011-05-18 14:40:51 +0100137/**
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +0200138 * struct iio_enum - Enum channel info attribute
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200139 * @items: An array of strings.
140 * @num_items: Length of the item array.
141 * @set: Set callback function, may be NULL.
142 * @get: Get callback function, may be NULL.
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +0200143 *
144 * The iio_enum struct can be used to implement enum style channel attributes.
145 * Enum style attributes are those which have a set of strings which map to
146 * unsigned integer values. The IIO enum helper code takes care of mapping
147 * between value and string as well as generating a "_available" file which
148 * contains a list of all available items. The set callback will be called when
149 * the attribute is updated. The last parameter is the index to the newly
150 * activated item. The get callback will be used to query the currently active
151 * item and is supposed to return the index for it.
152 */
153struct iio_enum {
154 const char * const *items;
155 unsigned int num_items;
156 int (*set)(struct iio_dev *, const struct iio_chan_spec *, unsigned int);
157 int (*get)(struct iio_dev *, const struct iio_chan_spec *);
158};
159
160ssize_t iio_enum_available_read(struct iio_dev *indio_dev,
161 uintptr_t priv, const struct iio_chan_spec *chan, char *buf);
162ssize_t iio_enum_read(struct iio_dev *indio_dev,
163 uintptr_t priv, const struct iio_chan_spec *chan, char *buf);
164ssize_t iio_enum_write(struct iio_dev *indio_dev,
165 uintptr_t priv, const struct iio_chan_spec *chan, const char *buf,
166 size_t len);
167
168/**
169 * IIO_ENUM() - Initialize enum extended channel attribute
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200170 * @_name: Attribute name
171 * @_shared: Whether the attribute is shared between all channels
Peter Meerwaldd25b3802012-08-26 13:43:00 +0100172 * @_e: Pointer to an iio_enum struct
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +0200173 *
174 * This should usually be used together with IIO_ENUM_AVAILABLE()
175 */
176#define IIO_ENUM(_name, _shared, _e) \
177{ \
178 .name = (_name), \
179 .shared = (_shared), \
180 .read = iio_enum_read, \
181 .write = iio_enum_write, \
182 .private = (uintptr_t)(_e), \
183}
184
185/**
186 * IIO_ENUM_AVAILABLE() - Initialize enum available extended channel attribute
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200187 * @_name: Attribute name ("_available" will be appended to the name)
Peter Meerwaldd25b3802012-08-26 13:43:00 +0100188 * @_e: Pointer to an iio_enum struct
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +0200189 *
Peter Meerwaldd25b3802012-08-26 13:43:00 +0100190 * Creates a read only attribute which lists all the available enum items in a
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +0200191 * space separated list. This should usually be used together with IIO_ENUM()
192 */
193#define IIO_ENUM_AVAILABLE(_name, _e) \
194{ \
195 .name = (_name "_available"), \
196 .shared = true, \
197 .read = iio_enum_available_read, \
198 .private = (uintptr_t)(_e), \
199}
200
201/**
Jonathan Cameron1d892712011-05-18 14:40:51 +0100202 * struct iio_chan_spec - specification of a single channel
203 * @type: What type of measurement is the channel making.
Peter Meerwalda16561c2012-06-12 15:38:46 +0200204 * @channel: What number do we wish to assign the channel.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100205 * @channel2: If there is a second number for a differential
206 * channel then this is it. If modified is set then the
207 * value here specifies the modifier.
208 * @address: Driver specific identifier.
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200209 * @scan_index: Monotonic index to give ordering in scans when read
Jonathan Cameron1d892712011-05-18 14:40:51 +0100210 * from a buffer.
211 * @scan_type: Sign: 's' or 'u' to specify signed or unsigned
212 * realbits: Number of valid bits of data
213 * storage_bits: Realbits + padding
214 * shift: Shift right by this before masking out
215 * realbits.
Jonathan Cameron8310b862011-09-02 17:14:36 +0100216 * endianness: little or big endian
Jonathan Cameron1d892712011-05-18 14:40:51 +0100217 * @info_mask: What information is to be exported about this channel.
218 * This includes calibbias, scale etc.
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200219 * @event_mask: What events can this channel produce.
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +0100220 * @ext_info: Array of extended info attributes for this channel.
221 * The array is NULL terminated, the last element should
Peter Meerwald9cc113b2012-06-18 20:33:01 +0200222 * have its name field set to NULL.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100223 * @extend_name: Allows labeling of channel attributes with an
224 * informative name. Note this has no effect codes etc,
225 * unlike modifiers.
Peter Meerwald17879482012-06-12 15:38:45 +0200226 * @datasheet_name: A name used in in-kernel mapping of channels. It should
Justin P. Mattock4abf6f82012-02-29 22:00:38 -0800227 * correspond to the first name that the channel is referred
Jonathan Cameron6c63dde2011-12-05 21:56:00 +0000228 * to by in the datasheet (e.g. IND), or the nearest
229 * possible compound name (e.g. IND-INC).
Jonathan Cameron1d892712011-05-18 14:40:51 +0100230 * @modified: Does a modifier apply to this channel. What these are
231 * depends on the channel type. Modifier is set in
232 * channel2. Examples are IIO_MOD_X for axial sensors about
233 * the 'x' axis.
234 * @indexed: Specify the channel has a numerical index. If not,
Peter Meerwalda16561c2012-06-12 15:38:46 +0200235 * the channel index number will be suppressed for sysfs
236 * attributes but not for event codes.
Peter Meerwaldc3668a02012-08-26 13:43:00 +0100237 * @output: Channel is output.
Jonathan Cameronade7ef72011-09-02 17:14:45 +0100238 * @differential: Channel is differential.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100239 */
240struct iio_chan_spec {
241 enum iio_chan_type type;
242 int channel;
243 int channel2;
244 unsigned long address;
245 int scan_index;
246 struct {
247 char sign;
248 u8 realbits;
249 u8 storagebits;
250 u8 shift;
Jonathan Cameron8310b862011-09-02 17:14:36 +0100251 enum iio_endian endianness;
Jonathan Cameron1d892712011-05-18 14:40:51 +0100252 } scan_type;
Michael Hennerich1c5e6a32011-07-20 15:03:07 +0200253 long info_mask;
254 long event_mask;
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +0100255 const struct iio_chan_spec_ext_info *ext_info;
Jonathan Cameron344692b2012-04-13 10:24:21 +0100256 const char *extend_name;
Jonathan Cameron6c63dde2011-12-05 21:56:00 +0000257 const char *datasheet_name;
Jonathan Cameron1d892712011-05-18 14:40:51 +0100258 unsigned modified:1;
259 unsigned indexed:1;
Jonathan Cameronc6fc8062011-09-02 17:14:34 +0100260 unsigned output:1;
Jonathan Cameronade7ef72011-09-02 17:14:45 +0100261 unsigned differential:1;
Jonathan Cameron1d892712011-05-18 14:40:51 +0100262};
Jonathan Camerondf9c1c42011-08-12 17:56:03 +0100263
Jonathan Cameron1d892712011-05-18 14:40:51 +0100264#define IIO_ST(si, rb, sb, sh) \
265 { .sign = si, .realbits = rb, .storagebits = sb, .shift = sh }
266
Jonathan Cameron1d892712011-05-18 14:40:51 +0100267#define IIO_CHAN_SOFT_TIMESTAMP(_si) \
268 { .type = IIO_TIMESTAMP, .channel = -1, \
269 .scan_index = _si, .scan_type = IIO_ST('s', 64, 64, 0) }
270
Jonathan Cameron847ec802009-08-18 18:06:19 +0100271/**
272 * iio_get_time_ns() - utility function to get a time stamp for events etc
273 **/
274static inline s64 iio_get_time_ns(void)
275{
276 struct timespec ts;
277 /*
278 * calls getnstimeofday.
279 * If hrtimers then up to ns accurate, if not microsecond.
280 */
281 ktime_get_real_ts(&ts);
282
283 return timespec_to_ns(&ts);
284}
285
Jonathan Cameron847ec802009-08-18 18:06:19 +0100286/* Device operating modes */
287#define INDIO_DIRECT_MODE 0x01
Jonathan Cameronec3afa42011-09-21 11:15:54 +0100288#define INDIO_BUFFER_TRIGGERED 0x02
289#define INDIO_BUFFER_HARDWARE 0x08
Jonathan Cameron847ec802009-08-18 18:06:19 +0100290
Jonathan Cameronec3afa42011-09-21 11:15:54 +0100291#define INDIO_ALL_BUFFER_MODES \
292 (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE)
Jonathan Cameron847ec802009-08-18 18:06:19 +0100293
Michael Hennerich43a43602011-06-27 13:07:09 +0100294struct iio_trigger; /* forward declaration */
Jonathan Cameron7ae8cf62011-08-30 12:32:44 +0100295struct iio_dev;
Michael Hennerich43a43602011-06-27 13:07:09 +0100296
Jonathan Cameron847ec802009-08-18 18:06:19 +0100297/**
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100298 * struct iio_info - constant information about device
299 * @driver_module: module structure used to ensure correct
Jonathan Cameron847ec802009-08-18 18:06:19 +0100300 * ownership of chrdevs etc
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100301 * @event_attrs: event control attributes
302 * @attrs: general purpose device attributes
303 * @read_raw: function to request a value from the device.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100304 * mask specifies which value. Note 0 means a reading of
305 * the channel in question. Return value will specify the
306 * type of value returned by the device. val and val2 will
307 * contain the elements making up the returned value.
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100308 * @write_raw: function to write a value to the device.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100309 * Parameters are the same as for read_raw.
Michael Hennerich5c04af02011-06-27 13:07:10 +0100310 * @write_raw_get_fmt: callback function to query the expected
311 * format/precision. If not set by the driver, write_raw
312 * returns IIO_VAL_INT_PLUS_MICRO.
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100313 * @read_event_config: find out if the event is enabled.
314 * @write_event_config: set if the event is enabled.
315 * @read_event_value: read a value associated with the event. Meaning
Jonathan Cameron1d892712011-05-18 14:40:51 +0100316 * is event dependant. event_code specifies which event.
Justin P. Mattock4abf6f82012-02-29 22:00:38 -0800317 * @write_event_value: write the value associated with the event.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100318 * Meaning is event dependent.
Michael Hennerich43a43602011-06-27 13:07:09 +0100319 * @validate_trigger: function to validate the trigger when the
320 * current trigger gets changed.
Peter Meerwaldc3668a02012-08-26 13:43:00 +0100321 * @update_scan_mode: function to configure device and scan buffer when
322 * channels have changed
323 * @debugfs_reg_access: function to read or write register value of device
Jonathan Cameron847ec802009-08-18 18:06:19 +0100324 **/
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100325struct iio_info {
Jonathan Cameron847ec802009-08-18 18:06:19 +0100326 struct module *driver_module;
Jonathan Cameron847ec802009-08-18 18:06:19 +0100327 struct attribute_group *event_attrs;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100328 const struct attribute_group *attrs;
Jonathan Cameron847ec802009-08-18 18:06:19 +0100329
Jonathan Cameron1d892712011-05-18 14:40:51 +0100330 int (*read_raw)(struct iio_dev *indio_dev,
331 struct iio_chan_spec const *chan,
332 int *val,
333 int *val2,
334 long mask);
335
336 int (*write_raw)(struct iio_dev *indio_dev,
337 struct iio_chan_spec const *chan,
338 int val,
339 int val2,
340 long mask);
341
Michael Hennerich5c04af02011-06-27 13:07:10 +0100342 int (*write_raw_get_fmt)(struct iio_dev *indio_dev,
343 struct iio_chan_spec const *chan,
344 long mask);
345
Jonathan Cameron1d892712011-05-18 14:40:51 +0100346 int (*read_event_config)(struct iio_dev *indio_dev,
Jonathan Cameron330c6c52011-09-02 17:14:39 +0100347 u64 event_code);
Jonathan Cameron1d892712011-05-18 14:40:51 +0100348
349 int (*write_event_config)(struct iio_dev *indio_dev,
Jonathan Cameron330c6c52011-09-02 17:14:39 +0100350 u64 event_code,
Jonathan Cameron1d892712011-05-18 14:40:51 +0100351 int state);
352
353 int (*read_event_value)(struct iio_dev *indio_dev,
Jonathan Cameron330c6c52011-09-02 17:14:39 +0100354 u64 event_code,
Jonathan Cameron1d892712011-05-18 14:40:51 +0100355 int *val);
356 int (*write_event_value)(struct iio_dev *indio_dev,
Jonathan Cameron330c6c52011-09-02 17:14:39 +0100357 u64 event_code,
Jonathan Cameron1d892712011-05-18 14:40:51 +0100358 int val);
Michael Hennerich43a43602011-06-27 13:07:09 +0100359 int (*validate_trigger)(struct iio_dev *indio_dev,
360 struct iio_trigger *trig);
Jonathan Cameron4d5f8d32011-12-05 21:37:12 +0000361 int (*update_scan_mode)(struct iio_dev *indio_dev,
362 const unsigned long *scan_mask);
Michael Henneriche553f182012-03-01 10:51:03 +0100363 int (*debugfs_reg_access)(struct iio_dev *indio_dev,
364 unsigned reg, unsigned writeval,
365 unsigned *readval);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100366};
367
Jonathan Cameron847ec802009-08-18 18:06:19 +0100368/**
Jonathan Cameron16122442011-12-05 22:18:14 +0000369 * struct iio_buffer_setup_ops - buffer setup related callbacks
370 * @preenable: [DRIVER] function to run prior to marking buffer enabled
371 * @postenable: [DRIVER] function to run after marking buffer enabled
372 * @predisable: [DRIVER] function to run prior to marking buffer
373 * disabled
374 * @postdisable: [DRIVER] function to run after marking buffer disabled
Lars-Peter Clausen939546d2012-07-09 10:00:00 +0100375 * @validate_scan_mask: [DRIVER] function callback to check whether a given
376 * scan mask is valid for the device.
Jonathan Cameron16122442011-12-05 22:18:14 +0000377 */
378struct iio_buffer_setup_ops {
Peter Meerwald99698b42012-08-26 13:43:00 +0100379 int (*preenable)(struct iio_dev *);
380 int (*postenable)(struct iio_dev *);
381 int (*predisable)(struct iio_dev *);
382 int (*postdisable)(struct iio_dev *);
Lars-Peter Clausen939546d2012-07-09 10:00:00 +0100383 bool (*validate_scan_mask)(struct iio_dev *indio_dev,
384 const unsigned long *scan_mask);
Jonathan Cameron16122442011-12-05 22:18:14 +0000385};
386
387/**
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100388 * struct iio_dev - industrial I/O device
389 * @id: [INTERN] used to identify device internally
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100390 * @modes: [DRIVER] operating modes supported by device
391 * @currentmode: [DRIVER] current operating mode
392 * @dev: [DRIVER] device structure, should be assigned a parent
393 * and owner
Jonathan Cameron5aa96182011-08-30 12:41:06 +0100394 * @event_interface: [INTERN] event chrdevs associated with interrupt lines
Jonathan Cameron14555b12011-09-21 11:15:57 +0100395 * @buffer: [DRIVER] any buffer present
Jonathan Cameron420fe2e2012-04-21 10:09:35 +0100396 * @scan_bytes: [INTERN] num bytes captured to be fed to buffer demux
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100397 * @mlock: [INTERN] lock used to prevent simultaneous device state
398 * changes
399 * @available_scan_masks: [DRIVER] optional array of allowed bitmasks
Jonathan Cameron32b5eec2011-09-02 17:14:38 +0100400 * @masklength: [INTERN] the length of the mask established from
401 * channels
Jonathan Cameron959d2952011-12-05 21:37:13 +0000402 * @active_scan_mask: [INTERN] union of all scan masks requested by buffers
Jonathan Cameronfd6487f2012-04-21 10:09:44 +0100403 * @scan_timestamp: [INTERN] set if any buffers have requested timestamp
Jonathan Cameronf1264802012-04-21 10:09:34 +0100404 * @scan_index_timestamp:[INTERN] cache of the index to the timestamp
Jonathan Cameron14555b12011-09-21 11:15:57 +0100405 * @trig: [INTERN] current device trigger (buffer modes)
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100406 * @pollfunc: [DRIVER] function run on trigger being received
407 * @channels: [DRIVER] channel specification structure table
Peter Meerwald17879482012-06-12 15:38:45 +0200408 * @num_channels: [DRIVER] number of channels specified in @channels.
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100409 * @channel_attr_list: [INTERN] keep track of automatically created channel
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100410 * attributes
Jonathan Cameron26d25ae2011-09-02 17:14:40 +0100411 * @chan_attr_group: [INTERN] group for all attrs in base directory
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100412 * @name: [DRIVER] name of the device.
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100413 * @info: [DRIVER] callbacks and constant info from driver
Jonathan Cameronac917a82012-02-15 19:48:00 +0000414 * @info_exist_lock: [INTERN] lock to prevent use during removal
Jonathan Cameronecbf20c2012-04-10 21:11:06 +0100415 * @setup_ops: [DRIVER] callbacks to call before and after buffer
416 * enable/disable
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100417 * @chrdev: [INTERN] associated character device
Jonathan Cameron26d25ae2011-09-02 17:14:40 +0100418 * @groups: [INTERN] attribute groups
419 * @groupcounter: [INTERN] index of next attribute group
Lars-Peter Clausenbb014432011-12-19 15:23:45 +0100420 * @flags: [INTERN] file ops related flags including busy flag.
Michael Henneriche553f182012-03-01 10:51:03 +0100421 * @debugfs_dentry: [INTERN] device specific debugfs dentry.
422 * @cached_reg_addr: [INTERN] cached register address for debugfs reads.
423 */
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100424struct iio_dev {
425 int id;
Jonathan Cameron4024bc72011-08-12 17:08:53 +0100426
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100427 int modes;
428 int currentmode;
429 struct device dev;
430
Jonathan Cameron5aa96182011-08-30 12:41:06 +0100431 struct iio_event_interface *event_interface;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100432
Jonathan Cameron14555b12011-09-21 11:15:57 +0100433 struct iio_buffer *buffer;
Jonathan Cameron420fe2e2012-04-21 10:09:35 +0100434 int scan_bytes;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100435 struct mutex mlock;
436
Michael Hennerichcd4361c2012-02-22 13:16:49 +0100437 const unsigned long *available_scan_masks;
Jonathan Cameron32b5eec2011-09-02 17:14:38 +0100438 unsigned masklength;
Michael Hennerichcd4361c2012-02-22 13:16:49 +0100439 const unsigned long *active_scan_mask;
Jonathan Cameronfd6487f2012-04-21 10:09:44 +0100440 bool scan_timestamp;
Jonathan Cameronf1264802012-04-21 10:09:34 +0100441 unsigned scan_index_timestamp;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100442 struct iio_trigger *trig;
443 struct iio_poll_func *pollfunc;
444
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100445 struct iio_chan_spec const *channels;
446 int num_channels;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100447
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100448 struct list_head channel_attr_list;
Jonathan Cameron26d25ae2011-09-02 17:14:40 +0100449 struct attribute_group chan_attr_group;
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100450 const char *name;
451 const struct iio_info *info;
Jonathan Cameronac917a82012-02-15 19:48:00 +0000452 struct mutex info_exist_lock;
Jonathan Cameron16122442011-12-05 22:18:14 +0000453 const struct iio_buffer_setup_ops *setup_ops;
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100454 struct cdev chrdev;
Jonathan Cameron26d25ae2011-09-02 17:14:40 +0100455#define IIO_MAX_GROUPS 6
456 const struct attribute_group *groups[IIO_MAX_GROUPS + 1];
457 int groupcounter;
Lars-Peter Clausenbb014432011-12-19 15:23:45 +0100458
459 unsigned long flags;
Michael Henneriche553f182012-03-01 10:51:03 +0100460#if defined(CONFIG_DEBUG_FS)
461 struct dentry *debugfs_dentry;
462 unsigned cached_reg_addr;
463#endif
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100464};
465
466/**
Jonathan Cameron5fb21c82011-12-05 21:37:10 +0000467 * iio_find_channel_from_si() - get channel from its scan index
468 * @indio_dev: device
469 * @si: scan index to match
470 */
471const struct iio_chan_spec
472*iio_find_channel_from_si(struct iio_dev *indio_dev, int si);
473
474/**
Jonathan Cameron847ec802009-08-18 18:06:19 +0100475 * iio_device_register() - register a device with the IIO subsystem
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100476 * @indio_dev: Device structure filled by the device driver
Jonathan Cameron847ec802009-08-18 18:06:19 +0100477 **/
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100478int iio_device_register(struct iio_dev *indio_dev);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100479
480/**
481 * iio_device_unregister() - unregister a device from the IIO subsystem
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100482 * @indio_dev: Device structure representing the device.
Jonathan Cameron847ec802009-08-18 18:06:19 +0100483 **/
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100484void iio_device_unregister(struct iio_dev *indio_dev);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100485
486/**
Jonathan Cameron847ec802009-08-18 18:06:19 +0100487 * iio_push_event() - try to add event to the list for userspace reading
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100488 * @indio_dev: IIO device structure
Jonathan Cameron847ec802009-08-18 18:06:19 +0100489 * @ev_code: What event
Randy Dunlap4c572602009-10-04 19:34:02 -0700490 * @timestamp: When the event occurred
Jonathan Cameron847ec802009-08-18 18:06:19 +0100491 **/
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100492int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100493
Jonathan Cameron5aaaeba2010-05-04 14:43:00 +0100494extern struct bus_type iio_bus_type;
Jonathan Cameron847ec802009-08-18 18:06:19 +0100495
496/**
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200497 * iio_device_put() - reference counted deallocation of struct device
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200498 * @indio_dev: IIO device structure containing the device
Jonathan Cameron847ec802009-08-18 18:06:19 +0100499 **/
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200500static inline void iio_device_put(struct iio_dev *indio_dev)
Jonathan Cameron847ec802009-08-18 18:06:19 +0100501{
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100502 if (indio_dev)
503 put_device(&indio_dev->dev);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100504};
505
Lars-Peter Clausen7a7913f2012-05-12 15:39:32 +0200506/**
507 * dev_to_iio_dev() - Get IIO device struct from a device struct
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200508 * @dev: The device embedded in the IIO device
Lars-Peter Clausen7a7913f2012-05-12 15:39:32 +0200509 *
510 * Note: The device must be a IIO device, otherwise the result is undefined.
511 */
512static inline struct iio_dev *dev_to_iio_dev(struct device *dev)
513{
514 return container_of(dev, struct iio_dev, dev);
515}
516
Lars-Peter Clausene4e8b772012-06-04 10:50:02 +0200517/**
518 * iio_device_get() - increment reference count for the device
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200519 * @indio_dev: IIO device structure
Lars-Peter Clausene4e8b772012-06-04 10:50:02 +0200520 *
521 * Returns: The passed IIO device
522 **/
523static inline struct iio_dev *iio_device_get(struct iio_dev *indio_dev)
524{
525 return indio_dev ? dev_to_iio_dev(get_device(&indio_dev->dev)) : NULL;
526}
527
Lars-Peter Clausen2d66f382012-08-10 17:36:00 +0100528
529/**
530 * iio_device_set_drvdata() - Set device driver data
531 * @indio_dev: IIO device structure
532 * @data: Driver specific data
533 *
534 * Allows to attach an arbitrary pointer to an IIO device, which can later be
535 * retrieved by iio_device_get_drvdata().
536 */
537static inline void iio_device_set_drvdata(struct iio_dev *indio_dev, void *data)
538{
539 dev_set_drvdata(&indio_dev->dev, data);
540}
541
542/**
543 * iio_device_get_drvdata() - Get device driver data
544 * @indio_dev: IIO device structure
545 *
546 * Returns the data previously set with iio_device_set_drvdata()
547 */
548static inline void *iio_device_get_drvdata(struct iio_dev *indio_dev)
549{
550 return dev_get_drvdata(&indio_dev->dev);
551}
552
Jonathan Cameron6f7c8ee2011-04-15 18:55:56 +0100553/* Can we make this smaller? */
554#define IIO_ALIGN L1_CACHE_BYTES
Jonathan Cameron847ec802009-08-18 18:06:19 +0100555/**
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200556 * iio_device_alloc() - allocate an iio_dev from a driver
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200557 * @sizeof_priv: Space to allocate for private structure.
Jonathan Cameron847ec802009-08-18 18:06:19 +0100558 **/
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200559struct iio_dev *iio_device_alloc(int sizeof_priv);
Jonathan Cameron6f7c8ee2011-04-15 18:55:56 +0100560
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100561static inline void *iio_priv(const struct iio_dev *indio_dev)
Jonathan Cameron6f7c8ee2011-04-15 18:55:56 +0100562{
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100563 return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN);
Jonathan Cameron6f7c8ee2011-04-15 18:55:56 +0100564}
565
566static inline struct iio_dev *iio_priv_to_dev(void *priv)
567{
568 return (struct iio_dev *)((char *)priv -
569 ALIGN(sizeof(struct iio_dev), IIO_ALIGN));
570}
Jonathan Cameron847ec802009-08-18 18:06:19 +0100571
572/**
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200573 * iio_device_free() - free an iio_dev from a driver
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200574 * @indio_dev: the iio_dev associated with the device
Jonathan Cameron847ec802009-08-18 18:06:19 +0100575 **/
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200576void iio_device_free(struct iio_dev *indio_dev);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100577
578/**
Jonathan Cameron14555b12011-09-21 11:15:57 +0100579 * iio_buffer_enabled() - helper function to test if the buffer is enabled
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200580 * @indio_dev: IIO device structure for device
Jonathan Cameron847ec802009-08-18 18:06:19 +0100581 **/
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100582static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
Jonathan Cameron847ec802009-08-18 18:06:19 +0100583{
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100584 return indio_dev->currentmode
Jonathan Cameronec3afa42011-09-21 11:15:54 +0100585 & (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100586};
587
Michael Henneriche553f182012-03-01 10:51:03 +0100588/**
589 * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200590 * @indio_dev: IIO device structure for device
Michael Henneriche553f182012-03-01 10:51:03 +0100591 **/
592#if defined(CONFIG_DEBUG_FS)
593static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
594{
595 return indio_dev->debugfs_dentry;
596};
597#else
598static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
599{
600 return NULL;
601};
602#endif
603
Jonathan Cameron847ec802009-08-18 18:06:19 +0100604#endif /* _INDUSTRIAL_IO_H_ */