TI BLE-Stack for Bluetooth 4.2 API Documentation  3.02.03.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 
666 #define GAP_DISC_FILTER_POLICY_ALL 0x00
667 #define GAP_DISC_FILTER_POLICY_WHITE 0x01
668 #define GAP_DISC_FILTER_POLICY_ALL_DIRECT 0x02
669 #define GAP_DISC_FILTER_POLICY_WHITE_DIRECT 0x03
670 
672 #define ADV_CHANMAP_SIZE 5
673 
674 #define GAP_PASSCODE_MAX 999999
675 
676 
682 #define GAP_INIT_SIGN_COUNTER 0xFFFFFFFF
683 
687 #define GAP_ADVCHAN_37 0x01
688 #define GAP_ADVCHAN_38 0x02
689 #define GAP_ADVCHAN_39 0x04
690 #define GAP_ADVCHAN_ALL (GAP_ADVCHAN_37 | GAP_ADVCHAN_38 | GAP_ADVCHAN_39)
691 
696 #define WL_NOTUSED 0x00
697 #define WL_USED 0x01
698 
704 #define GAP_ADTYPE_FLAGS 0x01
705 #define GAP_ADTYPE_16BIT_MORE 0x02
706 #define GAP_ADTYPE_16BIT_COMPLETE 0x03
707 #define GAP_ADTYPE_32BIT_MORE 0x04
708 #define GAP_ADTYPE_32BIT_COMPLETE 0x05
709 #define GAP_ADTYPE_128BIT_MORE 0x06
710 #define GAP_ADTYPE_128BIT_COMPLETE 0x07
711 #define GAP_ADTYPE_LOCAL_NAME_SHORT 0x08
712 #define GAP_ADTYPE_LOCAL_NAME_COMPLETE 0x09
713 #define GAP_ADTYPE_POWER_LEVEL 0x0A
714 #define GAP_ADTYPE_OOB_CLASS_OF_DEVICE 0x0D
715 #define GAP_ADTYPE_OOB_SIMPLE_PAIRING_HASHC 0x0E
716 #define GAP_ADTYPE_OOB_SIMPLE_PAIRING_RANDR 0x0F
717 #define GAP_ADTYPE_SM_TK 0x10
718 #define GAP_ADTYPE_SM_OOB_FLAG 0x11
719 #define GAP_ADTYPE_SLAVE_CONN_INTERVAL_RANGE 0x12
720 #define GAP_ADTYPE_SIGNED_DATA 0x13
721 #define GAP_ADTYPE_SERVICES_LIST_16BIT 0x14
722 #define GAP_ADTYPE_SERVICES_LIST_128BIT 0x15
723 #define GAP_ADTYPE_SERVICE_DATA 0x16
724 #define GAP_ADTYPE_PUBLIC_TARGET_ADDR 0x17
725 #define GAP_ADTYPE_RANDOM_TARGET_ADDR 0x18
726 #define GAP_ADTYPE_APPEARANCE 0x19
727 #define GAP_ADTYPE_ADV_INTERVAL 0x1A
728 #define GAP_ADTYPE_LE_BD_ADDR 0x1B
729 #define GAP_ADTYPE_LE_ROLE 0x1C
730 #define GAP_ADTYPE_SIMPLE_PAIRING_HASHC_256 0x1D
731 #define GAP_ADTYPE_SIMPLE_PAIRING_RANDR_256 0x1E
732 #define GAP_ADTYPE_SERVICE_DATA_32BIT 0x20
733 #define GAP_ADTYPE_SERVICE_DATA_128BIT 0x21
734 #define GAP_ADTYPE_3D_INFO_DATA 0x3D
735 #define GAP_ADTYPE_MANUFACTURER_SPECIFIC 0xFF
736 #define GAP_ADTYPE_FLAGS_LIMITED 0x01
737 #define GAP_ADTYPE_FLAGS_GENERAL 0x02
738 #define GAP_ADTYPE_FLAGS_BREDR_NOT_SUPPORTED 0x04
739 
744 #define GAP_STATE_IDLE 0x00
745 #define GAP_STATE_ADV 0x01
746 #define GAP_STATE_SCAN 0x02
747 #define GAP_STATE_INIT 0x04
748 
753 #define GAP_APPEARE_UNKNOWN 0x0000
754 #define GAP_APPEARE_GENERIC_PHONE 0x0040
755 #define GAP_APPEARE_GENERIC_COMPUTER 0x0080
756 #define GAP_APPEARE_GENERIC_WATCH 0x00C0
757 #define GAP_APPEARE_WATCH_SPORTS 0x00C1
758 #define GAP_APPEARE_GENERIC_CLOCK 0x0100
759 #define GAP_APPEARE_GENERIC_DISPLAY 0x0140
760 #define GAP_APPEARE_GENERIC_RC 0x0180
761 #define GAP_APPEARE_GENERIC_EYE_GALSSES 0x01C0
762 #define GAP_APPEARE_GENERIC_TAG 0x0200
763 #define GAP_APPEARE_GENERIC_KEYRING 0x0240
764 #define GAP_APPEARE_GENERIC_MEDIA_PLAYER 0x0280
765 #define GAP_APPEARE_GENERIC_BARCODE_SCANNER 0x02C0
766 #define GAP_APPEARE_GENERIC_THERMOMETER 0x0300
767 #define GAP_APPEARE_GENERIC_THERMO_EAR 0x0301
768 #define GAP_APPEARE_GENERIC_HR_SENSOR 0x0340
769 #define GAP_APPEARE_GENERIC_HRS_BELT 0x0341
770 #define GAP_APPEARE_GENERIC_BLOOD_PRESSURE 0x0380
771 #define GAP_APPEARE_GENERIC_BP_ARM 0x0381
772 #define GAP_APPEARE_GENERIC_BP_WRIST 0x0382
773 #define GAP_APPEARE_GENERIC_HID 0x03C0
774 #define GAP_APPEARE_HID_KEYBOARD 0x03C1
775 #define GAP_APPEARE_HID_MOUSE 0x03C2
776 #define GAP_APPEARE_HID_JOYSTIC 0x03C3
777 #define GAP_APPEARE_HID_GAMEPAD 0x03C4
778 #define GAP_APPEARE_HID_DIGITIZER_TYABLET 0x03C5
779 #define GAP_APPEARE_HID_DIGITAL_CARDREADER 0x03C6
780 #define GAP_APPEARE_HID_DIGITAL_PEN 0x03C7
781 #define GAP_APPEARE_HID_BARCODE_SCANNER 0x03C8
782 
787 #define GAP_LLERROR_COMMAND_DISALLOWED 0x0C
788 #define GAP_LLERROR_INVALID_PARAMETERS 0x12
789 
794 typedef enum
795 {
797  GAP_CONN_EVT_STAT_SUCCESS = LL_CONN_EVT_STAT_SUCCESS,
799  GAP_CONN_EVT_STAT_CRC_ERROR = LL_CONN_EVT_STAT_CRC_ERROR,
801  GAP_CONN_EVT_STAT_MISSED = LL_CONN_EVT_STAT_MISSED
803 
807 typedef enum
808 {
810  GAP_CONN_EVT_TASK_TYPE_ADV = LL_TASK_ID_ADVERTISER,
812  GAP_CONN_EVT_TASK_TYPE_INIT = LL_TASK_ID_INITIATOR,
814  GAP_CONN_EVT_TASK_TYPE_SLAVE = LL_TASK_ID_SLAVE,
816  GAP_CONN_EVT_TASK_TYPE_SCAN = LL_TASK_ID_SCANNER,
818  GAP_CONN_EVT_TASK_TYPE_MASTER = LL_TASK_ID_MASTER,
819  // No task
820  GAP_CONN_EVT_TASK_TYPE_NONE = LL_TASK_ID_NONE
822 
826 typedef enum
827 {
831 
832 
835 /*-------------------------------------------------------------------
836  * TYPEDEFS - Initialization and Configuration
837  */
838 
848 typedef uint16 gapParamIDs_t;
849 
851 typedef struct
852 {
854  uint8 opcode;
855 } gapEventHdr_t;
856 
867 typedef struct
868 {
870  uint8 opcode;
871  uint8 addrMode;
872  uint8 newRandomAddr[B_ADDR_LEN];
874 
884 typedef struct
885 {
887  uint16 intervalMin;
889  uint16 intervalMax;
891  uint16 latency;
893  uint16 timeout;
895 
908 typedef struct
909 {
911  uint8 opcode;
912  uint8 devAddr[B_ADDR_LEN];
913  uint16 dataPktLen;
914  uint8 numDataPkts;
916 
927 typedef struct
928 {
930  uint8 opcode;
931  uint8 addrType;
932  uint8 devAddr[B_ADDR_LEN];
933  uint32 signCounter;
935 
943 typedef struct
944 {
946  uint8 opcode;
947  uint8 eventType;
948  uint8 addrType;
949  uint8 addr[B_ADDR_LEN];
950  int8 rssi;
951  uint8 dataLen;
952  uint8 *pEvtData;
954  // end of GAP_Events
956 
957 /*-------------------------------------------------------------------
958  * TYPEDEFS - Device Discovery
959  */
960 
962 typedef struct
963 {
964  uint8 taskID;
965  uint8 mode;
966  uint8 activeScan;
967  uint8 whiteList;
969 
971 typedef struct
972 {
973  uint8 eventType;
974  uint8 addrType;
975  uint8 addr[B_ADDR_LEN];
976 } gapDevRec_t;
977 
989 typedef struct
990 {
992  uint8 opcode;
993  uint8 numDevs;
996  // end of GAP_Events
998 
1000 typedef struct
1001 {
1002  uint8 eventType;
1004  uint8 initiatorAddr[B_ADDR_LEN];
1005  uint8 channelMap;
1008 
1020 typedef struct
1021 {
1023  uint8 opcode;
1025 
1032 typedef struct
1033 {
1035  uint8 opcode;
1037 
1044 typedef struct
1045 {
1047  uint8 opcode;
1048  uint8 adType;
1050  // end of GAP_Events
1052 
1053 /*-------------------------------------------------------------------
1054  * TYPEDEFS - Link Establishment
1055  */
1056 
1058 typedef struct
1059 {
1060  uint8 taskID;
1062  uint8 whiteList;
1064  uint8 peerAddr[B_ADDR_LEN];
1065 } gapEstLinkReq_t;
1066 
1068 typedef struct
1069 {
1071  uint16 intervalMin;
1072  uint16 intervalMax;
1073  uint16 connLatency;
1074  uint16 connTimeout;
1076 
1078 typedef struct
1079 {
1081  uint16 intervalMin;
1082  uint16 intervalMax;
1083  uint16 connLatency;
1084  uint16 connTimeout;
1085  uint8 accepted;
1087 
1099 typedef struct
1100 {
1102  uint8 opcode;
1105 
1115 typedef struct
1116 {
1118  uint8 opcode;
1119  uint8 devAddrType;
1120  uint8 devAddr[B_ADDR_LEN];
1122  uint8 connRole;
1123  uint16 connInterval;
1124  uint16 connLatency;
1125  uint16 connTimeout;
1128 
1135 typedef struct
1136 {
1138  uint8 opcode;
1139  uint8 status;
1141  uint16 connInterval;
1142  uint16 connLatency;
1143  uint16 connTimeout;
1145 
1152 typedef struct
1153 {
1155  uint8 opcode;
1157  uint8 reason;
1159 
1160 /*-------------------------------------------------------------------
1161  * TYPEDEFS - Authentication, Bounding and Pairing
1162  */
1163 
1170 typedef struct
1171 {
1173  uint8 opcode;
1174  uint8 deviceAddr[B_ADDR_LEN];
1176  uint8 uiInputs;
1177  uint8 uiOutputs;
1178  uint32 numComparison;
1180 
1187 typedef struct
1188 {
1190  uint8 opcode;
1192  uint8 authState;
1198  // end of GAP_Events
1200 
1207 typedef struct
1208 {
1211 } gapAuthParams_t;
1212 
1224 typedef struct
1225 {
1227  uint8 opcode;
1229  uint8 deviceAddr[B_ADDR_LEN];
1230  uint8 authReq;
1232 
1239 typedef struct
1240 {
1242  uint8 opcode;
1245  // end of GAP_Events
1247 
1249 typedef struct
1250 {
1251  uint8 ioCap;
1252  uint8 oobDataFlag;
1253  uint8 authReq;
1256 } gapPairingReq_t;
1257 
1274 typedef struct
1275 {
1277  uint8 opcode;
1281 
1285 typedef struct
1286 {
1287  GAP_ConnEvtStat_t status;
1288  uint16_t handle;
1289  uint8_t channel;
1290  int8_t lastRssi;
1291  uint16_t packets;
1294  uint16_t errors;
1296  GAP_ConnEvtTaskType_t nextTaskType;
1298  uint32_t nextTaskTime;
1300  // end of GAP_Events
1302 
1310 typedef struct
1311 {
1312  uint8 adType;
1313  uint8 attrLen;
1314  uint8 *pAttrData;
1316 
1323 typedef uint8 (*pfnSuppEnhPrivCB_t)
1326  uint8 *deviceAddr
1327 );
1328 
1330 typedef void (*pfnGapIdleCB_t)();
1331 
1333 typedef struct
1334 {
1337 } gapBondMgrCBs_t;
1338 
1353 typedef void (*pfnGapConnEvtCB_t)
1356  Gap_ConnEventRpt_t *pReport
1357 );
1358 
1361 /*-------------------------------------------------------------------
1362  * GLOBAL VARIABLES
1363  */
1364 
1365 /*-------------------------------------------------------------------
1366  * FUNCTIONS - Initialization and Configuration
1367  */
1368 
1403  extern bStatus_t GAP_DeviceInit( uint8 taskID,
1404  uint8 profileRole,
1405  uint8 maxScanResponses,
1406  uint8 *pIRK,
1407  uint8 *pSRK,
1408  uint32 *pSignCounter );
1409 
1419  extern void GAP_UpdateResolvingList( uint8 *pIRK );
1420 
1440  extern bStatus_t GAP_SetAdvToken( gapAdvDataToken_t *pToken );
1441 
1451  extern gapAdvDataToken_t *GAP_GetAdvToken( uint8 adType );
1452 
1463  extern gapAdvDataToken_t *GAP_RemoveAdvToken( uint8 adType );
1464 
1473  extern bStatus_t GAP_UpdateAdvTokens( void );
1474 
1487  extern bStatus_t GAP_SetParamValue( gapParamIDs_t paramID, uint16 paramValue );
1488 
1497  extern uint16 GAP_GetParamValue( gapParamIDs_t paramID );
1498 
1526  extern bStatus_t GAP_ConfigDeviceAddr( uint8 addrMode, uint8 *pStaticAddr );
1527 
1536  extern void GAP_RegisterForMsgs( uint8 taskID );
1537 
1543  extern void GAP_RegisterBondMgrCBs( gapBondMgrCBs_t *pCBs );
1544 
1545 /*-------------------------------------------------------------------
1546  * FUNCTIONS - Device Discovery
1547  */
1548 
1565 
1579  extern bStatus_t GAP_DeviceDiscoveryCancel( uint8 taskID );
1580 
1595  extern bStatus_t GAP_MakeDiscoverable( uint8 taskID, gapAdvertisingParams_t *pParams );
1596 
1611  extern bStatus_t GAP_UpdateAdvertisingData( uint8 taskID, uint8 adType,
1612  uint8 dataLen, uint8 *pAdvertData );
1613 
1626  extern bStatus_t GAP_EndDiscoverable( uint8 taskID );
1627 
1628 #if !defined (BLE_V42_FEATURES) || !(BLE_V42_FEATURES & PRIVACY_1_2_CFG)
1629 
1639  extern bStatus_t GAP_ResolvePrivateAddr( uint8 *pIRK, uint8 *pAddr );
1640 #endif // ! BLE_V42_FEATURES | ! PRIVACY_1_2_CFG
1641 
1642 /*-------------------------------------------------------------------
1643  * FUNCTIONS - Link Establishment
1644  */
1645 
1660  extern bStatus_t GAP_EstablishLinkReq( gapEstLinkReq_t *pParams );
1661 
1677  extern bStatus_t GAP_TerminateLinkReq( uint8 taskID, uint16 connectionHandle, uint8 reason );
1678 
1695 
1722 
1728  extern uint8 GAP_NumActiveConnections( void );
1729 
1756  GAP_CB_Action_t action,
1757  uint16_t connHandle);
1758 
1759 
1760 
1761 /*-------------------------------------------------------------------
1762  * FUNCTIONS - Pairing
1763  */
1764 
1792  extern bStatus_t GAP_Authenticate( gapAuthParams_t *pParams, gapPairingReq_t *pPairReq );
1793 
1800  extern uint8 GAP_isPairing(void);
1801 
1819  extern bStatus_t GAP_TerminateAuth( uint16 connectionHandle, uint8 reason );
1820 
1840  extern bStatus_t GAP_PasskeyUpdate( uint8 *pPasskey, uint16 connectionHandle );
1841 
1860  extern bStatus_t GAP_PasscodeUpdate( uint32 passcode, uint16 connectionHandle );
1861 
1876  extern bStatus_t GAP_SendSlaveSecurityRequest( uint16 connectionHandle, uint8 authReq );
1877 
1894  extern bStatus_t GAP_Signable( uint16 connectionHandle, uint8 authenticated, smSigningInfo_t *pParams );
1895 
1917  extern bStatus_t GAP_Bond( uint16 connectionHandle, uint8 authenticated,
1918  uint8 secureConnections, smSecurityInfo_t *pParams,
1919  uint8 startEncryption );
1920 
1921 /*-------------------------------------------------------------------
1922  * Internal API - These functions are only called from gap.c module.
1923  */
1924 
1926 
1937  extern bStatus_t GAP_ParamsInit( uint8 taskID, uint8 profileRole );
1938 
1946  extern void GAP_PrivacyInit( uint8 *pIRK );
1947 
1955  extern uint8 *GAP_GetIRK( void );
1956 
1969  extern void GAP_SecParamsInit( uint8 *pSRK, uint32 *pSignCounter );
1970 
1978  extern bStatus_t GAP_PeriDevMgrInit( void );
1979 
1986  extern void GAP_PeriConnRegister( void );
1987 
1999  extern bStatus_t GAP_CentDevMgrInit( uint8 maxScanResponses );
2000 
2007  extern void GAP_CentConnRegister( void );
2008 
2009 
2010 /*-------------------------------------------------------------------
2011  * TASK API - These functions must only be called OSAL.
2012  */
2013 
2021  extern void GAP_Init( uint8 task_id );
2022 
2033  extern uint16 GAP_ProcessEvent( uint8 task_id, uint16 events );
2034 
2036 
2037 /*-------------------------------------------------------------------
2038 -------------------------------------------------------------------*/
2039 
2040 #ifdef __cplusplus
2041 }
2042 #endif
2043 
2044 #endif /* GAP_H */
2045 
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:1046
uint8 authState
TRUE if the pairing was authenticated (MITM)
Definition: gap.h:1192
uint8 opcode
GAP_MAKE_DISCOVERABLE_DONE_EVENT
Definition: gap.h:1023
uint8 opcode
GAP_END_DISCOVERABLE_DONE_EVENT
Definition: gap.h:1035
bStatus_t GAP_SetAdvToken(gapAdvDataToken_t *pToken)
Set Advertising Token.
uint8 opcode
GAP_SIGNATURE_UPDATED_EVENT
Definition: gap.h:930
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:929
uint8 eventType
Advertise Event Type: GAP Advertising Event Types.
Definition: gap.h:1002
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:1243
uint8 attrLen
Number of bytes in the attribute data.
Definition: gap.h:1313
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:869
void(* pfnGapConnEvtCB_t)(Gap_ConnEventRpt_t *pReport)
Definition: gap.h:1354
uint8 authReq
Authentication Requirements: Bit 2: MITM, Bits 0-1: bonding (0 - no bonding, 1 - bonding) ...
Definition: gap.h:1230
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:1193
bStatus_t GAP_TerminateAuth(uint16 connectionHandle, uint8 reason)
Terminate Authnetication.
Authentication Parameters.
Definition: gap.h:1207
bStatus_t GAP_PasskeyUpdate(uint8 *pPasskey, uint16 connectionHandle)
Update the passkey in string format.
GAP_MAKE_DISCOVERABLE_DONE_EVENT message format.
Definition: gap.h:1020
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1226
uint8 mode
Discovery Mode: GAP Device Discovery Modes.
Definition: gap.h:965
bStatus_t GAP_EstablishLinkReq(gapEstLinkReq_t *pParams)
Establish a link to a slave device.
Connection event in slave role.
Definition: gap.h:814
uint8 adType
ADTYPE value: Address Types.
Definition: gap.h:1312
smSigningInfo_t * pSigningInfo
Signing information.
Definition: gap.h:1194
uint8 addrType
Device's address type for devAddr.
Definition: gap.h:931
uint16_t handle
connection handle
Definition: gap.h:1288
uint16 connectionHandle
Connection Handle.
Definition: gap.h:1228
GAP_ConnEvtTaskType_t
Definition: gap.h:807
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:910
uint16 latency
Definition: gap.h:891
uint8 dataLen
Length (in bytes) of the data field (evtData)
Definition: gap.h:951
uint16 gapParamIDs_t
GAP Parameters IDs.
Definition: gap.h:848
uint8 adType
TRUE if advertising data, FALSE if SCAN_RSP.
Definition: gap.h:1048
GAP_PASSKEY_NEEDED_EVENT message format.
Definition: gap.h:1170
GAP_CB_Action_t
Definition: gap.h:826
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:853
Connection parameters for the peripheral device.
Definition: gap.h:884
GAP_DEVICE_INIT_DONE_EVENT message format.
Definition: gap.h:908
Definition: gap.h:1285
uint8 taskID
Requesting App's Task ID, used to return results.
Definition: gap.h:964
GAP_SLAVE_REQUESTED_SECURITY_EVENT message format.
Definition: gap.h:1224
Register a callback.
Definition: gap.h:828
Connection event occurred successfully.
Definition: gap.h:797
GAP_ConnEvtStat_t status
status of connection event
Definition: gap.h:1287
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1022
bStatus_t GAP_TerminateLinkReq(uint8 taskID, uint16 connectionHandle, uint8 reason)
Terminate a link connection.
GAP event header format.
Definition: gap.h:851
GAP_BOND_COMPLETE_EVENT message format.
Definition: gap.h:1239
uint8 eventType
Indicates advertising event type used by the advertiser: GAP Advertising Report Event Types...
Definition: gap.h:973
GAP_ConnEvtTaskType_t nextTaskType
Type of next BLE task.
Definition: gap.h:1296
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:1209
GAP_PAIRING_REQ_EVENT message format.
Definition: gap.h:1274
uint8 addrType
Address Type: Address Types.
Definition: gap.h:974
int8_t lastRssi
Definition: gap.h:1290
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1241
uint8 uiInputs
Pairing User Interface Inputs - Ask user to input passcode.
Definition: gap.h:1176
uint8 numDevs
Number of devices found during scan.
Definition: gap.h:993
GAP_ConnEvtStat_t
Definition: gap.h:794
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1172
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:854
keyDist_t keyDist
Pairing Request Key Distribution field.
Definition: gap.h:1255
uint8_t channel
BLE RF channel index (0-39)
Definition: gap.h:1289
uint8(* pfnSuppEnhPrivCB_t)(uint8 *deviceAddr)
Enhanced Privacy Check Callback Function.
Definition: gap.h:1325
uint8 maxEncKeySize
Pairing Request Maximum Encryption Key Size field.
Definition: gap.h:1254
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:945
GAP_SIGNATURE_UPDATED_EVENT message format.
Definition: gap.h:927
uint8 numDataPkts
HC_Total_Num_LE_Data_Packets.
Definition: gap.h:914
uint8 opcode
GAP_PAIRING_REQ_EVENT
Definition: gap.h:1277
uint8 opcode
GAP_SLAVE_REQUESTED_SECURITY_EVENT
Definition: gap.h:1227
Definition: sm.h:144
uint8 opcode
GAP_DEVICE_INFO_EVENT
Definition: gap.h:946
uint8 initiatorAddrType
Initiator's address type: Address Types.
Definition: gap.h:1003
uint8 opcode
GAP_ADV_DATA_UPDATE_DONE_EVENT
Definition: gap.h:1047
uint16 intervalMax
Definition: gap.h:889
Type of device discovery (Scan) to perform.
Definition: gap.h:971
uint16 GAP_GetParamValue(gapParamIDs_t paramID)
Get a GAP Parameter value.
uint8 opcode
GAP_DEVICE_INIT_DONE_EVENT
Definition: gap.h:911
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:1196
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:943
uint8 uiOutputs
Pairing User Interface Outputs - Display passcode.
Definition: gap.h:1177
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:1191
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1034
uint8 opcode
GAP_DEVICE_DISCOVERY_EVENT
Definition: gap.h:992
GAP_ADV_DATA_UPDATE_DONE_EVENT message format.
Definition: gap.h:1044
uint16 connectionHandle
connection Handle
Definition: gap.h:1278
bStatus_t GAP_RegisterConnEventCb(pfnGapConnEvtCB_t cb, GAP_CB_Action_t action, uint16_t connHandle)
uint32 signCounter
new Signed Counter
Definition: gap.h:933
smLinkSecurityReq_t secReqs
Pairing Control info.
Definition: gap.h:1210
uint8 addrType
address type: Address Types
Definition: gap.h:948
uint16 timeout
Definition: gap.h:893
bStatus_t GAP_UpdateAdvTokens(void)
Update Advertising Token.
gapAdvDataToken_t * GAP_GetAdvToken(uint8 adType)
Get Advertising Token.
uint16 intervalMin
Definition: gap.h:887
uint8 oobDataFlag
Pairing Request OOB Data Flag field.
Definition: gap.h:1252
uint16_t errors
Total number of CRC errors for the entire connection.
Definition: gap.h:1294
int8 rssi
Advertisement or SCAN_RSP RSSI.
Definition: gap.h:950
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:991
Type of device discovery (Scan) to perform.
Definition: gap.h:962
uint8 opcode
GAP_AUTHENTICATION_COMPLETE_EVENT
Definition: gap.h:1190
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1189
Type definitions and macros for BLE stack.
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap.h:1276
No data was received during connection event.
Definition: gap.h:801
smSecurityInfo_t * pDevSecInfo
BOUND - security information from connected device.
Definition: gap.h:1195
Initiating a connection.
Definition: gap.h:812
void(* pfnGapIdleCB_t)()
GAP Idle Callback Function.
Definition: gap.h:1330
Definition: sm.h:211
uint8 channelMap
Channel Map: Bit mask GAP Advertisement Channel Map.
Definition: gap.h:1005
uint8 addrMode
Address mode: GAP Addressing Modes.
Definition: gap.h:871
uint8 filterPolicy
Filer Policy: GAP Advertiser Filter Scan Parameters. Ignored when directed advertising is used...
Definition: gap.h:1006
GAP_END_DISCOVERABLE_DONE_EVENT message format.
Definition: gap.h:1032
uint8 opcode
GAP_PASSKEY_NEEDED_EVENT
Definition: gap.h:1173
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:799
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:1335
Advertiser.
Definition: gap.h:810
uint8 opcode
GAP_RANDOM_ADDR_CHANGED_EVENT
Definition: gap.h:870
#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:947
uint8 ioCap
Pairing Request ioCap field.
Definition: gap.h:1251
GAP_AUTHENTICATION_COMPLETE_EVENT message format.
Definition: gap.h:1187
Callback Registration Structure.
Definition: gap.h:1333
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:1298
uint8 opcode
GAP_BOND_COMPLETE_EVENT
Definition: gap.h:1242
uint8 * pAttrData
pointer to Attribute data
Definition: gap.h:1314
pfnGapIdleCB_t gapIdleCB
GAP Idle callback.
Definition: gap.h:1336
Status_t bStatus_t
BLE Generic Status return.
Definition: bcomdef.h:233
GAP_DEVICE_DISCOVERY_EVENT message format.
Definition: gap.h:989
GAP_RANDOM_ADDR_CHANGED_EVENT message format.
Definition: gap.h:867
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:966
Pairing Request fields - the parsed fields of the SMP Pairing Request command.
Definition: gap.h:1249
uint8 * pEvtData
Data field of advertisement or SCAN_RSP.
Definition: gap.h:952
Advertising Parameters.
Definition: gap.h:1000
Connection event in master role.
Definition: gap.h:818
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:913
uint32 numComparison
Numeric Comparison value to be displayed.
Definition: gap.h:1178
gapPairingReq_t pairReq
The Pairing Request fields received.
Definition: gap.h:1279
Scanner.
Definition: gap.h:816
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:967
uint16 connectionHandle
Connection handle.
Definition: gap.h:1175
GAP Advertisement/Scan Response Data Token.
Definition: gap.h:1310
Unregister a callback
Definition: gap.h:829
gapAdvDataToken_t * GAP_RemoveAdvToken(uint8 adType)
Remove Advertising Token.
uint8 authReq
Pairing Request Auth Req field.
Definition: gap.h:1253
gapDevRec_t * pDevList
array of device records
Definition: gap.h:994
bStatus_t GAP_SetParamValue(gapParamIDs_t paramID, uint16 paramValue)
Set a GAP Parameter value.
© Copyright 1995-2019, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale