1
2 /* 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 */
10 #ifndef _INDUSTRIAL_IO_H_
11 #define _INDUSTRIAL_IO_H_
12
13 #include <linux/device.h>
14 #include <linux/cdev.h>
15 #include "types.h"
16 /* IIO TODO LIST */
17 /*
18 * Provide means of adjusting timer accuracy.
19 * Currently assumes nano seconds.
20 */
21
22 enum iio_data_type {
23 IIO_RAW,
24 IIO_PROCESSED,
25 };
26
27 /* Could add the raw attributes as well - allowing buffer only devices */
28 enum iio_chan_info_enum {
29 /* 0 is reserved for raw attributes */
30 IIO_CHAN_INFO_SCALE = 1,
31 IIO_CHAN_INFO_OFFSET,
32 IIO_CHAN_INFO_CALIBSCALE,
33 IIO_CHAN_INFO_CALIBBIAS,
34 IIO_CHAN_INFO_PEAK,
35 IIO_CHAN_INFO_PEAK_SCALE,
36 IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW,
37 IIO_CHAN_INFO_AVERAGE_RAW,
38 IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY,
39 };
40
41 #define IIO_CHAN_INFO_SHARED_BIT(type) BIT(type*2)
42 #define IIO_CHAN_INFO_SEPARATE_BIT(type) BIT(type*2 + 1)
43
44 #define IIO_CHAN_INFO_SCALE_SEPARATE_BIT \
45 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_SCALE)
46 #define IIO_CHAN_INFO_SCALE_SHARED_BIT \
47 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_SCALE)
48 #define IIO_CHAN_INFO_OFFSET_SEPARATE_BIT \
49 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_OFFSET)
50 #define IIO_CHAN_INFO_OFFSET_SHARED_BIT \
51 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_OFFSET)
52 #define IIO_CHAN_INFO_CALIBSCALE_SEPARATE_BIT \
53 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBSCALE)
54 #define IIO_CHAN_INFO_CALIBSCALE_SHARED_BIT \
55 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBSCALE)
56 #define IIO_CHAN_INFO_CALIBBIAS_SEPARATE_BIT \
57 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBBIAS)
58 #define IIO_CHAN_INFO_CALIBBIAS_SHARED_BIT \
59 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBBIAS)
60 #define IIO_CHAN_INFO_PEAK_SEPARATE_BIT \
61 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAK)
62 #define IIO_CHAN_INFO_PEAK_SHARED_BIT \
63 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAK)
64 #define IIO_CHAN_INFO_PEAKSCALE_SEPARATE_BIT \
65 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAKSCALE)
66 #define IIO_CHAN_INFO_PEAKSCALE_SHARED_BIT \
67 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAKSCALE)
68 #define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SEPARATE_BIT \
69 IIO_CHAN_INFO_SEPARATE_BIT( \
70 IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW)
71 #define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SHARED_BIT \
72 IIO_CHAN_INFO_SHARED_BIT( \
73 IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW)
74 #define IIO_CHAN_INFO_AVERAGE_RAW_SEPARATE_BIT \
75 IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_AVERAGE_RAW)
76 #define IIO_CHAN_INFO_AVERAGE_RAW_SHARED_BIT \
77 IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_AVERAGE_RAW)
78 #define IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY_SHARED_BIT \
79 IIO_CHAN_INFO_SHARED_BIT( \
80 IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY)
81 #define IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY_SEPARATE_BIT \
82 IIO_CHAN_INFO_SEPARATE_BIT( \
83 IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY)
84
85 enum iio_endian {
86 IIO_CPU,
87 IIO_BE,
88 IIO_LE,
89 };
90
91 struct iio_chan_spec;
92 struct iio_dev;
93
94 /**
95 * struct iio_chan_spec_ext_info - Extended channel info attribute
96 * @name: Info attribute name
97 * @shared: Whether this attribute is shared between all channels.
98 * @read: Read callback for this info attribute, may be NULL.
99 * @write: Write callback for this info attribute, may be NULL.
100 */
101 struct iio_chan_spec_ext_info {
102 const char *name;
103 bool shared;
104 ssize_t (*read)(struct iio_dev *, struct iio_chan_spec const *,
105 char *buf);
106 ssize_t (*write)(struct iio_dev *, struct iio_chan_spec const *,
107 const char *buf, size_t len);
108 };
109
110 /**
111 * struct iio_chan_spec - specification of a single channel
112 * @type: What type of measurement is the channel making.
113 * @channel: What number or name do we wish to assign the channel.
114 * @channel2: If there is a second number for a differential
115 * channel then this is it. If modified is set then the
116 * value here specifies the modifier.
117 * @address: Driver specific identifier.
118 * @scan_index: Monotonic index to give ordering in scans when read
119 * from a buffer.
120 * @scan_type: Sign: 's' or 'u' to specify signed or unsigned
121 * realbits: Number of valid bits of data
122 * storage_bits: Realbits + padding
123 * shift: Shift right by this before masking out
124 * realbits.
125 * endianness: little or big endian
126 * @info_mask: What information is to be exported about this channel.
127 * This includes calibbias, scale etc.
128 * @event_mask: What events can this channel produce.
129 * @ext_info: Array of extended info attributes for this channel.
130 * The array is NULL terminated, the last element should
131 * have it's name field set to NULL.
132 * @extend_name: Allows labeling of channel attributes with an
133 * informative name. Note this has no effect codes etc,
134 * unlike modifiers.
135 * @datasheet_name: A name used in in kernel mapping of channels. It should
136 * correspond to the first name that the channel is referred
137 * to by in the datasheet (e.g. IND), or the nearest
138 * possible compound name (e.g. IND-INC).
139 * @processed_val: Flag to specify the data access attribute should be
140 * *_input rather than *_raw.
141 * @modified: Does a modifier apply to this channel. What these are
142 * depends on the channel type. Modifier is set in
143 * channel2. Examples are IIO_MOD_X for axial sensors about
144 * the 'x' axis.
145 * @indexed: Specify the channel has a numerical index. If not,
146 * the value in channel will be suppressed for attribute
147 * but not for event codes. Typically set it to 0 when
148 * the index is false.
149 * @differential: Channel is differential.
150 */
151 struct iio_chan_spec {
152 enum iio_chan_type type;
153 int channel;
154 int channel2;
155 unsigned long address;
156 int scan_index;
157 struct {
158 char sign;
159 u8 realbits;
160 u8 storagebits;
161 u8 shift;
162 enum iio_endian endianness;
163 } scan_type;
164 long info_mask;
165 long event_mask;
166 const struct iio_chan_spec_ext_info *ext_info;
167 char *extend_name;
168 const char *datasheet_name;
169 unsigned processed_val:1;
170 unsigned modified:1;
171 unsigned indexed:1;
172 unsigned output:1;
173 unsigned differential:1;
174 };
175
176 #define IIO_ST(si, rb, sb, sh) \
177 { .sign = si, .realbits = rb, .storagebits = sb, .shift = sh }
178
179 /* Macro assumes input channels */
180 #define IIO_CHAN(_type, _mod, _indexed, _proc, _name, _chan, _chan2, \
181 _inf_mask, _address, _si, _stype, _event_mask) \
182 { .type = _type, \
183 .output = 0, \
184 .modified = _mod, \
185 .indexed = _indexed, \
186 .processed_val = _proc, \
187 .extend_name = _name, \
188 .channel = _chan, \
189 .channel2 = _chan2, \
190 .info_mask = _inf_mask, \
191 .address = _address, \
192 .scan_index = _si, \
193 .scan_type = _stype, \
194 .event_mask = _event_mask }
195
196 #define IIO_CHAN_SOFT_TIMESTAMP(_si) \
197 { .type = IIO_TIMESTAMP, .channel = -1, \
198 .scan_index = _si, .scan_type = IIO_ST('s', 64, 64, 0) }
199
200 /**
201 * iio_get_time_ns() - utility function to get a time stamp for events etc
202 **/
iio_get_time_ns(void)203 static inline s64 iio_get_time_ns(void)
204 {
205 struct timespec ts;
206 /*
207 * calls getnstimeofday.
208 * If hrtimers then up to ns accurate, if not microsecond.
209 */
210 ktime_get_real_ts(&ts);
211
212 return timespec_to_ns(&ts);
213 }
214
215 /* Device operating modes */
216 #define INDIO_DIRECT_MODE 0x01
217 #define INDIO_BUFFER_TRIGGERED 0x02
218 #define INDIO_BUFFER_HARDWARE 0x08
219
220 #define INDIO_ALL_BUFFER_MODES \
221 (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE)
222
223 struct iio_trigger; /* forward declaration */
224 struct iio_dev;
225
226 /**
227 * struct iio_info - constant information about device
228 * @driver_module: module structure used to ensure correct
229 * ownership of chrdevs etc
230 * @event_attrs: event control attributes
231 * @attrs: general purpose device attributes
232 * @read_raw: function to request a value from the device.
233 * mask specifies which value. Note 0 means a reading of
234 * the channel in question. Return value will specify the
235 * type of value returned by the device. val and val2 will
236 * contain the elements making up the returned value.
237 * @write_raw: function to write a value to the device.
238 * Parameters are the same as for read_raw.
239 * @write_raw_get_fmt: callback function to query the expected
240 * format/precision. If not set by the driver, write_raw
241 * returns IIO_VAL_INT_PLUS_MICRO.
242 * @read_event_config: find out if the event is enabled.
243 * @write_event_config: set if the event is enabled.
244 * @read_event_value: read a value associated with the event. Meaning
245 * is event dependant. event_code specifies which event.
246 * @write_event_value: write the value associated with the event.
247 * Meaning is event dependent.
248 * @validate_trigger: function to validate the trigger when the
249 * current trigger gets changed.
250 **/
251 struct iio_info {
252 struct module *driver_module;
253 struct attribute_group *event_attrs;
254 const struct attribute_group *attrs;
255
256 int (*read_raw)(struct iio_dev *indio_dev,
257 struct iio_chan_spec const *chan,
258 int *val,
259 int *val2,
260 long mask);
261
262 int (*write_raw)(struct iio_dev *indio_dev,
263 struct iio_chan_spec const *chan,
264 int val,
265 int val2,
266 long mask);
267
268 int (*write_raw_get_fmt)(struct iio_dev *indio_dev,
269 struct iio_chan_spec const *chan,
270 long mask);
271
272 int (*read_event_config)(struct iio_dev *indio_dev,
273 u64 event_code);
274
275 int (*write_event_config)(struct iio_dev *indio_dev,
276 u64 event_code,
277 int state);
278
279 int (*read_event_value)(struct iio_dev *indio_dev,
280 u64 event_code,
281 int *val);
282 int (*write_event_value)(struct iio_dev *indio_dev,
283 u64 event_code,
284 int val);
285 int (*validate_trigger)(struct iio_dev *indio_dev,
286 struct iio_trigger *trig);
287 int (*update_scan_mode)(struct iio_dev *indio_dev,
288 const unsigned long *scan_mask);
289 int (*debugfs_reg_access)(struct iio_dev *indio_dev,
290 unsigned reg, unsigned writeval,
291 unsigned *readval);
292 };
293
294 /**
295 * struct iio_buffer_setup_ops - buffer setup related callbacks
296 * @preenable: [DRIVER] function to run prior to marking buffer enabled
297 * @postenable: [DRIVER] function to run after marking buffer enabled
298 * @predisable: [DRIVER] function to run prior to marking buffer
299 * disabled
300 * @postdisable: [DRIVER] function to run after marking buffer disabled
301 */
302 struct iio_buffer_setup_ops {
303 int (*preenable)(struct iio_dev *);
304 int (*postenable)(struct iio_dev *);
305 int (*predisable)(struct iio_dev *);
306 int (*postdisable)(struct iio_dev *);
307 };
308
309 /**
310 * struct iio_dev - industrial I/O device
311 * @id: [INTERN] used to identify device internally
312 * @modes: [DRIVER] operating modes supported by device
313 * @currentmode: [DRIVER] current operating mode
314 * @dev: [DRIVER] device structure, should be assigned a parent
315 * and owner
316 * @event_interface: [INTERN] event chrdevs associated with interrupt lines
317 * @buffer: [DRIVER] any buffer present
318 * @mlock: [INTERN] lock used to prevent simultaneous device state
319 * changes
320 * @available_scan_masks: [DRIVER] optional array of allowed bitmasks
321 * @masklength: [INTERN] the length of the mask established from
322 * channels
323 * @active_scan_mask: [INTERN] union of all scan masks requested by buffers
324 * @trig: [INTERN] current device trigger (buffer modes)
325 * @pollfunc: [DRIVER] function run on trigger being received
326 * @channels: [DRIVER] channel specification structure table
327 * @num_channels: [DRIVER] number of chanels specified in @channels.
328 * @channel_attr_list: [INTERN] keep track of automatically created channel
329 * attributes
330 * @chan_attr_group: [INTERN] group for all attrs in base directory
331 * @name: [DRIVER] name of the device.
332 * @info: [DRIVER] callbacks and constant info from driver
333 * @info_exist_lock: [INTERN] lock to prevent use during removal
334 * @chrdev: [INTERN] associated character device
335 * @groups: [INTERN] attribute groups
336 * @groupcounter: [INTERN] index of next attribute group
337 * @flags: [INTERN] file ops related flags including busy flag.
338 * @debugfs_dentry: [INTERN] device specific debugfs dentry.
339 * @cached_reg_addr: [INTERN] cached register address for debugfs reads.
340 */
341 struct iio_dev {
342 int id;
343
344 int modes;
345 int currentmode;
346 struct device dev;
347
348 struct iio_event_interface *event_interface;
349
350 struct iio_buffer *buffer;
351 struct mutex mlock;
352
353 const unsigned long *available_scan_masks;
354 unsigned masklength;
355 const unsigned long *active_scan_mask;
356 struct iio_trigger *trig;
357 struct iio_poll_func *pollfunc;
358
359 struct iio_chan_spec const *channels;
360 int num_channels;
361
362 struct list_head channel_attr_list;
363 struct attribute_group chan_attr_group;
364 const char *name;
365 const struct iio_info *info;
366 struct mutex info_exist_lock;
367 const struct iio_buffer_setup_ops *setup_ops;
368 struct cdev chrdev;
369 #define IIO_MAX_GROUPS 6
370 const struct attribute_group *groups[IIO_MAX_GROUPS + 1];
371 int groupcounter;
372
373 unsigned long flags;
374 #if defined(CONFIG_DEBUG_FS)
375 struct dentry *debugfs_dentry;
376 unsigned cached_reg_addr;
377 #endif
378 };
379
380 /**
381 * iio_find_channel_from_si() - get channel from its scan index
382 * @indio_dev: device
383 * @si: scan index to match
384 */
385 const struct iio_chan_spec
386 *iio_find_channel_from_si(struct iio_dev *indio_dev, int si);
387
388 /**
389 * iio_device_register() - register a device with the IIO subsystem
390 * @indio_dev: Device structure filled by the device driver
391 **/
392 int iio_device_register(struct iio_dev *indio_dev);
393
394 /**
395 * iio_device_unregister() - unregister a device from the IIO subsystem
396 * @indio_dev: Device structure representing the device.
397 **/
398 void iio_device_unregister(struct iio_dev *indio_dev);
399
400 /**
401 * iio_push_event() - try to add event to the list for userspace reading
402 * @indio_dev: IIO device structure
403 * @ev_code: What event
404 * @timestamp: When the event occurred
405 **/
406 int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);
407
408 extern struct bus_type iio_bus_type;
409
410 /**
411 * iio_put_device() - reference counted deallocation of struct device
412 * @dev: the iio_device containing the device
413 **/
iio_put_device(struct iio_dev * indio_dev)414 static inline void iio_put_device(struct iio_dev *indio_dev)
415 {
416 if (indio_dev)
417 put_device(&indio_dev->dev);
418 };
419
420 /* Can we make this smaller? */
421 #define IIO_ALIGN L1_CACHE_BYTES
422 /**
423 * iio_allocate_device() - allocate an iio_dev from a driver
424 * @sizeof_priv: Space to allocate for private structure.
425 **/
426 struct iio_dev *iio_allocate_device(int sizeof_priv);
427
iio_priv(const struct iio_dev * indio_dev)428 static inline void *iio_priv(const struct iio_dev *indio_dev)
429 {
430 return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN);
431 }
432
iio_priv_to_dev(void * priv)433 static inline struct iio_dev *iio_priv_to_dev(void *priv)
434 {
435 return (struct iio_dev *)((char *)priv -
436 ALIGN(sizeof(struct iio_dev), IIO_ALIGN));
437 }
438
439 /**
440 * iio_free_device() - free an iio_dev from a driver
441 * @dev: the iio_dev associated with the device
442 **/
443 void iio_free_device(struct iio_dev *indio_dev);
444
445 /**
446 * iio_buffer_enabled() - helper function to test if the buffer is enabled
447 * @indio_dev: IIO device info structure for device
448 **/
iio_buffer_enabled(struct iio_dev * indio_dev)449 static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
450 {
451 return indio_dev->currentmode
452 & (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE);
453 };
454
455 /**
456 * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry
457 * @indio_dev: IIO device info structure for device
458 **/
459 #if defined(CONFIG_DEBUG_FS)
iio_get_debugfs_dentry(struct iio_dev * indio_dev)460 static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
461 {
462 return indio_dev->debugfs_dentry;
463 };
464 #else
iio_get_debugfs_dentry(struct iio_dev * indio_dev)465 static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
466 {
467 return NULL;
468 };
469 #endif
470
471 #endif /* _INDUSTRIAL_IO_H_ */
472