blob: 1bc837b2d769eeabecc1833259832a98ef44887a [file] [log] [blame]
Roberta Dobrescubdcb31d2015-02-26 10:49:24 +02001#ifndef _IIO_UTILS_H_
2#define _IIO_UTILS_H_
3
Jonathan Cameronc57f1ba2009-08-18 18:06:32 +01004/* 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
Jonathan Camerone58537c2010-10-08 12:14:14 +010013#include <stdint.h>
Jonathan Cameron9d8ae6c2010-05-04 14:43:13 +010014
Peter Meerwaldb42f2a02012-06-25 23:12:13 +020015/* Made up value to limit allocation sizes */
Jonathan Cameron9d8ae6c2010-05-04 14:43:13 +010016#define IIO_MAX_NAME_LENGTH 30
17
Jonathan Cameron1aa04272011-08-30 12:32:47 +010018#define FORMAT_SCAN_ELEMENTS_DIR "%s/scan_elements"
Jonathan Camerone58537c2010-10-08 12:14:14 +010019#define FORMAT_TYPE_FILE "%s_type"
Jonathan Cameronc57f1ba2009-08-18 18:06:32 +010020
Roberta Dobrescubdcb31d2015-02-26 10:49:24 +020021extern const char *iio_dir;
Jonathan Camerone58537c2010-10-08 12:14:14 +010022
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 * @mask: a bit mask for the raw output
32 * @is_signed: is the raw value stored signed
33 * @enabled: is this channel enabled
34 **/
35struct iio_channel_info {
36 char *name;
37 char *generic_name;
38 float scale;
39 float offset;
40 unsigned index;
41 unsigned bytes;
42 unsigned bits_used;
Jonathan Cameron52615d42011-05-18 14:41:19 +010043 unsigned shift;
Jonathan Camerone58537c2010-10-08 12:14:14 +010044 uint64_t mask;
Jonathan Cameron117cf8b2011-12-04 19:10:59 +000045 unsigned be;
Jonathan Camerone58537c2010-10-08 12:14:14 +010046 unsigned is_signed;
Jonathan Camerone58537c2010-10-08 12:14:14 +010047 unsigned location;
48};
49
Roberta Dobrescubdcb31d2015-02-26 10:49:24 +020050int iioutils_break_up_name(const char *full_name, char **generic_name);
51int iioutils_get_type(unsigned *is_signed, unsigned *bytes,
52 unsigned *bits_used, unsigned *shift,
53 uint64_t *mask, unsigned *be,
54 const char *device_dir, const char *name,
55 const char *generic_name);
56int iioutils_get_param_float(float *output, const char *param_name,
57 const char *device_dir, const char *name,
58 const char *generic_name);
59void bsort_channel_array_by_index(struct iio_channel_info **ci_array, int cnt);
60int build_channel_array(const char *device_dir,
61 struct iio_channel_info **ci_array, int *counter);
62int find_type_by_name(const char *name, const char *type);
63int write_sysfs_int(char *filename, char *basedir, int val);
64int write_sysfs_int_and_verify(char *filename, char *basedir, int val);
65int write_sysfs_string_and_verify(char *filename, char *basedir, char *val);
66int write_sysfs_string(char *filename, char *basedir, char *val);
67int read_sysfs_posint(char *filename, char *basedir);
68int read_sysfs_float(char *filename, char *basedir, float *val);
69int read_sysfs_string(const char *filename, const char *basedir, char *str);
Jonathan Camerone58537c2010-10-08 12:14:14 +010070
Roberta Dobrescubdcb31d2015-02-26 10:49:24 +020071#endif /* _IIO_UTILS_H_ */