bleapputil_api.h

Go to the documentation of this file.

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

@file  bleapputil_api.h

@brief This file contains the bleapputil_api for use
with the Bluetooth Low Energy Protocol Stack.

Group: WCS, BTS
$Target Device: DEVICES $

******************************************************************************
$License: BSD3 2022 $
******************************************************************************
$Release Name: PACKAGE NAME $
$Release Date: PACKAGE RELEASE DATE $
*****************************************************************************/
#ifndef BLEAPPUTIL_API_H
#define BLEAPPUTIL_API_H

#ifdef __cplusplus
extern "C"
{
#endif


/*********************************************************************
 * INCLUDES
 */
#include "ti/ble/stack_util/bcomdef.h"
#include "ti/ble/stack_util/icall/app/icall.h"
#include "ti/ble/stack_util/icall/app/icall_ble_api.h"
#include <ti/display/Display.h>

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

// Size of string-converted device address ("0xXXXXXXXXXXXX")
#define BLEAPPUTIL_ADDR_STR_SIZE     15

#define BLEAppUtil_malloc   ICall_malloc
#define BLEAppUtil_free     ICall_free
#define BLEAppUtil_freeMsg  ICall_freeMsg
/*********************************************************************
 * TYPEDEFS
 */

// no description for ICall_Hdr in the api, so the user won't be able to see ICall_Hdr struct members inside the api.
// the definition of the struct is in: icall_ble_apimsg.h
typedef ICall_Hdr               BLEAppUtil_msgHdr_t;

// need to be internal
typedef ICall_EntityID          BLEAppUtil_entityId_t;

typedef uint8_t                 BLEAppUtil_BDaddr[B_ADDR_LEN];

// Handlers types

typedef void (*EventHandler_t)(uint32 event, BLEAppUtil_msgHdr_t *pMsgData);

// not being used for now
typedef void (*ErrorHandler_t)(int32 errorCode , void* pInfo);

typedef void (*StackInitDone_t)(gapDeviceInitDoneEvent_t *deviceInitDoneData);

typedef void (*InvokeFromBLEAppUtilContext_t)(char *pData);

/*********************************************************************
 * Enumerators
 */

typedef enum BLEAppUtil_eventHandlerType_e
{
    BLEAPPUTIL_GAP_CONN_TYPE,           
    BLEAPPUTIL_CONN_NOTI_TYPE,          
    BLEAPPUTIL_GAP_ADV_TYPE,            
    BLEAPPUTIL_GAP_SCAN_TYPE,           
    BLEAPPUTIL_GAP_PERIODIC_TYPE,       
    BLEAPPUTIL_GATT_TYPE,               
    BLEAPPUTIL_PASSCODE_TYPE,           
    BLEAPPUTIL_PAIR_STATE_TYPE,         
    BLEAPPUTIL_L2CAP_DATA_TYPE,         
    BLEAPPUTIL_L2CAP_SIGNAL_TYPE,       
    BLEAPPUTIL_HCI_DATA_TYPE,           
    BLEAPPUTIL_HCI_GAP_TYPE,            
    BLEAPPUTIL_HCI_SMP_TYPE,            
    BLEAPPUTIL_HCI_SMP_META_TYPE,       
    BLEAPPUTIL_HCI_CTRL_TO_HOST_TYPE,   
    BLEAPPUTIL_HANDOVER_TYPE,           
    BLEAPPUTIL_CS_TYPE,                 
    BLEAPPUTIL_CM_TYPE,                 
    BLEAPPUTIL_GENERIC_TYPE             
} BLEAppUtil_eventHandlerType_e;

typedef enum BLEAppUtil_GAPConnEventMaskFlags_e
{
    BLEAPPUTIL_LINK_ESTABLISHED_EVENT               = (uint32_t)BV(0),   
    BLEAPPUTIL_LINK_TERMINATED_EVENT                = (uint32_t)BV(1),   
    BLEAPPUTIL_CONNECTING_CANCELLED_EVENT           = (uint32_t)BV(2),   
    BLEAPPUTIL_LINK_PARAM_UPDATE_EVENT              = (uint32_t)BV(3),   
    BLEAPPUTIL_LINK_PARAM_UPDATE_REQ_EVENT          = (uint32_t)BV(4),   
    BLEAPPUTIL_LINK_PARAM_UPDATE_REJECT_EVENT       = (uint32_t)BV(5),   
    BLEAPPUTIL_SIGNATURE_UPDATED_EVENT              = (uint32_t)BV(6),   
    BLEAPPUTIL_AUTHENTICATION_COMPLETE_EVENT        = (uint32_t)BV(7),   
    BLEAPPUTIL_PASSKEY_NEEDED_EVENT                 = (uint32_t)BV(8),   
    BLEAPPUTIL_PERIPHERAL_REQUESTED_SECURITY_EVENT  = (uint32_t)BV(9),   
    BLEAPPUTIL_BOND_COMPLETE_EVENT                  = (uint32_t)BV(10),  
    BLEAPPUTIL_PAIRING_REQ_EVENT                    = (uint32_t)BV(11),  
    BLEAPPUTIL_AUTHENTICATION_FAILURE_EVT           = (uint32_t)BV(12),  
    BLEAPPUTIL_BOND_LOST_EVENT                      = (uint32_t)BV(13)   
} BLEAppUtil_GAPConnEventMaskFlags_e;

typedef enum BLEAppUtil_ConnEventNotiEventMaskFlags_e
{
    BLEAPPUTIL_CONN_NOTI_CONN_ESTABLISHED          = (uint32_t)BV(0),  
    BLEAPPUTIL_CONN_NOTI_PHY_UPDATE                = (uint32_t)BV(1),  
    BLEAPPUTIL_CONN_NOTI_CONN_EVENT_ALL            = (uint32_t)BV(2),  
} BLEAppUtil_ConnEventNotiEventMaskFlags_e;

typedef enum BLEAppUtil_GAPAdvEventMaskFlags_e
{
    BLEAPPUTIL_ADV_START_AFTER_ENABLE    = GAP_EVT_ADV_START_AFTER_ENABLE,  
    BLEAPPUTIL_ADV_END_AFTER_DISABLE     = GAP_EVT_ADV_END_AFTER_DISABLE,   
    BLEAPPUTIL_ADV_START                 = GAP_EVT_ADV_START,               
    BLEAPPUTIL_ADV_END                   = GAP_EVT_ADV_END,                 
    BLEAPPUTIL_ADV_SET_TERMINATED        = GAP_EVT_ADV_SET_TERMINATED,      
    BLEAPPUTIL_SCAN_REQ_RECEIVED         = GAP_EVT_SCAN_REQ_RECEIVED,       
    BLEAPPUTIL_ADV_DATA_TRUNCATED        = GAP_EVT_ADV_DATA_TRUNCATED,      
    BLEAPPUTIL_ADV_INSUFFICIENT_MEMORY   = GAP_EVT_INSUFFICIENT_MEMORY      
} BLEAppUtil_GAPAdvEventMaskFlags_e;


typedef enum BLEAppUtil_GAPScanEventMaskFlags_e
{
    BLEAPPUTIL_SCAN_ENABLED              = GAP_EVT_SCAN_ENABLED,        
    BLEAPPUTIL_SCAN_DISABLED             = GAP_EVT_SCAN_DISABLED,       
    BLEAPPUTIL_SCAN_PRD_ENDED            = GAP_EVT_SCAN_PRD_ENDED,      
    BLEAPPUTIL_SCAN_DUR_ENDED            = GAP_EVT_SCAN_DUR_ENDED,      
    BLEAPPUTIL_SCAN_INT_ENDED            = GAP_EVT_SCAN_INT_ENDED,      
    BLEAPPUTIL_SCAN_WND_ENDED            = GAP_EVT_SCAN_WND_ENDED,      
    BLEAPPUTIL_ADV_REPORT                = GAP_EVT_ADV_REPORT,          
    BLEAPPUTIL_ADV_REPORT_FULL           = GAP_EVT_ADV_REPORT_FULL,     
    BLEAPPUTIL_SCAN_INSUFFICIENT_MEMORY  = GAP_EVT_INSUFFICIENT_MEMORY  
} BLEAppUtil_GAPScanEventMaskFlags_e;

typedef enum BLEAppUtil_GAPPeriodicEventMaskFlags_e
{
    BLEAPPUTIL_ADV_SET_PERIODIC_ADV_PARAMS_EVENT = (uint32_t)BV(0),  
    BLEAPPUTIL_ADV_SET_PERIODIC_ADV_DATA_EVENT   = (uint32_t)BV(1),  
    BLEAPPUTIL_ADV_SET_PERIODIC_ADV_ENABLE_EVENT = (uint32_t)BV(2),  
    BLEAPPUTIL_SCAN_CREATE_SYNC_EVENT            = (uint32_t)BV(3),  
    BLEAPPUTIL_SCAN_SYNC_CANCEL_EVENT            = (uint32_t)BV(4),  
    BLEAPPUTIL_SCAN_TERMINATE_SYNC_EVENT         = (uint32_t)BV(5),  
    BLEAPPUTIL_SCAN_PERIODIC_RECEIVE_EVENT       = (uint32_t)BV(6),  
    BLEAPPUTIL_SCAN_ADD_DEVICE_ADV_LIST_EVENT    = (uint32_t)BV(7),  
    BLEAPPUTIL_SCAN_REMOVE_DEVICE_ADV_LIST_EVENT = (uint32_t)BV(8),  
    BLEAPPUTIL_SCAN_READ_ADV_LIST_SIZE_EVENT     = (uint32_t)BV(9),  
    BLEAPPUTIL_SCAN_CLEAR_ADV_LIST_EVENT         = (uint32_t)BV(10), 
    BLEAPPUTIL_SCAN_PERIODIC_ADV_SYNC_EST_EVENT  = (uint32_t)BV(11), 
    BLEAPPUTIL_SCAN_PERIODIC_ADV_SYNC_LOST_EVENT = (uint32_t)BV(12), 
    BLEAPPUTIL_SCAN_PERIODIC_ADV_REPORT_EVENT    = (uint32_t)BV(13)  
} BLEAppUtil_GAPPeriodicEventMaskFlags_e;

typedef enum BLEAppUtil_PairingEventMaskFlags_e
{
    BLEAPPUTIL_PAIRING_STATE_STARTED     = (uint32_t)BV(0), 
    BLEAPPUTIL_PAIRING_STATE_COMPLETE    = (uint32_t)BV(1), 
    BLEAPPUTIL_PAIRING_STATE_ENCRYPTED   = (uint32_t)BV(2), 
    BLEAPPUTIL_PAIRING_STATE_BOND_SAVED  = (uint32_t)BV(3), 
    BLEAPPUTIL_PAIRING_STATE_CAR_READ    = (uint32_t)BV(4), 
    BLEAPPUTIL_PAIRING_STATE_RPAO_READ   = (uint32_t)BV(5), 
    BLEAPPUTIL_GENERATE_ECC_DONE         = (uint32_t)BV(6)  
} BLEAppUtil_PairingEventMaskFlags_e;

typedef enum BLEAppUtil_GATTEventMaskFlags_e
{
    BLEAPPUTIL_ATT_ERROR_RSP                   = (uint32_t)BV(0),   
    BLEAPPUTIL_ATT_EXCHANGE_MTU_REQ            = (uint32_t)BV(1),   
    BLEAPPUTIL_ATT_EXCHANGE_MTU_RSP            = (uint32_t)BV(2),   
    BLEAPPUTIL_ATT_FIND_INFO_REQ               = (uint32_t)BV(3),   
    BLEAPPUTIL_ATT_FIND_INFO_RSP               = (uint32_t)BV(4),   
    BLEAPPUTIL_ATT_FIND_BY_TYPE_VALUE_REQ      = (uint32_t)BV(5),   
    BLEAPPUTIL_ATT_FIND_BY_TYPE_VALUE_RSP      = (uint32_t)BV(6),   
    BLEAPPUTIL_ATT_READ_BY_TYPE_REQ            = (uint32_t)BV(7),   
    BLEAPPUTIL_ATT_READ_BY_TYPE_RSP            = (uint32_t)BV(8),   
    BLEAPPUTIL_ATT_READ_REQ                    = (uint32_t)BV(9),   
    BLEAPPUTIL_ATT_READ_RSP                    = (uint32_t)BV(10),  
    BLEAPPUTIL_ATT_READ_BLOB_REQ               = (uint32_t)BV(11),  
    BLEAPPUTIL_ATT_READ_BLOB_RSP               = (uint32_t)BV(12),  
    BLEAPPUTIL_ATT_READ_MULTI_REQ              = (uint32_t)BV(13),  
    BLEAPPUTIL_ATT_READ_MULTI_RSP              = (uint32_t)BV(14),  
    BLEAPPUTIL_ATT_READ_BY_GRP_TYPE_REQ        = (uint32_t)BV(15),  
    BLEAPPUTIL_ATT_READ_BY_GRP_TYPE_RSP        = (uint32_t)BV(16),  
    BLEAPPUTIL_ATT_WRITE_REQ                   = (uint32_t)BV(17),  
    BLEAPPUTIL_ATT_WRITE_RSP                   = (uint32_t)BV(18),  
    BLEAPPUTIL_ATT_PREPARE_WRITE_REQ           = (uint32_t)BV(19),  
    BLEAPPUTIL_ATT_PREPARE_WRITE_RSP           = (uint32_t)BV(20),  
    BLEAPPUTIL_ATT_EXECUTE_WRITE_REQ           = (uint32_t)BV(21),  
    BLEAPPUTIL_ATT_EXECUTE_WRITE_RSP           = (uint32_t)BV(22),  
    BLEAPPUTIL_ATT_HANDLE_VALUE_NOTI           = (uint32_t)BV(23),  
    BLEAPPUTIL_ATT_HANDLE_VALUE_IND            = (uint32_t)BV(24),  
    BLEAPPUTIL_ATT_HANDLE_VALUE_CFM            = (uint32_t)BV(25),  
    BLEAPPUTIL_ATT_UNSUPPORTED_METHOD          = (uint32_t)BV(26),  
    BLEAPPUTIL_ATT_WRITE_CMD                   = (uint32_t)BV(27),  
    BLEAPPUTIL_ATT_SIGNED_WRITE_CMD            = (uint32_t)BV(28),  
    BLEAPPUTIL_ATT_TRANSACTION_READY_EVENT     = (uint32_t)BV(29),  
    BLEAPPUTIL_ATT_FLOW_CTRL_VIOLATED_EVENT    = (uint32_t)BV(30),  
    BLEAPPUTIL_ATT_MTU_UPDATED_EVENT           = (uint32_t)BV(31),  
} BLEAppUtil_GATTEventMaskFlags_e;

typedef enum BLEAppUtil_L2CAPSignalEventMaskFlags_e
{
    BLEAPPUTIL_L2CAP_CHANNEL_ESTABLISHED_EVT   = (uint32_t)BV(0), 
    BLEAPPUTIL_L2CAP_CHANNEL_TERMINATED_EVT    = (uint32_t)BV(1), 
    BLEAPPUTIL_L2CAP_OUT_OF_CREDIT_EVT         = (uint32_t)BV(2), 
    BLEAPPUTIL_L2CAP_PEER_CREDIT_THRESHOLD_EVT = (uint32_t)BV(3), 
    BLEAPPUTIL_L2CAP_SEND_SDU_DONE_EVT         = (uint32_t)BV(4), 
    BLEAPPUTIL_L2CAP_NUM_CTRL_DATA_PKT_EVT     = (uint32_t)BV(5), 
    BLEAPPUTIL_L2CAP_PEER_CREDIT_RECEIVED_EVT  = (uint32_t)BV(6)  

} BLEAppUtil_L2CAPSignalEventMaskFlags_e;

typedef enum BLEAppUtil_HciEventMaskFlags_e
{
    BLEAPPUTIL_HCI_DISCONNECTION_COMPLETE_EVENT_CODE    = (uint32_t)BV(0), 
    BLEAPPUTIL_HCI_COMMAND_COMPLETE_EVENT_CODE          = (uint32_t)BV(1), 
    BLEAPPUTIL_HCI_COMMAND_STATUS_EVENT_CODE            = (uint32_t)BV(2), 
    BLEAPPUTIL_HCI_LE_EVENT_CODE                        = (uint32_t)BV(3), 
    BLEAPPUTIL_HCI_VE_EVENT_CODE                        = (uint32_t)BV(4), 
    BLEAPPUTIL_HCI_BLE_HARDWARE_ERROR_EVENT_CODE        = (uint32_t)BV(5), 
    BLEAPPUTIL_HCI_NUM_OF_COMPLETED_PACKETS_EVENT_CODE  = (uint32_t)BV(6), 
    BLEAPPUTIL_HCI_APTO_EXPIRED_EVENT_CODE              = (uint32_t)BV(7), 
    BLEAPPUTIL_HCI_EVENT_PACKET                         = (uint32_t)BV(8), 
    BLEAPPUTIL_HCI_ACL_DATA_PACKET                      = (uint32_t)BV(9)  
} BLEAppUtil_HciEventMaskFlags_e;

typedef enum BLEAppUtil_HandoverEventMaskFlags_e
{
    BLEAPPUTIL_HANDOVER_START_SERVING_EVENT_CODE        = (uint32_t)BV(0), 
    BLEAPPUTIL_HANDOVER_START_CANDIDATE_EVENT_CODE      = (uint32_t)BV(1), 
} BLEAppUtil_HandoverEventMaskFlags_e;

typedef enum BLEAppUtil_CsEventMaskFlags_e
{
    BLEAPPUTIL_CS_EVENT_CODE                            = (uint32_t)BV(0), 
    BLEAPPUTIL_CS_APP_EVENT_CODE                        = (uint32_t)BV(1), 
} BLEAppUtil_CsEventMaskFlags_e;

typedef enum BLEAppUtil_CmEventMaskFlags_e
{
    BLEAPPUTIL_CM_CONN_UPDATE_EVENT_CODE                = (uint32_t)BV(0), 
    BLEAPPUTIL_CM_REPORT_EVENT_CODE                     = (uint32_t)BV(1), 
    BLEAPPUTIL_CM_CONN_STATUS_EVENT_CODE                = (uint32_t)BV(2), 
} BLEAppUtil_CmEventMaskFlags_e;

typedef enum BLEAppUtil_Profile_Roles_e
{
    BLEAPPUTIL_BROADCASTER_ROLE = GAP_PROFILE_BROADCASTER,  
    BLEAPPUTIL_OBSERVER_ROLE    = GAP_PROFILE_OBSERVER,     
    BLEAPPUTIL_PERIPHERAL_ROLE  = GAP_PROFILE_PERIPHERAL,   
    BLEAPPUTIL_CENTRAL_ROLE     = GAP_PROFILE_CENTRAL       
} BLEAppUtil_Profile_Roles_e;


typedef enum
{
  APP_SPECIFIER_CENTRAL       = 0x00,
  APP_SPECIFIER_PERIPHERAL    = 0x01,
  APP_SPECIFIER_CONNECTION    = 0x02,
  APP_SPECIFIER_PAIRING       = 0x03,
  APP_SPECIFIER_CHO           = 0x04,
  APP_SPECIFIER_CS            = 0x05,
  APP_SPECIFIER_CM            = 0x06,
  APP_SPECIFIER_COMMON        = 0x07,
  APP_SPECIFIER_L2CAPCOC      = 0x08,
  APP_SPECIFIER_GATT          = 0x09,
  APP_SPECIFIER_CA_SERVER     = 0x0A,
  APP_SPECIFIER_RREQ          = 0x0B,
  APP_SPECIFIER_RRSP          = 0x0C,
} BLEAppUtil_AppSpecifier_e;

typedef enum
{
  APP_CAP_COMMON               = 0x00000000,
  APP_CAP_CM                   = 0x00000001,
  APP_CAP_CENTRAL              = 0x00000400,
  APP_CAP_PERIPHERAL           = 0x00000800,
  APP_CAP_HANDOVER             = 0x00001000,
  APP_CAP_CONNECTION           = 0x00002000,
  APP_CAP_PAIRING              = 0x00004000,
  APP_CAP_L2CAPCOC             = 0x00008000,
  APP_CAP_CS                   = 0x00010000,
  APP_CAP_GATT                 = 0x00020000,
  APP_CAP_CA_SERVER            = 0x00040000,
  APP_CAP_RREQ                 = 0x00080000,
  APP_CAP_RRSP                 = 0x00100000,
} BLEAppUtil_AppCapabilities_e;

/*********************************************************************
 * Structures
 */

typedef struct {
  uint8_t  evtType;
  uint8_t  addrType;
  uint8_t  addr[B_ADDR_LEN];
  uint8_t  primPhy;
  uint8_t  secPhy;
  uint8_t  advSid;
  int8_t   txPower;
  int8_t   rssi;
  uint8_t  directAddrType;
  uint8_t  directAddr[B_ADDR_LEN];
  uint16_t periodicAdvInt;
  uint16_t dataLen;
  uint8_t  *pData;
} BLEAppUtil_GapScan_Evt_AdvRpt_t;

typedef union
{
    uint8_t advHandle;
    GapAdv_setTerm_t pSetTerm;
    GapAdv_scanReqReceived_t pScanReqRcv;
    GapAdv_truncData_t pTruncData;
} GapAdv_data_t;

// Structures/unions data types declarations
typedef union
{
    GapScan_Evt_End_t pScanDis;
    BLEAppUtil_GapScan_Evt_AdvRpt_t pAdvReport;
} GapScan_data_t;

typedef struct
{
    uint32_t        event;  
    GapAdv_data_t   *pBuf;  
    uint32_t        *arg;   
} BLEAppUtil_AdvEventData_t;

typedef struct
{
    uint32_t        event; 
    GapScan_data_t  *pBuf; 
    uint32_t        *arg;  
} BLEAppUtil_ScanEventData_t;

typedef struct
{
    uint16_t connHandle;        
    uint32_t state;             
    uint8_t  status;            
} BLEAppUtil_PairStateData_t;

typedef struct
{
    BLEAppUtil_BDaddr   deviceAddr;     
    uint16_t            connHandle;     
    uint8_t             uiInputs;       
    uint8_t             uiOutputs;      

    uint32_t            numComparison;
} BLEAppUtil_PasscodeData_t;

typedef struct
{
    uint16_t        advDataLen;         
    uint8_t         *advData;           
    uint16_t        scanRespDataLen;    
    uint8_t         *scanRespData;      
    GapAdv_params_t *advParam;          
} BLEAppUtil_AdvInit_t;

typedef struct
{
    GapAdv_enableOptions_t  enableOptions;  

    uint16_t                durationOrMaxEvents;
} BLEAppUtil_AdvStart_t;

typedef struct
{
    uint8_t                 primPhy;            
    GapScan_ScanType_t      scanType;           
    uint16_t                scanInterval;       
    uint16_t                scanWindow;         
    uint16_t                advReportFields;    
    uint8_t                 scanPhys;           
    uint8_t                 fltPolicy;          
    uint16_t                fltPduType;         
    int8_t                  fltMinRssi;         
    uint8_t                 fltDiscMode;        
    uint8_t                 fltDup;             
} BLEAppUtil_ScanInit_t;

typedef struct
{
    uint16_t scanPeriod;
    uint16_t scanDuration;
    uint8_t  maxNumReport;
} BLEAppUtil_ScanStart_t;

typedef struct
{
    uint8_t  initPhys;          
    uint16_t scanInterval;      
    uint16_t scanWindow;        
    uint16_t minConnInterval;   
    uint16_t maxConnInterval;   
    uint16_t connLatency;       
    uint16_t supTimeout;        
} BLEAppUtil_ConnParams_t;

typedef struct
{
    uint8_t                 peerAddrType;   
    BLEAppUtil_BDaddr       pPeerAddress;   
    uint8_t                 phys;           

    uint16_t                timeout;
}BLEAppUtil_ConnectParams_t;

typedef struct
{
    uint16 connHandle;      
    uint8  allPhys;         
    uint8  txPhy;           
    uint8  rxPhy;           
    uint16 phyOpts;         
}BLEAppUtil_ConnPhyParams_t;

typedef struct
{
    // Task related parameters - BLEAppUtil task priority. Higher values represent higher priorities
    int                         taskPriority;       
    size_t                      taskStackSize;      

    // BLE stack related parameters
    BLEAppUtil_Profile_Roles_e  profileRole;        

    // GAP GATT Server (GGS) Parameters
    uint8_t                     *deviceNameAtt;     
    uint16_t                    appearanceAtt;      
    gapPeriConnectParams_t      periConnParamsAtt;  

    // Device related parameters
    GAP_Addr_Modes_t            addressMode;
    uint8_t                     *pDeviceRandomAddress;
} BLEAppUtil_GeneralParams_t;

typedef struct
{
    gapBondParams_t             *gapBondParams;             
    Gap_updateDecision_t        connParamUpdateDecision;    
} BLEAppUtil_PeriCentParams_t;

// not used for now
typedef union
{
    gapEstLinkReqEvent_t            estLinkReqEvent;            
    gapTerminateLinkEvent_t         termLinkEvent;              
    gapConnCancelledEvent_t         gapConnCancelledEvent;      
    gapLinkUpdateEvent_t            linkUpdateEvent;            
    gapUpdateLinkParamReqEvent_t    paramUpdateReqEvent;        
    gapSignUpdateEvent_t            signUpdateEvent;            
    gapAuthCompleteEvent_t          authCompleteEvent;          
    gapPasskeyNeededEvent_t         passkeyIsNeededEvent;       
    gapPeripheralSecurityReqEvent_t peripheralSecurityReqEvent; 
    gapBondCompleteEvent_t          bondCompleteEvent;          
    gapPairingReqEvent_t            pairingReqEvent;            
    gapBondLostEvent_t              bondLostEvent;              
    Gap_ConnEventRpt_t              connEventRpt;               
    gapAuthParams_t                 authParams;                 
    gapPairingReq_t                 pairingReq;                 
    gapUpdateLinkParamReq_t         paramUpdateReq;             
    gapUpdateLinkParamReqReply_t    paramUpdateReqReplay;       
} BLEAppUtil_gapConnData_t;

typedef struct
{
    union
    {
        gapEventHdr_t               gapConnData;            
        BLEAppUtil_AdvEventData_t   gapAdvData;             
        BLEAppUtil_ScanEventData_t  gapScanData;            
        gapEventHdr_t               gapPeriodicData;        
        gattMsgEvent_t              gattData;               
        BLEAppUtil_PasscodeData_t   passcodeData;           
        BLEAppUtil_PairStateData_t  pairStateData;          
        l2capDataEvent_t            l2capData;              
        l2capSignalEvent_t          l2capSignalData;        
        hciDataEvent_t              hciData;                
        ICall_HciExtEvt             hciGapData;             
        ICall_HciExtEvt             hciSMPData;             
        ICall_HciExtEvt             hciSMPMetaData;         
    };
} BLEAppUtil_msgData_t;

/*
* @brief Connection Monitor Serving Update event
*/
typedef struct
{
    uint16_t          connHandle;       
    cmConnUpdateEvt_t connUpdateEvt;    
} BLEAppUtil_cmConnUpdateEvt_t;


typedef struct
{
    BLEAppUtil_eventHandlerType_e   handlerType;    
    EventHandler_t                  pEventHandler;  
    uint32_t                        eventMask;      
} BLEAppUtil_EventHandler_t;

/*********************************************************************
 * GLOBAL VARIABLES
 */

/*********************************************************************
 * FUNCTIONS
 */

void BLEAppUtil_init(ErrorHandler_t errorHandler, StackInitDone_t initDoneHandler,
                     BLEAppUtil_GeneralParams_t *initGeneralParams,
                     BLEAppUtil_PeriCentParams_t *initPeriCentParams);

BLEAppUtil_entityId_t BLEAppUtil_getSelfEntity(void);

// Register function for BLE stack events

bStatus_t BLEAppUtil_registerEventHandler(BLEAppUtil_EventHandler_t *eventHandler);

bStatus_t BLEAppUtil_unRegisterEventHandler(BLEAppUtil_EventHandler_t *eventHandler);

// Profiles/Services APIs

bStatus_t BLEAppUtil_invokeFunctionNoData(InvokeFromBLEAppUtilContext_t callback);

bStatus_t BLEAppUtil_invokeFunction(InvokeFromBLEAppUtilContext_t callback, char* pData);

// Adv functions

bStatus_t BLEAppUtil_initAdvSet(uint8 *advHandle, const BLEAppUtil_AdvInit_t *advInitInfo);

bStatus_t BLEAppUtil_advStart(uint8 handle, const BLEAppUtil_AdvStart_t *advStartInfo);

bStatus_t BLEAppUtil_advStop(uint8 handle);

// Scan functions

bStatus_t BLEAppUtil_scanInit(const BLEAppUtil_ScanInit_t *scanInitInfo);

bStatus_t BLEAppUtil_scanStart(const BLEAppUtil_ScanStart_t *scanStartInfo);

bStatus_t BLEAppUtil_scanStop(void);

// Connection initiation functions

bStatus_t BLEAppUtil_setConnParams(const BLEAppUtil_ConnParams_t *connParams);

bStatus_t BLEAppUtil_connect(BLEAppUtil_ConnectParams_t *connParams);

bStatus_t BLEAppUtil_cancelConnect(void);

// Connection general functions

bStatus_t BLEAppUtil_disconnect(uint16 connHandle);

GAP_Addr_Modes_t BLEAppUtil_getDevAddrMode(void);

bStatus_t BLEAppUtil_setConnPhy(BLEAppUtil_ConnPhyParams_t *phyParams);

// Connection Event notifications

bStatus_t BLEAppUtil_registerConnNotifHandler(uint16_t connHandle, GAP_CB_Event_e eventType);

bStatus_t BLEAppUtil_unRegisterConnNotifHandler(void);

// Connection parameter update related functions

bStatus_t BLEAppUtil_paramUpdateReq(gapUpdateLinkParamReq_t *pReq);

bStatus_t BLEAppUtil_paramUpdateRsp(gapUpdateLinkParamReqEvent_t *pReq, uint8 accept);

char *BLEAppUtil_convertBdAddr2Str(uint8_t *pAddr);

/*********************************************************************
 * @fn      BLEAppUtil_registerSNCB
 *
 * @brief   Register the serving node callback
 *
 * @param   None
 *
 * @return  SUCCESS, FAILURE
 */
bStatus_t BLEAppUtil_registerSNCB(void);

/*********************************************************************
 * @fn      BLEAppUtil_registerCNCB
 *
 * @brief   Register the serving node callback
 *
 * @param   None
 *
 * @return  SUCCESS, FAILURE
 */
bStatus_t BLEAppUtil_registerCNCB(void);

/*********************************************************************
 * @fn      BLEAppUtil_registerCsCB
 *
 * @brief   Register the ChannelSounding callback
 *
 * @param   None
 *
 * @return  SUCCESS, FAILURE
 */
bStatus_t BLEAppUtil_registerCsCB(void);

/*********************************************************************
 * @fn      BLEAppUtil_registerCMSCBs
 *
 * @brief   Register to connection monitor callbacks Connection Monitor
 *          Serving.
 * @param   None
 *
 * @return  SUCCESS, FAILURE
 */
bStatus_t BLEAppUtil_registerCMSCBs(void);

/*********************************************************************
 * @fn      BLEAppUtil_registerCMCBs
 *
 * @return  SUCCESS, FAILURE
 */
bStatus_t BLEAppUtil_registerCMSCBs(void);

/*********************************************************************
 * @fn      BLEAppUtil_registerCMCBs
 *
 * @brief   Register to connection monitor callbacks Connection Monitor
 *          Role.
 * @param   None
 *
 * @return  SUCCESS, FAILURE
 */
bStatus_t BLEAppUtil_registerCMCBs(void);

/*********************************************************************
 * @fn      BLEAppUtil_isbufset
 *
 * @brief   Is all of the array elements set to a value
 *
 * @param   buf - buffer to check
 * @param   val - value to check each array element for
 * @param   len - length to check
 *
 * @return  TRUE if all "val"
 *          FALSE otherwise
 */
bool BLEAppUtil_isbufset(uint8_t *buf, uint8_t val, uint8_t len);

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

#ifdef __cplusplus
}
#endif

#endif /* BLEAPPUTIL_API_H */