rtls_ctrl_api.h

Go to the documentation of this file.

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

 @file  rtls_ctrl_api.h

 @brief This file contains the RTLS Control API's

 Group: WCS, BTS
 $Target Device: DEVICES $

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

#ifndef RTLS_CTRL_API_H_
#define RTLS_CTRL_API_H_

#ifdef __cplusplus
extern "C"
{
#endif

/*********************************************************************
 * INCLUDES
 */
#include <stdint.h>

/*********************************************************************
*  EXTERNAL FUNCTIONS
*/

extern void AssertHandler(uint8 assertCause, uint8 assertSubcause);

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

// Error codes passed through Assert Handler
#define RTLS_CTRL_ASSERT_CAUSE_OUT_OF_MEMORY          0x01    
#define RTLS_CTRL_ASSERT_CAUSE_INVALID_PARAM          0x02    
#define RTLS_CTRL_ASSERT_CAUSE_NULL_POINTER_EXCEPT    0x03    

// RTLS Control version
#define RTLS_CTRL_REV           0x2

// RTLS Application Command Opcodes
#define RTLS_REQ_ENABLE_SYNC              0x01          
#define RTLS_REQ_CONN                     0x02          
#define RTLS_REQ_SCAN                     0x03          
#define RTLS_REQ_SEND_DATA                0x04          
#define RTLS_REQ_TERMINATE_LINK           0x05          
#define RTLS_REQ_SET_AOA_PARAMS           0x06          
#define RTLS_REQ_AOA_ENABLE               0x07          
#define RTLS_REQ_UPDATE_CONN_INTERVAL     0x08          
#define RTLS_REQ_GET_ACTIVE_CONN_INFO     0x09          
#define RTLS_REQ_SET_CREATE_SYNC_PARAMS   0x0A          
#define RTLS_REQ_CREATE_SYNC_CANCEL       0x0B          
#define RTLS_REQ_TERMINATE_SYNC           0x0C          
#define RTLS_REQ_PERIODIC_RECEIVE_ENABLE  0x0D          
#define RTLS_REQ_ADD_DEVICE_ADV_LIST      0x0E          
#define RTLS_REQ_REMOVE_DEVICE_ADV_LIST   0x0F          
#define RTLS_REQ_READ_ADV_LIST_SIZE       0x10          
#define RTLS_REQ_CLEAR_ADV_LIST           0x11          
#define RTLS_REQ_CL_AOA_ENABLE            0x12          

#define RTLS_REQ_BLE_LOG_STRINGS_MAX 0x9
extern char *rtlsReq_BleLogStrings[];

// Chip Identifier Address
#define CHIP_ID_ADDR ((uint8_t *)(0x50001000 + 0x2E8)) 
#define CHIP_ID_SIZE  6                                

#define RTLS_FALSE    0        
#define RTLS_TRUE     1        

// Connection Handle defines
#define RTLS_CONNHANDLE_ALL             0xFFFD // All connection handles
#define RTLS_CONNHANDLE_INVALID         0xFFFF // Invalid connection handle, used for no connection handle

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

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

typedef void (*pfnRtlsAppCb)(uint8_t *cmd);

typedef enum
{
  RTLS_SUCCESS,
  RTLS_FAIL,
  RTLS_LINK_ESTAB_FAIL,
  RTLS_LINK_TERMINATED,
  RTLS_OUT_OF_MEMORY,
  RTLS_CONFIG_NOT_SUPPORTED,
  RTLS_ILLEGAL_CMD
} rtlsStatus_e;

typedef enum
{
  RTLS_CAP_NOT_INITIALIZED         = 0x00000000,
  RTLS_CAP_CM                      = 0x00000001,
  RTLS_CAP_AOA_TX                  = 0x00000002,
  RTLS_CAP_AOA_RX                  = 0x00000004,
  RTLS_CAP_RESERVED1               = 0x00000008,
  RTLS_CAP_CL_AOA                  = 0x00000010,
  RTLS_CAP_RESERVED3               = 0x00000020,
  RTLS_CAP_RTLS_RESPONDER          = 0x00000040,
  RTLS_CAP_RTLS_COORDINATOR        = 0x00000080,
  RTLS_CAP_RTLS_PASSIVE            = 0x00000100,
  RTLS_CAP_RTLS_CONNECTION_MONITOR = 0x00000200
} rtlsCapabilities_e;

typedef struct
{
  rtlsCapabilities_e  rtlsCapab;                   
  uint8_t             identifier[CHIP_ID_SIZE];    
  uint16_t            revNum;                      
  uint8_t             devId;                       
  uint8_t             maxNumConns;                 
  pfnRtlsAppCb        rtlsAppCb;                   
} rtlsConfiguration_t;

typedef struct
{
  uint8_t reqOp;           
  uint8_t *pData;          
} rtlsCtrlReq_t;

typedef struct
{
  uint16_t connHandle;     
  uint8_t  cmdOp;          
  uint16_t payloadLen;     
  uint8_t  pPayload[];     
} rtlsPacket_t;

typedef struct
{
  uint16_t connHandle;
  uint8_t  enable;
} rtlsEnableSync_t;

typedef struct
{
  uint16_t connHandle;        
  uint16_t connInterval;      
} rtlsUpdateConnIntReq_t;

typedef struct
{
  uint16_t connHandle;        
} rtlsTerminateLinkReq_t;

typedef struct
{
  uint16_t connHandle;
} rtlsGetActiveConnInfo_t;

/*********************************************************************
 * API FUNCTIONS
 */

void RTLSCtrl_open(rtlsConfiguration_t *rtlsConfig);

void RTLSCtrl_scanResultEvt(rtlsStatus_e status, uint8_t *scanResult, uint8_t size);

void RTLSCtrl_connResultEvt(uint16_t connHandle, uint8_t status);

void RTLSCtrl_connInfoEvt(uint8_t *connInfo, uint16_t connInfoLen);

void RTLSCtrl_rtlsPacketEvt(uint8_t *pPkt);

void RTLSCtrl_syncNotifyEvt(uint16_t connHandle, rtlsStatus_e status, uint32_t timeToNextEvent, int8_t rssi, uint8_t channel);

void RTLSCtrl_dataSentEvt(uint16_t connHandle, uint8_t status);

void RTLSCtrl_sendDebugEvt(uint8_t *debug_string, uint32_t debug_value);

void RTLSCtrl_sendPeriodicListSize(uint8_t *pEvt);

void RTLSCtrl_processSyncEstEvt(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);

void RTLSCtrl_processSyncLostEvt(uint8_t opcode,
                                 uint16_t syncHandle);

#ifdef RTLS_CTE

void RTLSCtrl_aoaResultEvt(uint16_t handle, int8_t rssi, uint8_t channel, uint16_t numIqSamples, uint8_t sampleRate, uint8_t sampleSize, uint8_t sampleCtrl, uint8_t slotDuration, uint8_t numAnt, int8_t *pIQ);

void RTLSCtrl_processClAoaEnableEvt(uint16_t opcode,
                                    uint8_t status,
                                    uint16_t syncHandle);
#endif /* RTLS_CTE*/

void RTLSCtrl_processTerminateSyncEvt( void );

void RTLSCTRL_processPeriodicAdvReport( uint8_t opcode,
                                        uint16_t syncHandle,
                                        int8_t   txPower,
                                        int8_t   rssi,
                                        uint8_t  cteType,
                                        uint8_t  dataStatus,
                                        uint8_t  dataLen,
                                        uint8_t  *pData);

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


#ifdef __cplusplus
}
#endif

#endif /* RTLS_CTRL_API_H_ */