1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986
|
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* libiio - Library for interfacing industrial I/O (IIO) devices
*
* Copyright (C) 2014 Analog Devices, Inc.
* Author: Paul Cercueil <paul.cercueil@analog.com>
*/
/** @file iio.h
* @brief Public interface */
#ifndef __IIO_H__
#define __IIO_H__
#ifdef __cplusplus
extern "C" {
#endif
#include <limits.h>
#include <stdint.h>
#include <stdlib.h>
#include <stddef.h>
#if (defined(_WIN32) || defined(__MBED__))
#ifndef _SSIZE_T_DEFINED
typedef ptrdiff_t ssize_t;
#define _SSIZE_T_DEFINED
#endif
#else
#include <sys/types.h>
#endif
#if defined(_MSC_VER) && (_MSC_VER < 1800) && !defined(__BOOL_DEFINED)
#undef bool
#undef false
#undef true
#define bool char
#define false 0
#define true 1
#else
#include <stdbool.h>
#endif
#if defined(__GNUC__) && !defined(MATLAB_MEX_FILE) && !defined(MATLAB_LOADLIBRARY)
#ifndef __cnst
#define __cnst __attribute__((const))
#endif
#ifndef __pure
#define __pure __attribute__((pure))
#endif
#define __notused __attribute__((unused))
#ifdef IIO_CHECK_RET
#define __check_ret __attribute__((warn_unused_result))
#else
#define __check_ret
#endif
#else
#define __cnst
#define __pure
#define __notused
#define __check_ret
#endif
#ifdef _WIN32
# ifdef LIBIIO_STATIC
# define __api
# elif defined(LIBIIO_EXPORTS)
# define __api __declspec(dllexport)
# else
# define __api __declspec(dllimport)
# endif
#elif __GNUC__ >= 4 && !defined(MATLAB_MEX_FILE) && !defined(MATLAB_LOADLIBRARY)
# define __api __attribute__((visibility ("default")))
#else
# define __api
#endif
struct iio_context;
struct iio_device;
struct iio_channel;
struct iio_buffer;
struct iio_context_info;
struct iio_scan_context;
struct iio_scan_block;
/*
* <linux/iio/types.h> header guard to protect these enums from being defined
* twice
*/
#ifndef _IIO_TYPES_H_
#define _IIO_TYPES_H_
/**
* @enum iio_chan_type
* @brief IIO channel type
*
* A IIO channel has a type specifying the type of data associated with the
* channel.
*/
enum iio_chan_type {
IIO_VOLTAGE,
IIO_CURRENT,
IIO_POWER,
IIO_ACCEL,
IIO_ANGL_VEL,
IIO_MAGN,
IIO_LIGHT,
IIO_INTENSITY,
IIO_PROXIMITY,
IIO_TEMP,
IIO_INCLI,
IIO_ROT,
IIO_ANGL,
IIO_TIMESTAMP,
IIO_CAPACITANCE,
IIO_ALTVOLTAGE,
IIO_CCT,
IIO_PRESSURE,
IIO_HUMIDITYRELATIVE,
IIO_ACTIVITY,
IIO_STEPS,
IIO_ENERGY,
IIO_DISTANCE,
IIO_VELOCITY,
IIO_CONCENTRATION,
IIO_RESISTANCE,
IIO_PH,
IIO_UVINDEX,
IIO_ELECTRICALCONDUCTIVITY,
IIO_COUNT,
IIO_INDEX,
IIO_GRAVITY,
IIO_POSITIONRELATIVE,
IIO_PHASE,
IIO_MASSCONCENTRATION,
IIO_CHAN_TYPE_UNKNOWN = INT_MAX
};
/**
* @enum iio_modifier
* @brief IIO channel modifier
*
* In a addition to a type a IIO channel can optionally have a channel modifier
* further specifying the data type of of the channel.
*/
enum iio_modifier {
IIO_NO_MOD,
IIO_MOD_X,
IIO_MOD_Y,
IIO_MOD_Z,
IIO_MOD_X_AND_Y,
IIO_MOD_X_AND_Z,
IIO_MOD_Y_AND_Z,
IIO_MOD_X_AND_Y_AND_Z,
IIO_MOD_X_OR_Y,
IIO_MOD_X_OR_Z,
IIO_MOD_Y_OR_Z,
IIO_MOD_X_OR_Y_OR_Z,
IIO_MOD_LIGHT_BOTH,
IIO_MOD_LIGHT_IR,
IIO_MOD_ROOT_SUM_SQUARED_X_Y,
IIO_MOD_SUM_SQUARED_X_Y_Z,
IIO_MOD_LIGHT_CLEAR,
IIO_MOD_LIGHT_RED,
IIO_MOD_LIGHT_GREEN,
IIO_MOD_LIGHT_BLUE,
IIO_MOD_QUATERNION,
IIO_MOD_TEMP_AMBIENT,
IIO_MOD_TEMP_OBJECT,
IIO_MOD_NORTH_MAGN,
IIO_MOD_NORTH_TRUE,
IIO_MOD_NORTH_MAGN_TILT_COMP,
IIO_MOD_NORTH_TRUE_TILT_COMP,
IIO_MOD_RUNNING,
IIO_MOD_JOGGING,
IIO_MOD_WALKING,
IIO_MOD_STILL,
IIO_MOD_ROOT_SUM_SQUARED_X_Y_Z,
IIO_MOD_I,
IIO_MOD_Q,
IIO_MOD_CO2,
IIO_MOD_VOC,
IIO_MOD_LIGHT_UV,
IIO_MOD_LIGHT_DUV,
IIO_MOD_PM1,
IIO_MOD_PM2P5,
IIO_MOD_PM4,
IIO_MOD_PM10,
IIO_MOD_ETHANOL,
IIO_MOD_H2,
IIO_MOD_O2,
IIO_MOD_LINEAR_X,
IIO_MOD_LINEAR_Y,
IIO_MOD_LINEAR_Z,
IIO_MOD_PITCH,
IIO_MOD_YAW,
IIO_MOD_ROLL,
};
/**
* @enum iio_event_type
* @brief IIO event type
*
* Some IIO devices can deliver events. The type of the event can be specified
* by one of the iio_event_type values.
*/
enum iio_event_type {
IIO_EV_TYPE_THRESH,
IIO_EV_TYPE_MAG,
IIO_EV_TYPE_ROC,
IIO_EV_TYPE_THRESH_ADAPTIVE,
IIO_EV_TYPE_MAG_ADAPTIVE,
IIO_EV_TYPE_CHANGE,
IIO_EV_TYPE_MAG_REFERENCED,
IIO_EV_TYPE_GESTURE,
};
/**
* @enum iio_event_direction
* @brief IIO event direction
*
* When applicable, this enum specifies the direction of the iio_event_type.
*/
enum iio_event_direction {
IIO_EV_DIR_EITHER,
IIO_EV_DIR_RISING,
IIO_EV_DIR_FALLING,
IIO_EV_DIR_NONE,
IIO_EV_DIR_SINGLETAP,
IIO_EV_DIR_DOUBLETAP,
};
#endif /* _IIO_TYPES_H_ */
/* ---------------------------------------------------------------------------*/
/* ------------------------- Scan functions ----------------------------------*/
/** @defgroup Scan Functions for scanning available contexts
* @{
* @struct iio_scan_context
* @brief The scanning context
*
* @struct iio_context_info
* @brief The information related to a discovered context
*/
/** @brief Create a scan context
* @param backend A NULL-terminated string containing a comma-separated
* list of the backend(s) to use for scanning.
* @param flags Unused for now. Set to 0.
* @return on success, a pointer to a iio_scan_context structure
* @return On failure, NULL is returned and errno is set appropriately
*
* <b>NOTE:</b> Libiio version 0.20 and above can handle multiple
* strings, for instance "local:usb:", "ip:usb:", "local:usb:ip:", and
* require a colon as the delimiter.
* Libiio version 0.24 and above prefer a comma instead of colon as the
* delimiter, and handle specifying backend-specific information. For
* instance, "local,usb=0456:*" will scan the local backend and limit
* scans on USB to vendor ID 0x0456, and accept all product IDs. The
* "usb=0456:b673" string would limit the scan to the device with this
* particular VID/PID. Both IDs are expected in hexadecimal, no 0x
* prefix needed. */
__api __check_ret struct iio_scan_context * iio_create_scan_context(
const char *backend, unsigned int flags);
/** @brief Destroy the given scan context
* @param ctx A pointer to an iio_scan_context structure
*
* <b>NOTE:</b> After that function, the iio_scan_context pointer shall be invalid. */
__api void iio_scan_context_destroy(struct iio_scan_context *ctx);
/** @brief Enumerate available contexts
* @param ctx A pointer to an iio_scan_context structure
* @param info A pointer to a 'const struct iio_context_info **' typed variable.
* The pointed variable will be initialized on success.
* @returns On success, the number of contexts found.
* @returns On failure, a negative error number.
*/
__api __check_ret ssize_t iio_scan_context_get_info_list(struct iio_scan_context *ctx,
struct iio_context_info ***info);
/** @brief Free a context info list
* @param info A pointer to a 'const struct iio_context_info *' typed variable
*/
__api void iio_context_info_list_free(struct iio_context_info **info);
/** @brief Get a description of a discovered context
* @param info A pointer to an iio_context_info structure
* @return A pointer to a static NULL-terminated string
*/
__api __check_ret __pure const char * iio_context_info_get_description(
const struct iio_context_info *info);
/** @brief Get the URI of a discovered context
* @param info A pointer to an iio_context_info structure
* @return A pointer to a static NULL-terminated string
*/
__api __check_ret __pure const char * iio_context_info_get_uri(
const struct iio_context_info *info);
/** @brief Create a scan block
* @param backend A NULL-terminated string containing the backend to use for
* scanning. If NULL, all the available backends are used.
* @param flags Unused for now. Set to 0.
* @return on success, a pointer to a iio_scan_block structure
* @return On failure, NULL is returned and errno is set appropriately
*
* Introduced in version 0.20. */
__api struct iio_scan_block * iio_create_scan_block(
const char *backend, unsigned int flags);
/** @brief Destroy the given scan block
* @param blk A pointer to an iio_scan_block structure
*
* <b>NOTE:</b> After that function, the iio_scan_block pointer shall be invalid.
*
* Introduced in version 0.20. */
__api void iio_scan_block_destroy(struct iio_scan_block *blk);
/** @brief Enumerate available contexts via scan block
* @param blk A pointer to a iio_scan_block structure.
* @returns On success, the number of contexts found.
* @returns On failure, a negative error number.
*
* Introduced in version 0.20. */
__api ssize_t iio_scan_block_scan(struct iio_scan_block *blk);
/** @brief Get the iio_context_info for a particular context
* @param blk A pointer to an iio_scan_block structure
* @param index The index corresponding to the context.
* @return A pointer to the iio_context_info for the context
* @returns On success, a pointer to the specified iio_context_info
* @returns On failure, NULL is returned and errno is set appropriately
*
* Introduced in version 0.20. */
__api struct iio_context_info *iio_scan_block_get_info(
struct iio_scan_block *blk, unsigned int index);
/** @} *//* ------------------------------------------------------------------*/
/* ------------------------- Top-level functions -----------------------------*/
/** @defgroup TopLevel Top-level functions
* @{ */
/** @brief Get the version of the libiio library
* @param major A pointer to an unsigned integer (NULL accepted)
* @param minor A pointer to an unsigned integer (NULL accepted)
* @param git_tag A pointer to a 8-characters buffer (NULL accepted) */
__api void iio_library_get_version(unsigned int *major,
unsigned int *minor, char git_tag[8]);
/** @brief Get a string description of an error code
* @param err The error code
* @param dst A pointer to the memory area where the NULL-terminated string
* corresponding to the error message will be stored
* @param len The available length of the memory area, in bytes */
__api void iio_strerror(int err, char *dst, size_t len);
/** @brief Check if the specified backend is available
* @param backend The name of the backend to query
* @return True if the backend is available, false otherwise
*
* Introduced in version 0.9. */
__api __check_ret __cnst bool iio_has_backend(const char *backend);
/** @brief Get the number of available backends
* @return The number of available backends
*
* Introduced in version 0.9. */
__api __check_ret __cnst unsigned int iio_get_backends_count(void);
/** @brief Retrieve the name of a given backend
* @param index The index corresponding to the attribute
* @return On success, a pointer to a static NULL-terminated string
* @return If the index is invalid, NULL is returned
*
* Introduced in version 0.9. */
__api __check_ret __cnst const char * iio_get_backend(unsigned int index);
/** @} *//* ------------------------------------------------------------------*/
/* ------------------------- Context functions -------------------------------*/
/** @defgroup Context Context
* @{
* @struct iio_context
* @brief Contains the representation of an IIO context */
/** @brief Create a context from local or remote IIO devices
* @return On success, A pointer to an iio_context structure
* @return On failure, NULL is returned and errno is set appropriately
*
* <b>NOTE:</b> This function will create a context with the URI
* provided in the IIOD_REMOTE environment variable. If not set, a local
* context will be created instead. */
__api __check_ret struct iio_context * iio_create_default_context(void);
/** @brief Create a context from local IIO devices (Linux only)
* @return On success, A pointer to an iio_context structure
* @return On failure, NULL is returned and errno is set appropriately */
__api __check_ret struct iio_context * iio_create_local_context(void);
/** @brief Create a context from a XML file
* @param xml_file Path to the XML file to open
* @return On success, A pointer to an iio_context structure
* @return On failure, NULL is returned and errno is set appropriately
*
* <b>NOTE:</b> The format of the XML must comply to the one returned by
* iio_context_get_xml. */
__api __check_ret struct iio_context * iio_create_xml_context(const char *xml_file);
/** @brief Create a context from XML data in memory
* @param xml Pointer to the XML data in memory
* @param len Length of the XML string in memory (excluding the final \0)
* @return On success, A pointer to an iio_context structure
* @return On failure, NULL is returned and errno is set appropriately
*
* <b>NOTE:</b> The format of the XML must comply to the one returned by
* iio_context_get_xml */
__api __check_ret struct iio_context * iio_create_xml_context_mem(
const char *xml, size_t len);
/** @brief Create a context from the network
* @param host Hostname, IPv4 or IPv6 address where the IIO Daemon is running
* @return On success, a pointer to an iio_context structure
* @return On failure, NULL is returned and errno is set appropriately */
__api __check_ret struct iio_context * iio_create_network_context(const char *host);
/** @brief Create a context from a URI description
* @param uri A URI describing the context location
* @return On success, a pointer to a iio_context structure
* @return On failure, NULL is returned and errno is set appropriately
*
* <b>NOTE:</b> The following URIs are supported based on compile time backend
* support:
* - Local backend, "local:"\n
* Does not have an address part. For example <i>"local:"</i>
* - XML backend, "xml:"\n Requires a path to the XML file for the address part.
* For example <i>"xml:/home/user/file.xml"</i>
* - Network backend, "ip:"\n Requires a hostname, IPv4, or IPv6 to connect to
* a specific running IIO Daemon or no address part for automatic discovery
* when library is compiled with ZeroConf support. For example
* <i>"ip:192.168.2.1"</i>, <b>or</b> <i>"ip:localhost"</i>, <b>or</b> <i>"ip:"</i>
* <b>or</b> <i>"ip:plutosdr.local"</i>. To support alternative port numbers the
* standard <i>ip:host:port</i> format is used. A special format is required as
* defined in RFC2732 for IPv6 literal hostnames, (adding '[]' around the host)
* to use a <i>ip:[x:x:x:x:x:x:x:x]:port</i> format.
* Valid examples would be:
* - ip: Any host on default port
* - ip::40000 Any host on port 40000
* - ip:analog.local Default port
* - ip:brain.local:40000 Port 40000
* - ip:192.168.1.119 Default Port
* - ip:192.168.1.119:40000 Port 40000
* - ip:2601:190:400:da:47b3:55ab:3914:bff1 Default Port
* - ip:[2601:190:400:da:9a90:96ff:feb5:acaa]:40000 Port 40000
* - ip:fe80::f14d:3728:501e:1f94%eth0 Link-local through eth0, default port
* - ip:[fe80::f14d:3728:501e:1f94%eth0]:40000 Link-local through eth0, port 40000
* - USB backend, "usb:"\n When more than one usb device is attached, requires
* bus, address, and interface parts separated with a dot. For example
* <i>"usb:3.32.5"</i>. Where there is only one USB device attached, the shorthand
* <i>"usb:"</i> can be used.
* - Serial backend, "serial:"\n Requires:
* - a port (/dev/ttyUSB0),
* - baud_rate (default <b>115200</b>)
* - serial port configuration
* - data bits (5 6 7 <b>8</b> 9)
* - parity ('<b>n</b>' none, 'o' odd, 'e' even, 'm' mark, 's' space)
* - stop bits (<b>1</b> 2)
* - flow control ('<b>\0</b>' none, 'x' Xon Xoff, 'r' RTSCTS, 'd' DTRDSR)
*
* For example <i>"serial:/dev/ttyUSB0,115200"</i> <b>or</b> <i>"serial:/dev/ttyUSB0,115200,8n1"</i>*/
__api __check_ret struct iio_context * iio_create_context_from_uri(const char *uri);
/** @brief Duplicate a pre-existing IIO context
* @param ctx A pointer to an iio_context structure
* @return On success, A pointer to an iio_context structure
* @return On failure, NULL is returned and errno is set appropriately
*
* <b>NOTE:</b> This function is not supported on 'usb:' contexts, since libusb
* can only claim the interface once. "Function not implemented" is the expected errno.
* Any context which is cloned, must be destroyed via calling iio_context_destroy() */
__api __check_ret struct iio_context * iio_context_clone(const struct iio_context *ctx);
/** @brief Destroy the given context
* @param ctx A pointer to an iio_context structure
*
* <b>NOTE:</b> After that function, the iio_context pointer shall be invalid. */
__api void iio_context_destroy(struct iio_context *ctx);
/** @brief Get the version of the backend in use
* @param ctx A pointer to an iio_context structure
* @param major A pointer to an unsigned integer (NULL accepted)
* @param minor A pointer to an unsigned integer (NULL accepted)
* @param git_tag A pointer to a 8-characters buffer (NULL accepted)
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_context_get_version(const struct iio_context *ctx,
unsigned int *major, unsigned int *minor, char git_tag[8]);
/** @brief Obtain a XML representation of the given context
* @param ctx A pointer to an iio_context structure
* @return A pointer to a static NULL-terminated string */
__api __check_ret __pure const char * iio_context_get_xml(const struct iio_context *ctx);
/** @brief Get the name of the given context
* @param ctx A pointer to an iio_context structure
* @return A pointer to a static NULL-terminated string
*
* <b>NOTE:</b>The returned string will be <b><i>local</i></b>,
* <b><i>xml</i></b> or <b><i>network</i></b> when the context has been
* created with the local, xml and network backends respectively.*/
__api __check_ret __pure const char * iio_context_get_name(const struct iio_context *ctx);
/** @brief Get a description of the given context
* @param ctx A pointer to an iio_context structure
* @return A pointer to a static NULL-terminated string
*
* <b>NOTE:</b>The returned string will contain human-readable information about
* the current context. */
__api __check_ret __pure const char * iio_context_get_description(
const struct iio_context *ctx);
/** @brief Get the number of context-specific attributes
* @param ctx A pointer to an iio_context structure
* @return The number of context-specific attributes
*
* Introduced in version 0.9. */
__api __check_ret __pure unsigned int iio_context_get_attrs_count(
const struct iio_context *ctx);
/** @brief Retrieve the name and value of a context-specific attribute
* @param ctx A pointer to an iio_context structure
* @param index The index corresponding to the attribute
* @param name A pointer to a const char * pointer (NULL accepted)
* @param value A pointer to a const char * pointer (NULL accepted)
* @return On success, 0 is returned
* @return On error, a negative errno code is returned
*
* Introduced in version 0.9. */
__api __check_ret int iio_context_get_attr(
const struct iio_context *ctx, unsigned int index,
const char **name, const char **value);
/** @brief Retrieve the value of a context-specific attribute
* @param ctx A pointer to an iio_context structure
* @param name The name of the context attribute to read
* @return On success, a pointer to a static NULL-terminated string
* @return If the name does not correspond to any attribute, NULL is
* returned
*
* Introduced in version 0.9. */
__api __check_ret const char * iio_context_get_attr_value(
const struct iio_context *ctx, const char *name);
/** @brief Enumerate the devices found in the given context
* @param ctx A pointer to an iio_context structure
* @return The number of devices found */
__api __check_ret __pure unsigned int iio_context_get_devices_count(
const struct iio_context *ctx);
/** @brief Get the device present at the given index
* @param ctx A pointer to an iio_context structure
* @param index The index corresponding to the device
* @return On success, a pointer to an iio_device structure
* @return If the index is invalid, NULL is returned */
__api __check_ret __pure struct iio_device * iio_context_get_device(
const struct iio_context *ctx, unsigned int index);
/** @brief Try to find a device structure by its ID, label or name
* @param ctx A pointer to an iio_context structure
* @param name A NULL-terminated string corresponding to the ID, label or name
* of the device to search for
* @return On success, a pointer to an iio_device structure
* @return If the parameter does not correspond to the ID, label or name of
* any known device, NULL is returned */
__api __check_ret __pure struct iio_device * iio_context_find_device(
const struct iio_context *ctx, const char *name);
/** @brief Set a timeout for I/O operations
* @param ctx A pointer to an iio_context structure
* @param timeout_ms A positive integer representing the time in milliseconds
* after which a timeout occurs. A value of 0 is used to specify that no
* timeout should occur.
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_context_set_timeout(
struct iio_context *ctx, unsigned int timeout_ms);
/** @} *//* ------------------------------------------------------------------*/
/* ------------------------- Device functions --------------------------------*/
/** @defgroup Device Device
* @{
* @struct iio_device
* @brief Represents a device in the IIO context */
/** @brief Retrieve a pointer to the iio_context structure
* @param dev A pointer to an iio_device structure
* @return A pointer to an iio_context structure */
__api __check_ret __pure const struct iio_context * iio_device_get_context(
const struct iio_device *dev);
/** @brief Retrieve the device ID (e.g. <b><i>iio:device0</i></b>)
* @param dev A pointer to an iio_device structure
* @return A pointer to a static NULL-terminated string */
__api __check_ret __pure const char * iio_device_get_id(const struct iio_device *dev);
/** @brief Retrieve the device name (e.g. <b><i>xadc</i></b>)
* @param dev A pointer to an iio_device structure
* @return A pointer to a static NULL-terminated string
*
* <b>NOTE:</b> if the device has no name, NULL is returned. */
__api __check_ret __pure const char * iio_device_get_name(const struct iio_device *dev);
/** @brief Retrieve the device label (e.g. <b><i>lo_pll0_rx_adf4351</i></b>)
* @param dev A pointer to an iio_device structure
* @return A pointer to a static NULL-terminated string
*
* <b>NOTE:</b> if the device has no label, NULL is returned. */
__api __check_ret __pure const char * iio_device_get_label(const struct iio_device *dev);
/** @brief Enumerate the channels of the given device
* @param dev A pointer to an iio_device structure
* @return The number of channels found */
__api __check_ret __pure unsigned int iio_device_get_channels_count(
const struct iio_device *dev);
/** @brief Enumerate the device-specific attributes of the given device
* @param dev A pointer to an iio_device structure
* @return The number of device-specific attributes found */
__api __check_ret __pure unsigned int iio_device_get_attrs_count(
const struct iio_device *dev);
/** @brief Enumerate the buffer-specific attributes of the given device
* @param dev A pointer to an iio_device structure
* @return The number of buffer-specific attributes found */
__api __check_ret __pure unsigned int iio_device_get_buffer_attrs_count(
const struct iio_device *dev);
/** @brief Get the channel present at the given index
* @param dev A pointer to an iio_device structure
* @param index The index corresponding to the channel
* @return On success, a pointer to an iio_channel structure
* @return If the index is invalid, NULL is returned */
__api __check_ret __pure struct iio_channel * iio_device_get_channel(
const struct iio_device *dev, unsigned int index);
/** @brief Get the device-specific attribute present at the given index
* @param dev A pointer to an iio_device structure
* @param index The index corresponding to the attribute
* @return On success, a pointer to a static NULL-terminated string
* @return If the index is invalid, NULL is returned */
__api __check_ret __pure const char * iio_device_get_attr(
const struct iio_device *dev, unsigned int index);
/** @brief Get the buffer-specific attribute present at the given index
* @param dev A pointer to an iio_device structure
* @param index The index corresponding to the attribute
* @return On success, a pointer to a static NULL-terminated string
* @return If the index is invalid, NULL is returned */
__api __check_ret __pure const char * iio_device_get_buffer_attr(
const struct iio_device *dev, unsigned int index);
/** @brief Try to find a channel structure by its name of ID
* @param dev A pointer to an iio_device structure
* @param name A NULL-terminated string corresponding to the name or the ID of
* the channel to search for
* @param output True if the searched channel is output, False otherwise
* @return On success, a pointer to an iio_channel structure
* @return If the name or ID does not correspond to any known channel of the
* given device, NULL is returned */
__api __check_ret __pure struct iio_channel * iio_device_find_channel(
const struct iio_device *dev, const char *name, bool output);
/** @brief Try to find a device-specific attribute by its name
* @param dev A pointer to an iio_device structure
* @param name A NULL-terminated string corresponding to the name of the
* attribute
* @return On success, a pointer to a static NULL-terminated string
* @return If the name does not correspond to any known attribute of the given
* device, NULL is returned
*
* <b>NOTE:</b> This function is useful to detect the presence of an attribute.
* It can also be used to retrieve the name of an attribute as a pointer to a
* static string from a dynamically allocated string. */
__api __check_ret __pure const char * iio_device_find_attr(
const struct iio_device *dev, const char *name);
/** @brief Try to find a buffer-specific attribute by its name
* @param dev A pointer to an iio_device structure
* @param name A NULL-terminated string corresponding to the name of the
* attribute
* @return On success, a pointer to a static NULL-terminated string
* @return If the name does not correspond to any known attribute of the given
* device, NULL is returned
*
* <b>NOTE:</b> This function is useful to detect the presence of an attribute.
* It can also be used to retrieve the name of an attribute as a pointer to a
* static string from a dynamically allocated string. */
__api __check_ret __pure const char * iio_device_find_buffer_attr(
const struct iio_device *dev, const char *name);
/** @brief Read the content of the given device-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param dst A pointer to the memory area where the NULL-terminated string
* corresponding to the value read will be stored
* @param len The available length of the memory area, in bytes
* @return On success, the number of bytes written to the buffer
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b>By passing NULL as the "attr" argument to iio_device_attr_read,
* it is now possible to read all of the attributes of a device.
*
* The buffer is filled with one block of data per attribute of the device,
* by the order they appear in the iio_device structure.
*
* The first four bytes of one block correspond to a 32-bit signed value in
* network order. If negative, it corresponds to the errno code that were
* returned when reading the attribute; if positive, it corresponds to the
* length of the data read. In that case, the rest of the block contains
* the data. */
__api __check_ret ssize_t iio_device_attr_read(const struct iio_device *dev,
const char *attr, char *dst, size_t len);
/** @brief Read the content of all device-specific attributes
* @param dev A pointer to an iio_device structure
* @param cb A pointer to a callback function
* @param data A pointer that will be passed to the callback function
* @return On success, 0 is returned
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b> This function is especially useful when used with the network
* backend, as all the device-specific attributes are read in one single
* command. */
__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);
/** @brief Read the content of the given device-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A pointer to a bool variable where the value should be stored
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_attr_read_bool(const struct iio_device *dev,
const char *attr, bool *val);
/** @brief Read the content of the given device-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A pointer to a long long variable where the value should be stored
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_attr_read_longlong(const struct iio_device *dev,
const char *attr, long long *val);
/** @brief Read the content of the given device-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A pointer to a double variable where the value should be stored
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_attr_read_double(const struct iio_device *dev,
const char *attr, double *val);
/** @brief Set the value of the given device-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param src A NULL-terminated string to set the attribute to
* @return On success, the number of bytes written
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b>By passing NULL as the "attr" argument to iio_device_attr_write,
* it is now possible to write all of the attributes of a device.
*
* The buffer must contain one block of data per attribute of the device,
* by the order they appear in the iio_device structure.
*
* The first four bytes of one block correspond to a 32-bit signed value in
* network order. If negative, the attribute is not written; if positive,
* it corresponds to the length of the data to write. In that case, the rest
* of the block must contain the data. */
__api __check_ret ssize_t iio_device_attr_write(const struct iio_device *dev,
const char *attr, const char *src);
/** @brief Set the value of the given device-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param src A pointer to the data to be written
* @param len The number of bytes that should be written
* @return On success, the number of bytes written
* @return On error, a negative errno code is returned */
__api __check_ret ssize_t iio_device_attr_write_raw(const struct iio_device *dev,
const char *attr, const void *src, size_t len);
/** @brief Set the values of all device-specific attributes
* @param dev A pointer to an iio_device structure
* @param cb A pointer to a callback function
* @param data A pointer that will be passed to the callback function
* @return On success, 0 is returned
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b> This function is especially useful when used with the network
* backend, as all the device-specific attributes are written in one single
* command. */
__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);
/** @brief Set the value of the given device-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A bool value to set the attribute to
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_attr_write_bool(const struct iio_device *dev,
const char *attr, bool val);
/** @brief Set the value of the given device-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A long long value to set the attribute to
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_attr_write_longlong(const struct iio_device *dev,
const char *attr, long long val);
/** @brief Set the value of the given device-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A double value to set the attribute to
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_attr_write_double(const struct iio_device *dev,
const char *attr, double val);
/** @brief Read the content of the given buffer-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param dst A pointer to the memory area where the NULL-terminated string
* corresponding to the value read will be stored
* @param len The available length of the memory area, in bytes
* @return On success, the number of bytes written to the buffer
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b>By passing NULL as the "attr" argument to
* iio_device_buffer_attr_read, it is now possible to read all of the attributes
* of a device.
*
* The buffer is filled with one block of data per attribute of the buffer,
* by the order they appear in the iio_device structure.
*
* The first four bytes of one block correspond to a 32-bit signed value in
* network order. If negative, it corresponds to the errno code that were
* returned when reading the attribute; if positive, it corresponds to the
* length of the data read. In that case, the rest of the block contains
* the data. */
__api __check_ret ssize_t iio_device_buffer_attr_read(const struct iio_device *dev,
const char *attr, char *dst, size_t len);
/** @brief Read the content of all buffer-specific attributes
* @param dev A pointer to an iio_device structure
* @param cb A pointer to a callback function
* @param data A pointer that will be passed to the callback function
* @return On success, 0 is returned
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b> This function is especially useful when used with the network
* backend, as all the buffer-specific attributes are read in one single
* command. */
__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);
/** @brief Read the content of the given buffer-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A pointer to a bool variable where the value should be stored
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_buffer_attr_read_bool(const struct iio_device *dev,
const char *attr, bool *val);
/** @brief Read the content of the given buffer-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A pointer to a long long variable where the value should be stored
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_buffer_attr_read_longlong(const struct iio_device *dev,
const char *attr, long long *val);
/** @brief Read the content of the given buffer-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A pointer to a double variable where the value should be stored
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_buffer_attr_read_double(const struct iio_device *dev,
const char *attr, double *val);
/** @brief Set the value of the given buffer-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param src A NULL-terminated string to set the attribute to
* @return On success, the number of bytes written
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b>By passing NULL as the "attr" argument to
* iio_device_buffer_attr_write, it is now possible to write all of the
* attributes of a device.
*
* The buffer must contain one block of data per attribute of the buffer,
* by the order they appear in the iio_device structure.
*
* The first four bytes of one block correspond to a 32-bit signed value in
* network order. If negative, the attribute is not written; if positive,
* it corresponds to the length of the data to write. In that case, the rest
* of the block must contain the data. */
__api __check_ret ssize_t iio_device_buffer_attr_write(const struct iio_device *dev,
const char *attr, const char *src);
/** @brief Set the value of the given buffer-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param src A pointer to the data to be written
* @param len The number of bytes that should be written
* @return On success, the number of bytes written
* @return On error, a negative errno code is returned */
__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);
/** @brief Set the values of all buffer-specific attributes
* @param dev A pointer to an iio_device structure
* @param cb A pointer to a callback function
* @param data A pointer that will be passed to the callback function
* @return On success, 0 is returned
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b> This function is especially useful when used with the network
* backend, as all the buffer-specific attributes are written in one single
* command. */
__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);
/** @brief Set the value of the given buffer-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A bool value to set the attribute to
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_buffer_attr_write_bool(const struct iio_device *dev,
const char *attr, bool val);
/** @brief Set the value of the given buffer-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A long long value to set the attribute to
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_buffer_attr_write_longlong(const struct iio_device *dev,
const char *attr, long long val);
/** @brief Set the value of the given buffer-specific attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A double value to set the attribute to
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_buffer_attr_write_double(const struct iio_device *dev,
const char *attr, double val);
/** @brief Associate a pointer to an iio_device structure
* @param dev A pointer to an iio_device structure
* @param data The pointer to be associated */
__api void iio_device_set_data(struct iio_device *dev, void *data);
/** @brief Retrieve a previously associated pointer of an iio_device structure
* @param dev A pointer to an iio_device structure
* @return The pointer previously associated if present, or NULL */
__api void * iio_device_get_data(const struct iio_device *dev);
/** @brief Retrieve the trigger of a given device
* @param dev A pointer to an iio_device structure
* @param trigger a pointer to a pointer of an iio_device structure. The pointed
* pointer will be set to the address of the iio_device structure corresponding
* to the associated trigger device.
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_get_trigger(const struct iio_device *dev,
const struct iio_device **trigger);
/** @brief Associate a trigger to a given device
* @param dev A pointer to an iio_device structure
* @param trigger a pointer to the iio_device structure corresponding to the
* trigger that should be associated.
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_set_trigger(const struct iio_device *dev,
const struct iio_device *trigger);
/** @brief Return True if the given device is a trigger
* @param dev A pointer to an iio_device structure
* @return True if the device is a trigger, False otherwise */
__api __check_ret __pure bool iio_device_is_trigger(const struct iio_device *dev);
/** @brief Configure the number of kernel buffers for a device
*
* This function allows to change the number of buffers on kernel side.
* @param dev A pointer to an iio_device structure
* @param nb_buffers The number of buffers
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_set_kernel_buffers_count(const struct iio_device *dev,
unsigned int nb_buffers);
/** @} *//* ------------------------------------------------------------------*/
/* ------------------------- Channel functions -------------------------------*/
/** @defgroup Channel Channel
* @{
* @struct iio_channel
* @brief Represents an input or output channel of a device */
/** @brief Retrieve a pointer to the iio_device structure
* @param chn A pointer to an iio_channel structure
* @return A pointer to an iio_device structure */
__api __check_ret __pure const struct iio_device * iio_channel_get_device(
const struct iio_channel *chn);
/** @brief Retrieve the channel ID (e.g. <b><i>voltage0</i></b>)
* @param chn A pointer to an iio_channel structure
* @return A pointer to a static NULL-terminated string */
__api __check_ret __pure const char * iio_channel_get_id(const struct iio_channel *chn);
/** @brief Retrieve the channel name (e.g. <b><i>vccint</i></b>)
* @param chn A pointer to an iio_channel structure
* @return A pointer to a static NULL-terminated string
*
* <b>NOTE:</b> if the channel has no name, NULL is returned. */
__api __check_ret __pure const char * iio_channel_get_name(const struct iio_channel *chn);
/** @brief Return True if the given channel is an output channel
* @param chn A pointer to an iio_channel structure
* @return True if the channel is an output channel, False otherwise */
__api __check_ret __pure bool iio_channel_is_output(const struct iio_channel *chn);
/** @brief Return True if the given channel is a scan element
* @param chn A pointer to an iio_channel structure
* @return True if the channel is a scan element, False otherwise
*
* <b>NOTE:</b> a channel that is a scan element is a channel that can
* generate samples (for an input channel) or receive samples (for an output
* channel) after being enabled. */
__api __check_ret __pure bool iio_channel_is_scan_element(const struct iio_channel *chn);
/** @brief Enumerate the channel-specific attributes of the given channel
* @param chn A pointer to an iio_channel structure
* @return The number of channel-specific attributes found */
__api __check_ret __pure unsigned int iio_channel_get_attrs_count(
const struct iio_channel *chn);
/** @brief Get the channel-specific attribute present at the given index
* @param chn A pointer to an iio_channel structure
* @param index The index corresponding to the attribute
* @return On success, a pointer to a static NULL-terminated string
* @return If the index is invalid, NULL is returned */
__api __check_ret __pure const char * iio_channel_get_attr(
const struct iio_channel *chn, unsigned int index);
/** @brief Try to find a channel-specific attribute by its name
* @param chn A pointer to an iio_channel structure
* @param name A NULL-terminated string corresponding to the name of the
* attribute
* @return On success, a pointer to a static NULL-terminated string
* @return If the name does not correspond to any known attribute of the given
* channel, NULL is returned
*
* <b>NOTE:</b> This function is useful to detect the presence of an attribute.
* It can also be used to retrieve the name of an attribute as a pointer to a
* static string from a dynamically allocated string. */
__api __check_ret __pure const char * iio_channel_find_attr(
const struct iio_channel *chn, const char *name);
/** @brief Retrieve the filename of an attribute
* @param chn A pointer to an iio_channel structure
* @param attr a NULL-terminated string corresponding to the name of the
* attribute
* @return On success, a pointer to a static NULL-terminated string
* @return If the attribute name is unknown, NULL is returned */
__api __check_ret __pure const char * iio_channel_attr_get_filename(
const struct iio_channel *chn, const char *attr);
/** @brief Read the content of the given channel-specific attribute
* @param chn A pointer to an iio_channel structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param dst A pointer to the memory area where the NULL-terminated string
* corresponding to the value read will be stored
* @param len The available length of the memory area, in bytes
* @return On success, the number of bytes written to the buffer
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b>By passing NULL as the "attr" argument to iio_channel_attr_read,
* it is now possible to read all of the attributes of a channel.
*
* The buffer is filled with one block of data per attribute of the channel,
* by the order they appear in the iio_channel structure.
*
* The first four bytes of one block correspond to a 32-bit signed value in
* network order. If negative, it corresponds to the errno code that were
* returned when reading the attribute; if positive, it corresponds to the
* length of the data read. In that case, the rest of the block contains
* the data. */
__api __check_ret ssize_t iio_channel_attr_read(const struct iio_channel *chn,
const char *attr, char *dst, size_t len);
/** @brief Read the content of all channel-specific attributes
* @param chn A pointer to an iio_channel structure
* @param cb A pointer to a callback function
* @param data A pointer that will be passed to the callback function
* @return On success, 0 is returned
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b> This function is especially useful when used with the network
* backend, as all the channel-specific attributes are read in one single
* command. */
__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);
/** @brief Read the content of the given channel-specific attribute
* @param chn A pointer to an iio_channel structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A pointer to a bool variable where the value should be stored
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_channel_attr_read_bool(const struct iio_channel *chn,
const char *attr, bool *val);
/** @brief Read the content of the given channel-specific attribute
* @param chn A pointer to an iio_channel structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A pointer to a long long variable where the value should be stored
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_channel_attr_read_longlong(const struct iio_channel *chn,
const char *attr, long long *val);
/** @brief Read the content of the given channel-specific attribute
* @param chn A pointer to an iio_channel structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A pointer to a double variable where the value should be stored
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_channel_attr_read_double(const struct iio_channel *chn,
const char *attr, double *val);
/** @brief Set the value of the given channel-specific attribute
* @param chn A pointer to an iio_channel structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param src A NULL-terminated string to set the attribute to
* @return On success, the number of bytes written
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b>By passing NULL as the "attr" argument to iio_channel_attr_write,
* it is now possible to write all of the attributes of a channel.
*
* The buffer must contain one block of data per attribute of the channel,
* by the order they appear in the iio_channel structure.
*
* The first four bytes of one block correspond to a 32-bit signed value in
* network order. If negative, the attribute is not written; if positive,
* it corresponds to the length of the data to write. In that case, the rest
* of the block must contain the data. */
__api __check_ret ssize_t iio_channel_attr_write(const struct iio_channel *chn,
const char *attr, const char *src);
/** @brief Set the value of the given channel-specific attribute
* @param chn A pointer to an iio_channel structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param src A pointer to the data to be written
* @param len The number of bytes that should be written
* @return On success, the number of bytes written
* @return On error, a negative errno code is returned */
__api __check_ret ssize_t iio_channel_attr_write_raw(const struct iio_channel *chn,
const char *attr, const void *src, size_t len);
/** @brief Set the values of all channel-specific attributes
* @param chn A pointer to an iio_channel structure
* @param cb A pointer to a callback function
* @param data A pointer that will be passed to the callback function
* @return On success, 0 is returned
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b> This function is especially useful when used with the network
* backend, as all the channel-specific attributes are written in one single
* command. */
__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);
/** @brief Set the value of the given channel-specific attribute
* @param chn A pointer to an iio_channel structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A bool value to set the attribute to
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_channel_attr_write_bool(const struct iio_channel *chn,
const char *attr, bool val);
/** @brief Set the value of the given channel-specific attribute
* @param chn A pointer to an iio_channel structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A long long value to set the attribute to
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_channel_attr_write_longlong(const struct iio_channel *chn,
const char *attr, long long val);
/** @brief Set the value of the given channel-specific attribute
* @param chn A pointer to an iio_channel structure
* @param attr A NULL-terminated string corresponding to the name of the
* attribute
* @param val A double value to set the attribute to
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_channel_attr_write_double(const struct iio_channel *chn,
const char *attr, double val);
/** @brief Enable the given channel
* @param chn A pointer to an iio_channel structure
*
* <b>NOTE:</b>Before creating an iio_buffer structure with
* iio_device_create_buffer, it is required to enable at least one channel of
* the device to read from. */
__api void iio_channel_enable(struct iio_channel *chn);
/** @brief Disable the given channel
* @param chn A pointer to an iio_channel structure */
__api void iio_channel_disable(struct iio_channel *chn);
/** @brief Returns True if the channel is enabled
* @param chn A pointer to an iio_channel structure
* @return True if the channel is enabled, False otherwise */
__api __check_ret bool iio_channel_is_enabled(const struct iio_channel *chn);
/** @brief Demultiplex the samples of a given channel
* @param chn A pointer to an iio_channel structure
* @param buffer A pointer to an iio_buffer structure
* @param dst A pointer to the memory area where the demultiplexed data will be
* stored
* @param len The available length of the memory area, in bytes
* @return The size of the demultiplexed data, in bytes */
__api __check_ret size_t iio_channel_read_raw(const struct iio_channel *chn,
struct iio_buffer *buffer, void *dst, size_t len);
/** @brief Demultiplex and convert the samples of a given channel
* @param chn A pointer to an iio_channel structure
* @param buffer A pointer to an iio_buffer structure
* @param dst A pointer to the memory area where the converted data will be
* stored
* @param len The available length of the memory area, in bytes
* @return The size of the converted data, in bytes */
__api __check_ret size_t iio_channel_read(const struct iio_channel *chn,
struct iio_buffer *buffer, void *dst, size_t len);
/** @brief Multiplex the samples of a given channel
* @param chn A pointer to an iio_channel structure
* @param buffer A pointer to an iio_buffer structure
* @param src A pointer to the memory area where the sequential data will
* be read from
* @param len The length of the memory area, in bytes
* @return The number of bytes actually multiplexed */
__api __check_ret size_t iio_channel_write_raw(const struct iio_channel *chn,
struct iio_buffer *buffer, const void *src, size_t len);
/** @brief Convert and multiplex the samples of a given channel
* @param chn A pointer to an iio_channel structure
* @param buffer A pointer to an iio_buffer structure
* @param src A pointer to the memory area where the sequential data will
* be read from
* @param len The length of the memory area, in bytes
* @return The number of bytes actually converted and multiplexed */
__api __check_ret size_t iio_channel_write(const struct iio_channel *chn,
struct iio_buffer *buffer, const void *src, size_t len);
/** @brief Associate a pointer to an iio_channel structure
* @param chn A pointer to an iio_channel structure
* @param data The pointer to be associated */
__api void iio_channel_set_data(struct iio_channel *chn, void *data);
/** @brief Retrieve a previously associated pointer of an iio_channel structure
* @param chn A pointer to an iio_channel structure
* @return The pointer previously associated if present, or NULL */
__api void * iio_channel_get_data(const struct iio_channel *chn);
/** @brief Get the type of the given channel
* @param chn A pointer to an iio_channel structure
* @return The type of the channel */
__api __check_ret __pure enum iio_chan_type iio_channel_get_type(
const struct iio_channel *chn);
/** @brief Get the modifier type of the given channel
* @param chn A pointer to an iio_channel structure
* @return The modifier type of the channel */
__api __check_ret __pure enum iio_modifier iio_channel_get_modifier(
const struct iio_channel *chn);
/** @} *//* ------------------------------------------------------------------*/
/* ------------------------- Buffer functions --------------------------------*/
/** @defgroup Buffer Buffer
* @{
* @struct iio_buffer
* @brief An input or output buffer, used to read or write samples */
/** @brief Retrieve a pointer to the iio_device structure
* @param buf A pointer to an iio_buffer structure
* @return A pointer to an iio_device structure */
__api __check_ret __pure const struct iio_device * iio_buffer_get_device(
const struct iio_buffer *buf);
/** @brief Create an input or output buffer associated to the given device
* @param dev A pointer to an iio_device structure
* @param samples_count The number of samples that the buffer should contain
* @param cyclic If True, enable cyclic mode
* @return On success, a pointer to an iio_buffer structure
* @return On error, NULL is returned, and errno is set to the error code
*
* <b>NOTE:</b> Channels that have to be written to / read from must be enabled
* before creating the buffer. */
__api __check_ret struct iio_buffer * iio_device_create_buffer(const struct iio_device *dev,
size_t samples_count, bool cyclic);
/** @brief Destroy the given buffer
* @param buf A pointer to an iio_buffer structure
*
* <b>NOTE:</b> After that function, the iio_buffer pointer shall be invalid. */
__api void iio_buffer_destroy(struct iio_buffer *buf);
/** @brief Get a pollable file descriptor
*
* Can be used to know when iio_buffer_refill() or iio_buffer_push() can be
* called
* @param buf A pointer to an iio_buffer structure
* @return On success, valid file descriptor
* @return On error, a negative errno code is returned
*/
__api __check_ret int iio_buffer_get_poll_fd(struct iio_buffer *buf);
/** @brief Make iio_buffer_refill() and iio_buffer_push() blocking or not
*
* After this function has been called with blocking == false,
* iio_buffer_refill() and iio_buffer_push() will return -EAGAIN if no data is
* ready.
* A device is blocking by default.
* @param buf A pointer to an iio_buffer structure
* @param blocking true if the buffer API should be blocking, else false
* @return On success, 0
* @return On error, a negative errno code is returned
*/
__api __check_ret int iio_buffer_set_blocking_mode(struct iio_buffer *buf, bool blocking);
/** @brief Fetch more samples from the hardware
* @param buf A pointer to an iio_buffer structure
* @return On success, the number of bytes read is returned
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b> Only valid for input buffers */
__api __check_ret ssize_t iio_buffer_refill(struct iio_buffer *buf);
/** @brief Send the samples to the hardware
* @param buf A pointer to an iio_buffer structure
* @return On success, the number of bytes written is returned
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b> Only valid for output buffers */
__api __check_ret ssize_t iio_buffer_push(struct iio_buffer *buf);
/** @brief Send a given number of samples to the hardware
* @param buf A pointer to an iio_buffer structure
* @param samples_count The number of samples to submit
* @return On success, the number of bytes written is returned
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b> Only valid for output buffers */
__api __check_ret ssize_t iio_buffer_push_partial(struct iio_buffer *buf,
size_t samples_count);
/** @brief Cancel all buffer operations
* @param buf The buffer for which operations should be canceled
*
* This function cancels all outstanding buffer operations previously scheduled.
* This means any pending iio_buffer_push() or iio_buffer_refill() operation
* will abort and return immediately, any further invocations of these functions
* on the same buffer will return immediately with an error.
*
* Usually iio_buffer_push() and iio_buffer_refill() will block until either all
* data has been transferred or a timeout occurs. This can depending on the
* configuration take a significant amount of time. iio_buffer_cancel() is
* useful to bypass these conditions if the buffer operation is supposed to be
* stopped in response to an external event (e.g. user input).
*
* To be able to capture additional data after calling this function the buffer
* should be destroyed and then re-created.
*
* This function can be called multiple times for the same buffer, but all but
* the first invocation will be without additional effect.
*
* This function is thread-safe, but not signal-safe, i.e. it must not be called
* from a signal handler.
*/
__api void iio_buffer_cancel(struct iio_buffer *buf);
/** @brief Get the start address of the buffer
* @param buf A pointer to an iio_buffer structure
* @return A pointer corresponding to the start address of the buffer */
__api void * iio_buffer_start(const struct iio_buffer *buf);
/** @brief Find the first sample of a channel in a buffer
* @param buf A pointer to an iio_buffer structure
* @param chn A pointer to an iio_channel structure
* @return A pointer to the first sample found, or to the end of the buffer if
* no sample for the given channel is present in the buffer
*
* <b>NOTE:</b> This function, coupled with iio_buffer_step and iio_buffer_end,
* can be used to iterate on all the samples of a given channel present in the
* buffer, doing the following:
*
* @verbatim
for (void *ptr = iio_buffer_first(buffer, chn); ptr < iio_buffer_end(buffer); ptr += iio_buffer_step(buffer)) {
....
}
@endverbatim */
__api void * iio_buffer_first(const struct iio_buffer *buf,
const struct iio_channel *chn);
/** @brief Get the step size between two samples of one channel
* @param buf A pointer to an iio_buffer structure
* @return the difference between the addresses of two consecutive samples of
* one same channel */
__api __check_ret ptrdiff_t iio_buffer_step(const struct iio_buffer *buf);
/** @brief Get the address that follows the last sample in a buffer
* @param buf A pointer to an iio_buffer structure
* @return A pointer corresponding to the address that follows the last sample
* present in the buffer */
__api void * iio_buffer_end(const struct iio_buffer *buf);
/** @brief Call the supplied callback for each sample found in a buffer
* @param buf A pointer to an iio_buffer structure
* @param callback A pointer to a function to call for each sample found
* @param data A user-specified pointer that will be passed to the callback
* @return number of bytes processed.
*
* <b>NOTE:</b> The callback receives four arguments:
* * A pointer to the iio_channel structure corresponding to the sample,
* * A pointer to the sample itself,
* * The length of the sample in bytes,
* * The user-specified pointer passed to iio_buffer_foreach_sample. */
__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);
/** @brief Associate a pointer to an iio_buffer structure
* @param buf A pointer to an iio_buffer structure
* @param data The pointer to be associated */
__api void iio_buffer_set_data(struct iio_buffer *buf, void *data);
/** @brief Retrieve a previously associated pointer of an iio_buffer structure
* @param buf A pointer to an iio_buffer structure
* @return The pointer previously associated if present, or NULL */
__api void * iio_buffer_get_data(const struct iio_buffer *buf);
/** @} *//* ------------------------------------------------------------------*/
/* ---------------------------- HWMON support --------------------------------*/
/** @defgroup Hwmon Compatibility with hardware monitoring (hwmon) devices
* @{
* @enum hwmon_chan_type
* @brief Hwmon channel type
*
* Libiio support hardware-monitoring (hwmon) devices as well. This enum
* specifies the type of data associated with the hwmon channel.
*
* NOTE: as of 2021 only the current hwmon API is supported. The old
* and deprecated APIs are not supported, and won't be supported unless we
* have a case where updating a hwmon driver is not possible.
*/
enum hwmon_chan_type {
HWMON_VOLTAGE,
HWMON_FAN,
HWMON_PWM,
HWMON_TEMP,
HWMON_CURRENT,
HWMON_POWER,
HWMON_ENERGY,
HWMON_HUMIDITY,
HWMON_INTRUSION,
HWMON_CHAN_TYPE_UNKNOWN = IIO_CHAN_TYPE_UNKNOWN,
};
/**
* @brief Get the type of the given hwmon channel
* @param chn A pointer to an iio_channel structure
* @return The type of the hwmon channel */
static inline enum hwmon_chan_type
hwmon_channel_get_type(const struct iio_channel *chn)
{
return (enum hwmon_chan_type) iio_channel_get_type(chn);
}
/**
* @brief Get whether or not the device is a hardware monitoring device
* @param dev A pointer to an iio_device structure
* @return True if the device is a hardware monitoring device,
* false if it is a IIO device */
static inline bool iio_device_is_hwmon(const struct iio_device *dev)
{
const char *id = iio_device_get_id(dev);
return id[0] == 'h';
}
/** @} *//* ------------------------------------------------------------------*/
/* ------------------------- Low-level functions -----------------------------*/
/** @defgroup Debug Debug and low-level functions
* @{
* @struct iio_data_format
* @brief Contains the format of a data sample.
*
* The different fields inform about the correct way to convert one sample from
* its raw format (as read from / generated by the hardware) to its real-world
* value.
*/
struct iio_data_format {
/** @brief Total length of the sample, in bits */
unsigned int length;
/** @brief Length of valuable data in the sample, in bits */
unsigned int bits;
/** @brief Right-shift to apply when converting sample */
unsigned int shift;
/** @brief Contains True if the sample is signed */
bool is_signed;
/** @brief Contains True if the sample is fully defined, sign extended, etc. */
bool is_fully_defined;
/** @brief Contains True if the sample is in big-endian format */
bool is_be;
/** @brief Contains True if the sample should be scaled when converted */
bool with_scale;
/** @brief Contains the scale to apply if with_scale is set */
double scale;
/** @brief Number of times length repeats (added in v0.8) */
unsigned int repeat;
};
/** @brief Get the current sample size
* @param dev A pointer to an iio_device structure
* @return On success, the sample size in bytes
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b> The sample size is not constant and will change when channels
* get enabled or disabled. */
__api __check_ret ssize_t iio_device_get_sample_size(const struct iio_device *dev);
/** @brief Get the index of the given channel
* @param chn A pointer to an iio_channel structure
* @return On success, the index of the specified channel
* @return On error, a negative errno code is returned */
__api __check_ret __pure long iio_channel_get_index(const struct iio_channel *chn);
/** @brief Get a pointer to a channel's data format structure
* @param chn A pointer to an iio_channel structure
* @return A pointer to the channel's iio_data_format structure */
__api __check_ret __cnst const struct iio_data_format * iio_channel_get_data_format(
const struct iio_channel *chn);
/** @brief Convert the sample from hardware format to host format
* @param chn A pointer to an iio_channel structure
* @param dst A pointer to the destination buffer where the converted sample
* should be written
* @param src A pointer to the source buffer containing the sample */
__api void iio_channel_convert(const struct iio_channel *chn,
void *dst, const void *src);
/** @brief Convert the sample from host format to hardware format
* @param chn A pointer to an iio_channel structure
* @param dst A pointer to the destination buffer where the converted sample
* should be written
* @param src A pointer to the source buffer containing the sample */
__api void iio_channel_convert_inverse(const struct iio_channel *chn,
void *dst, const void *src);
/** @brief Enumerate the debug attributes of the given device
* @param dev A pointer to an iio_device structure
* @return The number of debug attributes found */
__api __check_ret __pure unsigned int iio_device_get_debug_attrs_count(
const struct iio_device *dev);
/** @brief Get the debug attribute present at the given index
* @param dev A pointer to an iio_device structure
* @param index The index corresponding to the debug attribute
* @return On success, a pointer to a static NULL-terminated string
* @return If the index is invalid, NULL is returned */
__api __check_ret __pure const char * iio_device_get_debug_attr(
const struct iio_device *dev, unsigned int index);
/** @brief Try to find a debug attribute by its name
* @param dev A pointer to an iio_device structure
* @param name A NULL-terminated string corresponding to the name of the
* debug attribute
* @return On success, a pointer to a static NULL-terminated string
* @return If the name does not correspond to any known debug attribute of the
* given device, NULL is returned
*
* <b>NOTE:</b> This function is useful to detect the presence of a debug
* attribute.
* It can also be used to retrieve the name of a debug attribute as a pointer
* to a static string from a dynamically allocated string. */
__api __check_ret __pure const char * iio_device_find_debug_attr(
const struct iio_device *dev, const char *name);
/** @brief Read the content of the given debug attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* debug attribute
* @param dst A pointer to the memory area where the NULL-terminated string
* corresponding to the value read will be stored
* @param len The available length of the memory area, in bytes
* @return On success, the number of bytes written to the buffer
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b>By passing NULL as the "attr" argument to
* iio_device_debug_attr_read, it is now possible to read all of the debug
* attributes of a device.
*
* The buffer is filled with one block of data per debug attribute of the
* device, by the order they appear in the iio_device structure.
*
* The first four bytes of one block correspond to a 32-bit signed value in
* network order. If negative, it corresponds to the errno code that were
* returned when reading the debug attribute; if positive, it corresponds
* to the length of the data read. In that case, the rest of the block contains
* the data. */
__api __check_ret ssize_t iio_device_debug_attr_read(const struct iio_device *dev,
const char *attr, char *dst, size_t len);
/** @brief Read the content of all debug attributes
* @param dev A pointer to an iio_device structure
* @param cb A pointer to a callback function
* @param data A pointer that will be passed to the callback function
* @return On success, 0 is returned
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b> This function is especially useful when used with the network
* backend, as all the debug attributes are read in one single command. */
__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);
/** @brief Set the value of the given debug attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* debug attribute
* @param src A NULL-terminated string to set the debug attribute to
* @return On success, the number of bytes written
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b>By passing NULL as the "attr" argument to
* iio_device_debug_attr_write, it is now possible to write all of the
* debug attributes of a device.
*
* The buffer must contain one block of data per debug attribute of the device,
* by the order they appear in the iio_device structure.
*
* The first four bytes of one block correspond to a 32-bit signed value in
* network order. If negative, the debug attribute is not written; if positive,
* it corresponds to the length of the data to write. In that case, the rest
* of the block must contain the data. */
__api __check_ret ssize_t iio_device_debug_attr_write(const struct iio_device *dev,
const char *attr, const char *src);
/** @brief Set the value of the given debug attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* debug attribute
* @param src A pointer to the data to be written
* @param len The number of bytes that should be written
* @return On success, the number of bytes written
* @return On error, a negative errno code is returned */
__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);
/** @brief Set the values of all debug attributes
* @param dev A pointer to an iio_device structure
* @param cb A pointer to a callback function
* @param data A pointer that will be passed to the callback function
* @return On success, 0 is returned
* @return On error, a negative errno code is returned
*
* <b>NOTE:</b> This function is especially useful when used with the network
* backend, as all the debug attributes are written in one single command. */
__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);
/** @brief Read the content of the given debug attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* debug attribute
* @param val A pointer to a bool variable where the value should be stored
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_debug_attr_read_bool(const struct iio_device *dev,
const char *attr, bool *val);
/** @brief Read the content of the given debug attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* debug attribute
* @param val A pointer to a long long variable where the value should be stored
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_debug_attr_read_longlong(const struct iio_device *dev,
const char *attr, long long *val);
/** @brief Read the content of the given debug attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* debug attribute
* @param val A pointer to a double variable where the value should be stored
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_debug_attr_read_double(const struct iio_device *dev,
const char *attr, double *val);
/** @brief Set the value of the given debug attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* debug attribute
* @param val A bool value to set the debug attribute to
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_debug_attr_write_bool(const struct iio_device *dev,
const char *attr, bool val);
/** @brief Set the value of the given debug attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* debug attribute
* @param val A long long value to set the debug attribute to
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_debug_attr_write_longlong(const struct iio_device *dev,
const char *attr, long long val);
/** @brief Set the value of the given debug attribute
* @param dev A pointer to an iio_device structure
* @param attr A NULL-terminated string corresponding to the name of the
* debug attribute
* @param val A double value to set the debug attribute to
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_debug_attr_write_double(const struct iio_device *dev,
const char *attr, double val);
/** @brief Identify the channel or debug attribute corresponding to a filename
* @param dev A pointer to an iio_device structure
* @param filename A NULL-terminated string corresponding to the filename
* @param chn A pointer to a pointer of an iio_channel structure. The pointed
* pointer will be set to the address of the iio_channel structure if the
* filename correspond to the attribute of a channel, or NULL otherwise.
* @param attr A pointer to a NULL-terminated string. The pointer
* pointer will be set to point to the name of the attribute corresponding to
* the filename.
* @return On success, 0 is returned, and *chn and *attr are modified.
* @return On error, a negative errno code is returned. *chn and *attr are not
* modified. */
__api __check_ret int iio_device_identify_filename(const struct iio_device *dev,
const char *filename, struct iio_channel **chn,
const char **attr);
/** @brief Set the value of a hardware register
* @param dev A pointer to an iio_device structure
* @param address The address of the register
* @param value The value to set the register to
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_reg_write(struct iio_device *dev,
uint32_t address, uint32_t value);
/** @brief Get the value of a hardware register
* @param dev A pointer to an iio_device structure
* @param address The address of the register
* @param value A pointer to the variable where the value will be written
* @return On success, 0 is returned
* @return On error, a negative errno code is returned */
__api __check_ret int iio_device_reg_read(struct iio_device *dev,
uint32_t address, uint32_t *value);
/** @} */
#ifdef __cplusplus
}
#endif
#undef __api
#endif /* __IIO_H__ */
|