LRFLPF3_Interface_Generic.h File Reference

#include <stdint.h>
#include <ti/drivers/rcl/LRF.h>
#include <ti/drivers/rcl/lrf/LRFLPF3_Interface.h>
#include <ti/devices/DeviceFamily.h>

Include dependency graph for LRFLPF3_Interface_Generic.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	LRF_SyncSearchCtrl
struct	LRF_ModulationCtrl

Macros
#define	LRF_INTERFACE_GENERIC_API_OP_PING   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_PING))
#define	LRF_INTERFACE_GENERIC_API_OP_STOP   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_STOP))
#define	LRF_INTERFACE_GENERIC_API_OP_EOP_STOP   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_EOPSTOP))
#define	LRF_INTERFACE_GENERIC_API_OP_TX   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_TX))
#define	LRF_INTERFACE_GENERIC_API_OP_RX   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_RX))
#define	LRF_INTERFACE_GENERIC_API_OP_FS   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_FS))
#define	LRF_INTERFACE_GENERIC_API_OP_STOP_FS   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_STOPFS))
#define	LRFDRFE_SPARE4_SYNTHLOCK_M   (0x00000001U)
#define	LRFDRFE_SPARE4_SYNTHLOCK_NOT_LOCKED   (0x00000000U)
#define	LRF_INTERFACE_GENERIC_PRBS15_POLY   (0x80020000U)
#define	LRF_INTERFACE_GENERIC_PRBS32_POLY   (0x00400007U)
#define	LRF_INTERFACE_GENERIC_PRBS_INIT   (0x00005555U)
#define	LRF_INTERFACE_GENERIC_PRBS_SYNC   (0xAB05FA1CU)
#define	LRF_INTERFACE_GENERIC_MODULATION_RESTORE_NONE   (0x0000U)
#define	LRF_INTERFACE_GENERIC_MODULATION_RESTORE_MODCTRL   (0x0001U)
#define	LRF_INTERFACE_GENERIC_MODULATION_RESTORE_WHITEN_INIT   (0x0002U)
#define	LRF_INTERFACE_GENERIC_MODULATION_RESTORE_WHITEN_POLY   (0x0004U)

Functions
void	LRF_Interface_Generic_configOpNesbPrx (uint16_t lrfOpCfg, uint8_t addrLen, const RCL_ConfigAddress *syncWordCfg)
void	LRF_Interface_Generic_setModulationMode (uint32_t sendCw, uint32_t whitenMode, LRF_ModulationCtrl *modulationCtrl)
void	LRF_Interface_Generic_disableSyncSearch (bool disableSyncWordA, bool disableSyncWordB, LRF_SyncSearchCtrl *syncSearchCtrl)
void	LRF_Interface_Generic_updateSyncWordCfg (RCL_ConfigAddress *syncWordCfg)
static void	LRF_Interface_Generic_sendOpFs (void)
static void	LRF_Interface_Generic_sendOpTx (void)
static void	LRF_Interface_Generic_sendOpRx (void)
static void	LRF_Interface_Generic_sendOpFsOff (void)
static void	LRF_Interface_Generic_sendOpStop (void)
static void	LRF_Interface_Generic_sendOpEopStop (void)
static void	LRF_Interface_Generic_skipFreqProgramming (void)
static uint32_t	LRF_Interface_Generic_getLastPacketTimestamp (void)
static void	LRF_Interface_Generic_setLastPacketTimestamp (uint32_t timestamp)
static int8_t	LRF_Interface_Generic_getLastPacketRssi (void)
static uint16_t	LRF_Interface_Generic_getNumOfRxOkPackets (void)
static void	LRF_Interface_Generic_setNumOfRxOkPackets (uint16_t numOfRxOkPackets)
static uint16_t	LRF_Interface_Generic_getNumOfNotRxOkPackets (void)
static void	LRF_Interface_Generic_setNumOfNotRxOkPackets (uint16_t numOfNotRxOkPackets)
static uint16_t	LRF_Interface_Generic_getNumOfTxPackets (void)
static void	LRF_Interface_Generic_setNumOfTxPackets (uint16_t numOfTxPackets)
static uint16_t	LRF_Interface_Generic_getNumOfIgnoredRxPackets (void)
static void	LRF_Interface_Generic_setNumOfIgnoredRxPackets (uint16_t numOfIgnoredRxPackets)
static uint16_t	LRF_Interface_Generic_getRxFifoFullCount (void)
static void	LRF_Interface_Generic_setRxFifoFullCount (uint16_t rxBufferFullCount)
static bool	LRF_Interface_Generic_shouldNesbListenForAck (uint8_t mode)
static uint16_t	LRF_Interface_Generic_getFifoCfg (void)
static void	LRF_Interface_Generic_configOpFs ()
static void	LRF_Interface_Generic_configOpFsOff ()
static bool	LRF_Interface_Generic_isFreqSynthLocked (void)
static void	LRF_Interface_Generic_configOpTx (uint8_t fsOff, uint32_t freqInHz)
static void	LRF_Interface_Generic_configOpTxRepeat (uint32_t freqInHz, uint8_t fsRecal)
static void	LRF_Interface_Generic_configOpTxTest (uint8_t fsOff, uint32_t freqInHz, uint16_t txWord)
static void	LRF_Interface_Generic_configOpRx (uint8_t fsOff, uint32_t freqInHz, uint8_t repeated, uint16_t maxPktLen)
static void	LRF_Interface_Generic_configOpNesbPtx (uint8_t fsOff, uint32_t freqInHz, uint8_t autoRetransmitMode)
static uint16_t	LRF_Interface_Generic_getOpCfgNesbPrx (uint8_t fsOff, uint32_t freqInHz, uint8_t repeatNok, uint8_t repeatOk)
static void	LRF_Interface_Generic_configNextOpTx (void)
static uint32_t	LRF_Interface_Generic_updateSyncWord (uint32_t syncWord)
static void	LRF_Interface_Generic_programSyncWordA (uint32_t syncWord)
static void	LRF_Interface_Generic_programSyncWordB (uint32_t syncWord)
static uint32_t	LRF_Interface_Generic_maskEventsByFifoConf (uint32_t mask, uint16_t fifoCfg, bool activeUpdate)
static void	LRF_Interface_Generic_restoreSyncSearch (const LRF_SyncSearchCtrl *syncSearchCtrl)
static void	LRF_Interface_Generic_restoreModulationMode (const LRF_ModulationCtrl *modulationCtrl)

---

Data Structure Documentation

LRF_SYNC_SEARCH_CTRL_t

struct LRF_SYNC_SEARCH_CTRL_t

NOTE: RCL_ConfigAddress is defined in 'rcl/commands/generic.h'

Data Fields
uint16_t	demc1be1
uint16_t	demc1be2
uint16_t	demc1be12
uint16_t	restoreThresh: 1

LRF_MODULATION_CTRL_t

struct LRF_MODULATION_CTRL_t

Data Fields
uint16_t	restoreOpt
uint16_t	storedWhitenInit
uint32_t	storedWhitenPoly

Macro Definition Documentation

LRF_INTERFACE_GENERIC_API_OP_PING

#define LRF_INTERFACE_GENERIC_API_OP_PING   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_PING))

LRF_INTERFACE_GENERIC_API_OP_STOP

#define LRF_INTERFACE_GENERIC_API_OP_STOP   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_STOP))

LRF_INTERFACE_GENERIC_API_OP_EOP_STOP

#define LRF_INTERFACE_GENERIC_API_OP_EOP_STOP   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_EOPSTOP))

LRF_INTERFACE_GENERIC_API_OP_TX

#define LRF_INTERFACE_GENERIC_API_OP_TX   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_TX))

LRF_INTERFACE_GENERIC_API_OP_RX

#define LRF_INTERFACE_GENERIC_API_OP_RX   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_RX))

LRF_INTERFACE_GENERIC_API_OP_FS

#define LRF_INTERFACE_GENERIC_API_OP_FS   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_FS))

LRF_INTERFACE_GENERIC_API_OP_STOP_FS

#define LRF_INTERFACE_GENERIC_API_OP_STOP_FS   ((uint16_t)(PBE_GENERIC_REGDEF_API_OP_STOPFS))

LRFDRFE_SPARE4_SYNTHLOCK_M

#define LRFDRFE_SPARE4_SYNTHLOCK_M   (0x00000001U)

Referenced by LRF_Interface_Generic_isFreqSynthLocked().

LRFDRFE_SPARE4_SYNTHLOCK_NOT_LOCKED

#define LRFDRFE_SPARE4_SYNTHLOCK_NOT_LOCKED   (0x00000000U)

Referenced by LRF_Interface_Generic_isFreqSynthLocked().

LRF_INTERFACE_GENERIC_PRBS15_POLY

#define LRF_INTERFACE_GENERIC_PRBS15_POLY   (0x80020000U)

Referenced by LRF_Interface_Generic_setModulationMode().

LRF_INTERFACE_GENERIC_PRBS32_POLY

#define LRF_INTERFACE_GENERIC_PRBS32_POLY   (0x00400007U)

Referenced by LRF_Interface_Generic_setModulationMode().

LRF_INTERFACE_GENERIC_PRBS_INIT

#define LRF_INTERFACE_GENERIC_PRBS_INIT   (0x00005555U)

Referenced by LRF_Interface_Generic_setModulationMode().

LRF_INTERFACE_GENERIC_PRBS_SYNC

#define LRF_INTERFACE_GENERIC_PRBS_SYNC   (0xAB05FA1CU)

Referenced by RCL_Handler_Generic_TxTest().

LRF_INTERFACE_GENERIC_MODULATION_RESTORE_NONE

#define LRF_INTERFACE_GENERIC_MODULATION_RESTORE_NONE   (0x0000U)

LRF_INTERFACE_GENERIC_MODULATION_RESTORE_MODCTRL

#define LRF_INTERFACE_GENERIC_MODULATION_RESTORE_MODCTRL   (0x0001U)

Referenced by LRF_Interface_Generic_restoreModulationMode(), and LRF_Interface_Generic_setModulationMode().

LRF_INTERFACE_GENERIC_MODULATION_RESTORE_WHITEN_INIT

#define LRF_INTERFACE_GENERIC_MODULATION_RESTORE_WHITEN_INIT   (0x0002U)

Referenced by LRF_Interface_Generic_restoreModulationMode(), and LRF_Interface_Generic_setModulationMode().

LRF_INTERFACE_GENERIC_MODULATION_RESTORE_WHITEN_POLY

#define LRF_INTERFACE_GENERIC_MODULATION_RESTORE_WHITEN_POLY   (0x0004U)

Referenced by LRF_Interface_Generic_restoreModulationMode(), and LRF_Interface_Generic_setModulationMode().

Function Documentation

LRF_Interface_Generic_configOpNesbPrx()

void LRF_Interface_Generic_configOpNesbPrx	(	uint16_t	lrfOpCfg,
		uint8_t	addrLen,
		const RCL_ConfigAddress *	syncWordCfg
	)

Referenced by RCL_Handler_Nesb_Prx().

LRF_Interface_Generic_setModulationMode()

void LRF_Interface_Generic_setModulationMode	(	uint32_t	sendCw,
		uint32_t	whitenMode,
		LRF_ModulationCtrl *	modulationCtrl
	)

References LRF_INTERFACE_GENERIC_MODULATION_RESTORE_MODCTRL, LRF_INTERFACE_GENERIC_MODULATION_RESTORE_WHITEN_INIT, LRF_INTERFACE_GENERIC_MODULATION_RESTORE_WHITEN_POLY, LRF_INTERFACE_GENERIC_PRBS15_POLY, LRF_INTERFACE_GENERIC_PRBS32_POLY, LRF_INTERFACE_GENERIC_PRBS_INIT, RCL_CMD_GENERIC_WH_MODE_NONE, and RCL_CMD_GENERIC_WH_MODE_PRBS15.

Referenced by RCL_Handler_Generic_TxTest().

LRF_Interface_Generic_disableSyncSearch()

void LRF_Interface_Generic_disableSyncSearch	(	bool	disableSyncWordA,
		bool	disableSyncWordB,
		LRF_SyncSearchCtrl *	syncSearchCtrl
	)

Referenced by RCL_Handler_Generic_Rx(), and RCL_Handler_Nesb_Prx().

LRF_Interface_Generic_updateSyncWordCfg()

void LRF_Interface_Generic_updateSyncWordCfg

(

RCL_ConfigAddress *

syncWordCfg

)

Referenced by RCL_Handler_Nesb_Prx().

LRF_Interface_Generic_sendOpFs()

static void LRF_Interface_Generic_sendOpFs ( void  )

inlinestatic

References LRF_Interface_sendOp().

Referenced by RCL_Handler_Generic_Fs().

LRF_Interface_Generic_sendOpTx()

static void LRF_Interface_Generic_sendOpTx ( void  )

inlinestatic

References LRF_Interface_sendOp().

Referenced by RCL_Handler_Generic_Tx(), RCL_Handler_Generic_TxRepeat(), RCL_Handler_Generic_TxTest(), and RCL_Handler_Nesb_Ptx().

LRF_Interface_Generic_sendOpRx()

static void LRF_Interface_Generic_sendOpRx ( void  )

inlinestatic

References LRF_Interface_sendOp().

Referenced by RCL_Handler_Generic_Rx(), and RCL_Handler_Nesb_Prx().

LRF_Interface_Generic_sendOpFsOff()

static void LRF_Interface_Generic_sendOpFsOff ( void  )

inlinestatic

References LRF_Interface_sendOp().

Referenced by RCL_Handler_Generic_FsOff(), and RCL_Handler_Generic_TxRepeat().

LRF_Interface_Generic_sendOpStop()

static void LRF_Interface_Generic_sendOpStop ( void  )

inlinestatic

References LRF_Interface_sendOp().

Referenced by RCL_Handler_Generic_Rx(), RCL_Handler_Nesb_Prx(), and RCL_Handler_Nesb_Ptx().

LRF_Interface_Generic_sendOpEopStop()

static void LRF_Interface_Generic_sendOpEopStop ( void  )

inlinestatic

References LRF_Interface_sendOp().

LRF_Interface_Generic_skipFreqProgramming()

static void LRF_Interface_Generic_skipFreqProgramming ( void  )

inlinestatic

Referenced by RCL_Handler_Generic_TxRepeat().

LRF_Interface_Generic_getLastPacketTimestamp()

static uint32_t LRF_Interface_Generic_getLastPacketTimestamp ( void  )

inlinestatic

Referenced by RCL_Handler_Generic_updateRxStats(), and RCL_Handler_Nesb_updateStats().

LRF_Interface_Generic_setLastPacketTimestamp()

static void LRF_Interface_Generic_setLastPacketTimestamp ( uint32_t  timestamp )

inlinestatic

Referenced by RCL_Handler_Generic_initRxStats(), and RCL_Handler_Nesb_initStats().

LRF_Interface_Generic_getLastPacketRssi()

static int8_t LRF_Interface_Generic_getLastPacketRssi ( void  )

inlinestatic

Referenced by RCL_Handler_Generic_updateRxStats(), and RCL_Handler_Nesb_updateStats().

LRF_Interface_Generic_getNumOfRxOkPackets()

static uint16_t LRF_Interface_Generic_getNumOfRxOkPackets ( void  )

inlinestatic

Referenced by RCL_Handler_Generic_updateLongStats(), and RCL_Handler_Nesb_updateLongStats().

LRF_Interface_Generic_setNumOfRxOkPackets()

static void LRF_Interface_Generic_setNumOfRxOkPackets ( uint16_t  numOfRxOkPackets )

inlinestatic

Referenced by RCL_Handler_Generic_initRxStats(), and RCL_Handler_Nesb_initStats().

LRF_Interface_Generic_getNumOfNotRxOkPackets()

static uint16_t LRF_Interface_Generic_getNumOfNotRxOkPackets ( void  )

inlinestatic

Referenced by RCL_Handler_Generic_updateLongStats(), and RCL_Handler_Nesb_updateLongStats().

LRF_Interface_Generic_setNumOfNotRxOkPackets()

static void LRF_Interface_Generic_setNumOfNotRxOkPackets ( uint16_t  numOfNotRxOkPackets )

inlinestatic

Referenced by RCL_Handler_Generic_initRxStats(), and RCL_Handler_Nesb_initStats().

LRF_Interface_Generic_getNumOfTxPackets()

static uint16_t LRF_Interface_Generic_getNumOfTxPackets ( void  )

inlinestatic

Referenced by RCL_Handler_Nesb_updateLongStats().

LRF_Interface_Generic_setNumOfTxPackets()

static void LRF_Interface_Generic_setNumOfTxPackets ( uint16_t  numOfTxPackets )

inlinestatic

Referenced by RCL_Handler_Nesb_initStats().

LRF_Interface_Generic_getNumOfIgnoredRxPackets()

static uint16_t LRF_Interface_Generic_getNumOfIgnoredRxPackets ( void  )

inlinestatic

Referenced by RCL_Handler_Nesb_updateLongStats().

LRF_Interface_Generic_setNumOfIgnoredRxPackets()

static void LRF_Interface_Generic_setNumOfIgnoredRxPackets ( uint16_t  numOfIgnoredRxPackets )

inlinestatic

Referenced by RCL_Handler_Nesb_initStats().

LRF_Interface_Generic_getRxFifoFullCount()

static uint16_t LRF_Interface_Generic_getRxFifoFullCount ( void  )

inlinestatic

Referenced by RCL_Handler_Nesb_updateLongStats().

LRF_Interface_Generic_setRxFifoFullCount()

static void LRF_Interface_Generic_setRxFifoFullCount ( uint16_t  rxBufferFullCount )

inlinestatic

Referenced by RCL_Handler_Nesb_initStats().

LRF_Interface_Generic_shouldNesbListenForAck()

static bool LRF_Interface_Generic_shouldNesbListenForAck ( uint8_t  mode )

inlinestatic

Referenced by RCL_Handler_Nesb_Ptx().

LRF_Interface_Generic_getFifoCfg()

static uint16_t LRF_Interface_Generic_getFifoCfg ( void  )

inlinestatic

Referenced by RCL_Handler_Generic_Rx(), RCL_Handler_Nesb_Prx(), and RCL_Handler_Nesb_Ptx().

LRF_Interface_Generic_configOpFs()

static void LRF_Interface_Generic_configOpFs ( )

inlinestatic

Referenced by RCL_Handler_Generic_Fs().

LRF_Interface_Generic_configOpFsOff()

static void LRF_Interface_Generic_configOpFsOff ( )

inlinestatic

Referenced by RCL_Handler_Generic_FsOff().

LRF_Interface_Generic_isFreqSynthLocked()

static bool LRF_Interface_Generic_isFreqSynthLocked ( void  )

inlinestatic

References LRFDRFE_SPARE4_SYNTHLOCK_M, and LRFDRFE_SPARE4_SYNTHLOCK_NOT_LOCKED.

Referenced by RCL_Handler_Generic_Rx(), RCL_Handler_Generic_Tx(), RCL_Handler_Generic_TxRepeat(), RCL_Handler_Generic_TxTest(), RCL_Handler_Nesb_Prx(), and RCL_Handler_Nesb_Ptx().

LRF_Interface_Generic_configOpTx()

static void LRF_Interface_Generic_configOpTx ( uint8_t  fsOff, uint32_t  freqInHz  )

inlinestatic

Referenced by RCL_Handler_Generic_Tx().

LRF_Interface_Generic_configOpTxRepeat()

static void LRF_Interface_Generic_configOpTxRepeat ( uint32_t  freqInHz, uint8_t  fsRecal  )

inlinestatic

Referenced by RCL_Handler_Generic_TxRepeat().

LRF_Interface_Generic_configOpTxTest()

static void LRF_Interface_Generic_configOpTxTest ( uint8_t  fsOff, uint32_t  freqInHz, uint16_t  txWord  )

inlinestatic

Referenced by RCL_Handler_Generic_TxTest().

LRF_Interface_Generic_configOpRx()

static void LRF_Interface_Generic_configOpRx ( uint8_t  fsOff, uint32_t  freqInHz, uint8_t  repeated, uint16_t  maxPktLen  )

inlinestatic

Referenced by RCL_Handler_Generic_Rx().

LRF_Interface_Generic_configOpNesbPtx()

static void LRF_Interface_Generic_configOpNesbPtx ( uint8_t  fsOff, uint32_t  freqInHz, uint8_t  autoRetransmitMode  )

inlinestatic

Referenced by RCL_Handler_Nesb_Ptx().

LRF_Interface_Generic_getOpCfgNesbPrx()

static uint16_t LRF_Interface_Generic_getOpCfgNesbPrx ( uint8_t  fsOff, uint32_t  freqInHz, uint8_t  repeatNok, uint8_t  repeatOk  )

inlinestatic

Referenced by RCL_Handler_Nesb_Prx().

LRF_Interface_Generic_configNextOpTx()

static void LRF_Interface_Generic_configNextOpTx ( void  )

inlinestatic

Referenced by RCL_Handler_Generic_TxRepeat(), and RCL_Handler_Nesb_Ptx().

LRF_Interface_Generic_updateSyncWord()

static uint32_t LRF_Interface_Generic_updateSyncWord ( uint32_t  syncWord )

inlinestatic

Referenced by LRF_Interface_Generic_programSyncWordA(), and LRF_Interface_Generic_programSyncWordB().

LRF_Interface_Generic_programSyncWordA()

static void LRF_Interface_Generic_programSyncWordA ( uint32_t  syncWord )

inlinestatic

References LRF_Interface_Generic_updateSyncWord(), and LRF_Interface_programSyncWordA().

Referenced by RCL_Handler_Generic_Rx(), RCL_Handler_Generic_Tx(), RCL_Handler_Generic_TxRepeat(), RCL_Handler_Generic_TxTest(), RCL_Handler_Nesb_Prx(), and RCL_Handler_Nesb_Ptx().

LRF_Interface_Generic_programSyncWordB()

static void LRF_Interface_Generic_programSyncWordB ( uint32_t  syncWord )

inlinestatic

References LRF_Interface_Generic_updateSyncWord(), and LRF_Interface_programSyncWordB().

Referenced by RCL_Handler_Generic_Rx(), RCL_Handler_Nesb_Prx(), and RCL_Handler_Nesb_Ptx().

LRF_Interface_Generic_maskEventsByFifoConf()

static uint32_t LRF_Interface_Generic_maskEventsByFifoConf ( uint32_t  mask, uint16_t  fifoCfg, bool  activeUpdate  )

inlinestatic

References LRF_EventRxBufFull, and LRF_EventRxIgnored.

Referenced by RCL_Handler_Generic_Rx(), RCL_Handler_Nesb_Prx(), and RCL_Handler_Nesb_Ptx().

LRF_Interface_Generic_restoreSyncSearch()

static void LRF_Interface_Generic_restoreSyncSearch ( const LRF_SyncSearchCtrl *  syncSearchCtrl )

inlinestatic

Referenced by RCL_Handler_Generic_Rx(), and RCL_Handler_Nesb_Prx().

LRF_Interface_Generic_restoreModulationMode()

static void LRF_Interface_Generic_restoreModulationMode ( const LRF_ModulationCtrl *  modulationCtrl )

inlinestatic

References LRF_INTERFACE_GENERIC_MODULATION_RESTORE_MODCTRL, LRF_INTERFACE_GENERIC_MODULATION_RESTORE_WHITEN_INIT, and LRF_INTERFACE_GENERIC_MODULATION_RESTORE_WHITEN_POLY.

Referenced by RCL_Handler_Generic_TxTest().