]> git.karo-electronics.de Git - karo-tx-linux.git/blob - include/linux/iio/iio.h
memcg, slab: do not destroy children caches if parent has aliases
[karo-tx-linux.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_CHAN_SOFT_TIMESTAMP(_si) {                                  \
258         .type = IIO_TIMESTAMP,                                          \
259         .channel = -1,                                                  \
260         .scan_index = _si,                                              \
261         .scan_type = {                                                  \
262                 .sign = 's',                                            \
263                 .realbits = 64,                                 \
264                 .storagebits = 64,                                      \
265                 },                                                      \
266 }
267
268 /**
269  * iio_get_time_ns() - utility function to get a time stamp for events etc
270  **/
271 static inline s64 iio_get_time_ns(void)
272 {
273         struct timespec ts;
274         /*
275          * calls getnstimeofday.
276          * If hrtimers then up to ns accurate, if not microsecond.
277          */
278         ktime_get_real_ts(&ts);
279
280         return timespec_to_ns(&ts);
281 }
282
283 /* Device operating modes */
284 #define INDIO_DIRECT_MODE               0x01
285 #define INDIO_BUFFER_TRIGGERED          0x02
286 #define INDIO_BUFFER_HARDWARE           0x08
287
288 #define INDIO_ALL_BUFFER_MODES                                  \
289         (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE)
290
291 struct iio_trigger; /* forward declaration */
292 struct iio_dev;
293
294 /**
295  * struct iio_info - constant information about device
296  * @driver_module:      module structure used to ensure correct
297  *                      ownership of chrdevs etc
298  * @event_attrs:        event control attributes
299  * @attrs:              general purpose device attributes
300  * @read_raw:           function to request a value from the device.
301  *                      mask specifies which value. Note 0 means a reading of
302  *                      the channel in question.  Return value will specify the
303  *                      type of value returned by the device. val and val2 will
304  *                      contain the elements making up the returned value.
305  * @write_raw:          function to write a value to the device.
306  *                      Parameters are the same as for read_raw.
307  * @write_raw_get_fmt:  callback function to query the expected
308  *                      format/precision. If not set by the driver, write_raw
309  *                      returns IIO_VAL_INT_PLUS_MICRO.
310  * @read_event_config:  find out if the event is enabled.
311  * @write_event_config: set if the event is enabled.
312  * @read_event_value:   read a configuration value associated with the event.
313  * @write_event_value:  write a configuration value for the event.
314  * @validate_trigger:   function to validate the trigger when the
315  *                      current trigger gets changed.
316  * @update_scan_mode:   function to configure device and scan buffer when
317  *                      channels have changed
318  * @debugfs_reg_access: function to read or write register value of device
319  **/
320 struct iio_info {
321         struct module                   *driver_module;
322         struct attribute_group          *event_attrs;
323         const struct attribute_group    *attrs;
324
325         int (*read_raw)(struct iio_dev *indio_dev,
326                         struct iio_chan_spec const *chan,
327                         int *val,
328                         int *val2,
329                         long mask);
330
331         int (*write_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_get_fmt)(struct iio_dev *indio_dev,
338                          struct iio_chan_spec const *chan,
339                          long mask);
340
341         int (*read_event_config)(struct iio_dev *indio_dev,
342                                  const struct iio_chan_spec *chan,
343                                  enum iio_event_type type,
344                                  enum iio_event_direction dir);
345
346         int (*write_event_config)(struct iio_dev *indio_dev,
347                                   const struct iio_chan_spec *chan,
348                                   enum iio_event_type type,
349                                   enum iio_event_direction dir,
350                                   int state);
351
352         int (*read_event_value)(struct iio_dev *indio_dev,
353                                 const struct iio_chan_spec *chan,
354                                 enum iio_event_type type,
355                                 enum iio_event_direction dir,
356                                 enum iio_event_info info, int *val, int *val2);
357
358         int (*write_event_value)(struct iio_dev *indio_dev,
359                                  const struct iio_chan_spec *chan,
360                                  enum iio_event_type type,
361                                  enum iio_event_direction dir,
362                                  enum iio_event_info info, int val, int val2);
363
364         int (*validate_trigger)(struct iio_dev *indio_dev,
365                                 struct iio_trigger *trig);
366         int (*update_scan_mode)(struct iio_dev *indio_dev,
367                                 const unsigned long *scan_mask);
368         int (*debugfs_reg_access)(struct iio_dev *indio_dev,
369                                   unsigned reg, unsigned writeval,
370                                   unsigned *readval);
371 };
372
373 /**
374  * struct iio_buffer_setup_ops - buffer setup related callbacks
375  * @preenable:          [DRIVER] function to run prior to marking buffer enabled
376  * @postenable:         [DRIVER] function to run after marking buffer enabled
377  * @predisable:         [DRIVER] function to run prior to marking buffer
378  *                      disabled
379  * @postdisable:        [DRIVER] function to run after marking buffer disabled
380  * @validate_scan_mask: [DRIVER] function callback to check whether a given
381  *                      scan mask is valid for the device.
382  */
383 struct iio_buffer_setup_ops {
384         int (*preenable)(struct iio_dev *);
385         int (*postenable)(struct iio_dev *);
386         int (*predisable)(struct iio_dev *);
387         int (*postdisable)(struct iio_dev *);
388         bool (*validate_scan_mask)(struct iio_dev *indio_dev,
389                                    const unsigned long *scan_mask);
390 };
391
392 /**
393  * struct iio_dev - industrial I/O device
394  * @id:                 [INTERN] used to identify device internally
395  * @modes:              [DRIVER] operating modes supported by device
396  * @currentmode:        [DRIVER] current operating mode
397  * @dev:                [DRIVER] device structure, should be assigned a parent
398  *                      and owner
399  * @event_interface:    [INTERN] event chrdevs associated with interrupt lines
400  * @buffer:             [DRIVER] any buffer present
401  * @buffer_list:        [INTERN] list of all buffers currently attached
402  * @scan_bytes:         [INTERN] num bytes captured to be fed to buffer demux
403  * @mlock:              [INTERN] lock used to prevent simultaneous device state
404  *                      changes
405  * @available_scan_masks: [DRIVER] optional array of allowed bitmasks
406  * @masklength:         [INTERN] the length of the mask established from
407  *                      channels
408  * @active_scan_mask:   [INTERN] union of all scan masks requested by buffers
409  * @scan_timestamp:     [INTERN] set if any buffers have requested timestamp
410  * @scan_index_timestamp:[INTERN] cache of the index to the timestamp
411  * @trig:               [INTERN] current device trigger (buffer modes)
412  * @pollfunc:           [DRIVER] function run on trigger being received
413  * @channels:           [DRIVER] channel specification structure table
414  * @num_channels:       [DRIVER] number of channels specified in @channels.
415  * @channel_attr_list:  [INTERN] keep track of automatically created channel
416  *                      attributes
417  * @chan_attr_group:    [INTERN] group for all attrs in base directory
418  * @name:               [DRIVER] name of the device.
419  * @info:               [DRIVER] callbacks and constant info from driver
420  * @info_exist_lock:    [INTERN] lock to prevent use during removal
421  * @setup_ops:          [DRIVER] callbacks to call before and after buffer
422  *                      enable/disable
423  * @chrdev:             [INTERN] associated character device
424  * @groups:             [INTERN] attribute groups
425  * @groupcounter:       [INTERN] index of next attribute group
426  * @flags:              [INTERN] file ops related flags including busy flag.
427  * @debugfs_dentry:     [INTERN] device specific debugfs dentry.
428  * @cached_reg_addr:    [INTERN] cached register address for debugfs reads.
429  */
430 struct iio_dev {
431         int                             id;
432
433         int                             modes;
434         int                             currentmode;
435         struct device                   dev;
436
437         struct iio_event_interface      *event_interface;
438
439         struct iio_buffer               *buffer;
440         struct list_head                buffer_list;
441         int                             scan_bytes;
442         struct mutex                    mlock;
443
444         const unsigned long             *available_scan_masks;
445         unsigned                        masklength;
446         const unsigned long             *active_scan_mask;
447         bool                            scan_timestamp;
448         unsigned                        scan_index_timestamp;
449         struct iio_trigger              *trig;
450         struct iio_poll_func            *pollfunc;
451
452         struct iio_chan_spec const      *channels;
453         int                             num_channels;
454
455         struct list_head                channel_attr_list;
456         struct attribute_group          chan_attr_group;
457         const char                      *name;
458         const struct iio_info           *info;
459         struct mutex                    info_exist_lock;
460         const struct iio_buffer_setup_ops       *setup_ops;
461         struct cdev                     chrdev;
462 #define IIO_MAX_GROUPS 6
463         const struct attribute_group    *groups[IIO_MAX_GROUPS + 1];
464         int                             groupcounter;
465
466         unsigned long                   flags;
467 #if defined(CONFIG_DEBUG_FS)
468         struct dentry                   *debugfs_dentry;
469         unsigned                        cached_reg_addr;
470 #endif
471 };
472
473 const struct iio_chan_spec
474 *iio_find_channel_from_si(struct iio_dev *indio_dev, int si);
475 int iio_device_register(struct iio_dev *indio_dev);
476 void iio_device_unregister(struct iio_dev *indio_dev);
477 int devm_iio_device_register(struct device *dev, struct iio_dev *indio_dev);
478 void devm_iio_device_unregister(struct device *dev, struct iio_dev *indio_dev);
479 int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);
480
481 extern struct bus_type iio_bus_type;
482
483 /**
484  * iio_device_put() - reference counted deallocation of struct device
485  * @indio_dev:          IIO device structure containing the device
486  **/
487 static inline void iio_device_put(struct iio_dev *indio_dev)
488 {
489         if (indio_dev)
490                 put_device(&indio_dev->dev);
491 }
492
493 /**
494  * dev_to_iio_dev() - Get IIO device struct from a device struct
495  * @dev:                The device embedded in the IIO device
496  *
497  * Note: The device must be a IIO device, otherwise the result is undefined.
498  */
499 static inline struct iio_dev *dev_to_iio_dev(struct device *dev)
500 {
501         return container_of(dev, struct iio_dev, dev);
502 }
503
504 /**
505  * iio_device_get() - increment reference count for the device
506  * @indio_dev:          IIO device structure
507  *
508  * Returns: The passed IIO device
509  **/
510 static inline struct iio_dev *iio_device_get(struct iio_dev *indio_dev)
511 {
512         return indio_dev ? dev_to_iio_dev(get_device(&indio_dev->dev)) : NULL;
513 }
514
515
516 /**
517  * iio_device_set_drvdata() - Set device driver data
518  * @indio_dev: IIO device structure
519  * @data: Driver specific data
520  *
521  * Allows to attach an arbitrary pointer to an IIO device, which can later be
522  * retrieved by iio_device_get_drvdata().
523  */
524 static inline void iio_device_set_drvdata(struct iio_dev *indio_dev, void *data)
525 {
526         dev_set_drvdata(&indio_dev->dev, data);
527 }
528
529 /**
530  * iio_device_get_drvdata() - Get device driver data
531  * @indio_dev: IIO device structure
532  *
533  * Returns the data previously set with iio_device_set_drvdata()
534  */
535 static inline void *iio_device_get_drvdata(struct iio_dev *indio_dev)
536 {
537         return dev_get_drvdata(&indio_dev->dev);
538 }
539
540 /* Can we make this smaller? */
541 #define IIO_ALIGN L1_CACHE_BYTES
542 struct iio_dev *iio_device_alloc(int sizeof_priv);
543
544 static inline void *iio_priv(const struct iio_dev *indio_dev)
545 {
546         return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN);
547 }
548
549 static inline struct iio_dev *iio_priv_to_dev(void *priv)
550 {
551         return (struct iio_dev *)((char *)priv -
552                                   ALIGN(sizeof(struct iio_dev), IIO_ALIGN));
553 }
554
555 void iio_device_free(struct iio_dev *indio_dev);
556 struct iio_dev *devm_iio_device_alloc(struct device *dev, int sizeof_priv);
557 void devm_iio_device_free(struct device *dev, struct iio_dev *indio_dev);
558 struct iio_trigger *devm_iio_trigger_alloc(struct device *dev,
559                                                 const char *fmt, ...);
560 void devm_iio_trigger_free(struct device *dev, struct iio_trigger *iio_trig);
561
562 /**
563  * iio_buffer_enabled() - helper function to test if the buffer is enabled
564  * @indio_dev:          IIO device structure for device
565  **/
566 static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
567 {
568         return indio_dev->currentmode
569                 & (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE);
570 }
571
572 /**
573  * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry
574  * @indio_dev:          IIO device structure for device
575  **/
576 #if defined(CONFIG_DEBUG_FS)
577 static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
578 {
579         return indio_dev->debugfs_dentry;
580 }
581 #else
582 static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
583 {
584         return NULL;
585 }
586 #endif
587
588 int iio_str_to_fixpoint(const char *str, int fract_mult, int *integer,
589         int *fract);
590
591 /**
592  * IIO_DEGREE_TO_RAD() - Convert degree to rad
593  * @deg: A value in degree
594  *
595  * Returns the given value converted from degree to rad
596  */
597 #define IIO_DEGREE_TO_RAD(deg) (((deg) * 314159ULL + 9000000ULL) / 18000000ULL)
598
599 /**
600  * IIO_G_TO_M_S_2() - Convert g to meter / second**2
601  * @g: A value in g
602  *
603  * Returns the given value converted from g to meter / second**2
604  */
605 #define IIO_G_TO_M_S_2(g) ((g) * 980665ULL / 100000ULL)
606
607 #endif /* _INDUSTRIAL_IO_H_ */