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