drivers/staging/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 "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 reserverd 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 };
  39
  40 #define IIO_CHAN_INFO_SHARED_BIT(type) BIT(type*2)
  41 #define IIO_CHAN_INFO_SEPARATE_BIT(type) BIT(type*2 + 1)
  42
  43 #define IIO_CHAN_INFO_SCALE_SEPARATE_BIT                \
  44         IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_SCALE)
  45 #define IIO_CHAN_INFO_SCALE_SHARED_BIT                  \
  46         IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_SCALE)
  47 #define IIO_CHAN_INFO_OFFSET_SEPARATE_BIT                       \
  48         IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_OFFSET)
  49 #define IIO_CHAN_INFO_OFFSET_SHARED_BIT                 \
  50         IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_OFFSET)
  51 #define IIO_CHAN_INFO_CALIBSCALE_SEPARATE_BIT                   \
  52         IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBSCALE)
  53 #define IIO_CHAN_INFO_CALIBSCALE_SHARED_BIT                     \
  54         IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBSCALE)
  55 #define IIO_CHAN_INFO_CALIBBIAS_SEPARATE_BIT                    \
  56         IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBBIAS)
  57 #define IIO_CHAN_INFO_CALIBBIAS_SHARED_BIT                      \
  58         IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBBIAS)
  59 #define IIO_CHAN_INFO_PEAK_SEPARATE_BIT                 \
  60         IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAK)
  61 #define IIO_CHAN_INFO_PEAK_SHARED_BIT                   \
  62         IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAK)
  63 #define IIO_CHAN_INFO_PEAKSCALE_SEPARATE_BIT                    \
  64         IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAKSCALE)
  65 #define IIO_CHAN_INFO_PEAKSCALE_SHARED_BIT                      \
  66         IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAKSCALE)
  67 #define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SEPARATE_BIT    \
  68         IIO_CHAN_INFO_SEPARATE_BIT(                             \
  69                 IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW)
  70 #define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SHARED_BIT      \
  71         IIO_CHAN_INFO_SHARED_BIT(                               \
  72                 IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW)
  73 #define IIO_CHAN_INFO_AVERAGE_RAW_SEPARATE_BIT                  \
  74         IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_AVERAGE_RAW)
  75 #define IIO_CHAN_INFO_AVERAGE_RAW_SHARED_BIT                    \
  76         IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_AVERAGE_RAW)
  77
  78 enum iio_endian {
  79         IIO_CPU,
  80         IIO_BE,
  81         IIO_LE,
  82 };
  83
  84 /**
  85  * struct iio_chan_spec - specification of a single channel
  86  * @type:               What type of measurement is the channel making.
  87  * @channel:            What number or name do we wish to asign the channel.
  88  * @channel2:           If there is a second number for a differential
  89  *                      channel then this is it. If modified is set then the
  90  *                      value here specifies the modifier.
  91  * @address:            Driver specific identifier.
  92  * @scan_index: Monotonic index to give ordering in scans when read
  93  *                      from a buffer.
  94  * @scan_type:          Sign:           's' or 'u' to specify signed or unsigned
  95  *                      realbits:       Number of valid bits of data
  96  *                      storage_bits:   Realbits + padding
  97  *                      shift:          Shift right by this before masking out
  98  *                                      realbits.
  99  *                      endianness:     little or big endian
 100  * @info_mask:          What information is to be exported about this channel.
 101  *                      This includes calibbias, scale etc.
 102  * @event_mask: What events can this channel produce.
 103  * @extend_name:        Allows labeling of channel attributes with an
 104  *                      informative name. Note this has no effect codes etc,
 105  *                      unlike modifiers.
 106  * @processed_val:      Flag to specify the data access attribute should be
 107  *                      *_input rather than *_raw.
 108  * @modified:           Does a modifier apply to this channel. What these are
 109  *                      depends on the channel type.  Modifier is set in
 110  *                      channel2. Examples are IIO_MOD_X for axial sensors about
 111  *                      the 'x' axis.
 112  * @indexed:            Specify the channel has a numerical index. If not,
 113  *                      the value in channel will be suppressed for attribute
 114  *                      but not for event codes. Typically set it to 0 when
 115  *                      the index is false.
 116  * @differential:       Channel is differential.
 117  */
 118 struct iio_chan_spec {
 119         enum iio_chan_type      type;
 120         int                     channel;
 121         int                     channel2;
 122         unsigned long           address;
 123         int                     scan_index;
 124         struct {
 125                 char    sign;
 126                 u8      realbits;
 127                 u8      storagebits;
 128                 u8      shift;
 129                 enum iio_endian endianness;
 130         } scan_type;
 131         long                    info_mask;
 132         long                    event_mask;
 133         char                    *extend_name;
 134         unsigned                processed_val:1;
 135         unsigned                modified:1;
 136         unsigned                indexed:1;
 137         unsigned                output:1;
 138         unsigned                differential:1;
 139 };
 140
 141 #define IIO_ST(si, rb, sb, sh)                                          \
 142         { .sign = si, .realbits = rb, .storagebits = sb, .shift = sh }
 143
 144 /* Macro assumes input channels */
 145 #define IIO_CHAN(_type, _mod, _indexed, _proc, _name, _chan, _chan2, \
 146                  _inf_mask, _address, _si, _stype, _event_mask)         \
 147         { .type = _type,                                                \
 148           .output = 0,                                                  \
 149           .modified = _mod,                                             \
 150           .indexed = _indexed,                                          \
 151           .processed_val = _proc,                                       \
 152           .extend_name = _name,                                         \
 153           .channel = _chan,                                             \
 154           .channel2 = _chan2,                                           \
 155           .info_mask = _inf_mask,                                       \
 156           .address = _address,                                          \
 157           .scan_index = _si,                                            \
 158           .scan_type = _stype,                                          \
 159           .event_mask = _event_mask }
 160
 161 #define IIO_CHAN_SOFT_TIMESTAMP(_si)                                    \
 162         { .type = IIO_TIMESTAMP, .channel = -1,                         \
 163                         .scan_index = _si, .scan_type = IIO_ST('s', 64, 64, 0) }
 164
 165 /**
 166  * iio_get_time_ns() - utility function to get a time stamp for events etc
 167  **/
 168 static inline s64 iio_get_time_ns(void)
 169 {
 170         struct timespec ts;
 171         /*
 172          * calls getnstimeofday.
 173          * If hrtimers then up to ns accurate, if not microsecond.
 174          */
 175         ktime_get_real_ts(&ts);
 176
 177         return timespec_to_ns(&ts);
 178 }
 179
 180 /* Device operating modes */
 181 #define INDIO_DIRECT_MODE               0x01
 182 #define INDIO_BUFFER_TRIGGERED          0x02
 183 #define INDIO_BUFFER_HARDWARE           0x08
 184
 185 #define INDIO_ALL_BUFFER_MODES                                  \
 186         (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE)
 187
 188 /* Vast majority of this is set by the industrialio subsystem on a
 189  * call to iio_device_register. */
 190 #define IIO_VAL_INT 1
 191 #define IIO_VAL_INT_PLUS_MICRO 2
 192 #define IIO_VAL_INT_PLUS_NANO 3
 193
 194 struct iio_trigger; /* forward declaration */
 195 struct iio_dev;
 196
 197 /**
 198  * struct iio_info - constant information about device
 199  * @driver_module:      module structure used to ensure correct
 200  *                      ownership of chrdevs etc
 201  * @event_attrs:        event control attributes
 202  * @attrs:              general purpose device attributes
 203  * @read_raw:           function to request a value from the device.
 204  *                      mask specifies which value. Note 0 means a reading of
 205  *                      the channel in question.  Return value will specify the
 206  *                      type of value returned by the device. val and val2 will
 207  *                      contain the elements making up the returned value.
 208  * @write_raw:          function to write a value to the device.
 209  *                      Parameters are the same as for read_raw.
 210  * @write_raw_get_fmt:  callback function to query the expected
 211  *                      format/precision. If not set by the driver, write_raw
 212  *                      returns IIO_VAL_INT_PLUS_MICRO.
 213  * @read_event_config:  find out if the event is enabled.
 214  * @write_event_config: set if the event is enabled.
 215  * @read_event_value:   read a value associated with the event. Meaning
 216  *                      is event dependant. event_code specifies which event.
 217  * @write_event_value:  write the value associate with the event.
 218  *                      Meaning is event dependent.
 219  * @validate_trigger:   function to validate the trigger when the
 220  *                      current trigger gets changed.
 221  **/
 222 struct iio_info {
 223         struct module                   *driver_module;
 224         struct attribute_group          *event_attrs;
 225         const struct attribute_group    *attrs;
 226
 227         int (*read_raw)(struct iio_dev *indio_dev,
 228                         struct iio_chan_spec const *chan,
 229                         int *val,
 230                         int *val2,
 231                         long mask);
 232
 233         int (*write_raw)(struct iio_dev *indio_dev,
 234                          struct iio_chan_spec const *chan,
 235                          int val,
 236                          int val2,
 237                          long mask);
 238
 239         int (*write_raw_get_fmt)(struct iio_dev *indio_dev,
 240                          struct iio_chan_spec const *chan,
 241                          long mask);
 242
 243         int (*read_event_config)(struct iio_dev *indio_dev,
 244                                  u64 event_code);
 245
 246         int (*write_event_config)(struct iio_dev *indio_dev,
 247                                   u64 event_code,
 248                                   int state);
 249
 250         int (*read_event_value)(struct iio_dev *indio_dev,
 251                                 u64 event_code,
 252                                 int *val);
 253         int (*write_event_value)(struct iio_dev *indio_dev,
 254                                  u64 event_code,
 255                                  int val);
 256         int (*validate_trigger)(struct iio_dev *indio_dev,
 257                                 struct iio_trigger *trig);
 258
 259 };
 260
 261 /**
 262  * struct iio_dev - industrial I/O device
 263  * @id:                 [INTERN] used to identify device internally
 264  * @modes:              [DRIVER] operating modes supported by device
 265  * @currentmode:        [DRIVER] current operating mode
 266  * @dev:                [DRIVER] device structure, should be assigned a parent
 267  *                      and owner
 268  * @event_interface:    [INTERN] event chrdevs associated with interrupt lines
 269  * @buffer:             [DRIVER] any buffer present
 270  * @mlock:              [INTERN] lock used to prevent simultaneous device state
 271  *                      changes
 272  * @available_scan_masks: [DRIVER] optional array of allowed bitmasks
 273  * @masklength:         [INTERN] the length of the mask established from
 274  *                      channels
 275  * @trig:               [INTERN] current device trigger (buffer modes)
 276  * @pollfunc:           [DRIVER] function run on trigger being received
 277  * @channels:           [DRIVER] channel specification structure table
 278  * @num_channels:       [DRIVER] number of chanels specified in @channels.
 279  * @channel_attr_list:  [INTERN] keep track of automatically created channel
 280  *                      attributes
 281  * @chan_attr_group:    [INTERN] group for all attrs in base directory
 282  * @name:               [DRIVER] name of the device.
 283  * @info:               [DRIVER] callbacks and constant info from driver
 284  * @chrdev:             [INTERN] associated character device
 285  * @groups:             [INTERN] attribute groups
 286  * @groupcounter:       [INTERN] index of next attribute group
 287  **/
 288 struct iio_dev {
 289         int                             id;
 290
 291         int                             modes;
 292         int                             currentmode;
 293         struct device                   dev;
 294
 295         struct iio_event_interface      *event_interface;
 296
 297         struct iio_buffer               *buffer;
 298         struct mutex                    mlock;
 299
 300         unsigned long                   *available_scan_masks;
 301         unsigned                        masklength;
 302         struct iio_trigger              *trig;
 303         struct iio_poll_func            *pollfunc;
 304
 305         struct iio_chan_spec const      *channels;
 306         int                             num_channels;
 307
 308         struct list_head                channel_attr_list;
 309         struct attribute_group          chan_attr_group;
 310         const char                      *name;
 311         const struct iio_info           *info;
 312         struct cdev                     chrdev;
 313 #define IIO_MAX_GROUPS 6
 314         const struct attribute_group    *groups[IIO_MAX_GROUPS + 1];
 315         int                             groupcounter;
 316 };
 317
 318 /**
 319  * iio_device_register() - register a device with the IIO subsystem
 320  * @indio_dev:          Device structure filled by the device driver
 321  **/
 322 int iio_device_register(struct iio_dev *indio_dev);
 323
 324 /**
 325  * iio_device_unregister() - unregister a device from the IIO subsystem
 326  * @indio_dev:          Device structure representing the device.
 327  **/
 328 void iio_device_unregister(struct iio_dev *indio_dev);
 329
 330 /**
 331  * iio_push_event() - try to add event to the list for userspace reading
 332  * @indio_dev:          IIO device structure
 333  * @ev_code:            What event
 334  * @timestamp:          When the event occurred
 335  **/
 336 int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);
 337
 338 extern struct bus_type iio_bus_type;
 339
 340 /**
 341  * iio_put_device() - reference counted deallocation of struct device
 342  * @dev: the iio_device containing the device
 343  **/
 344 static inline void iio_put_device(struct iio_dev *indio_dev)
 345 {
 346         if (indio_dev)
 347                 put_device(&indio_dev->dev);
 348 };
 349
 350 /* Can we make this smaller? */
 351 #define IIO_ALIGN L1_CACHE_BYTES
 352 /**
 353  * iio_allocate_device() - allocate an iio_dev from a driver
 354  * @sizeof_priv: Space to allocate for private structure.
 355  **/
 356 struct iio_dev *iio_allocate_device(int sizeof_priv);
 357
 358 static inline void *iio_priv(const struct iio_dev *indio_dev)
 359 {
 360         return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN);
 361 }
 362
 363 static inline struct iio_dev *iio_priv_to_dev(void *priv)
 364 {
 365         return (struct iio_dev *)((char *)priv -
 366                                   ALIGN(sizeof(struct iio_dev), IIO_ALIGN));
 367 }
 368
 369 /**
 370  * iio_free_device() - free an iio_dev from a driver
 371  * @dev: the iio_dev associated with the device
 372  **/
 373 void iio_free_device(struct iio_dev *indio_dev);
 374
 375 /**
 376  * iio_buffer_enabled() - helper function to test if the buffer is enabled
 377  * @indio_dev:          IIO device info structure for device
 378  **/
 379 static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
 380 {
 381         return indio_dev->currentmode
 382                 & (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE);
 383 };
 384
 385 #endif /* _INDUSTRIAL_IO_H_ */