TOF.h

Go to the documentation of this file.

/******************************************************************************

 @file  TOF.h

 @brief This file contains methods to enable/disable and control TOF
 Group: WCS, BTS
 $Target Device: DEVICES $

 ******************************************************************************
 $License: BSD3 2018 $
 ******************************************************************************
 $Release Name: PACKAGE NAME $
 $Release Date: PACKAGE RELEASE DATE $
 *****************************************************************************/

#ifndef TOF_H_
#define TOF_H_

#ifdef __cplusplus
extern "C"
{
#endif

/*********************************************************************
 * INCLUDES
 */

/* RF includes */
#include <ti/drivers/rf/RF.h>

#include <ti/devices/DeviceFamily.h>
#include "tof/rfc_cmd_tof.h"
#include "tof/tof_security.h"

/*********************************************************************
 * CONSTANTS
 */

#define TOF_TIMEOUTVAL       0xFFFFFFFF         

#define TOF_MAX_NUM_FREQ        20              

#define TOF_SEEDLEN             32              

#define TOF_NUM_RFC_BURST_PKTS  32              

#define TOF_COMPENSATION_NO_COMP         0      
#define TOF_COMPENSATION_STIM_COMP       1      
#define TOF_COMPENSATION_CORRELATOR_COMP 2      

// If using partial result readout or double sync word buffer, these are the event ID's
#define IRQN_PARTIAL_READ_READY             15  
#define IRQN_DOUBLE_SYNCWORD_BUFFER_SWITCH  11  
#define RF_EventPartialReadReady            (1 << IRQN_PARTIAL_READ_READY) 
#define RF_EventDoubleSyncWordBufferSwitch  (1 << IRQN_DOUBLE_SYNCWORD_BUFFER_SWITCH) 

#define TOF_FILL_BOTH_BUFF      TOF_SEC_FILL_BOTH_BUFFS   
#define TOF_FILL_1ST_BUFF       TOF_SEC_FILL_1ST_BUFF     
#define TOF_FILL_2ND_BUFF       TOF_SEC_FILL_2ND_BUFF     

// The ready-flags for the double buffers
#define syncWordBufferOneReady 0x01    
#define syncWordBufferTwoReady 0x02    

#define TICK_TO_METER (6.25 * 3)       

#define TOF_PATCH_LOCATION        0x21000914 
#define SUCCESS                   0x00 
#define FAILURE                   0x01 

#ifdef USE_TRACER
/* tracer configuration */
#define CMD_ENABLE_DBG_CMDID    0x602
#define CMD_ENABLE_DBG_CONFIG   ((0<<14) | (1<<12) | (1<<11) | (2<<9) | (1<<8) | (1<<6))
#endif // USE_TRACER

/*********************************************************************
 * MACROS
 */

/*********************************************************************
 * TYPEDEFS
 */

typedef enum
{
    ToF_ROLE_SLAVE = 0,
    ToF_ROLE_MASTER,
    ToF_ROLE_PASSIVE
} ToF_Role;

typedef rfc_CMD_TOF_sample_t ToF_Sample;

typedef rfc_CMD_TOF_synthCal_t ToF_SynthCal;

typedef uint8_t* ToF_TX_Buf;  
typedef uint8_t* ToF_RX_Buf;  

typedef void (*TOF_ApplicationCB)(void);

typedef struct
{
    RF_Object               rfObject;                     
    RF_Handle               rfHandle;                     
    ToF_Role                tofRole;                      
    uint8_t                 numFreqs;                     
    uint16_t                *pFrequencies;                
    uint8_t                 freqChangePeriod;             
    ToF_SynthCal            synthCal[TOF_MAX_NUM_FREQ];   
    ToF_TX_Buf              pTxBuf;                       
    ToF_RX_Buf              pRxBuf;                       
    ToF_Sample              *pT1RSSIBuf;                  
    uint16_t                numBurstSamples;              
} ToF_Object, ToF_Struct, *ToF_Handle;

typedef struct
{
    ToF_Role                tofRole;                      
    ToF_Sample              *pT1RSSIBuf;                  
    uint16_t                numBurstSamples;              
    uint8_t                 *pTxBuf;                      
    uint8_t                 *pRxBuf;                      
    uint16_t                *pFrequencies;                
    uint8_t                 numFreq;                      
    tofSecCfgPrms_t         tofSecurityParams;            
    uint8_t                 mask;                         
    uint8_t                 freqChangePeriod;             
    uint16_t                syncTimeout;                  
    TOF_ApplicationCB       pfnTofApplicationCB;          
    uint8_t                 constSyncwords;               
} ToF_Params;

typedef struct
{
    uint16_t freq;                        
    double   tick;                        
    double   tickVariance;                
    uint32_t numOk;                       
} ToF_BurstStat;

typedef struct
{
    uint32_t     freq;                    
    RF_EventMask rfEvent;                 
    uint32_t     ratSyncTime;             
} ToF_Status;
/*-------------------------------------------------------------------
 * FUNCTIONS
 */

ToF_Handle TOF_open(ToF_Struct *tofStruct, ToF_Params *params);

ToF_Status TOF_run(ToF_Handle handle, uint32_t nextTaskTime);

void TOF_clearBuffers(ToF_Handle handle);

void TOF_getBurstStat(ToF_Handle handle, ToF_BurstStat **resultBuffer);

void TOF_close(ToF_Handle handle);

uint8_t TOF_genSeed(void);

uint8_t TOF_setSeed(uint8_t* newSeed);

uint8_t TOF_getSeed(uint8_t *dst);

uint8_t TOF_initSyncWords(void);

void TOF_skipSyncWords(void);

/* For frequency calibration: */
#define CMD_READ_FS_CAL 0x000D 

struct __RFC_STRUCT rfc_CMD_READ_FS_CAL_s 
{
    uint16_t commandNo; 
    uint8_t __dummy0; 
    uint8_t coarseCal; 
    uint8_t midCal; 
    uint8_t ktCal; 
    uint16_t tdcCal; 
};
typedef struct __RFC_STRUCT rfc_CMD_READ_FS_CAL_s rfc_CMD_READ_FS_CAL_t; 

/*********************************************************************
*********************************************************************/

#ifdef __cplusplus
}
#endif

#endif /* TOF_H_ */