TI BLE5-Stack API Documentation  2.01.02.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 
187 #define GAP_BOND_LOST_EVENT 0x17
188 
193 #define GAP_LINK_PARAM_UPDATE_REJECT_EVENT 0x18
194 
211 #define GAP_EVT_ADV_START_AFTER_ENABLE (uint32_t)BV(0)
212 
217 #define GAP_EVT_ADV_END_AFTER_DISABLE (uint32_t)BV(1)
218 
224 #define GAP_EVT_ADV_START (uint32_t)BV(2)
225 
231 #define GAP_EVT_ADV_END (uint32_t)BV(3)
232 
238 #define GAP_EVT_ADV_SET_TERMINATED (uint32_t)BV(4)
239 
244 #define GAP_EVT_SCAN_REQ_RECEIVED (uint32_t)BV(5)
245 
251 #define GAP_EVT_ADV_DATA_TRUNCATED (uint32_t)BV(6)
252 #define GAP_EVT_SCAN_ENABLED (uint32_t)BV(16)
254 
260 #define GAP_EVT_SCAN_DISABLED (uint32_t)BV(17)
261 
266 #define GAP_EVT_SCAN_PRD_ENDED (uint32_t)BV(18)
267 #define GAP_EVT_SCAN_DUR_ENDED (uint32_t)BV(19)
269 
274 #define GAP_EVT_SCAN_INT_ENDED (uint32_t)BV(20)
275 #define GAP_EVT_SCAN_WND_ENDED (uint32_t)BV(21)
277 
283 #define GAP_EVT_ADV_REPORT (uint32_t)BV(22)
284 
289 #define GAP_EVT_ADV_REPORT_FULL (uint32_t)BV(23)
290 
297 #define GAP_EVT_PRD_ADV_SYNC_ESTABLISHED (uint32_t)BV(24)
298 
304 #define GAP_EVT_PRD_ADV_REPORT (uint32_t)BV(25)
305 
311 #define GAP_EVT_PRD_ADV_SYNC_LOST (uint32_t)BV(26)
312 #define GAP_EVT_INSUFFICIENT_MEMORY (uint32_t)BV(31)
315 
317 #define GAP_EVT_ADV_EVT_MASK (GAP_EVT_ADV_START_AFTER_ENABLE | \
318  GAP_EVT_ADV_END_AFTER_DISABLE | \
319  GAP_EVT_ADV_START | \
320  GAP_EVT_ADV_END | \
321  GAP_EVT_ADV_SET_TERMINATED | \
322  GAP_EVT_SCAN_REQ_RECEIVED | \
323  GAP_EVT_ADV_DATA_TRUNCATED | \
324  GAP_EVT_INSUFFICIENT_MEMORY)
325 
327 #define GAP_EVT_SCAN_EVT_MASK (GAP_EVT_SCAN_ENABLED | \
328  GAP_EVT_SCAN_DISABLED | \
329  GAP_EVT_SCAN_PRD_ENDED | \
330  GAP_EVT_SCAN_DUR_ENDED | \
331  GAP_EVT_SCAN_INT_ENDED | \
332  GAP_EVT_SCAN_WND_ENDED | \
333  GAP_EVT_ADV_REPORT | \
334  GAP_EVT_ADV_REPORT_FULL | \
335  GAP_EVT_PRD_ADV_SYNC_ESTABLISHED | \
336  GAP_EVT_PRD_ADV_REPORT | \
337  GAP_EVT_PRD_ADV_SYNC_LOST | \
338  GAP_EVT_INSUFFICIENT_MEMORY)
339 
356 typedef enum
357 {
376 
395 
397  GAP_CONFIG_PARAM_COUNT
400 
407 {
416 
430 
442 
452 
461 
470 
472 
476  GAP_PARAM_AUTH_TASK_ID,
477 
482  GAP_PARAM_DEPRECATED,
483 
491  GAP_PARAM_GGS_PARAMS,
492 
493 #if defined ( TESTMODES )
494 
497  GAP_PARAM_GAP_TESTCODE,
498 
502  GAP_PARAM_SM_TESTCODE,
503 
507  GAP_PARAM_GATT_TESTCODE,
508 
512  GAP_PARAM_ATT_TESTCODE,
513 
518  GAP_PARAM_L2CAP_TESTCODE,
519 #endif // TESTMODES
520 
523  GAP_PARAMID_MAX
525 };
526 
540 #define GAP_PROFILE_BROADCASTER 0x01
542 #define GAP_PROFILE_OBSERVER 0x02
544 
548 #define GAP_PROFILE_PERIPHERAL 0x04
549 
553 #define GAP_PROFILE_CENTRAL 0x08
554 
561 typedef enum
562 {
565 
571 
573 typedef enum
574 {
582 
584 typedef enum
585 {
588  ADDRTYPE_PUBLIC_ID = 0x02,
596 
598 typedef enum
599 {
603 
608 #define SET_ADDRTYPE_ID 0x02
610 #define MASK_ADDRTYPE_ID 0x01
612 
618 #define RANDOM_ADDR_HDR_MASK 0xC0
620 #define STATIC_ADDR_HDR 0xC0
622 #define PRIVATE_NON_RESOLVE_ADDR_HDR 0x80
624 #define PRIVATE_RESOLVE_ADDR_HDR 0x40
626 
634 #define GAP_ADTYPE_FLAGS 0x01
636 #define GAP_ADTYPE_16BIT_MORE 0x02
638 #define GAP_ADTYPE_16BIT_COMPLETE 0x03
640 #define GAP_ADTYPE_32BIT_MORE 0x04
642 #define GAP_ADTYPE_32BIT_COMPLETE 0x05
644 #define GAP_ADTYPE_128BIT_MORE 0x06
646 #define GAP_ADTYPE_128BIT_COMPLETE 0x07
648 #define GAP_ADTYPE_LOCAL_NAME_SHORT 0x08
650 #define GAP_ADTYPE_LOCAL_NAME_COMPLETE 0x09
652 #define GAP_ADTYPE_POWER_LEVEL 0x0A
654 #define GAP_ADTYPE_OOB_CLASS_OF_DEVICE 0x0D
656 #define GAP_ADTYPE_OOB_SIMPLE_PAIRING_HASHC 0x0E
658 #define GAP_ADTYPE_OOB_SIMPLE_PAIRING_RANDR 0x0F
660 #define GAP_ADTYPE_SM_TK 0x10
662 #define GAP_ADTYPE_SM_OOB_FLAG 0x11
664 
668 #define GAP_ADTYPE_SLAVE_CONN_INTERVAL_RANGE 0x12
669 #define GAP_ADTYPE_SIGNED_DATA 0x13
671 #define GAP_ADTYPE_SERVICES_LIST_16BIT 0x14
673 #define GAP_ADTYPE_SERVICES_LIST_128BIT 0x15
675 #define GAP_ADTYPE_SERVICE_DATA 0x16
677 #define GAP_ADTYPE_PUBLIC_TARGET_ADDR 0x17
679 #define GAP_ADTYPE_RANDOM_TARGET_ADDR 0x18
681 #define GAP_ADTYPE_APPEARANCE 0x19
683 #define GAP_ADTYPE_ADV_INTERVAL 0x1A
685 #define GAP_ADTYPE_LE_BD_ADDR 0x1B
687 #define GAP_ADTYPE_LE_ROLE 0x1C
689 #define GAP_ADTYPE_SIMPLE_PAIRING_HASHC_256 0x1D
691 #define GAP_ADTYPE_SIMPLE_PAIRING_RANDR_256 0x1E
693 #define GAP_ADTYPE_SERVICE_DATA_32BIT 0x20
695 #define GAP_ADTYPE_SERVICE_DATA_128BIT 0x21
697 #define GAP_ADTYPE_3D_INFO_DATA 0x3D
699 
703 #define GAP_ADTYPE_MANUFACTURER_SPECIFIC 0xFF
704 #define GAP_ADTYPE_FLAGS_LIMITED 0x01
706 #define GAP_ADTYPE_FLAGS_GENERAL 0x02
708 #define GAP_ADTYPE_FLAGS_BREDR_NOT_SUPPORTED 0x04
710 
716 #define GAP_STATE_IDLE 0x00
717 #define GAP_STATE_ADV 0x01
718 #define GAP_STATE_SCAN 0x02
719 #define GAP_STATE_INIT 0x04
720 
726 #define GAP_APPEARE_UNKNOWN 0x0000
727 #define GAP_APPEARE_GENERIC_PHONE 0x0040
728 #define GAP_APPEARE_GENERIC_COMPUTER 0x0080
729 #define GAP_APPEARE_GENERIC_WATCH 0x00C0
730 #define GAP_APPEARE_WATCH_SPORTS 0x00C1
731 #define GAP_APPEARE_GENERIC_CLOCK 0x0100
732 #define GAP_APPEARE_GENERIC_DISPLAY 0x0140
733 #define GAP_APPEARE_GENERIC_RC 0x0180
734 #define GAP_APPEARE_GENERIC_EYE_GALSSES 0x01C0
735 #define GAP_APPEARE_GENERIC_TAG 0x0200
736 #define GAP_APPEARE_GENERIC_KEYRING 0x0240
737 #define GAP_APPEARE_GENERIC_MEDIA_PLAYER 0x0280
738 #define GAP_APPEARE_GENERIC_BARCODE_SCANNER 0x02C0
739 #define GAP_APPEARE_GENERIC_THERMOMETER 0x0300
740 #define GAP_APPEARE_GENERIC_THERMO_EAR 0x0301
741 #define GAP_APPEARE_GENERIC_HR_SENSOR 0x0340
742 #define GAP_APPEARE_GENERIC_HRS_BELT 0x0341
743 #define GAP_APPEARE_GENERIC_BLOOD_PRESSURE 0x0380
744 #define GAP_APPEARE_GENERIC_BP_ARM 0x0381
745 #define GAP_APPEARE_GENERIC_BP_WRIST 0x0382
746 #define GAP_APPEARE_GENERIC_HID 0x03C0
747 #define GAP_APPEARE_HID_KEYBOARD 0x03C1
748 #define GAP_APPEARE_HID_MOUSE 0x03C2
749 #define GAP_APPEARE_HID_JOYSTIC 0x03C3
750 #define GAP_APPEARE_HID_GAMEPAD 0x03C4
751 #define GAP_APPEARE_HID_DIGITIZER_TYABLET 0x03C5
752 #define GAP_APPEARE_HID_DIGITAL_CARDREADER 0x03C6
753 #define GAP_APPEARE_HID_DIGITAL_PEN 0x03C7
754 #define GAP_APPEARE_HID_BARCODE_SCANNER 0x03C8
755 
761 #define GAP_PRIVACY_MODE_NETWORK 0
762 #define GAP_PRIVACY_MODE_DEVICE 1
763 
768 typedef enum
769 {
774 
778 typedef enum
779 {
781  GAP_CONN_EVT_STAT_SUCCESS = LL_CONN_EVT_STAT_SUCCESS,
783  GAP_CONN_EVT_STAT_CRC_ERROR = LL_CONN_EVT_STAT_CRC_ERROR,
785  GAP_CONN_EVT_STAT_MISSED = LL_CONN_EVT_STAT_MISSED
787 
791 typedef enum
792 {
794  GAP_CONN_EVT_TASK_TYPE_ADV = LL_TASK_ID_ADVERTISER,
796  GAP_CONN_EVT_TASK_TYPE_INIT = LL_TASK_ID_INITIATOR,
798  GAP_CONN_EVT_TASK_TYPE_SLAVE = LL_TASK_ID_SLAVE,
800  GAP_CONN_EVT_TASK_TYPE_SCAN = LL_TASK_ID_SCANNER,
802  GAP_CONN_EVT_TASK_TYPE_MASTER = LL_TASK_ID_MASTER,
803  // No task
804  GAP_CONN_EVT_TASK_TYPE_NONE = LL_TASK_ID_NONE
806 
810 typedef enum
811 {
815 
818 /*-------------------------------------------------------------------
819  * TYPEDEFS
820  */
821 
827 typedef struct
829 {
831  uint8_t opcode;
832 } gapEventHdr_t;
833 
840 typedef struct
841 {
843  uint16_t intervalMin;
845  uint16_t intervalMax;
847  uint16_t latency;
849  uint16_t timeout;
851 
859 typedef struct
860 {
862  uint8_t opcode;
863  uint8_t numDataPkts;
864  uint16_t dataPktLen;
865  uint8_t devAddr[B_ADDR_LEN];
867 
880 typedef struct
881 {
883  uint8_t opcode;
884  uint8_t addrType;
885  uint8_t devAddr[B_ADDR_LEN];
886  uint32_t signCounter;
888 
894 typedef struct
895 {
896  uint16_t connectionHandle;
897  uint16_t intervalMin;
898  uint16_t intervalMax;
899  uint16_t connLatency;
900  uint16_t connTimeout;
903 
909 typedef struct
910 {
911  uint16_t connectionHandle;
912  uint16_t intervalMin;
913  uint16_t intervalMax;
914  uint16_t connLatency;
915  uint16_t connTimeout;
917  uint8_t accepted;
919 
926 typedef struct
927 {
929  uint8_t opcode;
932 
949 typedef struct
950 {
952  uint8_t opcode;
953  uint8_t devAddrType;
954  uint8_t devAddr[B_ADDR_LEN];
955  uint16_t connectionHandle;
956  uint8_t connRole;
957  uint16_t connInterval;
958  uint16_t connLatency;
959  uint16_t connTimeout;
960  uint8_t clockAccuracy;
962 
969 typedef struct
970 {
972  uint8_t opcode;
973  uint8_t status;
974  uint16_t connectionHandle;
975  uint16_t connInterval;
976  uint16_t connLatency;
977  uint16_t connTimeout;
979 
985 typedef struct
986 {
988  uint8_t opcode;
989  uint16_t connectionHandle;
990  uint8_t reason;
992 
1001 typedef struct
1002 {
1004  uint8_t opcode;
1005  uint8_t deviceAddr[B_ADDR_LEN];
1006  uint16_t connectionHandle;
1007  uint8_t uiInputs;
1008  uint8_t uiOutputs;
1009  uint32_t numComparison;
1011 
1019 typedef struct
1020 {
1022  uint8_t opcode;
1023  uint16_t connectionHandle;
1024  uint8_t authState;
1030 
1035 typedef struct
1036 {
1037  uint16_t connectionHandle;
1039 } gapAuthParams_t;
1040 
1048 typedef struct
1049 {
1051  uint8_t opcode;
1052  uint16_t connectionHandle;
1053  uint8_t deviceAddr[B_ADDR_LEN];
1054 
1059  uint8_t authReq;
1061 
1070 typedef struct
1071 {
1073  uint8_t opcode;
1074  uint16_t connectionHandle;
1076 
1081 typedef struct
1082 {
1083  uint8_t ioCap;
1084  uint8_t oobDataFlag;
1085  uint8_t authReq;
1086  uint8_t maxEncKeySize;
1088 } gapPairingReq_t;
1089 
1101 typedef struct
1102 {
1104  uint8_t opcode;
1105  uint16_t connectionHandle;
1108 
1112 typedef struct
1113 {
1114  GAP_ConnEvtStat_t status;
1115  uint16_t handle;
1116  uint8_t channel;
1118  int8_t lastRssi;
1119  uint16_t packets;
1122  uint16_t errors;
1124  GAP_ConnEvtTaskType_t nextTaskType;
1126  uint32_t nextTaskTime;
1128 
1136 typedef struct
1137 {
1139  uint8_t opcode;
1140  uint16_t connectionHandle;
1141  uint8_t deviceAddr[B_ADDR_LEN];
1143 
1146 /*-------------------------------------------------------------------
1147  * CALLBACKS
1148  */
1149 
1155 typedef uint8_t(*pfnSuppCentAddrRes_t)
1158  uint8_t *deviceAddr,
1159  GAP_Peer_Addr_Types_t addrType
1160 );
1161 
1162 //TODO try to move these to gap_internal.h
1163 
1165 typedef void (*pfnGapIdleCB_t)();
1166 
1168 typedef uint8_t(*pfnGapDevPrivModeCB_t)
1170  GAP_Peer_Addr_Types_t addrType,
1171  uint8_t *pAddr
1172 );
1173 
1175 typedef struct
1176 {
1180 } gapBondMgrCBs_t;
1181 
1194 typedef void (*pfnGapCB_t)
1196  uint32_t event,
1197  void *pBuf,
1198  uintptr_t arg
1199 );
1200 
1215 typedef void (*pfnGapConnEvtCB_t)
1218  Gap_ConnEventRpt_t *pReport
1219 );
1220 
1223 /*-------------------------------------------------------------------
1224  * FUNCTIONS - Initialization and Configuration
1225  */
1226 
1257 extern bStatus_t GAP_DeviceInit(uint8_t profileRole, uint8_t taskID,
1258  GAP_Addr_Modes_t addrMode,
1259  uint8_t* pRandomAddr);
1260 
1291 extern bStatus_t GAP_DeviceInit_noGAPBondMgr(uint8_t profileRole, uint8_t taskID,
1292  GAP_Addr_Modes_t addrMode,
1293  uint8_t* pRandomAddr);
1294 
1306 extern bStatus_t GAP_SetParamValue(uint16_t paramID, uint16_t paramValue);
1307 
1316 extern uint16_t GAP_GetParamValue(uint16_t paramID);
1317 
1326 extern void GAP_RegisterForMsgs(uint8_t taskID);
1327 
1333 extern void GAP_RegisterBondMgrCBs(gapBondMgrCBs_t *pCBs);
1334 
1352  uint8_t *pAddr, uint8_t mode);
1353 
1354 /*-------------------------------------------------------------------
1355  * FUNCTIONS - Link Establishment
1356  */
1357 
1372 extern bStatus_t GAP_TerminateLinkReq(uint16_t connectionHandle, uint8_t reason);
1373 
1396 
1421  *pParams);
1422 
1428 extern uint8_t GAP_NumActiveConnections(void);
1429 
1456  GAP_CB_Action_t action,
1457  uint16_t connHandle);
1458 
1459 /*-------------------------------------------------------------------
1460  * FUNCTIONS - GAP Configuration
1461  */
1462 
1478 extern bStatus_t GapConfig_SetParameter(Gap_configParamIds_t param,
1479  void *pValue);
1480 
1490 extern uint8_t *GAP_GetDevAddress(uint8 wantIA);
1491 
1501 extern uint8_t *GAP_GetIRK(void);
1502 
1512 extern uint8_t *GAP_GetSRK(void);
1513 
1514 /*-------------------------------------------------------------------
1515  * FUNCTIONS - Pairing
1516  */
1517 
1549  gapPairingReq_t *pPairReq);
1550 
1560 extern uint8_t GAP_isPairing(void);
1561 
1579 extern bStatus_t GAP_TerminateAuth(uint16_t connectionHandle, uint8_t reason);
1580 
1602 extern bStatus_t GAP_PasskeyUpdate(uint8_t *pPasskey, uint16_t connectionHandle);
1603 
1621 extern bStatus_t GAP_PasscodeUpdate(uint32_t passcode, uint16_t connectionHandle);
1622 
1639 extern bStatus_t GAP_SendSlaveSecurityRequest(uint16_t connectionHandle,
1640  uint8_t authReq);
1641 
1659 extern bStatus_t GAP_Signable(uint16_t connectionHandle, uint8_t authenticated,
1660  smSigningInfo_t *pParams);
1661 
1684 extern bStatus_t GAP_Bond(uint16_t connectionHandle, uint8_t authenticated,
1685  uint8_t secureConnections, smSecurityInfo_t *pParams,
1686  uint8_t startEncryption);
1687 
1688 /*-------------------------------------------------------------------
1689  * TASK FUNCTIONS - To only be used in osal_icall_ble.c
1690  */
1691 
1699 extern void GAP_Init(uint8_t task_id);
1700 
1711 extern uint16_t GAP_ProcessEvent(uint8_t task_id, uint16_t events);
1712 
1713 /*-------------------------------------------------------------------
1714 -------------------------------------------------------------------*/
1715 
1716 #ifdef __cplusplus
1717 }
1718 #endif
1719 
1720 #endif /* GAP_H */
1721 
uint8_t(* pfnSuppCentAddrRes_t)(uint8_t *deviceAddr, GAP_Peer_Addr_Types_t addrType)
Central Address Resolution (CAR) Support Callback Function.
Definition: gap.h:1157
Definition: gap.h:429
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:584
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:882
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:598
uint8_t addrType
Device&#39;s address type for devAddr.
Definition: gap.h:884
void(* pfnGapConnEvtCB_t)(Gap_ConnEventRpt_t *pReport)
Definition: gap.h:1216
This file contains the interface to the SM.
No address provided.
Definition: gap.h:594
2 MBPS
Definition: gap.h:771
Definition: sm.h:194
Definition: gap.h:451
uint8_t opcode
GAP_BOND_COMPLETE_EVENT
Definition: gap.h:1073
smSecurityInfo_t * pSecurityInfo
security information from this device
Definition: gap.h:1025
Random (static) Identity Address (corresponds to peer&#39;s RPA)
Definition: gap.h:591
Definition: gap.h:1035
bStatus_t GAP_TerminateAuth(uint16_t connectionHandle, uint8_t reason)
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1050
Connection event in slave role.
Definition: gap.h:798
smSigningInfo_t * pSigningInfo
Signing information.
Definition: gap.h:1026
uint16_t handle
connection handle
Definition: gap.h:1115
GAP_ConnEvtTaskType_t
Definition: gap.h:791
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:861
Definition: gap.h:587
Definition: gap.h:1136
Deny all parameter update requests.
Definition: gap.h:564
bStatus_t GAP_SetParamValue(uint16_t paramID, uint16_t paramValue)
Definition: gap.h:1001
GAP_CB_Action_t
Definition: gap.h:810
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:830
Gap_configParamIds_t
Definition: gap.h:356
Definition: gap.h:840
Definition: gap.h:859
Definition: gap.h:1112
uint8_t maxEncKeySize
Pairing Request Maximum Encryption Key Size field.
Definition: gap.h:1086
Definition: gap.h:1048
uint8_t opcode
GAP_DEVICE_INIT_DONE_EVENT
Definition: gap.h:862
uint16_t connectionHandle
connection Handle
Definition: gap.h:1105
Register a callback.
Definition: gap.h:812
Connection event occurred successfully.
Definition: gap.h:781
GAP_ConnEvtStat_t status
status of connection event
Definition: gap.h:1114
GAP event header format.
Definition: gap.h:828
Definition: gap.h:1070
uint16_t timeout
Connection Timeout (0x000A - 0x0C80 * 10 ms)
Definition: gap.h:849
GAP_ConnEvtTaskType_t nextTaskType
Type of next BLE task.
Definition: gap.h:1124
Definition: gap.h:569
uint16_t dataPktLen
HC_LE_Data_Packet_Length.
Definition: gap.h:864
Definition: gap.h:576
Definition: gap.h:1101
int8_t lastRssi
Definition: gap.h:1118
uint16_t intervalMin
Minimum value for the connection event (interval. 0x0006 - 0x0C80 * 1.25 ms)
Definition: gap.h:843
1 MBPS
Definition: gap.h:770
uint8_t uiInputs
Pairing User Interface Inputs - Ask user to input passcode.
Definition: gap.h:1007
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1072
GAP_ConnEvtStat_t
Definition: gap.h:778
bStatus_t GAP_TerminateLinkReq(uint16_t connectionHandle, uint8_t reason)
Random Device Address (controller unable to resolve)
Definition: gap.h:593
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1003
bStatus_t GAP_UpdateLinkParamReq(gapUpdateLinkParamReq_t *pParams)
void GAP_RegisterForMsgs(uint8_t taskID)
keyDist_t keyDist
Pairing Request Key Distribution field.
Definition: gap.h:1087
uint8_t channel
BLE RF channel index (0-39)
Definition: gap.h:1116
uint8_t ioCap
Pairing Request ioCap field.
Definition: gap.h:1083
uint16_t connectionHandle
connection Handle
Definition: gap.h:1074
GAP_ConnEvtPhy_t
Definition: gap.h:768
Definition: gap.h:880
Definition: sm.h:148
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1138
Gap_updateDecision_t
Definition: gap.h:561
Public Identity Address (corresponds to peer&#39;s RPA)
Definition: gap.h:589
uint8_t opcode
GAP_SIGNATURE_UPDATED_EVENT
Definition: gap.h:883
void(* pfnGapCB_t)(uint32_t event, void *pBuf, uintptr_t arg)
Definition: gap.h:1195
smIdentityInfo_t * pIdentityInfo
identity information
Definition: gap.h:1028
uint8_t * GAP_GetIRK(void)
Definition: sm.h:205
uint8_t authReq
Definition: gap.h:1059
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:1008
uint16_t connectionHandle
Connection handle.
Definition: gap.h:1006
uint16_t GAP_ProcessEvent(uint8_t task_id, uint16_t events)
Coded-S2 or Coded-S8.
Definition: gap.h:772
smLinkSecurityReq_t secReqs
Pairing Control info.
Definition: gap.h:1038
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:580
pfnSuppCentAddrRes_t suppCentAddrResCB
Supports Central Address Resolution.
Definition: gap.h:1177
Definition: gap.h:469
uint16_t errors
Total number of CRC errors for the entire connection.
Definition: gap.h:1122
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1021
Type definitions and macros for BLE stack.
uint32_t numComparison
Numeric Comparison value to be displayed.
Definition: gap.h:1009
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1103
uint16_t latency
Number of LL latency connection events (0x0000 - 0x03e8)
Definition: gap.h:847
uint8_t opcode
GAP_PAIRING_REQ_EVENT
Definition: gap.h:1104
No data was received during connection event.
Definition: gap.h:785
Public Device Address.
Definition: gap.h:586
smSecurityInfo_t * pDevSecInfo
security information from connected device
Definition: gap.h:1027
uint8_t GAP_NumActiveConnections(void)
Initiating a connection.
Definition: gap.h:796
void(* pfnGapIdleCB_t)()
GAP Idle Callback Function.
Definition: gap.h:1165
Definition: sm.h:215
uint8_t opcode
GAP_SLAVE_REQUESTED_SECURITY_EVENT
Definition: gap.h:1051
Definition: gap.h:441
Definition: gap.h:460
Can be used by the application to set the SRK.
Definition: gap.h:394
OSAL Event Header.
Definition: osal.h:92
Connection event failed because all packets had CRC errors.
Definition: gap.h:783
Gap_ParamIDs_t
Definition: gap.h:406
Always Use Public Address.
Definition: gap.h:575
bStatus_t GAP_UpdateLinkParamReqReply(gapUpdateLinkParamReqReply_t *pParams)
Can be used by the application to set the IRK.
Definition: gap.h:375
uint8_t opcode
GAP_PASSKEY_NEEDED_EVENT
Definition: gap.h:1004
Advertiser.
Definition: gap.h:794
bStatus_t GAP_DeviceInit(uint8_t profileRole, uint8_t taskID, GAP_Addr_Modes_t addrMode, uint8_t *pRandomAddr)
Definition: gap.h:415
uint8_t(* pfnGapDevPrivModeCB_t)(GAP_Peer_Addr_Types_t addrType, uint8_t *pAddr)
GAP Device Privacy Mode Callback Function.
Definition: gap.h:1169
uint8_t authState
TRUE if the pairing was authenticated (MITM)
Definition: gap.h:1024
void GAP_Init(uint8_t task_id)
uint8_t opcode
GAP type of command. GAP Event IDs.
Definition: gap.h:831
#define B_ADDR_LEN
Default Public and Random Address Length.
Definition: bcomdef.h:108
uint8_t opcode
GAP_BOND_LOST_EVENT
Definition: gap.h:1139
uint8_t numDataPkts
HC_Total_Num_LE_Data_Packets.
Definition: gap.h:863
Definition: gap.h:1019
Callback Registration Structure.
Definition: gap.h:1175
uint8_t GAP_isPairing(void)
uint8_t authReq
Pairing Request Auth Req field.
Definition: gap.h:1085
uint32_t nextTaskTime
Time to next BLE task (in us). 0xFFFFFFFF if there is no next task.
Definition: gap.h:1126
uint8_t * GAP_GetSRK(void)
uint16_t intervalMax
Maximum value for the connection event (interval. 0x0006 - 0x0C80 * 1.25 ms)
Definition: gap.h:845
pfnGapIdleCB_t gapIdleCB
GAP Idle callback.
Definition: gap.h:1178
uint8_t opcode
GAP_AUTHENTICATION_COMPLETE_EVENT
Definition: gap.h:1022
GAP_ConnEvtPhy_t phy
PHY of connection event.
Definition: gap.h:1117
uint8_t oobDataFlag
Pairing Request OOB Data Flag field.
Definition: gap.h:1084
uint16_t connectionHandle
Connection Handle from controller used to ref the device.
Definition: gap.h:1023
Status_t bStatus_t
BLE Generic Status return.
Definition: bcomdef.h:246
Random or Random ID Address.
Definition: gap.h:601
Accept all parameter update requests.
Definition: gap.h:563
bStatus_t GAP_DeviceInit_noGAPBondMgr(uint8_t profileRole, uint8_t taskID, GAP_Addr_Modes_t addrMode, uint8_t *pRandomAddr)
uint16_t connectionHandle
Connection Handle.
Definition: gap.h:1140
bStatus_t GAP_SetPrivacyMode(GAP_Peer_Addr_Types_t addrType, uint8_t *pAddr, uint8_t mode)
Definition: gap.h:1081
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:802
Always Use Resolvable Private Address with Public Identity Address.
Definition: gap.h:578
bStatus_t GAP_PasskeyUpdate(uint8_t *pPasskey, uint16_t connectionHandle)
gapPairingReq_t pairReq
The Pairing Request fields received.
Definition: gap.h:1106
Scanner.
Definition: gap.h:800
Public or Public ID Address.
Definition: gap.h:600
bStatus_t GAP_Authenticate(gapAuthParams_t *pParams, gapPairingReq_t *pPairReq)
uint32_t signCounter
new Signed Counter
Definition: gap.h:886
uint16_t connectionHandle
Connection Handle.
Definition: gap.h:1052
Unregister a callback
Definition: gap.h:813
GAP_Addr_Modes_t
Address modes to initialize the local device.
Definition: gap.h:573
pfnGapDevPrivModeCB_t gapDevPrivModeCB
GAP Device Privacy Mode callback.
Definition: gap.h:1179
uint16_t connectionHandle
Connection Handle from controller,.
Definition: gap.h:1037
© Copyright 1995-2020, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale