blob: e3503bfe538b951102449e24e2e90e1a00fe407b [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
Cristina Opriceana34cbea12015-07-13 16:20:11 +030021#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof(arr[0]))
22
Roberta Dobrescubdcb31d2015-02-26 10:49:24 +020023extern const char *iio_dir;
Jonathan Camerone58537c2010-10-08 12:14:14 +010024
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
Hartmut Knaack5dc65d72015-05-31 14:40:16 +020033 * @bits_used: number of valid bits of data
34 * @shift: amount of bits to shift right data before applying bit mask
Jonathan Camerone58537c2010-10-08 12:14:14 +010035 * @mask: a bit mask for the raw output
Hartmut Knaack5dc65d72015-05-31 14:40:16 +020036 * @be: flag if data is big endian
Jonathan Camerone58537c2010-10-08 12:14:14 +010037 * @is_signed: is the raw value stored signed
Hartmut Knaack5dc65d72015-05-31 14:40:16 +020038 * @location: data offset for this channel inside the buffer (in bytes)
Jonathan Camerone58537c2010-10-08 12:14:14 +010039 **/
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;
Jonathan Cameron52615d42011-05-18 14:41:19 +010048 unsigned shift;
Jonathan Camerone58537c2010-10-08 12:14:14 +010049 uint64_t mask;
Jonathan Cameron117cf8b2011-12-04 19:10:59 +000050 unsigned be;
Jonathan Camerone58537c2010-10-08 12:14:14 +010051 unsigned is_signed;
Jonathan Camerone58537c2010-10-08 12:14:14 +010052 unsigned location;
53};
54
Roberta Dobrescubdcb31d2015-02-26 10:49:24 +020055int iioutils_break_up_name(const char *full_name, char **generic_name);
Hartmut Knaack7663a4a2015-06-10 21:51:20 +020056int 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);
Roberta Dobrescubdcb31d2015-02-26 10:49:24 +020060int iioutils_get_param_float(float *output, const char *param_name,
Hartmut Knaack7663a4a2015-06-10 21:51:20 +020061 const char *device_dir, const char *name,
62 const char *generic_name);
Joo Aun Saw95ddd3f2015-07-25 01:23:29 +100063void bsort_channel_array_by_index(struct iio_channel_info *ci_array, int cnt);
Roberta Dobrescubdcb31d2015-02-26 10:49:24 +020064int build_channel_array(const char *device_dir,
Hartmut Knaack7663a4a2015-06-10 21:51:20 +020065 struct iio_channel_info **ci_array, int *counter);
Roberta Dobrescubdcb31d2015-02-26 10:49:24 +020066int find_type_by_name(const char *name, const char *type);
Hartmut Knaack9d475252015-05-31 14:40:36 +020067int 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);
Roberta Dobrescubdcb31d2015-02-26 10:49:24 +020076int read_sysfs_string(const char *filename, const char *basedir, char *str);
Jonathan Camerone58537c2010-10-08 12:14:14 +010077
Roberta Dobrescubdcb31d2015-02-26 10:49:24 +020078#endif /* _IIO_UTILS_H_ */