TI BLE-Stack for Bluetooth 4.2 API Documentation  3.02.00.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 
24 #ifndef GAP_H
25 #define GAP_H
26 
27 #ifdef __cplusplus
28 extern "C"
29 {
30 #endif
31 
32 /*-------------------------------------------------------------------
33  * INCLUDES
34  */
35 #include "bcomdef.h"
36 #include "osal.h"
37 #include "sm.h"
38 
39 /*-------------------------------------------------------------------
40  * MACROS
41  */
42 
43 /*-------------------------------------------------------------------
44  * CONSTANTS
45  */
46 
60 #define GAP_DEVICE_INIT_DONE_EVENT 0x00
61 
65 #define GAP_DEVICE_DISCOVERY_EVENT 0x01
66 
70 #define GAP_ADV_DATA_UPDATE_DONE_EVENT 0x02
71 
75 #define GAP_MAKE_DISCOVERABLE_DONE_EVENT 0x03
76 
80 #define GAP_END_DISCOVERABLE_DONE_EVENT 0x04
81 
85 #define GAP_LINK_ESTABLISHED_EVENT 0x05
86 
90 #define GAP_LINK_TERMINATED_EVENT 0x06
91 
95 #define GAP_LINK_PARAM_UPDATE_EVENT 0x07
96 
100 #define GAP_RANDOM_ADDR_CHANGED_EVENT 0x08
101 
105 #define GAP_SIGNATURE_UPDATED_EVENT 0x09
106 
110 #define GAP_AUTHENTICATION_COMPLETE_EVENT 0x0A
111 
115 #define GAP_PASSKEY_NEEDED_EVENT 0x0B
116 
120 #define GAP_SLAVE_REQUESTED_SECURITY_EVENT 0x0C
121 
125 #define GAP_DEVICE_INFO_EVENT 0x0D
126 
130 #define GAP_BOND_COMPLETE_EVENT 0x0E
131 
135 #define GAP_PAIRING_REQ_EVENT 0x0F
136 
141 #define GAP_AUTHENTICATION_FAILURE_EVT 0x10
142 
147 #define GAP_UPDATE_LINK_PARAM_REQ_EVENT 0x11
148 
154 #define GAP_CONNHANDLE_INIT 0xFFFE
155 #define GAP_CONNHANDLE_ALL 0xFFFF
156 
162 #define GAP_PROFILE_BROADCASTER 0x01
163 #define GAP_PROFILE_OBSERVER 0x02
164 #define GAP_PROFILE_PERIPHERAL 0x04
165 #define GAP_PROFILE_CENTRAL 0x08
166 
183 #define TGAP_GEN_DISC_ADV_MIN 0
184 
192 #define TGAP_LIM_ADV_TIMEOUT 1
193 
201 #define TGAP_GEN_DISC_SCAN 2
202 
210 #define TGAP_LIM_DISC_SCAN 3
211 
219 #define TGAP_CONN_EST_ADV_TIMEOUT 4
220 
229 #define TGAP_CONN_PARAM_TIMEOUT 5
230 
238 #define TGAP_LIM_DISC_ADV_INT_MIN 6
239 
247 #define TGAP_LIM_DISC_ADV_INT_MAX 7
248 
256 #define TGAP_GEN_DISC_ADV_INT_MIN 8
257 
265 #define TGAP_GEN_DISC_ADV_INT_MAX 9
266 
274 #define TGAP_CONN_ADV_INT_MIN 10
275 
283 #define TGAP_CONN_ADV_INT_MAX 11
284 
292 #define TGAP_CONN_SCAN_INT 12
293 
301 #define TGAP_CONN_SCAN_WIND 13
302 
310 #define TGAP_CONN_HIGH_SCAN_INT 14
311 
319 #define TGAP_CONN_HIGH_SCAN_WIND 15
320 
328 #define TGAP_GEN_DISC_SCAN_INT 16
329 
337 #define TGAP_GEN_DISC_SCAN_WIND 17
338 
346 #define TGAP_LIM_DISC_SCAN_INT 18
347 
355 #define TGAP_LIM_DISC_SCAN_WIND 19
356 
358 
363 #define TGAP_CONN_EST_ADV 20
364 
373 #define TGAP_CONN_EST_INT_MIN 21
374 
382 #define TGAP_CONN_EST_INT_MAX 22
383 
391 #define TGAP_CONN_EST_SCAN_INT 23
392 
400 #define TGAP_CONN_EST_SCAN_WIND 24
401 
409 #define TGAP_CONN_EST_SUPERV_TIMEOUT 25
410 
418 #define TGAP_CONN_EST_LATENCY 26
419 
427 #define TGAP_CONN_EST_MIN_CE_LEN 27
428 
436 #define TGAP_CONN_EST_MAX_CE_LEN 28
437 
445 #define TGAP_PRIVATE_ADDR_INT 29
446 
454 #define TGAP_CONN_PAUSE_CENTRAL 30
455 
463 #define TGAP_CONN_PAUSE_PERIPHERAL 31
464 
472 #define TGAP_SM_TIMEOUT 32
473 
481 #define TGAP_SM_MIN_KEY_LEN 33
482 
490 #define TGAP_SM_MAX_KEY_LEN 34
491 
499 #define TGAP_FILTER_ADV_REPORTS 35
500 
508 #define TGAP_SCAN_RSP_RSSI_MIN 36
509 
517 #define TGAP_REJECT_CONN_PARAMS 37
518 
520 #if !defined ( TESTMODES )
521  #define TGAP_AUTH_TASK_ID 38
522  #define TGAP_VERIFY_CAR 39
523 
530  #define TGAP_FAST_INTERVAL_2_INT_MIN 40
531 
538  #define TGAP_FAST_INTERVAL_2_INT_MAX 41
539 
540  #define TGAP_PARAMID_MAX 42
541 #else
542  #define TGAP_GAP_TESTCODE 38
543  #define TGAP_SM_TESTCODE 39
544  #define TGAP_AUTH_TASK_ID 40
545  #define TGAP_VERIFY_CAR 41
546 
553  #define TGAP_FAST_INTERVAL_2_INT_MIN 42
554 
561  #define TGAP_FAST_INTERVAL_2_INT_MAX 43
562 
563  #define TGAP_PARAMID_MAX 44
564 
565  #define TGAP_GATT_TESTCODE 100
566  #define TGAP_ATT_TESTCODE 101
567  #define TGAP_GGS_TESTCODE 102
568  #define TGAP_L2CAP_TESTCODE 103
569 #endif
570 
577 #define DEVDISC_MODE_NONDISCOVERABLE 0x00
578 #define DEVDISC_MODE_GENERAL 0x01
579 #define DEVDISC_MODE_LIMITED 0x02
580 #define DEVDISC_MODE_ALL 0x03
581 
586 #define ADDRTYPE_PUBLIC 0x00
587 #define ADDRTYPE_RANDOM 0x01
588 #define ADDRTYPE_PUBLIC_ID 0x02
589 #define ADDRTYPE_RANDOM_ID 0x03
590 
595 #define SET_ADDRTYPE_ID 0x02
596 #define MASK_ADDRTYPE_ID 0x01
597 
602 #define RANDOM_ADDR_SUBTYPE_STATIC 0x00
603 #define RANDOM_ADDR_SUBTYPE_RPA 0x01
604 #define RANDOM_ADDR_SUBTYPE_NRPA 0x02
605 
610 #define RANDOM_ADDR_HDR_MASK 0xC0
611 #define STATIC_ADDR_HDR 0xC0
612 #define PRIVATE_NON_RESOLVE_ADDR_HDR 0x80
613 #define PRIVATE_RESOLVE_ADDR_HDR 0x40
614 
619 #define ADDRMODE_PUBLIC 0x00
620 #define ADDRMODE_STATIC 0x01
621 #define ADDRMODE_PRIVATE_NONRESOLVE 0x02
622 #define ADDRMODE_PRIVATE_RESOLVE 0x03
623 
629 #define GAP_ADTYPE_ADV_IND 0x00
630 #define GAP_ADTYPE_ADV_HDC_DIRECT_IND 0x01
631 #define GAP_ADTYPE_ADV_SCAN_IND 0x02
632 #define GAP_ADTYPE_ADV_NONCONN_IND 0x03
633 #define GAP_ADTYPE_ADV_LDC_DIRECT_IND 0x04
634 
640 #define GAP_ADRPT_ADV_IND 0x00
641 #define GAP_ADRPT_ADV_DIRECT_IND 0x01
642 #define GAP_ADRPT_ADV_SCAN_IND 0x02
643 #define GAP_ADRPT_ADV_NONCONN_IND 0x03
644 #define GAP_ADRPT_SCAN_RSP 0x04
645 
650 #define GAP_FILTER_POLICY_ALL 0x00
651 #define GAP_FILTER_POLICY_WHITE_SCAN 0x01
652 #define GAP_FILTER_POLICY_WHITE_CON 0x02
653 #define GAP_FILTER_POLICY_WHITE 0x03
654 
659 #define GAP_DISC_FILTER_POLICY_ALL 0x00
660 #define GAP_DISC_FILTER_POLICY_WHITE 0x01
661 #define GAP_DISC_FILTER_POLICY_ALL_DIRECT 0x02
662 #define GAP_DISC_FILTER_POLICY_WHITE_DIRECT 0x03
663 
665 #define ADV_CHANMAP_SIZE 5
666 
667 #define GAP_PASSCODE_MAX 999999
668 
669 
675 #define GAP_INIT_SIGN_COUNTER 0xFFFFFFFF
676 
680 #define GAP_ADVCHAN_37 0x01
681 #define GAP_ADVCHAN_38 0x02
682 #define GAP_ADVCHAN_39 0x04
683 #define GAP_ADVCHAN_ALL (GAP_ADVCHAN_37 | GAP_ADVCHAN_38 | GAP_ADVCHAN_39)
684 
689 #define WL_NOTUSED 0x00
690 #define WL_USED 0x01
691 
697 #define GAP_ADTYPE_FLAGS 0x01
698 #define GAP_ADTYPE_16BIT_MORE 0x02
699 #define GAP_ADTYPE_16BIT_COMPLETE 0x03
700 #define GAP_ADTYPE_32BIT_MORE 0x04
701 #define GAP_ADTYPE_32BIT_COMPLETE 0x05
702 #define GAP_ADTYPE_128BIT_MORE 0x06
703 #define GAP_ADTYPE_128BIT_COMPLETE 0x07
704 #define GAP_ADTYPE_LOCAL_NAME_SHORT 0x08
705 #define GAP_ADTYPE_LOCAL_NAME_COMPLETE 0x09
706 #define GAP_ADTYPE_POWER_LEVEL 0x0A
707 #define GAP_ADTYPE_OOB_CLASS_OF_DEVICE 0x0D
708 #define GAP_ADTYPE_OOB_SIMPLE_PAIRING_HASHC 0x0E
709 #define GAP_ADTYPE_OOB_SIMPLE_PAIRING_RANDR 0x0F
710 #define GAP_ADTYPE_SM_TK 0x10
711 #define GAP_ADTYPE_SM_OOB_FLAG 0x11
712 #define GAP_ADTYPE_SLAVE_CONN_INTERVAL_RANGE 0x12
713 #define GAP_ADTYPE_SIGNED_DATA 0x13
714 #define GAP_ADTYPE_SERVICES_LIST_16BIT 0x14
715 #define GAP_ADTYPE_SERVICES_LIST_128BIT 0x15
716 #define GAP_ADTYPE_SERVICE_DATA 0x16
717 #define GAP_ADTYPE_PUBLIC_TARGET_ADDR 0x17
718 #define GAP_ADTYPE_RANDOM_TARGET_ADDR 0x18
719 #define GAP_ADTYPE_APPEARANCE 0x19
720 #define GAP_ADTYPE_ADV_INTERVAL 0x1A
721 #define GAP_ADTYPE_LE_BD_ADDR 0x1B
722 #define GAP_ADTYPE_LE_ROLE 0x1C
723 #define GAP_ADTYPE_SIMPLE_PAIRING_HASHC_256 0x1D
724 #define GAP_ADTYPE_SIMPLE_PAIRING_RANDR_256 0x1E
725 #define GAP_ADTYPE_SERVICE_DATA_32BIT 0x20
726 #define GAP_ADTYPE_SERVICE_DATA_128BIT 0x21
727 #define GAP_ADTYPE_3D_INFO_DATA 0x3D
728 #define GAP_ADTYPE_MANUFACTURER_SPECIFIC 0xFF
729 #define GAP_ADTYPE_FLAGS_LIMITED 0x01
730 #define GAP_ADTYPE_FLAGS_GENERAL 0x02
731 #define GAP_ADTYPE_FLAGS_BREDR_NOT_SUPPORTED 0x04
732 
737 #define GAP_STATE_IDLE 0x00
738 #define GAP_STATE_ADV 0x01
739 #define GAP_STATE_SCAN 0x02
740 #define GAP_STATE_INIT 0x04
741 
746 #define GAP_APPEARE_UNKNOWN 0x0000
747 #define GAP_APPEARE_GENERIC_PHONE 0x0040
748 #define GAP_APPEARE_GENERIC_COMPUTER 0x0080
749 #define GAP_APPEARE_GENERIC_WATCH 0x00C0
750 #define GAP_APPEARE_WATCH_SPORTS 0x00C1
751 #define GAP_APPEARE_GENERIC_CLOCK 0x0100
752 #define GAP_APPEARE_GENERIC_DISPLAY 0x0140
753 #define GAP_APPEARE_GENERIC_RC 0x0180
754 #define GAP_APPEARE_GENERIC_EYE_GALSSES 0x01C0
755 #define GAP_APPEARE_GENERIC_TAG 0x0200
756 #define GAP_APPEARE_GENERIC_KEYRING 0x0240
757 #define GAP_APPEARE_GENERIC_MEDIA_PLAYER 0x0280
758 #define GAP_APPEARE_GENERIC_BARCODE_SCANNER 0x02C0
759 #define GAP_APPEARE_GENERIC_THERMOMETER 0x0300
760 #define GAP_APPEARE_GENERIC_THERMO_EAR 0x0301
761 #define GAP_APPEARE_GENERIC_HR_SENSOR 0x0340
762 #define GAP_APPEARE_GENERIC_HRS_BELT 0x0341
763 #define GAP_APPEARE_GENERIC_BLOOD_PRESSURE 0x0380
764 #define GAP_APPEARE_GENERIC_BP_ARM 0x0381
765 #define GAP_APPEARE_GENERIC_BP_WRIST 0x0382
766 #define GAP_APPEARE_GENERIC_HID 0x03C0
767 #define GAP_APPEARE_HID_KEYBOARD 0x03C1
768 #define GAP_APPEARE_HID_MOUSE 0x03C2
769 #define GAP_APPEARE_HID_JOYSTIC 0x03C3
770 #define GAP_APPEARE_HID_GAMEPAD 0x03C4
771 #define GAP_APPEARE_HID_DIGITIZER_TYABLET 0x03C5
772 #define GAP_APPEARE_HID_DIGITAL_CARDREADER 0x03C6
773 #define GAP_APPEARE_HID_DIGITAL_PEN 0x03C7
774 #define GAP_APPEARE_HID_BARCODE_SCANNER 0x03C8
775 
781 typedef enum
782 {
784  GAP_CONN_EVT_STAT_SUCCESS = LL_CONN_EVT_STAT_SUCCESS,
786  GAP_CONN_EVT_STAT_CRC_ERROR = LL_CONN_EVT_STAT_CRC_ERROR,
788  GAP_CONN_EVT_STAT_MISSED = LL_CONN_EVT_STAT_MISSED
790 
794 typedef enum
795 {
797  GAP_CONN_EVT_TASK_TYPE_ADV = LL_TASK_ID_ADVERTISER,
799  GAP_CONN_EVT_TASK_TYPE_INIT = LL_TASK_ID_INITIATOR,
801  GAP_CONN_EVT_TASK_TYPE_SLAVE = LL_TASK_ID_SLAVE,
803  GAP_CONN_EVT_TASK_TYPE_SCAN = LL_TASK_ID_SCANNER,
805  GAP_CONN_EVT_TASK_TYPE_MASTER = LL_TASK_ID_MASTER,
806  // No task
807  GAP_CONN_EVT_TASK_TYPE_NONE = LL_TASK_ID_NONE
809 
813 typedef enum
814 {
818 
819 
822 /*-------------------------------------------------------------------
823  * TYPEDEFS - Initialization and Configuration
824  */
825 
835 typedef uint16 gapParamIDs_t;
836 
838 typedef struct
839 {
841  uint8 opcode;
842 } gapEventHdr_t;
843 
854 typedef struct
855 {
857  uint8 opcode;
858  uint8 addrMode;
859  uint8 newRandomAddr[B_ADDR_LEN];
861 
871 typedef struct
872 {
874  uint16 intervalMin;
876  uint16 intervalMax;
878  uint16 latency;
880  uint16 timeout;
882 
895 typedef struct
896 {
898  uint8 opcode;
899  uint8 devAddr[B_ADDR_LEN];
900  uint16 dataPktLen;
901  uint8 numDataPkts;
903 
914 typedef struct
915 {
917  uint8 opcode;
918  uint8 addrType;
919  uint8 devAddr[B_ADDR_LEN];
920  uint32 signCounter;
922 
930 typedef struct
931 {
933  uint8 opcode;
934  uint8 eventType;
935  uint8 addrType;
936  uint8 addr[B_ADDR_LEN];
937  int8 rssi;
938  uint8 dataLen;
939  uint8 *pEvtData;
941  // end of GAP_Events
943 
944 /*-------------------------------------------------------------------
945  * TYPEDEFS - Device Discovery
946  */
947 
949 typedef struct
950 {
951  uint8 taskID;
952  uint8 mode;
953  uint8 activeScan;
954  uint8 whiteList;
956 
958 typedef struct
959 {
960  uint8 eventType;
961  uint8 addrType;
962  uint8 addr[B_ADDR_LEN];
963 } gapDevRec_t;
964 
976 typedef struct
977 {
979  uint8 opcode;
980  uint8 numDevs;
983  // end of GAP_Events
985 
987 typedef struct
988 {
989  uint8 eventType;
991  uint8 initiatorAddr[B_ADDR_LEN];
992  uint8 channelMap;
993  uint8 filterPolicy;
995 
1007 typedef struct
1008 {
1010  uint8 opcode;
1012 
1019 typedef struct
1020 {
1022  uint8 opcode;
1024 
1031 typedef struct
1032 {
1034  uint8 opcode;
1035  uint8 adType;
1037  // end of GAP_Events
1039 
1040 /*-------------------------------------------------------------------
1041  * TYPEDEFS - Link Establishment
1042  */
1043 
1045 typedef struct
1046 {
1047  uint8 taskID;
1049  uint8 whiteList;
1051  uint8 peerAddr[B_ADDR_LEN];
1052 } gapEstLinkReq_t;
1053 
1055 typedef struct
1056 {
1058  uint16 intervalMin;
1059  uint16 intervalMax;
1060  uint16 connLatency;
1061  uint16 connTimeout;
1063 
1065 typedef struct
1066 {
1068  uint16 intervalMin;
1069  uint16 intervalMax;
1070  uint16 connLatency;
1071  uint16 connTimeout;
1072  uint8 accepted;
1074 
1086 typedef struct
1087 {
1089  uint8 opcode;
1092 
1102 typedef struct
1103 {
1105  uint8 opcode;
1106  uint8 devAddrType;
1107  uint8 devAddr[B_ADDR_LEN];
1109  uint8 connRole;
1110  uint16 connInterval;
1111  uint16 connLatency;
1112  uint16 connTimeout;
1115 
1122 typedef struct
1123 {
1125  uint8 opcode;
1126  uint8 status;
1128  uint16 connInterval;
1129  uint16 connLatency;
1130  uint16 connTimeout;
1132 
1139 typedef struct
1140 {
1142  uint8 opcode;
1144  uint8 reason;
1146 
1147 /*-------------------------------------------------------------------
1148  * TYPEDEFS - Authentication, Bounding and Pairing
1149  */
1150 
1157 typedef struct
1158 {
1160  uint8 opcode;
1161  uint8 deviceAddr[B_ADDR_LEN];
1163  uint8 uiInputs;
1164  uint8 uiOutputs;
1165  uint32 numComparison;
1167 
1174 typedef struct
1175 {
1177  uint8 opcode;
1179  uint8 authState;
1185  // end of GAP_Events
1187 
1194 typedef struct
1195 {
1198 } gapAuthParams_t;
1199 
1211 typedef struct
1212 {
1214  uint8 opcode;
1216  uint8 deviceAddr[B_ADDR_LEN];
1217  uint8 authReq;
1219 
1226 typedef struct
1227 {
1229  uint8 opcode;
1232  // end of GAP_Events
1234 
1236 typedef struct
1237 {
1238  uint8 ioCap;
1239  uint8 oobDataFlag;
1240  uint8 authReq;
1243 } gapPairingReq_t;
1244 
1261 typedef struct
1262 {
1264  uint8 opcode;
1268 
1272 typedef struct
1273 {
1274  GAP_ConnEvtStat_t status;
1275  uint16_t handle;
1276  uint8_t channel;
1277  int8_t lastRssi;
1278  uint16_t packets;
1281  uint16_t errors;
1283  GAP_ConnEvtTaskType_t nextTaskType;
1285  uint32_t nextTaskTime;
1287  // end of GAP_Events
1289 
1297 typedef struct
1298 {
1299  uint8 adType;
1300  uint8 attrLen;
1301  uint8 *pAttrData;
1303 
1310 typedef uint8 (*pfnSuppEnhPrivCB_t)
1313  uint8 *deviceAddr
1314 );
1315 
1317 typedef void (*pfnGapIdleCB_t)();
1318 
1320 typedef struct
1321 {
1324 } gapBondMgrCBs_t;
1325 
1340 typedef void (*pfnGapConnEvtCB_t)
1343  Gap_ConnEventRpt_t *pReport
1344 );
1345 
1348 /*-------------------------------------------------------------------
1349  * GLOBAL VARIABLES
1350  */
1351 
1352 /*-------------------------------------------------------------------
1353  * FUNCTIONS - Initialization and Configuration
1354  */
1355 
1382  extern bStatus_t GAP_DeviceInit( uint8 taskID,
1383  uint8 profileRole,
1384  uint8 maxScanResponses,
1385  uint8 *pIRK,
1386  uint8 *pSRK,
1387  uint32 *pSignCounter );
1388 
1398  extern void GAP_UpdateResolvingList( uint8 *pIRK );
1399 
1419  extern bStatus_t GAP_SetAdvToken( gapAdvDataToken_t *pToken );
1420 
1430  extern gapAdvDataToken_t *GAP_GetAdvToken( uint8 adType );
1431 
1442  extern gapAdvDataToken_t *GAP_RemoveAdvToken( uint8 adType );
1443 
1452  extern bStatus_t GAP_UpdateAdvTokens( void );
1453 
1466  extern bStatus_t GAP_SetParamValue( gapParamIDs_t paramID, uint16 paramValue );
1467 
1476  extern uint16 GAP_GetParamValue( gapParamIDs_t paramID );
1477 
1505  extern bStatus_t GAP_ConfigDeviceAddr( uint8 addrMode, uint8 *pStaticAddr );
1506 
1515  extern void GAP_RegisterForMsgs( uint8 taskID );
1516 
1522  extern void GAP_RegisterBondMgrCBs( gapBondMgrCBs_t *pCBs );
1523 
1524 /*-------------------------------------------------------------------
1525  * FUNCTIONS - Device Discovery
1526  */
1527 
1544 
1558  extern bStatus_t GAP_DeviceDiscoveryCancel( uint8 taskID );
1559 
1574  extern bStatus_t GAP_MakeDiscoverable( uint8 taskID, gapAdvertisingParams_t *pParams );
1575 
1590  extern bStatus_t GAP_UpdateAdvertisingData( uint8 taskID, uint8 adType,
1591  uint8 dataLen, uint8 *pAdvertData );
1592 
1605  extern bStatus_t GAP_EndDiscoverable( uint8 taskID );
1606 
1607 #if !defined (BLE_V42_FEATURES) || !(BLE_V42_FEATURES & PRIVACY_1_2_CFG)
1608 
1618  extern bStatus_t GAP_ResolvePrivateAddr( uint8 *pIRK, uint8 *pAddr );
1619 #endif // ! BLE_V42_FEATURES | ! PRIVACY_1_2_CFG
1620 
1621 /*-------------------------------------------------------------------
1622  * FUNCTIONS - Link Establishment
1623  */
1624 
1639  extern bStatus_t GAP_EstablishLinkReq( gapEstLinkReq_t *pParams );
1640 
1656  extern bStatus_t GAP_TerminateLinkReq( uint8 taskID, uint16 connectionHandle, uint8 reason );
1657 
1674 
1701 
1707  extern uint8 GAP_NumActiveConnections( void );
1708 
1735  GAP_CB_Action_t action,
1736  uint16_t connHandle);
1737 
1738 
1739 
1740 /*-------------------------------------------------------------------
1741  * FUNCTIONS - Pairing
1742  */
1743 
1771  extern bStatus_t GAP_Authenticate( gapAuthParams_t *pParams, gapPairingReq_t *pPairReq );
1772 
1779  extern uint8 GAP_isPairing(void);
1780 
1798  extern bStatus_t GAP_TerminateAuth( uint16 connectionHandle, uint8 reason );
1799 
1819  extern bStatus_t GAP_PasskeyUpdate( uint8 *pPasskey, uint16 connectionHandle );
1820 
1839  extern bStatus_t GAP_PasscodeUpdate( uint32 passcode, uint16 connectionHandle );
1840 
1855  extern bStatus_t GAP_SendSlaveSecurityRequest( uint16 connectionHandle, uint8 authReq );
1856 
1873  extern bStatus_t GAP_Signable( uint16 connectionHandle, uint8 authenticated, smSigningInfo_t *pParams );
1874 
1896  extern bStatus_t GAP_Bond( uint16 connectionHandle, uint8 authenticated,
1897  uint8 secureConnections, smSecurityInfo_t *pParams,
1898  uint8 startEncryption );
1899 
1900 /*-------------------------------------------------------------------
1901  * Internal API - These functions are only called from gap.c module.
1902  */
1903 
1905 
1916  extern bStatus_t GAP_ParamsInit( uint8 taskID, uint8 profileRole );
1917 
1925  extern void GAP_PrivacyInit( uint8 *pIRK );
1926 
1934  extern uint8 *GAP_GetIRK( void );
1935 
1948  extern void GAP_SecParamsInit( uint8 *pSRK, uint32 *pSignCounter );
1949 
1957  extern bStatus_t GAP_PeriDevMgrInit( void );
1958 
1965  extern void GAP_PeriConnRegister( void );
1966 
1978  extern bStatus_t GAP_CentDevMgrInit( uint8 maxScanResponses );
1979 
1986  extern void GAP_CentConnRegister( void );
1987 
1988 
1989 /*-------------------------------------------------------------------
1990  * TASK API - These functions must only be called OSAL.
1991  */
1992 
2000  extern void GAP_Init( uint8 task_id );
2001 
2012  extern uint16 GAP_ProcessEvent( uint8 task_id, uint16 events );
2013 
2015 
2016 /*-------------------------------------------------------------------
2017 -------------------------------------------------------------------*/
2018 
2019 #ifdef __cplusplus
2020 }
2021 #endif
2022 
2023 #endif /* GAP_H */
2024 
bStatus_t GAP_ResolvePrivateAddr(uint8 *pIRK, uint8 *pAddr)
Resolves a private address against an IRK.
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1033
uint8 authState
TRUE if the pairing was authenticated (MITM)
Definition: gap.h:1179
uint8 opcode
GAP_MAKE_DISCOVERABLE_DONE_EVENT
Definition: gap.h:1010
uint8 opcode
GAP_END_DISCOVERABLE_DONE_EVENT
Definition: gap.h:1022
bStatus_t GAP_SetAdvToken(gapAdvDataToken_t *pToken)
Set Advertising Token.
uint8 opcode
GAP_SIGNATURE_UPDATED_EVENT
Definition: gap.h:917
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:916
uint8 eventType
Advertise Event Type: GAP Advertising Event Types.
Definition: gap.h:989
This API allows the software components in the Z-Stack to be written independently of the specifics o...
uint16 connectionHandle
connection Handle
Definition: gap.h:1230
uint8 attrLen
Number of bytes in the attribute data.
Definition: gap.h:1300
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:856
void(* pfnGapConnEvtCB_t)(Gap_ConnEventRpt_t *pReport)
Definition: gap.h:1341
uint8 authReq
Authentication Requirements: Bit 2: MITM, Bits 0-1: bonding (0 - no bonding, 1 - bonding) ...
Definition: gap.h:1217
This file contains the interface to the SM.
bStatus_t GAP_DeviceDiscoveryRequest(gapDevDiscReq_t *pParams)
Start a device discovery scan.
Definition: sm.h:190
smSecurityInfo_t * pSecurityInfo
BOUND - security information from this device.
Definition: gap.h:1180
bStatus_t GAP_TerminateAuth(uint16 connectionHandle, uint8 reason)
Terminate Authnetication.
Authentication Parameters.
Definition: gap.h:1194
bStatus_t GAP_PasskeyUpdate(uint8 *pPasskey, uint16 connectionHandle)
Update the passkey in string format.
GAP_MAKE_DISCOVERABLE_DONE_EVENT message format.
Definition: gap.h:1007
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1213
uint8 mode
Discovery Mode: GAP Device Discovery Modes.
Definition: gap.h:952
bStatus_t GAP_EstablishLinkReq(gapEstLinkReq_t *pParams)
Establish a link to a slave device.
Connection event in slave role.
Definition: gap.h:801
uint8 adType
ADTYPE value: Address Types.
Definition: gap.h:1299
smSigningInfo_t * pSigningInfo
Signing information.
Definition: gap.h:1181
uint8 addrType
Device's address type for devAddr.
Definition: gap.h:918
uint16_t handle
connection handle
Definition: gap.h:1275
uint16 connectionHandle
Connection Handle.
Definition: gap.h:1215
GAP_ConnEvtTaskType_t
Definition: gap.h:794
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:897
uint16 latency
Definition: gap.h:878
uint8 dataLen
Length (in bytes) of the data field (evtData)
Definition: gap.h:938
uint16 gapParamIDs_t
GAP Parameters IDs.
Definition: gap.h:835
uint8 adType
TRUE if advertising data, FALSE if SCAN_RSP.
Definition: gap.h:1035
GAP_PASSKEY_NEEDED_EVENT message format.
Definition: gap.h:1157
GAP_CB_Action_t
Definition: gap.h:813
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:840
Connection parameters for the peripheral device.
Definition: gap.h:871
GAP_DEVICE_INIT_DONE_EVENT message format.
Definition: gap.h:895
Definition: gap.h:1272
uint8 taskID
Requesting App's Task ID, used to return results.
Definition: gap.h:951
GAP_SLAVE_REQUESTED_SECURITY_EVENT message format.
Definition: gap.h:1211
Register a callback.
Definition: gap.h:815
Connection event occurred successfully.
Definition: gap.h:784
GAP_ConnEvtStat_t status
status of connection event
Definition: gap.h:1274
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1009
bStatus_t GAP_TerminateLinkReq(uint8 taskID, uint16 connectionHandle, uint8 reason)
Terminate a link connection.
GAP event header format.
Definition: gap.h:838
GAP_BOND_COMPLETE_EVENT message format.
Definition: gap.h:1226
uint8 eventType
Indicates advertising event type used by the advertiser: GAP Advertising Report Event Types...
Definition: gap.h:960
GAP_ConnEvtTaskType_t nextTaskType
Type of next BLE task.
Definition: gap.h:1283
bStatus_t GAP_Bond(uint16 connectionHandle, uint8 authenticated, uint8 secureConnections, smSecurityInfo_t *pParams, uint8 startEncryption)
Set up the connection's bound paramaters.
uint16 connectionHandle
Connection Handle from controller,.
Definition: gap.h:1196
GAP_PAIRING_REQ_EVENT message format.
Definition: gap.h:1261
uint8 addrType
Address Type: Address Types.
Definition: gap.h:961
int8_t lastRssi
Definition: gap.h:1277
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1228
uint8 uiInputs
Pairing User Interface Inputs - Ask user to input passcode.
Definition: gap.h:1163
uint8 numDevs
Number of devices found during scan.
Definition: gap.h:980
GAP_ConnEvtStat_t
Definition: gap.h:781
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1159
bStatus_t GAP_UpdateLinkParamReq(gapUpdateLinkParamReq_t *pParams)
Update the link parameters to a Master or Slave device.
uint8 opcode
GAP type of command. GAP Event IDs.
Definition: gap.h:841
keyDist_t keyDist
Pairing Request Key Distribution field.
Definition: gap.h:1242
uint8_t channel
BLE RF channel index (0-39)
Definition: gap.h:1276
uint8(* pfnSuppEnhPrivCB_t)(uint8 *deviceAddr)
Enhanced Privacy Check Callback Function.
Definition: gap.h:1312
uint8 maxEncKeySize
Pairing Request Maximum Encryption Key Size field.
Definition: gap.h:1241
bStatus_t GAP_Signable(uint16 connectionHandle, uint8 authenticated, smSigningInfo_t *pParams)
Set up the connection to accept signed data.
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:932
GAP_SIGNATURE_UPDATED_EVENT message format.
Definition: gap.h:914
uint8 numDataPkts
HC_Total_Num_LE_Data_Packets.
Definition: gap.h:901
uint8 opcode
GAP_PAIRING_REQ_EVENT
Definition: gap.h:1264
uint8 opcode
GAP_SLAVE_REQUESTED_SECURITY_EVENT
Definition: gap.h:1214
Definition: sm.h:144
uint8 opcode
GAP_DEVICE_INFO_EVENT
Definition: gap.h:933
uint8 initiatorAddrType
Initiator's address type: Address Types.
Definition: gap.h:990
uint8 opcode
GAP_ADV_DATA_UPDATE_DONE_EVENT
Definition: gap.h:1034
uint16 intervalMax
Definition: gap.h:876
Type of device discovery (Scan) to perform.
Definition: gap.h:958
uint16 GAP_GetParamValue(gapParamIDs_t paramID)
Get a GAP Parameter value.
uint8 opcode
GAP_DEVICE_INIT_DONE_EVENT
Definition: gap.h:898
bStatus_t GAP_MakeDiscoverable(uint8 taskID, gapAdvertisingParams_t *pParams)
Setup or change advertising. Also starts advertising.
bStatus_t GAP_DeviceDiscoveryCancel(uint8 taskID)
Cancel an existing device discovery request.
smIdentityInfo_t * pIdentityInfo
BOUND - identity information.
Definition: gap.h:1183
void GAP_UpdateResolvingList(uint8 *pIRK)
Update the resolving list.
Definition: sm.h:201
void GAP_RegisterBondMgrCBs(gapBondMgrCBs_t *pCBs)
Register bond manager call backs.
GAP_DEVICE_INFO_EVENT message format.
Definition: gap.h:930
uint8 uiOutputs
Pairing User Interface Outputs - Display passcode.
Definition: gap.h:1164
bStatus_t GAP_ConfigDeviceAddr(uint8 addrMode, uint8 *pStaticAddr)
Configure Device Address.
uint16 connectionHandle
Connection Handle from controller used to ref the device.
Definition: gap.h:1178
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1021
uint8 opcode
GAP_DEVICE_DISCOVERY_EVENT
Definition: gap.h:979
GAP_ADV_DATA_UPDATE_DONE_EVENT message format.
Definition: gap.h:1031
uint16 connectionHandle
connection Handle
Definition: gap.h:1265
bStatus_t GAP_RegisterConnEventCb(pfnGapConnEvtCB_t cb, GAP_CB_Action_t action, uint16_t connHandle)
uint32 signCounter
new Signed Counter
Definition: gap.h:920
smLinkSecurityReq_t secReqs
Pairing Control info.
Definition: gap.h:1197
uint8 addrType
address type: Address Types
Definition: gap.h:935
uint16 timeout
Definition: gap.h:880
bStatus_t GAP_UpdateAdvTokens(void)
Update Advertising Token.
gapAdvDataToken_t * GAP_GetAdvToken(uint8 adType)
Get Advertising Token.
uint16 intervalMin
Definition: gap.h:874
uint8 oobDataFlag
Pairing Request OOB Data Flag field.
Definition: gap.h:1239
uint16_t errors
Total number of CRC errors for the entire connection.
Definition: gap.h:1281
int8 rssi
Advertisement or SCAN_RSP RSSI.
Definition: gap.h:937
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:978
Type of device discovery (Scan) to perform.
Definition: gap.h:949
uint8 opcode
GAP_AUTHENTICATION_COMPLETE_EVENT
Definition: gap.h:1177
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1176
Type definitions and macros for BLE stack.
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1263
No data was received during connection event.
Definition: gap.h:788
smSecurityInfo_t * pDevSecInfo
BOUND - security information from connected device.
Definition: gap.h:1182
Initiating a connection.
Definition: gap.h:799
void(* pfnGapIdleCB_t)()
GAP Idle Callback Function.
Definition: gap.h:1317
Definition: sm.h:211
uint8 channelMap
Channel Map: Bit mask GAP Advertisement Channel Map.
Definition: gap.h:992
uint8 addrMode
Address mode: GAP Addressing Modes.
Definition: gap.h:858
uint8 filterPolicy
Filer Policy: GAP Advertiser Filter Scan Parameters. Ignored when directed advertising is used...
Definition: gap.h:993
GAP_END_DISCOVERABLE_DONE_EVENT message format.
Definition: gap.h:1019
uint8 opcode
GAP_PASSKEY_NEEDED_EVENT
Definition: gap.h:1160
bStatus_t GAP_PasscodeUpdate(uint32 passcode, uint16 connectionHandle)
Update the passkey in a numeric value (not string).
void GAP_RegisterForMsgs(uint8 taskID)
Register for GAP Messages.
OSAL Event Header.
Definition: osal.h:92
Connection event failed because all packets had CRC errors.
Definition: gap.h:786
bStatus_t GAP_UpdateLinkParamReqReply(gapUpdateLinkParamReqReply_t *pParams)
Reply to a Connection Parameter Update Request sent from a peer device.
pfnSuppEnhPrivCB_t supportEnhPrivCB
Supports Enhanced Privacy callback.
Definition: gap.h:1322
Advertiser.
Definition: gap.h:797
uint8 opcode
GAP_RANDOM_ADDR_CHANGED_EVENT
Definition: gap.h:857
#define B_ADDR_LEN
Default Public and Random Address Length.
Definition: bcomdef.h:115
uint8 eventType
Advertisement Type: GAP Advertising Report Event Types.
Definition: gap.h:934
uint8 ioCap
Pairing Request ioCap field.
Definition: gap.h:1238
GAP_AUTHENTICATION_COMPLETE_EVENT message format.
Definition: gap.h:1174
Callback Registration Structure.
Definition: gap.h:1320
uint8 GAP_isPairing(void)
Check if GAP is currently pairing.
uint32_t nextTaskTime
Time to next BLE task (in us). 0xFFFFFFFF if there is no next task.
Definition: gap.h:1285
uint8 opcode
GAP_BOND_COMPLETE_EVENT
Definition: gap.h:1229
uint8 * pAttrData
pointer to Attribute data
Definition: gap.h:1301
pfnGapIdleCB_t gapIdleCB
GAP Idle callback.
Definition: gap.h:1323
Status_t bStatus_t
BLE Generic Status return.
Definition: bcomdef.h:233
GAP_DEVICE_DISCOVERY_EVENT message format.
Definition: gap.h:976
GAP_RANDOM_ADDR_CHANGED_EVENT message format.
Definition: gap.h:854
bStatus_t GAP_SendSlaveSecurityRequest(uint16 connectionHandle, uint8 authReq)
Generate a Slave Requested Security message to the master.
bStatus_t GAP_EndDiscoverable(uint8 taskID)
Stops advertising.
uint8 GAP_NumActiveConnections(void)
Returns the number of active connections.
uint8 activeScan
TRUE for active scanning.
Definition: gap.h:953
Pairing Request fields - the parsed fields of the SMP Pairing Request command.
Definition: gap.h:1236
uint8 * pEvtData
Data field of advertisement or SCAN_RSP.
Definition: gap.h:939
Advertising Parameters.
Definition: gap.h:987
Connection event in master role.
Definition: gap.h:805
bStatus_t GAP_UpdateAdvertisingData(uint8 taskID, uint8 adType, uint8 dataLen, uint8 *pAdvertData)
Setup or change advertising and scan response data.
uint16 dataPktLen
HC_LE_Data_Packet_Length.
Definition: gap.h:900
uint32 numComparison
Numeric Comparison value to be displayed.
Definition: gap.h:1165
gapPairingReq_t pairReq
The Pairing Request fields received.
Definition: gap.h:1266
Scanner.
Definition: gap.h:803
bStatus_t GAP_Authenticate(gapAuthParams_t *pParams, gapPairingReq_t *pPairReq)
Start Authentication.
bStatus_t GAP_DeviceInit(uint8 taskID, uint8 profileRole, uint8 maxScanResponses, uint8 *pIRK, uint8 *pSRK, uint32 *pSignCounter)
GAP Device Initialiation.
uint8 whiteList
Filer Policy: GAP Discovery Filter Scan Parameters.
Definition: gap.h:954
uint16 connectionHandle
Connection handle.
Definition: gap.h:1162
GAP Advertisement/Scan Response Data Token.
Definition: gap.h:1297
Unregister a callback
Definition: gap.h:816
gapAdvDataToken_t * GAP_RemoveAdvToken(uint8 adType)
Remove Advertising Token.
uint8 authReq
Pairing Request Auth Req field.
Definition: gap.h:1240
gapDevRec_t * pDevList
array of device records
Definition: gap.h:981
bStatus_t GAP_SetParamValue(gapParamIDs_t paramID, uint16 paramValue)
Set a GAP Parameter value.
© Copyright 1995-2018, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale