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>

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

#define RTLSSRV_CTE_SAMPLING_NOT_INIT                   0             
#define RTLSSRV_CTE_SAMPLING_ENABLE                     1             
#define RTLSSRV_CTE_SAMPLING_DISABLE                    2             

#define RTLSSRV_CTE_SAMPLE_SLOT_1US                     1             
#define RTLSSRV_CTE_SAMPLE_SLOT_2US                     2             

#define RTLSSRV_CTE_SAMPLE_RATE_1US_AOD_TX              0             
#define RTLSSRV_CTE_SAMPLE_RATE_1US_AOD_RX              1             
#define RTLSSRV_CTE_SAMPLE_RATE_1US_AOA_RX              2             

#define RTLSSRV_CTE_TYPE_AOA                            0             

#define RTLSSRV_CTE_SAMPLE_RATE_1MHZ                    1             
#define RTLSSRV_CTE_SAMPLE_RATE_2MHZ                    2             
#define RTLSSRV_CTE_SAMPLE_RATE_3MHZ                    3             
#define RTLSSRV_CTE_SAMPLE_RATE_4MHZ                    4             

#define RTLSSRV_CTE_SAMPLE_SIZE_8BITS                   1             
#define RTLSSRV_CTE_SAMPLE_SIZE_16BITS                  2             


#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_CONN_HANDLE_INVALID              0x02             
#define RTLSSRV_OUT_OF_MEMORY                    0x07             
#define RTLSSRV_COMMAND_DISALLOWED               0x0C             
#define RTLSSRV_FEATURE_NOT_SUPPORTED            0x11             
#define RTLSSRV_REMOTE_FEATURE_NOT_SUPPORTED     0x1A             


#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             


/*-------------------------------------------------------------------
 * 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  numAnt;                  
  int8_t   *iSamples;               
  int8_t   *qSamples;               
} rtlsSrv_connectionIQReport_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
{
  uint8_t   evtType;              
  uint16_t  evtSize;              
  uint8_t   *evtData;             
} rtlsSrv_evt_t;

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

/*-------------------------------------------------------------------
 * 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 connHandle,
                                              uint8_t  sampleRate1M,
                                              uint8_t  sampleSize1M,
                                              uint8_t  sampleRate2M,
                                              uint8_t  sampleSize2M);
extern PIN_Handle RTLSSrv_initAntArray(uint8_t antArray[], uint8_t antArrLen);

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

#ifdef __cplusplus
}
#endif

#endif /* RTLSSRVAPI_H */