blob: 256a90a1bea681fde6473e2d5d74bc93ea868a87 [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,
Peter Meerwald899d90b2013-09-08 16:20:00 +010039 IIO_CHAN_INFO_INT_TIME,
Jonathan Cameron1d892712011-05-18 14:40:51 +010040};
41
Jonathan Cameron37044322013-09-08 14:57:00 +010042enum iio_shared_by {
43 IIO_SEPARATE,
Jonathan Cameronc006ec82013-09-08 14:57:00 +010044 IIO_SHARED_BY_TYPE,
45 IIO_SHARED_BY_DIR,
46 IIO_SHARED_BY_ALL
Jonathan Cameron37044322013-09-08 14:57:00 +010047};
48
Jonathan Cameron8310b862011-09-02 17:14:36 +010049enum iio_endian {
50 IIO_CPU,
51 IIO_BE,
52 IIO_LE,
53};
54
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +010055struct iio_chan_spec;
56struct iio_dev;
57
58/**
59 * struct iio_chan_spec_ext_info - Extended channel info attribute
60 * @name: Info attribute name
61 * @shared: Whether this attribute is shared between all channels.
62 * @read: Read callback for this info attribute, may be NULL.
63 * @write: Write callback for this info attribute, may be NULL.
Michael Hennerichfc6d1132012-04-27 10:58:36 +020064 * @private: Data private to the driver.
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +010065 */
66struct iio_chan_spec_ext_info {
67 const char *name;
Jonathan Cameron37044322013-09-08 14:57:00 +010068 enum iio_shared_by shared;
Michael Hennerichfc6d1132012-04-27 10:58:36 +020069 ssize_t (*read)(struct iio_dev *, uintptr_t private,
70 struct iio_chan_spec const *, char *buf);
71 ssize_t (*write)(struct iio_dev *, uintptr_t private,
72 struct iio_chan_spec const *, const char *buf,
73 size_t len);
74 uintptr_t private;
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +010075};
76
Jonathan Cameron1d892712011-05-18 14:40:51 +010077/**
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +020078 * struct iio_enum - Enum channel info attribute
Peter Meerwald7dcd7b62012-06-12 15:38:48 +020079 * @items: An array of strings.
80 * @num_items: Length of the item array.
81 * @set: Set callback function, may be NULL.
82 * @get: Get callback function, may be NULL.
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +020083 *
84 * The iio_enum struct can be used to implement enum style channel attributes.
85 * Enum style attributes are those which have a set of strings which map to
86 * unsigned integer values. The IIO enum helper code takes care of mapping
87 * between value and string as well as generating a "_available" file which
88 * contains a list of all available items. The set callback will be called when
89 * the attribute is updated. The last parameter is the index to the newly
90 * activated item. The get callback will be used to query the currently active
91 * item and is supposed to return the index for it.
92 */
93struct iio_enum {
94 const char * const *items;
95 unsigned int num_items;
96 int (*set)(struct iio_dev *, const struct iio_chan_spec *, unsigned int);
97 int (*get)(struct iio_dev *, const struct iio_chan_spec *);
98};
99
100ssize_t iio_enum_available_read(struct iio_dev *indio_dev,
101 uintptr_t priv, const struct iio_chan_spec *chan, char *buf);
102ssize_t iio_enum_read(struct iio_dev *indio_dev,
103 uintptr_t priv, const struct iio_chan_spec *chan, char *buf);
104ssize_t iio_enum_write(struct iio_dev *indio_dev,
105 uintptr_t priv, const struct iio_chan_spec *chan, const char *buf,
106 size_t len);
107
108/**
109 * IIO_ENUM() - Initialize enum extended channel attribute
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200110 * @_name: Attribute name
111 * @_shared: Whether the attribute is shared between all channels
Peter Meerwaldd25b3802012-08-26 13:43:00 +0100112 * @_e: Pointer to an iio_enum struct
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +0200113 *
114 * This should usually be used together with IIO_ENUM_AVAILABLE()
115 */
116#define IIO_ENUM(_name, _shared, _e) \
117{ \
118 .name = (_name), \
119 .shared = (_shared), \
120 .read = iio_enum_read, \
121 .write = iio_enum_write, \
122 .private = (uintptr_t)(_e), \
123}
124
125/**
126 * IIO_ENUM_AVAILABLE() - Initialize enum available extended channel attribute
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200127 * @_name: Attribute name ("_available" will be appended to the name)
Peter Meerwaldd25b3802012-08-26 13:43:00 +0100128 * @_e: Pointer to an iio_enum struct
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +0200129 *
Peter Meerwaldd25b3802012-08-26 13:43:00 +0100130 * Creates a read only attribute which lists all the available enum items in a
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +0200131 * space separated list. This should usually be used together with IIO_ENUM()
132 */
133#define IIO_ENUM_AVAILABLE(_name, _e) \
134{ \
135 .name = (_name "_available"), \
Jonathan Cameron37044322013-09-08 14:57:00 +0100136 .shared = IIO_SHARED_BY_TYPE, \
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +0200137 .read = iio_enum_available_read, \
138 .private = (uintptr_t)(_e), \
139}
140
141/**
Lars-Peter Clausenb4e3ac02013-10-07 15:11:00 +0100142 * struct iio_event_spec - specification for a channel event
143 * @type: Type of the event
144 * @dir: Direction of the event
145 * @mask_separate: Bit mask of enum iio_event_info values. Attributes
146 * set in this mask will be registered per channel.
147 * @mask_shared_by_type: Bit mask of enum iio_event_info values. Attributes
148 * set in this mask will be shared by channel type.
149 * @mask_shared_by_dir: Bit mask of enum iio_event_info values. Attributes
150 * set in this mask will be shared by channel type and
151 * direction.
152 * @mask_shared_by_all: Bit mask of enum iio_event_info values. Attributes
153 * set in this mask will be shared by all channels.
154 */
155struct iio_event_spec {
156 enum iio_event_type type;
157 enum iio_event_direction dir;
158 unsigned long mask_separate;
159 unsigned long mask_shared_by_type;
160 unsigned long mask_shared_by_dir;
161 unsigned long mask_shared_by_all;
162};
163
164/**
Jonathan Cameron1d892712011-05-18 14:40:51 +0100165 * struct iio_chan_spec - specification of a single channel
166 * @type: What type of measurement is the channel making.
Peter Meerwalda16561c2012-06-12 15:38:46 +0200167 * @channel: What number do we wish to assign the channel.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100168 * @channel2: If there is a second number for a differential
169 * channel then this is it. If modified is set then the
170 * value here specifies the modifier.
171 * @address: Driver specific identifier.
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200172 * @scan_index: Monotonic index to give ordering in scans when read
Jonathan Cameron1d892712011-05-18 14:40:51 +0100173 * from a buffer.
174 * @scan_type: Sign: 's' or 'u' to specify signed or unsigned
175 * realbits: Number of valid bits of data
176 * storage_bits: Realbits + padding
177 * shift: Shift right by this before masking out
178 * realbits.
Jonathan Cameron8310b862011-09-02 17:14:36 +0100179 * endianness: little or big endian
Jonathan Cameron8655cc42013-02-19 21:10:30 +0000180 * @info_mask_separate: What information is to be exported that is specific to
181 * this channel.
182 * @info_mask_shared_by_type: What information is to be exported that is shared
Jonathan Cameron9761696f2013-09-08 14:57:00 +0100183 * by all channels of the same type.
Jonathan Cameronc006ec82013-09-08 14:57:00 +0100184 * @info_mask_shared_by_dir: What information is to be exported that is shared
185 * by all channels of the same direction.
186 * @info_mask_shared_by_all: What information is to be exported that is shared
187 * by all channels.
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200188 * @event_mask: What events can this channel produce.
Lars-Peter Clausenb4e3ac02013-10-07 15:11:00 +0100189 * @event_spec: Array of events which should be registered for this
190 * channel.
191 * @num_event_specs: Size of the event_spec array.
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +0100192 * @ext_info: Array of extended info attributes for this channel.
193 * The array is NULL terminated, the last element should
Peter Meerwald9cc113b2012-06-18 20:33:01 +0200194 * have its name field set to NULL.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100195 * @extend_name: Allows labeling of channel attributes with an
196 * informative name. Note this has no effect codes etc,
197 * unlike modifiers.
Peter Meerwald17879482012-06-12 15:38:45 +0200198 * @datasheet_name: A name used in in-kernel mapping of channels. It should
Justin P. Mattock4abf6f82012-02-29 22:00:38 -0800199 * correspond to the first name that the channel is referred
Jonathan Cameron6c63dde2011-12-05 21:56:00 +0000200 * to by in the datasheet (e.g. IND), or the nearest
201 * possible compound name (e.g. IND-INC).
Jonathan Cameron1d892712011-05-18 14:40:51 +0100202 * @modified: Does a modifier apply to this channel. What these are
203 * depends on the channel type. Modifier is set in
204 * channel2. Examples are IIO_MOD_X for axial sensors about
205 * the 'x' axis.
206 * @indexed: Specify the channel has a numerical index. If not,
Peter Meerwalda16561c2012-06-12 15:38:46 +0200207 * the channel index number will be suppressed for sysfs
208 * attributes but not for event codes.
Peter Meerwaldc3668a02012-08-26 13:43:00 +0100209 * @output: Channel is output.
Jonathan Cameronade7ef72011-09-02 17:14:45 +0100210 * @differential: Channel is differential.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100211 */
212struct iio_chan_spec {
213 enum iio_chan_type type;
214 int channel;
215 int channel2;
216 unsigned long address;
217 int scan_index;
218 struct {
219 char sign;
220 u8 realbits;
221 u8 storagebits;
222 u8 shift;
Jonathan Cameron8310b862011-09-02 17:14:36 +0100223 enum iio_endian endianness;
Jonathan Cameron1d892712011-05-18 14:40:51 +0100224 } scan_type;
Jonathan Cameron8655cc42013-02-19 21:10:30 +0000225 long info_mask_separate;
226 long info_mask_shared_by_type;
Jonathan Cameronc006ec82013-09-08 14:57:00 +0100227 long info_mask_shared_by_dir;
228 long info_mask_shared_by_all;
Michael Hennerich1c5e6a32011-07-20 15:03:07 +0200229 long event_mask;
Lars-Peter Clausenb4e3ac02013-10-07 15:11:00 +0100230 const struct iio_event_spec *event_spec;
231 unsigned int num_event_specs;
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +0100232 const struct iio_chan_spec_ext_info *ext_info;
Jonathan Cameron344692b2012-04-13 10:24:21 +0100233 const char *extend_name;
Jonathan Cameron6c63dde2011-12-05 21:56:00 +0000234 const char *datasheet_name;
Jonathan Cameron1d892712011-05-18 14:40:51 +0100235 unsigned modified:1;
236 unsigned indexed:1;
Jonathan Cameronc6fc8062011-09-02 17:14:34 +0100237 unsigned output:1;
Jonathan Cameronade7ef72011-09-02 17:14:45 +0100238 unsigned differential:1;
Jonathan Cameron1d892712011-05-18 14:40:51 +0100239};
Jonathan Camerondf9c1c42011-08-12 17:56:03 +0100240
Lars-Peter Clausen48e44ce2012-09-17 13:17:00 +0100241
242/**
243 * iio_channel_has_info() - Checks whether a channel supports a info attribute
244 * @chan: The channel to be queried
245 * @type: Type of the info attribute to be checked
246 *
247 * Returns true if the channels supports reporting values for the given info
248 * attribute type, false otherwise.
249 */
250static inline bool iio_channel_has_info(const struct iio_chan_spec *chan,
251 enum iio_chan_info_enum type)
252{
Alexandre Belloni1c297a62013-07-01 15:20:00 +0100253 return (chan->info_mask_separate & BIT(type)) |
Jonathan Cameronc006ec82013-09-08 14:57:00 +0100254 (chan->info_mask_shared_by_type & BIT(type)) |
255 (chan->info_mask_shared_by_dir & BIT(type)) |
256 (chan->info_mask_shared_by_all & BIT(type));
Lars-Peter Clausen48e44ce2012-09-17 13:17:00 +0100257}
258
Jonathan Cameron1d892712011-05-18 14:40:51 +0100259#define IIO_ST(si, rb, sb, sh) \
260 { .sign = si, .realbits = rb, .storagebits = sb, .shift = sh }
261
Jonathan Cameron1d892712011-05-18 14:40:51 +0100262#define IIO_CHAN_SOFT_TIMESTAMP(_si) \
263 { .type = IIO_TIMESTAMP, .channel = -1, \
264 .scan_index = _si, .scan_type = IIO_ST('s', 64, 64, 0) }
265
Jonathan Cameron847ec802009-08-18 18:06:19 +0100266/**
267 * iio_get_time_ns() - utility function to get a time stamp for events etc
268 **/
269static inline s64 iio_get_time_ns(void)
270{
271 struct timespec ts;
272 /*
273 * calls getnstimeofday.
274 * If hrtimers then up to ns accurate, if not microsecond.
275 */
276 ktime_get_real_ts(&ts);
277
278 return timespec_to_ns(&ts);
279}
280
Jonathan Cameron847ec802009-08-18 18:06:19 +0100281/* Device operating modes */
282#define INDIO_DIRECT_MODE 0x01
Jonathan Cameronec3afa42011-09-21 11:15:54 +0100283#define INDIO_BUFFER_TRIGGERED 0x02
284#define INDIO_BUFFER_HARDWARE 0x08
Jonathan Cameron847ec802009-08-18 18:06:19 +0100285
Jonathan Cameronec3afa42011-09-21 11:15:54 +0100286#define INDIO_ALL_BUFFER_MODES \
287 (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE)
Jonathan Cameron847ec802009-08-18 18:06:19 +0100288
Michael Hennerich43a43602011-06-27 13:07:09 +0100289struct iio_trigger; /* forward declaration */
Jonathan Cameron7ae8cf62011-08-30 12:32:44 +0100290struct iio_dev;
Michael Hennerich43a43602011-06-27 13:07:09 +0100291
Jonathan Cameron847ec802009-08-18 18:06:19 +0100292/**
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100293 * struct iio_info - constant information about device
294 * @driver_module: module structure used to ensure correct
Jonathan Cameron847ec802009-08-18 18:06:19 +0100295 * ownership of chrdevs etc
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100296 * @event_attrs: event control attributes
297 * @attrs: general purpose device attributes
298 * @read_raw: function to request a value from the device.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100299 * mask specifies which value. Note 0 means a reading of
300 * the channel in question. Return value will specify the
301 * type of value returned by the device. val and val2 will
302 * contain the elements making up the returned value.
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100303 * @write_raw: function to write a value to the device.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100304 * Parameters are the same as for read_raw.
Michael Hennerich5c04af02011-06-27 13:07:10 +0100305 * @write_raw_get_fmt: callback function to query the expected
306 * format/precision. If not set by the driver, write_raw
307 * returns IIO_VAL_INT_PLUS_MICRO.
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100308 * @read_event_config: find out if the event is enabled.
309 * @write_event_config: set if the event is enabled.
310 * @read_event_value: read a value associated with the event. Meaning
Jonathan Cameron1d892712011-05-18 14:40:51 +0100311 * is event dependant. event_code specifies which event.
Justin P. Mattock4abf6f82012-02-29 22:00:38 -0800312 * @write_event_value: write the value associated with the event.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100313 * Meaning is event dependent.
Lars-Peter Clausenb4e3ac02013-10-07 15:11:00 +0100314 * @read_event_config_new: find out if the event is enabled. New style interface.
315 * @write_event_config_new: set if the event is enabled. New style interface.
316 * @read_event_value_new: read a configuration value associated with the event.
317 * New style interface.
318 * @write_event_value_new: write a configuration value for the event. New style
319 * interface.
Michael Hennerich43a43602011-06-27 13:07:09 +0100320 * @validate_trigger: function to validate the trigger when the
321 * current trigger gets changed.
Peter Meerwaldc3668a02012-08-26 13:43:00 +0100322 * @update_scan_mode: function to configure device and scan buffer when
323 * channels have changed
324 * @debugfs_reg_access: function to read or write register value of device
Jonathan Cameron847ec802009-08-18 18:06:19 +0100325 **/
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100326struct iio_info {
Jonathan Cameron847ec802009-08-18 18:06:19 +0100327 struct module *driver_module;
Jonathan Cameron847ec802009-08-18 18:06:19 +0100328 struct attribute_group *event_attrs;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100329 const struct attribute_group *attrs;
Jonathan Cameron847ec802009-08-18 18:06:19 +0100330
Jonathan Cameron1d892712011-05-18 14:40:51 +0100331 int (*read_raw)(struct iio_dev *indio_dev,
332 struct iio_chan_spec const *chan,
333 int *val,
334 int *val2,
335 long mask);
336
337 int (*write_raw)(struct iio_dev *indio_dev,
338 struct iio_chan_spec const *chan,
339 int val,
340 int val2,
341 long mask);
342
Michael Hennerich5c04af02011-06-27 13:07:10 +0100343 int (*write_raw_get_fmt)(struct iio_dev *indio_dev,
344 struct iio_chan_spec const *chan,
345 long mask);
346
Jonathan Cameron1d892712011-05-18 14:40:51 +0100347 int (*read_event_config)(struct iio_dev *indio_dev,
Jonathan Cameron330c6c52011-09-02 17:14:39 +0100348 u64 event_code);
Jonathan Cameron1d892712011-05-18 14:40:51 +0100349
350 int (*write_event_config)(struct iio_dev *indio_dev,
Jonathan Cameron330c6c52011-09-02 17:14:39 +0100351 u64 event_code,
Jonathan Cameron1d892712011-05-18 14:40:51 +0100352 int state);
353
354 int (*read_event_value)(struct iio_dev *indio_dev,
Jonathan Cameron330c6c52011-09-02 17:14:39 +0100355 u64 event_code,
Jonathan Cameron1d892712011-05-18 14:40:51 +0100356 int *val);
357 int (*write_event_value)(struct iio_dev *indio_dev,
Jonathan Cameron330c6c52011-09-02 17:14:39 +0100358 u64 event_code,
Jonathan Cameron1d892712011-05-18 14:40:51 +0100359 int val);
Lars-Peter Clausenb4e3ac02013-10-07 15:11:00 +0100360
361 int (*read_event_config_new)(struct iio_dev *indio_dev,
362 const struct iio_chan_spec *chan,
363 enum iio_event_type type,
364 enum iio_event_direction dir);
365
366 int (*write_event_config_new)(struct iio_dev *indio_dev,
367 const struct iio_chan_spec *chan,
368 enum iio_event_type type,
369 enum iio_event_direction dir,
370 int state);
371
372 int (*read_event_value_new)(struct iio_dev *indio_dev,
373 const struct iio_chan_spec *chan,
374 enum iio_event_type type,
375 enum iio_event_direction dir,
376 enum iio_event_info info, int *val, int *val2);
377
378 int (*write_event_value_new)(struct iio_dev *indio_dev,
379 const struct iio_chan_spec *chan,
380 enum iio_event_type type,
381 enum iio_event_direction dir,
382 enum iio_event_info info, int val, int val2);
383
Michael Hennerich43a43602011-06-27 13:07:09 +0100384 int (*validate_trigger)(struct iio_dev *indio_dev,
385 struct iio_trigger *trig);
Jonathan Cameron4d5f8d32011-12-05 21:37:12 +0000386 int (*update_scan_mode)(struct iio_dev *indio_dev,
387 const unsigned long *scan_mask);
Michael Henneriche553f182012-03-01 10:51:03 +0100388 int (*debugfs_reg_access)(struct iio_dev *indio_dev,
389 unsigned reg, unsigned writeval,
390 unsigned *readval);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100391};
392
Jonathan Cameron847ec802009-08-18 18:06:19 +0100393/**
Jonathan Cameron16122442011-12-05 22:18:14 +0000394 * struct iio_buffer_setup_ops - buffer setup related callbacks
395 * @preenable: [DRIVER] function to run prior to marking buffer enabled
396 * @postenable: [DRIVER] function to run after marking buffer enabled
397 * @predisable: [DRIVER] function to run prior to marking buffer
398 * disabled
399 * @postdisable: [DRIVER] function to run after marking buffer disabled
Lars-Peter Clausen939546d2012-07-09 10:00:00 +0100400 * @validate_scan_mask: [DRIVER] function callback to check whether a given
401 * scan mask is valid for the device.
Jonathan Cameron16122442011-12-05 22:18:14 +0000402 */
403struct iio_buffer_setup_ops {
Peter Meerwald99698b42012-08-26 13:43:00 +0100404 int (*preenable)(struct iio_dev *);
405 int (*postenable)(struct iio_dev *);
406 int (*predisable)(struct iio_dev *);
407 int (*postdisable)(struct iio_dev *);
Lars-Peter Clausen939546d2012-07-09 10:00:00 +0100408 bool (*validate_scan_mask)(struct iio_dev *indio_dev,
409 const unsigned long *scan_mask);
Jonathan Cameron16122442011-12-05 22:18:14 +0000410};
411
412/**
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100413 * struct iio_dev - industrial I/O device
414 * @id: [INTERN] used to identify device internally
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100415 * @modes: [DRIVER] operating modes supported by device
416 * @currentmode: [DRIVER] current operating mode
417 * @dev: [DRIVER] device structure, should be assigned a parent
418 * and owner
Jonathan Cameron5aa96182011-08-30 12:41:06 +0100419 * @event_interface: [INTERN] event chrdevs associated with interrupt lines
Jonathan Cameron14555b12011-09-21 11:15:57 +0100420 * @buffer: [DRIVER] any buffer present
Jonathan Cameron84b36ce2012-06-30 20:06:00 +0100421 * @buffer_list: [INTERN] list of all buffers currently attached
Jonathan Cameron420fe2e2012-04-21 10:09:35 +0100422 * @scan_bytes: [INTERN] num bytes captured to be fed to buffer demux
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100423 * @mlock: [INTERN] lock used to prevent simultaneous device state
424 * changes
425 * @available_scan_masks: [DRIVER] optional array of allowed bitmasks
Jonathan Cameron32b5eec2011-09-02 17:14:38 +0100426 * @masklength: [INTERN] the length of the mask established from
427 * channels
Jonathan Cameron959d2952011-12-05 21:37:13 +0000428 * @active_scan_mask: [INTERN] union of all scan masks requested by buffers
Jonathan Cameronfd6487f2012-04-21 10:09:44 +0100429 * @scan_timestamp: [INTERN] set if any buffers have requested timestamp
Jonathan Cameronf1264802012-04-21 10:09:34 +0100430 * @scan_index_timestamp:[INTERN] cache of the index to the timestamp
Jonathan Cameron14555b12011-09-21 11:15:57 +0100431 * @trig: [INTERN] current device trigger (buffer modes)
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100432 * @pollfunc: [DRIVER] function run on trigger being received
433 * @channels: [DRIVER] channel specification structure table
Peter Meerwald17879482012-06-12 15:38:45 +0200434 * @num_channels: [DRIVER] number of channels specified in @channels.
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100435 * @channel_attr_list: [INTERN] keep track of automatically created channel
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100436 * attributes
Jonathan Cameron26d25ae2011-09-02 17:14:40 +0100437 * @chan_attr_group: [INTERN] group for all attrs in base directory
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100438 * @name: [DRIVER] name of the device.
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100439 * @info: [DRIVER] callbacks and constant info from driver
Jonathan Cameronac917a82012-02-15 19:48:00 +0000440 * @info_exist_lock: [INTERN] lock to prevent use during removal
Jonathan Cameronecbf20c2012-04-10 21:11:06 +0100441 * @setup_ops: [DRIVER] callbacks to call before and after buffer
442 * enable/disable
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100443 * @chrdev: [INTERN] associated character device
Jonathan Cameron26d25ae2011-09-02 17:14:40 +0100444 * @groups: [INTERN] attribute groups
445 * @groupcounter: [INTERN] index of next attribute group
Lars-Peter Clausenbb014432011-12-19 15:23:45 +0100446 * @flags: [INTERN] file ops related flags including busy flag.
Michael Henneriche553f182012-03-01 10:51:03 +0100447 * @debugfs_dentry: [INTERN] device specific debugfs dentry.
448 * @cached_reg_addr: [INTERN] cached register address for debugfs reads.
449 */
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100450struct iio_dev {
451 int id;
Jonathan Cameron4024bc72011-08-12 17:08:53 +0100452
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100453 int modes;
454 int currentmode;
455 struct device dev;
456
Jonathan Cameron5aa96182011-08-30 12:41:06 +0100457 struct iio_event_interface *event_interface;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100458
Jonathan Cameron14555b12011-09-21 11:15:57 +0100459 struct iio_buffer *buffer;
Jonathan Cameron84b36ce2012-06-30 20:06:00 +0100460 struct list_head buffer_list;
Jonathan Cameron420fe2e2012-04-21 10:09:35 +0100461 int scan_bytes;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100462 struct mutex mlock;
463
Michael Hennerichcd4361c2012-02-22 13:16:49 +0100464 const unsigned long *available_scan_masks;
Jonathan Cameron32b5eec2011-09-02 17:14:38 +0100465 unsigned masklength;
Michael Hennerichcd4361c2012-02-22 13:16:49 +0100466 const unsigned long *active_scan_mask;
Jonathan Cameronfd6487f2012-04-21 10:09:44 +0100467 bool scan_timestamp;
Jonathan Cameronf1264802012-04-21 10:09:34 +0100468 unsigned scan_index_timestamp;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100469 struct iio_trigger *trig;
470 struct iio_poll_func *pollfunc;
471
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100472 struct iio_chan_spec const *channels;
473 int num_channels;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100474
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100475 struct list_head channel_attr_list;
Jonathan Cameron26d25ae2011-09-02 17:14:40 +0100476 struct attribute_group chan_attr_group;
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100477 const char *name;
478 const struct iio_info *info;
Jonathan Cameronac917a82012-02-15 19:48:00 +0000479 struct mutex info_exist_lock;
Jonathan Cameron16122442011-12-05 22:18:14 +0000480 const struct iio_buffer_setup_ops *setup_ops;
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100481 struct cdev chrdev;
Jonathan Cameron26d25ae2011-09-02 17:14:40 +0100482#define IIO_MAX_GROUPS 6
483 const struct attribute_group *groups[IIO_MAX_GROUPS + 1];
484 int groupcounter;
Lars-Peter Clausenbb014432011-12-19 15:23:45 +0100485
486 unsigned long flags;
Michael Henneriche553f182012-03-01 10:51:03 +0100487#if defined(CONFIG_DEBUG_FS)
488 struct dentry *debugfs_dentry;
489 unsigned cached_reg_addr;
490#endif
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100491};
492
493/**
Jonathan Cameron5fb21c82011-12-05 21:37:10 +0000494 * iio_find_channel_from_si() - get channel from its scan index
495 * @indio_dev: device
496 * @si: scan index to match
497 */
498const struct iio_chan_spec
499*iio_find_channel_from_si(struct iio_dev *indio_dev, int si);
500
501/**
Jonathan Cameron847ec802009-08-18 18:06:19 +0100502 * iio_device_register() - register a device with the IIO subsystem
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100503 * @indio_dev: Device structure filled by the device driver
Jonathan Cameron847ec802009-08-18 18:06:19 +0100504 **/
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100505int iio_device_register(struct iio_dev *indio_dev);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100506
507/**
508 * iio_device_unregister() - unregister a device from the IIO subsystem
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100509 * @indio_dev: Device structure representing the device.
Jonathan Cameron847ec802009-08-18 18:06:19 +0100510 **/
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100511void iio_device_unregister(struct iio_dev *indio_dev);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100512
513/**
Jonathan Cameron847ec802009-08-18 18:06:19 +0100514 * iio_push_event() - try to add event to the list for userspace reading
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100515 * @indio_dev: IIO device structure
Jonathan Cameron847ec802009-08-18 18:06:19 +0100516 * @ev_code: What event
Randy Dunlap4c572602009-10-04 19:34:02 -0700517 * @timestamp: When the event occurred
Jonathan Cameron847ec802009-08-18 18:06:19 +0100518 **/
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100519int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100520
Jonathan Cameron5aaaeba2010-05-04 14:43:00 +0100521extern struct bus_type iio_bus_type;
Jonathan Cameron847ec802009-08-18 18:06:19 +0100522
523/**
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200524 * iio_device_put() - reference counted deallocation of struct device
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200525 * @indio_dev: IIO device structure containing the device
Jonathan Cameron847ec802009-08-18 18:06:19 +0100526 **/
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200527static inline void iio_device_put(struct iio_dev *indio_dev)
Jonathan Cameron847ec802009-08-18 18:06:19 +0100528{
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100529 if (indio_dev)
530 put_device(&indio_dev->dev);
Peter Meerwald6898eb82013-08-21 00:15:00 +0100531}
Jonathan Cameron847ec802009-08-18 18:06:19 +0100532
Lars-Peter Clausen7a7913f2012-05-12 15:39:32 +0200533/**
534 * dev_to_iio_dev() - Get IIO device struct from a device struct
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200535 * @dev: The device embedded in the IIO device
Lars-Peter Clausen7a7913f2012-05-12 15:39:32 +0200536 *
537 * Note: The device must be a IIO device, otherwise the result is undefined.
538 */
539static inline struct iio_dev *dev_to_iio_dev(struct device *dev)
540{
541 return container_of(dev, struct iio_dev, dev);
542}
543
Lars-Peter Clausene4e8b772012-06-04 10:50:02 +0200544/**
545 * iio_device_get() - increment reference count for the device
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200546 * @indio_dev: IIO device structure
Lars-Peter Clausene4e8b772012-06-04 10:50:02 +0200547 *
548 * Returns: The passed IIO device
549 **/
550static inline struct iio_dev *iio_device_get(struct iio_dev *indio_dev)
551{
552 return indio_dev ? dev_to_iio_dev(get_device(&indio_dev->dev)) : NULL;
553}
554
Lars-Peter Clausen2d66f382012-08-10 17:36:00 +0100555
556/**
557 * iio_device_set_drvdata() - Set device driver data
558 * @indio_dev: IIO device structure
559 * @data: Driver specific data
560 *
561 * Allows to attach an arbitrary pointer to an IIO device, which can later be
562 * retrieved by iio_device_get_drvdata().
563 */
564static inline void iio_device_set_drvdata(struct iio_dev *indio_dev, void *data)
565{
566 dev_set_drvdata(&indio_dev->dev, data);
567}
568
569/**
570 * iio_device_get_drvdata() - Get device driver data
571 * @indio_dev: IIO device structure
572 *
573 * Returns the data previously set with iio_device_set_drvdata()
574 */
575static inline void *iio_device_get_drvdata(struct iio_dev *indio_dev)
576{
577 return dev_get_drvdata(&indio_dev->dev);
578}
579
Jonathan Cameron6f7c8ee2011-04-15 18:55:56 +0100580/* Can we make this smaller? */
581#define IIO_ALIGN L1_CACHE_BYTES
Jonathan Cameron847ec802009-08-18 18:06:19 +0100582/**
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200583 * iio_device_alloc() - allocate an iio_dev from a driver
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200584 * @sizeof_priv: Space to allocate for private structure.
Jonathan Cameron847ec802009-08-18 18:06:19 +0100585 **/
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200586struct iio_dev *iio_device_alloc(int sizeof_priv);
Jonathan Cameron6f7c8ee2011-04-15 18:55:56 +0100587
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100588static inline void *iio_priv(const struct iio_dev *indio_dev)
Jonathan Cameron6f7c8ee2011-04-15 18:55:56 +0100589{
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100590 return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN);
Jonathan Cameron6f7c8ee2011-04-15 18:55:56 +0100591}
592
593static inline struct iio_dev *iio_priv_to_dev(void *priv)
594{
595 return (struct iio_dev *)((char *)priv -
596 ALIGN(sizeof(struct iio_dev), IIO_ALIGN));
597}
Jonathan Cameron847ec802009-08-18 18:06:19 +0100598
599/**
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200600 * iio_device_free() - free an iio_dev from a driver
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200601 * @indio_dev: the iio_dev associated with the device
Jonathan Cameron847ec802009-08-18 18:06:19 +0100602 **/
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200603void iio_device_free(struct iio_dev *indio_dev);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100604
605/**
Grygorii Strashko9dabaf52013-07-18 11:19:00 +0100606 * devm_iio_device_alloc - Resource-managed iio_device_alloc()
607 * @dev: Device to allocate iio_dev for
608 * @sizeof_priv: Space to allocate for private structure.
609 *
610 * Managed iio_device_alloc. iio_dev allocated with this function is
611 * automatically freed on driver detach.
612 *
613 * If an iio_dev allocated with this function needs to be freed separately,
614 * devm_iio_device_free() must be used.
615 *
616 * RETURNS:
617 * Pointer to allocated iio_dev on success, NULL on failure.
618 */
619struct iio_dev *devm_iio_device_alloc(struct device *dev, int sizeof_priv);
620
621/**
622 * devm_iio_device_free - Resource-managed iio_device_free()
623 * @dev: Device this iio_dev belongs to
624 * @indio_dev: the iio_dev associated with the device
625 *
Peter Meerwald9bc54102013-07-29 22:35:00 +0100626 * Free iio_dev allocated with devm_iio_device_alloc().
Grygorii Strashko9dabaf52013-07-18 11:19:00 +0100627 */
Peter Meerwald9bc54102013-07-29 22:35:00 +0100628void devm_iio_device_free(struct device *dev, struct iio_dev *indio_dev);
Grygorii Strashko9dabaf52013-07-18 11:19:00 +0100629
630/**
Jacek Anaszewskid5363212013-08-16 14:11:00 +0100631 * devm_iio_trigger_alloc - Resource-managed iio_trigger_alloc()
632 * @dev: Device to allocate iio_trigger for
633 * @fmt: trigger name format. If it includes format
634 * specifiers, the additional arguments following
635 * format are formatted and inserted in the resulting
636 * string replacing their respective specifiers.
637 *
638 * Managed iio_trigger_alloc. iio_trigger allocated with this function is
639 * automatically freed on driver detach.
640 *
641 * If an iio_trigger allocated with this function needs to be freed separately,
642 * devm_iio_trigger_free() must be used.
643 *
644 * RETURNS:
645 * Pointer to allocated iio_trigger on success, NULL on failure.
646 */
647struct iio_trigger *devm_iio_trigger_alloc(struct device *dev,
648 const char *fmt, ...);
649
650/**
651 * devm_iio_trigger_free - Resource-managed iio_trigger_free()
652 * @dev: Device this iio_dev belongs to
653 * @iio_trig: the iio_trigger associated with the device
654 *
655 * Free iio_trigger allocated with devm_iio_trigger_alloc().
656 */
657void devm_iio_trigger_free(struct device *dev, struct iio_trigger *iio_trig);
658
659/**
Jonathan Cameron14555b12011-09-21 11:15:57 +0100660 * iio_buffer_enabled() - helper function to test if the buffer is enabled
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200661 * @indio_dev: IIO device structure for device
Jonathan Cameron847ec802009-08-18 18:06:19 +0100662 **/
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100663static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
Jonathan Cameron847ec802009-08-18 18:06:19 +0100664{
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100665 return indio_dev->currentmode
Jonathan Cameronec3afa42011-09-21 11:15:54 +0100666 & (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE);
Peter Meerwald6898eb82013-08-21 00:15:00 +0100667}
Jonathan Cameron847ec802009-08-18 18:06:19 +0100668
Michael Henneriche553f182012-03-01 10:51:03 +0100669/**
670 * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200671 * @indio_dev: IIO device structure for device
Michael Henneriche553f182012-03-01 10:51:03 +0100672 **/
673#if defined(CONFIG_DEBUG_FS)
674static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
675{
676 return indio_dev->debugfs_dentry;
Peter Meerwald6898eb82013-08-21 00:15:00 +0100677}
Michael Henneriche553f182012-03-01 10:51:03 +0100678#else
679static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
680{
681 return NULL;
Peter Meerwald6898eb82013-08-21 00:15:00 +0100682}
Michael Henneriche553f182012-03-01 10:51:03 +0100683#endif
684
Lars-Peter Clausen6807d722012-11-20 13:36:00 +0000685int iio_str_to_fixpoint(const char *str, int fract_mult, int *integer,
686 int *fract);
687
Lars-Peter Clausen9dbf8cc2012-10-15 10:35:00 +0100688/**
689 * IIO_DEGREE_TO_RAD() - Convert degree to rad
690 * @deg: A value in degree
691 *
692 * Returns the given value converted from degree to rad
693 */
694#define IIO_DEGREE_TO_RAD(deg) (((deg) * 314159ULL + 9000000ULL) / 18000000ULL)
695
696/**
697 * IIO_G_TO_M_S_2() - Convert g to meter / second**2
698 * @g: A value in g
699 *
700 * Returns the given value converted from g to meter / second**2
701 */
702#define IIO_G_TO_M_S_2(g) ((g) * 980665ULL / 100000ULL)
703
Jonathan Cameron847ec802009-08-18 18:06:19 +0100704#endif /* _INDUSTRIAL_IO_H_ */