LXR linux/tools/iio/iio

   1/* SPDX-License-Identifier: GPL-2.0-only */
   2#ifndef _IIO_UTILS_H_
   3#define _IIO_UTILS_H_
   4
   5/* IIO - useful set of util functionality
   6 *
   7 * Copyright (c) 2008 Jonathan Cameron
   8 */
   9
  10#include <stdint.h>
  11
  12/* Made up value to limit allocation sizes */
  13#define IIO_MAX_NAME_LENGTH 64
  14
  15#define FORMAT_SCAN_ELEMENTS_DIR "%s/buffer%d"
  16#define FORMAT_EVENTS_DIR "%s/events"
  17#define FORMAT_TYPE_FILE "%s_type"
  18
  19#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof(arr[0]))
  20
  21extern const char *iio_dir;
  22
  23/**
  24 * struct iio_channel_info - information about a given channel
  25 * @name: channel name
  26 * @generic_name: general name for channel type
  27 * @scale: scale factor to be applied for conversion to si units
  28 * @offset: offset to be applied for conversion to si units
  29 * @index: the channel index in the buffer output
  30 * @bytes: number of bytes occupied in buffer output
  31 * @bits_used: number of valid bits of data
  32 * @shift: amount of bits to shift right data before applying bit mask
  33 * @mask: a bit mask for the raw output
  34 * @be: flag if data is big endian
  35 * @is_signed: is the raw value stored signed
  36 * @location: data offset for this channel inside the buffer (in bytes)
  37 **/
  38struct iio_channel_info {
  39        char *name;
  40        char *generic_name;
  41        float scale;
  42        float offset;
  43        unsigned index;
  44        unsigned bytes;
  45        unsigned bits_used;
  46        unsigned shift;
  47        uint64_t mask;
  48        unsigned be;
  49        unsigned is_signed;
  50        unsigned location;
  51};
  52
  53static inline int iioutils_check_suffix(const char *str, const char *suffix)
  54{
  55        return strlen(str) >= strlen(suffix) &&
  56                strncmp(str+strlen(str)-strlen(suffix),
  57                        suffix, strlen(suffix)) == 0;
  58}
  59
  60int iioutils_break_up_name(const char *full_name, char **generic_name);
  61int iioutils_get_param_float(float *output, const char *param_name,
  62                             const char *device_dir, const char *name,
  63                             const char *generic_name);
  64void bsort_channel_array_by_index(struct iio_channel_info *ci_array, int cnt);
  65int build_channel_array(const char *device_dir, int buffer_idx,
  66                        struct iio_channel_info **ci_array, int *counter);
  67int find_type_by_name(const char *name, const char *type);
  68int write_sysfs_int(const char *filename, const char *basedir, int val);
  69int write_sysfs_int_and_verify(const char *filename, const char *basedir,
  70                               int val);
  71int write_sysfs_string_and_verify(const char *filename, const char *basedir,
  72                                  const char *val);
  73int write_sysfs_string(const char *filename, const char *basedir,
  74                       const char *val);
  75int read_sysfs_posint(const char *filename, const char *basedir);
  76int read_sysfs_float(const char *filename, const char *basedir, float *val);
  77int read_sysfs_string(const char *filename, const char *basedir, char *str);
  78
  79#endif /* _IIO_UTILS_H_ */
  80