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