Linux-libre 3.14.42-gnu
[librecmc/linux-libre.git] / include / linux / iio / iio.h
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 <linux/iio/types.h>
16 /* IIO TODO LIST */
17 /*
18  * Provide means of adjusting timer accuracy.
19  * Currently assumes nano seconds.
20  */
21
22 enum iio_chan_info_enum {
23         IIO_CHAN_INFO_RAW = 0,
24         IIO_CHAN_INFO_PROCESSED,
25         IIO_CHAN_INFO_SCALE,
26         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,
33         IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY,
34         IIO_CHAN_INFO_SAMP_FREQ,
35         IIO_CHAN_INFO_FREQUENCY,
36         IIO_CHAN_INFO_PHASE,
37         IIO_CHAN_INFO_HARDWAREGAIN,
38         IIO_CHAN_INFO_HYSTERESIS,
39         IIO_CHAN_INFO_INT_TIME,
40 };
41
42 enum iio_shared_by {
43         IIO_SEPARATE,
44         IIO_SHARED_BY_TYPE,
45         IIO_SHARED_BY_DIR,
46         IIO_SHARED_BY_ALL
47 };
48
49 enum iio_endian {
50         IIO_CPU,
51         IIO_BE,
52         IIO_LE,
53 };
54
55 struct iio_chan_spec;
56 struct 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.
64  * @private:    Data private to the driver.
65  */
66 struct iio_chan_spec_ext_info {
67         const char *name;
68         enum iio_shared_by shared;
69         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;
75 };
76
77 /**
78  * struct iio_enum - Enum channel info attribute
79  * @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.
83  *
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  */
93 struct 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
100 ssize_t iio_enum_available_read(struct iio_dev *indio_dev,
101         uintptr_t priv, const struct iio_chan_spec *chan, char *buf);
102 ssize_t iio_enum_read(struct iio_dev *indio_dev,
103         uintptr_t priv, const struct iio_chan_spec *chan, char *buf);
104 ssize_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
110  * @_name:      Attribute name
111  * @_shared:    Whether the attribute is shared between all channels
112  * @_e:         Pointer to an iio_enum struct
113  *
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
127  * @_name:      Attribute name ("_available" will be appended to the name)
128  * @_e:         Pointer to an iio_enum struct
129  *
130  * Creates a read only attribute which lists all the available enum items in a
131  * 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"), \
136         .shared = IIO_SHARED_BY_TYPE, \
137         .read = iio_enum_available_read, \
138         .private = (uintptr_t)(_e), \
139 }
140
141 /**
142  * 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  */
155 struct 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 /**
165  * struct iio_chan_spec - specification of a single channel
166  * @type:               What type of measurement is the channel making.
167  * @channel:            What number do we wish to assign the channel.
168  * @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.
172  * @scan_index:         Monotonic index to give ordering in scans when read
173  *                      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.
179  *                      endianness:     little or big endian
180  * @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
183  *                      by all channels of the same type.
184  * @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.
188  * @event_spec:         Array of events which should be registered for this
189  *                      channel.
190  * @num_event_specs:    Size of the event_spec array.
191  * @ext_info:           Array of extended info attributes for this channel.
192  *                      The array is NULL terminated, the last element should
193  *                      have its name field set to NULL.
194  * @extend_name:        Allows labeling of channel attributes with an
195  *                      informative name. Note this has no effect codes etc,
196  *                      unlike modifiers.
197  * @datasheet_name:     A name used in in-kernel mapping of channels. It should
198  *                      correspond to the first name that the channel is referred
199  *                      to by in the datasheet (e.g. IND), or the nearest
200  *                      possible compound name (e.g. IND-INC).
201  * @modified:           Does a modifier apply to this channel. What these are
202  *                      depends on the channel type.  Modifier is set in
203  *                      channel2. Examples are IIO_MOD_X for axial sensors about
204  *                      the 'x' axis.
205  * @indexed:            Specify the channel has a numerical index. If not,
206  *                      the channel index number will be suppressed for sysfs
207  *                      attributes but not for event codes.
208  * @output:             Channel is output.
209  * @differential:       Channel is differential.
210  */
211 struct iio_chan_spec {
212         enum iio_chan_type      type;
213         int                     channel;
214         int                     channel2;
215         unsigned long           address;
216         int                     scan_index;
217         struct {
218                 char    sign;
219                 u8      realbits;
220                 u8      storagebits;
221                 u8      shift;
222                 enum iio_endian endianness;
223         } scan_type;
224         long                    info_mask_separate;
225         long                    info_mask_shared_by_type;
226         long                    info_mask_shared_by_dir;
227         long                    info_mask_shared_by_all;
228         const struct iio_event_spec *event_spec;
229         unsigned int            num_event_specs;
230         const struct iio_chan_spec_ext_info *ext_info;
231         const char              *extend_name;
232         const char              *datasheet_name;
233         unsigned                modified:1;
234         unsigned                indexed:1;
235         unsigned                output:1;
236         unsigned                differential:1;
237 };
238
239
240 /**
241  * iio_channel_has_info() - Checks whether a channel supports a info attribute
242  * @chan: The channel to be queried
243  * @type: Type of the info attribute to be checked
244  *
245  * Returns true if the channels supports reporting values for the given info
246  * attribute type, false otherwise.
247  */
248 static inline bool iio_channel_has_info(const struct iio_chan_spec *chan,
249         enum iio_chan_info_enum type)
250 {
251         return (chan->info_mask_separate & BIT(type)) |
252                 (chan->info_mask_shared_by_type & BIT(type)) |
253                 (chan->info_mask_shared_by_dir & BIT(type)) |
254                 (chan->info_mask_shared_by_all & BIT(type));
255 }
256
257 #define IIO_ST(si, rb, sb, sh)                                          \
258         { .sign = si, .realbits = rb, .storagebits = sb, .shift = sh }
259
260 #define IIO_CHAN_SOFT_TIMESTAMP(_si)                                    \
261         { .type = IIO_TIMESTAMP, .channel = -1,                         \
262                         .scan_index = _si, .scan_type = IIO_ST('s', 64, 64, 0) }
263
264 /**
265  * iio_get_time_ns() - utility function to get a time stamp for events etc
266  **/
267 static inline s64 iio_get_time_ns(void)
268 {
269         struct timespec ts;
270         /*
271          * calls getnstimeofday.
272          * If hrtimers then up to ns accurate, if not microsecond.
273          */
274         ktime_get_real_ts(&ts);
275
276         return timespec_to_ns(&ts);
277 }
278
279 /* Device operating modes */
280 #define INDIO_DIRECT_MODE               0x01
281 #define INDIO_BUFFER_TRIGGERED          0x02
282 #define INDIO_BUFFER_HARDWARE           0x08
283
284 #define INDIO_ALL_BUFFER_MODES                                  \
285         (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE)
286
287 struct iio_trigger; /* forward declaration */
288 struct iio_dev;
289
290 /**
291  * struct iio_info - constant information about device
292  * @driver_module:      module structure used to ensure correct
293  *                      ownership of chrdevs etc
294  * @event_attrs:        event control attributes
295  * @attrs:              general purpose device attributes
296  * @read_raw:           function to request a value from the device.
297  *                      mask specifies which value. Note 0 means a reading of
298  *                      the channel in question.  Return value will specify the
299  *                      type of value returned by the device. val and val2 will
300  *                      contain the elements making up the returned value.
301  * @write_raw:          function to write a value to the device.
302  *                      Parameters are the same as for read_raw.
303  * @write_raw_get_fmt:  callback function to query the expected
304  *                      format/precision. If not set by the driver, write_raw
305  *                      returns IIO_VAL_INT_PLUS_MICRO.
306  * @read_event_config:  find out if the event is enabled.
307  * @write_event_config: set if the event is enabled.
308  * @read_event_value:   read a configuration value associated with the event.
309  * @write_event_value:  write a configuration value for the event.
310  * @validate_trigger:   function to validate the trigger when the
311  *                      current trigger gets changed.
312  * @update_scan_mode:   function to configure device and scan buffer when
313  *                      channels have changed
314  * @debugfs_reg_access: function to read or write register value of device
315  **/
316 struct iio_info {
317         struct module                   *driver_module;
318         struct attribute_group          *event_attrs;
319         const struct attribute_group    *attrs;
320
321         int (*read_raw)(struct iio_dev *indio_dev,
322                         struct iio_chan_spec const *chan,
323                         int *val,
324                         int *val2,
325                         long mask);
326
327         int (*write_raw)(struct iio_dev *indio_dev,
328                          struct iio_chan_spec const *chan,
329                          int val,
330                          int val2,
331                          long mask);
332
333         int (*write_raw_get_fmt)(struct iio_dev *indio_dev,
334                          struct iio_chan_spec const *chan,
335                          long mask);
336
337         int (*read_event_config)(struct iio_dev *indio_dev,
338                                  const struct iio_chan_spec *chan,
339                                  enum iio_event_type type,
340                                  enum iio_event_direction dir);
341
342         int (*write_event_config)(struct iio_dev *indio_dev,
343                                   const struct iio_chan_spec *chan,
344                                   enum iio_event_type type,
345                                   enum iio_event_direction dir,
346                                   int state);
347
348         int (*read_event_value)(struct iio_dev *indio_dev,
349                                 const struct iio_chan_spec *chan,
350                                 enum iio_event_type type,
351                                 enum iio_event_direction dir,
352                                 enum iio_event_info info, int *val, int *val2);
353
354         int (*write_event_value)(struct iio_dev *indio_dev,
355                                  const struct iio_chan_spec *chan,
356                                  enum iio_event_type type,
357                                  enum iio_event_direction dir,
358                                  enum iio_event_info info, int val, int val2);
359
360         int (*validate_trigger)(struct iio_dev *indio_dev,
361                                 struct iio_trigger *trig);
362         int (*update_scan_mode)(struct iio_dev *indio_dev,
363                                 const unsigned long *scan_mask);
364         int (*debugfs_reg_access)(struct iio_dev *indio_dev,
365                                   unsigned reg, unsigned writeval,
366                                   unsigned *readval);
367 };
368
369 /**
370  * struct iio_buffer_setup_ops - buffer setup related callbacks
371  * @preenable:          [DRIVER] function to run prior to marking buffer enabled
372  * @postenable:         [DRIVER] function to run after marking buffer enabled
373  * @predisable:         [DRIVER] function to run prior to marking buffer
374  *                      disabled
375  * @postdisable:        [DRIVER] function to run after marking buffer disabled
376  * @validate_scan_mask: [DRIVER] function callback to check whether a given
377  *                      scan mask is valid for the device.
378  */
379 struct iio_buffer_setup_ops {
380         int (*preenable)(struct iio_dev *);
381         int (*postenable)(struct iio_dev *);
382         int (*predisable)(struct iio_dev *);
383         int (*postdisable)(struct iio_dev *);
384         bool (*validate_scan_mask)(struct iio_dev *indio_dev,
385                                    const unsigned long *scan_mask);
386 };
387
388 /**
389  * struct iio_dev - industrial I/O device
390  * @id:                 [INTERN] used to identify device internally
391  * @modes:              [DRIVER] operating modes supported by device
392  * @currentmode:        [DRIVER] current operating mode
393  * @dev:                [DRIVER] device structure, should be assigned a parent
394  *                      and owner
395  * @event_interface:    [INTERN] event chrdevs associated with interrupt lines
396  * @buffer:             [DRIVER] any buffer present
397  * @buffer_list:        [INTERN] list of all buffers currently attached
398  * @scan_bytes:         [INTERN] num bytes captured to be fed to buffer demux
399  * @mlock:              [INTERN] lock used to prevent simultaneous device state
400  *                      changes
401  * @available_scan_masks: [DRIVER] optional array of allowed bitmasks
402  * @masklength:         [INTERN] the length of the mask established from
403  *                      channels
404  * @active_scan_mask:   [INTERN] union of all scan masks requested by buffers
405  * @scan_timestamp:     [INTERN] set if any buffers have requested timestamp
406  * @scan_index_timestamp:[INTERN] cache of the index to the timestamp
407  * @trig:               [INTERN] current device trigger (buffer modes)
408  * @pollfunc:           [DRIVER] function run on trigger being received
409  * @channels:           [DRIVER] channel specification structure table
410  * @num_channels:       [DRIVER] number of channels specified in @channels.
411  * @channel_attr_list:  [INTERN] keep track of automatically created channel
412  *                      attributes
413  * @chan_attr_group:    [INTERN] group for all attrs in base directory
414  * @name:               [DRIVER] name of the device.
415  * @info:               [DRIVER] callbacks and constant info from driver
416  * @info_exist_lock:    [INTERN] lock to prevent use during removal
417  * @setup_ops:          [DRIVER] callbacks to call before and after buffer
418  *                      enable/disable
419  * @chrdev:             [INTERN] associated character device
420  * @groups:             [INTERN] attribute groups
421  * @groupcounter:       [INTERN] index of next attribute group
422  * @flags:              [INTERN] file ops related flags including busy flag.
423  * @debugfs_dentry:     [INTERN] device specific debugfs dentry.
424  * @cached_reg_addr:    [INTERN] cached register address for debugfs reads.
425  */
426 struct iio_dev {
427         int                             id;
428
429         int                             modes;
430         int                             currentmode;
431         struct device                   dev;
432
433         struct iio_event_interface      *event_interface;
434
435         struct iio_buffer               *buffer;
436         struct list_head                buffer_list;
437         int                             scan_bytes;
438         struct mutex                    mlock;
439
440         const unsigned long             *available_scan_masks;
441         unsigned                        masklength;
442         const unsigned long             *active_scan_mask;
443         bool                            scan_timestamp;
444         unsigned                        scan_index_timestamp;
445         struct iio_trigger              *trig;
446         struct iio_poll_func            *pollfunc;
447
448         struct iio_chan_spec const      *channels;
449         int                             num_channels;
450
451         struct list_head                channel_attr_list;
452         struct attribute_group          chan_attr_group;
453         const char                      *name;
454         const struct iio_info           *info;
455         struct mutex                    info_exist_lock;
456         const struct iio_buffer_setup_ops       *setup_ops;
457         struct cdev                     chrdev;
458 #define IIO_MAX_GROUPS 6
459         const struct attribute_group    *groups[IIO_MAX_GROUPS + 1];
460         int                             groupcounter;
461
462         unsigned long                   flags;
463 #if defined(CONFIG_DEBUG_FS)
464         struct dentry                   *debugfs_dentry;
465         unsigned                        cached_reg_addr;
466 #endif
467 };
468
469 const struct iio_chan_spec
470 *iio_find_channel_from_si(struct iio_dev *indio_dev, int si);
471 int iio_device_register(struct iio_dev *indio_dev);
472 void iio_device_unregister(struct iio_dev *indio_dev);
473 int devm_iio_device_register(struct device *dev, struct iio_dev *indio_dev);
474 void devm_iio_device_unregister(struct device *dev, struct iio_dev *indio_dev);
475 int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);
476
477 extern struct bus_type iio_bus_type;
478
479 /**
480  * iio_device_put() - reference counted deallocation of struct device
481  * @indio_dev:          IIO device structure containing the device
482  **/
483 static inline void iio_device_put(struct iio_dev *indio_dev)
484 {
485         if (indio_dev)
486                 put_device(&indio_dev->dev);
487 }
488
489 /**
490  * dev_to_iio_dev() - Get IIO device struct from a device struct
491  * @dev:                The device embedded in the IIO device
492  *
493  * Note: The device must be a IIO device, otherwise the result is undefined.
494  */
495 static inline struct iio_dev *dev_to_iio_dev(struct device *dev)
496 {
497         return container_of(dev, struct iio_dev, dev);
498 }
499
500 /**
501  * iio_device_get() - increment reference count for the device
502  * @indio_dev:          IIO device structure
503  *
504  * Returns: The passed IIO device
505  **/
506 static inline struct iio_dev *iio_device_get(struct iio_dev *indio_dev)
507 {
508         return indio_dev ? dev_to_iio_dev(get_device(&indio_dev->dev)) : NULL;
509 }
510
511
512 /**
513  * iio_device_set_drvdata() - Set device driver data
514  * @indio_dev: IIO device structure
515  * @data: Driver specific data
516  *
517  * Allows to attach an arbitrary pointer to an IIO device, which can later be
518  * retrieved by iio_device_get_drvdata().
519  */
520 static inline void iio_device_set_drvdata(struct iio_dev *indio_dev, void *data)
521 {
522         dev_set_drvdata(&indio_dev->dev, data);
523 }
524
525 /**
526  * iio_device_get_drvdata() - Get device driver data
527  * @indio_dev: IIO device structure
528  *
529  * Returns the data previously set with iio_device_set_drvdata()
530  */
531 static inline void *iio_device_get_drvdata(struct iio_dev *indio_dev)
532 {
533         return dev_get_drvdata(&indio_dev->dev);
534 }
535
536 /* Can we make this smaller? */
537 #define IIO_ALIGN L1_CACHE_BYTES
538 struct iio_dev *iio_device_alloc(int sizeof_priv);
539
540 static inline void *iio_priv(const struct iio_dev *indio_dev)
541 {
542         return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN);
543 }
544
545 static inline struct iio_dev *iio_priv_to_dev(void *priv)
546 {
547         return (struct iio_dev *)((char *)priv -
548                                   ALIGN(sizeof(struct iio_dev), IIO_ALIGN));
549 }
550
551 void iio_device_free(struct iio_dev *indio_dev);
552 struct iio_dev *devm_iio_device_alloc(struct device *dev, int sizeof_priv);
553 void devm_iio_device_free(struct device *dev, struct iio_dev *indio_dev);
554 struct iio_trigger *devm_iio_trigger_alloc(struct device *dev,
555                                                 const char *fmt, ...);
556 void devm_iio_trigger_free(struct device *dev, struct iio_trigger *iio_trig);
557
558 /**
559  * iio_buffer_enabled() - helper function to test if the buffer is enabled
560  * @indio_dev:          IIO device structure for device
561  **/
562 static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
563 {
564         return indio_dev->currentmode
565                 & (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE);
566 }
567
568 /**
569  * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry
570  * @indio_dev:          IIO device structure for device
571  **/
572 #if defined(CONFIG_DEBUG_FS)
573 static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
574 {
575         return indio_dev->debugfs_dentry;
576 }
577 #else
578 static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
579 {
580         return NULL;
581 }
582 #endif
583
584 int iio_str_to_fixpoint(const char *str, int fract_mult, int *integer,
585         int *fract);
586
587 /**
588  * IIO_DEGREE_TO_RAD() - Convert degree to rad
589  * @deg: A value in degree
590  *
591  * Returns the given value converted from degree to rad
592  */
593 #define IIO_DEGREE_TO_RAD(deg) (((deg) * 314159ULL + 9000000ULL) / 18000000ULL)
594
595 /**
596  * IIO_G_TO_M_S_2() - Convert g to meter / second**2
597  * @g: A value in g
598  *
599  * Returns the given value converted from g to meter / second**2
600  */
601 #define IIO_G_TO_M_S_2(g) ((g) * 980665ULL / 100000ULL)
602
603 #endif /* _INDUSTRIAL_IO_H_ */