LMS API Documentation: /build/limesuite/src/LimeSuite-19.04.0/src/lime/LimeSuite.h Source File

LMS API Documentation v19.04.0

LimeSuite.h
Go to the documentation of this file.
1
21 #ifndef LMS7_API_H
22 #define LMS7_API_H
23
24 #include <stdint.h>
25 #include <stdlib.h>
26 #include "LMS7002M_parameters.h"
27
28 #ifdef __cplusplus
29 extern "C" {
30 #else
31 /* stdbool.h is not applicable for C++ programs, as the language inherently
32 * provides the bool type.
33 *
34 * Users of Visual Studio 2012 and earlier will need to supply a stdbool.h
35 * implementation, as it is not included with the toolchain. Visual Studio 2013
36 * onward supplies this header.
37 */
38 #include <stdbool.h>
39 #endif
40
41 #if defined _WIN32 || defined __CYGWIN__
42 # include <windows.h>
43 # define CALL_CONV __cdecl
44 # ifdef __GNUC__
45 # define API_EXPORT __attribute__ ((dllexport))
46 # else
47 # define API_EXPORT __declspec(dllexport)
48 # endif
49 #elif defined _DOXYGEN_ONLY_
50
52 # define API_EXPORT
53
55 # define CALL_CONV
56 #else
57 # define API_EXPORT __attribute__ ((visibility ("default")))
58 # define CALL_CONV
59 #endif
60
62 typedef double float_type;
63
65 static const int LMS_SUCCESS = 0;
66
75 typedef void lms_device_t;
77
79 typedef char lms_info_str_t[256];
80
88 API_EXPORT int CALL_CONV LMS_GetDeviceList(lms_info_str_t *dev_list);
89
104 API_EXPORT int CALL_CONV LMS_Open(lms_device_t **device, const lms_info_str_t info,
105 void* args);
106
116 API_EXPORT int CALL_CONV LMS_Close(lms_device_t *device);
117
129 static const bool LMS_CH_TX = true;
130 static const bool LMS_CH_RX = false;
131
133 typedef char lms_name_t[16];
134
136 typedef struct
137 {
138 float_type min;
139 float_type max;
140 float_type step;
141 }lms_range_t;
142
144 typedef enum
145 {
146 LMS_TESTSIG_NONE=0,
147 LMS_TESTSIG_NCODIV8,
148 LMS_TESTSIG_NCODIV4,
149 LMS_TESTSIG_NCODIV8F,
150 LMS_TESTSIG_NCODIV4F,
151 LMS_TESTSIG_DC
152 }lms_testsig_t;
153
165 API_EXPORT int CALL_CONV LMS_Init(lms_device_t *device);
166
177 API_EXPORT int CALL_CONV LMS_GetNumChannels(lms_device_t *device, bool dir_tx);
178
190 API_EXPORT int CALL_CONV LMS_EnableChannel(lms_device_t *device, bool dir_tx,
191 size_t chan, bool enabled);
192
206 API_EXPORT int CALL_CONV LMS_SetSampleRate(lms_device_t *device, float_type rate,
207 size_t oversample);
208
222 API_EXPORT int CALL_CONV LMS_GetSampleRate(lms_device_t *device, bool dir_tx,
223 size_t chan, float_type *host_Hz, float_type *rf_Hz);
233 API_EXPORT int CALL_CONV LMS_GetSampleRateRange(lms_device_t *device, bool dir_tx,
234 lms_range_t *range);
235
252 API_EXPORT int CALL_CONV LMS_SetLOFrequency(lms_device_t *device, bool dir_tx,
253 size_t chan, float_type frequency);
254
265 API_EXPORT int CALL_CONV LMS_GetLOFrequency(lms_device_t *device, bool dir_tx,
266 size_t chan, float_type *frequency);
267
277 API_EXPORT int CALL_CONV LMS_GetLOFrequencyRange(lms_device_t *device, bool dir_tx,
278 lms_range_t *range);
279
281 enum
282 {
283 LMS_PATH_NONE = 0,
284 LMS_PATH_LNAH = 1,
285 LMS_PATH_LNAL = 2,
286 LMS_PATH_LNAW = 3,
287 LMS_PATH_TX1 = 1,
288 LMS_PATH_TX2 = 2,
289 LMS_PATH_AUTO = 255,
290 };
291
303 API_EXPORT int CALL_CONV LMS_GetAntennaList(lms_device_t *dev, bool dir_tx,
304 size_t chan, lms_name_t *list);
305
316 API_EXPORT int CALL_CONV LMS_SetAntenna(lms_device_t *dev, bool dir_tx,
317 size_t chan, size_t index);
318
328 API_EXPORT int CALL_CONV LMS_GetAntenna(lms_device_t *dev, bool dir_tx,
329 size_t chan);
330
343 API_EXPORT int CALL_CONV LMS_GetAntennaBW(lms_device_t *dev, bool dir_tx,
344 size_t chan, size_t index, lms_range_t *range);
345
361 API_EXPORT int CALL_CONV LMS_SetNormalizedGain(lms_device_t *device, bool dir_tx,
362 size_t chan,float_type gain);
363
378 API_EXPORT int CALL_CONV LMS_SetGaindB(lms_device_t *device, bool dir_tx,
379 size_t chan, unsigned gain);
380
394 API_EXPORT int CALL_CONV LMS_GetNormalizedGain(lms_device_t *device, bool dir_tx,
395 size_t chan, float_type *gain);
408 API_EXPORT int CALL_CONV LMS_GetGaindB(lms_device_t *device, bool dir_tx,
409 size_t chan, unsigned *gain);
410
422 API_EXPORT int CALL_CONV LMS_SetLPFBW(lms_device_t *device, bool dir_tx,
423 size_t chan, float_type bandwidth);
424
437 API_EXPORT int CALL_CONV LMS_GetLPFBW(lms_device_t *device, bool dir_tx,
438 size_t chan, float_type *bandwidth);
439
449 API_EXPORT int CALL_CONV LMS_GetLPFBWRange(lms_device_t *device, bool dir_tx,
450 lms_range_t *range);
451
462 API_EXPORT int CALL_CONV LMS_SetLPF(lms_device_t *device, bool dir_tx,
463 size_t chan, bool enable);
464
479 API_EXPORT int CALL_CONV LMS_SetGFIRLPF(lms_device_t *device, bool dir_tx,
480 size_t chan, bool enabled, float_type bandwidth);
481
497 API_EXPORT int CALL_CONV LMS_Calibrate(lms_device_t *device, bool dir_tx,
498 size_t chan, double bw, unsigned flags);
499
512 API_EXPORT int CALL_CONV LMS_LoadConfig(lms_device_t *device, const char *filename);
513
522 API_EXPORT int CALL_CONV LMS_SaveConfig(lms_device_t *device, const char *filename);
523
536 API_EXPORT int CALL_CONV LMS_SetTestSignal(lms_device_t *device, bool dir_tx,
537 size_t chan, lms_testsig_t sig, int16_t dc_i, int16_t dc_q);
548 API_EXPORT int CALL_CONV LMS_GetTestSignal(lms_device_t *device, bool dir_tx,
549 size_t chan, lms_testsig_t *sig);
550
560 API_EXPORT int CALL_CONV LMS_GetChipTemperature(lms_device_t *dev, size_t ind,
561 float_type *temp);
562
573 typedef enum
575 {
576 LMS_GFIR1 = 0,
577 LMS_GFIR2,
578 LMS_GFIR3
579 }lms_gfir_t;
580
582 static const int LMS_NCO_VAL_COUNT = 16;
583
605 API_EXPORT int CALL_CONV LMS_SetSampleRateDir(lms_device_t *device, bool dir_tx,
606 float_type rate, size_t oversample);
607
623 API_EXPORT int CALL_CONV LMS_SetNCOFrequency(lms_device_t *device, bool dir_tx,
624 size_t chan, const float_type *freq, float_type pho);
625
638 API_EXPORT int CALL_CONV LMS_GetNCOFrequency(lms_device_t *device, bool dir_tx,
639 size_t chan, float_type *freq, float_type *pho);
640
656 API_EXPORT int CALL_CONV LMS_SetNCOPhase(lms_device_t *device, bool dir_tx,
657 size_t chan, const float_type *phases, float_type fcw);
658
671 API_EXPORT int CALL_CONV LMS_GetNCOPhase(lms_device_t *device, bool dir_tx,
672 size_t chan, float_type *phases, float_type *fcw);
673
686 API_EXPORT int CALL_CONV LMS_SetNCOIndex(lms_device_t *device, bool dir_tx,
687 size_t chan, int index, bool downconv);
688
698 API_EXPORT int CALL_CONV LMS_GetNCOIndex(lms_device_t *device, bool dir_tx,
699 size_t chan);
700
714 API_EXPORT int CALL_CONV LMS_SetGFIRCoeff(lms_device_t * device, bool dir_tx,
715 size_t chan, lms_gfir_t filt, const float_type* coef,size_t count);
716
729 API_EXPORT int CALL_CONV LMS_GetGFIRCoeff(lms_device_t * device, bool dir_tx,
730 size_t chan, lms_gfir_t filt, float_type* coef);
731
743 API_EXPORT int CALL_CONV LMS_SetGFIR(lms_device_t * device, bool dir_tx,
744 size_t chan, lms_gfir_t filt, bool enabled);
745
746
747
759 API_EXPORT int CALL_CONV LMS_EnableCalibCache(lms_device_t *dev, bool enable);
760
770 API_EXPORT int CALL_CONV LMS_EnableCache(lms_device_t *dev, bool enable);
771
793 API_EXPORT int CALL_CONV LMS_Reset(lms_device_t *device);
794
804 API_EXPORT int CALL_CONV LMS_ReadLMSReg(lms_device_t *device, uint32_t address,
805 uint16_t *val);
806
816 API_EXPORT int CALL_CONV LMS_WriteLMSReg(lms_device_t *device, uint32_t address,
817 uint16_t val);
818
828 API_EXPORT int CALL_CONV LMS_ReadParam(lms_device_t *device,
829 struct LMS7Parameter param, uint16_t *val);
830
840 API_EXPORT int CALL_CONV LMS_WriteParam(lms_device_t *device,
841 struct LMS7Parameter param, uint16_t val);
842
852 API_EXPORT int CALL_CONV LMS_ReadFPGAReg(lms_device_t *device, uint32_t address,
853 uint16_t *val);
854
864 API_EXPORT int CALL_CONV LMS_WriteFPGAReg(lms_device_t *device, uint32_t address,
865 uint16_t val);
866
872 #define BOARD_PARAM_DAC 0
874 #define BOARD_PARAM_TEMP 1
876
888 API_EXPORT int CALL_CONV LMS_ReadCustomBoardParam(lms_device_t *device,
889 uint8_t id, float_type *val, lms_name_t units);
890
901 API_EXPORT int CALL_CONV LMS_WriteCustomBoardParam(lms_device_t *device,
902 uint8_t id, float_type val, const lms_name_t units);
903
910 #define LMS_CLOCK_REF 0x0000
912 #define LMS_CLOCK_SXR 0x0001
914 #define LMS_CLOCK_SXT 0x0002
916 #define LMS_CLOCK_CGEN 0x0003
918 #define LMS_CLOCK_RXTSP 0x0004
920 #define LMS_CLOCK_TXTSP 0x0005
922
929 #define LMS_CLOCK_EXTREF 0x0006
930
942 API_EXPORT int CALL_CONV LMS_GetClockFreq(lms_device_t *dev, size_t clk_id,
943 float_type *freq);
944
955 API_EXPORT int CALL_CONV LMS_SetClockFreq(lms_device_t *dev, size_t clk_id,
956 float_type freq);
957
969 API_EXPORT int CALL_CONV LMS_VCTCXOWrite(lms_device_t * dev, uint16_t val);
970
980 API_EXPORT int CALL_CONV LMS_VCTCXORead(lms_device_t * dev, uint16_t *val);
981
990 API_EXPORT int CALL_CONV LMS_Synchronize(lms_device_t *dev, bool toChip);
991
999 API_EXPORT int CALL_CONV LMS_GPIORead(lms_device_t *dev, uint8_t* buffer, size_t len);
1000
1008 API_EXPORT int CALL_CONV LMS_GPIOWrite(lms_device_t *dev, const uint8_t* buffer, size_t len);
1009
1017 API_EXPORT int CALL_CONV LMS_GPIODirRead(lms_device_t *dev, uint8_t* buffer, size_t len);
1018
1026 API_EXPORT int CALL_CONV LMS_GPIODirWrite(lms_device_t *dev, const uint8_t* buffer, size_t len);
1027
1038 typedef struct
1039 {
1045 uint64_t timestamp;
1046
1051 bool waitForTimestamp;
1052
1056 bool flushPartialPacket;
1057
1058 }lms_stream_meta_t;
1059
1061 typedef struct
1062 {
1066 size_t handle;
1067
1069 bool isTx;
1070
1072 uint32_t channel;
1073
1075 uint32_t fifoSize;
1076
1083 float throughputVsLatency;
1084
1086 enum
1087 {
1088 LMS_FMT_F32=0,
1089 LMS_FMT_I16,
1090 LMS_FMT_I12
1091 }dataFmt;
1092 }lms_stream_t;
1093
1095 typedef struct
1096 {
1098 bool active;
1100 uint32_t fifoFilledCount;
1102 uint32_t fifoSize;
1104 uint32_t underrun;
1106 uint32_t overrun;
1108 uint32_t droppedPackets;
1110 float_type sampleRate;
1112 float_type linkRate;
1114 uint64_t timestamp;
1115
1116 } lms_stream_status_t;
1117
1127 API_EXPORT int CALL_CONV LMS_SetupStream(lms_device_t *device, lms_stream_t *stream);
1128
1137 API_EXPORT int CALL_CONV LMS_DestroyStream(lms_device_t *dev, lms_stream_t *stream);
1138
1146 API_EXPORT int CALL_CONV LMS_StartStream(lms_stream_t *stream);
1147
1155 API_EXPORT int CALL_CONV LMS_StopStream(lms_stream_t *stream);
1156
1169 API_EXPORT int CALL_CONV LMS_RecvStream(lms_stream_t *stream, void *samples,
1170 size_t sample_count, lms_stream_meta_t *meta, unsigned timeout_ms);
1171
1180 API_EXPORT int CALL_CONV LMS_GetStreamStatus(lms_stream_t *stream, lms_stream_status_t* status);
1181
1193 API_EXPORT int CALL_CONV LMS_SendStream(lms_stream_t *stream,
1194 const void *samples,size_t sample_count,
1195 const lms_stream_meta_t *meta, unsigned timeout_ms);
1196
1206 API_EXPORT int CALL_CONV LMS_UploadWFM(lms_device_t *device, const void **samples,
1207 uint8_t chCount, size_t sample_count, int format);
1208
1216 API_EXPORT int CALL_CONV LMS_EnableTxWFM(lms_device_t *device, unsigned chan, bool active);
1217
1236 API_EXPORT int CALL_CONV LMS_GetProgramModes(lms_device_t *device, lms_name_t *list);
1237
1245 typedef bool (*lms_prog_callback_t)(int bsent, int btotal, const char* progressMsg);
1246
1258 API_EXPORT int CALL_CONV LMS_Program(lms_device_t *device, const char *data,
1259 size_t size, const lms_name_t mode, lms_prog_callback_t callback);
1260
1262 typedef struct
1263 {
1264 char deviceName[32];
1265 char expansionName[32];
1266 char firmwareVersion[16];
1267 char hardwareVersion[16];
1268 char protocolVersion[16];
1269 uint64_t boardSerialNumber;
1270 char gatewareVersion[16];
1271 char gatewareTargetBoard[32];
1272 }lms_dev_info_t;
1273
1285 API_EXPORT const lms_dev_info_t* CALL_CONV LMS_GetDeviceInfo(lms_device_t *device);
1286
1290 API_EXPORT const char* LMS_GetLibraryVersion();
1291
1299 API_EXPORT const char * CALL_CONV LMS_GetLastErrorMessage(void);
1300
1306 #define LMS_LOG_ERROR 1
1308 #define LMS_LOG_WARNING 2
1310 #define LMS_LOG_INFO 3
1312 #define LMS_LOG_DEBUG 4
1314
1322 typedef void (*LMS_LogHandler)(int lvl, const char *msg);
1323
1330 API_EXPORT void LMS_RegisterLogHandler(LMS_LogHandler handler);
1331
1334 #ifdef __cplusplus
1335 } //extern "C"
1336 #endif
1337
1338 #endif //LMS_SDR_INTERFACE_H
lms_name_t
char lms_name_t[16]
Definition: LimeSuite.h:133
LMS_PATH_LNAW
RX LNA_W port.
Definition: LimeSuite.h:286
LMS_SaveConfig
API_EXPORT int CALL_CONV LMS_SaveConfig(lms_device_t *device, const char *filename)
lms_stream_status_t::linkRate
float_type linkRate
Combined data rate of all stream of the same direction (TX or RX)
Definition: LimeSuite.h:1112
LMS_PATH_TX2
TX port 2.
Definition: LimeSuite.h:288
LMS_GetProgramModes
API_EXPORT int CALL_CONV LMS_GetProgramModes(lms_device_t *device, lms_name_t *list)
LMS_TESTSIG_DC
DC test signal.
Definition: LimeSuite.h:151
LMS_UploadWFM
API_EXPORT int CALL_CONV LMS_UploadWFM(lms_device_t *device, const void **samples, uint8_t chCount, size_t sample_count, int format)
lms_stream_status_t::overrun
uint32_t overrun
FIFO overrun count.
Definition: LimeSuite.h:1106
LMS_LogHandler
void(* LMS_LogHandler)(int lvl, const char *msg)
Definition: LimeSuite.h:1322
LMS_SetSampleRateDir
API_EXPORT int CALL_CONV LMS_SetSampleRateDir(lms_device_t *device, bool dir_tx, float_type rate, size_t oversample)
LMS_RegisterLogHandler
API_EXPORT void LMS_RegisterLogHandler(LMS_LogHandler handler)
LMS_CH_TX
static const bool LMS_CH_TX
Convenience constants for TX selection.
Definition: LimeSuite.h:129
lms_stream_status_t::underrun
uint32_t underrun
FIFO underrun count.
Definition: LimeSuite.h:1104
lms_stream_t::channel
uint32_t channel
Channel number. Starts at 0.
Definition: LimeSuite.h:1072
lms_stream_t
Definition: LimeSuite.h:1061
LMS_SetupStream
API_EXPORT int CALL_CONV LMS_SetupStream(lms_device_t *device, lms_stream_t *stream)
LMS_GetTestSignal
API_EXPORT int CALL_CONV LMS_GetTestSignal(lms_device_t *device, bool dir_tx, size_t chan, lms_testsig_t *sig)
LMS_PATH_AUTO
Automatically select port (if supported)
Definition: LimeSuite.h:289
LMS_SetClockFreq
API_EXPORT int CALL_CONV LMS_SetClockFreq(lms_device_t *dev, size_t clk_id, float_type freq)
LMS_GetNCOPhase
API_EXPORT int CALL_CONV LMS_GetNCOPhase(lms_device_t *device, bool dir_tx, size_t chan, float_type *phases, float_type *fcw)
LMS_LoadConfig
API_EXPORT int CALL_CONV LMS_LoadConfig(lms_device_t *device, const char *filename)
LMS_GPIORead
API_EXPORT int CALL_CONV LMS_GPIORead(lms_device_t *dev, uint8_t *buffer, size_t len)
LMS_TESTSIG_NCODIV4
Test signal from NCO half scale.
Definition: LimeSuite.h:148
lms_range_t::step
float_type step
Minimum value step.
Definition: LimeSuite.h:140
lms_range_t::min
float_type min
Minimum allowed value.
Definition: LimeSuite.h:138
LMS_SetNCOPhase
API_EXPORT int CALL_CONV LMS_SetNCOPhase(lms_device_t *device, bool dir_tx, size_t chan, const float_type *phases, float_type fcw)
lms_stream_t::fifoSize
uint32_t fifoSize
FIFO size (in samples) used by stream.
Definition: LimeSuite.h:1075
LMS_SetGaindB
API_EXPORT int CALL_CONV LMS_SetGaindB(lms_device_t *device, bool dir_tx, size_t chan, unsigned gain)
LMS_ReadParam
API_EXPORT int CALL_CONV LMS_ReadParam(lms_device_t *device, struct LMS7Parameter param, uint16_t *val)
LMS_WriteCustomBoardParam
API_EXPORT int CALL_CONV LMS_WriteCustomBoardParam(lms_device_t *device, uint8_t id, float_type val, const lms_name_t units)
LMS_PATH_NONE
No active path (RX or TX)
Definition: LimeSuite.h:283
LMS_GetNCOFrequency
API_EXPORT int CALL_CONV LMS_GetNCOFrequency(lms_device_t *device, bool dir_tx, size_t chan, float_type *freq, float_type *pho)
LMS_Close
API_EXPORT int CALL_CONV LMS_Close(lms_device_t *device)
LMS_WriteParam
API_EXPORT int CALL_CONV LMS_WriteParam(lms_device_t *device, struct LMS7Parameter param, uint16_t val)
LMS_TESTSIG_NCODIV8
Test signal from NCO half scale.
Definition: LimeSuite.h:147
lms_stream_status_t::fifoFilledCount
uint32_t fifoFilledCount
Number of samples in FIFO buffer.
Definition: LimeSuite.h:1100
LMS_SetGFIR
API_EXPORT int CALL_CONV LMS_SetGFIR(lms_device_t *device, bool dir_tx, size_t chan, lms_gfir_t filt, bool enabled)
lms_stream_meta_t::flushPartialPacket
bool flushPartialPacket
Definition: LimeSuite.h:1056
LMS_EnableChannel
API_EXPORT int CALL_CONV LMS_EnableChannel(lms_device_t *device, bool dir_tx, size_t chan, bool enabled)
lms_stream_t::handle
size_t handle
Definition: LimeSuite.h:1066
LMS_PATH_LNAL
RX LNA_L port.
Definition: LimeSuite.h:285
LMS_StartStream
API_EXPORT int CALL_CONV LMS_StartStream(lms_stream_t *stream)
LMS_SetNCOFrequency
API_EXPORT int CALL_CONV LMS_SetNCOFrequency(lms_device_t *device, bool dir_tx, size_t chan, const float_type *freq, float_type pho)
LMS_GetNumChannels
API_EXPORT int CALL_CONV LMS_GetNumChannels(lms_device_t *device, bool dir_tx)
LMS_TESTSIG_NCODIV8F
Test signal from NCO full scale.
Definition: LimeSuite.h:149
lms_stream_status_t::timestamp
uint64_t timestamp
Current HW timestamp.
Definition: LimeSuite.h:1114
lms_info_str_t
char lms_info_str_t[256]
Convenience type for fixed length LMS Device information string.
Definition: LimeSuite.h:79
LMS_GetAntennaList
API_EXPORT int CALL_CONV LMS_GetAntennaList(lms_device_t *dev, bool dir_tx, size_t chan, lms_name_t *list)
LMS_ReadLMSReg
API_EXPORT int CALL_CONV LMS_ReadLMSReg(lms_device_t *device, uint32_t address, uint16_t *val)
LMS_EnableTxWFM
API_EXPORT int CALL_CONV LMS_EnableTxWFM(lms_device_t *device, unsigned chan, bool active)
LMS_SetAntenna
API_EXPORT int CALL_CONV LMS_SetAntenna(lms_device_t *dev, bool dir_tx, size_t chan, size_t index)
LMS_WriteFPGAReg
API_EXPORT int CALL_CONV LMS_WriteFPGAReg(lms_device_t *device, uint32_t address, uint16_t val)
LMS_Init
API_EXPORT int CALL_CONV LMS_Init(lms_device_t *device)
LMS_GetLOFrequencyRange
API_EXPORT int CALL_CONV LMS_GetLOFrequencyRange(lms_device_t *device, bool dir_tx, lms_range_t *range)
float_type
double float_type
Floating point data type.
Definition: LimeSuite.h:62
LMS_GetLPFBW
API_EXPORT int CALL_CONV LMS_GetLPFBW(lms_device_t *device, bool dir_tx, size_t chan, float_type *bandwidth)
LMS_SetSampleRate
API_EXPORT int CALL_CONV LMS_SetSampleRate(lms_device_t *device, float_type rate, size_t oversample)
LMS_GetClockFreq
API_EXPORT int CALL_CONV LMS_GetClockFreq(lms_device_t *dev, size_t clk_id, float_type *freq)
LMS_GetGFIRCoeff
API_EXPORT int CALL_CONV LMS_GetGFIRCoeff(lms_device_t *device, bool dir_tx, size_t chan, lms_gfir_t filt, float_type *coef)
LMS_GetDeviceList
API_EXPORT int CALL_CONV LMS_GetDeviceList(lms_info_str_t *dev_list)
LMS_GetDeviceInfo
API_EXPORT const lms_dev_info_t *CALL_CONV LMS_GetDeviceInfo(lms_device_t *device)
lms_stream_meta_t::waitForTimestamp
bool waitForTimestamp
Definition: LimeSuite.h:1051
LMS_GetAntenna
API_EXPORT int CALL_CONV LMS_GetAntenna(lms_device_t *dev, bool dir_tx, size_t chan)
LMS_TESTSIG_NONE
Disable test signals. Return to normal operation.
Definition: LimeSuite.h:146
lms_range_t::max
float_type max
Minimum allowed value.
Definition: LimeSuite.h:139
LMS_ReadFPGAReg
API_EXPORT int CALL_CONV LMS_ReadFPGAReg(lms_device_t *device, uint32_t address, uint16_t *val)
LMS_Program
API_EXPORT int CALL_CONV LMS_Program(lms_device_t *device, const char *data, size_t size, const lms_name_t mode, lms_prog_callback_t callback)
LMS_Reset
API_EXPORT int CALL_CONV LMS_Reset(lms_device_t *device)
LMS_SetNormalizedGain
API_EXPORT int CALL_CONV LMS_SetNormalizedGain(lms_device_t *device, bool dir_tx, size_t chan, float_type gain)
LMS_SetLPFBW
API_EXPORT int CALL_CONV LMS_SetLPFBW(lms_device_t *device, bool dir_tx, size_t chan, float_type bandwidth)
LMS_GetChipTemperature
API_EXPORT int CALL_CONV LMS_GetChipTemperature(lms_device_t *dev, size_t ind, float_type *temp)
lms_stream_status_t::fifoSize
uint32_t fifoSize
Size of FIFO buffer.
Definition: LimeSuite.h:1102
LMS_GetLOFrequency
API_EXPORT int CALL_CONV LMS_GetLOFrequency(lms_device_t *device, bool dir_tx, size_t chan, float_type *frequency)
lms_stream_status_t::droppedPackets
uint32_t droppedPackets
Number of dropped packets by HW.
Definition: LimeSuite.h:1108
LMS_WriteLMSReg
API_EXPORT int CALL_CONV LMS_WriteLMSReg(lms_device_t *device, uint32_t address, uint16_t val)
lms_stream_meta_t
Definition: LimeSuite.h:1038
lms_stream_status_t::sampleRate
float_type sampleRate
Currently not used.
Definition: LimeSuite.h:1110
LMS_GPIODirWrite
API_EXPORT int CALL_CONV LMS_GPIODirWrite(lms_device_t *dev, const uint8_t *buffer, size_t len)
LMS_VCTCXOWrite
API_EXPORT int CALL_CONV LMS_VCTCXOWrite(lms_device_t *dev, uint16_t val)
LMS_SetLPF
API_EXPORT int CALL_CONV LMS_SetLPF(lms_device_t *device, bool dir_tx, size_t chan, bool enable)
LMS_GetAntennaBW
API_EXPORT int CALL_CONV LMS_GetAntennaBW(lms_device_t *dev, bool dir_tx, size_t chan, size_t index, lms_range_t *range)
lms_stream_status_t
Definition: LimeSuite.h:1095
LMS_GetNormalizedGain
API_EXPORT int CALL_CONV LMS_GetNormalizedGain(lms_device_t *device, bool dir_tx, size_t chan, float_type *gain)
LMS_GetNCOIndex
API_EXPORT int CALL_CONV LMS_GetNCOIndex(lms_device_t *device, bool dir_tx, size_t chan)
LMS_GetSampleRateRange
API_EXPORT int CALL_CONV LMS_GetSampleRateRange(lms_device_t *device, bool dir_tx, lms_range_t *range)
LMS_NCO_VAL_COUNT
static const int LMS_NCO_VAL_COUNT
Number of NCO frequency/phase offset values.
Definition: LimeSuite.h:582
lms_stream_t::LMS_FMT_I16
16-bit integers
Definition: LimeSuite.h:1089
LMS_GetSampleRate
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)
lms_range_t
Definition: LimeSuite.h:136
lms_stream_t::isTx
bool isTx
Indicates whether stream is TX (true) or RX (false)
Definition: LimeSuite.h:1069
LMS_PATH_LNAH
RX LNA_H port.
Definition: LimeSuite.h:284
lms_stream_t::throughputVsLatency
float throughputVsLatency
Definition: LimeSuite.h:1083
LMS_SetLOFrequency
API_EXPORT int CALL_CONV LMS_SetLOFrequency(lms_device_t *device, bool dir_tx, size_t chan, float_type frequency)
LMS_GPIOWrite
API_EXPORT int CALL_CONV LMS_GPIOWrite(lms_device_t *dev, const uint8_t *buffer, size_t len)
LMS_GetLPFBWRange
API_EXPORT int CALL_CONV LMS_GetLPFBWRange(lms_device_t *device, bool dir_tx, lms_range_t *range)
lms_gfir_t
lms_gfir_t
Enumeration of LMS7 GFIRS.
Definition: LimeSuite.h:574
LMS_StopStream
API_EXPORT int CALL_CONV LMS_StopStream(lms_stream_t *stream)
lms_prog_callback_t
bool(* lms_prog_callback_t)(int bsent, int btotal, const char *progressMsg)
Definition: LimeSuite.h:1245
lms_dev_info_t
Definition: LimeSuite.h:1262
LMS_Synchronize
API_EXPORT int CALL_CONV LMS_Synchronize(lms_device_t *dev, bool toChip)
LMS_EnableCalibCache
API_EXPORT int CALL_CONV LMS_EnableCalibCache(lms_device_t *dev, bool enable)
LMS_SetGFIRCoeff
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)
LMS_Calibrate
API_EXPORT int CALL_CONV LMS_Calibrate(lms_device_t *device, bool dir_tx, size_t chan, double bw, unsigned flags)
LMS_TESTSIG_NCODIV4F
Test signal from NCO full scale.
Definition: LimeSuite.h:150
LMS_GetGaindB
API_EXPORT int CALL_CONV LMS_GetGaindB(lms_device_t *device, bool dir_tx, size_t chan, unsigned *gain)
LMS_SUCCESS
static const int LMS_SUCCESS
convenience constant for good return code
Definition: LimeSuite.h:65
LMS_GetLibraryVersion
API_EXPORT const char * LMS_GetLibraryVersion()
Returns API library version.
LMS_ReadCustomBoardParam
API_EXPORT int CALL_CONV LMS_ReadCustomBoardParam(lms_device_t *device, uint8_t id, float_type *val, lms_name_t units)
lms_dev_info_t::boardSerialNumber
uint64_t boardSerialNumber
A unique board serial number.
Definition: LimeSuite.h:1269
LMS_GPIODirRead
API_EXPORT int CALL_CONV LMS_GPIODirRead(lms_device_t *dev, uint8_t *buffer, size_t len)
lms_stream_status_t::active
bool active
Indicates whether the stream is currently active.
Definition: LimeSuite.h:1098
LMS_VCTCXORead
API_EXPORT int CALL_CONV LMS_VCTCXORead(lms_device_t *dev, uint16_t *val)
LMS_SetNCOIndex
API_EXPORT int CALL_CONV LMS_SetNCOIndex(lms_device_t *device, bool dir_tx, size_t chan, int index, bool downconv)
LMS_GetLastErrorMessage
API_EXPORT const char *CALL_CONV LMS_GetLastErrorMessage(void)
LMS_SendStream
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)
LMS_EnableCache
API_EXPORT int CALL_CONV LMS_EnableCache(lms_device_t *dev, bool enable)
LMS_RecvStream
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)
LMS_Open
API_EXPORT int CALL_CONV LMS_Open(lms_device_t **device, const lms_info_str_t info, void *args)
LMS_SetGFIRLPF
API_EXPORT int CALL_CONV LMS_SetGFIRLPF(lms_device_t *device, bool dir_tx, size_t chan, bool enabled, float_type bandwidth)
LMS_SetTestSignal
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)
lms_device_t
void lms_device_t
LMS Device handle.
Definition: LimeSuite.h:76
LMS_PATH_TX1
TX port 1.
Definition: LimeSuite.h:287
LMS_CH_RX
static const bool LMS_CH_RX
Convenience constants for RX selection.
Definition: LimeSuite.h:130
lms_stream_meta_t::timestamp
uint64_t timestamp
Definition: LimeSuite.h:1045
LMS_DestroyStream
API_EXPORT int CALL_CONV LMS_DestroyStream(lms_device_t *dev, lms_stream_t *stream)
LMS_GetStreamStatus
API_EXPORT int CALL_CONV LMS_GetStreamStatus(lms_stream_t *stream, lms_stream_status_t *status)
lms_testsig_t
lms_testsig_t
Definition: LimeSuite.h:144