gap.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, Texas Instruments Incorporated
 * All rights reserved.
        
        
        
        
        
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
        
        
 *    documentation and/or other materials provided with the distribution.
        
        
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/*!*****************************************************************************
 *  @defgroup GAP GAP
 *  @brief This module implements the Generic Access Protocol (GAP)
 *  @{
 *  @file       gap.h
 *  @brief      GAP layer interface
 */

#ifndef GAP_H
#define GAP_H

#ifdef __cplusplus
extern "C"
{
#endif

/*-------------------------------------------------------------------
 * INCLUDES
 */
#include "bcomdef.h"
#include "osal.h"
#include "sm.h"

/*-------------------------------------------------------------------
 * MACROS
 */

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

#define GAP_DEVICE_INIT_DONE_EVENT            0x00 
#define GAP_DEVICE_DISCOVERY_EVENT            0x01 
#define GAP_ADV_DATA_UPDATE_DONE_EVENT        0x02 
#define GAP_MAKE_DISCOVERABLE_DONE_EVENT      0x03 
#define GAP_END_DISCOVERABLE_DONE_EVENT       0x04 
#define GAP_LINK_ESTABLISHED_EVENT            0x05 
#define GAP_LINK_TERMINATED_EVENT             0x06 
#define GAP_LINK_PARAM_UPDATE_EVENT           0x07 
#define GAP_RANDOM_ADDR_CHANGED_EVENT         0x08 
#define GAP_SIGNATURE_UPDATED_EVENT           0x09 
#define GAP_AUTHENTICATION_COMPLETE_EVENT     0x0A 
#define GAP_PASSKEY_NEEDED_EVENT              0x0B 
#define GAP_SLAVE_REQUESTED_SECURITY_EVENT    0x0C 
#define GAP_DEVICE_INFO_EVENT                 0x0D 
#define GAP_BOND_COMPLETE_EVENT               0x0E 
#define GAP_PAIRING_REQ_EVENT                 0x0F 
#define GAP_AUTHENTICATION_FAILURE_EVT        0x10 
#define GAP_UPDATE_LINK_PARAM_REQ_EVENT       0x11 

#define GAP_CONNHANDLE_INIT     0xFFFE  
#define GAP_CONNHANDLE_ALL      0xFFFF  

#define GAP_PROFILE_BROADCASTER   0x01 
#define GAP_PROFILE_OBSERVER      0x02 
#define GAP_PROFILE_PERIPHERAL    0x04 
#define GAP_PROFILE_CENTRAL       0x08 

#define TGAP_GEN_DISC_ADV_MIN          0

#define TGAP_LIM_ADV_TIMEOUT           1

#define TGAP_GEN_DISC_SCAN             2

#define TGAP_LIM_DISC_SCAN             3

#define TGAP_CONN_EST_ADV_TIMEOUT      4

#define TGAP_CONN_PARAM_TIMEOUT        5

#define TGAP_LIM_DISC_ADV_INT_MIN      6

#define TGAP_LIM_DISC_ADV_INT_MAX      7

#define TGAP_GEN_DISC_ADV_INT_MIN      8

#define TGAP_GEN_DISC_ADV_INT_MAX      9

#define TGAP_CONN_ADV_INT_MIN         10

#define TGAP_CONN_ADV_INT_MAX         11

#define TGAP_CONN_SCAN_INT            12

#define TGAP_CONN_SCAN_WIND           13

#define TGAP_CONN_HIGH_SCAN_INT       14

#define TGAP_CONN_HIGH_SCAN_WIND      15

#define TGAP_GEN_DISC_SCAN_INT        16

#define TGAP_GEN_DISC_SCAN_WIND       17

#define TGAP_LIM_DISC_SCAN_INT        18

#define TGAP_LIM_DISC_SCAN_WIND       19


#define TGAP_CONN_EST_ADV             20

#define TGAP_CONN_EST_INT_MIN         21

#define TGAP_CONN_EST_INT_MAX         22

#define TGAP_CONN_EST_SCAN_INT        23

#define TGAP_CONN_EST_SCAN_WIND       24

#define TGAP_CONN_EST_SUPERV_TIMEOUT  25

#define TGAP_CONN_EST_LATENCY         26

#define TGAP_CONN_EST_MIN_CE_LEN      27

#define TGAP_CONN_EST_MAX_CE_LEN      28

#define TGAP_PRIVATE_ADDR_INT         29

#define TGAP_CONN_PAUSE_CENTRAL       30

#define TGAP_CONN_PAUSE_PERIPHERAL    31

#define TGAP_SM_TIMEOUT               32

#define TGAP_SM_MIN_KEY_LEN           33

#define TGAP_SM_MAX_KEY_LEN           34

#define TGAP_FILTER_ADV_REPORTS       35

#define TGAP_SCAN_RSP_RSSI_MIN        36

#define TGAP_REJECT_CONN_PARAMS       37

#if !defined ( TESTMODES )
  #define TGAP_AUTH_TASK_ID           38  
  #define TGAP_VERIFY_CAR             39  
  #define TGAP_PARAMID_MAX            40  
#else
  #define TGAP_GAP_TESTCODE           38  
  #define TGAP_SM_TESTCODE            39  
  #define TGAP_AUTH_TASK_ID           40  
  #define TGAP_VERIFY_CAR             41  
  #define TGAP_PARAMID_MAX            42  

  #define TGAP_GATT_TESTCODE          100 
  #define TGAP_ATT_TESTCODE           101 
  #define TGAP_GGS_TESTCODE           102 
  #define TGAP_L2CAP_TESTCODE         103 
#endif

#define DEVDISC_MODE_NONDISCOVERABLE  0x00    
#define DEVDISC_MODE_GENERAL          0x01    
#define DEVDISC_MODE_LIMITED          0x02    
#define DEVDISC_MODE_ALL              0x03    

#define ADDRTYPE_PUBLIC               0x00  
#define ADDRTYPE_RANDOM               0x01  
#define ADDRTYPE_PUBLIC_ID            0x02  
#define ADDRTYPE_RANDOM_ID            0x03  

#define SET_ADDRTYPE_ID               0x02  // OR with addrtype to change addr type to ID
#define MASK_ADDRTYPE_ID              0x01  // AND with addrtype to remove ID from type

#define RANDOM_ADDR_SUBTYPE_STATIC    0x00  
#define RANDOM_ADDR_SUBTYPE_RPA       0x01  
#define RANDOM_ADDR_SUBTYPE_NRPA      0x02  

#define RANDOM_ADDR_HDR_MASK          0xC0  // Get top 2 bits of address
#define STATIC_ADDR_HDR               0xC0  // Random Static Address (b11)
#define PRIVATE_NON_RESOLVE_ADDR_HDR  0x80  // Random Private Non-Resolvable Address (b10)
#define PRIVATE_RESOLVE_ADDR_HDR      0x40  // Random Private Resolvable Address (b01)

#define ADDRMODE_PUBLIC               0x00  
#define ADDRMODE_STATIC               0x01  
#define ADDRMODE_PRIVATE_NONRESOLVE   0x02  
#define ADDRMODE_PRIVATE_RESOLVE      0x03  

#define GAP_ADTYPE_ADV_IND                0x00  
#define GAP_ADTYPE_ADV_HDC_DIRECT_IND     0x01  
#define GAP_ADTYPE_ADV_SCAN_IND           0x02  
#define GAP_ADTYPE_ADV_NONCONN_IND        0x03  
#define GAP_ADTYPE_ADV_LDC_DIRECT_IND     0x04  

#define GAP_ADRPT_ADV_IND                 0x00  
#define GAP_ADRPT_ADV_DIRECT_IND          0x01  
#define GAP_ADRPT_ADV_SCAN_IND            0x02  
#define GAP_ADRPT_ADV_NONCONN_IND         0x03  
#define GAP_ADRPT_SCAN_RSP                0x04  

#define GAP_FILTER_POLICY_ALL             0x00 
#define GAP_FILTER_POLICY_WHITE_SCAN      0x01 
#define GAP_FILTER_POLICY_WHITE_CON       0x02 
#define GAP_FILTER_POLICY_WHITE           0x03 

#define GAP_DISC_FILTER_POLICY_ALL          0x00 
#define GAP_DISC_FILTER_POLICY_WHITE        0x01 
#define GAP_DISC_FILTER_POLICY_ALL_DIRECT   0x02 
#define GAP_DISC_FILTER_POLICY_WHITE_DIRECT 0x03 

#define ADV_CHANMAP_SIZE                 5  

#define GAP_PASSCODE_MAX                 999999 


#define GAP_INIT_SIGN_COUNTER            0xFFFFFFFF

#define GAP_ADVCHAN_37  0x01  
#define GAP_ADVCHAN_38  0x02  
#define GAP_ADVCHAN_39  0x04  
#define GAP_ADVCHAN_ALL (GAP_ADVCHAN_37 | GAP_ADVCHAN_38 | GAP_ADVCHAN_39) 

#define WL_NOTUSED    0x00    
#define WL_USED       0x01    

#define GAP_ADTYPE_FLAGS                        0x01 
#define GAP_ADTYPE_16BIT_MORE                   0x02 
#define GAP_ADTYPE_16BIT_COMPLETE               0x03 
#define GAP_ADTYPE_32BIT_MORE                   0x04 
#define GAP_ADTYPE_32BIT_COMPLETE               0x05 
#define GAP_ADTYPE_128BIT_MORE                  0x06 
#define GAP_ADTYPE_128BIT_COMPLETE              0x07 
#define GAP_ADTYPE_LOCAL_NAME_SHORT             0x08 
#define GAP_ADTYPE_LOCAL_NAME_COMPLETE          0x09 
#define GAP_ADTYPE_POWER_LEVEL                  0x0A 
#define GAP_ADTYPE_OOB_CLASS_OF_DEVICE          0x0D 
#define GAP_ADTYPE_OOB_SIMPLE_PAIRING_HASHC     0x0E 
#define GAP_ADTYPE_OOB_SIMPLE_PAIRING_RANDR     0x0F 
#define GAP_ADTYPE_SM_TK                        0x10 
#define GAP_ADTYPE_SM_OOB_FLAG                  0x11 
#define GAP_ADTYPE_SLAVE_CONN_INTERVAL_RANGE    0x12 
#define GAP_ADTYPE_SIGNED_DATA                  0x13 
#define GAP_ADTYPE_SERVICES_LIST_16BIT          0x14 
#define GAP_ADTYPE_SERVICES_LIST_128BIT         0x15 
#define GAP_ADTYPE_SERVICE_DATA                 0x16 
#define GAP_ADTYPE_PUBLIC_TARGET_ADDR           0x17 
#define GAP_ADTYPE_RANDOM_TARGET_ADDR           0x18 
#define GAP_ADTYPE_APPEARANCE                   0x19 
#define GAP_ADTYPE_ADV_INTERVAL                 0x1A 
#define GAP_ADTYPE_LE_BD_ADDR                   0x1B 
#define GAP_ADTYPE_LE_ROLE                      0x1C 
#define GAP_ADTYPE_SIMPLE_PAIRING_HASHC_256     0x1D 
#define GAP_ADTYPE_SIMPLE_PAIRING_RANDR_256     0x1E 
#define GAP_ADTYPE_SERVICE_DATA_32BIT           0x20 
#define GAP_ADTYPE_SERVICE_DATA_128BIT          0x21 
#define GAP_ADTYPE_3D_INFO_DATA                 0x3D 
#define GAP_ADTYPE_MANUFACTURER_SPECIFIC        0xFF 
#define GAP_ADTYPE_FLAGS_LIMITED                0x01 
#define GAP_ADTYPE_FLAGS_GENERAL                0x02 
#define GAP_ADTYPE_FLAGS_BREDR_NOT_SUPPORTED    0x04 

#define GAP_STATE_IDLE                          0x00 
#define GAP_STATE_ADV                           0x01 
#define GAP_STATE_SCAN                          0x02 
#define GAP_STATE_INIT                          0x04 

#define GAP_APPEARE_UNKNOWN                     0x0000 
#define GAP_APPEARE_GENERIC_PHONE               0x0040 
#define GAP_APPEARE_GENERIC_COMPUTER            0x0080 
#define GAP_APPEARE_GENERIC_WATCH               0x00C0 
#define GAP_APPEARE_WATCH_SPORTS                0x00C1 
#define GAP_APPEARE_GENERIC_CLOCK               0x0100 
#define GAP_APPEARE_GENERIC_DISPLAY             0x0140 
#define GAP_APPEARE_GENERIC_RC                  0x0180 
#define GAP_APPEARE_GENERIC_EYE_GALSSES         0x01C0 
#define GAP_APPEARE_GENERIC_TAG                 0x0200 
#define GAP_APPEARE_GENERIC_KEYRING             0x0240 
#define GAP_APPEARE_GENERIC_MEDIA_PLAYER        0x0280 
#define GAP_APPEARE_GENERIC_BARCODE_SCANNER     0x02C0 
#define GAP_APPEARE_GENERIC_THERMOMETER         0x0300 
#define GAP_APPEARE_GENERIC_THERMO_EAR          0x0301 
#define GAP_APPEARE_GENERIC_HR_SENSOR           0x0340 
#define GAP_APPEARE_GENERIC_HRS_BELT            0x0341 
#define GAP_APPEARE_GENERIC_BLOOD_PRESSURE      0x0380 
#define GAP_APPEARE_GENERIC_BP_ARM              0x0381 
#define GAP_APPEARE_GENERIC_BP_WRIST            0x0382 
#define GAP_APPEARE_GENERIC_HID                 0x03C0 
#define GAP_APPEARE_HID_KEYBOARD                0x03C1 
#define GAP_APPEARE_HID_MOUSE                   0x03C2 
#define GAP_APPEARE_HID_JOYSTIC                 0x03C3 
#define GAP_APPEARE_HID_GAMEPAD                 0x03C4 
#define GAP_APPEARE_HID_DIGITIZER_TYABLET       0x03C5 
#define GAP_APPEARE_HID_DIGITAL_CARDREADER      0x03C6 
#define GAP_APPEARE_HID_DIGITAL_PEN             0x03C7 
#define GAP_APPEARE_HID_BARCODE_SCANNER         0x03C8 

/*-------------------------------------------------------------------
 * TYPEDEFS - Initialization and Configuration
 */

typedef uint16 gapParamIDs_t;

typedef struct
{
  osal_event_hdr_t  hdr;           
  uint8 opcode;                    
} gapEventHdr_t;

typedef struct
{
  osal_event_hdr_t  hdr;              
  uint8 opcode;                       
  uint8 addrMode;                     
  uint8 newRandomAddr[B_ADDR_LEN];    
} gapRandomAddrEvent_t;

typedef struct
{
  uint16 intervalMin;
  uint16 intervalMax;
  uint16 latency;
  uint16 timeout;
} gapPeriConnectParams_t;

typedef struct
{
  osal_event_hdr_t  hdr;              
  uint8 opcode;                       
  uint8 devAddr[B_ADDR_LEN];          
  uint16 dataPktLen;                  
  uint8 numDataPkts;                  
} gapDeviceInitDoneEvent_t;

typedef struct
{
  osal_event_hdr_t  hdr;              
  uint8 opcode;                       
  uint8 addrType;                     
  uint8 devAddr[B_ADDR_LEN];          
  uint32 signCounter;                 
} gapSignUpdateEvent_t;

typedef struct
{
  osal_event_hdr_t  hdr;    
  uint8 opcode;             
  uint8 eventType;          
  uint8 addrType;           
  uint8 addr[B_ADDR_LEN];   
  int8 rssi;                
  uint8 dataLen;            
  uint8 *pEvtData;          
} gapDeviceInfoEvent_t;
 // end of GAP_Events

/*-------------------------------------------------------------------
 * TYPEDEFS - Device Discovery
 */

typedef struct
{
  uint8 taskID;              
  uint8 mode;                
  uint8 activeScan;          
  uint8 whiteList;           
} gapDevDiscReq_t;

typedef struct
{
  uint8 eventType;           
  uint8 addrType;            
  uint8 addr[B_ADDR_LEN];    
} gapDevRec_t;

typedef struct
{
  osal_event_hdr_t  hdr;    
  uint8 opcode;             
  uint8 numDevs;            
  gapDevRec_t *pDevList;    
} gapDevDiscEvent_t;
 // end of GAP_Events

typedef struct
{
  uint8 eventType;          
  uint8 initiatorAddrType;  
  uint8 initiatorAddr[B_ADDR_LEN];  
  uint8 channelMap;         
  uint8 filterPolicy;       
} gapAdvertisingParams_t;

typedef struct
{
  osal_event_hdr_t  hdr; 
  uint8 opcode;          
} gapMakeDiscoverableRspEvent_t;

typedef struct
{
  osal_event_hdr_t  hdr; 
  uint8 opcode;          
} gapEndDiscoverableRspEvent_t;

typedef struct
{
  osal_event_hdr_t  hdr; 
  uint8 opcode;          
  uint8 adType;          
} gapAdvDataUpdateEvent_t;
 // end of GAP_Events

/*-------------------------------------------------------------------
 * TYPEDEFS - Link Establishment
 */

typedef struct
{
  uint8 taskID;               
  uint8 highDutyCycle;        
  uint8 whiteList;            
  uint8 addrTypePeer;         
  uint8 peerAddr[B_ADDR_LEN]; 
} gapEstLinkReq_t;

typedef struct
{
  uint16 connectionHandle; 
  uint16 intervalMin;      
  uint16 intervalMax;      
  uint16 connLatency;      
  uint16 connTimeout;      
} gapUpdateLinkParamReq_t;

typedef struct
{
  uint16 connectionHandle; 
  uint16 intervalMin;      
  uint16 intervalMax;      
  uint16 connLatency;      
  uint16 connTimeout;      
  uint8  accepted;         
} gapUpdateLinkParamReqReply_t;

typedef struct
{
  osal_event_hdr_t  hdr;              
  uint8 opcode;                       
  gapUpdateLinkParamReq_t req;        
} gapUpdateLinkParamReqEvent_t;

typedef struct
{
  osal_event_hdr_t  hdr;     
  uint8 opcode;              
  uint8 devAddrType;         
  uint8 devAddr[B_ADDR_LEN]; 
  uint16 connectionHandle;   
  uint8 connRole;            
  uint16 connInterval;       
  uint16 connLatency;        
  uint16 connTimeout;        
  uint8 clockAccuracy;       
} gapEstLinkReqEvent_t;

typedef struct
{
  osal_event_hdr_t hdr;     
  uint8 opcode;             
  uint8 status;             
  uint16 connectionHandle;  
  uint16 connInterval;      
  uint16 connLatency;       
  uint16 connTimeout;       
} gapLinkUpdateEvent_t;

typedef struct
{
  osal_event_hdr_t  hdr;   
  uint8 opcode;            
  uint16 connectionHandle; 
  uint8 reason;            
} gapTerminateLinkEvent_t;

/*-------------------------------------------------------------------
 * TYPEDEFS - Authentication, Bounding and Pairing
 */

typedef struct
{
  osal_event_hdr_t  hdr;        
  uint8 opcode;                 
  uint8 deviceAddr[B_ADDR_LEN]; 
  uint16 connectionHandle;      
  uint8 uiInputs;               
  uint8 uiOutputs;              
  uint32 numComparison;         
} gapPasskeyNeededEvent_t;

typedef struct
{
  osal_event_hdr_t  hdr;           
  uint8 opcode;                    
  uint16 connectionHandle;         
  uint8 authState;                 
  smSecurityInfo_t *pSecurityInfo; 
  smSigningInfo_t *pSigningInfo;   
  smSecurityInfo_t *pDevSecInfo;   
  smIdentityInfo_t *pIdentityInfo; 
} gapAuthCompleteEvent_t;
 // end of GAP_Events

typedef struct
{
  uint16 connectionHandle;      
  smLinkSecurityReq_t  secReqs; 
} gapAuthParams_t;

typedef struct
{
  osal_event_hdr_t  hdr;        
  uint8 opcode;                 
  uint16 connectionHandle;      
  uint8 deviceAddr[B_ADDR_LEN]; 
  uint8 authReq;                
} gapSlaveSecurityReqEvent_t;

typedef struct
{
  osal_event_hdr_t  hdr;   
  uint8 opcode;            
  uint16 connectionHandle; 
} gapBondCompleteEvent_t;
 // end of GAP_Events

typedef struct
{
  uint8 ioCap;         
  uint8 oobDataFlag;   
  uint8 authReq;       
  uint8 maxEncKeySize; 
  keyDist_t keyDist;   
} gapPairingReq_t;

typedef struct
{
  osal_event_hdr_t hdr;    
  uint8 opcode;            
  uint16 connectionHandle; 
  gapPairingReq_t pairReq; 
} gapPairingReqEvent_t;
 // end of GAP_Events

typedef struct
{
  uint8 adType;     
  uint8 attrLen;    
  uint8 *pAttrData; 
} gapAdvDataToken_t;

typedef uint8 (*pfnSuppEnhPrivCB_t)
(
  uint8  *deviceAddr                   
);

typedef void (*pfnGapIdleCB_t)();

typedef struct
{
  pfnSuppEnhPrivCB_t        supportEnhPrivCB;  
  pfnGapIdleCB_t            gapIdleCB;         
} gapBondMgrCBs_t;

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

/*-------------------------------------------------------------------
 * FUNCTIONS - Initialization and Configuration
 */

  extern bStatus_t GAP_DeviceInit(  uint8 taskID,
                           uint8 profileRole,
                           uint8 maxScanResponses,
                           uint8 *pIRK,
                           uint8 *pSRK,
                           uint32 *pSignCounter );

  extern bStatus_t GAP_SetAdvToken( gapAdvDataToken_t *pToken );

  extern gapAdvDataToken_t *GAP_GetAdvToken( uint8 adType );

  extern gapAdvDataToken_t *GAP_RemoveAdvToken( uint8 adType );

  extern bStatus_t GAP_UpdateAdvTokens( void );

  extern bStatus_t GAP_SetParamValue( gapParamIDs_t paramID, uint16 paramValue );

  extern uint16 GAP_GetParamValue( gapParamIDs_t paramID );

  extern bStatus_t GAP_ConfigDeviceAddr( uint8 addrMode, uint8 *pStaticAddr );

  extern void GAP_RegisterForMsgs( uint8 taskID );

  extern void GAP_RegisterBondMgrCBs( gapBondMgrCBs_t *pCBs );

/*-------------------------------------------------------------------
 * FUNCTIONS - Device Discovery
 */

  extern bStatus_t GAP_DeviceDiscoveryRequest( gapDevDiscReq_t *pParams );

  extern bStatus_t GAP_DeviceDiscoveryCancel( uint8 taskID );

  extern bStatus_t GAP_MakeDiscoverable( uint8 taskID, gapAdvertisingParams_t *pParams );

  extern bStatus_t GAP_UpdateAdvertisingData( uint8 taskID, uint8 adType,
                                      uint8 dataLen, uint8 *pAdvertData );

  extern bStatus_t GAP_EndDiscoverable( uint8 taskID );

#if !defined (BLE_V42_FEATURES) || !(BLE_V42_FEATURES & PRIVACY_1_2_CFG)

  extern bStatus_t GAP_ResolvePrivateAddr( uint8 *pIRK, uint8 *pAddr );
#endif // ! BLE_V42_FEATURES | ! PRIVACY_1_2_CFG

/*-------------------------------------------------------------------
 * FUNCTIONS - Link Establishment
 */

  extern bStatus_t GAP_EstablishLinkReq( gapEstLinkReq_t *pParams );

  extern bStatus_t GAP_TerminateLinkReq( uint8 taskID, uint16 connectionHandle, uint8 reason );

  extern bStatus_t GAP_UpdateLinkParamReq( gapUpdateLinkParamReq_t *pParams );

  extern bStatus_t GAP_UpdateLinkParamReqReply(gapUpdateLinkParamReqReply_t *pParams);

  extern uint8 GAP_NumActiveConnections( void );

/*-------------------------------------------------------------------
 * FUNCTIONS - Pairing
 */

  extern bStatus_t GAP_Authenticate( gapAuthParams_t *pParams, gapPairingReq_t *pPairReq );

  extern uint8 GAP_isPairing(void);

  extern bStatus_t GAP_TerminateAuth( uint16 connectionHandle, uint8 reason );

  extern bStatus_t GAP_PasskeyUpdate( uint8 *pPasskey, uint16 connectionHandle );

  extern bStatus_t GAP_PasscodeUpdate( uint32 passcode, uint16 connectionHandle );

  extern bStatus_t GAP_SendSlaveSecurityRequest( uint16 connectionHandle, uint8 authReq );

  extern bStatus_t GAP_Signable( uint16 connectionHandle, uint8 authenticated, smSigningInfo_t *pParams );

  extern bStatus_t GAP_Bond( uint16 connectionHandle, uint8 authenticated,
                             uint8 secureConnections, smSecurityInfo_t *pParams,
                             uint8 startEncryption );

/*-------------------------------------------------------------------
 * Internal API - These functions are only called from gap.c module.
 */


  extern bStatus_t GAP_ParamsInit( uint8 taskID, uint8 profileRole );

  extern void GAP_PrivacyInit( uint8 *pIRK );

  extern uint8 *GAP_GetIRK( void );

  extern void GAP_SecParamsInit( uint8 *pSRK, uint32 *pSignCounter );

  extern bStatus_t GAP_PeriDevMgrInit( void );

  extern void GAP_PeriConnRegister( void );

  extern bStatus_t GAP_CentDevMgrInit( uint8 maxScanResponses );

  extern void GAP_CentConnRegister( void );


/*-------------------------------------------------------------------
 * TASK API - These functions must only be called OSAL.
 */

  extern void GAP_Init( uint8 task_id );

  extern uint16 GAP_ProcessEvent( uint8 task_id, uint16 events );


/*-------------------------------------------------------------------
-------------------------------------------------------------------*/

#ifdef __cplusplus
}
#endif

#endif /* GAP_H */