TI BLE5-Stack API Documentation  2.02.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 
114 #define GAP_ADV_DATA_UPDATE_DONE_EVENT 0x02
115 
119 #define GAP_ADV_MAKE_DISCOVERABLE_DONE_EVENT 0x03
120 
124 #define GAP_ADV_END_DISCOVERABLE_DONE_EVENT 0x04
125 
129 #define GAP_LINK_ESTABLISHED_EVENT 0x05
130 
133 #define GAP_LINK_TERMINATED_EVENT 0x06
134 
139 #define GAP_LINK_PARAM_UPDATE_EVENT 0x07
140 
146 #define GAP_SIGNATURE_UPDATED_EVENT 0x09
147 
152 #define GAP_AUTHENTICATION_COMPLETE_EVENT 0x0A
153 
158 #define GAP_PASSKEY_NEEDED_EVENT 0x0B
159 
165 #define GAP_SLAVE_REQUESTED_SECURITY_EVENT 0x0C
166 
171 #define GAP_BOND_COMPLETE_EVENT 0x0E
172 
178 #define GAP_PAIRING_REQ_EVENT 0x0F
179 
185 #define GAP_AUTHENTICATION_FAILURE_EVT 0x10
186 
192 #define GAP_UPDATE_LINK_PARAM_REQ_EVENT 0x11
193 #define GAP_SCAN_SESSION_END_EVENT 0x12
195 #define GAP_ADV_REMOVE_SET_EVENT 0x13
197 
200 #define GAP_CONNECTING_CANCELLED_EVENT 0x15
201 
205 #define GAP_BOND_LOST_EVENT 0x17
206 
211 #define GAP_LINK_PARAM_UPDATE_REJECT_EVENT 0x18
212 
216 #define GAP_ADV_SET_PERIODIC_ADV_PARAMS_EVENT 0x19
218 #define GAP_ADV_SET_PERIODIC_ADV_DATA_EVENT 0x1A
220 #define GAP_ADV_SET_PERIODIC_ADV_ENABLE_EVENT 0x1B
222 
226 #define GAP_SCAN_CREATE_SYNC_EVENT 0x1C
227 
231 #define GAP_SCAN_SYNC_CANCEL_EVENT 0x1D
233 #define GAP_SCAN_TERMINATE_SYNC_EVENT 0x1E
235 #define GAP_SCAN_PERIODIC_RECEIVE_EVENT 0x1F
237 #define GAP_SCAN_ADD_DEVICE_ADV_LIST_EVENT 0x20
239 #define GAP_SCAN_REMOVE_DEVICE_ADV_LIST_EVENT 0x21
241 #define GAP_SCAN_READ_ADV_LIST_SIZE_EVENT 0x22
243 #define GAP_SCAN_CLEAR_ADV_LIST_EVENT 0x23
245 
249 #define GAP_SCAN_PERIODIC_ADV_SYNC_EST_EVENT 0x24
250 
254 #define GAP_SCAN_PERIODIC_ADV_SYNC_LOST_EVENT 0x25
255 
259 #define GAP_SCAN_PERIODIC_ADV_REPORT_EVENT 0x26
260 
276 #define GAP_EVT_ADV_START_AFTER_ENABLE (uint32_t)BV(0)
277 
282 #define GAP_EVT_ADV_END_AFTER_DISABLE (uint32_t)BV(1)
283 
289 #define GAP_EVT_ADV_START (uint32_t)BV(2)
290 
296 #define GAP_EVT_ADV_END (uint32_t)BV(3)
297 
303 #define GAP_EVT_ADV_SET_TERMINATED (uint32_t)BV(4)
304 
309 #define GAP_EVT_SCAN_REQ_RECEIVED (uint32_t)BV(5)
310 
316 #define GAP_EVT_ADV_DATA_TRUNCATED (uint32_t)BV(6)
317 #define GAP_EVT_SCAN_ENABLED (uint32_t)BV(16)
319 
325 #define GAP_EVT_SCAN_DISABLED (uint32_t)BV(17)
326 
331 #define GAP_EVT_SCAN_PRD_ENDED (uint32_t)BV(18)
332 #define GAP_EVT_SCAN_DUR_ENDED (uint32_t)BV(19)
334 
339 #define GAP_EVT_SCAN_INT_ENDED (uint32_t)BV(20)
340 #define GAP_EVT_SCAN_WND_ENDED (uint32_t)BV(21)
342 
348 #define GAP_EVT_ADV_REPORT (uint32_t)BV(22)
349 
354 #define GAP_EVT_ADV_REPORT_FULL (uint32_t)BV(23)
355 
362 #define GAP_EVT_PRD_ADV_SYNC_ESTABLISHED (uint32_t)BV(24)
363 
369 #define GAP_EVT_PRD_ADV_REPORT (uint32_t)BV(25)
370 
376 #define GAP_EVT_PRD_ADV_SYNC_LOST (uint32_t)BV(26)
377 #define GAP_EVT_INSUFFICIENT_MEMORY (uint32_t)BV(31)
380 
382 #define GAP_EVT_ADV_EVT_MASK (GAP_EVT_ADV_START_AFTER_ENABLE | \
383  GAP_EVT_ADV_END_AFTER_DISABLE | \
384  GAP_EVT_ADV_START | \
385  GAP_EVT_ADV_END | \
386  GAP_EVT_ADV_SET_TERMINATED | \
387  GAP_EVT_SCAN_REQ_RECEIVED | \
388  GAP_EVT_ADV_DATA_TRUNCATED | \
389  GAP_EVT_INSUFFICIENT_MEMORY)
390 
392 #define GAP_EVT_SCAN_EVT_MASK (GAP_EVT_SCAN_ENABLED | \
393  GAP_EVT_SCAN_DISABLED | \
394  GAP_EVT_SCAN_PRD_ENDED | \
395  GAP_EVT_SCAN_DUR_ENDED | \
396  GAP_EVT_SCAN_INT_ENDED | \
397  GAP_EVT_SCAN_WND_ENDED | \
398  GAP_EVT_ADV_REPORT | \
399  GAP_EVT_ADV_REPORT_FULL | \
400  GAP_EVT_PRD_ADV_SYNC_ESTABLISHED | \
401  GAP_EVT_PRD_ADV_REPORT | \
402  GAP_EVT_PRD_ADV_SYNC_LOST | \
403  GAP_EVT_INSUFFICIENT_MEMORY)
404 
421 typedef enum
422 {
441 
460 
462  GAP_CONFIG_PARAM_COUNT
465 
472 {
481 
495 
507 
517 
526 
535 
537 
541  GAP_PARAM_AUTH_TASK_ID,
542 
547  GAP_PARAM_DEPRECATED,
548 
556  GAP_PARAM_GGS_PARAMS,
557 
558 #if defined ( TESTMODES )
559 
562  GAP_PARAM_GAP_TESTCODE,
563 
567  GAP_PARAM_SM_TESTCODE,
568 
572  GAP_PARAM_GATT_TESTCODE,
573 
577  GAP_PARAM_ATT_TESTCODE,
578 
583  GAP_PARAM_L2CAP_TESTCODE,
584 
594  GAP_PARAM_SET_SCAN_CHAN_TESTCODE,
595 
596 #endif // TESTMODES
597 
604  GAP_STUB1_NOT_TESTCODE,
605 
612  GAP_STUB2_NOT_TESTCODE,
613 
620  GAP_STUB3_NOT_TESTCODE,
621 
628  GAP_STUB4_NOT_TESTCODE,
629 
636  GAP_STUB5_NOT_TESTCODE,
637 
647  GAP_PARAM_SET_SCAN_CHAN,
648 
652  GAP_PARAMID_MAX
654 };
655 
669 #define GAP_PROFILE_BROADCASTER 0x01
671 #define GAP_PROFILE_OBSERVER 0x02
673 
677 #define GAP_PROFILE_PERIPHERAL 0x04
678 
682 #define GAP_PROFILE_CENTRAL 0x08
683 
690 typedef enum
691 {
694 
700 
702 typedef enum
703 {
711 
713 typedef enum
714 {
717  ADDRTYPE_PUBLIC_ID = 0x02,
725 
727 typedef enum
728 {
732 
737 #define SET_ADDRTYPE_ID 0x02
739 #define MASK_ADDRTYPE_ID 0x01
741 
747 #define RANDOM_ADDR_HDR_MASK 0xC0
749 #define STATIC_ADDR_HDR 0xC0
751 #define PRIVATE_NON_RESOLVE_ADDR_HDR 0x80
753 #define PRIVATE_RESOLVE_ADDR_HDR 0x40
755 
763 #define GAP_ADTYPE_FLAGS 0x01
765 #define GAP_ADTYPE_16BIT_MORE 0x02
767 #define GAP_ADTYPE_16BIT_COMPLETE 0x03
769 #define GAP_ADTYPE_32BIT_MORE 0x04
771 #define GAP_ADTYPE_32BIT_COMPLETE 0x05
773 #define GAP_ADTYPE_128BIT_MORE 0x06
775 #define GAP_ADTYPE_128BIT_COMPLETE 0x07
777 #define GAP_ADTYPE_LOCAL_NAME_SHORT 0x08
779 #define GAP_ADTYPE_LOCAL_NAME_COMPLETE 0x09
781 #define GAP_ADTYPE_POWER_LEVEL 0x0A
783 #define GAP_ADTYPE_OOB_CLASS_OF_DEVICE 0x0D
785 #define GAP_ADTYPE_OOB_SIMPLE_PAIRING_HASHC 0x0E
787 #define GAP_ADTYPE_OOB_SIMPLE_PAIRING_RANDR 0x0F
789 #define GAP_ADTYPE_SM_TK 0x10
791 #define GAP_ADTYPE_SM_OOB_FLAG 0x11
793 
797 #define GAP_ADTYPE_SLAVE_CONN_INTERVAL_RANGE 0x12
798 #define GAP_ADTYPE_SIGNED_DATA 0x13
800 #define GAP_ADTYPE_SERVICES_LIST_16BIT 0x14
802 #define GAP_ADTYPE_SERVICES_LIST_128BIT 0x15
804 #define GAP_ADTYPE_SERVICE_DATA 0x16
806 #define GAP_ADTYPE_PUBLIC_TARGET_ADDR 0x17
808 #define GAP_ADTYPE_RANDOM_TARGET_ADDR 0x18
810 #define GAP_ADTYPE_APPEARANCE 0x19
812 #define GAP_ADTYPE_ADV_INTERVAL 0x1A
814 #define GAP_ADTYPE_LE_BD_ADDR 0x1B
816 #define GAP_ADTYPE_LE_ROLE 0x1C
818 #define GAP_ADTYPE_SIMPLE_PAIRING_HASHC_256 0x1D
820 #define GAP_ADTYPE_SIMPLE_PAIRING_RANDR_256 0x1E
822 #define GAP_ADTYPE_SERVICE_DATA_32BIT 0x20
824 #define GAP_ADTYPE_SERVICE_DATA_128BIT 0x21
826 #define GAP_ADTYPE_3D_INFO_DATA 0x3D
828 
832 #define GAP_ADTYPE_MANUFACTURER_SPECIFIC 0xFF
833 #define GAP_ADTYPE_FLAGS_LIMITED 0x01
835 #define GAP_ADTYPE_FLAGS_GENERAL 0x02
837 #define GAP_ADTYPE_FLAGS_BREDR_NOT_SUPPORTED 0x04
839 
845 #define GAP_STATE_IDLE 0x00
846 #define GAP_STATE_ADV 0x01
847 #define GAP_STATE_SCAN 0x02
848 #define GAP_STATE_INIT 0x04
849 
855 #define GAP_APPEARE_UNKNOWN 0x0000
856 #define GAP_APPEARE_GENERIC_PHONE 0x0040
857 #define GAP_APPEARE_GENERIC_COMPUTER 0x0080
858 #define GAP_APPEARE_GENERIC_WATCH 0x00C0
859 #define GAP_APPEARE_WATCH_SPORTS 0x00C1
860 #define GAP_APPEARE_GENERIC_CLOCK 0x0100
861 #define GAP_APPEARE_GENERIC_DISPLAY 0x0140
862 #define GAP_APPEARE_GENERIC_RC 0x0180
863 #define GAP_APPEARE_GENERIC_EYE_GALSSES 0x01C0
864 #define GAP_APPEARE_GENERIC_TAG 0x0200
865 #define GAP_APPEARE_GENERIC_KEYRING 0x0240
866 #define GAP_APPEARE_GENERIC_MEDIA_PLAYER 0x0280
867 #define GAP_APPEARE_GENERIC_BARCODE_SCANNER 0x02C0
868 #define GAP_APPEARE_GENERIC_THERMOMETER 0x0300
869 #define GAP_APPEARE_GENERIC_THERMO_EAR 0x0301
870 #define GAP_APPEARE_GENERIC_HR_SENSOR 0x0340
871 #define GAP_APPEARE_GENERIC_HRS_BELT 0x0341
872 #define GAP_APPEARE_GENERIC_BLOOD_PRESSURE 0x0380
873 #define GAP_APPEARE_GENERIC_BP_ARM 0x0381
874 #define GAP_APPEARE_GENERIC_BP_WRIST 0x0382
875 #define GAP_APPEARE_GENERIC_HID 0x03C0
876 #define GAP_APPEARE_HID_KEYBOARD 0x03C1
877 #define GAP_APPEARE_HID_MOUSE 0x03C2
878 #define GAP_APPEARE_HID_JOYSTIC 0x03C3
879 #define GAP_APPEARE_HID_GAMEPAD 0x03C4
880 #define GAP_APPEARE_HID_DIGITIZER_TYABLET 0x03C5
881 #define GAP_APPEARE_HID_DIGITAL_CARDREADER 0x03C6
882 #define GAP_APPEARE_HID_DIGITAL_PEN 0x03C7
883 #define GAP_APPEARE_HID_BARCODE_SCANNER 0x03C8
884 
890 #define GAP_PRIVACY_MODE_NETWORK 0
891 #define GAP_PRIVACY_MODE_DEVICE 1
892 
897 typedef enum
898 {
903 
907 typedef enum
908 {
910  GAP_CONN_EVT_STAT_SUCCESS = LL_CONN_EVT_STAT_SUCCESS,
912  GAP_CONN_EVT_STAT_CRC_ERROR = LL_CONN_EVT_STAT_CRC_ERROR,
914  GAP_CONN_EVT_STAT_MISSED = LL_CONN_EVT_STAT_MISSED
916 
920 typedef enum
921 {
923  GAP_CONN_EVT_TASK_TYPE_ADV = LL_TASK_ID_ADVERTISER,
925  GAP_CONN_EVT_TASK_TYPE_INIT = LL_TASK_ID_INITIATOR,
927  GAP_CONN_EVT_TASK_TYPE_SLAVE = LL_TASK_ID_SLAVE,
929  GAP_CONN_EVT_TASK_TYPE_SCAN = LL_TASK_ID_SCANNER,
931  GAP_CONN_EVT_TASK_TYPE_MASTER = LL_TASK_ID_MASTER,
932  // No task
933  GAP_CONN_EVT_TASK_TYPE_NONE = LL_TASK_ID_NONE
935 
939 typedef enum
940 {
944 
947 /*-------------------------------------------------------------------
948  * TYPEDEFS
949  */
950 
956 typedef struct
958 {
960  uint8_t opcode;
961 } gapEventHdr_t;
962 
969 typedef struct
970 {
972  uint16_t intervalMin;
974  uint16_t intervalMax;
976  uint16_t latency;
978  uint16_t timeout;
980 
988 typedef struct
989 {
991  uint8_t opcode;
992  uint8_t numDataPkts;
993  uint16_t dataPktLen;
994  uint8_t devAddr[B_ADDR_LEN];
996 
1009 typedef struct
1010 {
1012  uint8_t opcode;
1013  uint8_t addrType;
1014  uint8_t devAddr[B_ADDR_LEN];
1015  uint32_t signCounter;
1017 
1023 typedef struct
1024 {
1025  uint16_t connectionHandle;
1026  uint16_t intervalMin;
1027  uint16_t intervalMax;
1028  uint16_t connLatency;
1029  uint16_t connTimeout;
1032 
1038 typedef struct
1039 {
1040  uint16_t connectionHandle;
1041  uint16_t intervalMin;
1042  uint16_t intervalMax;
1043  uint16_t connLatency;
1044  uint16_t connTimeout;
1046  uint8_t accepted;
1048 
1055 typedef struct
1056 {
1058  uint8_t opcode;
1061 
1078 typedef struct
1079 {
1081  uint8_t opcode;
1082  uint8_t devAddrType;
1083  uint8_t devAddr[B_ADDR_LEN];
1084  uint16_t connectionHandle;
1085  uint8_t connRole;
1086  uint16_t connInterval;
1087  uint16_t connLatency;
1088  uint16_t connTimeout;
1089  uint8_t clockAccuracy;
1091 
1098 typedef struct
1099 {
1101  uint8_t opcode;
1102  uint8_t status;
1103  uint16_t connectionHandle;
1104  uint16_t connInterval;
1105  uint16_t connLatency;
1106  uint16_t connTimeout;
1108 
1114 typedef struct
1115 {
1117  uint8_t opcode;
1118  uint16_t connectionHandle;
1119  uint8_t reason;
1121 
1130 typedef struct
1131 {
1133  uint8_t opcode;
1134  uint8_t deviceAddr[B_ADDR_LEN];
1135  uint16_t connectionHandle;
1136  uint8_t uiInputs;
1137  uint8_t uiOutputs;
1138  uint32_t numComparison;
1140 
1148 typedef struct
1149 {
1151  uint8_t opcode;
1152  uint16_t connectionHandle;
1153  uint8_t authState;
1159 
1164 typedef struct
1165 {
1166  uint16_t connectionHandle;
1168 } gapAuthParams_t;
1169 
1177 typedef struct
1178 {
1180  uint8_t opcode;
1181  uint16_t connectionHandle;
1182  uint8_t deviceAddr[B_ADDR_LEN];
1183 
1188  uint8_t authReq;
1190 
1199 typedef struct
1200 {
1202  uint8_t opcode;
1203  uint16_t connectionHandle;
1205 
1210 typedef struct
1211 {
1212  uint8_t ioCap;
1213  uint8_t oobDataFlag;
1214  uint8_t authReq;
1215  uint8_t maxEncKeySize;
1217 } gapPairingReq_t;
1218 
1230 typedef struct
1231 {
1233  uint8_t opcode;
1234  uint16_t connectionHandle;
1237 
1241 typedef struct
1242 {
1243  GAP_ConnEvtStat_t status;
1244  uint16_t handle;
1245  uint8_t channel;
1247  int8_t lastRssi;
1248  uint16_t packets;
1251  uint16_t errors;
1253  GAP_ConnEvtTaskType_t nextTaskType;
1255  uint32_t nextTaskTime;
1257 
1265 typedef struct
1266 {
1268  uint8_t opcode;
1269  uint16_t connectionHandle;
1270  uint8_t deviceAddr[B_ADDR_LEN];
1272 
1275 /*-------------------------------------------------------------------
1276  * CALLBACKS
1277  */
1278 
1284 typedef uint8_t(*pfnSuppCentAddrRes_t)
1287  uint8_t *deviceAddr,
1288  GAP_Peer_Addr_Types_t addrType
1289 );
1290 
1291 //TODO try to move these to gap_internal.h
1292 
1294 typedef void (*pfnGapIdleCB_t)();
1295 
1297 typedef uint8_t(*pfnGapDevPrivModeCB_t)
1299  GAP_Peer_Addr_Types_t addrType,
1300  uint8_t *pAddr
1301 );
1302 
1304 typedef struct
1305 {
1309 } gapBondMgrCBs_t;
1310 
1323 typedef void (*pfnGapCB_t)
1325  uint32_t event,
1326  void *pBuf,
1327  uintptr_t arg
1328 );
1329 
1344 typedef void (*pfnGapConnEvtCB_t)
1347  Gap_ConnEventRpt_t *pReport
1348 );
1349 
1352 /*-------------------------------------------------------------------
1353  * FUNCTIONS - Initialization and Configuration
1354  */
1355 
1386 extern bStatus_t GAP_DeviceInit(uint8_t profileRole, uint8_t taskID,
1387  GAP_Addr_Modes_t addrMode,
1388  uint8_t* pRandomAddr);
1389 
1420 extern bStatus_t GAP_DeviceInit_noGAPBondMgr(uint8_t profileRole, uint8_t taskID,
1421  GAP_Addr_Modes_t addrMode,
1422  uint8_t* pRandomAddr);
1423 
1435 extern bStatus_t GAP_SetParamValue(uint16_t paramID, uint16_t paramValue);
1436 
1445 extern uint16_t GAP_GetParamValue(uint16_t paramID);
1446 
1455 extern void GAP_RegisterForMsgs(uint8_t taskID);
1456 
1462 extern void GAP_RegisterBondMgrCBs(gapBondMgrCBs_t *pCBs);
1463 
1481  uint8_t *pAddr, uint8_t mode);
1482 
1483 /*-------------------------------------------------------------------
1484  * FUNCTIONS - Link Establishment
1485  */
1486 
1501 extern bStatus_t GAP_TerminateLinkReq(uint16_t connectionHandle, uint8_t reason);
1502 
1525 
1550  *pParams);
1551 
1557 extern uint8_t GAP_NumActiveConnections(void);
1558 
1585  GAP_CB_Action_t action,
1586  uint16_t connHandle);
1587 
1588 /*-------------------------------------------------------------------
1589  * FUNCTIONS - GAP Configuration
1590  */
1591 
1607 extern bStatus_t GapConfig_SetParameter(Gap_configParamIds_t param,
1608  void *pValue);
1609 
1619 extern uint8_t *GAP_GetDevAddress(uint8 wantIA);
1620 
1630 extern uint8_t *GAP_GetIRK(void);
1631 
1641 extern uint8_t *GAP_GetSRK(void);
1642 
1643 /*-------------------------------------------------------------------
1644  * FUNCTIONS - Pairing
1645  */
1646 
1678  gapPairingReq_t *pPairReq);
1679 
1689 extern uint8_t GAP_isPairing(void);
1690 
1708 extern bStatus_t GAP_TerminateAuth(uint16_t connectionHandle, uint8_t reason);
1709 
1731 extern bStatus_t GAP_PasskeyUpdate(uint8_t *pPasskey, uint16_t connectionHandle);
1732 
1750 extern bStatus_t GAP_PasscodeUpdate(uint32_t passcode, uint16_t connectionHandle);
1751 
1768 extern bStatus_t GAP_SendSlaveSecurityRequest(uint16_t connectionHandle,
1769  uint8_t authReq);
1770 
1788 extern bStatus_t GAP_Signable(uint16_t connectionHandle, uint8_t authenticated,
1789  smSigningInfo_t *pParams);
1790 
1813 extern bStatus_t GAP_Bond(uint16_t connectionHandle, uint8_t authenticated,
1814  uint8_t secureConnections, smSecurityInfo_t *pParams,
1815  uint8_t startEncryption);
1816 
1817 /*-------------------------------------------------------------------
1818  * TASK FUNCTIONS - To only be used in osal_icall_ble.c
1819  */
1820 
1828 extern void GAP_Init(uint8_t task_id);
1829 
1840 extern uint16_t GAP_ProcessEvent(uint8_t task_id, uint16_t events);
1841 
1842 /*-------------------------------------------------------------------
1843 -------------------------------------------------------------------*/
1844 
1845 #ifdef __cplusplus
1846 }
1847 #endif
1848 
1849 #endif /* GAP_H */
1850 
uint8_t(* pfnSuppCentAddrRes_t)(uint8_t *deviceAddr, GAP_Peer_Addr_Types_t addrType)
Central Address Resolution (CAR) Support Callback Function.
Definition: gap.h:1286
Definition: gap.h:494
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:713
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1011
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:727
uint8_t addrType
Device&#39;s address type for devAddr.
Definition: gap.h:1013
void(* pfnGapConnEvtCB_t)(Gap_ConnEventRpt_t *pReport)
Definition: gap.h:1345
This file contains the interface to the SM.
No address provided.
Definition: gap.h:723
2 MBPS
Definition: gap.h:900
Definition: sm.h:194
Definition: gap.h:516
uint8_t opcode
GAP_BOND_COMPLETE_EVENT
Definition: gap.h:1202
smSecurityInfo_t * pSecurityInfo
security information from this device
Definition: gap.h:1154
Random (static) Identity Address (corresponds to peer&#39;s RPA)
Definition: gap.h:720
Definition: gap.h:1164
bStatus_t GAP_TerminateAuth(uint16_t connectionHandle, uint8_t reason)
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1179
Connection event in slave role.
Definition: gap.h:927
smSigningInfo_t * pSigningInfo
Signing information.
Definition: gap.h:1155
uint16_t handle
connection handle
Definition: gap.h:1244
GAP_ConnEvtTaskType_t
Definition: gap.h:920
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:990
Definition: gap.h:716
Definition: gap.h:1265
Deny all parameter update requests.
Definition: gap.h:693
bStatus_t GAP_SetParamValue(uint16_t paramID, uint16_t paramValue)
Definition: gap.h:1130
GAP_CB_Action_t
Definition: gap.h:939
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:959
Gap_configParamIds_t
Definition: gap.h:421
Definition: gap.h:969
Definition: gap.h:988
Definition: gap.h:1241
uint8_t maxEncKeySize
Pairing Request Maximum Encryption Key Size field.
Definition: gap.h:1215
Definition: gap.h:1177
uint8_t opcode
GAP_DEVICE_INIT_DONE_EVENT
Definition: gap.h:991
uint16_t connectionHandle
connection Handle
Definition: gap.h:1234
Register a callback.
Definition: gap.h:941
Connection event occurred successfully.
Definition: gap.h:910
GAP_ConnEvtStat_t status
status of connection event
Definition: gap.h:1243
GAP event header format.
Definition: gap.h:957
Definition: gap.h:1199
uint16_t timeout
Connection Timeout (0x000A - 0x0C80 * 10 ms)
Definition: gap.h:978
GAP_ConnEvtTaskType_t nextTaskType
Type of next BLE task.
Definition: gap.h:1253
Definition: gap.h:698
uint16_t dataPktLen
HC_LE_Data_Packet_Length.
Definition: gap.h:993
Definition: gap.h:705
Definition: gap.h:1230
int8_t lastRssi
Definition: gap.h:1247
uint16_t intervalMin
Minimum value for the connection event (interval. 0x0006 - 0x0C80 * 1.25 ms)
Definition: gap.h:972
1 MBPS
Definition: gap.h:899
uint8_t uiInputs
Pairing User Interface Inputs - Ask user to input passcode.
Definition: gap.h:1136
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1201
GAP_ConnEvtStat_t
Definition: gap.h:907
bStatus_t GAP_TerminateLinkReq(uint16_t connectionHandle, uint8_t reason)
Random Device Address (controller unable to resolve)
Definition: gap.h:722
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1132
bStatus_t GAP_UpdateLinkParamReq(gapUpdateLinkParamReq_t *pParams)
void GAP_RegisterForMsgs(uint8_t taskID)
keyDist_t keyDist
Pairing Request Key Distribution field.
Definition: gap.h:1216
uint8_t channel
BLE RF channel index (0-39)
Definition: gap.h:1245
uint8_t ioCap
Pairing Request ioCap field.
Definition: gap.h:1212
uint16_t connectionHandle
connection Handle
Definition: gap.h:1203
GAP_ConnEvtPhy_t
Definition: gap.h:897
Definition: gap.h:1009
Definition: sm.h:148
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1267
Gap_updateDecision_t
Definition: gap.h:690
Public Identity Address (corresponds to peer&#39;s RPA)
Definition: gap.h:718
uint8_t opcode
GAP_SIGNATURE_UPDATED_EVENT
Definition: gap.h:1012
void(* pfnGapCB_t)(uint32_t event, void *pBuf, uintptr_t arg)
Definition: gap.h:1324
smIdentityInfo_t * pIdentityInfo
identity information
Definition: gap.h:1157
uint8_t * GAP_GetIRK(void)
Definition: sm.h:205
uint8_t authReq
Definition: gap.h:1188
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:1137
uint16_t connectionHandle
Connection handle.
Definition: gap.h:1135
uint16_t GAP_ProcessEvent(uint8_t task_id, uint16_t events)
Coded-S2 or Coded-S8.
Definition: gap.h:901
smLinkSecurityReq_t secReqs
Pairing Control info.
Definition: gap.h:1167
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:709
pfnSuppCentAddrRes_t suppCentAddrResCB
Supports Central Address Resolution.
Definition: gap.h:1306
Definition: gap.h:534
uint16_t errors
Total number of CRC errors for the entire connection.
Definition: gap.h:1251
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1150
Type definitions and macros for BLE stack.
uint32_t numComparison
Numeric Comparison value to be displayed.
Definition: gap.h:1138
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1232
uint16_t latency
Number of LL latency connection events (0x0000 - 0x03e8)
Definition: gap.h:976
uint8_t opcode
GAP_PAIRING_REQ_EVENT
Definition: gap.h:1233
No data was received during connection event.
Definition: gap.h:914
Public Device Address.
Definition: gap.h:715
smSecurityInfo_t * pDevSecInfo
security information from connected device
Definition: gap.h:1156
uint8_t GAP_NumActiveConnections(void)
Initiating a connection.
Definition: gap.h:925
void(* pfnGapIdleCB_t)()
GAP Idle Callback Function.
Definition: gap.h:1294
Definition: sm.h:215
uint8_t opcode
GAP_SLAVE_REQUESTED_SECURITY_EVENT
Definition: gap.h:1180
Definition: gap.h:506
Definition: gap.h:525
Can be used by the application to set the SRK.
Definition: gap.h:459
OSAL Event Header.
Definition: osal.h:92
Connection event failed because all packets had CRC errors.
Definition: gap.h:912
Gap_ParamIDs_t
Definition: gap.h:471
Always Use Public Address.
Definition: gap.h:704
bStatus_t GAP_UpdateLinkParamReqReply(gapUpdateLinkParamReqReply_t *pParams)
Can be used by the application to set the IRK.
Definition: gap.h:440
uint8_t opcode
GAP_PASSKEY_NEEDED_EVENT
Definition: gap.h:1133
Advertiser.
Definition: gap.h:923
bStatus_t GAP_DeviceInit(uint8_t profileRole, uint8_t taskID, GAP_Addr_Modes_t addrMode, uint8_t *pRandomAddr)
Definition: gap.h:480
uint8_t(* pfnGapDevPrivModeCB_t)(GAP_Peer_Addr_Types_t addrType, uint8_t *pAddr)
GAP Device Privacy Mode Callback Function.
Definition: gap.h:1298
uint8_t authState
TRUE if the pairing was authenticated (MITM)
Definition: gap.h:1153
void GAP_Init(uint8_t task_id)
uint8_t opcode
GAP type of command. GAP Event IDs.
Definition: gap.h:960
#define B_ADDR_LEN
Default Public and Random Address Length.
Definition: bcomdef.h:108
uint8_t opcode
GAP_BOND_LOST_EVENT
Definition: gap.h:1268
uint8_t numDataPkts
HC_Total_Num_LE_Data_Packets.
Definition: gap.h:992
Definition: gap.h:1148
Callback Registration Structure.
Definition: gap.h:1304
uint8_t GAP_isPairing(void)
uint8_t authReq
Pairing Request Auth Req field.
Definition: gap.h:1214
uint32_t nextTaskTime
Time to next BLE task (in us). 0xFFFFFFFF if there is no next task.
Definition: gap.h:1255
uint8_t * GAP_GetSRK(void)
uint16_t intervalMax
Maximum value for the connection event (interval. 0x0006 - 0x0C80 * 1.25 ms)
Definition: gap.h:974
pfnGapIdleCB_t gapIdleCB
GAP Idle callback.
Definition: gap.h:1307
uint8_t opcode
GAP_AUTHENTICATION_COMPLETE_EVENT
Definition: gap.h:1151
GAP_ConnEvtPhy_t phy
PHY of connection event.
Definition: gap.h:1246
uint8_t oobDataFlag
Pairing Request OOB Data Flag field.
Definition: gap.h:1213
uint16_t connectionHandle
Connection Handle from controller used to ref the device.
Definition: gap.h:1152
Status_t bStatus_t
BLE Generic Status return.
Definition: bcomdef.h:251
Random or Random ID Address.
Definition: gap.h:730
Accept all parameter update requests.
Definition: gap.h:692
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:1269
bStatus_t GAP_SetPrivacyMode(GAP_Peer_Addr_Types_t addrType, uint8_t *pAddr, uint8_t mode)
Definition: gap.h:1210
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:931
Always Use Resolvable Private Address with Public Identity Address.
Definition: gap.h:707
bStatus_t GAP_PasskeyUpdate(uint8_t *pPasskey, uint16_t connectionHandle)
gapPairingReq_t pairReq
The Pairing Request fields received.
Definition: gap.h:1235
Scanner.
Definition: gap.h:929
Public or Public ID Address.
Definition: gap.h:729
bStatus_t GAP_Authenticate(gapAuthParams_t *pParams, gapPairingReq_t *pPairReq)
uint32_t signCounter
new Signed Counter
Definition: gap.h:1015
uint16_t connectionHandle
Connection Handle.
Definition: gap.h:1181
Unregister a callback
Definition: gap.h:942
GAP_Addr_Modes_t
Address modes to initialize the local device.
Definition: gap.h:702
pfnGapDevPrivModeCB_t gapDevPrivModeCB
GAP Device Privacy Mode callback.
Definition: gap.h:1308
uint16_t connectionHandle
Connection Handle from controller,.
Definition: gap.h:1166
© Copyright 1995-2021, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale