TI BLE5-Stack API Documentation  1.01.12.00
gap.h
Go to the documentation of this file.
1 /******************************************************************************
2 
3  Group: WCS, BTS
4  $Target Device: DEVICES $
5 
6  ******************************************************************************
7  $License: TISD 2009 $
8  ******************************************************************************
9  $Release Name: PACKAGE NAME $
10  $Release Date: PACKAGE RELEASE DATE $
11  *****************************************************************************/
12 
21 #ifndef GAP_H
22 #define GAP_H
23 
24 #ifdef __cplusplus
25 extern "C"
26 {
27 #endif
28 
29 /*-------------------------------------------------------------------
30  * INCLUDES
31  */
32 #include <stdbool.h>
33 #include "bcomdef.h"
34 #include "osal.h"
35 #include "sm.h"
36 #include "ll_ae.h"
37 
38 /*-------------------------------------------------------------------
39  * MACROS
40  */
42 #ifndef status_t
43  #define status_t bStatus_t
44 #endif
45 
55 #define GAP_IS_ADDR_RPR(pAddr) ((pAddr[B_ADDR_LEN-1] & RANDOM_ADDR_HDR_MASK) \
56  == PRIVATE_RESOLVE_ADDR_HDR)
57 
66 #define GAP_IS_ADDR_RPN(pAddr) ((pAddr[B_ADDR_LEN-1] & RANDOM_ADDR_HDR_MASK) \
67  == PRIVATE_NON_RESOLVE_ADDR_HDR)
68 
77 #define GAP_IS_ADDR_RS(pAddr) ((pAddr[B_ADDR_LEN-1] & RANDOM_ADDR_HDR_MASK) \
78  == STATIC_ADDR_HDR)
79 
83 #define GAP_IS_ADDR_RAND(pAddr) (GAP_IS_ADDR_RPR(pAddr) | \
84  GAP_IS_ADDR_RPN(pAddr) | \
85  GAP_IS_ADDR_RS(pAddr))
86 
87 /*-------------------------------------------------------------------
88  * CONSTANTS
89  */
90 
107 #define GAP_DEVICE_INIT_DONE_EVENT 0x00
108 
111 #define GAP_LINK_ESTABLISHED_EVENT 0x05
112 
115 #define GAP_LINK_TERMINATED_EVENT 0x06
116 
121 #define GAP_LINK_PARAM_UPDATE_EVENT 0x07
122 
128 #define GAP_SIGNATURE_UPDATED_EVENT 0x09
129 
134 #define GAP_AUTHENTICATION_COMPLETE_EVENT 0x0A
135 
140 #define GAP_PASSKEY_NEEDED_EVENT 0x0B
141 
147 #define GAP_SLAVE_REQUESTED_SECURITY_EVENT 0x0C
148 
153 #define GAP_BOND_COMPLETE_EVENT 0x0E
154 
160 #define GAP_PAIRING_REQ_EVENT 0x0F
161 
167 #define GAP_AUTHENTICATION_FAILURE_EVT 0x10
168 
174 #define GAP_UPDATE_LINK_PARAM_REQ_EVENT 0x11
175 #define GAP_SCAN_SESSION_END_EVENT 0x12
177 #define GAP_ADV_REMOVE_SET_EVENT 0x13
179 
182 #define GAP_CONNECTING_CANCELLED_EVENT 0x15
183 
199 #define GAP_EVT_ADV_START_AFTER_ENABLE (uint32_t)BV(0)
200 
205 #define GAP_EVT_ADV_END_AFTER_DISABLE (uint32_t)BV(1)
206 
212 #define GAP_EVT_ADV_START (uint32_t)BV(2)
213 
219 #define GAP_EVT_ADV_END (uint32_t)BV(3)
220 
226 #define GAP_EVT_ADV_SET_TERMINATED (uint32_t)BV(4)
227 
232 #define GAP_EVT_SCAN_REQ_RECEIVED (uint32_t)BV(5)
233 
239 #define GAP_EVT_ADV_DATA_TRUNCATED (uint32_t)BV(6)
240 #define GAP_EVT_SCAN_ENABLED (uint32_t)BV(16)
242 
248 #define GAP_EVT_SCAN_DISABLED (uint32_t)BV(17)
249 
254 #define GAP_EVT_SCAN_PRD_ENDED (uint32_t)BV(18)
255 #define GAP_EVT_SCAN_DUR_ENDED (uint32_t)BV(19)
257 
262 #define GAP_EVT_SCAN_INT_ENDED (uint32_t)BV(20)
263 #define GAP_EVT_SCAN_WND_ENDED (uint32_t)BV(21)
265 
271 #define GAP_EVT_ADV_REPORT (uint32_t)BV(22)
272 
277 #define GAP_EVT_ADV_REPORT_FULL (uint32_t)BV(23)
278 
285 #define GAP_EVT_PRD_ADV_SYNC_ESTABLISHED (uint32_t)BV(24)
286 
292 #define GAP_EVT_PRD_ADV_REPORT (uint32_t)BV(25)
293 
299 #define GAP_EVT_PRD_ADV_SYNC_LOST (uint32_t)BV(26)
300 #define GAP_EVT_INSUFFICIENT_MEMORY (uint32_t)BV(31)
303 
305 #define GAP_EVT_ADV_EVT_MASK (GAP_EVT_ADV_START_AFTER_ENABLE | \
306  GAP_EVT_ADV_END_AFTER_DISABLE | \
307  GAP_EVT_ADV_START | \
308  GAP_EVT_ADV_END | \
309  GAP_EVT_ADV_SET_TERMINATED | \
310  GAP_EVT_SCAN_REQ_RECEIVED | \
311  GAP_EVT_ADV_DATA_TRUNCATED | \
312  GAP_EVT_INSUFFICIENT_MEMORY)
313 
315 #define GAP_EVT_SCAN_EVT_MASK (GAP_EVT_SCAN_ENABLED | \
316  GAP_EVT_SCAN_DISABLED | \
317  GAP_EVT_SCAN_PRD_ENDED | \
318  GAP_EVT_SCAN_DUR_ENDED | \
319  GAP_EVT_SCAN_INT_ENDED | \
320  GAP_EVT_SCAN_WND_ENDED | \
321  GAP_EVT_ADV_REPORT | \
322  GAP_EVT_ADV_REPORT_FULL | \
323  GAP_EVT_PRD_ADV_SYNC_ESTABLISHED | \
324  GAP_EVT_PRD_ADV_REPORT | \
325  GAP_EVT_PRD_ADV_SYNC_LOST | \
326  GAP_EVT_INSUFFICIENT_MEMORY)
327 
344 typedef enum
345 {
364 
383 
385  GAP_CONFIG_PARAM_COUNT
388 
395 {
404 
418 
430 
440 
449 
458 
460 
464  GAP_PARAM_AUTH_TASK_ID,
465 
470  GAP_PARAM_DEPRECATED,
471 
479  GAP_PARAM_GGS_PARAMS,
480 
481 #if defined ( TESTMODES )
482 
485  GAP_PARAM_GAP_TESTCODE,
486 
490  GAP_PARAM_SM_TESTCODE,
491 
495  GAP_PARAM_GATT_TESTCODE,
496 
500  GAP_PARAM_ATT_TESTCODE,
501 
506  GAP_PARAM_L2CAP_TESTCODE,
507 #endif // TESTMODES
508 
511  GAP_PARAMID_MAX
513 };
514 
528 #define GAP_PROFILE_BROADCASTER 0x01
530 #define GAP_PROFILE_OBSERVER 0x02
532 
536 #define GAP_PROFILE_PERIPHERAL 0x04
537 
541 #define GAP_PROFILE_CENTRAL 0x08
542 
549 typedef enum
550 {
553 
559 
561 typedef enum
562 {
565 #if defined(BLE_V42_FEATURES) && (BLE_V42_FEATURES & PRIVACY_1_2_CFG)
570 #endif // PRIVACY_1_2_CFG
572 
574 typedef enum
575 {
578  ADDRTYPE_PUBLIC_ID = 0x02,
586 
588 typedef enum
589 {
593 
598 #define SET_ADDRTYPE_ID 0x02
600 #define MASK_ADDRTYPE_ID 0x01
602 
608 #define RANDOM_ADDR_HDR_MASK 0xC0
610 #define STATIC_ADDR_HDR 0xC0
612 #define PRIVATE_NON_RESOLVE_ADDR_HDR 0x80
614 #define PRIVATE_RESOLVE_ADDR_HDR 0x40
616 
624 #define GAP_ADTYPE_FLAGS 0x01
626 #define GAP_ADTYPE_16BIT_MORE 0x02
628 #define GAP_ADTYPE_16BIT_COMPLETE 0x03
630 #define GAP_ADTYPE_32BIT_MORE 0x04
632 #define GAP_ADTYPE_32BIT_COMPLETE 0x05
634 #define GAP_ADTYPE_128BIT_MORE 0x06
636 #define GAP_ADTYPE_128BIT_COMPLETE 0x07
638 #define GAP_ADTYPE_LOCAL_NAME_SHORT 0x08
640 #define GAP_ADTYPE_LOCAL_NAME_COMPLETE 0x09
642 #define GAP_ADTYPE_POWER_LEVEL 0x0A
644 #define GAP_ADTYPE_OOB_CLASS_OF_DEVICE 0x0D
646 #define GAP_ADTYPE_OOB_SIMPLE_PAIRING_HASHC 0x0E
648 #define GAP_ADTYPE_OOB_SIMPLE_PAIRING_RANDR 0x0F
650 #define GAP_ADTYPE_SM_TK 0x10
652 #define GAP_ADTYPE_SM_OOB_FLAG 0x11
654 
658 #define GAP_ADTYPE_SLAVE_CONN_INTERVAL_RANGE 0x12
659 #define GAP_ADTYPE_SIGNED_DATA 0x13
661 #define GAP_ADTYPE_SERVICES_LIST_16BIT 0x14
663 #define GAP_ADTYPE_SERVICES_LIST_128BIT 0x15
665 #define GAP_ADTYPE_SERVICE_DATA 0x16
667 #define GAP_ADTYPE_PUBLIC_TARGET_ADDR 0x17
669 #define GAP_ADTYPE_RANDOM_TARGET_ADDR 0x18
671 #define GAP_ADTYPE_APPEARANCE 0x19
673 #define GAP_ADTYPE_ADV_INTERVAL 0x1A
675 #define GAP_ADTYPE_LE_BD_ADDR 0x1B
677 #define GAP_ADTYPE_LE_ROLE 0x1C
679 #define GAP_ADTYPE_SIMPLE_PAIRING_HASHC_256 0x1D
681 #define GAP_ADTYPE_SIMPLE_PAIRING_RANDR_256 0x1E
683 #define GAP_ADTYPE_SERVICE_DATA_32BIT 0x20
685 #define GAP_ADTYPE_SERVICE_DATA_128BIT 0x21
687 #define GAP_ADTYPE_3D_INFO_DATA 0x3D
689 
693 #define GAP_ADTYPE_MANUFACTURER_SPECIFIC 0xFF
694 #define GAP_ADTYPE_FLAGS_LIMITED 0x01
696 #define GAP_ADTYPE_FLAGS_GENERAL 0x02
698 #define GAP_ADTYPE_FLAGS_BREDR_NOT_SUPPORTED 0x04
700 
706 #define GAP_STATE_IDLE 0x00
707 #define GAP_STATE_ADV 0x01
708 #define GAP_STATE_SCAN 0x02
709 #define GAP_STATE_INIT 0x04
710 
716 #define GAP_APPEARE_UNKNOWN 0x0000
717 #define GAP_APPEARE_GENERIC_PHONE 0x0040
718 #define GAP_APPEARE_GENERIC_COMPUTER 0x0080
719 #define GAP_APPEARE_GENERIC_WATCH 0x00C0
720 #define GAP_APPEARE_WATCH_SPORTS 0x00C1
721 #define GAP_APPEARE_GENERIC_CLOCK 0x0100
722 #define GAP_APPEARE_GENERIC_DISPLAY 0x0140
723 #define GAP_APPEARE_GENERIC_RC 0x0180
724 #define GAP_APPEARE_GENERIC_EYE_GALSSES 0x01C0
725 #define GAP_APPEARE_GENERIC_TAG 0x0200
726 #define GAP_APPEARE_GENERIC_KEYRING 0x0240
727 #define GAP_APPEARE_GENERIC_MEDIA_PLAYER 0x0280
728 #define GAP_APPEARE_GENERIC_BARCODE_SCANNER 0x02C0
729 #define GAP_APPEARE_GENERIC_THERMOMETER 0x0300
730 #define GAP_APPEARE_GENERIC_THERMO_EAR 0x0301
731 #define GAP_APPEARE_GENERIC_HR_SENSOR 0x0340
732 #define GAP_APPEARE_GENERIC_HRS_BELT 0x0341
733 #define GAP_APPEARE_GENERIC_BLOOD_PRESSURE 0x0380
734 #define GAP_APPEARE_GENERIC_BP_ARM 0x0381
735 #define GAP_APPEARE_GENERIC_BP_WRIST 0x0382
736 #define GAP_APPEARE_GENERIC_HID 0x03C0
737 #define GAP_APPEARE_HID_KEYBOARD 0x03C1
738 #define GAP_APPEARE_HID_MOUSE 0x03C2
739 #define GAP_APPEARE_HID_JOYSTIC 0x03C3
740 #define GAP_APPEARE_HID_GAMEPAD 0x03C4
741 #define GAP_APPEARE_HID_DIGITIZER_TYABLET 0x03C5
742 #define GAP_APPEARE_HID_DIGITAL_CARDREADER 0x03C6
743 #define GAP_APPEARE_HID_DIGITAL_PEN 0x03C7
744 #define GAP_APPEARE_HID_BARCODE_SCANNER 0x03C8
745 
751 #define GAP_PRIVACY_MODE_NETWORK 0
752 #define GAP_PRIVACY_MODE_DEVICE 1
753 
758 typedef enum
759 {
764 
768 typedef enum
769 {
771  GAP_CONN_EVT_STAT_SUCCESS = LL_CONN_EVT_STAT_SUCCESS,
773  GAP_CONN_EVT_STAT_CRC_ERROR = LL_CONN_EVT_STAT_CRC_ERROR,
775  GAP_CONN_EVT_STAT_MISSED = LL_CONN_EVT_STAT_MISSED
777 
781 typedef enum
782 {
784  GAP_CONN_EVT_TASK_TYPE_ADV = LL_TASK_ID_ADVERTISER,
786  GAP_CONN_EVT_TASK_TYPE_INIT = LL_TASK_ID_INITIATOR,
788  GAP_CONN_EVT_TASK_TYPE_SLAVE = LL_TASK_ID_SLAVE,
790  GAP_CONN_EVT_TASK_TYPE_SCAN = LL_TASK_ID_SCANNER,
792  GAP_CONN_EVT_TASK_TYPE_MASTER = LL_TASK_ID_MASTER,
793  // No task
794  GAP_CONN_EVT_TASK_TYPE_NONE = LL_TASK_ID_NONE
796 
800 typedef enum
801 {
805 
808 /*-------------------------------------------------------------------
809  * TYPEDEFS
810  */
811 
817 typedef struct
819 {
821  uint8_t opcode;
822 } gapEventHdr_t;
823 
830 typedef struct
831 {
833  uint16_t intervalMin;
835  uint16_t intervalMax;
837  uint16_t latency;
839  uint16_t timeout;
841 
849 typedef struct
850 {
852  uint8_t opcode;
853  uint8_t numDataPkts;
854  uint16_t dataPktLen;
855  uint8_t devAddr[B_ADDR_LEN];
857 
870 typedef struct
871 {
873  uint8_t opcode;
874  uint8_t addrType;
875  uint8_t devAddr[B_ADDR_LEN];
876  uint32_t signCounter;
878 
884 typedef struct
885 {
886  uint16_t connectionHandle;
887  uint16_t intervalMin;
888  uint16_t intervalMax;
889  uint16_t connLatency;
890  uint16_t connTimeout;
893 
899 typedef struct
900 {
901  uint16_t connectionHandle;
902  uint16_t intervalMin;
903  uint16_t intervalMax;
904  uint16_t connLatency;
905  uint16_t connTimeout;
907  uint8_t accepted;
909 
916 typedef struct
917 {
919  uint8_t opcode;
922 
943 typedef struct
944 {
946  uint8_t opcode;
947  uint8_t devAddrType;
948  uint8_t devAddr[B_ADDR_LEN];
949  uint16_t connectionHandle;
950  uint8_t connRole;
951  uint16_t connInterval;
952  uint16_t connLatency;
953  uint16_t connTimeout;
954  uint8_t clockAccuracy;
956 
963 typedef struct
964 {
966  uint8_t opcode;
967  uint8_t status;
968  uint16_t connectionHandle;
969  uint16_t connInterval;
970  uint16_t connLatency;
971  uint16_t connTimeout;
973 
979 typedef struct
980 {
982  uint8_t opcode;
983  uint16_t connectionHandle;
984  uint8_t reason;
986 
995 typedef struct
996 {
998  uint8_t opcode;
999  uint8_t deviceAddr[B_ADDR_LEN];
1000  uint16_t connectionHandle;
1001  uint8_t uiInputs;
1002  uint8_t uiOutputs;
1003  uint32_t numComparison;
1005 
1013 typedef struct
1014 {
1016  uint8_t opcode;
1017  uint16_t connectionHandle;
1018  uint8_t authState;
1024 
1029 typedef struct
1030 {
1031  uint16_t connectionHandle;
1033 } gapAuthParams_t;
1034 
1042 typedef struct
1043 {
1045  uint8_t opcode;
1046  uint16_t connectionHandle;
1047  uint8_t deviceAddr[B_ADDR_LEN];
1048 
1053  uint8_t authReq;
1055 
1064 typedef struct
1065 {
1067  uint8_t opcode;
1068  uint16_t connectionHandle;
1070 
1075 typedef struct
1076 {
1077  uint8_t ioCap;
1078  uint8_t oobDataFlag;
1079  uint8_t authReq;
1080  uint8_t maxEncKeySize;
1082 } gapPairingReq_t;
1083 
1095 typedef struct
1096 {
1098  uint8_t opcode;
1099  uint16_t connectionHandle;
1102 
1106 typedef struct
1107 {
1108  GAP_ConnEvtStat_t status;
1109  uint16_t handle;
1110  uint8_t channel;
1112  int8_t lastRssi;
1113  uint16_t packets;
1116  uint16_t errors;
1118  GAP_ConnEvtTaskType_t nextTaskType;
1120  uint32_t nextTaskTime;
1122 
1125 /*-------------------------------------------------------------------
1126  * CALLBACKS
1127  */
1128 
1134 typedef uint8_t(*pfnSuppCentAddrRes_t)
1137  uint8_t *deviceAddr,
1138  GAP_Peer_Addr_Types_t addrType
1139 );
1140 
1141 //TODO try to move these to gap_internal.h
1142 
1144 typedef void (*pfnGapIdleCB_t)();
1145 
1147 typedef uint8_t(*pfnGapDevPrivModeCB_t)
1149  GAP_Peer_Addr_Types_t addrType,
1150  uint8_t *pAddr
1151 );
1152 
1154 typedef struct
1155 {
1159 } gapBondMgrCBs_t;
1160 
1173 typedef void (*pfnGapCB_t)
1175  uint32_t event,
1176  void *pBuf,
1177  uintptr_t arg
1178 );
1179 
1194 typedef void (*pfnGapConnEvtCB_t)
1197  Gap_ConnEventRpt_t *pReport
1198 );
1199 
1202 /*-------------------------------------------------------------------
1203  * FUNCTIONS - Initialization and Configuration
1204  */
1205 
1236 extern bStatus_t GAP_DeviceInit(uint8_t profileRole, uint8_t taskID,
1237  GAP_Addr_Modes_t addrMode,
1238  uint8_t* pRandomAddr);
1239 
1251 extern bStatus_t GAP_SetParamValue(uint16_t paramID, uint16_t paramValue);
1252 
1261 extern uint16_t GAP_GetParamValue(uint16_t paramID);
1262 
1271 extern void GAP_RegisterForMsgs(uint8_t taskID);
1272 
1278 extern void GAP_RegisterBondMgrCBs(gapBondMgrCBs_t *pCBs);
1279 
1280 #if defined (BLE_V42_FEATURES) && (BLE_V42_FEATURES & PRIVACY_1_2_CFG)
1281 
1298  uint8_t *pAddr, uint8_t mode);
1299 #endif // BLE_V42_FEATURES & PRIVACY_1_2_CFG
1300 
1301 /*-------------------------------------------------------------------
1302  * FUNCTIONS - Link Establishment
1303  */
1304 
1319 extern bStatus_t GAP_TerminateLinkReq(uint16_t connectionHandle, uint8_t reason);
1320 
1343 
1368  *pParams);
1369 
1375 extern uint8_t GAP_NumActiveConnections(void);
1376 
1403  GAP_CB_Action_t action,
1404  uint16_t connHandle);
1405 
1406 /*-------------------------------------------------------------------
1407  * FUNCTIONS - GAP Configuration
1408  */
1409 
1425 extern bStatus_t GapConfig_SetParameter(Gap_configParamIds_t param,
1426  void *pValue);
1427 
1437 extern uint8_t *GAP_GetDevAddress(uint8 wantIA);
1438 
1448 extern uint8_t *GAP_GetIRK(void);
1449 
1459 extern uint8_t *GAP_GetSRK(void);
1460 
1461 /*-------------------------------------------------------------------
1462  * FUNCTIONS - Pairing
1463  */
1464 
1496  gapPairingReq_t *pPairReq);
1497 
1507 extern uint8_t GAP_isPairing(void);
1508 
1526 extern bStatus_t GAP_TerminateAuth(uint16_t connectionHandle, uint8_t reason);
1527 
1549 extern bStatus_t GAP_PasskeyUpdate(uint8_t *pPasskey, uint16_t connectionHandle);
1550 
1568 extern bStatus_t GAP_PasscodeUpdate(uint32_t passcode, uint16_t connectionHandle);
1569 
1586 extern bStatus_t GAP_SendSlaveSecurityRequest(uint16_t connectionHandle,
1587  uint8_t authReq);
1588 
1606 extern bStatus_t GAP_Signable(uint16_t connectionHandle, uint8_t authenticated,
1607  smSigningInfo_t *pParams);
1608 
1631 extern bStatus_t GAP_Bond(uint16_t connectionHandle, uint8_t authenticated,
1632  uint8_t secureConnections, smSecurityInfo_t *pParams,
1633  uint8_t startEncryption);
1634 
1635 /*-------------------------------------------------------------------
1636  * TASK FUNCTIONS - To only be used in osal_icall_ble.c
1637  */
1638 
1646 extern void GAP_Init(uint8_t task_id);
1647 
1658 extern uint16_t GAP_ProcessEvent(uint8_t task_id, uint16_t events);
1659 
1660 /*-------------------------------------------------------------------
1661 -------------------------------------------------------------------*/
1662 
1663 #ifdef __cplusplus
1664 }
1665 #endif
1666 
1667 #endif /* GAP_H */
1668 
uint8_t(* pfnSuppCentAddrRes_t)(uint8_t *deviceAddr, GAP_Peer_Addr_Types_t addrType)
Central Address Resolution (CAR) Support Callback Function.
Definition: gap.h:1136
Definition: gap.h:417
bStatus_t Gap_RegisterConnEventCb(pfnGapConnEvtCB_t cb, GAP_CB_Action_t action, uint16_t connHandle)
GAP_Addr_Types_t
Address types used for identifying peer address type.
Definition: gap.h:574
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:872
uint8_t * GAP_GetDevAddress(uint8 wantIA)
This API allows the software components in the Z-Stack to be written independently of the specifics o...
GAP_Peer_Addr_Types_t
Address types used for specifying peer address type.
Definition: gap.h:588
uint8_t addrType
Device&#39;s address type for devAddr.
Definition: gap.h:874
void(* pfnGapConnEvtCB_t)(Gap_ConnEventRpt_t *pReport)
Definition: gap.h:1195
This file contains the interface to the SM.
No address provided.
Definition: gap.h:584
2 MBPS
Definition: gap.h:761
Definition: sm.h:194
Definition: gap.h:439
uint8_t opcode
GAP_BOND_COMPLETE_EVENT
Definition: gap.h:1067
smSecurityInfo_t * pSecurityInfo
security information from this device
Definition: gap.h:1019
Random (static) Identity Address (corresponds to peer&#39;s RPA)
Definition: gap.h:581
Definition: gap.h:1029
bStatus_t GAP_TerminateAuth(uint16_t connectionHandle, uint8_t reason)
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1044
Connection event in slave role.
Definition: gap.h:788
smSigningInfo_t * pSigningInfo
Signing information.
Definition: gap.h:1020
uint16_t handle
connection handle
Definition: gap.h:1109
GAP_ConnEvtTaskType_t
Definition: gap.h:781
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:851
Definition: gap.h:577
Deny all parameter update requests.
Definition: gap.h:552
bStatus_t GAP_SetParamValue(uint16_t paramID, uint16_t paramValue)
Definition: gap.h:995
GAP_CB_Action_t
Definition: gap.h:800
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:820
Gap_configParamIds_t
Definition: gap.h:344
Definition: gap.h:830
Definition: gap.h:849
Definition: gap.h:1106
uint8_t maxEncKeySize
Pairing Request Maximum Encryption Key Size field.
Definition: gap.h:1080
Definition: gap.h:1042
uint8_t opcode
GAP_DEVICE_INIT_DONE_EVENT
Definition: gap.h:852
uint16_t connectionHandle
connection Handle
Definition: gap.h:1099
Register a callback.
Definition: gap.h:802
Connection event occurred successfully.
Definition: gap.h:771
GAP_ConnEvtStat_t status
status of connection event
Definition: gap.h:1108
GAP event header format.
Definition: gap.h:818
Definition: gap.h:1064
uint16_t timeout
Connection Timeout (0x000A - 0x0C80 * 10 ms)
Definition: gap.h:839
GAP_ConnEvtTaskType_t nextTaskType
Type of next BLE task.
Definition: gap.h:1118
Definition: gap.h:557
uint16_t dataPktLen
HC_LE_Data_Packet_Length.
Definition: gap.h:854
Always Use Random Static Address.
Definition: gap.h:564
Definition: gap.h:1095
int8_t lastRssi
Definition: gap.h:1112
uint16_t intervalMin
Minimum value for the connection event (interval. 0x0006 - 0x0C80 * 1.25 ms)
Definition: gap.h:833
1 MBPS
Definition: gap.h:760
uint8_t uiInputs
Pairing User Interface Inputs - Ask user to input passcode.
Definition: gap.h:1001
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1066
GAP_ConnEvtStat_t
Definition: gap.h:768
bStatus_t GAP_TerminateLinkReq(uint16_t connectionHandle, uint8_t reason)
Random Device Address (controller unable to resolve)
Definition: gap.h:583
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:997
bStatus_t GAP_UpdateLinkParamReq(gapUpdateLinkParamReq_t *pParams)
void GAP_RegisterForMsgs(uint8_t taskID)
keyDist_t keyDist
Pairing Request Key Distribution field.
Definition: gap.h:1081
uint8_t channel
BLE RF channel index (0-39)
Definition: gap.h:1110
uint8_t ioCap
Pairing Request ioCap field.
Definition: gap.h:1077
uint16_t connectionHandle
connection Handle
Definition: gap.h:1068
GAP_ConnEvtPhy_t
Definition: gap.h:758
Definition: gap.h:870
Definition: sm.h:148
Gap_updateDecision_t
Definition: gap.h:549
Public Identity Address (corresponds to peer&#39;s RPA)
Definition: gap.h:579
uint8_t opcode
GAP_SIGNATURE_UPDATED_EVENT
Definition: gap.h:873
void(* pfnGapCB_t)(uint32_t event, void *pBuf, uintptr_t arg)
Definition: gap.h:1174
smIdentityInfo_t * pIdentityInfo
identity information
Definition: gap.h:1022
uint8_t * GAP_GetIRK(void)
Definition: sm.h:205
uint8_t authReq
Definition: gap.h:1053
void GAP_RegisterBondMgrCBs(gapBondMgrCBs_t *pCBs)
bStatus_t GAP_Bond(uint16_t connectionHandle, uint8_t authenticated, uint8_t secureConnections, smSecurityInfo_t *pParams, uint8_t startEncryption)
uint8_t uiOutputs
Pairing User Interface Outputs - Display passcode.
Definition: gap.h:1002
uint16_t connectionHandle
Connection handle.
Definition: gap.h:1000
uint16_t GAP_ProcessEvent(uint8_t task_id, uint16_t events)
Coded-S2 or Coded-S8.
Definition: gap.h:762
smLinkSecurityReq_t secReqs
Pairing Control info.
Definition: gap.h:1032
bStatus_t GAP_SendSlaveSecurityRequest(uint16_t connectionHandle, uint8_t authReq)
uint16_t GAP_GetParamValue(uint16_t paramID)
bStatus_t GAP_PasscodeUpdate(uint32_t passcode, uint16_t connectionHandle)
Always Use Resolvable Private Address with Random Identity Address.
Definition: gap.h:569
pfnSuppCentAddrRes_t suppCentAddrResCB
Supports Central Address Resolution.
Definition: gap.h:1156
Definition: gap.h:457
uint16_t errors
Total number of CRC errors for the entire connection.
Definition: gap.h:1116
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1015
Type definitions and macros for BLE stack.
uint32_t numComparison
Numeric Comparison value to be displayed.
Definition: gap.h:1003
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1097
uint16_t latency
Number of LL latency connection events (0x0000 - 0x03e8)
Definition: gap.h:837
uint8_t opcode
GAP_PAIRING_REQ_EVENT
Definition: gap.h:1098
No data was received during connection event.
Definition: gap.h:775
Public Device Address.
Definition: gap.h:576
smSecurityInfo_t * pDevSecInfo
security information from connected device
Definition: gap.h:1021
uint8_t GAP_NumActiveConnections(void)
Initiating a connection.
Definition: gap.h:786
void(* pfnGapIdleCB_t)()
GAP Idle Callback Function.
Definition: gap.h:1144
Definition: sm.h:215
uint8_t opcode
GAP_SLAVE_REQUESTED_SECURITY_EVENT
Definition: gap.h:1045
Definition: gap.h:429
Definition: gap.h:448
Can be used by the application to set the SRK.
Definition: gap.h:382
OSAL Event Header.
Definition: osal.h:92
Connection event failed because all packets had CRC errors.
Definition: gap.h:773
Gap_ParamIDs_t
Definition: gap.h:394
Always Use Public Address.
Definition: gap.h:563
bStatus_t GAP_UpdateLinkParamReqReply(gapUpdateLinkParamReqReply_t *pParams)
Can be used by the application to set the IRK.
Definition: gap.h:363
uint8_t opcode
GAP_PASSKEY_NEEDED_EVENT
Definition: gap.h:998
Advertiser.
Definition: gap.h:784
bStatus_t GAP_DeviceInit(uint8_t profileRole, uint8_t taskID, GAP_Addr_Modes_t addrMode, uint8_t *pRandomAddr)
Definition: gap.h:403
uint8_t(* pfnGapDevPrivModeCB_t)(GAP_Peer_Addr_Types_t addrType, uint8_t *pAddr)
GAP Device Privacy Mode Callback Function.
Definition: gap.h:1148
uint8_t authState
TRUE if the pairing was authenticated (MITM)
Definition: gap.h:1018
void GAP_Init(uint8_t task_id)
uint8_t opcode
GAP type of command. GAP Event IDs.
Definition: gap.h:821
#define B_ADDR_LEN
Default Public and Random Address Length.
Definition: bcomdef.h:115
uint8_t numDataPkts
HC_Total_Num_LE_Data_Packets.
Definition: gap.h:853
Definition: gap.h:1013
Callback Registration Structure.
Definition: gap.h:1154
uint8_t GAP_isPairing(void)
uint8_t authReq
Pairing Request Auth Req field.
Definition: gap.h:1079
uint32_t nextTaskTime
Time to next BLE task (in us). 0xFFFFFFFF if there is no next task.
Definition: gap.h:1120
uint8_t * GAP_GetSRK(void)
uint16_t intervalMax
Maximum value for the connection event (interval. 0x0006 - 0x0C80 * 1.25 ms)
Definition: gap.h:835
pfnGapIdleCB_t gapIdleCB
GAP Idle callback.
Definition: gap.h:1157
uint8_t opcode
GAP_AUTHENTICATION_COMPLETE_EVENT
Definition: gap.h:1016
GAP_ConnEvtPhy_t phy
PHY of connection event.
Definition: gap.h:1111
uint8_t oobDataFlag
Pairing Request OOB Data Flag field.
Definition: gap.h:1078
uint16_t connectionHandle
Connection Handle from controller used to ref the device.
Definition: gap.h:1017
Status_t bStatus_t
BLE Generic Status return.
Definition: bcomdef.h:249
Random or Random ID Address.
Definition: gap.h:591
Accept all parameter update requests.
Definition: gap.h:551
bStatus_t GAP_SetPrivacyMode(GAP_Peer_Addr_Types_t addrType, uint8_t *pAddr, uint8_t mode)
Definition: gap.h:1075
bStatus_t GapConfig_SetParameter(Gap_configParamIds_t param, void *pValue)
bStatus_t GAP_Signable(uint16_t connectionHandle, uint8_t authenticated, smSigningInfo_t *pParams)
Connection event in master role.
Definition: gap.h:792
Always Use Resolvable Private Address with Public Identity Address.
Definition: gap.h:567
bStatus_t GAP_PasskeyUpdate(uint8_t *pPasskey, uint16_t connectionHandle)
gapPairingReq_t pairReq
The Pairing Request fields received.
Definition: gap.h:1100
Scanner.
Definition: gap.h:790
Public or Public ID Address.
Definition: gap.h:590
bStatus_t GAP_Authenticate(gapAuthParams_t *pParams, gapPairingReq_t *pPairReq)
uint32_t signCounter
new Signed Counter
Definition: gap.h:876
uint16_t connectionHandle
Connection Handle.
Definition: gap.h:1046
Unregister a callback
Definition: gap.h:803
GAP_Addr_Modes_t
Address modes to initialize the local device.
Definition: gap.h:561
pfnGapDevPrivModeCB_t gapDevPrivModeCB
GAP Device Privacy Mode callback.
Definition: gap.h:1158
uint16_t connectionHandle
Connection Handle from controller,.
Definition: gap.h:1031
© Copyright 1995-2021, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale