TI BLE5-Stack API Documentation  9.14.00
Data Structures | Macros | Typedefs | Enumerations | Functions
gap.h File Reference
GAP

Detailed Description

GAP layer interface.

Go to the source code of this file.

Data Structures

struct  Gap_ConnEventRpt_t
 
struct  gapAuthCompleteEvent_t
 
struct  gapAuthParams_t
 
struct  gapBondCompleteEvent_t
 
struct  gapBondLostEvent_t
 
struct  gapBondMgrCBs_t
 Callback Registration Structure. More...
 
struct  gapDeviceInitDoneEvent_t
 
struct  gapEstLinkReqEvent_t
 
struct  gapEventHdr_t
 GAP event header format. More...
 
struct  gapLinkUpdateEvent_t
 
struct  gapPairingReq_t
 
struct  gapPairingReqEvent_t
 
struct  gapPasskeyNeededEvent_t
 
struct  gapPeriConnectParams_t
 
struct  gapPeripheralSecurityReqEvent_t
 
struct  gapSignUpdateEvent_t
 
struct  gapTerminateLinkEvent_t
 
struct  gapUpdateLinkParamReq_t
 
struct  gapUpdateLinkParamReqEvent_t
 GAP_UPDATE_LINK_PARAM_REQ_EVENT message format. More...
 
struct  gapUpdateLinkParamReqReply_t
 

Macros

#define GAP_ADTYPE_128BIT_COMPLETE   0x07
 Service: Complete list of 128-bit UUIDs. More...
 
#define GAP_ADTYPE_128BIT_MORE   0x06
 Service: More 128-bit UUIDs available. More...
 
#define GAP_ADTYPE_16BIT_COMPLETE   0x03
 Service: Complete list of 16-bit UUIDs. More...
 
#define GAP_ADTYPE_16BIT_MORE   0x02
 Service: More 16-bit UUIDs available. More...
 
#define GAP_ADTYPE_32BIT_COMPLETE   0x05
 Service: Complete list of 32-bit UUIDs. More...
 
#define GAP_ADTYPE_32BIT_MORE   0x04
 Service: More 32-bit UUIDs available. More...
 
#define GAP_ADTYPE_3D_INFO_DATA   0x3D
 3D Information Data More...
 
#define GAP_ADTYPE_ADV_INTERVAL   0x1A
 Advertising Interval. More...
 
#define GAP_ADTYPE_APPEARANCE   0x19
 Appearance. More...
 
#define GAP_ADTYPE_FLAGS   0x01
 Gap Advertising Flags. More...
 
#define GAP_ADTYPE_FLAGS_BREDR_NOT_SUPPORTED   0x04
 Discovery Mode: BR/EDR Not Supported. More...
 
#define GAP_ADTYPE_FLAGS_GENERAL   0x02
 Discovery Mode: LE General Discoverable Mode. More...
 
#define GAP_ADTYPE_FLAGS_LIMITED   0x01
 Discovery Mode: LE Limited Discoverable Mode. More...
 
#define GAP_ADTYPE_LE_BD_ADDR   0x1B
 LE Bluetooth Device Address. More...
 
#define GAP_ADTYPE_LE_ROLE   0x1C
 LE Role. More...
 
#define GAP_ADTYPE_LOCAL_NAME_COMPLETE   0x09
 Complete local name. More...
 
#define GAP_ADTYPE_LOCAL_NAME_SHORT   0x08
 Shortened local name. More...
 
#define GAP_ADTYPE_MANUFACTURER_SPECIFIC   0xFF
 
#define GAP_ADTYPE_OOB_CLASS_OF_DEVICE   0x0D
 Simple Pairing OOB Tag: Class of device (3 octets) More...
 
#define GAP_ADTYPE_OOB_SIMPLE_PAIRING_HASHC   0x0E
 Simple Pairing OOB Tag: Simple Pairing Hash C (16 octets) More...
 
#define GAP_ADTYPE_OOB_SIMPLE_PAIRING_RANDR   0x0F
 Simple Pairing OOB Tag: Simple Pairing Randomizer R (16 octets) More...
 
#define GAP_ADTYPE_PERIPHERAL_CONN_INTERVAL_RANGE   0x12
 
#define GAP_ADTYPE_POWER_LEVEL   0x0A
 TX Power Level: 0xXX: -127 to +127 dBm. More...
 
#define GAP_ADTYPE_PUBLIC_TARGET_ADDR   0x17
 Public Target Address. More...
 
#define GAP_ADTYPE_RANDOM_TARGET_ADDR   0x18
 Random Target Address. More...
 
#define GAP_ADTYPE_SERVICE_DATA   0x16
 Service Data - 16-bit UUID. More...
 
#define GAP_ADTYPE_SERVICE_DATA_128BIT   0x21
 Service Data - 128-bit UUID. More...
 
#define GAP_ADTYPE_SERVICE_DATA_32BIT   0x20
 Service Data - 32-bit UUID. More...
 
#define GAP_ADTYPE_SERVICES_LIST_128BIT   0x15
 Service Solicitation: list of 128-bit Service UUIDs. More...
 
#define GAP_ADTYPE_SERVICES_LIST_16BIT   0x14
 Service Solicitation: list of 16-bit Service UUIDs. More...
 
#define GAP_ADTYPE_SIGNED_DATA   0x13
 Signed Data field. More...
 
#define GAP_ADTYPE_SIMPLE_PAIRING_HASHC_256   0x1D
 Simple Pairing Hash C-256. More...
 
#define GAP_ADTYPE_SIMPLE_PAIRING_RANDR_256   0x1E
 Simple Pairing Randomizer R-256. More...
 
#define GAP_ADTYPE_SM_OOB_FLAG   0x11
 Security Manager OOB Flags. More...
 
#define GAP_ADTYPE_SM_TK   0x10
 Security Manager TK Value. More...
 
#define GAP_ADV_REMOVE_SET_EVENT   0x13
 Sent when an advertising set needs to be removed. This is an internal event. More...
 
#define GAP_ADV_SET_PERIODIC_ADV_DATA_EVENT   0x1A
 Set periodic advertising data command complete event. More...
 
#define GAP_ADV_SET_PERIODIC_ADV_ENABLE_EVENT   0x1B
 Set periodic advertising enable command complete event. More...
 
#define GAP_ADV_SET_PERIODIC_ADV_PARAMS_EVENT   0x19
 Set periodic advertising parameters command complete event. More...
 
#define GAP_APPEARE_GENERIC_BARCODE_SCANNER   0x02C0
 Generic Barcode Scanner. More...
 
#define GAP_APPEARE_GENERIC_BLOOD_PRESSURE   0x0380
 Generic Blood Pressure. More...
 
#define GAP_APPEARE_GENERIC_BP_ARM   0x0381
 Blood Pressure: Arm. More...
 
#define GAP_APPEARE_GENERIC_BP_WRIST   0x0382
 Blood Pressure: Wrist. More...
 
#define GAP_APPEARE_GENERIC_CLOCK   0x0100
 Generic Clock. More...
 
#define GAP_APPEARE_GENERIC_COMPUTER   0x0080
 Generic Computer. More...
 
#define GAP_APPEARE_GENERIC_DISPLAY   0x0140
 Generic Display. More...
 
#define GAP_APPEARE_GENERIC_EYE_GALSSES   0x01C0
 Generic Eye-glasses. More...
 
#define GAP_APPEARE_GENERIC_HID   0x03C0
 Generic Human Interface Device (HID) More...
 
#define GAP_APPEARE_GENERIC_HR_SENSOR   0x0340
 Generic Heart rate Sensor. More...
 
#define GAP_APPEARE_GENERIC_HRS_BELT   0x0341
 Heart Rate Sensor: Heart Rate Belt. More...
 
#define GAP_APPEARE_GENERIC_KEYRING   0x0240
 Generic Keyring. More...
 
#define GAP_APPEARE_GENERIC_MEDIA_PLAYER   0x0280
 Generic Media Player. More...
 
#define GAP_APPEARE_GENERIC_PHONE   0x0040
 Generic Phone. More...
 
#define GAP_APPEARE_GENERIC_RC   0x0180
 Generic Remote Control. More...
 
#define GAP_APPEARE_GENERIC_TAG   0x0200
 Generic Tag. More...
 
#define GAP_APPEARE_GENERIC_THERMO_EAR   0x0301
 Thermometer: Ear. More...
 
#define GAP_APPEARE_GENERIC_THERMOMETER   0x0300
 Generic Thermometer. More...
 
#define GAP_APPEARE_GENERIC_WATCH   0x00C0
 Generic Watch. More...
 
#define GAP_APPEARE_HID_BARCODE_SCANNER   0x03C8
 HID Barcode Scanner. More...
 
#define GAP_APPEARE_HID_DIGITAL_CARDREADER   0x03C6
 HID Card Reader. More...
 
#define GAP_APPEARE_HID_DIGITAL_PEN   0x03C7
 HID Digital Pen. More...
 
#define GAP_APPEARE_HID_DIGITIZER_TYABLET   0x03C5
 HID Digitizer Tablet. More...
 
#define GAP_APPEARE_HID_GAMEPAD   0x03C4
 HID Gamepad. More...
 
#define GAP_APPEARE_HID_JOYSTIC   0x03C3
 HID Joystick. More...
 
#define GAP_APPEARE_HID_KEYBOARD   0x03C1
 HID Keyboard. More...
 
#define GAP_APPEARE_HID_MOUSE   0x03C2
 HID Mouse. More...
 
#define GAP_APPEARE_UNKNOWN   0x0000
 Unknown. More...
 
#define GAP_APPEARE_WATCH_SPORTS   0x00C1
 Watch: Sports Watch. More...
 
#define GAP_AUTHENTICATION_COMPLETE_EVENT   0x0A
 
#define GAP_AUTHENTICATION_FAILURE_EVT   0x10
 
#define GAP_BOND_COMPLETE_EVENT   0x0E
 
#define GAP_BOND_LOST_EVENT   0x17
 
#define GAP_CONNECTING_CANCELLED_EVENT   0x15
 
#define GAP_DEVICE_INIT_DONE_EVENT   0x00
 
#define GAP_EVT_ADV_DATA_TRUNCATED   (uint32_t)BV(6)
 
#define GAP_EVT_ADV_END   (uint32_t)BV(3)
 
#define GAP_EVT_ADV_END_AFTER_DISABLE   (uint32_t)BV(1)
 
#define GAP_EVT_ADV_EVT_MASK
 Mask for all advertising events. More...
 
#define GAP_EVT_ADV_REPORT   (uint32_t)BV(22)
 
#define GAP_EVT_ADV_REPORT_FULL   (uint32_t)BV(23)
 
#define GAP_EVT_ADV_SET_TERMINATED   (uint32_t)BV(4)
 
#define GAP_EVT_ADV_START   (uint32_t)BV(2)
 
#define GAP_EVT_ADV_START_AFTER_ENABLE   (uint32_t)BV(0)
 
#define GAP_EVT_INSUFFICIENT_MEMORY   (uint32_t)BV(31)
 A memory failure has occurred. More...
 
#define GAP_EVT_SCAN_DISABLED   (uint32_t)BV(17)
 
#define GAP_EVT_SCAN_DUR_ENDED   (uint32_t)BV(19)
 Scan duration has ended. More...
 
#define GAP_EVT_SCAN_ENABLED   (uint32_t)BV(16)
 Scanner has been enabled. More...
 
#define GAP_EVT_SCAN_EVT_MASK
 Mask for all scan events. More...
 
#define GAP_EVT_SCAN_INT_ENDED   (uint32_t)BV(20)
 
#define GAP_EVT_SCAN_PRD_ENDED   (uint32_t)BV(18)
 
#define GAP_EVT_SCAN_REQ_RECEIVED   (uint32_t)BV(5)
 
#define GAP_EVT_SCAN_WND_ENDED   (uint32_t)BV(21)
 Scan window has ended. More...
 
#define GAP_IS_ADDR_RAND(pAddr)
 
#define GAP_IS_ADDR_RPN(pAddr)
 
#define GAP_IS_ADDR_RPR(pAddr)
 
#define GAP_IS_ADDR_RS(pAddr)
 
#define GAP_LINK_ESTABLISHED_EVENT   0x05
 
#define GAP_LINK_PARAM_UPDATE_EVENT   0x07
 
#define GAP_LINK_PARAM_UPDATE_REJECT_EVENT   0x18
 
#define GAP_LINK_TERMINATED_EVENT   0x06
 
#define GAP_PAIRING_REQ_EVENT   0x0F
 
#define GAP_PASSKEY_NEEDED_EVENT   0x0B
 
#define GAP_PERIPHERAL_REQUESTED_SECURITY_EVENT   0x0C
 
#define GAP_PRIVACY_MODE_DEVICE   1
 Device Privacy Mode. More...
 
#define GAP_PRIVACY_MODE_NETWORK   0
 Network Privacy Mode. More...
 
#define GAP_PROFILE_BROADCASTER   0x01U
 A device that sends advertising events only. More...
 
#define GAP_PROFILE_CENTRAL   0x08U
 
#define GAP_PROFILE_OBSERVER   0x02U
 A device that receives advertising events only. More...
 
#define GAP_PROFILE_PERIPHERAL   0x04U
 
#define GAP_SCAN_ADD_DEVICE_ADV_LIST_EVENT   0x20
 Add device to period advertisers list command complete event. More...
 
#define GAP_SCAN_CLEAR_ADV_LIST_EVENT   0x23
 Clear period advertisers list command complete event. More...
 
#define GAP_SCAN_CREATE_SYNC_EVENT   0x1C
 
#define GAP_SCAN_PERIODIC_ADV_REPORT_EVENT   0x26
 
#define GAP_SCAN_PERIODIC_ADV_SYNC_EST_EVENT   0x24
 
#define GAP_SCAN_PERIODIC_ADV_SYNC_LOST_EVENT   0x25
 
#define GAP_SCAN_PERIODIC_RECEIVE_EVENT   0x1F
 Periodic advertising receive enable command complete event. More...
 
#define GAP_SCAN_READ_ADV_LIST_SIZE_EVENT   0x22
 Read period advertisers list size command complete event. More...
 
#define GAP_SCAN_REMOVE_DEVICE_ADV_LIST_EVENT   0x21
 Remove device from period advertisers list create sync command complete event. More...
 
#define GAP_SCAN_SESSION_END_EVENT   0x12
 Sent when an advertising report session ends. This is an internal event. More...
 
#define GAP_SCAN_SYNC_CANCEL_EVENT   0x1D
 Periodic advertising create sync command complete event. More...
 
#define GAP_SCAN_TERMINATE_SYNC_EVENT   0x1E
 Periodic advertising terminate sync command complete event. More...
 
#define GAP_SIGNATURE_UPDATED_EVENT   0x09
 
#define GAP_STATE_ADV   0x01U
 Device is advertising. More...
 
#define GAP_STATE_IDLE   0x00U
 Device is idle. More...
 
#define GAP_STATE_INIT   0x04U
 Device is establishing a connection. More...
 
#define GAP_STATE_SCAN   0x02U
 Device is scanning. More...
 
#define GAP_UPDATE_LINK_PARAM_REQ_EVENT   0x11
 
#define MASK_ADDRTYPE_ID   0x01
 AND with addrtype to remove ID from type. More...
 
#define PRIVATE_NON_RESOLVE_ADDR_HDR   0x80
 Random Private Non-Resolvable Address (b10) More...
 
#define PRIVATE_RESOLVE_ADDR_HDR   0x40
 Random Private Resolvable Address (b01) More...
 
#define RANDOM_ADDR_HDR_MASK   0xC0
 Get top 2 bits of address. More...
 
#define SET_ADDRTYPE_ID   0x02
 OR with addrtype to change addr type to ID. More...
 
#define STATIC_ADDR_HDR   0xC0
 Random Static Address (b11) More...
 

Typedefs

typedef void(* pfnGapCB_t) (uint32_t event, void *pBuf, uintptr_t arg)
 
typedef void(* pfnGapConnEvtCB_t) (Gap_ConnEventRpt_t *pReport)
 
typedef uint8_t(* pfnGapDevPrivModeCB_t) (GAP_Peer_Addr_Types_t addrType, uint8_t *pAddr)
 GAP Device Privacy Mode Callback Function. More...
 
typedef void(* pfnGapIdleCB_t) ()
 GAP Idle Callback Function. More...
 
typedef uint8_t(* pfnSuppCentAddrRes_t) (uint8_t *deviceAddr, GAP_Peer_Addr_Types_t addrType)
 Central Address Resolution (CAR) Support Callback Function. More...
 

Enumerations

enum  GAP_Addr_Modes_t { ADDRMODE_PUBLIC = 0x00, ADDRMODE_RANDOM = 0x01, ADDRMODE_RP_WITH_PUBLIC_ID = 0x02, ADDRMODE_RP_WITH_RANDOM_ID = 0x03 }
 Address modes to initialize the local device. More...
 
enum  GAP_Addr_Types_t {
  ADDRTYPE_PUBLIC = 0x00, ADDRTYPE_RANDOM = 0x01, ADDRTYPE_PUBLIC_ID = 0x02, ADDRTYPE_RANDOM_ID = 0x03,
  ADDRTYPE_RANDOM_NR = 0xFE, ADDRTYPE_NONE = 0xFF
}
 Address types used for identifying peer address type. More...
 
enum  GAP_CB_Action_t { GAP_CB_REGISTER, GAP_CB_UNREGISTER }
 
enum  GAP_CB_Event_e { GAP_CB_EVENT_INVALID = 0x00, GAP_CB_CONN_ESTABLISHED = 0x01, GAP_CB_PHY_UPDATE = 0x02, GAP_CB_CONN_EVENT_ALL = 0xFF }
 
enum  Gap_configParamIds_t { GAP_CONFIG_PARAM_IRK, GAP_CONFIG_PARAM_SRK, GAP_CONFIG_PARAM_IRK_UPDATE_IMMED }
 
enum  GAP_ConnEvtPhy_t { GAP_CONN_EVT_PHY_1MBPS = 1, GAP_CONN_EVT_PHY_2MBPS = 2, GAP_CONN_EVT_PHY_CODED = 4 }
 
enum  GAP_ConnEvtStat_t { GAP_CONN_EVT_STAT_SUCCESS = LL_CONN_EVT_STAT_SUCCESS, GAP_CONN_EVT_STAT_CRC_ERROR = LL_CONN_EVT_STAT_CRC_ERROR, GAP_CONN_EVT_STAT_MISSED = LL_CONN_EVT_STAT_MISSED }
 
enum  GAP_ConnEvtTaskType_t {
  GAP_CONN_EVT_TASK_TYPE_ADV = LL_TASK_ID_ADVERTISER, GAP_CONN_EVT_TASK_TYPE_INIT = LL_TASK_ID_INITIATOR, GAP_CONN_EVT_TASK_TYPE_PERIPHERAL = LL_TASK_ID_PERIPHERAL, GAP_CONN_EVT_TASK_TYPE_SCAN = LL_TASK_ID_SCANNER,
  GAP_CONN_EVT_TASK_TYPE_CENTRAL = LL_TASK_ID_CENTRAL, GAP_CONN_EVT_TASK_TYPE_NONE = LL_TASK_ID_NONE
}
 
enum  Gap_ParamIDs_t {
  GAP_PARAM_LINK_UPDATE_DECISION, GAP_PARAM_CONN_PARAM_TIMEOUT, GAP_PARAM_PRIVATE_ADDR_INT, GAP_PARAM_SM_TIMEOUT,
  GAP_PARAM_SM_MIN_KEY_LEN, GAP_PARAM_SM_MAX_KEY_LEN
}
 
enum  GAP_Peer_Addr_Types_t { PEER_ADDRTYPE_PUBLIC_OR_PUBLIC_ID = 0x00, PEER_ADDRTYPE_RANDOM_OR_RANDOM_ID = 0x01 }
 Address types used for specifying peer address type. More...
 
enum  Gap_updateDecision_t { GAP_UPDATE_REQ_ACCEPT_ALL, GAP_UPDATE_REQ_DENY_ALL, GAP_UPDATE_REQ_PASS_TO_APP }
 

Functions

bStatus_t GAP_Authenticate (gapAuthParams_t *pParams, gapPairingReq_t *pPairReq)
 
bStatus_t GAP_Bond (uint16_t connectionHandle, uint8_t authenticated, uint8_t secureConnections, smSecurityInfo_t *pParams, uint8_t startEncryption)
 
bStatus_t gap_checkLtk_GapBondMgr (uint16_t connectionHandle)
 Checks the Long Term Key (LTK) for a given connection using the GAP Bond Manager. If GAP Bond Manager is used, this function will always return SUCCESS because the LTK is stored in the bond manager. More...
 
bStatus_t gap_checkLtk_noGapBondMgr (uint16_t connectionHandle)
 Checks the Long Term Key (LTK) for a given connection without using the GAP Bond Manager. More...
 
bStatus_t GAP_DeviceInit (uint8_t profileRole, uint8_t taskID, GAP_Addr_Modes_t addrMode, uint8_t *pRandomAddr)
 
uint8_t * GAP_GetDevAddress (uint8 wantIA)
 
uint8 * GAP_GetDevAddressByType (uint8 wantIA, uint8 deviceAddrType)
 
uint8_t * GAP_GetIRK (void)
 
uint16_t GAP_GetParamValue (uint16_t paramID)
 
uint8_t * GAP_GetSRK (void)
 
void GAP_Init (uint8_t task_id)
 
uint8_t GAP_isPairing (void)
 
uint8_t GAP_NumActiveConnections (void)
 
bStatus_t GAP_PasscodeUpdate (uint32_t passcode, uint16_t connectionHandle)
 
bStatus_t GAP_PasskeyUpdate (uint8_t *pPasskey, uint16_t connectionHandle)
 
uint32 GAP_ProcessEvent (uint8_t task_id, uint32 events)
 
void GAP_RegisterBondMgrCBs (gapBondMgrCBs_t *pCBs)
 
bStatus_t Gap_RegisterConnEventCb (pfnGapConnEvtCB_t cb, GAP_CB_Action_t action, GAP_CB_Event_e event, uint16_t connHandle)
 
void GAP_RegisterForMsgs (uint8_t taskID)
 
bStatus_t Gap_ReplyToLTKReq (uint16_t connectionHandle, smSecurityInfo_t *const pParams, uint8_t *isLTKUpdated)
 
bStatus_t GAP_SendPeripheralSecurityRequest (uint16_t connectionHandle, uint8_t authReq)
 
bStatus_t GAP_SetParamValue (uint16_t paramID, uint16_t paramValue)
 
bStatus_t GAP_SetPrivacyMode (GAP_Peer_Addr_Types_t addrType, uint8_t *pAddr, uint8_t mode)
 
bStatus_t GAP_Signable (uint16_t connectionHandle, uint8_t authenticated, smSigningInfo_t *pParams)
 
bStatus_t GAP_TerminateAuth (uint16_t connectionHandle, uint8_t reason)
 
bStatus_t GAP_TerminateLinkReq (uint16_t connectionHandle, uint8_t reason)
 
bStatus_t GAP_UpdateLinkParamReq (gapUpdateLinkParamReq_t *pParams)
 
bStatus_t GAP_UpdateLinkParamReqReply (gapUpdateLinkParamReqReply_t *pParams)
 
bStatus_t GapConfig_SetParameter (Gap_configParamIds_t param, void *pValue)
 
© Copyright 1995-2025, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale