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 #include <linux/of.h>
  17 /* IIO TODO LIST */
  18 /*
  19  * Provide means of adjusting timer accuracy.
  20  * Currently assumes nano seconds.
  21  */
  22
  23 enum iio_chan_info_enum {
  24         IIO_CHAN_INFO_RAW = 0,
  25         IIO_CHAN_INFO_PROCESSED,
  26         IIO_CHAN_INFO_SCALE,
  27         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,
  34         IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY,
  35         IIO_CHAN_INFO_HIGH_PASS_FILTER_3DB_FREQUENCY,
  36         IIO_CHAN_INFO_SAMP_FREQ,
  37         IIO_CHAN_INFO_FREQUENCY,
  38         IIO_CHAN_INFO_PHASE,
  39         IIO_CHAN_INFO_HARDWAREGAIN,
  40         IIO_CHAN_INFO_HYSTERESIS,
  41         IIO_CHAN_INFO_INT_TIME,
  42         IIO_CHAN_INFO_ENABLE,
  43         IIO_CHAN_INFO_CALIBHEIGHT,
  44         IIO_CHAN_INFO_CALIBWEIGHT,
  45         IIO_CHAN_INFO_DEBOUNCE_COUNT,
  46         IIO_CHAN_INFO_DEBOUNCE_TIME,
  47         IIO_CHAN_INFO_CALIBEMISSIVITY,
  48         IIO_CHAN_INFO_OVERSAMPLING_RATIO,
  49 };
  50
  51 enum iio_shared_by {
  52         IIO_SEPARATE,
  53         IIO_SHARED_BY_TYPE,
  54         IIO_SHARED_BY_DIR,
  55         IIO_SHARED_BY_ALL
  56 };
  57
  58 enum iio_endian {
  59         IIO_CPU,
  60         IIO_BE,
  61         IIO_LE,
  62 };
  63
  64 struct iio_chan_spec;
  65 struct 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.
  73  * @private:    Data private to the driver.
  74  */
  75 struct iio_chan_spec_ext_info {
  76         const char *name;
  77         enum iio_shared_by shared;
  78         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;
  84 };
  85
  86 /**
  87  * struct iio_enum - Enum channel info attribute
  88  * @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.
  92  *
  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  */
 102 struct 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
 109 ssize_t iio_enum_available_read(struct iio_dev *indio_dev,
 110         uintptr_t priv, const struct iio_chan_spec *chan, char *buf);
 111 ssize_t iio_enum_read(struct iio_dev *indio_dev,
 112         uintptr_t priv, const struct iio_chan_spec *chan, char *buf);
 113 ssize_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
 119  * @_name:      Attribute name
 120  * @_shared:    Whether the attribute is shared between all channels
 121  * @_e:         Pointer to an iio_enum struct
 122  *
 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
 136  * @_name:      Attribute name ("_available" will be appended to the name)
 137  * @_e:         Pointer to an iio_enum struct
 138  *
 139  * Creates a read only attribute which lists all the available enum items in a
 140  * 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"), \
 145         .shared = IIO_SHARED_BY_TYPE, \
 146         .read = iio_enum_available_read, \
 147         .private = (uintptr_t)(_e), \
 148 }
 149
 150 /**
 151  * struct iio_mount_matrix - iio mounting matrix
 152  * @rotation: 3 dimensional space rotation matrix defining sensor alignment with
 153  *            main hardware
 154  */
 155 struct iio_mount_matrix {
 156         const char *rotation[9];
 157 };
 158
 159 ssize_t iio_show_mount_matrix(struct iio_dev *indio_dev, uintptr_t priv,
 160                               const struct iio_chan_spec *chan, char *buf);
 161 int of_iio_read_mount_matrix(const struct device *dev, const char *propname,
 162                              struct iio_mount_matrix *matrix);
 163
 164 typedef const struct iio_mount_matrix *
 165         (iio_get_mount_matrix_t)(const struct iio_dev *indio_dev,
 166                                  const struct iio_chan_spec *chan);
 167
 168 /**
 169  * IIO_MOUNT_MATRIX() - Initialize mount matrix extended channel attribute
 170  * @_shared:    Whether the attribute is shared between all channels
 171  * @_get:       Pointer to an iio_get_mount_matrix_t accessor
 172  */
 173 #define IIO_MOUNT_MATRIX(_shared, _get) \
 174 { \
 175         .name = "mount_matrix", \
 176         .shared = (_shared), \
 177         .read = iio_show_mount_matrix, \
 178         .private = (uintptr_t)(_get), \
 179 }
 180
 181 /**
 182  * struct iio_event_spec - specification for a channel event
 183  * @type:                   Type of the event
 184  * @dir:                    Direction of the event
 185  * @mask_separate:          Bit mask of enum iio_event_info values. Attributes
 186  *                          set in this mask will be registered per channel.
 187  * @mask_shared_by_type:    Bit mask of enum iio_event_info values. Attributes
 188  *                          set in this mask will be shared by channel type.
 189  * @mask_shared_by_dir:     Bit mask of enum iio_event_info values. Attributes
 190  *                          set in this mask will be shared by channel type and
 191  *                          direction.
 192  * @mask_shared_by_all:     Bit mask of enum iio_event_info values. Attributes
 193  *                          set in this mask will be shared by all channels.
 194  */
 195 struct iio_event_spec {
 196         enum iio_event_type type;
 197         enum iio_event_direction dir;
 198         unsigned long mask_separate;
 199         unsigned long mask_shared_by_type;
 200         unsigned long mask_shared_by_dir;
 201         unsigned long mask_shared_by_all;
 202 };
 203
 204 /**
 205  * struct iio_chan_spec - specification of a single channel
 206  * @type:               What type of measurement is the channel making.
 207  * @channel:            What number do we wish to assign the channel.
 208  * @channel2:           If there is a second number for a differential
 209  *                      channel then this is it. If modified is set then the
 210  *                      value here specifies the modifier.
 211  * @address:            Driver specific identifier.
 212  * @scan_index:         Monotonic index to give ordering in scans when read
 213  *                      from a buffer.
 214  * @scan_type:          sign:           's' or 'u' to specify signed or unsigned
 215  *                      realbits:       Number of valid bits of data
 216  *                      storagebits:    Realbits + padding
 217  *                      shift:          Shift right by this before masking out
 218  *                                      realbits.
 219  *                      repeat:         Number of times real/storage bits
 220  *                                      repeats. When the repeat element is
 221  *                                      more than 1, then the type element in
 222  *                                      sysfs will show a repeat value.
 223  *                                      Otherwise, the number of repetitions is
 224  *                                      omitted.
 225  *                      endianness:     little or big endian
 226  * @info_mask_separate: What information is to be exported that is specific to
 227  *                      this channel.
 228  * @info_mask_separate_available: What availability information is to be
 229  *                      exported that is specific to this channel.
 230  * @info_mask_shared_by_type: What information is to be exported that is shared
 231  *                      by all channels of the same type.
 232  * @info_mask_shared_by_type_available: What availability information is to be
 233  *                      exported that is shared by all channels of the same
 234  *                      type.
 235  * @info_mask_shared_by_dir: What information is to be exported that is shared
 236  *                      by all channels of the same direction.
 237  * @info_mask_shared_by_dir_available: What availability information is to be
 238  *                      exported that is shared by all channels of the same
 239  *                      direction.
 240  * @info_mask_shared_by_all: What information is to be exported that is shared
 241  *                      by all channels.
 242  * @info_mask_shared_by_all_available: What availability information is to be
 243  *                      exported that is shared by all channels.
 244  * @event_spec:         Array of events which should be registered for this
 245  *                      channel.
 246  * @num_event_specs:    Size of the event_spec array.
 247  * @ext_info:           Array of extended info attributes for this channel.
 248  *                      The array is NULL terminated, the last element should
 249  *                      have its name field set to NULL.
 250  * @extend_name:        Allows labeling of channel attributes with an
 251  *                      informative name. Note this has no effect codes etc,
 252  *                      unlike modifiers.
 253  * @datasheet_name:     A name used in in-kernel mapping of channels. It should
 254  *                      correspond to the first name that the channel is referred
 255  *                      to by in the datasheet (e.g. IND), or the nearest
 256  *                      possible compound name (e.g. IND-INC).
 257  * @modified:           Does a modifier apply to this channel. What these are
 258  *                      depends on the channel type.  Modifier is set in
 259  *                      channel2. Examples are IIO_MOD_X for axial sensors about
 260  *                      the 'x' axis.
 261  * @indexed:            Specify the channel has a numerical index. If not,
 262  *                      the channel index number will be suppressed for sysfs
 263  *                      attributes but not for event codes.
 264  * @output:             Channel is output.
 265  * @differential:       Channel is differential.
 266  */
 267 struct iio_chan_spec {
 268         enum iio_chan_type      type;
 269         int                     channel;
 270         int                     channel2;
 271         unsigned long           address;
 272         int                     scan_index;
 273         struct {
 274                 char    sign;
 275                 u8      realbits;
 276                 u8      storagebits;
 277                 u8      shift;
 278                 u8      repeat;
 279                 enum iio_endian endianness;
 280         } scan_type;
 281         long                    info_mask_separate;
 282         long                    info_mask_separate_available;
 283         long                    info_mask_shared_by_type;
 284         long                    info_mask_shared_by_type_available;
 285         long                    info_mask_shared_by_dir;
 286         long                    info_mask_shared_by_dir_available;
 287         long                    info_mask_shared_by_all;
 288         long                    info_mask_shared_by_all_available;
 289         const struct iio_event_spec *event_spec;
 290         unsigned int            num_event_specs;
 291         const struct iio_chan_spec_ext_info *ext_info;
 292         const char              *extend_name;
 293         const char              *datasheet_name;
 294         unsigned                modified:1;
 295         unsigned                indexed:1;
 296         unsigned                output:1;
 297         unsigned                differential:1;
 298 };
 299
 300
 301 /**
 302  * iio_channel_has_info() - Checks whether a channel supports a info attribute
 303  * @chan: The channel to be queried
 304  * @type: Type of the info attribute to be checked
 305  *
 306  * Returns true if the channels supports reporting values for the given info
 307  * attribute type, false otherwise.
 308  */
 309 static inline bool iio_channel_has_info(const struct iio_chan_spec *chan,
 310         enum iio_chan_info_enum type)
 311 {
 312         return (chan->info_mask_separate & BIT(type)) |
 313                 (chan->info_mask_shared_by_type & BIT(type)) |
 314                 (chan->info_mask_shared_by_dir & BIT(type)) |
 315                 (chan->info_mask_shared_by_all & BIT(type));
 316 }
 317
 318 /**
 319  * iio_channel_has_available() - Checks if a channel has an available attribute
 320  * @chan: The channel to be queried
 321  * @type: Type of the available attribute to be checked
 322  *
 323  * Returns true if the channel supports reporting available values for the
 324  * given attribute type, false otherwise.
 325  */
 326 static inline bool iio_channel_has_available(const struct iio_chan_spec *chan,
 327                                              enum iio_chan_info_enum type)
 328 {
 329         return (chan->info_mask_separate_available & BIT(type)) |
 330                 (chan->info_mask_shared_by_type_available & BIT(type)) |
 331                 (chan->info_mask_shared_by_dir_available & BIT(type)) |
 332                 (chan->info_mask_shared_by_all_available & BIT(type));
 333 }
 334
 335 #define IIO_CHAN_SOFT_TIMESTAMP(_si) {                                  \
 336         .type = IIO_TIMESTAMP,                                          \
 337         .channel = -1,                                                  \
 338         .scan_index = _si,                                              \
 339         .scan_type = {                                                  \
 340                 .sign = 's',                                            \
 341                 .realbits = 64,                                 \
 342                 .storagebits = 64,                                      \
 343                 },                                                      \
 344 }
 345
 346 s64 iio_get_time_ns(const struct iio_dev *indio_dev);
 347 unsigned int iio_get_time_res(const struct iio_dev *indio_dev);
 348
 349 /* Device operating modes */
 350 #define INDIO_DIRECT_MODE               0x01
 351 #define INDIO_BUFFER_TRIGGERED          0x02
 352 #define INDIO_BUFFER_SOFTWARE           0x04
 353 #define INDIO_BUFFER_HARDWARE           0x08
 354 #define INDIO_EVENT_TRIGGERED           0x10
 355 #define INDIO_HARDWARE_TRIGGERED        0x20
 356
 357 #define INDIO_ALL_BUFFER_MODES                                  \
 358         (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE | INDIO_BUFFER_SOFTWARE)
 359
 360 #define INDIO_ALL_TRIGGERED_MODES       \
 361         (INDIO_BUFFER_TRIGGERED         \
 362          | INDIO_EVENT_TRIGGERED        \
 363          | INDIO_HARDWARE_TRIGGERED)
 364
 365 #define INDIO_MAX_RAW_ELEMENTS          4
 366
 367 struct iio_trigger; /* forward declaration */
 368 struct iio_dev;
 369
 370 /**
 371  * struct iio_info - constant information about device
 372  * @driver_module:      module structure used to ensure correct
 373  *                      ownership of chrdevs etc
 374  * @event_attrs:        event control attributes
 375  * @attrs:              general purpose device attributes
 376  * @read_raw:           function to request a value from the device.
 377  *                      mask specifies which value. Note 0 means a reading of
 378  *                      the channel in question.  Return value will specify the
 379  *                      type of value returned by the device. val and val2 will
 380  *                      contain the elements making up the returned value.
 381  * @read_raw_multi:     function to return values from the device.
 382  *                      mask specifies which value. Note 0 means a reading of
 383  *                      the channel in question.  Return value will specify the
 384  *                      type of value returned by the device. vals pointer
 385  *                      contain the elements making up the returned value.
 386  *                      max_len specifies maximum number of elements
 387  *                      vals pointer can contain. val_len is used to return
 388  *                      length of valid elements in vals.
 389  * @read_avail:         function to return the available values from the device.
 390  *                      mask specifies which value. Note 0 means the available
 391  *                      values for the channel in question.  Return value
 392  *                      specifies if a IIO_AVAIL_LIST or a IIO_AVAIL_RANGE is
 393  *                      returned in vals. The type of the vals are returned in
 394  *                      type and the number of vals is returned in length. For
 395  *                      ranges, there are always three vals returned; min, step
 396  *                      and max. For lists, all possible values are enumerated.
 397  * @write_raw:          function to write a value to the device.
 398  *                      Parameters are the same as for read_raw.
 399  * @write_raw_get_fmt:  callback function to query the expected
 400  *                      format/precision. If not set by the driver, write_raw
 401  *                      returns IIO_VAL_INT_PLUS_MICRO.
 402  * @read_event_config:  find out if the event is enabled.
 403  * @write_event_config: set if the event is enabled.
 404  * @read_event_value:   read a configuration value associated with the event.
 405  * @write_event_value:  write a configuration value for the event.
 406  * @validate_trigger:   function to validate the trigger when the
 407  *                      current trigger gets changed.
 408  * @update_scan_mode:   function to configure device and scan buffer when
 409  *                      channels have changed
 410  * @debugfs_reg_access: function to read or write register value of device
 411  * @of_xlate:           function pointer to obtain channel specifier index.
 412  *                      When #iio-cells is greater than '0', the driver could
 413  *                      provide a custom of_xlate function that reads the
 414  *                      *args* and returns the appropriate index in registered
 415  *                      IIO channels array.
 416  * @hwfifo_set_watermark: function pointer to set the current hardware
 417  *                      fifo watermark level; see hwfifo_* entries in
 418  *                      Documentation/ABI/testing/sysfs-bus-iio for details on
 419  *                      how the hardware fifo operates
 420  * @hwfifo_flush_to_buffer: function pointer to flush the samples stored
 421  *                      in the hardware fifo to the device buffer. The driver
 422  *                      should not flush more than count samples. The function
 423  *                      must return the number of samples flushed, 0 if no
 424  *                      samples were flushed or a negative integer if no samples
 425  *                      were flushed and there was an error.
 426  **/
 427 struct iio_info {
 428         struct module                   *driver_module;
 429         const struct attribute_group    *event_attrs;
 430         const struct attribute_group    *attrs;
 431
 432         int (*read_raw)(struct iio_dev *indio_dev,
 433                         struct iio_chan_spec const *chan,
 434                         int *val,
 435                         int *val2,
 436                         long mask);
 437
 438         int (*read_raw_multi)(struct iio_dev *indio_dev,
 439                         struct iio_chan_spec const *chan,
 440                         int max_len,
 441                         int *vals,
 442                         int *val_len,
 443                         long mask);
 444
 445         int (*read_avail)(struct iio_dev *indio_dev,
 446                           struct iio_chan_spec const *chan,
 447                           const int **vals,
 448                           int *type,
 449                           int *length,
 450                           long mask);
 451
 452         int (*write_raw)(struct iio_dev *indio_dev,
 453                          struct iio_chan_spec const *chan,
 454                          int val,
 455                          int val2,
 456                          long mask);
 457
 458         int (*write_raw_get_fmt)(struct iio_dev *indio_dev,
 459                          struct iio_chan_spec const *chan,
 460                          long mask);
 461
 462         int (*read_event_config)(struct iio_dev *indio_dev,
 463                                  const struct iio_chan_spec *chan,
 464                                  enum iio_event_type type,
 465                                  enum iio_event_direction dir);
 466
 467         int (*write_event_config)(struct iio_dev *indio_dev,
 468                                   const struct iio_chan_spec *chan,
 469                                   enum iio_event_type type,
 470                                   enum iio_event_direction dir,
 471                                   int state);
 472
 473         int (*read_event_value)(struct iio_dev *indio_dev,
 474                                 const struct iio_chan_spec *chan,
 475                                 enum iio_event_type type,
 476                                 enum iio_event_direction dir,
 477                                 enum iio_event_info info, int *val, int *val2);
 478
 479         int (*write_event_value)(struct iio_dev *indio_dev,
 480                                  const struct iio_chan_spec *chan,
 481                                  enum iio_event_type type,
 482                                  enum iio_event_direction dir,
 483                                  enum iio_event_info info, int val, int val2);
 484
 485         int (*validate_trigger)(struct iio_dev *indio_dev,
 486                                 struct iio_trigger *trig);
 487         int (*update_scan_mode)(struct iio_dev *indio_dev,
 488                                 const unsigned long *scan_mask);
 489         int (*debugfs_reg_access)(struct iio_dev *indio_dev,
 490                                   unsigned reg, unsigned writeval,
 491                                   unsigned *readval);
 492         int (*of_xlate)(struct iio_dev *indio_dev,
 493                         const struct of_phandle_args *iiospec);
 494         int (*hwfifo_set_watermark)(struct iio_dev *indio_dev, unsigned val);
 495         int (*hwfifo_flush_to_buffer)(struct iio_dev *indio_dev,
 496                                       unsigned count);
 497 };
 498
 499 /**
 500  * struct iio_buffer_setup_ops - buffer setup related callbacks
 501  * @preenable:          [DRIVER] function to run prior to marking buffer enabled
 502  * @postenable:         [DRIVER] function to run after marking buffer enabled
 503  * @predisable:         [DRIVER] function to run prior to marking buffer
 504  *                      disabled
 505  * @postdisable:        [DRIVER] function to run after marking buffer disabled
 506  * @validate_scan_mask: [DRIVER] function callback to check whether a given
 507  *                      scan mask is valid for the device.
 508  */
 509 struct iio_buffer_setup_ops {
 510         int (*preenable)(struct iio_dev *);
 511         int (*postenable)(struct iio_dev *);
 512         int (*predisable)(struct iio_dev *);
 513         int (*postdisable)(struct iio_dev *);
 514         bool (*validate_scan_mask)(struct iio_dev *indio_dev,
 515                                    const unsigned long *scan_mask);
 516 };
 517
 518 /**
 519  * struct iio_dev - industrial I/O device
 520  * @id:                 [INTERN] used to identify device internally
 521  * @modes:              [DRIVER] operating modes supported by device
 522  * @currentmode:        [DRIVER] current operating mode
 523  * @dev:                [DRIVER] device structure, should be assigned a parent
 524  *                      and owner
 525  * @event_interface:    [INTERN] event chrdevs associated with interrupt lines
 526  * @buffer:             [DRIVER] any buffer present
 527  * @buffer_list:        [INTERN] list of all buffers currently attached
 528  * @scan_bytes:         [INTERN] num bytes captured to be fed to buffer demux
 529  * @mlock:              [DRIVER] lock used to prevent simultaneous device state
 530  *                      changes
 531  * @available_scan_masks: [DRIVER] optional array of allowed bitmasks
 532  * @masklength:         [INTERN] the length of the mask established from
 533  *                      channels
 534  * @active_scan_mask:   [INTERN] union of all scan masks requested by buffers
 535  * @scan_timestamp:     [INTERN] set if any buffers have requested timestamp
 536  * @scan_index_timestamp:[INTERN] cache of the index to the timestamp
 537  * @trig:               [INTERN] current device trigger (buffer modes)
 538  * @trig_readonly       [INTERN] mark the current trigger immutable
 539  * @pollfunc:           [DRIVER] function run on trigger being received
 540  * @pollfunc_event:     [DRIVER] function run on events trigger being received
 541  * @channels:           [DRIVER] channel specification structure table
 542  * @num_channels:       [DRIVER] number of channels specified in @channels.
 543  * @channel_attr_list:  [INTERN] keep track of automatically created channel
 544  *                      attributes
 545  * @chan_attr_group:    [INTERN] group for all attrs in base directory
 546  * @name:               [DRIVER] name of the device.
 547  * @info:               [DRIVER] callbacks and constant info from driver
 548  * @clock_id:           [INTERN] timestamping clock posix identifier
 549  * @info_exist_lock:    [INTERN] lock to prevent use during removal
 550  * @setup_ops:          [DRIVER] callbacks to call before and after buffer
 551  *                      enable/disable
 552  * @chrdev:             [INTERN] associated character device
 553  * @groups:             [INTERN] attribute groups
 554  * @groupcounter:       [INTERN] index of next attribute group
 555  * @flags:              [INTERN] file ops related flags including busy flag.
 556  * @debugfs_dentry:     [INTERN] device specific debugfs dentry.
 557  * @cached_reg_addr:    [INTERN] cached register address for debugfs reads.
 558  */
 559 struct iio_dev {
 560         int                             id;
 561
 562         int                             modes;
 563         int                             currentmode;
 564         struct device                   dev;
 565
 566         struct iio_event_interface      *event_interface;
 567
 568         struct iio_buffer               *buffer;
 569         struct list_head                buffer_list;
 570         int                             scan_bytes;
 571         struct mutex                    mlock;
 572
 573         const unsigned long             *available_scan_masks;
 574         unsigned                        masklength;
 575         const unsigned long             *active_scan_mask;
 576         bool                            scan_timestamp;
 577         unsigned                        scan_index_timestamp;
 578         struct iio_trigger              *trig;
 579         bool                            trig_readonly;
 580         struct iio_poll_func            *pollfunc;
 581         struct iio_poll_func            *pollfunc_event;
 582
 583         struct iio_chan_spec const      *channels;
 584         int                             num_channels;
 585
 586         struct list_head                channel_attr_list;
 587         struct attribute_group          chan_attr_group;
 588         const char                      *name;
 589         const struct iio_info           *info;
 590         clockid_t                       clock_id;
 591         struct mutex                    info_exist_lock;
 592         const struct iio_buffer_setup_ops       *setup_ops;
 593         struct cdev                     chrdev;
 594 #define IIO_MAX_GROUPS 6
 595         const struct attribute_group    *groups[IIO_MAX_GROUPS + 1];
 596         int                             groupcounter;
 597
 598         unsigned long                   flags;
 599 #if defined(CONFIG_DEBUG_FS)
 600         struct dentry                   *debugfs_dentry;
 601         unsigned                        cached_reg_addr;
 602 #endif
 603 };
 604
 605 const struct iio_chan_spec
 606 *iio_find_channel_from_si(struct iio_dev *indio_dev, int si);
 607 int iio_device_register(struct iio_dev *indio_dev);
 608 void iio_device_unregister(struct iio_dev *indio_dev);
 609 int devm_iio_device_register(struct device *dev, struct iio_dev *indio_dev);
 610 void devm_iio_device_unregister(struct device *dev, struct iio_dev *indio_dev);
 611 int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);
 612 int iio_device_claim_direct_mode(struct iio_dev *indio_dev);
 613 void iio_device_release_direct_mode(struct iio_dev *indio_dev);
 614
 615 extern struct bus_type iio_bus_type;
 616
 617 /**
 618  * iio_device_put() - reference counted deallocation of struct device
 619  * @indio_dev: IIO device structure containing the device
 620  **/
 621 static inline void iio_device_put(struct iio_dev *indio_dev)
 622 {
 623         if (indio_dev)
 624                 put_device(&indio_dev->dev);
 625 }
 626
 627 /**
 628  * iio_device_get_clock() - Retrieve current timestamping clock for the device
 629  * @indio_dev: IIO device structure containing the device
 630  */
 631 static inline clockid_t iio_device_get_clock(const struct iio_dev *indio_dev)
 632 {
 633         return indio_dev->clock_id;
 634 }
 635
 636 /**
 637  * dev_to_iio_dev() - Get IIO device struct from a device struct
 638  * @dev:                The device embedded in the IIO device
 639  *
 640  * Note: The device must be a IIO device, otherwise the result is undefined.
 641  */
 642 static inline struct iio_dev *dev_to_iio_dev(struct device *dev)
 643 {
 644         return container_of(dev, struct iio_dev, dev);
 645 }
 646
 647 /**
 648  * iio_device_get() - increment reference count for the device
 649  * @indio_dev:          IIO device structure
 650  *
 651  * Returns: The passed IIO device
 652  **/
 653 static inline struct iio_dev *iio_device_get(struct iio_dev *indio_dev)
 654 {
 655         return indio_dev ? dev_to_iio_dev(get_device(&indio_dev->dev)) : NULL;
 656 }
 657
 658
 659 /**
 660  * iio_device_set_drvdata() - Set device driver data
 661  * @indio_dev: IIO device structure
 662  * @data: Driver specific data
 663  *
 664  * Allows to attach an arbitrary pointer to an IIO device, which can later be
 665  * retrieved by iio_device_get_drvdata().
 666  */
 667 static inline void iio_device_set_drvdata(struct iio_dev *indio_dev, void *data)
 668 {
 669         dev_set_drvdata(&indio_dev->dev, data);
 670 }
 671
 672 /**
 673  * iio_device_get_drvdata() - Get device driver data
 674  * @indio_dev: IIO device structure
 675  *
 676  * Returns the data previously set with iio_device_set_drvdata()
 677  */
 678 static inline void *iio_device_get_drvdata(struct iio_dev *indio_dev)
 679 {
 680         return dev_get_drvdata(&indio_dev->dev);
 681 }
 682
 683 /* Can we make this smaller? */
 684 #define IIO_ALIGN L1_CACHE_BYTES
 685 struct iio_dev *iio_device_alloc(int sizeof_priv);
 686
 687 static inline void *iio_priv(const struct iio_dev *indio_dev)
 688 {
 689         return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN);
 690 }
 691
 692 static inline struct iio_dev *iio_priv_to_dev(void *priv)
 693 {
 694         return (struct iio_dev *)((char *)priv -
 695                                   ALIGN(sizeof(struct iio_dev), IIO_ALIGN));
 696 }
 697
 698 void iio_device_free(struct iio_dev *indio_dev);
 699 int devm_iio_device_match(struct device *dev, void *res, void *data);
 700 struct iio_dev *devm_iio_device_alloc(struct device *dev, int sizeof_priv);
 701 void devm_iio_device_free(struct device *dev, struct iio_dev *indio_dev);
 702 struct iio_trigger *devm_iio_trigger_alloc(struct device *dev,
 703                                                 const char *fmt, ...);
 704 void devm_iio_trigger_free(struct device *dev, struct iio_trigger *iio_trig);
 705
 706 /**
 707  * iio_buffer_enabled() - helper function to test if the buffer is enabled
 708  * @indio_dev:          IIO device structure for device
 709  **/
 710 static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
 711 {
 712         return indio_dev->currentmode
 713                 & (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE |
 714                    INDIO_BUFFER_SOFTWARE);
 715 }
 716
 717 /**
 718  * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry
 719  * @indio_dev:          IIO device structure for device
 720  **/
 721 #if defined(CONFIG_DEBUG_FS)
 722 static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
 723 {
 724         return indio_dev->debugfs_dentry;
 725 }
 726 #else
 727 static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
 728 {
 729         return NULL;
 730 }
 731 #endif
 732
 733 ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals);
 734
 735 int iio_str_to_fixpoint(const char *str, int fract_mult, int *integer,
 736         int *fract);
 737
 738 /**
 739  * IIO_DEGREE_TO_RAD() - Convert degree to rad
 740  * @deg: A value in degree
 741  *
 742  * Returns the given value converted from degree to rad
 743  */
 744 #define IIO_DEGREE_TO_RAD(deg) (((deg) * 314159ULL + 9000000ULL) / 18000000ULL)
 745
 746 /**
 747  * IIO_RAD_TO_DEGREE() - Convert rad to degree
 748  * @rad: A value in rad
 749  *
 750  * Returns the given value converted from rad to degree
 751  */
 752 #define IIO_RAD_TO_DEGREE(rad) \
 753         (((rad) * 18000000ULL + 314159ULL / 2) / 314159ULL)
 754
 755 /**
 756  * IIO_G_TO_M_S_2() - Convert g to meter / second**2
 757  * @g: A value in g
 758  *
 759  * Returns the given value converted from g to meter / second**2
 760  */
 761 #define IIO_G_TO_M_S_2(g) ((g) * 980665ULL / 100000ULL)
 762
 763 /**
 764  * IIO_M_S_2_TO_G() - Convert meter / second**2 to g
 765  * @ms2: A value in meter / second**2
 766  *
 767  * Returns the given value converted from meter / second**2 to g
 768  */
 769 #define IIO_M_S_2_TO_G(ms2) (((ms2) * 100000ULL + 980665ULL / 2) / 980665ULL)
 770
 771 #endif /* _INDUSTRIAL_IO_H_ */