[linux-2.6-block.git] / tools / iio / iio_utils.h

/* SPDX-License-Identifier: GPL-2.0-only */
#ifndef _IIO_UTILS_H_
#define _IIO_UTILS_H_

/* IIO - useful set of util functionality
 *
 * Copyright (c) 2008 Jonathan Cameron
 */

#include <stdint.h>

/* Made up value to limit allocation sizes */
#define IIO_MAX_NAME_LENGTH 64

#define FORMAT_SCAN_ELEMENTS_DIR "%s/buffer%d"
#define FORMAT_EVENTS_DIR "%s/events"
#define FORMAT_TYPE_FILE "%s_type"

#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof(arr[0]))

extern const char *iio_dir;

/**
 * struct iio_channel_info - information about a given channel
 * @name: channel name
 * @generic_name: general name for channel type
 * @scale: scale factor to be applied for conversion to si units
 * @offset: offset to be applied for conversion to si units
 * @index: the channel index in the buffer output
 * @bytes: number of bytes occupied in buffer output
 * @bits_used: number of valid bits of data
 * @shift: amount of bits to shift right data before applying bit mask
 * @mask: a bit mask for the raw output
 * @be: flag if data is big endian
 * @is_signed: is the raw value stored signed
 * @location: data offset for this channel inside the buffer (in bytes)
 **/
struct iio_channel_info {
	char *name;
	char *generic_name;
	float scale;
	float offset;
	unsigned index;
	unsigned bytes;
	unsigned bits_used;
	unsigned shift;
	uint64_t mask;
	unsigned be;
	unsigned is_signed;
	unsigned location;
};

static inline int iioutils_check_suffix(const char *str, const char *suffix)
{
	return strlen(str) >= strlen(suffix) &&
		strncmp(str+strlen(str)-strlen(suffix),
			suffix, strlen(suffix)) == 0;
}

int iioutils_break_up_name(const char *full_name, char **generic_name);
int iioutils_get_param_float(float *output, const char *param_name,
			     const char *device_dir, const char *name,
			     const char *generic_name);
void bsort_channel_array_by_index(struct iio_channel_info *ci_array, int cnt);
int build_channel_array(const char *device_dir, int buffer_idx,
			struct iio_channel_info **ci_array, int *counter);
int find_type_by_name(const char *name, const char *type);
int write_sysfs_int(const char *filename, const char *basedir, int val);
int write_sysfs_int_and_verify(const char *filename, const char *basedir,
			       int val);
int write_sysfs_string_and_verify(const char *filename, const char *basedir,
				  const char *val);
int write_sysfs_string(const char *filename, const char *basedir,
		       const char *val);
int read_sysfs_posint(const char *filename, const char *basedir);
int read_sysfs_float(const char *filename, const char *basedir, float *val);
int read_sysfs_string(const char *filename, const char *basedir, char *str);

#endif /* _IIO_UTILS_H_ */
Commit	Line	Data
d2912cb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
bdcb31d0 RD	2	#ifndef _IIO_UTILS_H_
	3	#define _IIO_UTILS_H_
	4
c57f1ba7 JC	5	/* IIO - useful set of util functionality
	6	*
	7	* Copyright (c) 2008 Jonathan Cameron
c57f1ba7 JC	8	*/
c57f1ba7 JC	9
e58537cc	10	#include <stdint.h>
9d8ae6c8	11
b42f2a0c	12	/* Made up value to limit allocation sizes */
f80ac400	13	#define IIO_MAX_NAME_LENGTH 64
9d8ae6c8	14
8827faab	15	#define FORMAT_SCAN_ELEMENTS_DIR "%s/buffer%d"
e1d392dc	16	#define FORMAT_EVENTS_DIR "%s/events"
e58537cc	17	#define FORMAT_TYPE_FILE "%s_type"
c57f1ba7	18
34cbea19 CO	19	#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof(arr[0]))
34cbea19 CO	20
bdcb31d0	21	extern const char *iio_dir;
e58537cc JC	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
5dc65d79 HK	31	* @bits_used: number of valid bits of data
5dc65d79 HK	32	* @shift: amount of bits to shift right data before applying bit mask
e58537cc	33	* @mask: a bit mask for the raw output
5dc65d79	34	* @be: flag if data is big endian
e58537cc	35	* @is_signed: is the raw value stored signed
5dc65d79	36	* @location: data offset for this channel inside the buffer (in bytes)
e58537cc JC	37	**/
	38	struct 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;
52615d47	46	unsigned shift;
e58537cc	47	uint64_t mask;
117cf8b7	48	unsigned be;
e58537cc	49	unsigned is_signed;
e58537cc JC	50	unsigned location;
	51	};
	52
5f991a92 LW	53	static 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
bdcb31d0	60	int iioutils_break_up_name(const char full_name, char *generic_name);
bdcb31d0	61	int iioutils_get_param_float(float output, const char param_name,
7663a4aa HK	62	const char device_dir, const char name,
7663a4aa HK	63	const char *generic_name);
95ddd3f4	64	void bsort_channel_array_by_index(struct iio_channel_info *ci_array, int cnt);
8827faab	65	int build_channel_array(const char *device_dir, int buffer_idx,
7663a4aa	66	struct iio_channel_info *ci_array, int counter);
bdcb31d0	67	int find_type_by_name(const char name, const char type);
9d475254 HK	68	int write_sysfs_int(const char filename, const char basedir, int val);
	69	int write_sysfs_int_and_verify(const char filename, const char basedir,
	70	int val);
	71	int write_sysfs_string_and_verify(const char filename, const char basedir,
	72	const char *val);
	73	int write_sysfs_string(const char filename, const char basedir,
	74	const char *val);
	75	int read_sysfs_posint(const char filename, const char basedir);
	76	int read_sysfs_float(const char filename, const char basedir, float *val);
bdcb31d0 RD	77	int read_sysfs_string(const char filename, const char basedir, char *str);
	78
	79	#endif /* _IIO_UTILS_H_ */