/usr/include/lime/LMS7002M.h is in liblimesuite-dev 17.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 | /**
@file LMS7002M.h
@author Lime Microsystems (www.limemicro.com)
@brief LMS7002M transceiver configuration interface
*/
#ifndef LMS7API_H
#define LMS7API_H
#include "LimeSuiteConfig.h"
#include "LMS7002M_parameters.h"
#include <cstdint>
#include <sstream>
#include <stdarg.h>
#include <functional>
#include <vector>
namespace lime{
class IConnection;
class LMS7002M_RegistersMap;
class CalibrationCache;
class MCU_BD;
class BinSearchParam;
class GridSearchParam;
struct RSSI_measurements
{
void clear()
{
amplitudeFFT.clear();
amplitudeGeortzelF.clear();
amplitudeGeortzelFPGA.clear();
}
std::vector<float> amplitudeFFT;
std::vector<float> amplitudeGeortzelF;
std::vector<float> amplitudeGeortzelFPGA;
};
typedef double float_type;
class LIME_API LMS7002M
{
public:
enum
{
Rx, Tx
};
struct CGEN_details
{
float_type frequency;
float_type frequencyVCO;
float_type referenceClock;
uint32_t INT;
uint32_t FRAC;
uint8_t div_outch_cgen;
uint16_t csw;
bool success;
};
struct SX_details
{
float_type frequency;
float_type frequencyVCO;
float_type referenceClock;
uint32_t INT;
uint32_t FRAC;
uint8_t div_loch;
bool en_div2_divprog;
uint16_t sel_vco;
uint16_t csw;
bool success;
};
LMS7002M();
/*!
* Set the connection for the LMS7002M driver.
* \param port the connection interface
* \param devIndex which RFIC index (default 0 for most devices)
* \param dataPort connection used to get samples data when calibrating with FFT
*/
void SetConnection(IConnection* port, const size_t devIndex = 0);
IConnection *GetConnection(void) const
{
return controlPort;
}
virtual ~LMS7002M();
/*!
* Enum for configuring the channel selection.
* @see MAC register
*/
enum Channel
{
ChA = 1,
ChB = 2,
ChAB = 3,
ChSXR = 1, //SXR register space
ChSXT = 2, //SXT register space
};
/*!
* Set the selected channel (MAC).
* The API calls will reflect this channel.
*/
void SetActiveChannel(const Channel ch);
/*!
* Get the selected channel (MAC).
* The API calls will reflect this channel.
*/
Channel GetActiveChannel(bool fromChip = true);
/*!
* Get the channel selected by the RFIC index (devIndex),
* and by the currently selected RF channel A/B (MAC).
* Example when devIndex == 0, return 0 for chA, 1 for chB.
*/
size_t GetActiveChannelIndex(bool fromChip = true);
/*!
* Enable/disable the selected channel.
* This powers on or off all of the respective hardware
* for a given channel A or B: TSP, BB, and RF sections.
* @param isTx true for the transmit size, false for receive
* @param enable true to enable, false to disable
*/
int EnableChannel(const bool isTx, const bool enable);
///@name Registers writing and reading
int UploadAll();
int DownloadAll();
bool IsSynced();
int CopyChannelRegisters(const Channel src, const Channel dest, bool copySX);
int ResetChip();
/*!
* Perform soft-reset sequence over SPI
*/
int SoftReset();
int LoadConfig(const char* filename);
int SaveConfig(const char* filename);
///@}
///@name Registers writing and reading
uint16_t Get_SPI_Reg_bits(const LMS7Parameter ¶m, bool fromChip = false);
uint16_t Get_SPI_Reg_bits(uint16_t address, uint8_t msb, uint8_t lsb, bool fromChip = false);
int Modify_SPI_Reg_bits(const LMS7Parameter ¶m, const uint16_t value, bool fromChip = false);
int Modify_SPI_Reg_bits(uint16_t address, uint8_t msb, uint8_t lsb, uint16_t value, bool fromChip = false);
int SPI_write(uint16_t address, uint16_t data);
uint16_t SPI_read(uint16_t address, bool fromChip = false, int *status = 0);
int RegistersTest(const char* fileName = "registersTest.txt");
///@}
///@name Calibration protection:
///Called internally by calibration and cgen API.
///Call externally when performing multiple cals.
///Safe to next calls to enter and exit.
///Always match calls to enter+exit.
void EnterSelfCalibration(void);
void ExitSelfCalibration(void);
///@}
///@name Transmitter, Receiver calibrations
int CalibrateRx(float_type bandwidth, const bool useExtLoopback = false);
int CalibrateTx(float_type bandwidth, const bool useExtLoopback = false);
///@}
///@name Filters tuning
int TuneTxFilter(const float_type bandwidth);
int TuneRxFilter(const float_type rx_lpf_freq_RF);
int TuneTxFilterWithCaching(const float_type bandwidth);
int TuneRxFilterWithCaching(const float_type rx_lpf_freq_RF);
///@}
///@name Internal calibrations
int CalibrateInternalADC(int clkDiv = 32);
int CalibrateRP_BIAS();
int CalibrateTxGain(float maxGainOffset_dBFS, float *actualGain_dBFS);
int CalibrateAnalogRSSI_DC_Offset();
///@name High level gain configuration
/*!
* Set the RX PGA gain in dB
* @param gain in dB range -12.0, 19.0 dB
* @return 0 for success, else error
*/
int SetRBBPGA_dB(const float_type gain);
//! Get the actual RX PGA gain in dB
float_type GetRBBPGA_dB(void);
/*!
* Set the RX LNA gain in dB
* @param gain in dB range 0.0, 30.0 dB
* @return 0 for success, else error
*/
int SetRFELNA_dB(const float_type gain);
//! Get the actual RX LNA gain in dB
float_type GetRFELNA_dB(void);
/*!
* Set the RX loopback LNA gain in dB
* @param gain in dB range 0.0, 40.0 dB
* @return 0 for success, else error
*/
int SetRFELoopbackLNA_dB(const float_type gain);
//! Get the actual RX loopback LNA gain in dB
float_type GetRFELoopbackLNA_dB(void);
/*!
* Set the RX TIA gain in dB
* @param gain in dB range 0.0, 12.0 dB
* @return 0 for success, else error
*/
int SetRFETIA_dB(const float_type gain);
//! Get the actual RX TIA gain in dB
float_type GetRFETIA_dB(void);
/*!
* Set the TX PAD gain in dB
* @param gain in dB range -52.0, 0.0 dB
* @return 0 for success, else error
*/
int SetTRFPAD_dB(const float_type gain);
//! Get the actual TX PAD gain in dB
float_type GetTRFPAD_dB(void);
/*!
* Set the TBB frontend gain in dB
* @param gain in dB relative to optimal gain (0 - optimal gain, >0 may cause saturation)
* @return 0 for success, else error
*/
int SetTBBIAMP_dB(const float_type gain);
//! Get the TBB frontend gain in dB
float_type GetTBBIAMP_dB(void);
/*!
* Set the TX loopback PAD gain in dB
* @param gain in dB range -4.3, 0.0 dB
* @return 0 for success, else error
*/
int SetTRFLoopbackPAD_dB(const float_type gain);
//! Get the actual TX loopback PAD gain in dB
float_type GetTRFLoopbackPAD_dB(void);
///@}
///@name RF selection
enum PathRFE
{
PATH_RFE_NONE = 0,
PATH_RFE_LNAH = int('H'),
PATH_RFE_LNAL = int('L'),
PATH_RFE_LNAW = int('W'),
PATH_RFE_LB1 = 1,
PATH_RFE_LB2 = 2,
};
//! Set the RFE input path.
int SetPathRFE(PathRFE path);
//! Get the currently set RFE path
PathRFE GetPathRFE(void);
/*!
* Set the TRF Band selection.
* @param band 1 or 2
*/
int SetBandTRF(const int band);
/*!
* Get the TRF Band selection.
* @return the band 1 or 2
*/
int GetBandTRF(void);
/*!
* Update the external band selection by calling
* UpdateExternalBandSelect() on the connection object.
* This is called automatically by the LMS7002M driver,
* but can also be called manually by the user.
*/
void UpdateExternalBandSelect(void);
///@}
///@name CGEN and PLL
int SetReferenceClk_SX(bool tx, float_type freq_Hz);
float_type GetReferenceClk_SX(bool tx);
float_type GetFrequencyCGEN();
int SetFrequencyCGEN(float_type freq_Hz, const bool retainNCOfrequencies = false, CGEN_details* output = nullptr);
bool GetCGENLocked(void);
float_type GetFrequencySX(bool tx);
int SetFrequencySX(bool tx, float_type freq_Hz, SX_details* output = nullptr);
int SetFrequencySXWithSpurCancelation(bool tx, float_type freq_Hz, float_type BW);
bool GetSXLocked(bool tx);
///VCO modules available for tuning
enum VCO_Module
{
VCO_CGEN, VCO_SXR, VCO_SXT
};
int TuneVCO(VCO_Module module);
///@}
///@name TSP
int LoadDC_REG_IQ(bool tx, int16_t I, int16_t Q);
int SetNCOFrequency(bool tx, uint8_t index, float_type freq_Hz);
float_type GetNCOFrequency(bool tx, uint8_t index, bool fromChip = true);
int SetNCOPhaseOffsetForMode0(bool tx, float_type angle_Deg);
int SetNCOPhaseOffset(bool tx, uint8_t index, float_type angle_Deg);
float_type GetNCOPhaseOffset_Deg(bool tx, uint8_t index);
int SetGFIRCoefficients(bool tx, uint8_t GFIR_index, const int16_t *coef, uint8_t coefCount);
int GetGFIRCoefficients(bool tx, uint8_t GFIR_index, int16_t *coef, uint8_t coefCount);
float_type GetReferenceClk_TSP(bool tx);
///@}
int SetInterfaceFrequency(float_type cgen_freq_Hz, const uint8_t interpolation, const uint8_t decimation);
//! Get the sample rate in Hz
float_type GetSampleRate(bool tx, Channel ch);
///@name LML
enum LMLSampleSource
{
AI = 0,
AQ = 1,
BI = 2,
BQ = 3,
};
/*!
* Set the LML sample positions in the RF to baseband direction.
*/
void ConfigureLML_RF2BB(
const LMLSampleSource s0,
const LMLSampleSource s1,
const LMLSampleSource s2,
const LMLSampleSource s3);
/*!
* Set the LML sample positions in the baseband to RF direction.
*/
void ConfigureLML_BB2RF(
const LMLSampleSource s0,
const LMLSampleSource s1,
const LMLSampleSource s2,
const LMLSampleSource s3);
///@}
/*!
* Set enable for the RX DC removal filter.
* @param enable true to enable DC removal
* @return 0 for success for error condition
*/
int SetRxDCRemoval(const bool enable);
/*!
* Get the RX DC removal filter enabled.
*/
bool GetRxDCRemoval(void);
/*!
* Set the TX DC offset adjustment.
* @param I the real adjustment [+1.0, -1.0]
* @param Q the imaginary adjustment [+1.0, -1.0]
* @return 0 for success for error condition
*/
int SetTxDCOffset(const float_type I, const float_type Q);
/*!
* Readback the TX DC offset adjustment.
* @param [out] I the real adjustment [+1.0, -1.0]
* @param [out] Q the imaginary adjustment [+1.0, -1.0]
*/
void GetTxDCOffset(float_type &I, float_type &Q);
/*!
* Set the IQ imbalance correction.
* @param tx true for tx, false for rx
* @param phase the phase adjustment [+pi, -pi]
* @param gainI the real gain adjustment [+1.0, 0.0]
* @param gainQ the imaginary gain adjustment [+1.0, 0.0]
*/
int SetIQBalance(const bool tx, const float_type phase, const float_type gainI, const float_type gainQ);
/*!
* Get the IQ imbalance correction.
* @param tx true for tx, false for rx
* @param [out] phase the phase adjustment [+pi, -pi]
* @param [out] gainI the real gain adjustment [+1.0, 0.0]
* @param [out] gainQ the imaginary gain adjustment [+1.0, 0.0]
*/
void GetIQBalance(const bool tx, float_type &phase, float_type &gainI, float_type &gainQ);
///enumeration to indicate module registers intervals
enum MemorySection
{
LimeLight = 0, EN_DIR, AFE, BIAS, XBUF, CGEN, LDO, BIST, CDS,
TRF, TBB, RFE, RBB, SX, TRX_GAIN, TxTSP,
TxNCO, TxGFIR1, TxGFIR2, TxGFIR3a, TxGFIR3b, TxGFIR3c,
RxTSP, RxNCO, RxGFIR1, RxGFIR2, RxGFIR3a, RxGFIR3b, RxGFIR3c,
RSSI_DC_CALIBRATION, RSSI_PDET_TEMP_CONFIG, RSSI_DC_CONFIG,
MEMORY_SECTIONS_COUNT
};
virtual int SetDefaults(MemorySection module);
static float_type gVCO_frequency_table[3][2];
static float_type gCGEN_VCO_frequencies[2];
void EnableValuesCache(bool enabled = true);
bool IsValuesCacheEnabled();
MCU_BD* GetMCUControls() const;
void EnableCalibrationByMCU(bool enabled);
float_type GetTemperature();
enum LogType
{
LOG_INFO,
LOG_WARNING,
LOG_ERROR,
LOG_DATA
};
void SetLogCallback(std::function<void(const char*, int)> callback);
LMS7002M_RegistersMap *BackupRegisterMap(void);
void RestoreRegisterMap(LMS7002M_RegistersMap *backup);
protected:
bool mCalibrationByMCU;
MCU_BD *mcuControl;
bool useCache;
CalibrationCache *mValueCache;
LMS7002M_RegistersMap *mRegistersMap;
static const uint16_t readOnlyRegisters[];
static const uint16_t readOnlyRegistersMasks[];
uint16_t MemorySectionAddresses[MEMORY_SECTIONS_COUNT][2];
///@name Algorithms functions
void BackupAllRegisters();
void RestoreAllRegisters();
uint32_t GetRSSI(RSSI_measurements *measurements = nullptr);
uint32_t GetAvgRSSI(const int avgCount);
void SetRxDCOFF(int8_t offsetI, int8_t offsetQ);
void CalibrateRxDC();
void AdjustAutoDC(const uint16_t address, bool tx);
void CalibrateRxDCAuto();
void CalibrateTxDCAuto();
void CalibrateTxDC(int16_t *dccorri, int16_t *dccorrq);
void CalibrateIQImbalance(const bool tx, uint16_t *gainI=nullptr, uint16_t *gainQ=nullptr, int16_t *phase=nullptr);
int CalibrateTxSetup(const float_type bandwidth_Hz, const bool useExtLoopback);
int CalibrateRxSetup(const float_type bandwidth_Hz, const bool useExtLoopback);
int CheckSaturationRx(const float_type bandwidth_Hz, const bool useExtLoopback);
int CheckSaturationTxRx(const float_type bandwidth_Hz, const bool useExtLoopback);
int CalibrateTxGainSetup();
void BinarySearch(BinSearchParam* args);
void TxDcBinarySearch(BinSearchParam* args);
void GridSearch(GridSearchParam* args);
void CoarseSearch(const uint16_t addr, const uint8_t msb, const uint8_t lsb, int16_t &value, const uint8_t maxIterations);
void FineSearch(const uint16_t addrI, const uint8_t msbI, const uint8_t lsbI, int16_t &valueI, const uint16_t addrQ, const uint8_t msbQ, const uint8_t lsbQ, int16_t &valueQ, const uint8_t fieldSize);
int RxFilterSearch(const LMS7Parameter ¶m, const uint32_t rssi_3dB, uint8_t rssiAvgCnt, const int stepLimit);
int TxFilterSearch(const LMS7Parameter ¶m, const uint32_t rssi_3dB, uint8_t rssiAvgCnt, const int stepLimit);
int TxFilterSearch_S5(const LMS7Parameter ¶m, const uint32_t rssi_3dB, uint8_t rssiAvgCnt, const int stepLimit);
int TuneRxFilterSetup(const float_type rx_lpf_IF);
int TuneTxFilterSetup(const float_type tx_lpf_IF);
int RegistersTestInterval(uint16_t startAddr, uint16_t endAddr, uint16_t pattern, std::stringstream &ss);
int SPI_write_batch(const uint16_t* spiAddr, const uint16_t* spiData, uint16_t cnt);
int SPI_read_batch(const uint16_t* spiAddr, uint16_t* spiData, uint16_t cnt);
int Modify_SPI_Reg_mask(const uint16_t *addr, const uint16_t *masks, const uint16_t *values, uint8_t start, uint8_t stop);
///@}
virtual void Log(const char* text, LogType type);
void Log(LogType type, const char *format, ...)
{
va_list argList;
va_start(argList, format);
Log(type, format, argList);
va_end(argList);
}
std::function<void(const char*, int)> log_callback;
void Log(LogType type, const char *format, va_list argList);
///port used for communicating with LMS7002M
IConnection* controlPort;
unsigned mdevIndex;
size_t mSelfCalDepth;
int LoadConfigLegacyFile(const char* filename);
};
/*!
* Helper class to enter a calibration upon construction,
* and to automatically exit calibration upon exit.
*/
class LIME_API LMS7002M_SelfCalState
{
public:
LMS7002M_SelfCalState(LMS7002M *rfic);
~LMS7002M_SelfCalState(void);
private:
LMS7002M *rfic;
};
}
#endif
|