hci.h

Go to the documentation of this file.

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

 Group: WCS, BTS
 $Target Device: DEVICES $

 ******************************************************************************
 $License: TI_TEXT 2009 $
 ******************************************************************************
 $Release Name: PACKAGE NAME $
 $Release Date: PACKAGE RELEASE DATE $
 *****************************************************************************/

#ifndef HCI_H
#define HCI_H

#ifdef __cplusplus
extern "C"
{
#endif

/*
 * INCLUDES
 */
#include "ti/ble/stack_util/bcomdef.h"
#include "ti/ble/controller/ll/ll_common.h"
#include "ti/ble/controller/ll/ll_ae.h"
#include "ti/ble/stack_util/health_toolkit/assert.h"
#include "ti/ble/controller/ll/ll_tx_power.h"
#include "ti/ble/controller/hci/hci_supported_cmd.h"
#include "ti/ble/controller/ll/ll_pawr_scan.h"

/*
 * MACROS
 */

/*
 * CONSTANTS
 */

#define HCI_SUCCESS                                                         0x00 
#define HCI_ERROR_CODE_UNKNOWN_HCI_CMD                                      0x01 
#define HCI_ERROR_CODE_UNKNOWN_CONN_ID                                      0x02 
#define HCI_ERROR_CODE_HW_FAILURE                                           0x03 
#define HCI_ERROR_CODE_PAGE_TIMEOUT                                         0x04 
#define HCI_ERROR_CODE_AUTH_FAILURE                                         0x05 
#define HCI_ERROR_CODE_PIN_KEY_MISSING                                      0x06 
#define HCI_ERROR_CODE_MEM_CAP_EXCEEDED                                     0x07 
#define HCI_ERROR_CODE_CONN_TIMEOUT                                         0x08 
#define HCI_ERROR_CODE_CONN_LIMIT_EXCEEDED                                  0x09 
#define HCI_ERROR_CODE_SYNCH_CONN_LIMIT_EXCEEDED                            0x0A 
#define HCI_ERROR_CODE_ACL_CONN_ALREADY_EXISTS                              0x0B 
#define HCI_ERROR_CODE_CMD_DISALLOWED                                       0x0C 
#define HCI_ERROR_CODE_CONN_REJ_LIMITED_RESOURCES                           0x0D 
#define HCI_ERROR_CODE_CONN_REJECTED_SECURITY_REASONS                       0x0E 
#define HCI_ERROR_CODE_CONN_REJECTED_UNACCEPTABLE_BDADDR                    0x0F 
#define HCI_ERROR_CODE_CONN_ACCEPT_TIMEOUT_EXCEEDED                         0x10 
#define HCI_ERROR_CODE_UNSUPPORTED_FEATURE_PARAM_VALUE                      0x11 
#define HCI_ERROR_CODE_INVALID_HCI_CMD_PARAMS                               0x12 
#define HCI_ERROR_CODE_REMOTE_USER_TERM_CONN                                0x13 
#define HCI_ERROR_CODE_REMOTE_DEVICE_TERM_CONN_LOW_RESOURCES                0x14 
#define HCI_ERROR_CODE_REMOTE_DEVICE_TERM_CONN_POWER_OFF                    0x15 
#define HCI_ERROR_CODE_CONN_TERM_BY_LOCAL_HOST                              0x16 
#define HCI_ERROR_CODE_REPEATED_ATTEMPTS                                    0x17 
#define HCI_ERROR_CODE_PAIRING_NOT_ALLOWED                                  0x18 
#define HCI_ERROR_CODE_UNKNOWN_LMP_PDU                                      0x19 
#define HCI_ERROR_CODE_UNSUPPORTED_REMOTE_FEATURE                           0x1A 
#define HCI_ERROR_CODE_SCO_OFFSET_REJ                                       0x1B 
#define HCI_ERROR_CODE_SCO_INTERVAL_REJ                                     0x1C 
#define HCI_ERROR_CODE_SCO_AIR_MODE_REJ                                     0x1D 
#define HCI_ERROR_CODE_INVALID_LMP_PARAMS                                   0x1E 
#define HCI_ERROR_CODE_UNSPECIFIED_ERROR                                    0x1F 
#define HCI_ERROR_CODE_UNSUPPORTED_LMP_PARAM_VAL                            0x20 
#define HCI_ERROR_CODE_ROLE_CHANGE_NOT_ALLOWED                              0x21 
#define HCI_ERROR_CODE_LMP_LL_RESP_TIMEOUT                                  0x22 
#define HCI_ERROR_CODE_LMP_ERR_TRANSACTION_COLLISION                        0x23 
#define HCI_ERROR_CODE_LMP_PDU_NOT_ALLOWED                                  0x24 
#define HCI_ERROR_CODE_ENCRYPT_MODE_NOT_ACCEPTABLE                          0x25 
#define HCI_ERROR_CODE_LINK_KEY_CAN_NOT_BE_CHANGED                          0x26 
#define HCI_ERROR_CODE_REQ_QOS_NOT_SUPPORTED                                0x27 
#define HCI_ERROR_CODE_INSTANT_PASSED                                       0x28 
#define HCI_ERROR_CODE_PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED                  0x29 
#define HCI_ERROR_CODE_DIFFERENT_TRANSACTION_COLLISION                      0x2A 
#define HCI_ERROR_CODE_RESERVED1                                            0x2B 
#define HCI_ERROR_CODE_QOS_UNACCEPTABLE_PARAM                               0x2C 
#define HCI_ERROR_CODE_QOS_REJ                                              0x2D 
#define HCI_ERROR_CODE_CHAN_ASSESSMENT_NOT_SUPPORTED                        0x2E 
#define HCI_ERROR_CODE_INSUFFICIENT_SECURITY                                0x2F 
#define HCI_ERROR_CODE_PARAM_OUT_OF_MANDATORY_RANGE                         0x30 
#define HCI_ERROR_CODE_RESERVED2                                            0x31 
#define HCI_ERROR_CODE_ROLE_SWITCH_PENDING                                  0x32 
#define HCI_ERROR_CODE_RESERVED3                                            0x33 
#define HCI_ERROR_CODE_RESERVED_SLOT_VIOLATION                              0x34 
#define HCI_ERROR_CODE_ROLE_SWITCH_FAILED                                   0x35 
#define HCI_ERROR_CODE_EXTENDED_INQUIRY_RESP_TOO_LARGE                      0x36 
#define HCI_ERROR_CODE_SIMPLE_PAIRING_NOT_SUPPORTED_BY_HOST                 0x37 
#define HCI_ERROR_CODE_HOST_BUSY_PAIRING                                    0x38 
#define HCI_ERROR_CODE_CONN_REJ_NO_SUITABLE_CHAN_FOUND                      0x39 
#define HCI_ERROR_CODE_CONTROLLER_BUSY                                      0x3A 
#define HCI_ERROR_CODE_UNACCEPTABLE_CONN_PARAMETERS                         0x3B 
#define HCI_ERROR_CODE_DIRECTED_ADV_TIMEOUT                                 0x3C 
#define HCI_ERROR_CODE_CONN_TERM_MIC_FAILURE                                0x3D 
#define HCI_ERROR_CODE_CONN_FAILED_TO_ESTABLISH                             0x3E 
#define HCI_ERROR_CODE_MAC_CONN_FAILED                                      0x3F 
#define HCI_ERROR_CODE_COARSE_CLOCK_ADJUST_REJECTED                         0x40 
#define HCI_ERROR_CODE_TYPE0_SUBMAP_NOT_DEFINED                             0x41 
#define HCI_ERROR_CODE_UNKNOWN_ADVERTISING_IDENTIFIER                       0x42 
#define HCI_ERROR_CODE_LIMIT_REACHED                                        0x43 
#define HCI_ERROR_CODE_OPERATION_CANCELLED_BY_HOST                          0x44 

#define HCI_STATUS_ESTABLISH_WITH_HANDOVER             LL_STATUS_ESTABLISH_WITH_HANDOVER

#define HCI_MAX_NUM_CMD_BUFFERS                        LL_MAX_NUM_CMD_BUFFERS   
#if defined(CC2540) || defined(CC2541) || defined(CC2541S)
#define HCI_MAX_NUM_DATA_BUFFERS                       LL_MAX_NUM_DATA_BUFFERS  //<! Max Num Data Buffers
#endif // CC2540 | CC2541 | CC2541S

// Send Data Packet Boundary Flags
#define FIRST_PKT_HOST_TO_CTRL                         LL_DATA_FIRST_PKT_HOST_TO_CTRL       
#define CONTINUING_PKT                                 LL_DATA_CONTINUATION_PKT             
#define FIRST_PKT_CTRL_TO_HOST                         LL_DATA_FIRST_PKT_CTRL_TO_HOST       


#define HCI_RSSI_NOT_AVAILABLE                         LL_RSSI_NOT_AVAILABLE

#define HCI_DISCONNECT_AUTH_FAILURE                    HCI_ERROR_CODE_AUTH_FAILURE                              
#define HCI_DISCONNECT_REMOTE_USER_TERM                HCI_ERROR_CODE_REMOTE_USER_TERM_CONN                     
#define HCI_DISCONNECT_REMOTE_DEV_LOW_RESOURCES        HCI_ERROR_CODE_REMOTE_DEVICE_TERM_CONN_LOW_RESOURCES     
#define HCI_DISCONNECT_REMOTE_DEV_POWER_OFF            HCI_ERROR_CODE_REMOTE_DEVICE_TERM_CONN_POWER_OFF         
#define HCI_DISCONNECT_UNSUPPORTED_REMOTE_FEATURE      HCI_ERROR_CODE_UNSUPPORTED_REMOTE_FEATURE                
#define HCI_DISCONNECT_KEY_PAIRING_NOT_SUPPORTED       HCI_ERROR_CODE_PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED       
#define HCI_DISCONNECT_UNACCEPTABLE_CONN_INTERVAL      HCI_ERROR_CODE_UNACCEPTABLE_CONN_INTERVAL                

// Tx Power Types
#define HCI_READ_CURRENT_TX_POWER_LEVEL                LL_READ_CURRENT_TX_POWER_LEVEL           
#define HCI_READ_MAX_TX_POWER_LEVEL                    LL_READ_MAX_TX_POWER_LEVEL               

#define HCI_CTRL_TO_HOST_FLOW_CTRL_OFF                 0  
#define HCI_CTRL_TO_HOST_FLOW_CTRL_ACL_ON_SYNCH_OFF    1  
#define HCI_CTRL_TO_HOST_FLOW_CTRL_ACL_OFF_SYNCH_ON    2  
#define HCI_CTRL_TO_HOST_FLOW_CTRL_ACL_ON_SYNCH_ON     3  

#define HCI_PUBLIC_DEVICE_ADDRESS                      LL_DEV_ADDR_TYPE_PUBLIC      
#define HCI_RANDOM_DEVICE_ADDRESS                      LL_DEV_ADDR_TYPE_RANDOM      

#define HCI_CONNECTABLE_UNDIRECTED_ADV                 LL_ADV_CONNECTABLE_UNDIRECTED_EVT        
#define HCI_CONNECTABLE_DIRECTED_HDC_ADV               LL_ADV_CONNECTABLE_DIRECTED_HDC_EVT      
#define HCI_SCANNABLE_UNDIRECTED                       LL_ADV_SCANNABLE_UNDIRECTED_EVT          
#define HCI_NONCONNECTABLE_UNDIRECTED_ADV              LL_ADV_NONCONNECTABLE_UNDIRECTED_EVT     
#define HCI_CONNECTABLE_DIRECTED_LDC_ADV               LL_ADV_CONNECTABLE_DIRECTED_LDC_EVT      

#define HCI_ADV_CHAN_37                                LL_ADV_CHAN_37       
#define HCI_ADV_CHAN_38                                LL_ADV_CHAN_38       
#define HCI_ADV_CHAN_39                                LL_ADV_CHAN_39       
#define HCI_ADV_CHAN_ALL                               (LL_ADV_CHAN_37 | LL_ADV_CHAN_38 | LL_ADV_CHAN_39)   

#define HCI_ADV_AL_POLICY_ANY_REQ                      LL_ADV_AL_POLICY_ANY_REQ             
#define HCI_ADV_AL_POLICY_AL_SCAN_REQ                  LL_ADV_AL_POLICY_AL_SCAN_REQ         
#define HCI_ADV_AL_POLICY_AL_CONNECT_IND               LL_ADV_AL_POLICY_AL_CONNECT_IND      
#define HCI_ADV_AL_POLICY_AL_ALL_REQ                   LL_ADV_AL_POLICY_AL_ALL_REQ          

#define HCI_ENABLE_ADV                                 LL_ADV_MODE_ON       
#define HCI_DISABLE_ADV                                LL_ADV_MODE_OFF      

#define HCI_SCAN_PASSIVE                               LL_SCAN_PASSIVE      
#define HCI_SCAN_ACTIVE                                LL_SCAN_ACTIVE       

// Scan accept List Policy
#define HCI_SCAN_AL_POLICY_ANY_ADV_PKTS                LL_SCAN_AL_POLICY_ANY_ADV_PKTS       
#define HCI_SCAN_AL_POLICY_USE_ACCEPT_LIST              LL_SCAN_AL_POLICY_USE_ACCEPT_LIST    

// Scan Filtering
#define HCI_FILTER_REPORTS_DISABLE                     LL_FILTER_REPORTS_DISABLE    
#define HCI_FILTER_REPORTS_ENABLE                      LL_FILTER_REPORTS_ENABLE     

// Scan Commands
#define HCI_SCAN_STOP                                  LL_SCAN_STOP     
#define HCI_SCAN_START                                 LL_SCAN_START    

#define HCI_INIT_AL_POLICY_USE_PEER_ADDR               LL_INIT_AL_POLICY_USE_PEER_ADDR      
#define HCI_INIT_AL_POLICY_USE_ACCEPT_LIST             LL_INIT_AL_POLICY_USE_ACCEPT_LIST    

#define HCI_ENCRYPTION_OFF                             LL_ENCRYPTION_OFF        
#define HCI_ENCRYPTION_ON                              LL_ENCRYPTION_ON         

#define HCI_DIRECT_TEST_PAYLOAD_PRBS9                  LL_DIRECT_TEST_PAYLOAD_PRBS9     
#define HCI_DIRECT_TEST_PAYLOAD_0x0F                   LL_DIRECT_TEST_PAYLOAD_0x0F      
#define HCI_DIRECT_TEST_PAYLOAD_0x55                   LL_DIRECT_TEST_PAYLOAD_0x55      
#define HCI_DIRECT_TEST_PAYLOAD_PRBS15                 LL_DIRECT_TEST_PAYLOAD_PRBS15    
#define HCI_DIRECT_TEST_PAYLOAD_0xFF                   LL_DIRECT_TEST_PAYLOAD_0xFF      
#define HCI_DIRECT_TEST_PAYLOAD_0x00                   LL_DIRECT_TEST_PAYLOAD_0x00      
#define HCI_DIRECT_TEST_PAYLOAD_0xF0                   LL_DIRECT_TEST_PAYLOAD_0xF0      
#define HCI_DIRECT_TEST_PAYLOAD_0xAA                   LL_DIRECT_TEST_PAYLOAD_0xAA      

#define HCI_DTM_STANDARD_MODULATION_INDEX              LL_DTM_STANDARD_MODULATION_INDEX     
#define HCI_DTM_STABLE_MODULATION_INDEX                LL_DTM_STABLE_MODULATION_INDEX       

#define HCI_EXT_DTM_TX_CONTINUOUS                      LL_EXT_DTM_TX_CONTINUOUS                

#define HCI_DISABLE_ADDR_RESOLUTION                    LL_DISABLE_ADDR_RESOLUTION       
#define HCI_ENABLE_ADDR_RESOLUTION                     LL_ENABLE_ADDR_RESOLUTION        
#define HCI_NETWORK_PRIVACY_MODE                       LL_NETWORK_PRIVACY_MODE          
#define HCI_DEVICE_PRIVACY_MODE                        LL_DEVICE_PRIVACY_MODE           

#define HCI_PHY_USE_PHY_PARAM                          LL_PHY_USE_PHY_PARAM     
#define HCI_PHY_USE_ANY_PHY                            LL_PHY_USE_ANY_PHY       
#define HCI_PHY_1_MBPS                                 LL_PHY_1_MBPS            
#define HCI_PHY_2_MBPS                                 LL_PHY_2_MBPS            
#define HCI_PHY_CODED                                  LL_PHY_CODED             

#define PHY_UPDATE_COMPLETE_EVENT_1M                   1  
#define PHY_UPDATE_COMPLETE_EVENT_2M                   2  
#define PHY_UPDATE_COMPLETE_EVENT_CODED                3  

#define HCI_EXT_RX_GAIN_STD                            LL_EXT_RX_GAIN_STD       
#define HCI_EXT_RX_GAIN_HIGH                           LL_EXT_RX_GAIN_HIGH      

#define HCI_EXT_ENABLE_ONE_PKT_PER_EVT                 LL_EXT_ENABLE_ONE_PKT_PER_EVT    
#define HCI_EXT_DISABLE_ONE_PKT_PER_EVT                LL_EXT_DISABLE_ONE_PKT_PER_EVT   



#define HCI_EXT_ENABLE_CLK_DIVIDE_ON_HALT              LL_EXT_ENABLE_CLK_DIVIDE_ON_HALT 
#define HCI_EXT_DISABLE_CLK_DIVIDE_ON_HALT             LL_EXT_DISABLE_CLK_DIVIDE_ON_HALT    



#define HCI_EXT_NV_IN_USE                              LL_EXT_NV_IN_USE         
#define HCI_EXT_NV_NOT_IN_USE                          LL_EXT_NV_NOT_IN_USE     

#define HCI_EXT_ENABLE_FAST_TX_RESP_TIME               LL_EXT_ENABLE_FAST_TX_RESP_TIME  
#define HCI_EXT_DISABLE_FAST_TX_RESP_TIME              LL_EXT_DISABLE_FAST_TX_RESP_TIME 

#define HCI_EXT_ENABLE_PL_OVERRIDE                     LL_EXT_ENABLE_PL_OVERRIDE    
#define HCI_EXT_DISABLE_PL_OVERRIDE                    LL_EXT_DISABLE_PL_OVERRIDE   

#define HCI_EXT_TX_MODULATED_CARRIER                   LL_EXT_TX_MODULATED_CARRIER  
#define HCI_EXT_TX_UNMODULATED_CARRIER                 LL_EXT_TX_UNMODULATED_CARRIER 

#define HCI_PTM_SET_FREQ_TUNE_DOWN                     LL_EXT_SET_FREQ_TUNE_DOWN    
#define HCI_PTM_SET_FREQ_TUNE_UP                       LL_EXT_SET_FREQ_TUNE_UP      



#define HCI_EXT_PM_IO_PORT_P0                          LL_EXT_PM_IO_PORT_P0
#define HCI_EXT_PM_IO_PORT_P1                          LL_EXT_PM_IO_PORT_P1
#define HCI_EXT_PM_IO_PORT_P2                          LL_EXT_PM_IO_PORT_P2
#define HCI_EXT_PM_IO_PORT_NONE                        LL_EXT_PM_IO_PORT_NONE

#define HCI_EXT_PM_IO_PORT_PIN0                        LL_EXT_PM_IO_PORT_PIN0
#define HCI_EXT_PM_IO_PORT_PIN1                        LL_EXT_PM_IO_PORT_PIN1
#define HCI_EXT_PM_IO_PORT_PIN2                        LL_EXT_PM_IO_PORT_PIN2
#define HCI_EXT_PM_IO_PORT_PIN3                        LL_EXT_PM_IO_PORT_PIN3
#define HCI_EXT_PM_IO_PORT_PIN4                        LL_EXT_PM_IO_PORT_PIN4
#define HCI_EXT_PM_IO_PORT_PIN5                        LL_EXT_PM_IO_PORT_PIN5
#define HCI_EXT_PM_IO_PORT_PIN6                        LL_EXT_PM_IO_PORT_PIN6
#define HCI_EXT_PM_IO_PORT_PIN7                        LL_EXT_PM_IO_PORT_PIN7


#define HCI_EXT_PER_RESET                              LL_EXT_PER_RESET     
#define HCI_EXT_PER_READ                               LL_EXT_PER_READ      



#define HCI_EXT_HALT_DURING_RF_DISABLE                 LL_EXT_HALT_DURING_RF_DISABLE    
#define HCI_EXT_HALT_DURING_RF_ENABLE                  LL_EXT_HALT_DURING_RF_ENABLE     



#define HCI_EXT_SET_USER_REVISION                      LL_EXT_SET_USER_REVISION     
#define HCI_EXT_READ_BUILD_REVISION                    LL_EXT_READ_BUILD_REVISION   

#define HCI_EXT_RESET_SYSTEM_HARD                      LL_EXT_RESET_SYSTEM_HARD     
#define HCI_EXT_RESET_SYSTEM_SOFT                      LL_EXT_RESET_SYSTEM_SOFT     



#define HCI_EXT_DISABLE_OVERLAPPED_PROCESSING          LL_EXT_DISABLE_OVERLAPPED_PROCESSING 
#define HCI_EXT_ENABLE_OVERLAPPED_PROCESSING           LL_EXT_ENABLE_OVERLAPPED_PROCESSING  



#define HCI_EXT_DISABLE_NUM_COMPL_PKTS_ON_EVENT        LL_EXT_DISABLE_NUM_COMPL_PKTS_ON_EVENT   
#define HCI_EXT_ENABLE_NUM_COMPL_PKTS_ON_EVENT         LL_EXT_ENABLE_NUM_COMPL_PKTS_ON_EVENT    

#define HCI_EXT_DISABLE_SCAN_REQUEST_REPORT            LL_EXT_DISABLE_SCAN_REQUEST_REPORT   
#define HCI_EXT_ENABLE_SCAN_REQUEST_REPORT             LL_EXT_ENABLE_SCAN_REQUEST_REPORT    

#define HCI_LINK_TYPE_SCO_BUFFER_OVERFLOW             0    
#define HCI_LINK_TYPE_ACL_BUFFER_OVERFLOW             1    

#define HCI_EXT_RF_SETUP_1M_PHY                       LL_EXT_RF_SETUP_1M_PHY       
#define HCI_EXT_RF_SETUP_2M_PHY                       LL_EXT_RF_SETUP_2M_PHY       
#define HCI_EXT_RF_SETUP_CODED_S8_PHY                 LL_EXT_RF_SETUP_CODED_S8_PHY 
#define HCI_EXT_RF_SETUP_CODED_S2_PHY                 LL_EXT_RF_SETUP_CODED_S2_PHY  

 #define HCI_EXT_STATS_RESET                          LL_EXT_STATS_RESET     
 #define HCI_EXT_STATS_READ                           LL_EXT_STATS_READ      

/*
 * TYPEDEFS
 */

typedef uint8 hciStatus_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint8  status;                  
  uint16 connectionHandle;        
  uint8  role;                    
  uint8  peerAddrType;            
  uint8  peerAddr[B_ADDR_LEN];    
  uint16 connInterval;            
  uint16 connLatency;             
  uint16 connTimeout;             
  uint8  clockAccuracy;           
} hciEvt_BLEConnComplete_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint8  status;                  
  uint16 connectionHandle;        
  uint8  role;                    
  uint8  peerAddrType;            
  uint8  peerAddr[B_ADDR_LEN];    
  uint16 connInterval;            
  uint16 connLatency;             
  uint16 connTimeout;             
  uint8  clockAccuracy;           
  // Note: These fields normally follow peerAddr. Put here for Host optimization.
  uint8  localRPA[B_ADDR_LEN];    
  uint8  peerRPA[B_ADDR_LEN];     
} hciEvt_BLEEnhConnComplete_t;

typedef union _hciEvt_BLEConnComplete_u_
{
  hciEvt_BLEConnComplete_t      legEvt;   
  hciEvt_BLEEnhConnComplete_t   enhEvt;   
} hciEvt_BLEConnComplete_u;

typedef struct
{
  uint8  eventType;                       
  uint8  addrType;                        
  uint8  addr[B_ADDR_LEN];                
  uint8  dataLen;                         
  uint8  rspData[B_MAX_ADV_LEN];          
  int8   rssi;                            
} hciEvt_DevInfo_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint8  numDevices;              
  hciEvt_DevInfo_t* devInfo;      
} hciEvt_BLEAdvPktReport_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint8  eventType;               
  uint8  peerAddrType;            
  uint8  peerAddr[B_ADDR_LEN];    
  uint8  bleChan;                 
  int8   rssi;                    
} hciEvt_BLEScanReqReport_t;

typedef struct
{
  event_hdr_t  hdr;                               
  uint8   BLEEventCode;                           
  uint16  connHandle;                             
  uint8   nextDataChan;                           
  uint8   newChanMap[LL_NUM_BYTES_FOR_CHAN_MAP];  
} hciEvt_BLEChanMapUpdate_t;

typedef struct
{
  event_hdr_t  hdr;                               
  uint8   BLEEventCode;                           
  uint8   status;                                 
  uint16  connHandle;                             
  uint8   reason;                                 
  uint8   txPhy;                                  
  uint8   txPowerLevel;                           
  uint8   txPowerFlag;                            
  uint8   delta;                                  
} hciEvt_BLETransPwrReport_t;

typedef struct
{
  event_hdr_t  hdr;          
  uint8  BLEEventCode;       
  uint8  status;             
  uint16 connectionHandle;   
  uint16 connInterval;       
  uint16 connLatency;        
  uint16 connTimeout;        
} hciEvt_BLEConnUpdateComplete_t;

typedef struct
{
  event_hdr_t  hdr;          
  uint8  BLEEventCode;       
  uint8  status;             
  uint16 connectionHandle;   
  uint8  features[8];        
} hciEvt_BLEReadRemoteFeatureComplete_t;

typedef struct
{
  event_hdr_t  hdr;          
  uint8  BLEEventCode;       
  uint16 connHandle;         
  uint8  reason;             
  uint8  encEnable;          
} hciEvt_EncryptChange_t;

typedef struct
{
  event_hdr_t  hdr;                 
  uint8  BLEEventCode;              
  uint16 connHandle;                
  uint8  random[B_RANDOM_NUM_SIZE]; 
  uint16 encryptedDiversifier;      
} hciEvt_BLELTKReq_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  numHandles;              
  uint16 *pConnectionHandle;      
  uint16 *pNumCompletedPackets;   
} hciEvt_NumCompletedPkt_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  numHciCmdPkt;            
  uint16 cmdOpcode;               
  uint8  *pReturnParam;           
} hciEvt_CmdComplete_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8   length;                 
  uint16  cmdOpcode;              
  uint8  *pEventParam;            
} hciEvt_VSCmdComplete_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  cmdStatus;               
  uint8  numHciCmdPkt;            
  uint16 cmdOpcode;               
} hciEvt_CommandStatus_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8 hardwareCode;             
} hciEvt_HardwareError_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  status;                  
  uint16 connHandle;              
  uint8  reason;                  
} hciEvt_DisconnComplete_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8 linkType;                 
} hciEvt_BufferOverflow_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint16 connHandle;              
} hciEvt_AptoExpired_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint16 connHandle;              
  uint16 cid;                     
} hciEvt_DataLenExceed_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint8  status;                  
  uint16 connHandle;              
  uint16 Interval_Min;            
  uint16 Interval_Max;            
  uint16 Latency;                 
  uint16 Timeout;                 
} hciEvt_BLERemoteConnParamReq_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint8  status;                  
  uint16 connHandle;              
  uint8  txPhy;                   
  uint8  rxPhy;                   
} hciEvt_BLEPhyUpdateComplete_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint16 connHandle;              
  uint16 maxTxOctets;             
  uint16 maxTxTime;               
  uint16 maxRxOctets;             
  uint16 maxRxTime;               
} hciEvt_BLEDataLengthChange_t;

typedef struct
{
  event_hdr_t  hdr;                  
  uint8 BLEEventCode;                
  uint8 status;                      
  uint8 p256Key[LL_SC_P256_KEY_LEN]; 
} hciEvt_BLEReadP256PublicKeyComplete_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8 BLEEventCode;             
  uint8 status;                   
  uint8 dhKey[LL_SC_DHKEY_LEN];   
} hciEvt_BLEGenDHKeyComplete_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint16 connHandle;              
  uint8  phy;                     
  uint8  dataChIndex;             
  uint16 rssi;                    
  uint8  rssiAntenna;             
  uint8  cteType;                 
  uint8  slotDuration;            
  uint8  status;                  
  uint16 connEvent;               
  uint8  sampleCount;             
  int8   *iqSamples;              
} hciEvt_BLECteConnectionIqReport_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8 BLEEventCode;             
  uint8 status;                   
  uint16 connHandle;              
} hciEvt_BLECteRequestFailed_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint16 totalDataLen;            
  uint8  eventIndex;              
  uint16 connHandle;              
  uint8  phy;                     
  uint8  dataChIndex;             
  uint16 rssi;                    
  uint8  rssiAntenna;             
  uint8  cteType;                 
  uint8  slotDuration;            
  uint8  status;                  
  uint16 connEvent;               
  uint8  dataLen;                 
  uint8  sampleRate;              
  uint8  sampleSize;              
  uint8  sampleCtrl;              
  void   *iqSamples;              
} hciEvt_BLEExtCteConnectionIqReport_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint16 syncHandle;              
  uint8  channelIndex;            
  uint16 rssi;                    
  uint8  rssiAntenna;             
  uint8  cteType;                 
  uint8  slotDuration;            
  uint8  status;                  
  uint16 eventCounter;            
  uint8  sampleCount;             
  int8   *iqSamples;              
} hciEvt_BLECteConnectionlessIqReport_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint16 totalDataLen;            
  uint8  eventIndex;              
  uint16 syncHandle;              
  uint8  channelIndex;            
  uint16 rssi;                    
  uint8  rssiAntenna;             
  uint8  cteType;                 
  uint8  slotDuration;            
  uint8  status;                  
  uint16 eventCounter;            
  uint8  dataLen;                 
  uint8  sampleRate;              
  uint8  sampleSize;              
  uint8  sampleCtrl;              
  void   *iqSamples;              
} hciEvt_BLEExtCteConnectionlessIqReport_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint8  status;                  
  uint16 syncHandle;              
  uint8  sid;                     
  uint8  addrType;                
  uint8  address[B_ADDR_LEN];     
  uint8  phy;                     
  uint16 periodicInterval;        
  uint8  clockAccuracy;           
} hciEvt_BLEPeriodicAdvSyncEstablished_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint16 syncHandle;              
  int8   txPower;                 
  int8   rssi;                    
  uint8  cteType;                 
  uint8  dataStatus;              
  uint8  dataLen;                 
  uint8  *data;                   
} hciEvt_BLEPeriodicAdvReport_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint16 syncHandle;              
} hciEvt_BLEPeriodicAdvSyncLost_t;


typedef struct
{
  uint8  status;                  
  uint16 dataPktLen;              
  uint8  numDataPkts;             
} hciRetParam_LeReadBufSize_t;

typedef struct
{
  event_hdr_t  hdr;               
  uint8  BLEEventCode;            
  uint16 connHandle;              
  uint8  chSelAlgo;               
} hciEvt_BLEChanSelAlgo_t;

typedef struct
{
  event_hdr_t hdr;              
  uint8_t  BLEEventCode;        
} hciEvtHdr_t;

typedef struct
{
  event_hdr_t hdr;              
  uint8            *pData;      
} hciPacket_t;

typedef struct
{
  event_hdr_t hdr;                
  uint8  pktType;                 
  uint16 connHandle;              
  uint8  pbFlag;                  
  uint16 pktLen;                  
  uint8  *pData;                  
} hciDataPacket_t;


// OSAL HCI_DATA_EVENT message format. This message is used to forward incoming
// data messages up to an application
typedef struct
{
  event_hdr_t hdr;                        
  uint16 connHandle;                      
  uint8  pbFlag;                          
  uint16 len;                             
  uint8  *pData;                          
} hciDataEvent_t;


PACKED_TYPEDEF_STRUCT
{
  uint8 connId;                           
  uint8 role;                             
  uint8 addr[LL_DEVICE_ADDR_LEN];         
  uint8 addrType;                         
} hciConnInfo_t; 

PACKED_TYPEDEF_STRUCT
{
  uint32_t  accessAddr;                          
  uint16_t  connInterval;                        
  uint8_t   hopValue;                            
  uint16_t  mSCA;                                
  uint8_t   nextChan;                            
  uint8_t   chanMap[LL_NUM_BYTES_FOR_CHAN_MAP];  
  uint8_t   crcInit[LL_PKT_CRC_LEN];             
  uint8_t   ownAddrType;                         
}hciActiveConnInfo_t;

PACKED_TYPEDEF_STRUCT
{
  uint16 numPkts;                         
  uint16 numCrcErr;                       
  uint16 numEvents;                       
  uint16 numMMissedEvents;                
} hciPER_t; 


extern void *HCI_bm_alloc( uint16 size );

extern void HCI_bm_free( uint8* pBuf );

extern uint8 HCI_ValidConnTimeParams( uint16 connIntervalMin,
                                      uint16 connIntervalMax,
                                      uint16 connLatency,
                                      uint16 connTimeout );

extern void HCI_GAPTaskRegister( uint8 taskID );

extern void HCI_L2CAPTaskRegister( uint8 taskID );

extern void HCI_SMPTaskRegister( uint8 taskID );

extern void HCI_ExtTaskRegister( uint8 taskID );

extern hciStatus_t HCI_SendDataPkt( uint16 connHandle,
                                    uint8  pbFlag,
                                    uint16 pktLen,
                                    uint8  *pData );

extern hciStatus_t HCI_DisconnectCmd( uint16 connHandle,
                                      uint8  reason );


extern hciStatus_t HCI_ReadRemoteVersionInfoCmd( uint16 connHandle );


extern hciStatus_t HCI_SetEventMaskCmd( uint8 *pMask );


extern hciStatus_t HCI_SetEventMaskPage2Cmd( uint8 *pMask );

extern hciStatus_t HCI_ResetCmd( void );

extern hciStatus_t HCI_ReadTransmitPowerLevelCmd( uint16 connHandle,
                                                  uint8  txPwrType );


extern hciStatus_t HCI_SetControllerToHostFlowCtrlCmd( uint8 flowControlEnable );

extern hciStatus_t HCI_HostBufferSizeCmd( uint16 hostAclPktLen,
                                          uint8  hostSyncPktLen,
                                          uint16 hostTotalNumAclPkts,
                                          uint16 hostTotalNumSyncPkts );


extern hciStatus_t HCI_HostNumCompletedPktCmd( uint8   numHandles,
                                               uint16 *connHandles,
                                               uint16 *numCompletedPkts );

extern hciStatus_t HCI_ReadAuthPayloadTimeoutCmd( uint16  connHandle,
                                                  uint16 *aptoValue );

extern hciStatus_t HCI_WriteAuthPayloadTimeoutCmd( uint16 connHandle,
                                                   uint16 aptoValue );

extern hciStatus_t HCI_ReadLocalVersionInfoCmd( void );

extern hciStatus_t HCI_ReadLocalSupportedCommandsCmd( void );

extern hciStatus_t HCI_ReadLocalSupportedFeaturesCmd( void );

void HCI_GetLocalSupportedCommands(uint8_t* pSupportedCmdBuf);

extern hciStatus_t HCI_ReadBDADDRCmd( void );

extern hciStatus_t HCI_ReadRssiCmd( uint16 connHandle );

extern hciStatus_t HCI_LE_SetEventMaskCmd( uint8 *pEventMask );

extern hciStatus_t HCI_LE_ReadBufSizeCmd( void );

extern hciStatus_t HCI_LE_ReadLocalSupportedFeaturesCmd( void );

extern hciStatus_t HCI_LE_SetRandomAddressCmd( uint8 *pRandAddr );

extern hciStatus_t HCI_LE_SetAdvParamCmd( uint16 advIntervalMin,
                                          uint16 advIntervalMax,
                                          uint8  advType,
                                          uint8  ownAddrType,
                                          uint8  directAddrType,
                                          uint8  *directAddr,
                                          uint8  advChannelMap,
                                          uint8  advFilterPolicy );

extern hciStatus_t HCI_LE_SetAdvDataCmd( uint8 dataLen,
                                         uint8 *pData );
hciStatus_t HCI_LE_SetExtAdvData( aeSetDataCmd_t *pCmdParams );

hciStatus_t HCI_LE_SetExtScanRspData( aeSetDataCmd_t *pCmdParams );

hciStatus_t HCI_LE_SetAdvStatus( aeEnableCmd_t *pCmdParams );

extern hciStatus_t HCI_LE_SetScanRspDataCmd( uint8 dataLen,
                                             uint8 *pData );

extern hciStatus_t HCI_LE_SetAdvEnableCmd( uint8 advEnable );

extern hciStatus_t HCI_LE_ReadAdvChanTxPowerCmd( void );

extern hciStatus_t HCI_LE_SetScanParamCmd( uint8  scanType,
                                           uint16 scanInterval,
                                           uint16 scanWindow,
                                           uint8  ownAddrType,
                                           uint8  filterPolicy );

extern hciStatus_t HCI_LE_SetScanEnableCmd( uint8 scanEnable,
                                            uint8 filterDuplicates );

extern hciStatus_t HCI_LE_CreateConnCancelCmd( void );

extern hciStatus_t HCI_LE_ReadAcceptListSizeCmd( void );


extern hciStatus_t HCI_LE_ClearAcceptListCmd( void );


extern hciStatus_t HCI_LE_AddAcceptListCmd( uint8 addrType,
                                           uint8 *devAddr );


extern hciStatus_t HCI_LE_RemoveAcceptListCmd( uint8 addrType,
                                              uint8 *devAddr );

extern hciStatus_t HCI_LE_ConnUpdateCmd( uint16 connHandle,
                                         uint16 connIntervalMin,
                                         uint16 connIntervalMax,
                                         uint16 connLatency,
                                         uint16 connTimeout,
                                         uint16 minLen,
                                         uint16 maxLen );

extern hciStatus_t HCI_LE_SetHostChanClassificationCmd( uint8 *chanMap );

extern hciStatus_t HCI_EXT_SetHostDefChanClassificationCmd( uint8 *chanMap );

extern hciStatus_t HCI_EXT_SetHostConnChanClassificationCmd( uint8 *chanMap , uint16 connID );

extern hciStatus_t HCI_LE_ReadChannelMapCmd( uint16 connHandle );

extern hciStatus_t HCI_LE_ReadRemoteUsedFeaturesCmd( uint16 connHandle );

extern hciStatus_t HCI_LE_EncryptCmd( uint8 *key,
                                      uint8 *plainText );

extern hciStatus_t HCI_LE_RandCmd( void );

extern hciStatus_t HCI_LE_StartEncyptCmd( uint16 connHandle,
                                          uint8  *random,
                                          uint8  *encDiv,
                                          uint8  *ltk );

extern hciStatus_t HCI_LE_LtkReqReplyCmd( uint16 connHandle,
                                          uint8  *ltk );


extern hciStatus_t HCI_LE_LtkReqNegReplyCmd( uint16 connHandle );

extern hciStatus_t HCI_LE_ReadSupportedStatesCmd( void );

extern hciStatus_t HCI_LE_ReceiverTestCmd( uint8 rxChan );

extern hciStatus_t HCI_LE_TransmitterTestCmd( uint8 txChan,
                                              uint8 dataLen,
                                              uint8 pktPayload );

extern hciStatus_t HCI_LE_TestEndCmd( void );

// V4.1

extern hciStatus_t HCI_LE_RemoteConnParamReqReplyCmd( uint16 connHandle,
                                                      uint16 connIntervalMin,
                                                      uint16 connIntervalMax,
                                                      uint16 connLatency,
                                                      uint16 connTimeout,
                                                      uint16 minLen,
                                                      uint16 maxLen );

extern hciStatus_t HCI_LE_RemoteConnParamReqNegReplyCmd( uint16 connHandle,
                                                         uint8  reason );

// V4.2 Extended Data Length

extern hciStatus_t HCI_LE_SetDataLenCmd( uint16 connHandle,
                                         uint16 txOctets,
                                         uint16 txTime );

extern hciStatus_t HCI_LE_ReadSuggestedDefaultDataLenCmd( void );

extern hciStatus_t HCI_LE_WriteSuggestedDefaultDataLenCmd( uint16 txOctets,
                                                           uint16 txTime );

extern hciStatus_t HCI_LE_ReadMaxDataLenCmd( void );

// V4.2 Privacy 1.2

extern hciStatus_t HCI_LE_AddDeviceToResolvingListCmd( uint8  peerIdAddrType,
                                                       uint8 *peerIdAddr,
                                                       uint8 *peerIRK,
                                                       uint8 *localIRK );

extern hciStatus_t HCI_LE_RemoveDeviceFromResolvingListCmd( uint8  peerIdAddrType,
                                                            uint8 *peerIdAddr );

extern hciStatus_t HCI_LE_ClearResolvingListCmd( void );

extern hciStatus_t HCI_LE_ReadResolvingListSizeCmd( void );

extern hciStatus_t HCI_LE_ReadPeerResolvableAddressCmd( uint8  peerIdAddrType,
                                                        uint8 *peerIdAddr );

extern hciStatus_t HCI_LE_ReadLocalResolvableAddressCmd( uint8  localIdAddrType,
                                                         uint8 *localIdAddr );

extern hciStatus_t HCI_LE_SetAddressResolutionEnableCmd( uint8 addrResolutionEnable );

extern hciStatus_t HCI_LE_SetResolvablePrivateAddressTimeoutCmd( uint16 rpaTimeout );

extern hciStatus_t HCI_LE_SetPrivacyModeCmd( uint8  peerIdAddrType,
                                             uint8 *peerIdAddr,
                                             uint8  privacyMode );

// V4.2 Secure Connections

extern hciStatus_t HCI_LE_ReadLocalP256PublicKeyCmd( void );

extern hciStatus_t HCI_LE_GenerateDHKeyCmd( uint8 *publicKey );


extern hciStatus_t HCI_LE_GenerateDHKeyV2Cmd( uint8 *publicKey, uint8 keyType );

// V5.0 2M and Coded PHY

extern hciStatus_t HCI_LE_ReadPhyCmd( uint16 connHandle );

extern hciStatus_t HCI_LE_SetDefaultPhyCmd( uint8 allPhys,
                                            uint8 txPhy,
                                            uint8 rxPhy );


extern hciStatus_t HCI_LE_SetPhyCmd( uint16 connHandle,
                                     uint8  allPhys,
                                     uint8  txPhy,
                                     uint8  rxPhy,
                                     uint16 phyOpts );


extern hciStatus_t HCI_LE_EnhancedRxTestCmd( uint8 rxChan,
                                             uint8 rxPhy,
                                             uint8 modIndex );


extern hciStatus_t HCI_LE_EnhancedTxTestCmd( uint8 txChan,
                                             uint8 payloadLen,
                                             uint8 payloadType,
                                             uint8 txPhy );
extern hciStatus_t HCI_LE_EnhancedCteRxTestCmd( uint8 rxChan,
                                                uint8 rxPhy,
                                                uint8 modIndex,
                                                uint8 expectedCteLength,
                                                uint8 expectedCteType,
                                                uint8 slotDurations,
                                                uint8 length,
                                                uint8 *pAntenna);

extern hciStatus_t HCI_LE_EnhancedCteTxTestCmd( uint8 txChan,
                                                uint8 payloadLen,
                                                uint8 payloadType,
                                                uint8 txPhy,
                                                uint8 cteLength,
                                                uint8 cteType,
                                                uint8 length,
                                                uint8 *pAntenna);
extern hciStatus_t HCI_LE_ReadTxPowerCmd( void );

extern hciStatus_t HCI_LE_ReadRfPathCompCmd( void );

extern hciStatus_t HCI_LE_WriteRfPathCompCmd( int16 txPathParam,
                                              int16 rxPathParam );

// @cond NODOC
extern hciStatus_t HCI_LE_SetConnectionCteReceiveParamsCmd( uint16 connHandle,
                                                            uint8 samplingEnable,
                                                            uint8 slotDurations,
                                                            uint8 length,
                                                            uint8 *pAntenna);


extern hciStatus_t HCI_LE_SetConnectionCteTransmitParamsCmd( uint16 connHandle,
                                                             uint8 types,
                                                             uint8 length,
                                                             uint8 *pAntenna);

extern hciStatus_t HCI_LE_SetConnectionCteRequestEnableCmd( uint16 connHandle,
                                                            uint8 enable,
                                                            uint16 interval,
                                                            uint8 length,
                                                            uint8 type);

extern hciStatus_t HCI_LE_SetConnectionCteResponseEnableCmd( uint16 connHandle,
                                                             uint8 enable);

extern hciStatus_t HCI_LE_ReadAntennaInformationCmd( void );

extern hciStatus_t HCI_LE_SetPeriodicAdvParamsCmd( uint8 advHandle,
                                                   uint16 periodicAdvIntervalMin,
                                                   uint16 periodicAdvIntervalMax,
                                                   uint16 periodicAdvProp );


extern hciStatus_t HCI_LE_SetPeriodicAdvDataCmd( uint8 advHandle,
                                                 uint8 operation,
                                                 uint8 dataLength,
                                                 uint8 *data );

extern hciStatus_t HCI_LE_SetPeriodicAdvEnableCmd( uint8 enable,
                                                   uint8 advHandle );

extern hciStatus_t HCI_LE_SetConnectionlessCteTransmitParamsCmd( uint8 advHandle,
                                                                 uint8 cteLen,
                                                                 uint8 cteType,
                                                                 uint8 cteCount,
                                                                 uint8 length,
                                                                 uint8 *pAntenna);

extern hciStatus_t HCI_LE_SetConnectionlessCteTransmitEnableCmd( uint8 advHandle,
                                                                 uint8 enable );

extern hciStatus_t HCI_LE_PeriodicAdvCreateSyncCmd( uint8  options,
                                                    uint8  advSID,
                                                    uint8  advAddrType,
                                                    uint8  *advAddress,
                                                    uint16 skip,
                                                    uint16 syncTimeout,
                                                    uint8  syncCteType );

/*******************************************************************************
 * @fn          HCI_LE_SetPeriodicSyncSubeventCmd
 *
 * @brief       This function used by the Host to set the subevents it want to
 *              sync with.
 *
 * input parameters
 *
 * @param       syncHandle      - Handle identifying the periodic advertising train
 * @param       perAdvProps     - Properties for the Response data header
 * @param       numSubevents    - Number of subevents to be set
 * @param       subEvents       - Pointer to the array of subevents to be set
 *
 * output parameters
 *
 * @param       None.
 *
 * @return      status of the command
 *              HCI_SUCCESS - Command was successful
 *              LL_STATUS_ERROR_COMMAND_DISALLOWED - Command disallowed
 *              LL_STATUS_ERROR_BAD_PARAMETER - Invalid parameters were passed
 *              LL_STATUS_ERROR_FEATURE_NOT_SUPPORTED - Invalid parameters were passed
 *              HCI_ERROR_CODE_MEM_CAP_EXCEEDED - Memory capacity exceeded
 */
extern hciStatus_t HCI_LE_SetPeriodicSyncSubeventCmd(uint16_t syncHandle,
                                                     uint16_t perAdvProps,
                                                     uint8_t  numSubevents,
                                                     uint8_t* subEvents);

/*******************************************************************************
 * @fn         HCI_LE_SetPeriodicAdvResponseDataCmd
 *
 * @brief      Used by the Host to set the periodic advertising response parameters
 *             and data.
 *
 * input parameters
 *
 * @param     syncHandle - Handle identifying the periodic advertising train
 * @param     pRspParams - Pointer to the periodic advertising response parameters
 *                         and data.
 *
 * output parameters
 *
 * @param     None.
 *
 * @return    status of the command
 *            HCI_SUCCESS - Command was successful
 *            LL_STATUS_ERROR_COMMAND_DISALLOWED - Command disallowed
 *            LL_STATUS_ERROR_UNKNOWN_ADVERTISING_IDENTIFIER - Unknown advertising identifier
 *            LL_STATUS_ERROR_BAD_PARAMETER - Invalid parameters were passed
 *            HCI_ERROR_CODE_MEM_CAP_EXCEEDED - Memory capacity exceeded
*/
extern hciStatus_t HCI_LE_SetPeriodicAdvResponseDataCmd(uint16 syncHandle,
                                                        uint8_t* pRspParams);
extern hciStatus_t HCI_LE_PeriodicAdvCreateSyncCancelCmd( void );

extern hciStatus_t HCI_LE_PeriodicAdvTerminateSyncCmd( uint16 syncHandle );

extern hciStatus_t HCI_LE_AddDeviceToPeriodicAdvListCmd( uint8 advAddrType,
                                                         uint8 *advAddress,
                                                         uint8 advSID );

extern hciStatus_t HCI_LE_RemoveDeviceFromPeriodicAdvListCmd( uint8 advAddrType,
                                                              uint8 *advAddress,
                                                              uint8 advSID );

extern hciStatus_t HCI_LE_ClearPeriodicAdvListCmd( void );

extern hciStatus_t HCI_LE_ReadPeriodicAdvListSizeCmd( void );

extern hciStatus_t HCI_LE_SetHostFeature( uint8, uint8  );

extern hciStatus_t HCI_LE_SetPeriodicAdvReceiveEnableCmd( uint16 syncHandle,
                                                          uint8  enable );


/*
** HCI Vendor Specific Commands: Link Layer Extensions
*/

extern hciStatus_t HCI_EXT_SetRxGainCmd( uint8 rxGain );

extern hciStatus_t HCI_EXT_SetTxPowerDbmCmd( int8 txPower, uint8 fraction );

extern hciStatus_t HCI_EXT_OnePktPerEvtCmd( uint8 control );


extern hciStatus_t HCI_EXT_ClkDivOnHaltCmd( uint8 control );

extern hciStatus_t HCI_EXT_DeclareNvUsageCmd( uint8 mode );


extern hciStatus_t HCI_EXT_DecryptCmd( uint8 *key,
                                       uint8 *encText );

extern hciStatus_t HCI_EXT_SetLocalSupportedFeaturesCmd( uint8 *localFeatures );

extern hciStatus_t HCI_EXT_SetFastTxResponseTimeCmd( uint8 control );


extern hciStatus_t HCI_EXT_SetPeripheralLatencyOverrideCmd( uint8 control );


extern hciStatus_t HCI_EXT_ModemTestTxCmd( uint8 cwMode,
                                           uint8 txChan );

extern hciStatus_t HCI_EXT_ModemHopTestTxCmd( void );

extern hciStatus_t HCI_EXT_ModemTestRxCmd( uint8 rxChan );

extern hciStatus_t HCI_EXT_EnhancedModemTestTxCmd( uint8 cwMode,
                                                   uint8 rfPhy,
                                                   uint8 rfChan );

extern hciStatus_t HCI_EXT_EnhancedModemHopTestTxCmd( uint8 payloadLen,
                                                      uint8 payloadType,
                                                      uint8 rfPhy );

extern hciStatus_t HCI_EXT_EnhancedModemTestRxCmd( uint8 rfPhy,
                                                   uint8 rfChan );

extern hciStatus_t HCI_EXT_EndModemTestCmd( void );

extern hciStatus_t HCI_EXT_SetBDADDRCmd( uint8 *bdAddr );

extern hciStatus_t HCI_EXT_SetSCACmd( uint16 scaInPPM );

extern hciStatus_t HCI_EXT_EnablePTMCmd( void );

extern hciStatus_t HCI_EXT_SetMaxDtmTxPowerDbmCmd( int8   txPowerDbm,
                                                   uint8  fraction );

extern hciStatus_t HCI_EXT_MapPmIoPortCmd( uint8 ioPort, uint8 ioPin );


extern hciStatus_t HCI_EXT_DisconnectImmedCmd( uint16 connHandle );

extern hciStatus_t HCI_EXT_PacketErrorRateCmd( uint16 connHandle, uint8 command );

extern hciStatus_t HCI_EXT_PERbyChanCmd( uint16 connHandle, perByChan_t *perByChan );

extern hciStatus_t HCI_EXT_BuildRevisionCmd( uint8 mode, uint16 userRevNum );


extern hciStatus_t HCI_EXT_DelaySleepCmd( uint16 delay );


extern hciStatus_t HCI_EXT_ResetSystemCmd( uint8 mode );

// @cond NODOC

extern hciStatus_t HCI_EXT_LLTestModeCmd( uint8 testCase );


extern hciStatus_t HCI_EXT_OverlappedProcessingCmd( uint8 mode );


extern hciStatus_t HCI_EXT_NumComplPktsLimitCmd( uint8 limit,
                                                 uint8 flushOnEvt );

extern hciStatus_t HCI_EXT_GetConnInfoCmd( uint8         *numAllocConns,
                                           uint8         *numActiveConns,
                                           hciConnInfo_t *activeConnInfo );

extern hciStatus_t HCI_EXT_SetMaxDataLenCmd( uint16 txOctets,
                                             uint16 txTime,
                                             uint16 rxOctets,
                                             uint16 rxTime );

extern hciStatus_t HCI_EXT_SetDtmTxPktCntCmd( uint16 txPktCnt );


extern hciStatus_t HCI_EXT_ReadRandAddrCmd( void );


extern hciStatus_t HCI_EXT_SetPinOutputCmd( uint8 dio,
                                            uint8 value );

extern hciStatus_t HCI_EXT_SetLocationingAccuracyCmd( uint16 handle,
                                                      uint8  sampleRate1M,
                                                      uint8  sampleSize1M,
                                                      uint8  sampleRate2M,
                                                      uint8  sampleSize2M,
                                                      uint8  sampleCtrl);

extern hciStatus_t HCI_EXT_GetActiveConnInfoCmd( uint8 connId, hciActiveConnInfo_t *activeConnInfo );

extern hciStatus_t HCI_EXT_SetAdvSetRandAddrCmd( uint8 advHandle, uint8 *randAddr);

extern hciStatus_t HCI_EXT_SetVirtualAdvAddrCmd( uint8 advHandle,  uint8 *bdAddr );

extern hciStatus_t HCI_EXT_SetExtScanChannels( uint8 extScanChannelsMap );

extern hciStatus_t HCI_EXT_SetQOSParameters( uint8  taskType,
                                             uint8  paramType,
                                             uint32 ParamVal,
                                             uint16 taskHandle);

extern hciStatus_t HCI_EXT_SetQOSDefaultParameters(uint32 paramDefaultVal,
                                                   uint8  paramType,
                                                   uint8  taskType);

extern hciStatus_t HCI_EXT_CoexEnableCmd( uint8 enable );

extern hciStatus_t HCI_EXT_GetRxStatisticsCmd( uint16 connHandle, uint8 command );

extern hciStatus_t HCI_EXT_GetTxStatisticsCmd( uint16 connHandle, uint8 command );

extern hciStatus_t HCI_EXT_GetCoexStatisticsCmd( uint8 command );

/*******************************************************************************
 * @fn          HCI_CMD_Parser
 *
 * @brief       This API is called by an external or internal host to send
 *              a raw HCI packet command to the controller. The API runs on all
 *              parser functions and looks for opcode matches. Inside the parser
 *              function, a call is made to the HCI function, which returns the
 *              HCI status or HCI_ERROR_CODE_UNKNOWN_HCI_CMD if the opcode
 *              is not found.
 *
 * input parameters
 *
 * @param       pData - Pointer to packet's data.
 *
 * output parameters
 *
 * @param       None.
 *
 * @return        HCI/LL status
 *                HCI_ERROR_CODE_UNKNOWN_HCI_CMD.
 *
 */
hciStatus_t HCI_CMD_Parser(uint8 *pData);

/*******************************************************************************
 * @fn          HCI_LE_ReadRemoteTransmitPowerLevelCmd
 *
 * @brief       Read the transmit power level used by the remote
 *              controller on a specific connection and specific PHY.
 *
 * @Design      BLE_LOKI-1969
 *
 * input parameters
 *
 * @param       connHandle - Connection handle.
 * @param       txPhy      - Tx PHY of the remote controller to read the power value from.
 *
 * output parameters
 *
 * @param       None
 *
 * @return @ref HCI_SUCCESS
 */
hciStatus_t HCI_LE_ReadRemoteTransmitPowerLevelCmd( uint16_t connHandle,
                                                    uint8_t  txPhy );

/*******************************************************************************
 * @fn          HCI_LE_EnhancedReadTransmitPowerLevelCmd
 *
 * @brief       Read the current and maximum transmit power level used by the local
 *              controller on a specific connection and a specific PHY.
 *
 * @design     BLE_LOKI-1969
 *
 * input parameters
 *
 * @param      connHandle - Connection handle.
 * @param      txPhy      - Tx PHY to read the power value from.
 *
 * output parameters
 *
 * @param       None
 *
 * @return @ref HCI_SUCCESS
 */
hciStatus_t HCI_LE_EnhancedReadTransmitPowerLevelCmd( uint16_t connHandle,
                                                      uint8_t  txPhy );

/*******************************************************************************
 * @fn          HCI_LE_SetTransmitPowerReportingEnableCmd
 *
 * @brief       Enable or disable the reporting to the local Host of transmit
 *              power level changes in the local and remote Controllers of a
 *              specific connection.
 *
 * @design     BLE_LOKI-1969
 *
 * input parameters
 *
 * @param       connHandle    - Connection handle.
 * @param       localEnable   - Enable or disable the local reporting events
 * @param       remoteEnable  - Enable or disable the remote reporting events
 *
 * output parameters
 *
 * @param       None
 *
 * @return @ref HCI_SUCCESS
 */
hciStatus_t HCI_LE_SetTransmitPowerReportingEnableCmd( uint16_t connHandle,
                                                       uint8_t  localEnable,
                                                       uint8_t  remoteEnable);

/*******************************************************************************
 * @fn          HCI_EXT_SendPowerControlRequestCmd
 *
 * @brief       Enables the App/Host to sent the power control request packet
 *              with any delta value.
 *
 * @Design      BLE_LOKI-1969
 *
 * input parameters
 *
 * @param       connHandle    - Connection handle.
 * @param       txPhy         - Tx PHY of the remote controller to query.
 * @param       deltaPowerDb  - Amount of Tx power (dB) to ask the peer device to change
 * @param       enableApr     - Enable or disable the usage of the APR value from the power control response packet
 *
 * output parameters
 *
 * @param       None
 *
 * @return @ref HCI_SUCCESS
 */
hciStatus_t HCI_EXT_SendPowerControlRequestCmd( uint16_t connHandle,
                                                uint8_t  txPhy,
                                                int8_t   deltaPowerDb,
                                                uint8_t  aprEnalbe );

/*******************************************************************************
 * @fn          HCI_EXT_SetDefaultAntenna
 *
 * @brief       This API is to be called by the host to set a default antenna
 *              for common BLE communications.
 *
 * input parameters
 *
 * @param       index - Index of the antenna to set as default.
 *                      Should match an antenna index defined by the controller.
 *                      Range: 0x00 to 0x03.
 *
 * output parameters
 *
 * @param       None.
 *
 * @return        HCI status
 *
 */
extern hciStatus_t HCI_EXT_SetDefaultAntenna( uint8 index );

/*******************************************************************************
 * @fn          HCI_EXT_RssiMon_RegCmd
 *
 * @brief       Enables the App/Host to register an RSSI monitoring command for
 *              a specific connection.
 *
 * @design      BLE_LOKI-2764
 *
 * input parameters
 *
 * @param       connHandle     - Connection handle.
 * @param       lowRssiThresh  - Low RSSI threshold value.
 * @param       highRssiThresh - High RSSI threshold value.
 *
 * output parameters
 *
 * @param       None
 *
 * @return @ref Register handle when success. Otherwise RSSI_MON_INVALID_REG_HANDLE
 */
hciStatus_t HCI_EXT_RssiMon_RegCmd( uint16_t connHandle,
                                    int8_t   lowRssiThresh,
                                    int8_t   highRssiThresh );

/*******************************************************************************
 * @fn          HCI_EXT_RssiMon_UnregCmd
 *
 * @brief       Enables the App/Host to unregister from an RSSI monitoring command for
 *              a specific register handle.
 *
 * @design      BLE_LOKI-2764
 *
 * input parameters
 *
 * @param       regHandle - Register handle.
 *
 * output parameters
 *
 * @param       None
 *
 * @return @ref HCI_SUCCESS when success. Otherswise RSSI_MON_INVALID_REG_HANDLE
 */
hciStatus_t HCI_EXT_RssiMon_UnregCmd(uint8_t regHandle);

/*******************************************************************************
 * @fn          HCI_EXT_RssiMon_SetConfigCmd
 *
 * @brief       Enables the App/Host to set the RSSI monitoring configuration.
 *
 * @design      BLE_LOKI-2764
 *
 * input parameters
 *
 * @param       incomeRssiWeight - Weight of the new RSSI value.
 * @param       minRssiSamples   - Minimum number of RSSI samples.
 *
 * output parameters
 *
 * @param       None
 *
 * @return @ref HCI_SUCCESS when success. Otherwise RSSI_MON_INVALID_CONFIG
 */
hciStatus_t HCI_EXT_RssiMon_SetConfigCmd( int8_t   incomeRssiWeight,
                                          uint8_t  minRssiSamples );

/*******************************************************************************
 * @fn          HCI_EXT_RssiMon_GetConfigCmd
 *
 * @brief       Enables the App/Host to get the RSSI monitoring configuration.
 *
 * @design      BLE_LOKI-2764
 *
 * input parameters
 *
 * @param       None
 *
 * output parameters
 *
 * @param       None
 *
 * @return @ref HCI_SUCCESS when success. Otherwise RSSI_MON_INVALID_CONFIG
 *              The config data is raised through the command complete event
 */
hciStatus_t HCI_EXT_RssiMon_GetConfigCmd(void);

/*******************************************************************************
 * @fn          HCI_EXT_RssiMon_GetRssiStatCmd
 *
 * @brief       Enables the App/Host to get the RSSI monitoring statistics.
 *
 * @design      BLE_LOKI-2764
 *
 * input parameters
 *
 * @param       connHandle - Connection handle
 *
 * output parameters
 *
 * @param       None
 *
 * @return @ref Rssi statistic value when success. otherwise RSSI_MON_INVALID_VALUE
 *              The statistic data is raised through the command complete event
 */
hciStatus_t HCI_EXT_RssiMon_GetRssiStatCmd(uint16_t connHandle);

/*******************************************************************************
 * @fn          HCI_LE_PAdvSetInfoTransferCmd
 *
 * @brief       Periodic advertising sync transfer command is used to instruct
 *              the controller to send synchronization information about the
 *              periodic advertising in an advertising set to a connected
 *              device
 *
 * @Design      BLE_LOKI-2753
 *
 * input parameters
 *
 * @param       connHandle  - Connection handle.
 * @param       serviceData - Value provided by the host for use by the Host
 *                            of the peer device.
 * @param       advHandle   - Advertising set of the periodic advertising.
 *
 * output parameters
 *
 * @param       None
 *
 * @return      HCI_SUCCESS when success.
 *              Otherwise:
 *              HCI_ERROR_CODE_UNKNOWN_ADVERTISING_IDENTIFIER
 *              HCI_ERROR_CODE_UNKNOWN_CONN_ID
 *              HCI_ERROR_CODE_UNSUPPORTED_FEATURE_PARAM_VALUE
 */
hciStatus_t HCI_LE_PAdvSetInfoTransferCmd( uint16_t  connHandle,
                                           uint16_t  serviceData,
                                           uint8_t   advHandle);

/*******************************************************************************
 * @fn          HCI_LE_PAdvSyncTransferCmd
 *
 * @brief       Periodic advertising sync transfer command is used to instruct
 *              the controller to send synchronization information about the
 *              periodic advertising train identified by the Sync_Handle parameter
 *              to a connected device
 *
 * @Design      BLE_LOKI-2753
 *
 * input parameters
 *
 * @param       connHandle  - Connection handle.
 * @param       serviceData - Value provided by the host for use by the Host
 *                            of the peer device.
 * @param       syncHandle  - Sync handle of the periodic advertising train.
 *
 * output parameters
 *
 * @param       None
 *
 * @return      HCI_SUCCESS when success.
 *              Otherwise:
 *              HCI_ERROR_CODE_UNKNOWN_ADVERTISING_IDENTIFIER
 *              HCI_ERROR_CODE_UNKNOWN_CONN_ID
 *              HCI_ERROR_CODE_UNSUPPORTED_FEATURE_PARAM_VALUE
 */
hciStatus_t HCI_LE_PAdvSyncTransferCmd( uint16_t  connHandle,
                                        uint16_t  serviceData,
                                        uint16_t  syncHandle );

/*******************************************************************************
 * @fn          HCI_LE_SetPASTParamCmd
 *
 * @brief       Periodic advertising sync transfer parameters command is used to
 *              specify how the controller will process periodic advertising
 *              synchronization information (syncInfo) received from the device
 *              identified by the Connection_Handle parameter.
 *
 * @Design      BLE_LOKI-2753
 *
 * input parameters
 *
 * @param       connHandle    - Connection handle.
 * @param       mode          - Action to be taken when periodic advertising
 *                              synchronization information is received:
 *                              0x00 - No attempt is made to synchronize to the periodic
 *                                     advertising and no event is sent to host
 *                              0x01 - Attempt to synchronize to periodic advertising,
 *                                     Event is raised if we succeed to sync or not to the host
 *                                     Periodic advertisements reports will not raised to the host
 *                              0x02 - Attempt to synchronize to periodic advertising,
 *                                     Event is raised to if we succeed to sync or not
 *                                     Periodic advertisements reports will be raised to the host
 *                                     with duplicate filtering is disabled
 *                              0x03 - Attempt to synchronize to periodic advertising,
 *                                     Event is raised to if we succeed to sync or not
 *                                     Periodic advertisements reports will be raised to the host
 *                                     with duplicate filtering is enabled
 * @param       skip          - Number of consecutive periodic advertising packets
 *                              the device may skip after successfully receiving
 *                              a periodic advertising packet
 * @param       syncTimeout  - Maximum permitted time between successful receives
 * @param       cteType      - Whether to only synchronize to periodic advertising
 *                             with certain types of Constant Tone Extension
 *
 * output parameters
 *
 * @param       None
 *
 * @return      HCI_SUCCESS when success.
 *              Otherwise:
 *              HCI_ERROR_CODE_UNSUPPORTED_FEATURE_PARAM_VALUE
 *              HCI_ERROR_CODE_UNKNOWN_CONN_ID
 *              HCI_ERROR_CODE_CMD_DISALLOWED
 */
hciStatus_t HCI_LE_SetPASTParamCmd( uint16_t  connHandle,
                                    uint8_t   mode,
                                    uint16_t  skip,
                                    uint16_t  syncTimeout,
                                    uint8_t   cteType );

/*******************************************************************************
 * @fn          HCI_LE_SetDefaultPASTParamCmd
 *
 * @brief       Periodic advertising sync transfer set default parameters command
 *              is used to specify the initial value for the periodic advertising
 *              sync transfer parameters
 *
 * @Design      BLE_LOKI-2753
 *
 * input parameters
 *
 * @param       mode          - Action to be taken when periodic advertising
 *                              synchronization information is received:
 *                              0x00 - No attempt is made to synchronize to the periodic
 *                                     advertising and no event is sent to host
 *                              0x01 - Attempt to synchronize to periodic advertising,
 *                                     Event is raised if we succeed to sync or not to the host
 *                                     Periodic advertisements reports will not raised to the host
 *                              0x02 - Attempt to synchronize to periodic advertising,
 *                                     Event is raised to if we succeed to sync or not
 *                                     Periodic advertisements reports will be raised to the host
 *                                     with duplicate filtering is disabled
 *                              0x03 - Attempt to synchronize to periodic advertising,
 *                                     Event is raised to if we succeed to sync or not
 *                                     Periodic advertisements reports will be raised to the host
 * @param       skip          - Number of consecutive periodic advertising packets
 *                              the device may skip after successfully receiving
 *                              a periodic advertising packet
 * @param       syncTimeout  - Maximum permitted time between successful receives
 * @param       cteType      - Whether to only synchronize to periodic advertising
 *                             with certain types of Constant Tone Extension
 *
 * output parameters
 *
 * @param       None
 *
 * @return @ref HCI_SUCCESS when success.
 *              Otherwise:
 *              HCI_ERROR_CODE_UNSUPPORTED_FEATURE_PARAM_VALUE
 *              HCI_ERROR_CODE_CMD_DISALLOWED
 */
hciStatus_t HCI_LE_SetDefaultPASTParamCmd( uint8_t   mode,
                                           uint16_t  skip,
                                           uint16_t  syncTimeout,
                                           uint8_t   cteType );
#ifdef __cplusplus
}
#endif

#endif /* HCI_H */