libiio  0.24
Library for interfacing with IIO devices
iio.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 /*
3  * libiio - Library for interfacing industrial I/O (IIO) devices
4  *
5  * Copyright (C) 2014 Analog Devices, Inc.
6  * Author: Paul Cercueil <paul.cercueil@analog.com>
7  */
8 
12 #ifndef __IIO_H__
13 #define __IIO_H__
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
19 #include <limits.h>
20 #include <stdint.h>
21 #include <stdlib.h>
22 #include <stddef.h>
23 
24 #if (defined(_WIN32) || defined(__MBED__))
25 #ifndef _SSIZE_T_DEFINED
26 typedef ptrdiff_t ssize_t;
27 #define _SSIZE_T_DEFINED
28 #endif
29 #else
30 #include <sys/types.h>
31 #endif
32 
33 #if defined(_MSC_VER) && (_MSC_VER < 1800) && !defined(__BOOL_DEFINED)
34 #undef bool
35 #undef false
36 #undef true
37 #define bool char
38 #define false 0
39 #define true 1
40 #else
41 #include <stdbool.h>
42 #endif
43 
44 #if defined(__GNUC__) && !defined(MATLAB_MEX_FILE) && !defined(MATLAB_LOADLIBRARY)
45 #ifndef __cnst
46 #define __cnst __attribute__((const))
47 #endif
48 #ifndef __pure
49 #define __pure __attribute__((pure))
50 #endif
51 #define __notused __attribute__((unused))
52 #ifdef IIO_CHECK_RET
53 #define __check_ret __attribute__((warn_unused_result))
54 #else
55 #define __check_ret
56 #endif
57 #else
58 #define __cnst
59 #define __pure
60 #define __notused
61 #define __check_ret
62 #endif
63 
64 #ifdef _WIN32
65 # ifdef LIBIIO_STATIC
66 # define __api
67 # elif defined(LIBIIO_EXPORTS)
68 # define __api __declspec(dllexport)
69 # else
70 # define __api __declspec(dllimport)
71 # endif
72 #elif __GNUC__ >= 4 && !defined(MATLAB_MEX_FILE) && !defined(MATLAB_LOADLIBRARY)
73 # define __api __attribute__((visibility ("default")))
74 #else
75 # define __api
76 #endif
77 
78 struct iio_context;
79 struct iio_device;
80 struct iio_channel;
81 struct iio_buffer;
82 
83 struct iio_context_info;
84 struct iio_scan_context;
85 struct iio_scan_block;
86 
87 /*
88  * <linux/iio/types.h> header guard to protect these enums from being defined
89  * twice
90  */
91 #ifndef _IIO_TYPES_H_
92 #define _IIO_TYPES_H_
93 
102  IIO_VOLTAGE,
103  IIO_CURRENT,
104  IIO_POWER,
105  IIO_ACCEL,
106  IIO_ANGL_VEL,
107  IIO_MAGN,
108  IIO_LIGHT,
109  IIO_INTENSITY,
110  IIO_PROXIMITY,
111  IIO_TEMP,
112  IIO_INCLI,
113  IIO_ROT,
114  IIO_ANGL,
115  IIO_TIMESTAMP,
116  IIO_CAPACITANCE,
117  IIO_ALTVOLTAGE,
118  IIO_CCT,
119  IIO_PRESSURE,
120  IIO_HUMIDITYRELATIVE,
121  IIO_ACTIVITY,
122  IIO_STEPS,
123  IIO_ENERGY,
124  IIO_DISTANCE,
125  IIO_VELOCITY,
126  IIO_CONCENTRATION,
127  IIO_RESISTANCE,
128  IIO_PH,
129  IIO_UVINDEX,
130  IIO_ELECTRICALCONDUCTIVITY,
131  IIO_COUNT,
132  IIO_INDEX,
133  IIO_GRAVITY,
134  IIO_POSITIONRELATIVE,
135  IIO_PHASE,
136  IIO_MASSCONCENTRATION,
137  IIO_CHAN_TYPE_UNKNOWN = INT_MAX
138 };
139 
148  IIO_NO_MOD,
149  IIO_MOD_X,
150  IIO_MOD_Y,
151  IIO_MOD_Z,
152  IIO_MOD_X_AND_Y,
153  IIO_MOD_X_AND_Z,
154  IIO_MOD_Y_AND_Z,
155  IIO_MOD_X_AND_Y_AND_Z,
156  IIO_MOD_X_OR_Y,
157  IIO_MOD_X_OR_Z,
158  IIO_MOD_Y_OR_Z,
159  IIO_MOD_X_OR_Y_OR_Z,
160  IIO_MOD_LIGHT_BOTH,
161  IIO_MOD_LIGHT_IR,
162  IIO_MOD_ROOT_SUM_SQUARED_X_Y,
163  IIO_MOD_SUM_SQUARED_X_Y_Z,
164  IIO_MOD_LIGHT_CLEAR,
165  IIO_MOD_LIGHT_RED,
166  IIO_MOD_LIGHT_GREEN,
167  IIO_MOD_LIGHT_BLUE,
168  IIO_MOD_QUATERNION,
169  IIO_MOD_TEMP_AMBIENT,
170  IIO_MOD_TEMP_OBJECT,
171  IIO_MOD_NORTH_MAGN,
172  IIO_MOD_NORTH_TRUE,
173  IIO_MOD_NORTH_MAGN_TILT_COMP,
174  IIO_MOD_NORTH_TRUE_TILT_COMP,
175  IIO_MOD_RUNNING,
176  IIO_MOD_JOGGING,
177  IIO_MOD_WALKING,
178  IIO_MOD_STILL,
179  IIO_MOD_ROOT_SUM_SQUARED_X_Y_Z,
180  IIO_MOD_I,
181  IIO_MOD_Q,
182  IIO_MOD_CO2,
183  IIO_MOD_VOC,
184  IIO_MOD_LIGHT_UV,
185  IIO_MOD_LIGHT_DUV,
186  IIO_MOD_PM1,
187  IIO_MOD_PM2P5,
188  IIO_MOD_PM4,
189  IIO_MOD_PM10,
190  IIO_MOD_ETHANOL,
191  IIO_MOD_H2,
192  IIO_MOD_O2,
193  IIO_MOD_LINEAR_X,
194  IIO_MOD_LINEAR_Y,
195  IIO_MOD_LINEAR_Z,
196  IIO_MOD_PITCH,
197  IIO_MOD_YAW,
198  IIO_MOD_ROLL,
199 };
200 
209  IIO_EV_TYPE_THRESH,
210  IIO_EV_TYPE_MAG,
211  IIO_EV_TYPE_ROC,
212  IIO_EV_TYPE_THRESH_ADAPTIVE,
213  IIO_EV_TYPE_MAG_ADAPTIVE,
214  IIO_EV_TYPE_CHANGE,
215  IIO_EV_TYPE_MAG_REFERENCED,
216  IIO_EV_TYPE_GESTURE,
217 };
218 
226  IIO_EV_DIR_EITHER,
227  IIO_EV_DIR_RISING,
228  IIO_EV_DIR_FALLING,
229  IIO_EV_DIR_NONE,
230  IIO_EV_DIR_SINGLETAP,
231  IIO_EV_DIR_DOUBLETAP,
232 };
233 
234 #endif /* _IIO_TYPES_H_ */
235 
236 /* ---------------------------------------------------------------------------*/
237 /* ------------------------- Scan functions ----------------------------------*/
265 __api __check_ret struct iio_scan_context * iio_create_scan_context(
266  const char *backend, unsigned int flags);
267 
268 
273 __api void iio_scan_context_destroy(struct iio_scan_context *ctx);
274 
275 
283 __api __check_ret ssize_t iio_scan_context_get_info_list(struct iio_scan_context *ctx,
284  struct iio_context_info ***info);
285 
286 
290 __api void iio_context_info_list_free(struct iio_context_info **info);
291 
292 
297 __api __check_ret __pure const char * iio_context_info_get_description(
298  const struct iio_context_info *info);
299 
300 
305 __api __check_ret __pure const char * iio_context_info_get_uri(
306  const struct iio_context_info *info);
307 
308 
317 __api struct iio_scan_block * iio_create_scan_block(
318  const char *backend, unsigned int flags);
319 
320 
327 __api void iio_scan_block_destroy(struct iio_scan_block *blk);
328 
329 
336 __api ssize_t iio_scan_block_scan(struct iio_scan_block *blk);
337 
338 
348  struct iio_scan_block *blk, unsigned int index);
349 
350 /* ------------------------------------------------------------------*/
352 /* ------------------------- Top-level functions -----------------------------*/
361 __api void iio_library_get_version(unsigned int *major,
362  unsigned int *minor, char git_tag[8]);
363 
364 
370 __api void iio_strerror(int err, char *dst, size_t len);
371 
372 
378 __api __check_ret __cnst bool iio_has_backend(const char *backend);
379 
380 
385 __api __check_ret __cnst unsigned int iio_get_backends_count(void);
386 
387 
394 __api __check_ret __cnst const char * iio_get_backend(unsigned int index);
395 
396 /* ------------------------------------------------------------------*/
398 /* ------------------------- Context functions -------------------------------*/
412 __api __check_ret struct iio_context * iio_create_default_context(void);
413 
414 
418 __api __check_ret struct iio_context * iio_create_local_context(void);
419 
420 
428 __api __check_ret struct iio_context * iio_create_xml_context(const char *xml_file);
429 
430 
439 __api __check_ret struct iio_context * iio_create_xml_context_mem(
440  const char *xml, size_t len);
441 
442 
447 __api __check_ret struct iio_context * iio_create_network_context(const char *host);
448 
449 
492 __api __check_ret struct iio_context * iio_create_context_from_uri(const char *uri);
493 
494 
503 __api __check_ret struct iio_context * iio_context_clone(const struct iio_context *ctx);
504 
505 
510 __api void iio_context_destroy(struct iio_context *ctx);
511 
512 
520 __api __check_ret int iio_context_get_version(const struct iio_context *ctx,
521  unsigned int *major, unsigned int *minor, char git_tag[8]);
522 
523 
527 __api __check_ret __pure const char * iio_context_get_xml(const struct iio_context *ctx);
528 
529 
537 __api __check_ret __pure const char * iio_context_get_name(const struct iio_context *ctx);
538 
539 
546 __api __check_ret __pure const char * iio_context_get_description(
547  const struct iio_context *ctx);
548 
549 
555 __api __check_ret __pure unsigned int iio_context_get_attrs_count(
556  const struct iio_context *ctx);
557 
558 
568 __api __check_ret int iio_context_get_attr(
569  const struct iio_context *ctx, unsigned int index,
570  const char **name, const char **value);
571 
572 
581 __api __check_ret const char * iio_context_get_attr_value(
582  const struct iio_context *ctx, const char *name);
583 
584 
588 __api __check_ret __pure unsigned int iio_context_get_devices_count(
589  const struct iio_context *ctx);
590 
591 
597 __api __check_ret __pure struct iio_device * iio_context_get_device(
598  const struct iio_context *ctx, unsigned int index);
599 
600 
608 __api __check_ret __pure struct iio_device * iio_context_find_device(
609  const struct iio_context *ctx, const char *name);
610 
611 
619 __api __check_ret int iio_context_set_timeout(
620  struct iio_context *ctx, unsigned int timeout_ms);
621 
622 /* ------------------------------------------------------------------*/
624 /* ------------------------- Device functions --------------------------------*/
634 __api __check_ret __pure const struct iio_context * iio_device_get_context(
635  const struct iio_device *dev);
636 
637 
641 __api __check_ret __pure const char * iio_device_get_id(const struct iio_device *dev);
642 
643 
649 __api __check_ret __pure const char * iio_device_get_name(const struct iio_device *dev);
650 
651 
657 __api __check_ret __pure const char * iio_device_get_label(const struct iio_device *dev);
658 
659 
663 __api __check_ret __pure unsigned int iio_device_get_channels_count(
664  const struct iio_device *dev);
665 
666 
670 __api __check_ret __pure unsigned int iio_device_get_attrs_count(
671  const struct iio_device *dev);
672 
676 __api __check_ret __pure unsigned int iio_device_get_buffer_attrs_count(
677  const struct iio_device *dev);
678 
684 __api __check_ret __pure struct iio_channel * iio_device_get_channel(
685  const struct iio_device *dev, unsigned int index);
686 
687 
693 __api __check_ret __pure const char * iio_device_get_attr(
694  const struct iio_device *dev, unsigned int index);
695 
701 __api __check_ret __pure const char * iio_device_get_buffer_attr(
702  const struct iio_device *dev, unsigned int index);
703 
712 __api __check_ret __pure struct iio_channel * iio_device_find_channel(
713  const struct iio_device *dev, const char *name, bool output);
714 
715 
727 __api __check_ret __pure const char * iio_device_find_attr(
728  const struct iio_device *dev, const char *name);
729 
741 __api __check_ret __pure const char * iio_device_find_buffer_attr(
742  const struct iio_device *dev, const char *name);
743 
765 __api __check_ret ssize_t iio_device_attr_read(const struct iio_device *dev,
766  const char *attr, char *dst, size_t len);
767 
768 
779 __api __check_ret int iio_device_attr_read_all(struct iio_device *dev,
780  int (*cb)(struct iio_device *dev, const char *attr,
781  const char *value, size_t len, void *d),
782  void *data);
783 
784 
792 __api __check_ret int iio_device_attr_read_bool(const struct iio_device *dev,
793  const char *attr, bool *val);
794 
795 
803 __api __check_ret int iio_device_attr_read_longlong(const struct iio_device *dev,
804  const char *attr, long long *val);
805 
806 
814 __api __check_ret int iio_device_attr_read_double(const struct iio_device *dev,
815  const char *attr, double *val);
816 
817 
836 __api __check_ret ssize_t iio_device_attr_write(const struct iio_device *dev,
837  const char *attr, const char *src);
838 
839 
848 __api __check_ret ssize_t iio_device_attr_write_raw(const struct iio_device *dev,
849  const char *attr, const void *src, size_t len);
850 
851 
862 __api __check_ret int iio_device_attr_write_all(struct iio_device *dev,
863  ssize_t (*cb)(struct iio_device *dev,
864  const char *attr, void *buf, size_t len, void *d),
865  void *data);
866 
867 
875 __api __check_ret int iio_device_attr_write_bool(const struct iio_device *dev,
876  const char *attr, bool val);
877 
878 
886 __api __check_ret int iio_device_attr_write_longlong(const struct iio_device *dev,
887  const char *attr, long long val);
888 
889 
897 __api __check_ret int iio_device_attr_write_double(const struct iio_device *dev,
898  const char *attr, double val);
899 
922 __api __check_ret ssize_t iio_device_buffer_attr_read(const struct iio_device *dev,
923  const char *attr, char *dst, size_t len);
924 
935 __api __check_ret int iio_device_buffer_attr_read_all(struct iio_device *dev,
936  int (*cb)(struct iio_device *dev, const char *attr,
937  const char *value, size_t len, void *d),
938  void *data);
939 
940 
948 __api __check_ret int iio_device_buffer_attr_read_bool(const struct iio_device *dev,
949  const char *attr, bool *val);
950 
951 
959 __api __check_ret int iio_device_buffer_attr_read_longlong(const struct iio_device *dev,
960  const char *attr, long long *val);
961 
962 
970 __api __check_ret int iio_device_buffer_attr_read_double(const struct iio_device *dev,
971  const char *attr, double *val);
972 
973 
993 __api __check_ret ssize_t iio_device_buffer_attr_write(const struct iio_device *dev,
994  const char *attr, const char *src);
995 
996 
1005 __api __check_ret ssize_t iio_device_buffer_attr_write_raw(const struct iio_device *dev,
1006  const char *attr, const void *src, size_t len);
1007 
1008 
1019 __api __check_ret int iio_device_buffer_attr_write_all(struct iio_device *dev,
1020  ssize_t (*cb)(struct iio_device *dev,
1021  const char *attr, void *buf, size_t len, void *d),
1022  void *data);
1023 
1024 
1032 __api __check_ret int iio_device_buffer_attr_write_bool(const struct iio_device *dev,
1033  const char *attr, bool val);
1034 
1035 
1043 __api __check_ret int iio_device_buffer_attr_write_longlong(const struct iio_device *dev,
1044  const char *attr, long long val);
1045 
1046 
1054 __api __check_ret int iio_device_buffer_attr_write_double(const struct iio_device *dev,
1055  const char *attr, double val);
1056 
1057 
1061 __api void iio_device_set_data(struct iio_device *dev, void *data);
1062 
1063 
1067 __api void * iio_device_get_data(const struct iio_device *dev);
1068 
1069 
1077 __api __check_ret int iio_device_get_trigger(const struct iio_device *dev,
1078  const struct iio_device **trigger);
1079 
1080 
1087 __api __check_ret int iio_device_set_trigger(const struct iio_device *dev,
1088  const struct iio_device *trigger);
1089 
1090 
1094 __api __check_ret __pure bool iio_device_is_trigger(const struct iio_device *dev);
1095 
1103 __api __check_ret int iio_device_set_kernel_buffers_count(const struct iio_device *dev,
1104  unsigned int nb_buffers);
1105 /* ------------------------------------------------------------------*/
1107 /* ------------------------- Channel functions -------------------------------*/
1117 __api __check_ret __pure const struct iio_device * iio_channel_get_device(
1118  const struct iio_channel *chn);
1119 
1120 
1124 __api __check_ret __pure const char * iio_channel_get_id(const struct iio_channel *chn);
1125 
1126 
1132 __api __check_ret __pure const char * iio_channel_get_name(const struct iio_channel *chn);
1133 
1134 
1138 __api __check_ret __pure bool iio_channel_is_output(const struct iio_channel *chn);
1139 
1140 
1148 __api __check_ret __pure bool iio_channel_is_scan_element(const struct iio_channel *chn);
1149 
1150 
1154 __api __check_ret __pure unsigned int iio_channel_get_attrs_count(
1155  const struct iio_channel *chn);
1156 
1157 
1163 __api __check_ret __pure const char * iio_channel_get_attr(
1164  const struct iio_channel *chn, unsigned int index);
1165 
1166 
1178 __api __check_ret __pure const char * iio_channel_find_attr(
1179  const struct iio_channel *chn, const char *name);
1180 
1181 
1188 __api __check_ret __pure const char * iio_channel_attr_get_filename(
1189  const struct iio_channel *chn, const char *attr);
1190 
1191 
1213 __api __check_ret ssize_t iio_channel_attr_read(const struct iio_channel *chn,
1214  const char *attr, char *dst, size_t len);
1215 
1216 
1227 __api __check_ret int iio_channel_attr_read_all(struct iio_channel *chn,
1228  int (*cb)(struct iio_channel *chn,
1229  const char *attr, const char *val, size_t len, void *d),
1230  void *data);
1231 
1232 
1240 __api __check_ret int iio_channel_attr_read_bool(const struct iio_channel *chn,
1241  const char *attr, bool *val);
1242 
1243 
1251 __api __check_ret int iio_channel_attr_read_longlong(const struct iio_channel *chn,
1252  const char *attr, long long *val);
1253 
1254 
1262 __api __check_ret int iio_channel_attr_read_double(const struct iio_channel *chn,
1263  const char *attr, double *val);
1264 
1265 
1284 __api __check_ret ssize_t iio_channel_attr_write(const struct iio_channel *chn,
1285  const char *attr, const char *src);
1286 
1287 
1296 __api __check_ret ssize_t iio_channel_attr_write_raw(const struct iio_channel *chn,
1297  const char *attr, const void *src, size_t len);
1298 
1299 
1310 __api __check_ret int iio_channel_attr_write_all(struct iio_channel *chn,
1311  ssize_t (*cb)(struct iio_channel *chn,
1312  const char *attr, void *buf, size_t len, void *d),
1313  void *data);
1314 
1315 
1323 __api __check_ret int iio_channel_attr_write_bool(const struct iio_channel *chn,
1324  const char *attr, bool val);
1325 
1326 
1334 __api __check_ret int iio_channel_attr_write_longlong(const struct iio_channel *chn,
1335  const char *attr, long long val);
1336 
1337 
1345 __api __check_ret int iio_channel_attr_write_double(const struct iio_channel *chn,
1346  const char *attr, double val);
1347 
1348 
1355 __api void iio_channel_enable(struct iio_channel *chn);
1356 
1357 
1360 __api void iio_channel_disable(struct iio_channel *chn);
1361 
1362 
1366 __api __check_ret bool iio_channel_is_enabled(const struct iio_channel *chn);
1367 
1368 
1376 __api __check_ret size_t iio_channel_read_raw(const struct iio_channel *chn,
1377  struct iio_buffer *buffer, void *dst, size_t len);
1378 
1379 
1387 __api __check_ret size_t iio_channel_read(const struct iio_channel *chn,
1388  struct iio_buffer *buffer, void *dst, size_t len);
1389 
1390 
1398 __api __check_ret size_t iio_channel_write_raw(const struct iio_channel *chn,
1399  struct iio_buffer *buffer, const void *src, size_t len);
1400 
1401 
1409 __api __check_ret size_t iio_channel_write(const struct iio_channel *chn,
1410  struct iio_buffer *buffer, const void *src, size_t len);
1411 
1412 
1416 __api void iio_channel_set_data(struct iio_channel *chn, void *data);
1417 
1418 
1422 __api void * iio_channel_get_data(const struct iio_channel *chn);
1423 
1424 
1428 __api __check_ret __pure enum iio_chan_type iio_channel_get_type(
1429  const struct iio_channel *chn);
1430 
1431 
1435 __api __check_ret __pure enum iio_modifier iio_channel_get_modifier(
1436  const struct iio_channel *chn);
1437 
1438 /* ------------------------------------------------------------------*/
1440 /* ------------------------- Buffer functions --------------------------------*/
1450 __api __check_ret __pure const struct iio_device * iio_buffer_get_device(
1451  const struct iio_buffer *buf);
1452 
1453 
1463 __api __check_ret struct iio_buffer * iio_device_create_buffer(const struct iio_device *dev,
1464  size_t samples_count, bool cyclic);
1465 
1466 
1471 __api void iio_buffer_destroy(struct iio_buffer *buf);
1472 
1481 __api __check_ret int iio_buffer_get_poll_fd(struct iio_buffer *buf);
1482 
1494 __api __check_ret int iio_buffer_set_blocking_mode(struct iio_buffer *buf, bool blocking);
1495 
1496 
1503 __api __check_ret ssize_t iio_buffer_refill(struct iio_buffer *buf);
1504 
1505 
1512 __api __check_ret ssize_t iio_buffer_push(struct iio_buffer *buf);
1513 
1514 
1522 __api __check_ret ssize_t iio_buffer_push_partial(struct iio_buffer *buf,
1523  size_t samples_count);
1524 
1548 __api void iio_buffer_cancel(struct iio_buffer *buf);
1549 
1550 
1554 __api void * iio_buffer_start(const struct iio_buffer *buf);
1555 
1556 
1572 __api void * iio_buffer_first(const struct iio_buffer *buf,
1573  const struct iio_channel *chn);
1574 
1575 
1580 __api __check_ret ptrdiff_t iio_buffer_step(const struct iio_buffer *buf);
1581 
1582 
1587 __api void * iio_buffer_end(const struct iio_buffer *buf);
1588 
1589 
1601 __api __check_ret ssize_t iio_buffer_foreach_sample(struct iio_buffer *buf,
1602  ssize_t (*callback)(const struct iio_channel *chn,
1603  void *src, size_t bytes, void *d), void *data);
1604 
1605 
1609 __api void iio_buffer_set_data(struct iio_buffer *buf, void *data);
1610 
1611 
1615 __api void * iio_buffer_get_data(const struct iio_buffer *buf);
1616 /* ------------------------------------------------------------------*/
1618 /* ---------------------------- HWMON support --------------------------------*/
1632  HWMON_VOLTAGE,
1633  HWMON_FAN,
1634  HWMON_PWM,
1635  HWMON_TEMP,
1636  HWMON_CURRENT,
1637  HWMON_POWER,
1638  HWMON_ENERGY,
1639  HWMON_HUMIDITY,
1640  HWMON_INTRUSION,
1641  HWMON_CHAN_TYPE_UNKNOWN = IIO_CHAN_TYPE_UNKNOWN,
1642 };
1643 
1648 static inline enum hwmon_chan_type
1649 hwmon_channel_get_type(const struct iio_channel *chn)
1650 {
1651  return (enum hwmon_chan_type) iio_channel_get_type(chn);
1652 }
1653 
1659 static inline bool iio_device_is_hwmon(const struct iio_device *dev)
1660 {
1661  const char *id = iio_device_get_id(dev);
1662 
1663  return id[0] == 'h';
1664 }
1665 
1666 /* ------------------------------------------------------------------*/
1668 /* ------------------------- Low-level functions -----------------------------*/
1680  unsigned int length;
1681 
1683  unsigned int bits;
1684 
1686  unsigned int shift;
1687 
1690 
1693 
1695  bool is_be;
1696 
1699 
1701  double scale;
1702 
1704  unsigned int repeat;
1705 };
1706 
1707 
1715 __api __check_ret ssize_t iio_device_get_sample_size(const struct iio_device *dev);
1716 
1717 
1722 __api __check_ret __pure long iio_channel_get_index(const struct iio_channel *chn);
1723 
1724 
1728 __api __check_ret __cnst const struct iio_data_format * iio_channel_get_data_format(
1729  const struct iio_channel *chn);
1730 
1731 
1737 __api void iio_channel_convert(const struct iio_channel *chn,
1738  void *dst, const void *src);
1739 
1740 
1746 __api void iio_channel_convert_inverse(const struct iio_channel *chn,
1747  void *dst, const void *src);
1748 
1749 
1753 __api __check_ret __pure unsigned int iio_device_get_debug_attrs_count(
1754  const struct iio_device *dev);
1755 
1756 
1762 __api __check_ret __pure const char * iio_device_get_debug_attr(
1763  const struct iio_device *dev, unsigned int index);
1764 
1765 
1778 __api __check_ret __pure const char * iio_device_find_debug_attr(
1779  const struct iio_device *dev, const char *name);
1780 
1781 
1804 __api __check_ret ssize_t iio_device_debug_attr_read(const struct iio_device *dev,
1805  const char *attr, char *dst, size_t len);
1806 
1807 
1817 __api __check_ret int iio_device_debug_attr_read_all(struct iio_device *dev,
1818  int (*cb)(struct iio_device *dev, const char *attr,
1819  const char *value, size_t len, void *d),
1820  void *data);
1821 
1822 
1842 __api __check_ret ssize_t iio_device_debug_attr_write(const struct iio_device *dev,
1843  const char *attr, const char *src);
1844 
1845 
1854 __api __check_ret ssize_t iio_device_debug_attr_write_raw(const struct iio_device *dev,
1855  const char *attr, const void *src, size_t len);
1856 
1857 
1867 __api __check_ret int iio_device_debug_attr_write_all(struct iio_device *dev,
1868  ssize_t (*cb)(struct iio_device *dev,
1869  const char *attr, void *buf, size_t len, void *d),
1870  void *data);
1871 
1872 
1880 __api __check_ret int iio_device_debug_attr_read_bool(const struct iio_device *dev,
1881  const char *attr, bool *val);
1882 
1883 
1891 __api __check_ret int iio_device_debug_attr_read_longlong(const struct iio_device *dev,
1892  const char *attr, long long *val);
1893 
1894 
1902 __api __check_ret int iio_device_debug_attr_read_double(const struct iio_device *dev,
1903  const char *attr, double *val);
1904 
1905 
1913 __api __check_ret int iio_device_debug_attr_write_bool(const struct iio_device *dev,
1914  const char *attr, bool val);
1915 
1916 
1924 __api __check_ret int iio_device_debug_attr_write_longlong(const struct iio_device *dev,
1925  const char *attr, long long val);
1926 
1927 
1935 __api __check_ret int iio_device_debug_attr_write_double(const struct iio_device *dev,
1936  const char *attr, double val);
1937 
1938 
1951 __api __check_ret int iio_device_identify_filename(const struct iio_device *dev,
1952  const char *filename, struct iio_channel **chn,
1953  const char **attr);
1954 
1955 
1962 __api __check_ret int iio_device_reg_write(struct iio_device *dev,
1963  uint32_t address, uint32_t value);
1964 
1965 
1972 __api __check_ret int iio_device_reg_read(struct iio_device *dev,
1973  uint32_t address, uint32_t *value);
1974 
1975 
1978 #ifdef __cplusplus
1979 }
1980 #endif
1981 
1982 #undef __api
1983 
1984 #endif /* __IIO_H__ */
__api void * iio_buffer_first(const struct iio_buffer *buf, const struct iio_channel *chn)
Find the first sample of a channel in a buffer.
Definition: buffer.c:250
__api void iio_buffer_set_data(struct iio_buffer *buf, void *data)
Associate a pointer to an iio_buffer structure.
Definition: buffer.c:298
__api void iio_buffer_cancel(struct iio_buffer *buf)
Cancel all buffer operations.
Definition: buffer.c:313
__api __check_ret int iio_buffer_get_poll_fd(struct iio_buffer *buf)
Get a pollable file descriptor.
Definition: buffer.c:113
__api __check_ret ssize_t iio_buffer_push_partial(struct iio_buffer *buf, size_t samples_count)
Send a given number of samples to the hardware.
Definition: buffer.c:183
__api __check_ret __pure const struct iio_device * iio_buffer_get_device(const struct iio_buffer *buf)
Retrieve a pointer to the iio_device structure.
Definition: buffer.c:308
__api __check_ret ptrdiff_t iio_buffer_step(const struct iio_buffer *buf)
Get the step size between two samples of one channel.
Definition: buffer.c:288
__api void * iio_buffer_start(const struct iio_buffer *buf)
Get the start address of the buffer.
Definition: buffer.c:245
__api __check_ret ssize_t iio_buffer_foreach_sample(struct iio_buffer *buf, ssize_t(*callback)(const struct iio_channel *chn, void *src, size_t bytes, void *d), void *data)
Call the supplied callback for each sample found in a buffer.
__api void * iio_buffer_end(const struct iio_buffer *buf)
Get the address that follows the last sample in a buffer.
Definition: buffer.c:293
__api void iio_buffer_destroy(struct iio_buffer *buf)
Destroy the given buffer.
Definition: buffer.c:104
__api void * iio_buffer_get_data(const struct iio_buffer *buf)
Retrieve a previously associated pointer of an iio_buffer structure.
Definition: buffer.c:303
__api __check_ret ssize_t iio_buffer_refill(struct iio_buffer *buf)
Fetch more samples from the hardware.
Definition: buffer.c:123
__api __check_ret int iio_buffer_set_blocking_mode(struct iio_buffer *buf, bool blocking)
Make iio_buffer_refill() and iio_buffer_push() blocking or not.
Definition: buffer.c:118
__api __check_ret ssize_t iio_buffer_push(struct iio_buffer *buf)
Send the samples to the hardware.
Definition: buffer.c:147
__api __check_ret struct iio_buffer * iio_device_create_buffer(const struct iio_device *dev, size_t samples_count, bool cyclic)
Create an input or output buffer associated to the given device.
Definition: buffer.c:26
__api __check_ret __pure bool iio_channel_is_scan_element(const struct iio_channel *chn)
Return True if the given channel is a scan element.
Definition: channel.c:318
__api __check_ret int iio_channel_attr_read_longlong(const struct iio_channel *chn, const char *attr, long long *val)
Read the content of the given channel-specific attribute.
Definition: channel.c:687
__api __check_ret __pure const char * iio_channel_find_attr(const struct iio_channel *chn, const char *name)
Try to find a channel-specific attribute by its name.
Definition: channel.c:361
__api __check_ret __pure unsigned int iio_channel_get_attrs_count(const struct iio_channel *chn)
Enumerate the channel-specific attributes of the given channel.
Definition: channel.c:333
__api __check_ret __pure enum iio_chan_type iio_channel_get_type(const struct iio_channel *chn)
Get the type of the given channel.
Definition: channel.c:328
__api void iio_channel_enable(struct iio_channel *chn)
Enable the given channel.
Definition: channel.c:450
__api __check_ret ssize_t iio_channel_attr_read(const struct iio_channel *chn, const char *attr, char *dst, size_t len)
Read the content of the given channel-specific attribute.
Definition: channel.c:387
__api __check_ret int iio_channel_attr_read_bool(const struct iio_channel *chn, const char *attr, bool *val)
Read the content of the given channel-specific attribute.
Definition: channel.c:704
__api __check_ret size_t iio_channel_write_raw(const struct iio_channel *chn, struct iio_buffer *buffer, const void *src, size_t len)
Multiplex the samples of a given channel.
Definition: channel.c:656
__api __check_ret ssize_t iio_channel_attr_write(const struct iio_channel *chn, const char *attr, const char *src)
Set the value of the given channel-specific attribute.
Definition: channel.c:417
__api __check_ret __pure const char * iio_channel_get_name(const struct iio_channel *chn)
Retrieve the channel name (e.g. vccint)
Definition: channel.c:308
__api __check_ret __pure bool iio_channel_is_output(const struct iio_channel *chn)
Return True if the given channel is an output channel.
Definition: channel.c:313
__api __check_ret __pure enum iio_modifier iio_channel_get_modifier(const struct iio_channel *chn)
Get the modifier type of the given channel.
Definition: channel.c:323
__api void iio_channel_set_data(struct iio_channel *chn, void *data)
Associate a pointer to an iio_channel structure.
Definition: channel.c:423
__api __check_ret size_t iio_channel_write(const struct iio_channel *chn, struct iio_buffer *buffer, const void *src, size_t len)
Convert and multiplex the samples of a given channel.
Definition: channel.c:671
__api __check_ret size_t iio_channel_read(const struct iio_channel *chn, struct iio_buffer *buffer, void *dst, size_t len)
Demultiplex and convert the samples of a given channel.
Definition: channel.c:640
__api __check_ret int iio_channel_attr_write_all(struct iio_channel *chn, ssize_t(*cb)(struct iio_channel *chn, const char *attr, void *buf, size_t len, void *d), void *data)
Set the values of all channel-specific attributes.
Definition: channel.c:830
__api __check_ret int iio_channel_attr_read_double(const struct iio_channel *chn, const char *attr, double *val)
Read the content of the given channel-specific attribute.
Definition: channel.c:716
__api __check_ret int iio_channel_attr_write_bool(const struct iio_channel *chn, const char *attr, bool val)
Set the value of the given channel-specific attribute.
Definition: channel.c:749
__api __check_ret __pure const char * iio_channel_attr_get_filename(const struct iio_channel *chn, const char *attr)
Retrieve the filename of an attribute.
Definition: channel.c:760
__api __check_ret int iio_channel_attr_read_all(struct iio_channel *chn, int(*cb)(struct iio_channel *chn, const char *attr, const char *val, size_t len, void *d), void *data)
Read the content of all channel-specific attributes.
Definition: channel.c:771
__api __check_ret int iio_channel_attr_write_longlong(const struct iio_channel *chn, const char *attr, long long val)
Set the value of the given channel-specific attribute.
Definition: channel.c:727
__api void * iio_channel_get_data(const struct iio_channel *chn)
Retrieve a previously associated pointer of an iio_channel structure.
Definition: channel.c:428
__api __check_ret ssize_t iio_channel_attr_write_raw(const struct iio_channel *chn, const char *attr, const void *src, size_t len)
Set the value of the given channel-specific attribute.
Definition: channel.c:403
__api __check_ret size_t iio_channel_read_raw(const struct iio_channel *chn, struct iio_buffer *buffer, void *dst, size_t len)
Demultiplex the samples of a given channel.
Definition: channel.c:625
__api void iio_channel_disable(struct iio_channel *chn)
Disable the given channel.
Definition: channel.c:456
__api __check_ret int iio_channel_attr_write_double(const struct iio_channel *chn, const char *attr, double val)
Set the value of the given channel-specific attribute.
Definition: channel.c:737
__api __check_ret bool iio_channel_is_enabled(const struct iio_channel *chn)
Returns True if the channel is enabled.
Definition: channel.c:444
__api __check_ret __pure const struct iio_device * iio_channel_get_device(const struct iio_channel *chn)
Retrieve a pointer to the iio_device structure.
Definition: channel.c:873
__api __check_ret __pure const char * iio_channel_get_attr(const struct iio_channel *chn, unsigned int index)
Get the channel-specific attribute present at the given index.
Definition: channel.c:338
__api __check_ret __pure const char * iio_channel_get_id(const struct iio_channel *chn)
Retrieve the channel ID (e.g. voltage0)
Definition: channel.c:303
__api __check_ret struct iio_context * iio_context_clone(const struct iio_context *ctx)
Duplicate a pre-existing IIO context.
Definition: context.c:384
__api __check_ret struct iio_context * iio_create_default_context(void)
Create a context from local or remote IIO devices.
Definition: context.c:415
__api __check_ret int iio_context_get_version(const struct iio_context *ctx, unsigned int *major, unsigned int *minor, char git_tag[8])
Get the version of the backend in use.
Definition: context.c:355
__api __check_ret __pure struct iio_device * iio_context_get_device(const struct iio_context *ctx, unsigned int index)
Get the device present at the given index.
Definition: context.c:285
__api __check_ret int iio_context_get_attr(const struct iio_context *ctx, unsigned int index, const char **name, const char **value)
Retrieve the name and value of a context-specific attribute.
Definition: context.c:470
__api __check_ret __pure const char * iio_context_get_description(const struct iio_context *ctx)
Get a description of the given context.
Definition: context.c:250
__api __check_ret const char * iio_context_get_attr_value(const struct iio_context *ctx, const char *name)
Retrieve the value of a context-specific attribute.
Definition: context.c:483
__api void iio_context_destroy(struct iio_context *ctx)
Destroy the given context.
Definition: context.c:258
__api __check_ret __pure const char * iio_context_get_xml(const struct iio_context *ctx)
Obtain a XML representation of the given context.
Definition: context.c:240
__api __check_ret struct iio_context * iio_create_network_context(const char *host)
Create a context from the network.
Definition: context.c:438
__api __check_ret __pure unsigned int iio_context_get_attrs_count(const struct iio_context *ctx)
Get the number of context-specific attributes.
Definition: context.c:465
__api __check_ret struct iio_context * iio_create_xml_context(const char *xml_file)
Create a context from a XML file.
Definition: context.c:456
__api __check_ret __pure unsigned int iio_context_get_devices_count(const struct iio_context *ctx)
Enumerate the devices found in the given context.
Definition: context.c:280
__api __check_ret int iio_context_set_timeout(struct iio_context *ctx, unsigned int timeout_ms)
Set a timeout for I/O operations.
Definition: context.c:376
__api __check_ret struct iio_context * iio_create_xml_context_mem(const char *xml, size_t len)
Create a context from XML data in memory.
Definition: context.c:447
__api __check_ret __pure struct iio_device * iio_context_find_device(const struct iio_context *ctx, const char *name)
Try to find a device structure by its ID, label or name.
Definition: context.c:294
__api __check_ret struct iio_context * iio_create_local_context(void)
Create a context from local IIO devices (Linux only)
Definition: context.c:429
__api __check_ret struct iio_context * iio_create_context_from_uri(const char *uri)
Create a context from a URI description.
Definition: context.c:394
__api __check_ret __pure const char * iio_context_get_name(const struct iio_context *ctx)
Get the name of the given context.
Definition: context.c:245
__api __check_ret int iio_device_debug_attr_read_double(const struct iio_device *dev, const char *attr, double *val)
Read the content of the given debug attribute.
Definition: device.c:701
__api __check_ret int iio_device_reg_write(struct iio_device *dev, uint32_t address, uint32_t value)
Set the value of a hardware register.
Definition: device.c:788
__api __check_ret ssize_t iio_device_debug_attr_write_raw(const struct iio_device *dev, const char *attr, const void *src, size_t len)
Set the value of the given debug attribute.
Definition: device.c:645
__api __check_ret int iio_device_debug_attr_read_all(struct iio_device *dev, int(*cb)(struct iio_device *dev, const char *attr, const char *value, size_t len, void *d), void *data)
Read the content of all debug attributes.
__api __check_ret int iio_device_debug_attr_write_longlong(const struct iio_device *dev, const char *attr, long long val)
Set the value of the given debug attribute.
Definition: device.c:712
__api __check_ret __pure const char * iio_device_find_debug_attr(const struct iio_device *dev, const char *name)
Try to find a debug attribute by its name.
Definition: device.c:228
__api __check_ret int iio_device_debug_attr_write_double(const struct iio_device *dev, const char *attr, double val)
Set the value of the given debug attribute.
Definition: device.c:724
__api __check_ret int iio_device_debug_attr_write_bool(const struct iio_device *dev, const char *attr, bool val)
Set the value of the given debug attribute.
Definition: device.c:736
__api __check_ret ssize_t iio_device_get_sample_size(const struct iio_device *dev)
Get the current sample size.
Definition: device.c:476
__api __check_ret int iio_device_debug_attr_write_all(struct iio_device *dev, ssize_t(*cb)(struct iio_device *dev, const char *attr, void *buf, size_t len, void *d), void *data)
Set the values of all debug attributes.
Definition: device.c:1029
__api __check_ret int iio_device_reg_read(struct iio_device *dev, uint32_t address, uint32_t *value)
Get the value of a hardware register.
Definition: device.c:801
__api __check_ret int iio_device_identify_filename(const struct iio_device *dev, const char *filename, struct iio_channel **chn, const char **attr)
Identify the channel or debug attribute corresponding to a filename.
Definition: device.c:749
__api __check_ret ssize_t iio_device_debug_attr_read(const struct iio_device *dev, const char *attr, char *dst, size_t len)
Read the content of the given debug attribute.
Definition: device.c:635
__api __check_ret __pure unsigned int iio_device_get_debug_attrs_count(const struct iio_device *dev)
Enumerate the debug attributes of the given device.
Definition: device.c:661
__api __check_ret __cnst const struct iio_data_format * iio_channel_get_data_format(const struct iio_channel *chn)
Get a pointer to a channel's data format structure.
Definition: channel.c:438
__api __check_ret int iio_device_debug_attr_read_bool(const struct iio_device *dev, const char *attr, bool *val)
Read the content of the given debug attribute.
Definition: device.c:689
__api __check_ret ssize_t iio_device_debug_attr_write(const struct iio_device *dev, const char *attr, const char *src)
Set the value of the given debug attribute.
Definition: device.c:655
__api void iio_channel_convert_inverse(const struct iio_channel *chn, void *dst, const void *src)
Convert the sample from host format to hardware format.
Definition: channel.c:596
__api void iio_channel_convert(const struct iio_channel *chn, void *dst, const void *src)
Convert the sample from hardware format to host format.
Definition: channel.c:564
__api __check_ret __pure long iio_channel_get_index(const struct iio_channel *chn)
Get the index of the given channel.
Definition: channel.c:433
__api __check_ret __pure const char * iio_device_get_debug_attr(const struct iio_device *dev, unsigned int index)
Get the debug attribute present at the given index.
Definition: device.c:666
__api __check_ret int iio_device_debug_attr_read_longlong(const struct iio_device *dev, const char *attr, long long *val)
Read the content of the given debug attribute.
Definition: device.c:672
__api __check_ret int iio_device_attr_read_longlong(const struct iio_device *dev, const char *attr, long long *val)
Read the content of the given device-specific attribute.
Definition: device.c:481
__api __check_ret int iio_device_buffer_attr_write_double(const struct iio_device *dev, const char *attr, double val)
Set the value of the given buffer-specific attribute.
Definition: device.c:610
__api __check_ret ssize_t iio_device_attr_write_raw(const struct iio_device *dev, const char *attr, const void *src, size_t len)
Set the value of the given device-specific attribute.
Definition: device.c:316
__api __check_ret __pure unsigned int iio_device_get_attrs_count(const struct iio_device *dev)
Enumerate the device-specific attributes of the given device.
Definition: device.c:194
__api __check_ret int iio_device_set_trigger(const struct iio_device *dev, const struct iio_device *trigger)
Associate a trigger to a given device.
Definition: device.c:402
__api __check_ret int iio_device_buffer_attr_write_all(struct iio_device *dev, ssize_t(*cb)(struct iio_device *dev, const char *attr, void *buf, size_t len, void *d), void *data)
Set the values of all buffer-specific attributes.
Definition: device.c:1037
__api __check_ret int iio_device_buffer_attr_write_bool(const struct iio_device *dev, const char *attr, bool val)
Set the value of the given buffer-specific attribute.
Definition: device.c:622
__api __check_ret int iio_device_attr_write_longlong(const struct iio_device *dev, const char *attr, long long val)
Set the value of the given device-specific attribute.
Definition: device.c:521
__api __check_ret int iio_device_buffer_attr_read_double(const struct iio_device *dev, const char *attr, double *val)
Read the content of the given buffer-specific attribute.
Definition: device.c:587
__api __check_ret __pure const char * iio_device_find_buffer_attr(const struct iio_device *dev, const char *name)
Try to find a buffer-specific attribute by its name.
Definition: device.c:222
__api __check_ret int iio_device_attr_read_all(struct iio_device *dev, int(*cb)(struct iio_device *dev, const char *attr, const char *value, size_t len, void *d), void *data)
Read the content of all device-specific attributes.
__api __check_ret __pure struct iio_channel * iio_device_get_channel(const struct iio_device *dev, unsigned int index)
Get the channel present at the given index.
Definition: device.c:148
__api __check_ret __pure unsigned int iio_device_get_buffer_attrs_count(const struct iio_device *dev)
Enumerate the buffer-specific attributes of the given device.
Definition: device.c:211
__api __check_ret __pure const char * iio_device_get_attr(const struct iio_device *dev, unsigned int index)
Get the device-specific attribute present at the given index.
Definition: device.c:199
__api __check_ret __pure const char * iio_device_get_name(const struct iio_device *dev)
Retrieve the device name (e.g. xadc)
Definition: device.c:133
__api __check_ret __pure const char * iio_device_get_buffer_attr(const struct iio_device *dev, unsigned int index)
Get the buffer-specific attribute present at the given index.
Definition: device.c:216
__api __check_ret __pure bool iio_device_is_trigger(const struct iio_device *dev)
Return True if the given device is a trigger.
Definition: device.c:368
__api void * iio_device_get_data(const struct iio_device *dev)
Retrieve a previously associated pointer of an iio_device structure.
Definition: device.c:363
__api __check_ret ssize_t iio_device_buffer_attr_write(const struct iio_device *dev, const char *attr, const char *src)
Set the value of the given buffer-specific attribute.
Definition: device.c:352
__api __check_ret int iio_device_set_kernel_buffers_count(const struct iio_device *dev, unsigned int nb_buffers)
Configure the number of kernel buffers for a device.
Definition: device.c:380
__api __check_ret int iio_device_buffer_attr_read_bool(const struct iio_device *dev, const char *attr, bool *val)
Read the content of the given buffer-specific attribute.
Definition: device.c:575
__api __check_ret int iio_device_attr_read_bool(const struct iio_device *dev, const char *attr, bool *val)
Read the content of the given device-specific attribute.
Definition: device.c:498
__api __check_ret ssize_t iio_device_buffer_attr_write_raw(const struct iio_device *dev, const char *attr, const void *src, size_t len)
Set the value of the given buffer-specific attribute.
Definition: device.c:342
__api __check_ret __pure const char * iio_device_get_id(const struct iio_device *dev)
Retrieve the device ID (e.g. iio:device0)
Definition: device.c:128
__api __check_ret int iio_device_attr_write_bool(const struct iio_device *dev, const char *attr, bool val)
Set the value of the given device-specific attribute.
Definition: device.c:545
__api __check_ret ssize_t iio_device_buffer_attr_read(const struct iio_device *dev, const char *attr, char *dst, size_t len)
Read the content of the given buffer-specific attribute.
Definition: device.c:332
__api __check_ret __pure const char * iio_device_get_label(const struct iio_device *dev)
Retrieve the device label (e.g. lo_pll0_rx_adf4351)
Definition: device.c:138
__api __check_ret ssize_t iio_device_attr_write(const struct iio_device *dev, const char *attr, const char *src)
Set the value of the given device-specific attribute.
Definition: device.c:326
__api __check_ret int iio_device_buffer_attr_read_all(struct iio_device *dev, int(*cb)(struct iio_device *dev, const char *attr, const char *value, size_t len, void *d), void *data)
Read the content of all buffer-specific attributes.
__api __check_ret int iio_device_attr_read_double(const struct iio_device *dev, const char *attr, double *val)
Read the content of the given device-specific attribute.
Definition: device.c:510
__api void iio_device_set_data(struct iio_device *dev, void *data)
Associate a pointer to an iio_device structure.
Definition: device.c:358
__api __check_ret int iio_device_buffer_attr_write_longlong(const struct iio_device *dev, const char *attr, long long val)
Set the value of the given buffer-specific attribute.
Definition: device.c:598
__api __check_ret __pure const struct iio_context * iio_device_get_context(const struct iio_device *dev)
Retrieve a pointer to the iio_context structure.
Definition: device.c:1053
__api __check_ret int iio_device_attr_write_double(const struct iio_device *dev, const char *attr, double val)
Set the value of the given device-specific attribute.
Definition: device.c:533
__api __check_ret int iio_device_attr_write_all(struct iio_device *dev, ssize_t(*cb)(struct iio_device *dev, const char *attr, void *buf, size_t len, void *d), void *data)
Set the values of all device-specific attributes.
Definition: device.c:1045
__api __check_ret __pure unsigned int iio_device_get_channels_count(const struct iio_device *dev)
Enumerate the channels of the given device.
Definition: device.c:143
__api __check_ret int iio_device_get_trigger(const struct iio_device *dev, const struct iio_device **trigger)
Retrieve the trigger of a given device.
Definition: device.c:391
__api __check_ret int iio_device_buffer_attr_read_longlong(const struct iio_device *dev, const char *attr, long long *val)
Read the content of the given buffer-specific attribute.
Definition: device.c:558
__api __check_ret ssize_t iio_device_attr_read(const struct iio_device *dev, const char *attr, char *dst, size_t len)
Read the content of the given device-specific attribute.
Definition: device.c:306
__api __check_ret __pure const char * iio_device_find_attr(const struct iio_device *dev, const char *name)
Try to find a device-specific attribute by its name.
Definition: device.c:205
__api __check_ret __pure struct iio_channel * iio_device_find_channel(const struct iio_device *dev, const char *name, bool output)
Try to find a channel structure by its name of ID.
Definition: device.c:157
hwmon_chan_type
Hwmon channel type.
Definition: iio.h:1631
__api void iio_context_info_list_free(struct iio_context_info **info)
Free a context info list.
Definition: scan.c:103
__api __check_ret ssize_t iio_scan_context_get_info_list(struct iio_scan_context *ctx, struct iio_context_info ***info)
Enumerate available contexts.
Definition: scan.c:33
__api void iio_scan_context_destroy(struct iio_scan_context *ctx)
Destroy the given scan context.
Definition: scan.c:188
__api __check_ret __pure const char * iio_context_info_get_uri(const struct iio_context_info *info)
Get the URI of a discovered context.
Definition: scan.c:27
__api __check_ret __pure const char * iio_context_info_get_description(const struct iio_context_info *info)
Get a description of a discovered context.
Definition: scan.c:21
__api void iio_scan_block_destroy(struct iio_scan_block *blk)
Destroy the given scan block.
Definition: scan.c:238
__api struct iio_context_info * iio_scan_block_get_info(struct iio_scan_block *blk, unsigned int index)
Get the iio_context_info for a particular context.
Definition: scan.c:208
__api __check_ret struct iio_scan_context * iio_create_scan_context(const char *backend, unsigned int flags)
Create a scan context.
Definition: scan.c:139
__api struct iio_scan_block * iio_create_scan_block(const char *backend, unsigned int flags)
Create a scan block.
Definition: scan.c:218
__api ssize_t iio_scan_block_scan(struct iio_scan_block *blk)
Enumerate available contexts via scan block.
Definition: scan.c:200
__api __check_ret __cnst const char * iio_get_backend(unsigned int index)
Retrieve the name of a given backend.
Definition: backend.c:27
__api void iio_strerror(int err, char *dst, size_t len)
Get a string description of an error code.
Definition: utilities.c:198
__api __check_ret __cnst bool iio_has_backend(const char *backend)
Check if the specified backend is available.
Definition: backend.c:62
__api void iio_library_get_version(unsigned int *major, unsigned int *minor, char git_tag[8])
Get the version of the libiio library.
Definition: utilities.c:186
__api __check_ret __cnst unsigned int iio_get_backends_count(void)
Get the number of available backends.
Definition: backend.c:14
iio_event_type
IIO event type.
Definition: iio.h:208
iio_chan_type
IIO channel type.
Definition: iio.h:101
iio_event_direction
IIO event direction.
Definition: iio.h:225
iio_modifier
IIO channel modifier.
Definition: iio.h:147
An input or output buffer, used to read or write samples.
Represents an input or output channel of a device.
The information related to a discovered context.
Contains the representation of an IIO context.
Contains the format of a data sample.
Definition: iio.h:1678
bool is_signed
Contains True if the sample is signed.
Definition: iio.h:1689
bool is_be
Contains True if the sample is in big-endian format.
Definition: iio.h:1695
bool with_scale
Contains True if the sample should be scaled when converted.
Definition: iio.h:1698
double scale
Contains the scale to apply if with_scale is set.
Definition: iio.h:1701
unsigned int repeat
Number of times length repeats (added in v0.8)
Definition: iio.h:1704
unsigned int length
Total length of the sample, in bits.
Definition: iio.h:1680
bool is_fully_defined
Contains True if the sample is fully defined, sign extended, etc.
Definition: iio.h:1692
unsigned int shift
Right-shift to apply when converting sample.
Definition: iio.h:1686
unsigned int bits
Length of valuable data in the sample, in bits.
Definition: iio.h:1683
Represents a device in the IIO context.