blob: b5894118755fbf7441b1dfe6d7a623f46a8f370f [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>
Ivan T. Ivanovacd82562014-10-22 18:29:43 +030016#include <linux/of.h>
Jonathan Cameron847ec802009-08-18 18:06:19 +010017/* IIO TODO LIST */
Jonathan Cameron751a3702010-06-26 12:54:19 +010018/*
Jonathan Cameron847ec802009-08-18 18:06:19 +010019 * Provide means of adjusting timer accuracy.
20 * Currently assumes nano seconds.
21 */
22
Jonathan Cameron1d892712011-05-18 14:40:51 +010023enum iio_chan_info_enum {
Jonathan Cameron5ccb3ad2012-04-15 17:41:16 +010024 IIO_CHAN_INFO_RAW = 0,
25 IIO_CHAN_INFO_PROCESSED,
26 IIO_CHAN_INFO_SCALE,
Jonathan Cameronc8a9f802011-10-26 17:41:36 +010027 IIO_CHAN_INFO_OFFSET,
28 IIO_CHAN_INFO_CALIBSCALE,
29 IIO_CHAN_INFO_CALIBBIAS,
30 IIO_CHAN_INFO_PEAK,
31 IIO_CHAN_INFO_PEAK_SCALE,
32 IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW,
33 IIO_CHAN_INFO_AVERAGE_RAW,
Jonathan Camerondf94aba2011-11-27 11:39:12 +000034 IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY,
Martin Fuzzey3f7f6422015-05-13 12:26:42 +020035 IIO_CHAN_INFO_HIGH_PASS_FILTER_3DB_FREQUENCY,
Laxman Dewangance85a1c2012-04-13 16:03:31 +053036 IIO_CHAN_INFO_SAMP_FREQ,
Michael Hennericha6b12852012-04-27 10:58:34 +020037 IIO_CHAN_INFO_FREQUENCY,
38 IIO_CHAN_INFO_PHASE,
Michael Hennerichb65d6212012-05-11 11:36:53 +020039 IIO_CHAN_INFO_HARDWAREGAIN,
srinivas pandruvada7c9ab032012-09-05 13:56:00 +010040 IIO_CHAN_INFO_HYSTERESIS,
Peter Meerwald899d90b2013-09-08 16:20:00 +010041 IIO_CHAN_INFO_INT_TIME,
Irina Tirdeaa88bfe72014-11-10 14:45:32 +020042 IIO_CHAN_INFO_ENABLE,
Irina Tirdeabcdf28f2014-11-10 14:45:33 +020043 IIO_CHAN_INFO_CALIBHEIGHT,
Irina Tirdead37f6832015-01-11 21:10:10 +020044 IIO_CHAN_INFO_CALIBWEIGHT,
Irina Tirdea2f0ecb72015-01-27 20:41:52 +020045 IIO_CHAN_INFO_DEBOUNCE_COUNT,
46 IIO_CHAN_INFO_DEBOUNCE_TIME,
Vianney le Clément de Saint-Marcqc8a85852015-03-30 10:34:58 +020047 IIO_CHAN_INFO_CALIBEMISSIVITY,
Irina Tirdeafaaa4492015-04-29 21:16:39 +030048 IIO_CHAN_INFO_OVERSAMPLING_RATIO,
Jonathan Cameron1d892712011-05-18 14:40:51 +010049};
50
Jonathan Cameron37044322013-09-08 14:57:00 +010051enum iio_shared_by {
52 IIO_SEPARATE,
Jonathan Cameronc006ec82013-09-08 14:57:00 +010053 IIO_SHARED_BY_TYPE,
54 IIO_SHARED_BY_DIR,
55 IIO_SHARED_BY_ALL
Jonathan Cameron37044322013-09-08 14:57:00 +010056};
57
Jonathan Cameron8310b862011-09-02 17:14:36 +010058enum iio_endian {
59 IIO_CPU,
60 IIO_BE,
61 IIO_LE,
62};
63
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +010064struct iio_chan_spec;
65struct iio_dev;
66
67/**
68 * struct iio_chan_spec_ext_info - Extended channel info attribute
69 * @name: Info attribute name
70 * @shared: Whether this attribute is shared between all channels.
71 * @read: Read callback for this info attribute, may be NULL.
72 * @write: Write callback for this info attribute, may be NULL.
Michael Hennerichfc6d1132012-04-27 10:58:36 +020073 * @private: Data private to the driver.
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +010074 */
75struct iio_chan_spec_ext_info {
76 const char *name;
Jonathan Cameron37044322013-09-08 14:57:00 +010077 enum iio_shared_by shared;
Michael Hennerichfc6d1132012-04-27 10:58:36 +020078 ssize_t (*read)(struct iio_dev *, uintptr_t private,
79 struct iio_chan_spec const *, char *buf);
80 ssize_t (*write)(struct iio_dev *, uintptr_t private,
81 struct iio_chan_spec const *, const char *buf,
82 size_t len);
83 uintptr_t private;
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +010084};
85
Jonathan Cameron1d892712011-05-18 14:40:51 +010086/**
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +020087 * struct iio_enum - Enum channel info attribute
Peter Meerwald7dcd7b62012-06-12 15:38:48 +020088 * @items: An array of strings.
89 * @num_items: Length of the item array.
90 * @set: Set callback function, may be NULL.
91 * @get: Get callback function, may be NULL.
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +020092 *
93 * The iio_enum struct can be used to implement enum style channel attributes.
94 * Enum style attributes are those which have a set of strings which map to
95 * unsigned integer values. The IIO enum helper code takes care of mapping
96 * between value and string as well as generating a "_available" file which
97 * contains a list of all available items. The set callback will be called when
98 * the attribute is updated. The last parameter is the index to the newly
99 * activated item. The get callback will be used to query the currently active
100 * item and is supposed to return the index for it.
101 */
102struct iio_enum {
103 const char * const *items;
104 unsigned int num_items;
105 int (*set)(struct iio_dev *, const struct iio_chan_spec *, unsigned int);
106 int (*get)(struct iio_dev *, const struct iio_chan_spec *);
107};
108
109ssize_t iio_enum_available_read(struct iio_dev *indio_dev,
110 uintptr_t priv, const struct iio_chan_spec *chan, char *buf);
111ssize_t iio_enum_read(struct iio_dev *indio_dev,
112 uintptr_t priv, const struct iio_chan_spec *chan, char *buf);
113ssize_t iio_enum_write(struct iio_dev *indio_dev,
114 uintptr_t priv, const struct iio_chan_spec *chan, const char *buf,
115 size_t len);
116
117/**
118 * IIO_ENUM() - Initialize enum extended channel attribute
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200119 * @_name: Attribute name
120 * @_shared: Whether the attribute is shared between all channels
Peter Meerwaldd25b3802012-08-26 13:43:00 +0100121 * @_e: Pointer to an iio_enum struct
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +0200122 *
123 * This should usually be used together with IIO_ENUM_AVAILABLE()
124 */
125#define IIO_ENUM(_name, _shared, _e) \
126{ \
127 .name = (_name), \
128 .shared = (_shared), \
129 .read = iio_enum_read, \
130 .write = iio_enum_write, \
131 .private = (uintptr_t)(_e), \
132}
133
134/**
135 * IIO_ENUM_AVAILABLE() - Initialize enum available extended channel attribute
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200136 * @_name: Attribute name ("_available" will be appended to the name)
Peter Meerwaldd25b3802012-08-26 13:43:00 +0100137 * @_e: Pointer to an iio_enum struct
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +0200138 *
Peter Meerwaldd25b3802012-08-26 13:43:00 +0100139 * Creates a read only attribute which lists all the available enum items in a
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +0200140 * space separated list. This should usually be used together with IIO_ENUM()
141 */
142#define IIO_ENUM_AVAILABLE(_name, _e) \
143{ \
144 .name = (_name "_available"), \
Jonathan Cameron37044322013-09-08 14:57:00 +0100145 .shared = IIO_SHARED_BY_TYPE, \
Lars-Peter Clausen5212cc82012-06-04 11:36:11 +0200146 .read = iio_enum_available_read, \
147 .private = (uintptr_t)(_e), \
148}
149
150/**
Lars-Peter Clausenb4e3ac02013-10-07 15:11:00 +0100151 * struct iio_event_spec - specification for a channel event
152 * @type: Type of the event
153 * @dir: Direction of the event
154 * @mask_separate: Bit mask of enum iio_event_info values. Attributes
155 * set in this mask will be registered per channel.
156 * @mask_shared_by_type: Bit mask of enum iio_event_info values. Attributes
157 * set in this mask will be shared by channel type.
158 * @mask_shared_by_dir: Bit mask of enum iio_event_info values. Attributes
159 * set in this mask will be shared by channel type and
160 * direction.
161 * @mask_shared_by_all: Bit mask of enum iio_event_info values. Attributes
162 * set in this mask will be shared by all channels.
163 */
164struct iio_event_spec {
165 enum iio_event_type type;
166 enum iio_event_direction dir;
167 unsigned long mask_separate;
168 unsigned long mask_shared_by_type;
169 unsigned long mask_shared_by_dir;
170 unsigned long mask_shared_by_all;
171};
172
173/**
Jonathan Cameron1d892712011-05-18 14:40:51 +0100174 * struct iio_chan_spec - specification of a single channel
175 * @type: What type of measurement is the channel making.
Peter Meerwalda16561c2012-06-12 15:38:46 +0200176 * @channel: What number do we wish to assign the channel.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100177 * @channel2: If there is a second number for a differential
178 * channel then this is it. If modified is set then the
179 * value here specifies the modifier.
180 * @address: Driver specific identifier.
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200181 * @scan_index: Monotonic index to give ordering in scans when read
Jonathan Cameron1d892712011-05-18 14:40:51 +0100182 * from a buffer.
183 * @scan_type: Sign: 's' or 'u' to specify signed or unsigned
184 * realbits: Number of valid bits of data
185 * storage_bits: Realbits + padding
186 * shift: Shift right by this before masking out
187 * realbits.
Jonathan Cameron8310b862011-09-02 17:14:36 +0100188 * endianness: little or big endian
Srinivas Pandruvada0ee85462014-04-29 00:51:00 +0100189 * repeat: Number of times real/storage bits
190 * repeats. When the repeat element is
191 * more than 1, then the type element in
192 * sysfs will show a repeat value.
193 * Otherwise, the number of repetitions is
194 * omitted.
Jonathan Cameron8655cc42013-02-19 21:10:30 +0000195 * @info_mask_separate: What information is to be exported that is specific to
196 * this channel.
197 * @info_mask_shared_by_type: What information is to be exported that is shared
Jonathan Cameron9761696f2013-09-08 14:57:00 +0100198 * by all channels of the same type.
Jonathan Cameronc006ec82013-09-08 14:57:00 +0100199 * @info_mask_shared_by_dir: What information is to be exported that is shared
200 * by all channels of the same direction.
201 * @info_mask_shared_by_all: What information is to be exported that is shared
202 * by all channels.
Lars-Peter Clausenb4e3ac02013-10-07 15:11:00 +0100203 * @event_spec: Array of events which should be registered for this
204 * channel.
205 * @num_event_specs: Size of the event_spec array.
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +0100206 * @ext_info: Array of extended info attributes for this channel.
207 * The array is NULL terminated, the last element should
Peter Meerwald9cc113bc2012-06-18 20:33:01 +0200208 * have its name field set to NULL.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100209 * @extend_name: Allows labeling of channel attributes with an
210 * informative name. Note this has no effect codes etc,
211 * unlike modifiers.
Peter Meerwald17879482012-06-12 15:38:45 +0200212 * @datasheet_name: A name used in in-kernel mapping of channels. It should
Justin P. Mattock4abf6f82012-02-29 22:00:38 -0800213 * correspond to the first name that the channel is referred
Jonathan Cameron6c63dde2011-12-05 21:56:00 +0000214 * to by in the datasheet (e.g. IND), or the nearest
215 * possible compound name (e.g. IND-INC).
Jonathan Cameron1d892712011-05-18 14:40:51 +0100216 * @modified: Does a modifier apply to this channel. What these are
217 * depends on the channel type. Modifier is set in
218 * channel2. Examples are IIO_MOD_X for axial sensors about
219 * the 'x' axis.
220 * @indexed: Specify the channel has a numerical index. If not,
Peter Meerwalda16561c2012-06-12 15:38:46 +0200221 * the channel index number will be suppressed for sysfs
222 * attributes but not for event codes.
Peter Meerwaldc3668a02012-08-26 13:43:00 +0100223 * @output: Channel is output.
Jonathan Cameronade7ef72011-09-02 17:14:45 +0100224 * @differential: Channel is differential.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100225 */
226struct iio_chan_spec {
227 enum iio_chan_type type;
228 int channel;
229 int channel2;
230 unsigned long address;
231 int scan_index;
232 struct {
233 char sign;
234 u8 realbits;
235 u8 storagebits;
236 u8 shift;
Srinivas Pandruvada0ee85462014-04-29 00:51:00 +0100237 u8 repeat;
Jonathan Cameron8310b862011-09-02 17:14:36 +0100238 enum iio_endian endianness;
Jonathan Cameron1d892712011-05-18 14:40:51 +0100239 } scan_type;
Jonathan Cameron8655cc42013-02-19 21:10:30 +0000240 long info_mask_separate;
241 long info_mask_shared_by_type;
Jonathan Cameronc006ec82013-09-08 14:57:00 +0100242 long info_mask_shared_by_dir;
243 long info_mask_shared_by_all;
Lars-Peter Clausenb4e3ac02013-10-07 15:11:00 +0100244 const struct iio_event_spec *event_spec;
245 unsigned int num_event_specs;
Lars-Peter Clausen5f420b42012-02-21 18:38:12 +0100246 const struct iio_chan_spec_ext_info *ext_info;
Jonathan Cameron344692b2012-04-13 10:24:21 +0100247 const char *extend_name;
Jonathan Cameron6c63dde2011-12-05 21:56:00 +0000248 const char *datasheet_name;
Jonathan Cameron1d892712011-05-18 14:40:51 +0100249 unsigned modified:1;
250 unsigned indexed:1;
Jonathan Cameronc6fc8062011-09-02 17:14:34 +0100251 unsigned output:1;
Jonathan Cameronade7ef72011-09-02 17:14:45 +0100252 unsigned differential:1;
Jonathan Cameron1d892712011-05-18 14:40:51 +0100253};
Jonathan Camerondf9c1c42011-08-12 17:56:03 +0100254
Lars-Peter Clausen48e44ce2012-09-17 13:17:00 +0100255
256/**
257 * iio_channel_has_info() - Checks whether a channel supports a info attribute
258 * @chan: The channel to be queried
259 * @type: Type of the info attribute to be checked
260 *
261 * Returns true if the channels supports reporting values for the given info
262 * attribute type, false otherwise.
263 */
264static inline bool iio_channel_has_info(const struct iio_chan_spec *chan,
265 enum iio_chan_info_enum type)
266{
Alexandre Belloni1c297a62013-07-01 15:20:00 +0100267 return (chan->info_mask_separate & BIT(type)) |
Jonathan Cameronc006ec82013-09-08 14:57:00 +0100268 (chan->info_mask_shared_by_type & BIT(type)) |
269 (chan->info_mask_shared_by_dir & BIT(type)) |
270 (chan->info_mask_shared_by_all & BIT(type));
Lars-Peter Clausen48e44ce2012-09-17 13:17:00 +0100271}
272
Jonathan Cameron07d46552013-11-12 18:45:00 +0000273#define IIO_CHAN_SOFT_TIMESTAMP(_si) { \
274 .type = IIO_TIMESTAMP, \
275 .channel = -1, \
276 .scan_index = _si, \
277 .scan_type = { \
278 .sign = 's', \
279 .realbits = 64, \
280 .storagebits = 64, \
281 }, \
282}
Jonathan Cameron1d892712011-05-18 14:40:51 +0100283
Jonathan Cameron847ec802009-08-18 18:06:19 +0100284/**
285 * iio_get_time_ns() - utility function to get a time stamp for events etc
286 **/
287static inline s64 iio_get_time_ns(void)
288{
Thomas Gleixnerfb31cc12014-07-16 21:04:49 +0000289 return ktime_get_real_ns();
Jonathan Cameron847ec802009-08-18 18:06:19 +0100290}
291
Jonathan Cameron847ec802009-08-18 18:06:19 +0100292/* Device operating modes */
293#define INDIO_DIRECT_MODE 0x01
Jonathan Cameronec3afa42011-09-21 11:15:54 +0100294#define INDIO_BUFFER_TRIGGERED 0x02
Karol Wrona03af03a2015-01-07 19:36:11 +0100295#define INDIO_BUFFER_SOFTWARE 0x04
Jonathan Cameronec3afa42011-09-21 11:15:54 +0100296#define INDIO_BUFFER_HARDWARE 0x08
Vladimir Barinov735ad072015-08-20 22:37:39 +0300297#define INDIO_EVENT_TRIGGERED 0x10
Jonathan Cameron847ec802009-08-18 18:06:19 +0100298
Jonathan Cameronec3afa42011-09-21 11:15:54 +0100299#define INDIO_ALL_BUFFER_MODES \
Karol Wrona03af03a2015-01-07 19:36:11 +0100300 (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE | INDIO_BUFFER_SOFTWARE)
Jonathan Cameron847ec802009-08-18 18:06:19 +0100301
Srinivas Pandruvada9fbfb4b2014-04-29 00:51:00 +0100302#define INDIO_MAX_RAW_ELEMENTS 4
303
Michael Hennerich43a43602011-06-27 13:07:09 +0100304struct iio_trigger; /* forward declaration */
Jonathan Cameron7ae8cf62011-08-30 12:32:44 +0100305struct iio_dev;
Michael Hennerich43a43602011-06-27 13:07:09 +0100306
Jonathan Cameron847ec802009-08-18 18:06:19 +0100307/**
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100308 * struct iio_info - constant information about device
309 * @driver_module: module structure used to ensure correct
Jonathan Cameron847ec802009-08-18 18:06:19 +0100310 * ownership of chrdevs etc
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100311 * @event_attrs: event control attributes
312 * @attrs: general purpose device attributes
313 * @read_raw: function to request a value from the device.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100314 * mask specifies which value. Note 0 means a reading of
315 * the channel in question. Return value will specify the
316 * type of value returned by the device. val and val2 will
317 * contain the elements making up the returned value.
Srinivas Pandruvada9fbfb4b2014-04-29 00:51:00 +0100318 * @read_raw_multi: function to return values from the device.
319 * mask specifies which value. Note 0 means a reading of
320 * the channel in question. Return value will specify the
321 * type of value returned by the device. vals pointer
322 * contain the elements making up the returned value.
323 * max_len specifies maximum number of elements
324 * vals pointer can contain. val_len is used to return
325 * length of valid elements in vals.
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100326 * @write_raw: function to write a value to the device.
Jonathan Cameron1d892712011-05-18 14:40:51 +0100327 * Parameters are the same as for read_raw.
Michael Hennerich5c04af02011-06-27 13:07:10 +0100328 * @write_raw_get_fmt: callback function to query the expected
329 * format/precision. If not set by the driver, write_raw
330 * returns IIO_VAL_INT_PLUS_MICRO.
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100331 * @read_event_config: find out if the event is enabled.
332 * @write_event_config: set if the event is enabled.
Lars-Peter Clausencb955852013-12-07 10:45:00 +0000333 * @read_event_value: read a configuration value associated with the event.
334 * @write_event_value: write a configuration value for the event.
Michael Hennerich43a43602011-06-27 13:07:09 +0100335 * @validate_trigger: function to validate the trigger when the
336 * current trigger gets changed.
Peter Meerwaldc3668a02012-08-26 13:43:00 +0100337 * @update_scan_mode: function to configure device and scan buffer when
338 * channels have changed
339 * @debugfs_reg_access: function to read or write register value of device
Ivan T. Ivanovacd82562014-10-22 18:29:43 +0300340 * @of_xlate: function pointer to obtain channel specifier index.
341 * When #iio-cells is greater than '0', the driver could
342 * provide a custom of_xlate function that reads the
343 * *args* and returns the appropriate index in registered
344 * IIO channels array.
Octavian Purdilaf4f46732015-03-22 20:33:39 +0200345 * @hwfifo_set_watermark: function pointer to set the current hardware
346 * fifo watermark level; see hwfifo_* entries in
347 * Documentation/ABI/testing/sysfs-bus-iio for details on
348 * how the hardware fifo operates
349 * @hwfifo_flush_to_buffer: function pointer to flush the samples stored
350 * in the hardware fifo to the device buffer. The driver
351 * should not flush more than count samples. The function
352 * must return the number of samples flushed, 0 if no
353 * samples were flushed or a negative integer if no samples
354 * were flushed and there was an error.
Jonathan Cameron847ec802009-08-18 18:06:19 +0100355 **/
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100356struct iio_info {
Jonathan Cameron847ec802009-08-18 18:06:19 +0100357 struct module *driver_module;
Jonathan Cameron847ec802009-08-18 18:06:19 +0100358 struct attribute_group *event_attrs;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100359 const struct attribute_group *attrs;
Jonathan Cameron847ec802009-08-18 18:06:19 +0100360
Jonathan Cameron1d892712011-05-18 14:40:51 +0100361 int (*read_raw)(struct iio_dev *indio_dev,
362 struct iio_chan_spec const *chan,
363 int *val,
364 int *val2,
365 long mask);
366
Srinivas Pandruvada9fbfb4b2014-04-29 00:51:00 +0100367 int (*read_raw_multi)(struct iio_dev *indio_dev,
368 struct iio_chan_spec const *chan,
369 int max_len,
370 int *vals,
371 int *val_len,
372 long mask);
373
Jonathan Cameron1d892712011-05-18 14:40:51 +0100374 int (*write_raw)(struct iio_dev *indio_dev,
375 struct iio_chan_spec const *chan,
376 int val,
377 int val2,
378 long mask);
379
Michael Hennerich5c04af02011-06-27 13:07:10 +0100380 int (*write_raw_get_fmt)(struct iio_dev *indio_dev,
381 struct iio_chan_spec const *chan,
382 long mask);
383
Jonathan Cameron1d892712011-05-18 14:40:51 +0100384 int (*read_event_config)(struct iio_dev *indio_dev,
Lars-Peter Clausenb4e3ac02013-10-07 15:11:00 +0100385 const struct iio_chan_spec *chan,
386 enum iio_event_type type,
387 enum iio_event_direction dir);
388
Lars-Peter Clausencb955852013-12-07 10:45:00 +0000389 int (*write_event_config)(struct iio_dev *indio_dev,
Lars-Peter Clausenb4e3ac02013-10-07 15:11:00 +0100390 const struct iio_chan_spec *chan,
391 enum iio_event_type type,
392 enum iio_event_direction dir,
393 int state);
394
Lars-Peter Clausencb955852013-12-07 10:45:00 +0000395 int (*read_event_value)(struct iio_dev *indio_dev,
Lars-Peter Clausenb4e3ac02013-10-07 15:11:00 +0100396 const struct iio_chan_spec *chan,
397 enum iio_event_type type,
398 enum iio_event_direction dir,
399 enum iio_event_info info, int *val, int *val2);
400
Lars-Peter Clausencb955852013-12-07 10:45:00 +0000401 int (*write_event_value)(struct iio_dev *indio_dev,
Lars-Peter Clausenb4e3ac02013-10-07 15:11:00 +0100402 const struct iio_chan_spec *chan,
403 enum iio_event_type type,
404 enum iio_event_direction dir,
405 enum iio_event_info info, int val, int val2);
406
Michael Hennerich43a43602011-06-27 13:07:09 +0100407 int (*validate_trigger)(struct iio_dev *indio_dev,
408 struct iio_trigger *trig);
Jonathan Cameron4d5f8d32011-12-05 21:37:12 +0000409 int (*update_scan_mode)(struct iio_dev *indio_dev,
410 const unsigned long *scan_mask);
Michael Henneriche553f182012-03-01 10:51:03 +0100411 int (*debugfs_reg_access)(struct iio_dev *indio_dev,
412 unsigned reg, unsigned writeval,
413 unsigned *readval);
Ivan T. Ivanovacd82562014-10-22 18:29:43 +0300414 int (*of_xlate)(struct iio_dev *indio_dev,
415 const struct of_phandle_args *iiospec);
Octavian Purdilaf4f46732015-03-22 20:33:39 +0200416 int (*hwfifo_set_watermark)(struct iio_dev *indio_dev, unsigned val);
417 int (*hwfifo_flush_to_buffer)(struct iio_dev *indio_dev,
418 unsigned count);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100419};
420
Jonathan Cameron847ec802009-08-18 18:06:19 +0100421/**
Jonathan Cameron16122442011-12-05 22:18:14 +0000422 * struct iio_buffer_setup_ops - buffer setup related callbacks
423 * @preenable: [DRIVER] function to run prior to marking buffer enabled
424 * @postenable: [DRIVER] function to run after marking buffer enabled
425 * @predisable: [DRIVER] function to run prior to marking buffer
426 * disabled
427 * @postdisable: [DRIVER] function to run after marking buffer disabled
Lars-Peter Clausen939546d2012-07-09 10:00:00 +0100428 * @validate_scan_mask: [DRIVER] function callback to check whether a given
429 * scan mask is valid for the device.
Jonathan Cameron16122442011-12-05 22:18:14 +0000430 */
431struct iio_buffer_setup_ops {
Peter Meerwald99698b42012-08-26 13:43:00 +0100432 int (*preenable)(struct iio_dev *);
433 int (*postenable)(struct iio_dev *);
434 int (*predisable)(struct iio_dev *);
435 int (*postdisable)(struct iio_dev *);
Lars-Peter Clausen939546d2012-07-09 10:00:00 +0100436 bool (*validate_scan_mask)(struct iio_dev *indio_dev,
437 const unsigned long *scan_mask);
Jonathan Cameron16122442011-12-05 22:18:14 +0000438};
439
440/**
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100441 * struct iio_dev - industrial I/O device
442 * @id: [INTERN] used to identify device internally
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100443 * @modes: [DRIVER] operating modes supported by device
444 * @currentmode: [DRIVER] current operating mode
445 * @dev: [DRIVER] device structure, should be assigned a parent
446 * and owner
Jonathan Cameron5aa96182011-08-30 12:41:06 +0100447 * @event_interface: [INTERN] event chrdevs associated with interrupt lines
Jonathan Cameron14555b12011-09-21 11:15:57 +0100448 * @buffer: [DRIVER] any buffer present
Jonathan Cameron84b36ce2012-06-30 20:06:00 +0100449 * @buffer_list: [INTERN] list of all buffers currently attached
Jonathan Cameron420fe2e2012-04-21 10:09:35 +0100450 * @scan_bytes: [INTERN] num bytes captured to be fed to buffer demux
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100451 * @mlock: [INTERN] lock used to prevent simultaneous device state
452 * changes
453 * @available_scan_masks: [DRIVER] optional array of allowed bitmasks
Jonathan Cameron32b5eec2011-09-02 17:14:38 +0100454 * @masklength: [INTERN] the length of the mask established from
455 * channels
Jonathan Cameron959d2952011-12-05 21:37:13 +0000456 * @active_scan_mask: [INTERN] union of all scan masks requested by buffers
Jonathan Cameronfd6487f2012-04-21 10:09:44 +0100457 * @scan_timestamp: [INTERN] set if any buffers have requested timestamp
Jonathan Cameronf1264802012-04-21 10:09:34 +0100458 * @scan_index_timestamp:[INTERN] cache of the index to the timestamp
Jonathan Cameron14555b12011-09-21 11:15:57 +0100459 * @trig: [INTERN] current device trigger (buffer modes)
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100460 * @pollfunc: [DRIVER] function run on trigger being received
Vladimir Barinov735ad072015-08-20 22:37:39 +0300461 * @pollfunc_event: [DRIVER] function run on events trigger being received
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100462 * @channels: [DRIVER] channel specification structure table
Peter Meerwald17879482012-06-12 15:38:45 +0200463 * @num_channels: [DRIVER] number of channels specified in @channels.
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100464 * @channel_attr_list: [INTERN] keep track of automatically created channel
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100465 * attributes
Jonathan Cameron26d25ae2011-09-02 17:14:40 +0100466 * @chan_attr_group: [INTERN] group for all attrs in base directory
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100467 * @name: [DRIVER] name of the device.
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100468 * @info: [DRIVER] callbacks and constant info from driver
Jonathan Cameronac917a82012-02-15 19:48:00 +0000469 * @info_exist_lock: [INTERN] lock to prevent use during removal
Jonathan Cameronecbf20c2012-04-10 21:11:06 +0100470 * @setup_ops: [DRIVER] callbacks to call before and after buffer
471 * enable/disable
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100472 * @chrdev: [INTERN] associated character device
Jonathan Cameron26d25ae2011-09-02 17:14:40 +0100473 * @groups: [INTERN] attribute groups
474 * @groupcounter: [INTERN] index of next attribute group
Lars-Peter Clausenbb014432011-12-19 15:23:45 +0100475 * @flags: [INTERN] file ops related flags including busy flag.
Michael Henneriche553f182012-03-01 10:51:03 +0100476 * @debugfs_dentry: [INTERN] device specific debugfs dentry.
477 * @cached_reg_addr: [INTERN] cached register address for debugfs reads.
478 */
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100479struct iio_dev {
480 int id;
Jonathan Cameron4024bc72011-08-12 17:08:53 +0100481
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100482 int modes;
483 int currentmode;
484 struct device dev;
485
Jonathan Cameron5aa96182011-08-30 12:41:06 +0100486 struct iio_event_interface *event_interface;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100487
Jonathan Cameron14555b12011-09-21 11:15:57 +0100488 struct iio_buffer *buffer;
Jonathan Cameron84b36ce2012-06-30 20:06:00 +0100489 struct list_head buffer_list;
Jonathan Cameron420fe2e2012-04-21 10:09:35 +0100490 int scan_bytes;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100491 struct mutex mlock;
492
Michael Hennerichcd4361c2012-02-22 13:16:49 +0100493 const unsigned long *available_scan_masks;
Jonathan Cameron32b5eec2011-09-02 17:14:38 +0100494 unsigned masklength;
Michael Hennerichcd4361c2012-02-22 13:16:49 +0100495 const unsigned long *active_scan_mask;
Jonathan Cameronfd6487f2012-04-21 10:09:44 +0100496 bool scan_timestamp;
Jonathan Cameronf1264802012-04-21 10:09:34 +0100497 unsigned scan_index_timestamp;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100498 struct iio_trigger *trig;
499 struct iio_poll_func *pollfunc;
Vladimir Barinov735ad072015-08-20 22:37:39 +0300500 struct iio_poll_func *pollfunc_event;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100501
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100502 struct iio_chan_spec const *channels;
503 int num_channels;
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100504
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100505 struct list_head channel_attr_list;
Jonathan Cameron26d25ae2011-09-02 17:14:40 +0100506 struct attribute_group chan_attr_group;
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100507 const char *name;
508 const struct iio_info *info;
Jonathan Cameronac917a82012-02-15 19:48:00 +0000509 struct mutex info_exist_lock;
Jonathan Cameron16122442011-12-05 22:18:14 +0000510 const struct iio_buffer_setup_ops *setup_ops;
Jonathan Cameron1a25e592011-08-30 12:41:12 +0100511 struct cdev chrdev;
Jonathan Cameron26d25ae2011-09-02 17:14:40 +0100512#define IIO_MAX_GROUPS 6
513 const struct attribute_group *groups[IIO_MAX_GROUPS + 1];
514 int groupcounter;
Lars-Peter Clausenbb014432011-12-19 15:23:45 +0100515
516 unsigned long flags;
Michael Henneriche553f182012-03-01 10:51:03 +0100517#if defined(CONFIG_DEBUG_FS)
518 struct dentry *debugfs_dentry;
519 unsigned cached_reg_addr;
520#endif
Jonathan Cameron6fe81352011-05-18 14:42:37 +0100521};
522
Jonathan Cameron5fb21c82011-12-05 21:37:10 +0000523const struct iio_chan_spec
524*iio_find_channel_from_si(struct iio_dev *indio_dev, int si);
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100525int iio_device_register(struct iio_dev *indio_dev);
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100526void iio_device_unregister(struct iio_dev *indio_dev);
Sachin Kamat8caa07c2013-10-29 11:39:00 +0000527int devm_iio_device_register(struct device *dev, struct iio_dev *indio_dev);
528void devm_iio_device_unregister(struct device *dev, struct iio_dev *indio_dev);
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100529int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);
Jonathan Cameron847ec802009-08-18 18:06:19 +0100530
Jonathan Cameron5aaaeba2010-05-04 14:43:00 +0100531extern struct bus_type iio_bus_type;
Jonathan Cameron847ec802009-08-18 18:06:19 +0100532
533/**
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200534 * iio_device_put() - reference counted deallocation of struct device
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200535 * @indio_dev: IIO device structure containing the device
Jonathan Cameron847ec802009-08-18 18:06:19 +0100536 **/
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200537static inline void iio_device_put(struct iio_dev *indio_dev)
Jonathan Cameron847ec802009-08-18 18:06:19 +0100538{
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100539 if (indio_dev)
540 put_device(&indio_dev->dev);
Peter Meerwald6898eb82013-08-21 00:15:00 +0100541}
Jonathan Cameron847ec802009-08-18 18:06:19 +0100542
Lars-Peter Clausen7a7913f2012-05-12 15:39:32 +0200543/**
544 * dev_to_iio_dev() - Get IIO device struct from a device struct
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200545 * @dev: The device embedded in the IIO device
Lars-Peter Clausen7a7913f2012-05-12 15:39:32 +0200546 *
547 * Note: The device must be a IIO device, otherwise the result is undefined.
548 */
549static inline struct iio_dev *dev_to_iio_dev(struct device *dev)
550{
551 return container_of(dev, struct iio_dev, dev);
552}
553
Lars-Peter Clausene4e8b772012-06-04 10:50:02 +0200554/**
555 * iio_device_get() - increment reference count for the device
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200556 * @indio_dev: IIO device structure
Lars-Peter Clausene4e8b772012-06-04 10:50:02 +0200557 *
558 * Returns: The passed IIO device
559 **/
560static inline struct iio_dev *iio_device_get(struct iio_dev *indio_dev)
561{
562 return indio_dev ? dev_to_iio_dev(get_device(&indio_dev->dev)) : NULL;
563}
564
Lars-Peter Clausen2d66f382012-08-10 17:36:00 +0100565
566/**
567 * iio_device_set_drvdata() - Set device driver data
568 * @indio_dev: IIO device structure
569 * @data: Driver specific data
570 *
571 * Allows to attach an arbitrary pointer to an IIO device, which can later be
572 * retrieved by iio_device_get_drvdata().
573 */
574static inline void iio_device_set_drvdata(struct iio_dev *indio_dev, void *data)
575{
576 dev_set_drvdata(&indio_dev->dev, data);
577}
578
579/**
580 * iio_device_get_drvdata() - Get device driver data
581 * @indio_dev: IIO device structure
582 *
583 * Returns the data previously set with iio_device_set_drvdata()
584 */
585static inline void *iio_device_get_drvdata(struct iio_dev *indio_dev)
586{
587 return dev_get_drvdata(&indio_dev->dev);
588}
589
Jonathan Cameron6f7c8ee2011-04-15 18:55:56 +0100590/* Can we make this smaller? */
591#define IIO_ALIGN L1_CACHE_BYTES
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200592struct iio_dev *iio_device_alloc(int sizeof_priv);
Jonathan Cameron6f7c8ee2011-04-15 18:55:56 +0100593
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100594static inline void *iio_priv(const struct iio_dev *indio_dev)
Jonathan Cameron6f7c8ee2011-04-15 18:55:56 +0100595{
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100596 return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN);
Jonathan Cameron6f7c8ee2011-04-15 18:55:56 +0100597}
598
599static inline struct iio_dev *iio_priv_to_dev(void *priv)
600{
601 return (struct iio_dev *)((char *)priv -
602 ALIGN(sizeof(struct iio_dev), IIO_ALIGN));
603}
Jonathan Cameron847ec802009-08-18 18:06:19 +0100604
Lars-Peter Clausen7cbb7532012-04-26 13:35:01 +0200605void iio_device_free(struct iio_dev *indio_dev);
Grygorii Strashko9dabaf52013-07-18 11:19:00 +0100606struct iio_dev *devm_iio_device_alloc(struct device *dev, int sizeof_priv);
Peter Meerwald9bc54102013-07-29 22:35:00 +0100607void devm_iio_device_free(struct device *dev, struct iio_dev *indio_dev);
Jacek Anaszewskid5363212013-08-16 14:11:00 +0100608struct iio_trigger *devm_iio_trigger_alloc(struct device *dev,
609 const char *fmt, ...);
Jacek Anaszewskid5363212013-08-16 14:11:00 +0100610void devm_iio_trigger_free(struct device *dev, struct iio_trigger *iio_trig);
611
612/**
Jonathan Cameron14555b12011-09-21 11:15:57 +0100613 * iio_buffer_enabled() - helper function to test if the buffer is enabled
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200614 * @indio_dev: IIO device structure for device
Jonathan Cameron847ec802009-08-18 18:06:19 +0100615 **/
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100616static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
Jonathan Cameron847ec802009-08-18 18:06:19 +0100617{
Jonathan Cameronf8c6f4e2011-10-06 17:14:35 +0100618 return indio_dev->currentmode
Karol Wrona03af03a2015-01-07 19:36:11 +0100619 & (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE |
620 INDIO_BUFFER_SOFTWARE);
Peter Meerwald6898eb82013-08-21 00:15:00 +0100621}
Jonathan Cameron847ec802009-08-18 18:06:19 +0100622
Michael Henneriche553f182012-03-01 10:51:03 +0100623/**
624 * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry
Peter Meerwald7dcd7b62012-06-12 15:38:48 +0200625 * @indio_dev: IIO device structure for device
Michael Henneriche553f182012-03-01 10:51:03 +0100626 **/
627#if defined(CONFIG_DEBUG_FS)
628static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
629{
630 return indio_dev->debugfs_dentry;
Peter Meerwald6898eb82013-08-21 00:15:00 +0100631}
Michael Henneriche553f182012-03-01 10:51:03 +0100632#else
633static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
634{
635 return NULL;
Peter Meerwald6898eb82013-08-21 00:15:00 +0100636}
Michael Henneriche553f182012-03-01 10:51:03 +0100637#endif
638
Andrew F. Davis7d2c2aca2015-12-14 16:35:57 -0600639ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals);
640
Lars-Peter Clausen6807d722012-11-20 13:36:00 +0000641int iio_str_to_fixpoint(const char *str, int fract_mult, int *integer,
642 int *fract);
643
Lars-Peter Clausen9dbf8cc2012-10-15 10:35:00 +0100644/**
645 * IIO_DEGREE_TO_RAD() - Convert degree to rad
646 * @deg: A value in degree
647 *
648 * Returns the given value converted from degree to rad
649 */
650#define IIO_DEGREE_TO_RAD(deg) (((deg) * 314159ULL + 9000000ULL) / 18000000ULL)
651
652/**
Lars-Peter Clausenc689a922015-08-05 15:38:14 +0200653 * IIO_RAD_TO_DEGREE() - Convert rad to degree
654 * @rad: A value in rad
655 *
656 * Returns the given value converted from rad to degree
657 */
658#define IIO_RAD_TO_DEGREE(rad) \
659 (((rad) * 18000000ULL + 314159ULL / 2) / 314159ULL)
660
661/**
Lars-Peter Clausen9dbf8cc2012-10-15 10:35:00 +0100662 * IIO_G_TO_M_S_2() - Convert g to meter / second**2
663 * @g: A value in g
664 *
665 * Returns the given value converted from g to meter / second**2
666 */
667#define IIO_G_TO_M_S_2(g) ((g) * 980665ULL / 100000ULL)
668
Lars-Peter Clausenc689a922015-08-05 15:38:14 +0200669/**
670 * IIO_M_S_2_TO_G() - Convert meter / second**2 to g
671 * @ms2: A value in meter / second**2
672 *
673 * Returns the given value converted from meter / second**2 to g
674 */
675#define IIO_M_S_2_TO_G(ms2) (((ms2) * 100000ULL + 980665ULL / 2) / 980665ULL)
676
Jonathan Cameron847ec802009-08-18 18:06:19 +0100677#endif /* _INDUSTRIAL_IO_H_ */