rtls_srv_api.h

Go to the documentation of this file.

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

 @file  rtls_srv_api.h

 @brief This file implements the RTLS Services APIs
 Group: WCS, BTS
 $Target Device: DEVICES $

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

#ifndef RTLSSRVAPI_H
#define RTLSSRVAPI_H

#ifdef __cplusplus
extern "C"
{
#endif

/*-------------------------------------------------------------------
 * INCLUDES
 */

#include "bcomdef.h"
#include <ti/drivers/PIN.h>
#include "ble_user_config.h"
#include "hci.h"
#include "ll.h"

/*-------------------------------------------------------------------
 * CONSTANTS
 */

#define RTLSSRV_CTE_SAMPLING_NOT_INIT                   LL_CTE_SAMPLING_NOT_INIT       
#define RTLSSRV_CTE_SAMPLING_ENABLE                     LL_CTE_SAMPLING_ENABLE         
#define RTLSSRV_CTE_SAMPLING_DISABLE                    LL_CTE_SAMPLING_DISABLE        

#define RTLSSRV_CTE_SAMPLE_SLOT_1US                     LL_CTE_SAMPLE_SLOT_1US         
#define RTLSSRV_CTE_SAMPLE_SLOT_2US                     LL_CTE_SAMPLE_SLOT_2US         

#define RTLSSRV_CTE_SAMPLE_RATE_1US_AOD_TX              LL_CTE_SAMPLE_RATE_1US_AOD_TX  
#define RTLSSRV_CTE_SAMPLE_RATE_1US_AOD_RX              LL_CTE_SAMPLE_RATE_1US_AOD_RX  
#define RTLSSRV_CTE_SAMPLE_RATE_1US_AOA_RX              LL_CTE_SAMPLE_RATE_1US_AOA_RX  

#define RTLSSRV_CTE_TYPE_AOA                            LL_CTE_TYPE_AOA            

#define RTLSSRV_CTE_SAMPLE_RATE_1MHZ                    CTE_SAMPLING_CONFIG_1MHZ   
#define RTLSSRV_CTE_SAMPLE_RATE_2MHZ                    CTE_SAMPLING_CONFIG_2MHZ   
#define RTLSSRV_CTE_SAMPLE_RATE_3MHZ                    CTE_SAMPLING_CONFIG_3MHZ   
#define RTLSSRV_CTE_SAMPLE_RATE_4MHZ                    CTE_SAMPLING_CONFIG_4MHZ   

#define RTLSSRV_CTE_SAMPLE_SIZE_8BITS                   LL_CTE_SAMPLE_SIZE_8BITS   
#define RTLSSRV_CTE_SAMPLE_SIZE_16BITS                  LL_CTE_SAMPLE_SIZE_16BITS  

#define RTLSSRV_CTE_SAMPLE_CONTROL_RF_DEFAULT_FILTERING CTE_SAMPLING_CONTROL_DEFAULT_FILTERING
#define RTLSSRV_CTE_SAMPLE_CONTROL_RF_RAW_NO_FILTERING  CTE_SAMPLING_CONTROL_RF_RAW_NO_FILTERING

#define RTLSSRV_CL_CTE_ANTENNA_LIST_MIN_LENGTH          LL_CTE_ANTENNA_LIST_MIN_LENGTH
#define RTLSSRV_CL_CTE_ANTENNA_LIST_MAX_LENGTH          LL_CTE_ANTENNA_LIST_MAX_LENGTH

#define RTLSSRV_CL_CTE_MIN_LEN                          LL_CTE_MIN_LEN
#define RTLSSRV_CL_CTE_MAX_LEN                          LL_CTE_MAX_LEN

#define RTLSSRV_CL_CTE_MIN_COUNT                        LL_CTE_COUNT_MIN
#define RTLSSRV_CL_CTE_MAX_COUNT                        LL_CTE_COUNT_MAX

#define RTLSSRV_SYNC_HANDLE_MASK                        0x1000
#define RTLSSRV_REVERSE_SYNC_HANDLE                     0x0FFF

#define RTLSSRV_CONNECTION_CTE_IQ_REPORT_EVT            1

#define RTLSSRV_ANTENNA_INFORMATION_EVT                 2

#define RTLSSRV_CTE_REQUEST_FAILED_EVT                  3

#define RTLSSRV_ERROR_EVT                               4

#define RTLSSRV_CL_CTE_EVT                              5

#define RTLSSRV_READ_PERIODIC_LIST_SIZE_EVT             6

#define RTLSSRV_SYNC_EST_EVT                            7

#define RTLSSRV_SYNC_LOST_EVT                           8

#define RTLSSRV_PERIODIC_ADV_RPT                        9

#define RTLSSRV_CL_CTE_IQ_REPORT_EVT                    10

#define RTLSSRV_PERIODIC_ADV_TERMINATE_SYNC             11

#define RTLSSRV_CL_AOA_ENABLE_EVT                       12

#define RTLSSRV_CONN_HANDLE_INVALID              0x02             
#define RTLSSRV_OUT_OF_MEMORY                    0x07             
#define RTLSSRV_COMMAND_DISALLOWED               0x0C             
#define RTLSSRV_ERROR_DUE_TO_LIMITED_RESOURCES   0x0D             
#define RTLSSRV_FEATURE_NOT_SUPPORTED            0x11             
#define RTLSSRV_BAD_PARAMETER                    0x12             
#define RTLSSRV_REMOTE_FEATURE_NOT_SUPPORTED     0x1A             
#define RTLSSRV_UNKNOWN_ADVERTISING_IDENTIFIER   0x42             


#define RTLSSRV_SET_CONNECTION_CTE_RECEIVE_PARAMS      0x2054             
#define RTLSSRV_SET_CONNECTION_CTE_TRANSMIT_PARAMS     0x2055             
#define RTLSSRV_SET_CONNECTION_CTE_REQUEST_ENABLE      0x2056             
#define RTLSSRV_SET_CONNECTION_CTE_RESPONSE_ENABLE     0x2057             
#define RTLSSRV_SET_CL_CTE_TRANSMIT_PARAMS             0x2051             
#define RTLSSRV_SET_CL_CTE_TRANSMIT_ENABLE             0x2052             
#define RTLSSRV_SET_CL_IQ_SAMPLING_ENABLE              0x2053             


/*-------------------------------------------------------------------
 * TYPEDEFS
 */


typedef struct
{
  uint16_t connHandle;              
  uint8_t  phy;                     
  uint8_t  dataChIndex;             
  uint16_t rssi;                    
  uint8_t  rssiAntenna;             
  uint8_t  cteType;                 
  uint8_t  slotDuration;            
  uint8_t  status;                  
  uint16_t connEvent;               
  uint16_t sampleCount;             
  uint8_t  sampleRate;              
  uint8_t  sampleSize;              
  uint8_t  sampleCtrl;              
  uint8_t  numAnt;                  
  int8_t   *iqSamples;              
} rtlsSrv_connectionIQReport_t;

typedef struct
{
  uint16_t syncHandle;              
  uint8_t  channelIndex;            
  uint16_t rssi;                    
  uint8_t  rssiAntenna;             
  uint8_t  cteType;                 
  uint8_t  slotDuration;            
  uint8_t  sampleRate;              
  uint8_t  sampleSize;              
  uint8_t  sampleCtrl;              
  uint8_t  packetStatus;            
  uint16_t eventCounter;            
  uint8_t  numAnt;                  
  uint16_t sampleCount;             
  int8_t   *iqSamples;              
} rtlsSrv_clIQReport_t;


typedef struct
{
  uint8_t sampleRates;              
  uint8_t maxNumOfAntennas;         
  uint8_t maxSwitchPatternLen;      
  uint8_t maxCteLen;                
} rtlsSrv_antennaInfo_t;

typedef struct
{
  uint8_t status;                   
  uint16_t connHandle;              
} rtlsSrv_cteReqFailed_t;

typedef struct
{
  uint16_t connHandle;              
  uint16_t errSrc;                  
  uint16_t errCause;                
} rtlsSrv_errorEvt_t;

typedef struct
{
  uint16_t opcode;      
  uint8_t status;      
} rtlsSrv_ClCmdCompleteEvt_t;

typedef struct
{
  uint16_t opcode;      
  uint8_t  status;      
  uint16_t syncHandle;  
} rtlsSrv_ClAoAEnableEvt_t;

typedef struct
{
  uint8_t  opcode;               
  uint8_t  status;               
  uint16_t syncHandle;           
  uint8_t  advSid;               
  uint8_t  advAddrType;          
  uint8_t  advAddress[6];        
  uint8_t  advPhy;               
  uint16_t periodicAdvInt;       
  uint8_t  advClockAccuracy;     
} rtlsSrv_SyncEstEvt_t;

typedef struct
{
  uint8_t  opcode;          
  uint16_t syncHandle;      
} rtlsSrv_SyncLostEvt_t;

typedef struct
{
  uint8_t  opcode;            
  uint16_t syncHandle;        
  int8_t   txPower;           
  int8_t   rssi;              
  uint8_t  cteType;           
  uint8_t  dataStatus;        
  uint8_t  dataLen;           
  uint8_t  *pData;            
} rtlsSrv_PeriodicAdvRpt_t;

typedef struct
{
  uint8_t   evtType;              
  uint16_t  evtSize;              
  uint8_t   *evtData;             
} rtlsSrv_evt_t;

typedef void (*pfnAppEventHandlerCB_t)(rtlsSrv_evt_t *pEvt);

extern uint8_t maxNumClCteBufs;

/*-------------------------------------------------------------------
 * API's
 */

extern bStatus_t RTLSSrv_init(uint8_t numOfRTLSConns);

extern bStatus_t RTLSSrv_register(pfnAppEventHandlerCB_t pCB);

extern bStatus_t RTLSSrv_setConnCteReceiveParams(uint16_t connHandle,
                                                 uint8_t  samplingEnable,
                                                 uint8_t  slotDurations,
                                                 uint8_t  numAnt,
                                                 uint8_t  antArray[]);

extern bStatus_t RTLSSrv_setConnCteTransmitParams(uint16_t connHandle,
                                                  uint8_t  types,
                                                  uint8_t  length,
                                                  uint8_t  antArray[]);

extern bStatus_t RTLSSrv_setConnCteRequestEnableCmd(uint16_t connHandle,
                                                    uint8_t  enable,
                                                    uint16_t interval,
                                                    uint8_t  length,
                                                    uint8_t  type);

extern bStatus_t RTLSSrv_setConnCteResponseEnableCmd(uint16_t connHandle,
                                                     uint8_t  enable);

extern bStatus_t RTLSSrv_readAntennaInformationCmd(void);

extern bStatus_t RTLSSrv_setCteSampleAccuracy(uint16_t handle,
                                              uint8_t  sampleRate1M,
                                              uint8_t  sampleSize1M,
                                              uint8_t  sampleRate2M,
                                              uint8_t  sampleSize2M,
                                              uint8_t  sampleCtrl);
extern PIN_Handle RTLSSrv_initAntArray(uint8_t mainAntenna);

extern bStatus_t RTLSSrv_processHciEvent(uint16_t hciEvt, uint16_t hciEvtSz, uint8_t *pEvtData);

 bStatus_t RTLSSrv_SetCLCteTransmitParams( uint8 advHandle,
                                           uint8 cteLength,
                                           uint8 cteType,
                                           uint8 cteCount,
                                           uint8 switchLen,
                                           uint8 *pAntenna );

 bStatus_t RTLSSrv_CLCteTransmitEnable( uint8 advHandle,
                                        uint8 enable );

bStatus_t RTLSSrv_setCLCteSamplingEnableCmd( uint16_t syncHandle,
                                             uint8_t enable,
                                             uint8_t slotDuration,
                                             uint8_t maxSampleCte,
                                             uint8_t numAnt,
                                             uint8_t pAntPattern[] );

#ifdef __cplusplus
}
#endif

#endif /* RTLSSRVAPI_H */