TI BLE Stack API Documentation  2.03.09
central.h
1 /******************************************************************************
2 
3  @file central.h
4 
5  @brief TI BLE GAP Central Role for for RTOS Applications
6 
7  This GAP profile discovers and initiates connections.
8 
9  Group: WCS, BTS
10  $Target Device: DEVICES $
11 
12  ******************************************************************************
13  $License: BSD3 2011 $
14  ******************************************************************************
15  $Release Name: PACKAGE NAME $
16  $Release Date: PACKAGE RELEASE DATE $
17  *****************************************************************************/
18 
19 #ifndef CENTRAL_H
20 #define CENTRAL_H
21 
22 #ifdef __cplusplus
23 extern "C"
24 {
25 #endif
26 
27 /*********************************************************************
28  * INCLUDES
29  */
30 #include "bcomdef.h"
31 #include "osal.h"
32 #include "gap.h"
33 
34 /*********************************************************************
35  * CONSTANTS
36  */
37 
41 #define GAPCENTRALROLE_IRK 0x400
42 #define GAPCENTRALROLE_SRK 0x401
43 #define GAPCENTRALROLE_SIGNCOUNTER 0x402
44 #define GAPCENTRALROLE_BD_ADDR 0x403
45 #define GAPCENTRALROLE_MAX_SCAN_RES 0x404
46 #define GAPCENTRALROLE_LINK_PARAM_UPDATE_REQ_REPLY 0x405
47 
53 #define GAPCENTRALROLE_PARAM_UPDATE_REQ_AUTO_REJECT 0x00
54 #define GAPCENTRALROLE_PARAM_UPDATE_REQ_AUTO_ACCEPT 0x01
55 #define GAPCENTRALROLE_PARAM_UPDATE_REQ_SEND_TO_APP 0x02
56 
58 /*********************************************************************
59  * VARIABLES
60  */
61 
62 /*********************************************************************
63  * MACROS
64  */
65 
66 /*********************************************************************
67  * TYPEDEFS
68  */
69 
73 typedef union
74 {
84 
90 typedef uint8_t (*pfnGapCentralRoleEventCB_t)
91 (
92  gapCentralRoleEvent_t *pEvent
93 );
94 
99 typedef struct
100 {
101  pfnGapCentralRoleEventCB_t eventCB;
103 
104 /*********************************************************************
105  * VARIABLES
106  */
107 
108 /*********************************************************************
109  * API FUNCTIONS
110  */
111 
112 /*-------------------------------------------------------------------
113  * Central Profile Public APIs
114  */
115 
132 
145 extern bStatus_t GAPCentralRole_SetParameter(uint16_t param, uint8_t len, void *pValue);
146 
156 extern bStatus_t GAPCentralRole_GetParameter(uint16_t param, void *pValue);
157 
167 extern bStatus_t GAPCentralRole_TerminateLink(uint16_t connHandle);
168 
183 extern bStatus_t GAPCentralRole_EstablishLink(uint8_t highDutyCycle, uint8_t whiteList,
184  uint8_t addrTypePeer, uint8_t *peerAddr);
185 
198 extern bStatus_t GAPCentralRole_UpdateLink(uint16_t connHandle, uint16_t connIntervalMin,
199  uint16_t connIntervalMax, uint16_t connLatency,
200  uint16_t connTimeout);
212 extern bStatus_t GAPCentralRole_StartDiscovery(uint8_t mode, uint8_t activeScan, uint8_t whiteList);
213 
222 
227 /*-------------------------------------------------------------------
228  * TASK FUNCTIONS - Don't call these. These are system functions.
229  */
230 
238 extern void GAPCentralRole_createTask(void);
239 
240 /*********************************************************************
241 *********************************************************************/
242 
243 #ifdef __cplusplus
244 }
245 #endif
246 
247 #endif /* CENTRAL_H */
Definition: central.h:99
bStatus_t GAPCentralRole_StartDevice(gapCentralRoleCB_t *pAppCallbacks)
Start the device in Central role. This function is typically called once during system startup...
gapDeviceInitDoneEvent_t initDone
GAP initialization done.
Definition: central.h:76
bStatus_t GAPCentralRole_EstablishLink(uint8_t highDutyCycle, uint8_t whiteList, uint8_t addrTypePeer, uint8_t *peerAddr)
Establish a link to a peer device.
pfnGapCentralRoleEventCB_t eventCB
Event callback.
Definition: central.h:101
gapEventHdr_t gap
GAP_MSG_EVENT and status.
Definition: central.h:75
Definition: gap.h:405
bStatus_t GAPCentralRole_StartDiscovery(uint8_t mode, uint8_t activeScan, uint8_t whiteList)
Start a device discovery scan.
bStatus_t GAPCentralRole_CancelDiscovery(void)
Cancel a device discovery scan.
Definition: gap.h:517
gapTerminateLinkEvent_t linkTerminate
Link terminated event structure.
Definition: central.h:82
gapUpdateLinkParamReqEvent_t linkUpdateReply
Link update request reply structure.
Definition: central.h:81
bStatus_t GAPCentralRole_UpdateLink(uint16_t connHandle, uint16_t connIntervalMin, uint16_t connIntervalMax, uint16_t connLatency, uint16_t connTimeout)
Update the link connection parameters.
Status_t bStatus_t
BLE Generic Status return: BLE Default BLE Status Values.
Definition: bcomdef.h:244
Definition: gap.h:661
gapEstLinkReqEvent_t linkCmpl
Link complete event structure.
Definition: central.h:79
Definition: central.h:73
gapLinkUpdateEvent_t linkUpdate
Link update event structure.
Definition: central.h:80
gapDeviceInfoEvent_t deviceInfo
Discovery device information event structure.
Definition: central.h:77
gapDevDiscEvent_t discCmpl
Discovery complete event structure.
Definition: central.h:78
bStatus_t GAPCentralRole_SetParameter(uint16_t param, uint8_t len, void *pValue)
Set a parameter in the Central Profile.
bStatus_t GAPCentralRole_TerminateLink(uint16_t connHandle)
Terminate a link.
bStatus_t GAPCentralRole_GetParameter(uint16_t param, void *pValue)
Get a parameter in the Central Profile.
Definition: gap.h:614
Definition: gap.h:476
Definition: gap.h:445
Definition: gap.h:646
Definition: gap.h:628