S2LP_Radio.h

Go to the documentation of this file.

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __S2LP_RADIO_H
#define __S2LP_RADIO_H


/* Includes ------------------------------------------------------------------*/
#include "S2LP_Regs.h"
#include "S2LP_Types.h"


#ifdef __cplusplus
extern "C" {
#endif


typedef enum {
  MOD_NO_MOD       = 0x70, 
  MOD_2FSK         = 0x00, 
  MOD_4FSK         = 0x10, 
  MOD_2GFSK_BT05   = 0xA0, 
  MOD_2GFSK_BT1    = 0x20, 
  MOD_4GFSK_BT05   = 0xB0, 
  MOD_4GFSK_BT1    = 0x30, 
  MOD_ASK_OOK      = 0x50, 
  MOD_POLAR        = 0x60, 
} ModulationSelect;


typedef struct {
  uint32_t          lFrequencyBase;     
  ModulationSelect  xModulationSelect;  
  uint32_t          lDatarate;          
  uint32_t          lFreqDev;           
  uint32_t          lBandwidth;         
} SRadioInit;


typedef enum {
  AFC_MODE_LOOP_CLOSED_ON_SLICER = 0,     /* loop closed on slicer */
  AFC_MODE_LOOP_CLOSED_ON_2ND_CONV_STAGE  /* loop closed on 2nd conversion stage */
} SAfcMode;


typedef struct {
  SFunctionalState  xAfcEnable;       
  SFunctionalState  xAfcFreezeOnSync; 
  SAfcMode          xAfcMode;         
  uint8_t          cAfcFastPeriod;    
  uint8_t          cAfcFastGain;      
  uint8_t          cAfcSlowGain;      
} SAfcInit;


typedef enum {
  ISI_EQUALIZATION_DISABLED = 0,  /* static mode */
  ISI_EQUALIZATION_SINGLE_PASS,   /* dynamic mode 6 dB above threshold*/
  ISI_EQUALIZATION_DUAL_PASS      /* dynamic mode 18 dB above threshold */
} SIsiEqu;


typedef enum {
  CLKREC_DLL_MODE = 0, /* DLL mode */
  CLKREC_PLL_MODE,     /* PLL mode */
} SClkRecMode;


typedef struct {
  SClkRecMode      xSClkRecMode;          
  uint8_t          cClkRecPGainSlow;      
  uint8_t          cClkRecPGainFast;      
  uint8_t          cClkRecIGainSlow;      
  uint8_t          cClkRecIGainFast;      
  SFunctionalState cClkRec16SymPostFlt;   
} SSymClkRecInit;


uint8_t S2LPRadioInit(SRadioInit* pxSRadioInitStruct);
void S2LPRadioGetInfo(SRadioInit* pxSRadioInitStruct);
void S2LPRadioSetSynthWord(uint32_t lSynthWord);
uint32_t S2LPRadioGetSynthWord(void);
void S2LPRadioSetChannel(uint8_t cChannel);
uint8_t S2LPRadioGetChannel(void);
void S2LPRadioSetRefDiv(SFunctionalState xNewState);
SFunctionalState S2LPRadioGetRefDiv(void);
void S2LPRadioSetDigDiv(SFunctionalState xNewState);
SFunctionalState S2LPRadioGetDigDiv(void);
void S2LPRadioSetChannelSpace(uint32_t lChannelSpace);
uint32_t S2LPRadioGetChannelSpace(void);
uint8_t S2LPRadioSetFrequencyBase(uint32_t lFBase);
uint32_t S2LPRadioGetFrequencyBase(void);
void S2LPRadioSetDatarate(uint32_t lDatarate);
uint32_t S2LPRadioGetDatarate(void);
void S2LPRadioSetFrequencyDev(uint32_t lFDev);
uint32_t S2LPRadioGetFrequencyDev(void);
void S2LPRadioSetChannelBW(uint32_t lBandwidth);
uint32_t S2LPRadioGetChannelBW(void);
void S2LPRadioSetModulation(ModulationSelect xModulation);
ModulationSelect S2LPRadioGetModulation(void);
void S2LPRadioSetXtalFrequency(uint32_t lXtalFrequency);
uint32_t S2LPRadioGetXtalFrequency(void);
void S2LPRadioSetIsiEqualizationMode(SIsiEqu xSIsiMode);
SIsiEqu S2LPRadioGetIsiEqualizationMode(void);
void S2LPRadioCalibrationVco(SFunctionalState xAmplitudeCalibration, SFunctionalState xFrequencyCalibration);
void S2LPRadioSetTxCalibVcoAmpWord(uint8_t value);
void S2LPRadioSetRxCalibVcoAmpWord(uint8_t value);
void S2LPRadioSetTxCalibVcoFreqWord(uint8_t value);
void S2LPRadioSetRxCalibVcoFreqWord(uint8_t value);

void S2LPRadioSetMaxPALevel(SFunctionalState xNewState);
void S2LPRadioSetPALeveldBm(uint8_t cIndex, int32_t wPowerdBm);
int32_t S2LPRadioGetPALeveldBm(uint8_t cIndex);
uint8_t S2LPRadioGetPALevelMaxIndex(void);
void S2LPRadioSetPALevelMaxIndex(uint8_t cIndex);
void S2LPRadioSetManualRampingMode(SFunctionalState xNewState);
void S2LPRadioSetAutoRampingMode(SFunctionalState xNewState);

void S2LPRadioAfcInit(SAfcInit* xSAfcInit);
void S2LPRadioGetAfcInfo(SAfcInit* xSAfcInit);
void S2LPRadioSymClkRecoverInit(SSymClkRecInit* xSSymClkRecInit);
void S2LPRadioGetSymClkRecoverInfo(SSymClkRecInit* xSSymClkRecInit);


#ifdef __cplusplus
}
#endif

#endif

/******************* (C) COPYRIGHT 2016 STMicroelectronics *****END OF FILE****/