/usr/include/lime/LimeSuite.h is in liblimesuite-dev 16.12.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /**
* @file lime/LimeSuite.h
*
* @brief LMS API library
*
* Copyright (C) 2016 Lime Microsystems
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef LMS7_API_H
#define LMS7_API_H
#include <stdint.h>
#include <stdlib.h>
#include "LMS7002M_parameters.h"
#ifdef __cplusplus
extern "C" {
#else
/* stdbool.h is not applicable for C++ programs, as the language inherently
* provides the bool type.
*
* Users of Visual Studio 2012 and earlier will need to supply a stdbool.h
* implementation, as it is not included with the toolchain. Visual Studio 2013
* onward supplies this header.
*/
#include <stdbool.h>
#endif
#if defined _WIN32 || defined __CYGWIN__
# include <windows.h>
# define CALL_CONV __cdecl
# ifdef __GNUC__
# define API_EXPORT __attribute__ ((dllexport))
# else
# define API_EXPORT __declspec(dllexport)
# endif
#elif defined _DOXYGEN_ONLY_
/** Marks an API routine to be made visible to the dynamic loader.
* This is OS and/or compiler-specific. */
# define API_EXPORT
/** Specifies calling convention, if necessary.
* This is OS and/or compiler-specific. */
# define CALL_CONV
#else
# define API_EXPORT __attribute__ ((visibility ("default")))
# define CALL_CONV
#endif
/**Floating point data type*/
typedef double float_type;
/**convenience constant for good return code*/
static const int LMS_SUCCESS = 0;
/**
* @defgroup FN_INIT Initialization/deinitialization
*
* The functions in this section provide the ability to query available devices,
* initialize them, and deinitialize them.
* @{
*/
/**LMS Device handle */
typedef void lms_device_t;
/**Convenience type for fixed length LMS Device information string*/
typedef char lms_info_str_t[256];
/**
* Obtain a list of LMS devices attached to the system
*
* @param[out] dev_list List of available devices
*
* @return number of devices in the list on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetDeviceList(lms_info_str_t *dev_list);
/**
* Opens device specified by the provided ::lms_dev_info string
*
* This function should be used to open a device based upon the results of
* LMS_GetDeviceList()
*
* @pre device should be initialized to NULL
*
* @param[out] device Updated with device handle on success
* @param[in] info Device information string. If NULL, the first
* available device will be opened.
* @param[in] args additional arguments. Can be NULL.
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_Open(lms_device_t **device, lms_info_str_t info,
void* args);
/**
* Close device
*
* @post device is deallocated and may no longer be used.
*
* @param device Device handle previously obtained by LMS_Open().
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_Close(lms_device_t *device);
/**
* Disconnect device but keep configuration cache (device is not deallocated).
*
* @param device Device handle previously obtained by LMS_Open().
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_Disconnect(lms_device_t *device);
/**
* Checks if device port is opened
*
* @param device Device handle previously obtained by LMS_Open().
* @param port 0 - control port, 1- data port
*
* @return true(1) if port is open, false (0) if - closed
*/
API_EXPORT bool CALL_CONV LMS_IsOpen(lms_device_t *device, int port);
/** @} (End FN_INIT) */
/**
* @defgroup FN_HIGH_LVL High-level control functions
*
* The functions in this section provide the ability to easily configure the
* device for operation.
*
* @{
*/
/**Convenience constants for TX/RX selection*/
const bool LMS_CH_TX = true;
const bool LMS_CH_RX = false;
/**Structure used to represent the allowed value range of various parameters*/
typedef struct
{
float_type min; /**<Minimum allowed value*/
float_type max; /**<Minimum allowed value*/
float_type step; /**<Minimum value step*/
}lms_range_t;
/**Enumeration of loopback modes*/
typedef enum {
LMS_LOOPBACK_NONE /**<Return to normal operation (disable loopback)*/
} lms_loopback_t;
/**Enumeration of LMS7 TEST signal types*/
typedef enum
{
LMS_TESTSIG_NONE=0, /**<Disable test signals. Return to normal operation*/
LMS_TESTSIG_NCODIV8, /**<Test signal from NCO half scale*/
LMS_TESTSIG_NCODIV4, /**<Test signal from NCO half scale*/
LMS_TESTSIG_NCODIV8F, /**<Test signal from NCO full scale*/
LMS_TESTSIG_NCODIV4F, /**<Test signal from NCO full scale*/
LMS_TESTSIG_DC /**<DC test signal*/
}lms_testsig_t;
/**
* Configure LMS chip with settings that make it ready for operation.
*
* @note This configuration differs from default LMS chip configuration which is
* described in chip datasheet. In order to load default chip configuration use
* LMS_Reset().
*
* @param[in] device Device handle previously obtained by LMS_Open().
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_Init(lms_device_t *device);
/**
* Obtain number of RX or TX channels. Use this to determine the maximum
* channel index (specifying channel index is required by most API functions).
* The maximum channel index is N-1, where N is number returned by this function
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
*
* @return Number of channels on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetNumChannels(lms_device_t *device, bool dir_tx);
/**
* Enable or disable specified RX channel.
*
* @param[in] device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param enabled true(1) to enable, false(0) to disable.
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_EnableChannel(lms_device_t *device, bool dir_tx,
size_t chan, bool enabled);
/**
* Set sampling rate for all RX/TX channels. Sample rate is in complex samples
* (1 sample = I + Q). The function sets sampling rate that is used for data
* exchange with the host. It also allows to specify higher sampling rate to be
* used in RF by setting oversampling ratio. Valid oversampling values are 1, 2,
* 4, 8, 16, 32 or 0 (use device default oversampling value).
*
* @param[in] device Device handle previously obtained by LMS_Open().
* @param rate sampling rate in Hz to set
* @param oversample RF oversampling ratio.
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetSampleRate(lms_device_t *device, float_type rate,
size_t oversample);
/**
* Get the sampling rate of the specified LMS device RX or TX channel.
* The function obtains the sample rate used in data interface with the host and
* the RF sample rate used by DAC/ADC.
*
* @param[in] device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param[out] host_Hz sampling rate used for data exchange with the host
* @param[out] rf_Hz RF sampling rate in Hz
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetSampleRate(lms_device_t *device, bool dir_tx,
size_t chan, float_type *host_Hz,
float_type *rf_Hz);
/**
* Get the range of supported sampling rates.
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param range[out] Allowed sample rate range in Hz.
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetSampleRateRange(lms_device_t *device, bool dir_tx,
lms_range_t *range);
/**
* Set RF center frequency in Hz. This automatically selects the appropriate
* antenna (band path) for the desired frequency. In oder to override antenna
* selection use LMS_SetAntenna().
*
* @note setting different frequencies for A and B channels is not supported by
* LMS7 chip. Changing frequency for one (A or B) channel will result in
* frequency being changed for both (A and B) channels.
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param frequency Desired RF center frequency in Hz
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetLOFrequency(lms_device_t *device, bool dir_tx,
size_t chan, float_type frequency);
/**
* Obtain the current RF center frequency in Hz.
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param[out] frequency Current RF center frequency in Hz
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetLOFrequency(lms_device_t *device, bool dir_tx,
size_t chan, float_type *frequency);
/**
* Obtain the supported RF center frequency range in Hz.
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param[out] range Supported RF center frequency in Hz
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetLOFrequencyRange(lms_device_t *device,bool dir_tx,
lms_range_t *range);
/**
* Set the combined gain value
*
* This function computes and sets the optimal gain values of various amplifiers
* that are present in the device based on desired normalized gain value.
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param gain Desired gain, range [0, 1.0], where 1.0 represents the
* maximum gain
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetNormalizedGain(lms_device_t *device, bool dir_tx,
size_t chan,float_type gain);
/**
* Obtain the current combined gain value
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param[out] gain Current gain, range [0, 1.0], where 1.0 represents
* the maximum gain
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetNormalizedGain(lms_device_t *device, bool dir_tx,
size_t chan,float_type *gain);
typedef enum
{
LPF_BW_5_MHz,
LPF_BW_10_MHz,
LPF_BW_15_MHz,
LPF_BW_20_MHz,
LPF_BW_COUNT
} LPF_FixedBW;
/**
* Configure analog LPF and GFIR of the LMS chip for selected fixed bandwidth.
* This function automatically enables LPF.
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param bandwidth Fixed bandwidth selection
*
* @return 0 on success
*/
API_EXPORT int CALL_CONV LMS_SetLPFBWFixed(lms_device_t *device, bool dir_tx,
size_t chan, LPF_FixedBW bandwidth);
/**
* Configure analog LPF of the LMS chip for the desired RF bandwidth.
* This function automatically enables LPF.
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param bandwidth LPF bandwidth in Hz
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetLPFBW(lms_device_t *device, bool dir_tx,
size_t chan, float_type bandwidth);
/**
* Get the currently configured analog LPF RF bandwidth.
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param[out] bandwidth Current LPF bandwidth in Hz
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetLPFBW(lms_device_t *device, bool dir_tx,
size_t chan, float_type *bandwidth);
/**
* Get the RF bandwidth setting range supported by the analog LPF of LMS chip
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param[out] range Supported RF bandwidth range in Hz
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetLPFBWRange(lms_device_t *device,
bool dir_tx, lms_range_t *range);
/**
* Disables or enables the analog LPF of LMS chip without reconfiguring it.
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param enable true(1) to enable, false(0) to disable
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetLPF(lms_device_t *device, bool dir_tx,
size_t chan, bool enabled);
/**
* Set up digital LPF using LMS chip GFIRS. This is a convenience function to
* quickly configure GFIRS as LPF with desired RF bandwidth.
*
* @pre sampling rate must be set
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan channel index
* @param enabled Disable (false) or enable (true) GFIRS.
* @param bandwidth LPF bandwidth in Hz. Has no effect if enabled is false.
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetGFIRLPF(lms_device_t *device, bool dir_tx,
size_t chan, bool enabled, float_type bandwidth);
/**
* Perform the automatic calibration of specified RX/TX channel. The automatic
* calibration must be run after device configuration is finished because
* calibration values are dependant on various configuration settings.
*
* @note automatic RX calibration is not available when RX_LNA_H path is
* selected
*
* @pre Device should be configured
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan channel index
* @param bw bandwidth
* @param flags additional calibration flags (normally should be 0)
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_Calibrate(lms_device_t *device, bool dir_tx,
size_t chan, double bw, unsigned flags);
/**
* Load LMS chip configuration from a file
*
* @param device Device handle
* @param filename path to file
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_LoadConfig(lms_device_t *device, const char *filename);
/**
* Save LMS chip configuration to a file
*
* @param device Device handle
* @param module path to file with LMS chip configuration
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SaveConfig(lms_device_t *device, const char *filename);
/**
* Apply the specified loopback mode
*
* @param device Device handle previously obtained by LMS_Open().
* @param mode Loopback mode. LMS_LOOPBACK_NONE returns to normal
* operation
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetLoopback(lms_device_t *device,
lms_loopback_t mode);
/**
* Get the current loopback mode
*
* @param device Device handle previously obtained by LMS_Open().
* @param[out] mode Current loopback mode
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetLoopback(lms_device_t *device,
lms_loopback_t* mode);
/**
* Apply the specified test signal
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX.
* @param chan Channel index.
* @param sig Test signal. LMS_TESTSIG_NONE disables test signal.
* @param dc_i DC I value for LMS_TESTSIG_DC mode. Ignored in other modes.
* @param dc_q DC Q value for LMS_TESTSIG_DC mode. Ignored in other modes.
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetTestSignal(lms_device_t *device, bool dir_tx,
size_t chan, lms_testsig_t sig, int16_t dc_i, int16_t dc_q);
/**
* Get the currently active test signal
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param sig Currently active test signal
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetTestSignal(lms_device_t *device, bool dir_tx,
size_t chan, lms_testsig_t *sig);
/** @} (End FN_HIGH_LVL) */
/**
* @defgroup FN_ADVANCED Advanced control functions
*
* The functions in this section provides some additional control compared to
* High-Level functions. They are labeled advanced because they require better
* understanding of hardware and provide functionality that may conflict with
* certain High-Level functions.
* @{
*/
/**Enumeration of LMS7 GFIRS*/
typedef enum
{
LMS_GFIR1 = 0,
LMS_GFIR2,
LMS_GFIR3
}lms_gfir_t;
/**Number of NCO frequency/phase offset values*/
const size_t LMS_NCO_VAL_COUNT = 16;
/** Convenience type for fixed length name string*/
typedef char lms_name_t[16];
/**
* Obtain antenna list with names. First item in the list is the name of antenna
* index 0.
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan channel index
* @param[out] list List of antenna names (can be NULL)
*
* @return number of available antennae, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetAntennaList(lms_device_t *device, bool dir_tx,
size_t chan, lms_name_t *list);
/**
* Select the antenna for the specified RX or TX channel.
*
* LMS_SetFrequency() automatically selects antenna based on frequency. This
* function is meant to override path selected by LMS_SetFrequency() and should
* be called after LMS_SetFrequency().
*
* @param device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan channel index
* @param index Index of antenna to select
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetAntenna(lms_device_t *device, bool dir_tx,
size_t chan, size_t index);
/**
* Obtain currently selected antenna of the the specified RX or TX channel.
*
* @param dev Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan channel index
*
* @return Index of selected antenna on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetAntenna(lms_device_t *device, bool dir_tx, size_t chan);
/**
* Obtains bandwidth (lower and upper frequency) of the specified antenna
*
* @param dev Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan channel index
* @param index Antenna index
* @param[out] range Antenna bandwidth
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetAntennaBW(lms_device_t *device, bool dir_tx, size_t chan, size_t index, lms_range_t *range);
/**
* Set sampling rate for all RX or TX channels. Sample rate is in complex
* samples (1 sample = I + Q). The function sets sampling rate that is used for
* data exchange with the host. It also allows to specify higher sampling rate
* to be used in RF by setting oversampling ratio. Valid oversampling values are
* 1, 2, 4, 8, 16, 32 or 0 (use device default oversampling value).
*
* @note RX and TX rates sampling are closely tied in LMS7 chip. Changing RX or
* TX will often result in change of both (RX and TX). RX/TX ratio can only be
* power of 2 and is also limited by other factors. Use LMS_GetSampleRate() to
* obtain actual sample rate values. The function returns success if it is able
* to achieve desired sample rate and oversampling for the specified direction
* (RX or TX) ignoring possible value changes in other direction channels.
*
* @param[in] device Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param rate Sampling rate in Hz to set
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetSampleRateDir(lms_device_t *device, bool dir_tx,
float_type rate, size_t oversample);
/**
* Configure NCO to operate in FCW mode. Configures NCO with up to 16
* frequencies that can be quickly switched between.
* Automatically starts NCO with frequency at index 0
* Use LMS_SetNCOindex() to switch between NCO frequencies.
*
* @param dev Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param[in] freq List of NCO frequencies. Values cannot be negative.
* Must be at least ::LMS_NCO_VAL_COUNT length;
* @param pho NCO phase offset in deg
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetNCOFrequency(lms_device_t *device, bool dir_tx,
size_t chan, const float_type *freq, float_type pho);
/**
* Get the current NCO FCW mode configuration.
*
* @param dev Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param[out] freq List of NCO frequencies. Must be at least
* ::LMS_NCO_VAL_COUNT length;
* @param[out] pho1 Phase offset in deg
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetNCOFrequency(lms_device_t *device, bool dir_tx,
size_t chan, float_type *freq, float_type *pho);
/**
* Configure NCO to operate in PHO mode. Configures NCO with up to 16
* phase offsets that can be quickly switched between.
* Automatically starts NCO with phase at index 0
* Use LMS_SetNCOindex() to switch between NCO phases.
*
* @param dev Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param[in] phases List of NCO phases. Values cannot be negative.
* Must be at least ::LMS_NCO_VAL_COUNT length;
* @param fcw NCO frequency in Hz
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetNCOPhase(lms_device_t *device, bool dir_tx,
size_t chan, const float_type *phases, float_type fcw);
/**
* Get the current NCO PHO mode configuration.
*
* @param dev Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan channel index
* @param[out] phases List of configured NCO phases
* Must be at least ::LMS_NCO_VAL_COUNT length;
* @param[out] fcw Current NCO frequency
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetNCOPhase(lms_device_t *device, bool dir_tx,
size_t chan, float_type *phases, float_type *fcw);
/**
* Switches between configured list of NCO frequencies/phase offsets. Also
* Allows to switch CMIX mode to either downconvert or upconvert.
*
* @param dev Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan channel index
* @param index NCO frequency/phase index to activate
* @param downconv true(1) CMIX downconvert, false(0) CMIX upconvert
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetNCOIndex(lms_device_t *device, bool dir_tx,
size_t chan, size_t index, bool downconv);
/**
* Get the currently active NCO frequency/phase offset index
*
* @param dev Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
*
* @return Current NCO frequency/phase index on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetNCOIndex(lms_device_t *device, bool dir_tx,
size_t chan);
/**
* Read device parameter. Parameter defines specific bits in device register.
*
* @param device Device handle previously obtained by LMS_Open().
* @param param Parameter.
* @param val Current parameter value.
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ReadParam(lms_device_t *device,
struct LMS7Parameter param, uint16_t *val);
/**
* Write device parameter. Parameter defines specific bits in device register.
*
* @param device Device handle previously obtained by LMS_Open().
* @param param Parameter.
* @param val Parameter value to write
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_WriteParam(lms_device_t *device,
struct LMS7Parameter param, uint16_t val);
/**
* Generates LPF coefficients for LMS GFIR.
* Pass and stop band frequencies are relative to sampling rate.
*
* @param n number of coefficients to generate.
* @param w1 Relative pass band frequency. Range [0, 0.5].
* @param w2 Relative Stop band frequency. Range [w1, 0.5].
* @param g_stop Stop_band gain. Range [0, 0.5].
* @param[out] coef generated filter coefficients
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GenerateLPFCoef(size_t n, float_type w1,
float_type w2, float_type g_stop, float_type *coef);
/**
* Configure LMS GFIR using specified filter coefficients. Maximum number of
* coefficients is 40 for GFIR1 and GFIR2, and 120 for GFIR3.
*
* @param dev Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param filt GFIR to configure
* @param[in] coef Array of filter coefficients. Coeff range [-1.0, 1.0].
* @param count number of filter coefficients.
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetGFIRCoeff(lms_device_t * device, bool dir_tx,
size_t chan, lms_gfir_t filt, const float_type* coef,size_t count);
/**
* Get currently set GFIR coefficients.
*
* @param dev Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param filt GFIR to configure
* @param[out] coef Current GFIR coefficients. Array must be big enough to
* hold 40 (GFIR1, GFIR2) or 120 (GFIR3) values.
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetGFIRCoeff(lms_device_t * device, bool dir_tx,
size_t chan, lms_gfir_t filt, float_type* coef);
/**
* Enables or disables specified GFIR.
*
* @param dev Device handle previously obtained by LMS_Open().
* @param dir_tx Select RX or TX
* @param chan Channel index
* @param filt GFIR to configure
* @param enabled true(1) enable, false(0) disable.
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetGFIR(lms_device_t * device, bool dir_tx,
size_t chan, lms_gfir_t filt, bool enabled);
/**
* @defgroup FN_LOW_LVL Low-Level control functions
*
* @{
*/
/**
* Send Reset signal to LMS chip. This initializes LMS chip with default
* configuration as described in LMS chip datasheet.
*
* @param device Device handle previously obtained by LMS_Open().
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_Reset(lms_device_t *device);
/**
* Read device LMS chip register
*
* @param device Device handle previously obtained by LMS_Open().
* @param address Register address
* @param val Current register value
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ReadLMSReg(lms_device_t *device, uint32_t address,
uint16_t *val);
/**
* Write device LMS chip register
*
* @param device Device handle previously obtained by LMS_Open().
* @param address Register address
* @param val Value to write
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_WriteLMSReg(lms_device_t *device, uint32_t address,
uint16_t val);
/**
* Perform register test
*
* @param device Device handle previously obtained by LMS_Open().
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_RegisterTest(lms_device_t *device);
/**
* Read device FPGA register
*
* @param device Device handle previously obtained by LMS_Open().
* @param address Register address
* @param val Current register value
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ReadFPGAReg(lms_device_t *device, uint32_t address,
uint16_t *val);
/**
* Write device FPGA register
*
* @param device Device handle previously obtained by LMS_Open().
* @param address Register address
* @param val Value to write
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_WriteFPGAReg(lms_device_t *device, uint32_t address,
uint16_t val);
/**
* Read custom parameter from board
*
* @param device Device handle previously obtained by LMS_Open().
* @param id Parameter identifier
* @param val Current register value
* @param units [optional] measurement units of parameter if available
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ReadCustomBoardParam(lms_device_t *device,
uint8_t id, float_type *val, lms_name_t units);
/**
* Write custom parameter from board
*
* @param device Device handle previously obtained by LMS_Open().
* @param id Parameter identifier
* @param val Value to write
* @param units [optional] measurement units of parameter if available
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_WriteCustomBoardParam(lms_device_t *device,
uint8_t id, float_type val, const lms_name_t units);
/**
* Changes device reference clock used by API for various calculations.
* Normally reference clock should be detected automatically based on device.
* Use this function in case you have replaced the reference crystal.
*
* @param device Device handle previously obtained by LMS_Open().
* @param clock_Hz reference clock in Hz.
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetReferenceClock(lms_device_t * device,
float_type clock_Hz);
/**
* Get the currently set reference clock
*
* @param device Device handle previously obtained by LMS_Open().
* @param clock_Hz reference clock in Hz.
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetReferenceClock(lms_device_t * device,
float_type * clock_Hz);
/**
* Write value to VCTCXO trim DAC
*
* @param dev Device handle previously obtained by LMS_Open().
* @param val Value to write to VCTCXO trim DAC
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_VCTCXOWrite(lms_device_t * dev, uint16_t val);
/**
* Read value from VCTCXO trim DAC.
*
* @param[in] dev Device handle previously obtained by LMS_Open().
* @param[out] val Value to read from VCTCXO trim DAC
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_VCTCXORead(lms_device_t * dev, uint16_t *val);
/**
* Get VCO value range.
*
* @param dev Device handle previously obtained by LMS_Open().
* @param vco_id VCO identifier
* @param range VCO range
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetVCORange(lms_device_t * dev, size_t vco_id,
lms_range_t* range);
/**
* Set VCO value range.
*
* @param dev Device handle previously obtained by LMS_Open().
* @param vco_id VCO identifier
* @param range VCO range
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetVCORange(lms_device_t * dev, size_t vco_id,
lms_range_t range);
/**
* @brief Sets callback for logging data write/read operations
*
* @param dev Device handle previously obtained by LMS_Open().
* @param func callback function
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetDataLogCallback(lms_device_t *dev, void (*func)(bool tx, const unsigned char* data, const unsigned int length));
/**
* @brief Sets callback for logging info/warning/error messages
*
* @param dev Device handle previously obtained by LMS_Open().
* @param func callback function
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetLogCallback(lms_device_t *dev, void (*func)(const char* cstr, const unsigned int type));
/**
* @defgroup LMS_CLOCK_ID Clock definitions
*
* Clock definitions for accessing specific internal clocks
* @{
*/
#define LMS_CLOCK_REF 0x0000 /**<Chip reference clock*/
#define LMS_CLOCK_SXR 0x0001 /**<RX LO clock*/
#define LMS_CLOCK_SXT 0x0002 /**<TX LO clock*/
#define LMS_CLOCK_CGEN 0x0003 /**<CGEN clock*/
#define LMS_CLOCK_RXTSP 0x0004 /**<RXTSP reference clock*/
#define LMS_CLOCK_TXTSP 0x0005 /**TXTSP reference clock*/
/** @} (End LMS_CLOCK_ID) */
/**
* Get frequency of the specified clock.
*
* @param dev Device handle previously obtained by LMS_Open().
* @param clk_id Clock identifier
* @param freq Clock frequency in Hz
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetClockFreq(lms_device_t *dev, size_t clk_id,
float_type *freq);
/**
* Set frequency of the specified clock
*
* @param dev Device handle previously obtained by LMS_Open().
* @param clk_id Clock identifier
* @param freq Clock frequency in Hz. Pass zero or negative value to only
* perform tune (if supported) without recalculating values
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetClockFreq(lms_device_t *dev, size_t clk_id,
float_type freq);
/**
* Load Si5351C configuration from file
*
* @param dev Device handle previously obtained by LMS_Open().
* @param filename file containing Si5351C configuration
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_LoadConfigSi5351C(lms_device_t *dev,
const char* filename);
/**
* Configure Si5351C frequencies
*
* @param dev Device handle previously obtained by LMS_Open().
* @param clkin PLLs input clock frequency.
* @param clks output clock frequencies (must be 8).
* 0 - disabled, negative - inverted
* @param src input clock source 0-XTAL, 1-CLKIN
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ConfigureSi5351C(lms_device_t *dev,
float_type clkin, float_type *clks, uint32_t src);
/**
* Get Si5351C status bits
*
* @param dev Device handle previously obtained by LMS_Open().
* @param status Status bits. Pass Null to clear status bits
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_StatusSi5351C(lms_device_t *dev, uint32_t *status);
typedef struct
{
double fRef;
double fVCO;
//Reference counter latch
unsigned lockDetectPrec; /**<3 cycles (0), or 5 cycles (1)*/
unsigned antiBacklash; /**<2.9ns (0), 6ns (1)*/
unsigned referenceCounter; /**<range [0, 16383]*/
//N counter latch
unsigned cpGain; /**<0 or 1*/
unsigned nCounter; /**<range [0, 8191]*/
//Function latch
unsigned flCurrent1;
unsigned flCurrent2;
unsigned flTimerCounter;
unsigned flFastlock;
unsigned flMuxCtrl;
unsigned flPDPolarity;
unsigned flPD1;
unsigned flPD2;
unsigned flCounterReset;
unsigned flCPState;
//Initialization latch
unsigned ilCurrent1;
unsigned ilCurrent2;
unsigned ilTimerCounter;
unsigned ilFastlock;
unsigned ilMuxCtrl;
unsigned ilPDPolarity;
unsigned ilPD1;
unsigned ilPD2;
unsigned ilCounterReset;
unsigned ilCPState;
//Extra
uint32_t flags;
}lms_adf4002_conf_t;
/**
* Get Si5351C status bits
*
* @param dev Device handle previously obtained by LMS_Open().
* @param config ADF4002 configuration structure ::lms_adf4002_conf_t
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ConfigureADF4002(lms_device_t *dev, lms_adf4002_conf_t *config);
/**
* Synchronizes register values between API cache and chip
*
* @param dev Device handle previously obtained by LMS_Open().
* @param toChip if true copies values from API cache to chip.
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_Synchronize(lms_device_t *dev, bool toChip);
/**
*
* @param dev Device handle previously obtained by LMS_Open().
* @param buffer read values
* @param len number of bytes to read
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GPIORead(lms_device_t *dev, uint8_t* buffer, size_t len);
/**
*
* @param dev Device handle previously obtained by LMS_Open().
* @param buffer values to write
* @param len number bytes to write
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GPIOWrite(lms_device_t *dev, const uint8_t* buffer, size_t len);
/**
* Low-level data transfer using LMS64C protocol
*
* @param dev Device handle previously obtained by LMS_Open().
* @param cmd command
* @param data in/out data
* @param len data length
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_TransferLMS64C(lms_device_t *dev, int cmd, uint8_t* data, size_t *len);
/**
* Enables or disable caching of calibration values
*
* @param dev Device handle previously obtained by LMS_Open().
* @param enable true to enable cache
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_EnableCalibCache(lms_device_t *dev, bool enable);
/**
* Read LMS7 chip internal temperature sensor
*
* @param dev Device handle previously obtained by LMS_Open().
* @param ind chip index
* @param temp temperature value
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetChipTemperature(lms_device_t *dev, size_t ind,
float_type *temp);
/** @} (End FN_LOW_LVL) */
/** @} (End FN_ADVANCED) */
/**
* @defgroup FN_STREAM Sample Streaming functions
* The functions in this section provides support for sending and receiving
* IQ data samples.
* @{
*/
/**Metadata structure used in sample transfers*/
typedef struct
{
/**Timestamp is a value of HW counter with a tick based on sample rate.
* In RX: time when the first sample in the returned buffer was received
* In TX: time when the first sample in the submitted buffer should be send
*/
uint64_t timestamp;
/**In TX: wait for the specified HW timestamp before broadcasting data over
* the air
* In RX: wait for the specified HW timestamp before starting to receive
* samples
*/
bool waitForTimestamp;
/**Indicates the end of send/receive transaction. Discards data remainder
* in buffer (if there is any) in RX or flushes transfer buffer in TX (even
* if the buffer is not full yet).*/
bool flushPartialPacket;
}lms_stream_meta_t;
/**Stream structure*/
typedef struct
{
/**Stream handle. Should not be modified manually.
* Assigned by LMS_SetupStream().
*/
size_t handle;
//! Indicates whether stream is TX (true) or RX (false)
bool isTx;
//! Channel number. Starts at 0.
uint32_t channel;
//! FIFO size (in samples) used by stream.
uint32_t fifoSize;
/**Parameter for controlling configuration bias toward low latency or high
* data throughput range [0,1.0].
* 0 - lowest latency, usually results in lower throughput
* 1 - higher throughput, usually results in higher latency
*/
float throughputVsLatency;
//! Data output format
enum
{
LMS_FMT_F32=0, /**<32-bit floating point*/
LMS_FMT_I16, /**<16-bit integers*/
LMS_FMT_I12 /**<12-bit integers stored in 16-bit variables*/
}dataFmt;
}lms_stream_t;
/**Streaming status structure*/
typedef struct
{
/**Indicates whether the stream is currently active*/
bool active;
/**Number of samples in FIFO buffer*/
uint32_t fifoFilledCount;
/**Size of FIFO buffer*/
uint32_t fifoSize;
/**FIFO underrun count*/
uint32_t underrun;
/**FIFO overrun count*/
uint32_t overrun;
/**Number of dropped packets by HW*/
uint32_t droppedPackets;
/**Sampling rate of the stream*/
float_type sampleRate;
/**Combined data rate of all stream of the same direction (TX or RX)*/
float_type linkRate;
/**Current HW timestamp*/
uint64_t timestamp;
} lms_stream_status_t;
/**
* Create new stream based on parameters passed in configuration structure.
* The structure is initialized with stream handle.
*
* @param device Device handle previously obtained by LMS_Open().
* @param stream Stream configuration .See the ::lms_stream_t description.
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SetupStream(lms_device_t *device, lms_stream_t *stream);
/**
* Deallocate memory used for stream.
* @todo
* @param stream Stream structure previously initialized with LMS_SetupStream().
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_DestroyStream(lms_device_t *device, lms_stream_t *stream);
/**
* Start stream
*
* @param stream Stream structure previously initialized with LMS_SetupStream().
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_StartStream(lms_stream_t *stream);
/**
* Stop stream
*
* @param stream Stream structure previously initialized with LMS_SetupStream().
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_StopStream(lms_stream_t *conf);
/**
* Read samples from the FIFO of the specified stream.
* Sample buffer must be big enough to hold requested number of samples.
*
* @param stream structure previously initialized with LMS_SetupStream().
* @param samples sample buffer.
* @param sample_count Number of samples to read
* @param meta Metadata. See the ::lms_stream_meta_t description.
* @param timeout_ms how long to wait for data before timing out(0=infinite).
*
* @return number of samples received on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_RecvStream(lms_stream_t *stream, void *samples,
size_t sample_count, lms_stream_meta_t *meta, unsigned timeout_ms);
/**
* Get stream operation status
*
* @param stream structure previously initialized with LMS_SetupStream().
* @param status Stream status. See the ::lms_stream_status_t for description
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_GetStreamStatus(lms_stream_t *stream, lms_stream_status_t* status);
/**
* Write samples to the FIFO of the specified stream.
*
* @param stream structure previously initialized with LMS_SetupStream().
* @param samples sample buffer.
* @param sample_count Number of samples to write
* @param meta Metadata. See the ::lms_stream_meta_t description.
* @param timeout_ms how long to wait for data before timing out(0=infinite).
*
* @return number of samples send on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_SendStream(lms_stream_t *stream,
const void *samples,size_t sample_count,
const lms_stream_meta_t *meta, unsigned timeout_ms);
/** @brief Uploads waveform to on board memory for later use
* @param device Device handle previously obtained by LMS_Open().
* @param samples multiple channel samples data
* @param chCount number of waveform channels
* @param sample_count number of samples in each channel
* @param format waveform data format
* @return 0 on success
*/
API_EXPORT int CALL_CONV LMS_UploadWFM(lms_device_t *device, const void **samples,
uint8_t chCount, size_t sample_count, int format);
/** @brief Enables/Disables transmitting of uploaded waveform
* @param device Device handle previously obtained by LMS_Open().
* @param active Enable/Disable waveform playback
* @return 0 on success
*/
API_EXPORT int CALL_CONV LMS_EnableTxWFM(lms_device_t *device, const bool active);
/** @} (End FN_STREAM) */
/**
* @defgroup FN_VERSION Version and update functions
*
* The functions in this section provides ability to check device version
* and perform updates
* @{
*/
/**Enumeration of device programming target*/
typedef enum
{
LMS_TARGET_RAM = 0, /**<load firmware/bitstream to volatile storage*/
LMS_TARGET_FLASH = 1, /**<load firmware/bitstream to non-volatile storage*/
LMS_TARGET_BOOT = 2 /**<reset and boot from flash*/
}lms_target_t;
/**Device information structure*/
typedef struct
{
//! The displayable name for the device
char deviceName[32];
/*! The displayable name for the expansion card
*/
char expansionName[32];
//! The firmware version as a string
char firmwareVersion[16];
//! The hardware version as a string
char hardwareVersion[16];
//! The protocol version as a string
char protocolVersion[16];
//! A unique board serial number
uint32_t boardSerialNumber;
//! Gateware version as a string
char gatewareVersion[16];
//! Gateware revision as a string
char gatewareRevision[16];
//! Which board should use this gateware
char gatewareTargetBoard[32];
}lms_dev_info_t;
/**
* Get device serial number and version information
*
* @note This function returns pointer to internal data structure that gets
* deallocated when device is closed. Do not attempt to read from it after
* closing the device. If you need to keep using device info returned by this
* function after closing the device, make a copy before closing the device.
*
* @param device Device handle previously obtained by LMS_Open().
* @return pointer to device info structure
*/
API_EXPORT const lms_dev_info_t* CALL_CONV LMS_GetDeviceInfo(lms_device_t *device);
/**
* @brief Returns API library build type
*/
API_EXPORT const char* LMS_GetBuildTimestamp();
/**
* @brief Returns API library version
*/
API_EXPORT const char* LMS_GetLibraryVersion();
/*!
* Callback from programming processes
* @param bsent number of bytes transferred
* @param btotal total number of bytes to send
* @param progressMsg string describing current progress state
* @return 0-continue programming, 1-abort operation
*/
typedef bool (*lms_prog_callback_t)(int bsent, int btotal, const char* progressMsg);
/**
* Write binary FPGA image to device.
*
* @param device Device handle previously obtained by LMS_Open().
* @param data Pointer to memory containing FPGA image
* @param size Size of FPGA image in bytes.
* @param target load to volatile or non-volatile storage
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ProgramFPGA(lms_device_t *device, const char *data,
size_t size, lms_target_t target,lms_prog_callback_t callback);
/**
* Read FPGA image from the specified file and write it to device.
*
* @param device Device handle previously obtained by LMS_Open().
* @param file File containing FPGA image
* @param target load to volatile or non-volatile storage
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ProgramFPGAFile(lms_device_t *device,
const char *file, lms_target_t target, lms_prog_callback_t callback);
/**
* Write firmware image to device.
*
* @param device Device handle previously obtained by LMS_Open().
* @param data Pointer to memory containing firmware image
* @param size Size of firmware image in bytes.
* @param target load to volatile or non-volatile storage
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ProgramFirmware(lms_device_t *device, const char *data,
size_t size, lms_target_t target, lms_prog_callback_t callback);
/**
* Read firmware image from file and write it to device.
*
* @param device Device handle previously obtained by LMS_Open().
* @param file File containing Firmware image
* @param target load to volatile or non-volatile storage
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ProgramFirmwareFile(lms_device_t *device,
const char *file, lms_target_t target, lms_prog_callback_t callback);
/**
*
* @param device Device handle previously obtained by LMS_Open().
* @param data Pointer to memory containing image
* @param size Size of image in bytes.
* @param mode programming mode
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ProgramHPM7(lms_device_t *device, const char *data,
size_t size, unsigned mode, lms_prog_callback_t callback);
/**
*
* @param device Device handle previously obtained by LMS_Open().
* @param file File containing image
* @param mode programming mode
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ProgramHPM7File(lms_device_t *device,
const char *file, unsigned mode, lms_prog_callback_t callback);
/**
* Program LMS7 internal MCU.
*
* @param device Device handle previously obtained by LMS_Open().
* @param file Pointer to memory containing binary MCU firmware image data
* @param target load to volatile or non-volatile storage
* @param size Size of MCU firmware image in bytes.
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ProgramLMSMCU(lms_device_t *device, const char *data,
size_t size, lms_target_t target, lms_prog_callback_t callback);
/**
* Boots LMS7 internal MCU from flash memory.
*
* @param device Device handle previously obtained by LMS_Open().
*
* @return 0 on success, (-1) on failure
*/
API_EXPORT int CALL_CONV LMS_ResetLMSMCU(lms_device_t *device);
/** @} (End FN_VERSION) */
/**
* @defgroup FN_ERRORS Error reporting
*
* LMS API functions return 0 or positive value on success and (-1) on failure.
* The functions in this section provides ability to get more detailed
* error descriptions.
* @{
*/
/**
* Get the last error code. Error codes are as defined in errno.h
* @return last error code
*/
API_EXPORT int CALL_CONV LMS_GetLastError(void);
/**
* Get the error message detailing why the last error occurred.
*
* @return last error message.
*/
API_EXPORT const char * CALL_CONV LMS_GetLastErrorMessage(void);
/** @} (End FN_ERRORS) */
#ifdef __cplusplus
} //extern "C"
#endif
#endif //LMS_SDR_INTERFACE_H
|