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