TI BLE5-Stack API Documentation  2.02.05.00
gap_initiator.h
Go to the documentation of this file.
1 /******************************************************************************
2 
3  Group: WCS, BTS
4  $Target Device: DEVICES $
5 
6  ******************************************************************************
7  $License: TI_TEXT 2009 $
8  ******************************************************************************
9  $Release Name: PACKAGE NAME $
10  $Release Date: PACKAGE RELEASE DATE $
11  *****************************************************************************/
12 
21 #ifndef GAP_INITIATOR_H
22 #define GAP_INITIATOR_H
23 
24 #ifdef __cplusplus
25 extern "C"
26 {
27 #endif
28 
29 /*-------------------------------------------------------------------
30  * INCLUDES
31  */
32 #include "bcomdef.h"
33 #include "osal.h"
34 #include "gap.h"
35 
36 /*-------------------------------------------------------------------
37  * CONSTANTS
38  */
39 
49 {
50  INIT_PHY_1M = LL_PHY_1_MBPS,
51  INIT_PHY_2M = LL_PHY_2_MBPS,
52  INIT_PHY_CODED = LL_PHY_CODED
53 };
54 
59 #define INIT_PHYPARAM_DFLT_SCAN_INTERVAL 16
60 #define INIT_PHYPARAM_DFLT_SCAN_WINDOW 16
61 #define INIT_PHYPARAM_DFLT_CONN_INT_MIN 80
62 #define INIT_PHYPARAM_DFLT_CONN_INT_MAX 80
63 #define INIT_PHYPARAM_DFLT_CONN_LATENCY 0
64 #define INIT_PHYPARAM_DFLT_SUP_TIMEOUT 2000
65 // TODO: currently minimum/maximum CE lengths are ignored
66 #define INIT_PHYPARAM_DFLT_MIN_CE_LEN 0
67 #define INIT_PHYPARAM_DFLT_MAX_CE_LEN 0xFFFF
68 
86 typedef enum
87 {
96 
105 
116 
127 
136 
145 
156 
169 
171  INIT_NUM_PHYPARAM,
176 /*-------------------------------------------------------------------
177  * Structures
178  */
179 
193 typedef struct
194 {
196  uint8 opcode;
198 
201 /*-------------------------------------------------------------------
202  * API's
203  */
204 
219 status_t GapInit_setPhyParam(uint8_t phys, GapInit_PhyParamId_t paramId,
220  uint16_t value);
221 
235 status_t GapInit_getPhyParam(uint8_t phy, GapInit_PhyParamId_t paramId,
236  uint16_t* pValue);
237 
256 status_t GapInit_connect(GAP_Peer_Addr_Types_t peerAddrType,
257  uint8_t* pPeerAddress, uint8_t phys, uint16_t timeout);
258 
273 status_t GapInit_connectWl(uint8_t phys, uint16_t timeout);
274 
282 status_t GapInit_cancelConnect(void);
283 
285 
286 /*-------------------------------------------------------------------
287 -------------------------------------------------------------------*/
288 
289 #ifdef __cplusplus
290 }
291 #endif
292 
293 #endif /* GAP_INITIATOR_H */
294 
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
status_t GapInit_connect(GAP_Peer_Addr_Types_t peerAddrType, uint8_t *pPeerAddress, uint8_t phys, uint16_t timeout)
Definition: gap_initiator.h:193
Definition: gap_initiator.h:135
uint8 opcode
GAP_CONNECTING_CANCELLED_EVENT
Definition: gap_initiator.h:196
Definition: gap_initiator.h:115
Coded PHY. Bit 2.
Definition: gap_initiator.h:52
GapInit_PhyParamId_t
Definition: gap_initiator.h:86
GapInit_InitPhy_t
GAP Initiator Initiating PHYs.
Definition: gap_initiator.h:48
Definition: gap_initiator.h:155
status_t GapInit_getPhyParam(uint8_t phy, GapInit_PhyParamId_t paramId, uint16_t *pValue)
Type definitions and macros for BLE stack.
status_t GapInit_connectWl(uint8_t phys, uint16_t timeout)
Definition: gap_initiator.h:104
Definition: gap_initiator.h:95
GAP layer interface.
OSAL Event Header.
Definition: osal.h:92
Definition: gap_initiator.h:144
status_t GapInit_setPhyParam(uint8_t phys, GapInit_PhyParamId_t paramId, uint16_t value)
2Mbps PHY. Bit 1
Definition: gap_initiator.h:51
Definition: gap_initiator.h:126
osal_event_hdr_t hdr
GAP_MSG_EVENT and status
Definition: gap_initiator.h:195
status_t GapInit_cancelConnect(void)
1Mbps PHY. Bit 0
Definition: gap_initiator.h:50
Definition: gap_initiator.h:168
© Copyright 1995-2022, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale