TI BLE5-Stack API Documentation  2.02.00.00
bcomdef.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 
18 #ifndef BCOMDEF_H
19 #define BCOMDEF_H
20 
21 #ifdef __cplusplus
22 extern "C"
23 {
24 #endif
25 
26 
27 /*********************************************************************
28  * INCLUDES
29  */
30 
31 #include "comdef.h"
32 
33 /*********************************************************************
34  * CONSTANTS
35  */
36 
38 #if defined ( HOST_CONFIG )
39  // Set the Controller Configuration
40  #if ( HOST_CONFIG == ( CENTRAL_CFG | PERIPHERAL_CFG ) )
41  #define CTRL_CONFIG ( ADV_NCONN_CFG | ADV_CONN_CFG | SCAN_CFG | INIT_CFG )
42  #elif ( HOST_CONFIG == ( CENTRAL_CFG | BROADCASTER_CFG ) )
43  #define CTRL_CONFIG ( ADV_NCONN_CFG | SCAN_CFG | INIT_CFG )
44  #elif ( HOST_CONFIG == ( PERIPHERAL_CFG | OBSERVER_CFG ) )
45  #define CTRL_CONFIG ( ADV_NCONN_CFG | ADV_CONN_CFG | SCAN_CFG )
46  #elif ( HOST_CONFIG == ( BROADCASTER_CFG | OBSERVER_CFG ) )
47  #define CTRL_CONFIG ( ADV_NCONN_CFG | SCAN_CFG )
48  #elif ( HOST_CONFIG == CENTRAL_CFG )
49  #define CTRL_CONFIG ( SCAN_CFG | INIT_CFG )
50  #elif ( HOST_CONFIG == PERIPHERAL_CFG )
51  #define CTRL_CONFIG ( ADV_NCONN_CFG | ADV_CONN_CFG )
52  #elif ( HOST_CONFIG == OBSERVER_CFG )
53  #define CTRL_CONFIG SCAN_CFG
54  #elif ( HOST_CONFIG == BROADCASTER_CFG )
55  #define CTRL_CONFIG ADV_NCONN_CFG
56  #else
57  #if defined ( FLASH_ONLY_BUILD ) || defined ( FLASH_ROM_BUILD )
58  #error "Build Configuration Error: Invalid Host Role!"
59  #endif
60  #endif
61 #else
62  // Controller Sanity Check: Stop build when no configuration is defined.
63  #if !defined( CTRL_CONFIG ) || !( CTRL_CONFIG & ( ADV_NCONN_CFG | \
64  ADV_CONN_CFG | \
65  SCAN_CFG | \
66  INIT_CFG ) )
67  #if defined ( FLASH_ONLY_BUILD ) || defined ( FLASH_ROM_BUILD )
68  #error "Build Configuration Error: At least one Controller build component required!"
69  #endif
70  #endif // no Controller build components defined
71 #endif
72 
73 // If BLE_V41_FEATURES is defined, map it to CTRL_V41_CONFIG
74 #if defined ( BLE_V41_FEATURES ) && !defined ( CTRL_V41_CONFIG )
75  #define CTRL_V41_CONFIG ( ( BLE_V41_FEATURES ) & CTRL_V41_MASK )
76 #elif defined ( BLE_V41_FEATURES ) && defined ( CTRL_V41_CONFIG )
77  #error "Build Configuration Error: Cannot define both BLE_V41_FEATURES and CTRL_V41_CONFIG!"
78 #endif // BLE_V41_FEATURES
79 
80 // If BLE_V50_FEATURES is defined, map it to CTRL_V50_CONFIG
81 #if defined ( BLE_V50_FEATURES ) && !defined ( CTRL_V50_CONFIG )
82  #define CTRL_V50_CONFIG BLE_V50_FEATURES
83 #elif defined ( BLE_V50_FEATURES ) && defined ( CTRL_V50_CONFIG )
84  #error "Build Configuration Error: Cannot define both BLE_V50_FEATURES and CTRL_V50_CONFIG!"
85 #endif // BLE_V41_FEATURES
86 
87 // If L2CAP Connection Oriented Channels are not configured and GATT_QUAL is not defined
88 // then do not configure GATT Service Changed characteristic
89 #if (!defined ( BLE_V41_FEATURES ) || !( BLE_V41_FEATURES & L2CAP_COC_CFG )) && !defined(GATT_QUAL)
90  #define GATT_NO_SERVICE_CHANGED
91 #endif // ! BLE_41_FEATURES || ! L2CAP_COC_CFG
92 
93 #if defined(CC2540) || defined(CC2541) || defined(CC2541S)
94  #if !defined ( MAX_NUM_BLE_CONNS )
95  #if ( CTRL_CONFIG & INIT_CFG )
96  #define MAX_NUM_BLE_CONNS 3
97  #elif ( !( CTRL_CONFIG & INIT_CFG ) && ( CTRL_CONFIG & ADV_CONN_CFG ) )
98  #define MAX_NUM_BLE_CONNS 1
99  #else // no connection needed
100  #define MAX_NUM_BLE_CONNS 0
101  #endif // CTRL_CONFIG=INIT_CFG
102  #endif // !MAX_NUM_BLE_CONNS
103 #endif // CC2540 | CC2541 | CC2541S
104 
106 
108 #define B_ADDR_LEN 6
109 
111 #define KEYLEN 16
112 
115 #define LSB_2_BYTES 2
116 
118 #define MSB_4_BYTES 4
119 
121 #define B_CHANNEL_MAP_LEN 5
122 
124 #define B_EVENT_MASK_LEN 8
125 
127 #define B_LOCAL_NAME_LEN 248
128 
130 #define B_MAX_ADV_LEN 31
131 
133 #define B_RANDOM_NUM_SIZE 8
134 
136 #define B_FEATURE_SUPPORT_LENGTH 8
137 
139 #define B_APP_DEFAULT_PASSCODE 123456
140 
142 #define EXTENDED_STACK_SETTINGS_DEFAULT 0x00
143 
145 #define MASTER_GUARD_TIME_ENABLE 0x01
146 #define CC2652RB_OVERRIDE_USED 0x02
147 
148 #define bleInvalidTaskID INVALID_TASK
149 #define bleNotReady 0x10
150 #define bleAlreadyInRequestedMode 0x11
151 #define bleIncorrectMode 0x12
152 #define bleMemAllocError 0x13
153 #define bleNotConnected 0x14
154 #define bleNoResources 0x15
155 #define blePending 0x16
156 #define bleTimeout 0x17
157 #define bleInvalidRange 0x18
158 #define bleLinkEncrypted 0x19
159 #define bleProcedureComplete 0x1A
160 #define bleInvalidMtuSize 0x1B
161 #define blePairingTimedOut 0x1C
162 #define bleMemFreeError 0x1D
163 #define bleInternalError 0x1E
164 
165 // GAP Status Return Values - returned as bStatus_t
166 #define bleGAPUserCanceled 0x30
167 #define bleGAPConnNotAcceptable 0x31
168 #define bleGAPBondRejected 0x32
169 #define bleGAPBufferInUse 0x33
170 #define bleGAPNotFound 0x34
171 #define bleGAPFilteredOut 0x35
172 
173 // ATT Status Return Values - returned as bStatus_t
174 #define bleInvalidPDU 0x40
175 #define bleInsufficientAuthen 0x41
176 #define bleInsufficientEncrypt 0x42
177 #define bleInsufficientKeySize 0x43
178 
179 // L2CAP Status Return Values - returned as bStatus_t
180 
181 #define INVALID_TASK_ID 0xFF
182 
183 // Note: Maximum NVID index is 0x03FF (10 bits) - this is a NV driver limitation
184 
185 // Device NV Items - Range 0 - 0x1F
186 #define BLE_NVID_IRK 0x02
187 #define BLE_NVID_CSRK 0x03
188 #define BLE_NVID_ADDR_MODE 0x04
189 #define BLE_LRU_BOND_LIST 0x05
190 #define BLE_NVID_RANDOM_ADDR 0x06
191 
192 // Bonding NV Items - Range 0x20 - 0xDF - This allows for 32 bonds
193 #define BLE_NVID_GAP_BOND_START 0x20
194 #define BLE_NVID_GAP_BOND_END 0xDF
195 
196 // GATT Configuration NV Items - Range 0xE0 - 0xFF - This must match the number of Bonding entries
197 #define BLE_NVID_GATT_CFG_START 0xE0
198 #define BLE_NVID_GATT_CFG_END 0xFF
199 
200 // Customer NV Items - Range 0x100 - 0x11F - This must match the number of Bonding entries
201 #define BLE_NVID_CUST_START 0x100
202 #define BLE_NVID_CUST_END 0x11F
203 
204 // BLE Mesh NV IDs Start
205 #define BLE_NVID_MESH_START BLE_NVID_CUST_END + 1
206 
207 /*********************************************************************
208  * BLE OSAL GAP GLOBAL Events
209  */
210 #define GAP_EVENT_SIGN_COUNTER_CHANGED 0x4000
211 
212 // GAP - Messages IDs (0xD0 - 0xDF)
213 #define GAP_MSG_EVENT 0xD0
214 
215 // SM - Messages IDs (0xC1 - 0xCF)
216 #define SM_NEW_RAND_KEY_EVENT 0xC1
217 #define SM_MSG_EVENT 0xC2
218 
219 // GATT - Messages IDs (0xB0 - 0xBF)
220 #define GATT_MSG_EVENT 0xB0
221 #define GATT_SERV_MSG_EVENT 0xB1
222 
223 // L2CAP - Messages IDs (0xA0 - 0xAF)
224 #define L2CAP_DATA_EVENT 0xA0
225 #define L2CAP_SIGNAL_EVENT 0xA2
226 
227 // HCI - Messages IDs (0x90 - 0x9F)
228 #define HCI_DATA_EVENT 0x90
229 #define HCI_GAP_EVENT_EVENT 0x91
230 #define HCI_SMP_EVENT_EVENT 0x92
231 #define HCI_EXT_CMD_EVENT 0x93
232 #define HCI_SMP_META_EVENT_EVENT 0x94
233 #define HCI_GAP_META_EVENT_EVENT 0x95
234 
235 // ICall and Dispatch - Messages IDs (0x80 - 0x8F)
236 #define ICALL_EVENT_EVENT 0x80
237 #define ICALL_CMD_EVENT 0x81
238 #define DISPATCH_CMD_EVENT 0x82
239 
240 #ifdef __TI_COMPILER_VERSION__
241 #define PRAGMA_OPTIMIZE_NONE
242 #elif defined(__IAR_SYSTEMS_ICC__)
243 #define PRAGMA_OPTIMIZE_NONE _Pragma("optimize=none")
244 #endif
245 
246 /*********************************************************************
247  * TYPEDEFS
248  */
249 
251 typedef Status_t bStatus_t;
252 
253 
254 /*********************************************************************
255  * System Events
256  */
257 
258 /*********************************************************************
259  * Global System Messages
260  */
261 
262 /*********************************************************************
263  * MACROS
264  */
265 
267 #define TI_BASE_UUID_128( uuid ) 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xB0, \
268  0x00, 0x40, 0x51, 0x04, LO_UINT16( uuid ), HI_UINT16( uuid ), 0x00, 0xF0
269 
270 /*********************************************************************
271  * GLOBAL VARIABLES
272  */
273 
274 /*********************************************************************
275  * FUNCTIONS
276  */
277 
278 /*********************************************************************
279 *********************************************************************/
280 
281 #ifdef __cplusplus
282 }
283 #endif
284 
285 #endif /* BCOMDEF_H */
Common Defines.
Status_t bStatus_t
BLE Generic Status return.
Definition: bcomdef.h:251
© Copyright 1995-2021, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale