1 /******************************************************************************
2 *
3 * Copyright (C) 1999-2012 Broadcom Corporation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 ******************************************************************************/
18
19 #ifndef BT_TYPES_H
20 #define BT_TYPES_H
21
22 #include <stdint.h>
23 #include <stdbool.h>
24 #include "bt_common.h"
25 #include "osi/semaphore.h"
26
27 typedef uint8_t UINT8;
28 typedef uint16_t UINT16;
29 typedef uint32_t UINT32;
30 typedef uint64_t UINT64;
31
32 typedef int8_t INT8;
33 typedef int16_t INT16;
34 typedef int32_t INT32;
35 typedef bool BOOLEAN;
36
37 #define PACKED __packed
38 // #define INLINE __inline
39
40 #define BCM_STRCPY_S(x1,x2) strcpy((x1),(x2))
41 #define BCM_STRNCPY_S(x1,x2,x3) strncpy((x1),(x2),(x3))
42
43 /* READ WELL !!
44 **
45 ** This section defines global events. These are events that cross layers.
46 ** Any event that passes between layers MUST be one of these events. Tasks
47 ** can use their own events internally, but a FUNDAMENTAL design issue is
48 ** that global events MUST be one of these events defined below.
49 **
50 ** The convention used is the the event name contains the layer that the
51 ** event is going to.
52 */
53 #define BT_EVT_MASK 0xFF00
54 #define BT_SUB_EVT_MASK 0x00FF
55 #define BT_STATIC_RAND_ADDR_MASK 0xC0
56 #define BT_NON_RPA_MASK 0x3F
57 /* To Bluetooth Upper Layers */
58 /************************************/
59 #define BT_EVT_TO_BTU_L2C_EVT 0x0900 /* L2CAP event */
60 #define BT_EVT_TO_BTU_HCI_EVT 0x1000 /* HCI Event */
61 #define BT_EVT_TO_BTU_HCI_BR_EDR_EVT (0x0000 | BT_EVT_TO_BTU_HCI_EVT) /* event from BR/EDR controller */
62 #define BT_EVT_TO_BTU_HCI_AMP1_EVT (0x0001 | BT_EVT_TO_BTU_HCI_EVT) /* event from local AMP 1 controller */
63 #define BT_EVT_TO_BTU_HCI_AMP2_EVT (0x0002 | BT_EVT_TO_BTU_HCI_EVT) /* event from local AMP 2 controller */
64 #define BT_EVT_TO_BTU_HCI_AMP3_EVT (0x0003 | BT_EVT_TO_BTU_HCI_EVT) /* event from local AMP 3 controller */
65
66 #define BT_EVT_TO_BTU_HCI_ACL 0x1100 /* ACL Data from HCI */
67 #define BT_EVT_TO_BTU_HCI_SCO 0x1200 /* SCO Data from HCI */
68 #define BT_EVT_TO_BTU_HCIT_ERR 0x1300 /* HCI Transport Error */
69
70 #define BT_EVT_TO_BTU_SP_EVT 0x1400 /* Serial Port Event */
71 #define BT_EVT_TO_BTU_SP_DATA 0x1500 /* Serial Port Data */
72
73 #define BT_EVT_TO_BTU_HCI_CMD 0x1600 /* HCI command from upper layer */
74
75
76 #define BT_EVT_TO_BTU_L2C_SEG_XMIT 0x1900 /* L2CAP segment(s) transmitted */
77
78 #define BT_EVT_PROXY_INCOMING_MSG 0x1A00 /* BlueStackTester event: incoming message from target */
79
80 #define BT_EVT_BTSIM 0x1B00 /* Insight BTSIM event */
81 #define BT_EVT_BTISE 0x1C00 /* Insight Script Engine event */
82
83 /* To LM */
84 /************************************/
85 #define BT_EVT_TO_LM_HCI_CMD 0x2000 /* HCI Command */
86 #define BT_EVT_TO_LM_HCI_ACL 0x2100 /* HCI ACL Data */
87 #define BT_EVT_TO_LM_HCI_SCO 0x2200 /* HCI SCO Data */
88 #define BT_EVT_TO_LM_HCIT_ERR 0x2300 /* HCI Transport Error */
89 #define BT_EVT_TO_LM_LC_EVT 0x2400 /* LC event */
90 #define BT_EVT_TO_LM_LC_LMP 0x2500 /* LC Received LMP command frame */
91 #define BT_EVT_TO_LM_LC_ACL 0x2600 /* LC Received ACL data */
92 #define BT_EVT_TO_LM_LC_SCO 0x2700 /* LC Received SCO data (not used) */
93 #define BT_EVT_TO_LM_LC_ACL_TX 0x2800 /* LMP data transmit complete */
94 #define BT_EVT_TO_LM_LC_LMPC_TX 0x2900 /* LMP Command transmit complete */
95 #define BT_EVT_TO_LM_LOCAL_ACL_LB 0x2a00 /* Data to be locally loopbacked */
96 #define BT_EVT_TO_LM_HCI_ACL_ACK 0x2b00 /* HCI ACL Data ack (not used) */
97 #define BT_EVT_TO_LM_DIAG 0x2c00 /* LM Diagnostics commands */
98
99
100 #define BT_EVT_TO_BTM_CMDS 0x2f00
101 #define BT_EVT_TO_BTM_PM_MDCHG_EVT (0x0001 | BT_EVT_TO_BTM_CMDS)
102
103 #define BT_EVT_TO_TCS_CMDS 0x3000
104
105 #define BT_EVT_TO_CTP_CMDS 0x3300
106
107 /* ftp events */
108 #define BT_EVT_TO_FTP_SRVR_CMDS 0x3600
109 #define BT_EVT_TO_FTP_CLNT_CMDS 0x3700
110
111 #define BT_EVT_TO_BTU_SAP 0x3800 /* SIM Access Profile events */
112
113 /* opp events */
114 #define BT_EVT_TO_OPP_SRVR_CMDS 0x3900
115 #define BT_EVT_TO_OPP_CLNT_CMDS 0x3a00
116
117 /* gap events */
118 #define BT_EVT_TO_GAP_MSG 0x3b00
119
120 /* for NFC */
121 /************************************/
122 #define BT_EVT_TO_NFC_NCI 0x4000 /* NCI Command, Notification or Data*/
123 #define BT_EVT_TO_NFC_INIT 0x4100 /* Initialization message */
124 #define BT_EVT_TO_NCI_LP 0x4200 /* Low power */
125 #define BT_EVT_TO_NFC_ERR 0x4300 /* Error notification to NFC Task */
126
127 #define BT_EVT_TO_NFCCSIM_NCI 0x4a00 /* events to NFCC simulation (NCI packets) */
128
129 /* HCISU Events */
130
131 #define BT_EVT_HCISU 0x5000
132
133 // btla-specific ++
134 #define BT_EVT_TO_HCISU_RECONFIG_EVT (0x0001 | BT_EVT_HCISU)
135 #define BT_EVT_TO_HCISU_UPDATE_BAUDRATE_EVT (0x0002 | BT_EVT_HCISU)
136 #define BT_EVT_TO_HCISU_LP_ENABLE_EVT (0x0003 | BT_EVT_HCISU)
137 #define BT_EVT_TO_HCISU_LP_DISABLE_EVT (0x0004 | BT_EVT_HCISU)
138 // btla-specific --
139 #define BT_EVT_TO_HCISU_LP_APP_SLEEPING_EVT (0x0005 | BT_EVT_HCISU)
140 #define BT_EVT_TO_HCISU_LP_ALLOW_BT_SLEEP_EVT (0x0006 | BT_EVT_HCISU)
141 #define BT_EVT_TO_HCISU_LP_WAKEUP_HOST_EVT (0x0007 | BT_EVT_HCISU)
142 #define BT_EVT_TO_HCISU_LP_RCV_H4IBSS_EVT (0x0008 | BT_EVT_HCISU)
143 #define BT_EVT_TO_HCISU_H5_RESET_EVT (0x0009 | BT_EVT_HCISU)
144 #define BT_EVT_HCISU_START_QUICK_TIMER (0x000a | BT_EVT_HCISU)
145
146 #define BT_EVT_DATA_TO_AMP_1 0x5100
147 #define BT_EVT_DATA_TO_AMP_15 0x5f00
148
149 /* HSP Events */
150
151 #define BT_EVT_BTU_HSP2 0x6000
152
153 #define BT_EVT_TO_BTU_HSP2_EVT (0x0001 | BT_EVT_BTU_HSP2)
154
155 /* BPP Events */
156 #define BT_EVT_TO_BPP_PR_CMDS 0x6100 /* Printer Events */
157 #define BT_EVT_TO_BPP_SND_CMDS 0x6200 /* BPP Sender Events */
158
159 /* BIP Events */
160 #define BT_EVT_TO_BIP_CMDS 0x6300
161
162 /* HCRP Events */
163
164 #define BT_EVT_BTU_HCRP 0x7000
165
166 #define BT_EVT_TO_BTU_HCRP_EVT (0x0001 | BT_EVT_BTU_HCRP)
167 #define BT_EVT_TO_BTU_HCRPM_EVT (0x0002 | BT_EVT_BTU_HCRP)
168
169
170 #define BT_EVT_BTU_HFP 0x8000
171 #define BT_EVT_TO_BTU_HFP_EVT (0x0001 | BT_EVT_BTU_HFP)
172
173 #define BT_EVT_BTU_IPC_EVT 0x9000
174 #define BT_EVT_BTU_IPC_LOGMSG_EVT (0x0000 | BT_EVT_BTU_IPC_EVT)
175 #define BT_EVT_BTU_IPC_ACL_EVT (0x0001 | BT_EVT_BTU_IPC_EVT)
176 #define BT_EVT_BTU_IPC_BTU_EVT (0x0002 | BT_EVT_BTU_IPC_EVT)
177 #define BT_EVT_BTU_IPC_L2C_EVT (0x0003 | BT_EVT_BTU_IPC_EVT)
178 #define BT_EVT_BTU_IPC_L2C_MSG_EVT (0x0004 | BT_EVT_BTU_IPC_EVT)
179 #define BT_EVT_BTU_IPC_BTM_EVT (0x0005 | BT_EVT_BTU_IPC_EVT)
180 #define BT_EVT_BTU_IPC_AVDT_EVT (0x0006 | BT_EVT_BTU_IPC_EVT)
181 #define BT_EVT_BTU_IPC_SLIP_EVT (0x0007 | BT_EVT_BTU_IPC_EVT)
182 #define BT_EVT_BTU_IPC_MGMT_EVT (0x0008 | BT_EVT_BTU_IPC_EVT)
183 #define BT_EVT_BTU_IPC_BTTRC_EVT (0x0009 | BT_EVT_BTU_IPC_EVT)
184 #define BT_EVT_BTU_IPC_BURST_EVT (0x000A | BT_EVT_BTU_IPC_EVT)
185
186
187 /* BTIF Events */
188 #define BT_EVT_BTIF 0xA000
189 #define BT_EVT_CONTEXT_SWITCH_EVT (0x0001 | BT_EVT_BTIF)
190
191 /* Define the header of each buffer used in the Bluetooth stack.
192 */
193 typedef struct {
194 uint16_t event;
195 uint16_t len;
196 uint16_t offset;
197 uint16_t layer_specific;
198 uint8_t data[];
199 } BT_HDR;
200
201 typedef struct {
202 uint8_t status;
203 uint16_t opcode;
204 osi_sem_t sync_sem;
205 } BlE_SYNC;
206
207
208 #define BT_HDR_SIZE (sizeof (BT_HDR))
209
210 #define BT_PSM_SDP 0x0001
211 #define BT_PSM_RFCOMM 0x0003
212 #define BT_PSM_TCS 0x0005
213 #define BT_PSM_CTP 0x0007
214 #define BT_PSM_BNEP 0x000F
215 #define BT_PSM_HIDC 0x0011
216 #define BT_PSM_HIDI 0x0013
217 #define BT_PSM_UPNP 0x0015
218 #define BT_PSM_AVCTP 0x0017
219 #define BT_PSM_AVDTP 0x0019
220 #define BT_PSM_AVCTP_13 0x001B /* Advanced Control - Browsing */
221 #define BT_PSM_UDI_CP 0x001D /* Unrestricted Digital Information Profile C-Plane */
222 #define BT_PSM_ATT 0x001F /* Attribute Protocol */
223
224
225 /* These macros extract the HCI opcodes from a buffer
226 */
227 #define HCI_GET_CMD_HDR_OPCODE(p) (UINT16)((*((UINT8 *)((p) + 1) + p->offset) + \
228 (*((UINT8 *)((p) + 1) + p->offset + 1) << 8)))
229 #define HCI_GET_CMD_HDR_PARAM_LEN(p) (UINT8) (*((UINT8 *)((p) + 1) + p->offset + 2))
230
231 #define HCI_GET_EVT_HDR_OPCODE(p) (UINT8)(*((UINT8 *)((p) + 1) + p->offset))
232 #define HCI_GET_EVT_HDR_PARAM_LEN(p) (UINT8) (*((UINT8 *)((p) + 1) + p->offset + 1))
233
234
235 /********************************************************************************
236 ** Macros to get and put bytes to and from a stream (Little Endian format).
237 */
238 #define UINT32_TO_STREAM(p, u32) {*(p)++ = (UINT8)(u32); *(p)++ = (UINT8)((u32) >> 8); *(p)++ = (UINT8)((u32) >> 16); *(p)++ = (UINT8)((u32) >> 24);}
239 #define UINT24_TO_STREAM(p, u24) {*(p)++ = (UINT8)(u24); *(p)++ = (UINT8)((u24) >> 8); *(p)++ = (UINT8)((u24) >> 16);}
240 #define UINT16_TO_STREAM(p, u16) {*(p)++ = (UINT8)(u16); *(p)++ = (UINT8)((u16) >> 8);}
241 #define UINT8_TO_STREAM(p, u8) {*(p)++ = (UINT8)(u8);}
242 #define INT8_TO_STREAM(p, u8) {*(p)++ = (INT8)(u8);}
243 #define ARRAY32_TO_STREAM(p, a) {register int ijk; for (ijk = 0; ijk < 32; ijk++) *(p)++ = (UINT8) a[31 - ijk];}
244 #define ARRAY16_TO_STREAM(p, a) {register int ijk; for (ijk = 0; ijk < 16; ijk++) *(p)++ = (UINT8) a[15 - ijk];}
245 #define ARRAY8_TO_STREAM(p, a) {register int ijk; for (ijk = 0; ijk < 8; ijk++) *(p)++ = (UINT8) a[7 - ijk];}
246 #define BDADDR_TO_STREAM(p, a) {register int ijk; for (ijk = 0; ijk < BD_ADDR_LEN; ijk++) *(p)++ = (UINT8) a[BD_ADDR_LEN - 1 - ijk];}
247 #define LAP_TO_STREAM(p, a) {register int ijk; for (ijk = 0; ijk < LAP_LEN; ijk++) *(p)++ = (UINT8) a[LAP_LEN - 1 - ijk];}
248 #define DEVCLASS_TO_STREAM(p, a) {register int ijk; for (ijk = 0; ijk < DEV_CLASS_LEN;ijk++) *(p)++ = (UINT8) a[DEV_CLASS_LEN - 1 - ijk];}
249 #define ARRAY_TO_STREAM(p, a, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) *(p)++ = (UINT8) a[ijk];}
250 #define REVERSE_ARRAY_TO_STREAM(p, a, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) *(p)++ = (UINT8) a[len - 1 - ijk];}
251
252 #define STREAM_TO_UINT8(u8, p) {u8 = (UINT8)(*(p)); (p) += 1;}
253 #define STREAM_TO_UINT16(u16, p) {u16 = ((UINT16)(*(p)) + (((UINT16)(*((p) + 1))) << 8)); (p) += 2;}
254 #define STREAM_TO_UINT24(u32, p) {u32 = (((UINT32)(*(p))) + ((((UINT32)(*((p) + 1)))) << 8) + ((((UINT32)(*((p) + 2)))) << 16) ); (p) += 3;}
255 #define STREAM_TO_UINT32(u32, p) {u32 = (((UINT32)(*(p))) + ((((UINT32)(*((p) + 1)))) << 8) + ((((UINT32)(*((p) + 2)))) << 16) + ((((UINT32)(*((p) + 3)))) << 24)); (p) += 4;}
256 #define STREAM_TO_BDADDR(a, p) {register int ijk; register UINT8 *pbda = (UINT8 *)a + BD_ADDR_LEN - 1; for (ijk = 0; ijk < BD_ADDR_LEN; ijk++) *pbda-- = *p++;}
257 #define STREAM_TO_ARRAY32(a, p) {register int ijk; register UINT8 *_pa = (UINT8 *)a + 31; for (ijk = 0; ijk < 32; ijk++) *_pa-- = *p++;}
258 #define STREAM_TO_ARRAY16(a, p) {register int ijk; register UINT8 *_pa = (UINT8 *)a + 15; for (ijk = 0; ijk < 16; ijk++) *_pa-- = *p++;}
259 #define STREAM_TO_ARRAY8(a, p) {register int ijk; register UINT8 *_pa = (UINT8 *)a + 7; for (ijk = 0; ijk < 8; ijk++) *_pa-- = *p++;}
260 #define STREAM_TO_DEVCLASS(a, p) {register int ijk; register UINT8 *_pa = (UINT8 *)a + DEV_CLASS_LEN - 1; for (ijk = 0; ijk < DEV_CLASS_LEN; ijk++) *_pa-- = *p++;}
261 #define STREAM_TO_LAP(a, p) {register int ijk; register UINT8 *plap = (UINT8 *)a + LAP_LEN - 1; for (ijk = 0; ijk < LAP_LEN; ijk++) *plap-- = *p++;}
262 #define STREAM_TO_ARRAY(a, p, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) ((UINT8 *) a)[ijk] = *p++;}
263 #define REVERSE_STREAM_TO_ARRAY(a, p, len) {register int ijk; register UINT8 *_pa = (UINT8 *)a + len - 1; for (ijk = 0; ijk < len; ijk++) *_pa-- = *p++;}
264
265 #define STREAM_SKIP_UINT8(p) do { (p) += 1; } while (0)
266 #define STREAM_SKIP_UINT16(p) do { (p) += 2; } while (0)
267
268 /********************************************************************************
269 ** Macros to get and put bytes to and from a field (Little Endian format).
270 ** These are the same as to stream, except the pointer is not incremented.
271 */
272 #define UINT32_TO_FIELD(p, u32) {*(UINT8 *)(p) = (UINT8)(u32); *((UINT8 *)(p)+1) = (UINT8)((u32) >> 8); *((UINT8 *)(p)+2) = (UINT8)((u32) >> 16); *((UINT8 *)(p)+3) = (UINT8)((u32) >> 24);}
273 #define UINT24_TO_FIELD(p, u24) {*(UINT8 *)(p) = (UINT8)(u24); *((UINT8 *)(p)+1) = (UINT8)((u24) >> 8); *((UINT8 *)(p)+2) = (UINT8)((u24) >> 16);}
274 #define UINT16_TO_FIELD(p, u16) {*(UINT8 *)(p) = (UINT8)(u16); *((UINT8 *)(p)+1) = (UINT8)((u16) >> 8);}
275 #define UINT8_TO_FIELD(p, u8) {*(UINT8 *)(p) = (UINT8)(u8);}
276
277
278 /********************************************************************************
279 ** Macros to get and put bytes to and from a stream (Big Endian format)
280 */
281 #define UINT64_TO_BE_STREAM(p, u64) {*(p)++ = (UINT8)((u64) >> 56); *(p)++ = (UINT8)((u64) >> 48); *(p)++ = (UINT8)((u64) >> 40); *(p)++ = (UINT8)((u64) >> 32); *(p)++ = (UINT8)((u64) >> 24); *(p)++ = (UINT8)((u64) >> 16); *(p)++ = (UINT8)((u64) >> 8); *(p)++ = (UINT8)(u64); }
282 #define UINT32_TO_BE_STREAM(p, u32) {*(p)++ = (UINT8)((u32) >> 24); *(p)++ = (UINT8)((u32) >> 16); *(p)++ = (UINT8)((u32) >> 8); *(p)++ = (UINT8)(u32); }
283 #define UINT24_TO_BE_STREAM(p, u24) {*(p)++ = (UINT8)((u24) >> 16); *(p)++ = (UINT8)((u24) >> 8); *(p)++ = (UINT8)(u24);}
284 #define UINT16_TO_BE_STREAM(p, u16) {*(p)++ = (UINT8)((u16) >> 8); *(p)++ = (UINT8)(u16);}
285 #define UINT8_TO_BE_STREAM(p, u8) {*(p)++ = (UINT8)(u8);}
286 #define ARRAY_TO_BE_STREAM(p, a, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) *(p)++ = (UINT8) a[ijk];}
287 #define ARRAY_TO_BE_STREAM_REVERSE(p, a, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) *(p)++ = (UINT8) a[len - ijk - 1];}
288
289 #define BE_STREAM_TO_UINT8(u8, p) {u8 = (UINT8)(*(p)); (p) += 1;}
290 #define BE_STREAM_TO_UINT16(u16, p) {u16 = (UINT16)(((UINT16)(*(p)) << 8) + (UINT16)(*((p) + 1))); (p) += 2;}
291 #define BE_STREAM_TO_UINT24(u32, p) {u32 = (((UINT32)(*((p) + 2))) + ((UINT32)(*((p) + 1)) << 8) + ((UINT32)(*(p)) << 16)); (p) += 3;}
292 #define BE_STREAM_TO_UINT32(u32, p) {u32 = ((UINT32)(*((p) + 3)) + ((UINT32)(*((p) + 2)) << 8) + ((UINT32)(*((p) + 1)) << 16) + ((UINT32)(*(p)) << 24)); (p) += 4;}
293 #define BE_STREAM_TO_ARRAY(p, a, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) ((UINT8 *) a)[ijk] = *p++;}
294
295
296 /********************************************************************************
297 ** Macros to get and put bytes to and from a field (Big Endian format).
298 ** These are the same as to stream, except the pointer is not incremented.
299 */
300 #define UINT32_TO_BE_FIELD(p, u32) {*(UINT8 *)(p) = (UINT8)((u32) >> 24); *((UINT8 *)(p)+1) = (UINT8)((u32) >> 16); *((UINT8 *)(p)+2) = (UINT8)((u32) >> 8); *((UINT8 *)(p)+3) = (UINT8)(u32); }
301 #define UINT24_TO_BE_FIELD(p, u24) {*(UINT8 *)(p) = (UINT8)((u24) >> 16); *((UINT8 *)(p)+1) = (UINT8)((u24) >> 8); *((UINT8 *)(p)+2) = (UINT8)(u24);}
302 #define UINT16_TO_BE_FIELD(p, u16) {*(UINT8 *)(p) = (UINT8)((u16) >> 8); *((UINT8 *)(p)+1) = (UINT8)(u16);}
303 #define UINT8_TO_BE_FIELD(p, u8) {*(UINT8 *)(p) = (UINT8)(u8);}
304
305
306 /* Common Bluetooth field definitions */
307 #define BD_ADDR_LEN 6 /* Device address length */
308 typedef UINT8 BD_ADDR[BD_ADDR_LEN]; /* Device address */
309 typedef UINT8 *BD_ADDR_PTR; /* Pointer to Device Address */
310
311 #define AMP_KEY_TYPE_GAMP 0
312 #define AMP_KEY_TYPE_WIFI 1
313 #define AMP_KEY_TYPE_UWB 2
314 typedef UINT8 tAMP_KEY_TYPE;
315
316 #define BT_OCTET8_LEN 8
317 typedef UINT8 BT_OCTET8[BT_OCTET8_LEN]; /* octet array: size 16 */
318
319 #define LINK_KEY_LEN 16
320 typedef UINT8 LINK_KEY[LINK_KEY_LEN]; /* Link Key */
321
322 #define AMP_LINK_KEY_LEN 32
323 typedef UINT8 AMP_LINK_KEY[AMP_LINK_KEY_LEN]; /* Dedicated AMP and GAMP Link Keys */
324
325 #define BT_OCTET16_LEN 16
326 typedef UINT8 BT_OCTET16[BT_OCTET16_LEN]; /* octet array: size 16 */
327
328 #define PIN_CODE_LEN 16
329 typedef UINT8 PIN_CODE[PIN_CODE_LEN]; /* Pin Code (upto 128 bits) MSB is 0 */
330 typedef UINT8 *PIN_CODE_PTR; /* Pointer to Pin Code */
331
332 #define BT_OCTET32_LEN 32
333 typedef UINT8 BT_OCTET32[BT_OCTET32_LEN]; /* octet array: size 32 */
334
335 #define DEV_CLASS_LEN 3
336 typedef UINT8 DEV_CLASS[DEV_CLASS_LEN]; /* Device class */
337 typedef UINT8 *DEV_CLASS_PTR; /* Pointer to Device class */
338
339 #define EXT_INQ_RESP_LEN 3
340 typedef UINT8 EXT_INQ_RESP[EXT_INQ_RESP_LEN];/* Extended Inquiry Response */
341 typedef UINT8 *EXT_INQ_RESP_PTR; /* Pointer to Extended Inquiry Response */
342
343 #define BD_NAME_LEN 248
344 typedef UINT8 BD_NAME[BD_NAME_LEN + 1]; /* Device name */
345 typedef UINT8 *BD_NAME_PTR; /* Pointer to Device name */
346
347 #define BD_FEATURES_LEN 8
348 typedef UINT8 BD_FEATURES[BD_FEATURES_LEN]; /* LMP features supported by device */
349
350 #define BT_EVENT_MASK_LEN 8
351 typedef UINT8 BT_EVENT_MASK[BT_EVENT_MASK_LEN]; /* Event Mask */
352
353 #define LAP_LEN 3
354 typedef UINT8 LAP[LAP_LEN]; /* IAC as passed to Inquiry (LAP) */
355 typedef UINT8 INQ_LAP[LAP_LEN]; /* IAC as passed to Inquiry (LAP) */
356
357 #define RAND_NUM_LEN 16
358 typedef UINT8 RAND_NUM[RAND_NUM_LEN];
359
360 #define ACO_LEN 12
361 typedef UINT8 ACO[ACO_LEN]; /* Authenticated ciphering offset */
362
363 #define COF_LEN 12
364 typedef UINT8 COF[COF_LEN]; /* ciphering offset number */
365
366 #define AFH_CHANNELS_LEN 10
367 typedef UINT8 AFH_CHANNELS[AFH_CHANNELS_LEN];
368 #define BLE_CHANNELS_LEN 5
369 typedef UINT8 BLE_CHANNELS[BLE_CHANNELS_LEN];
370
371 typedef struct {
372 UINT8 qos_flags; /* TBD */
373 UINT8 service_type; /* see below */
374 UINT32 token_rate; /* bytes/second */
375 UINT32 token_bucket_size; /* bytes */
376 UINT32 peak_bandwidth; /* bytes/second */
377 UINT32 latency; /* microseconds */
378 UINT32 delay_variation; /* microseconds */
379 } FLOW_SPEC;
380
381 /* Values for service_type */
382 #define NO_TRAFFIC 0
383 #define BEST_EFFORT 1
384 #define GUARANTEED 2
385
386 /* Service class of the CoD */
387 #define SERV_CLASS_NETWORKING (1 << 1)
388 #define SERV_CLASS_RENDERING (1 << 2)
389 #define SERV_CLASS_CAPTURING (1 << 3)
390 #define SERV_CLASS_OBJECT_TRANSFER (1 << 4)
391 #define SERV_CLASS_OBJECT_AUDIO (1 << 5)
392 #define SERV_CLASS_OBJECT_TELEPHONY (1 << 6)
393 #define SERV_CLASS_OBJECT_INFORMATION (1 << 7)
394
395 /* Second byte */
396 #define SERV_CLASS_LIMITED_DISC_MODE (0x20)
397
398 /* Field size definitions. Note that byte lengths are rounded up. */
399 #define ACCESS_CODE_BIT_LEN 72
400 #define ACCESS_CODE_BYTE_LEN 9
401 #define SHORTENED_ACCESS_CODE_BIT_LEN 68
402
403 typedef UINT8 ACCESS_CODE[ACCESS_CODE_BYTE_LEN];
404
405 #define SYNTH_TX 1 /* want synth code to TRANSMIT at this freq */
406 #define SYNTH_RX 2 /* want synth code to RECEIVE at this freq */
407
408 #define SYNC_REPS 1 /* repeats of sync word transmitted to start of burst */
409
410 /* Bluetooth CLK27 */
411 #define BT_CLK27 (2 << 26)
412
413 /* Bluetooth CLK12 is 1.28 sec */
414 #define BT_CLK12_TO_MS(x) ((x) * 1280)
415 #define BT_MS_TO_CLK12(x) ((x) / 1280)
416 #define BT_CLK12_TO_SLOTS(x) ((x) << 11)
417
418 /* Bluetooth CLK is 0.625 msec */
419 #define BT_CLK_TO_MS(x) (((x) * 5 + 3) / 8)
420 #define BT_MS_TO_CLK(x) (((x) * 8 + 2) / 5)
421
422 #define BT_CLK_TO_MICROSECS(x) (((x) * 5000 + 3) / 8)
423 #define BT_MICROSECS_TO_CLK(x) (((x) * 8 + 2499) / 5000)
424
425 /* Maximum UUID size - 16 bytes, and structure to hold any type of UUID. */
426 #define MAX_UUID_SIZE 16
427 typedef struct {
428 #define LEN_UUID_16 2
429 #define LEN_UUID_32 4
430 #define LEN_UUID_128 16
431
432 UINT16 len;
433
434 union {
435 UINT16 uuid16;
436 UINT32 uuid32;
437 UINT8 uuid128[MAX_UUID_SIZE];
438 } uu;
439
440 } tBT_UUID;
441
442 #define BT_EIR_FLAGS_TYPE 0x01
443 #define BT_EIR_MORE_16BITS_UUID_TYPE 0x02
444 #define BT_EIR_COMPLETE_16BITS_UUID_TYPE 0x03
445 #define BT_EIR_MORE_32BITS_UUID_TYPE 0x04
446 #define BT_EIR_COMPLETE_32BITS_UUID_TYPE 0x05
447 #define BT_EIR_MORE_128BITS_UUID_TYPE 0x06
448 #define BT_EIR_COMPLETE_128BITS_UUID_TYPE 0x07
449 #define BT_EIR_SHORTENED_LOCAL_NAME_TYPE 0x08
450 #define BT_EIR_COMPLETE_LOCAL_NAME_TYPE 0x09
451 #define BT_EIR_TX_POWER_LEVEL_TYPE 0x0A
452 #define BT_EIR_OOB_BD_ADDR_TYPE 0x0C
453 #define BT_EIR_OOB_COD_TYPE 0x0D
454 #define BT_EIR_OOB_SSP_HASH_C_TYPE 0x0E
455 #define BT_EIR_OOB_SSP_RAND_R_TYPE 0x0F
456 #define BT_EIR_URL_TYPE 0x24
457 #define BT_EIR_MANUFACTURER_SPECIFIC_TYPE 0xFF
458
459 #define BT_OOB_COD_SIZE 3
460 #define BT_OOB_HASH_C_SIZE 16
461 #define BT_OOB_RAND_R_SIZE 16
462
463 /* Broadcom proprietary UUIDs and reserved PSMs
464 **
465 ** The lowest 4 bytes byte of the UUID or GUID depends on the feature. Typically,
466 ** the value of those bytes will be the PSM or SCN, but it is up to the features.
467 */
468 #define BRCM_PROPRIETARY_UUID_BASE 0xDA, 0x23, 0x41, 0x02, 0xA3, 0xBB, 0xC1, 0x71, 0xBA, 0x09, 0x6f, 0x21
469 #define BRCM_PROPRIETARY_GUID_BASE 0xda23, 0x4102, 0xa3, 0xbb, 0xc1, 0x71, 0xba, 0x09, 0x6f, 0x21
470
471 /* We will not allocate a PSM in the reserved range to 3rd party apps
472 */
473 #define BRCM_RESERVED_PSM_START 0x5AE1
474 #define BRCM_RESERVED_PSM_END 0x5AFF
475
476 #define BRCM_UTILITY_SERVICE_PSM 0x5AE1
477 #define BRCM_MATCHER_PSM 0x5AE3
478
479 /* Connection statistics
480 */
481
482 /* Structure to hold connection stats */
483 #ifndef BT_CONN_STATS_DEFINED
484 #define BT_CONN_STATS_DEFINED
485
486 /* These bits are used in the bIsConnected field */
487 #define BT_CONNECTED_USING_BREDR 1
488 #define BT_CONNECTED_USING_AMP 2
489
490 typedef struct {
491 UINT32 is_connected;
492 INT32 rssi;
493 UINT32 bytes_sent;
494 UINT32 bytes_rcvd;
495 UINT32 duration;
496 } tBT_CONN_STATS;
497
498 #endif
499
500
501 /*****************************************************************************
502 ** Low Energy definitions
503 **
504 ** Address types
505 */
506 #define BLE_ADDR_PUBLIC 0x00
507 #define BLE_ADDR_RANDOM 0x01
508 #define BLE_ADDR_PUBLIC_ID 0x02
509 #define BLE_ADDR_RANDOM_ID 0x03
510 #define BLE_ADDR_TYPE_MAX BLE_ADDR_RANDOM_ID
511 #define BLE_ADDR_UNKNOWN_TYPE 0XFF
512 typedef UINT8 tBLE_ADDR_TYPE;
513 #define BLE_ADDR_TYPE_MASK (BLE_ADDR_RANDOM | BLE_ADDR_PUBLIC)
514
515 #define BT_TRANSPORT_INVALID 0
516 #define BT_TRANSPORT_BR_EDR 1
517 #define BT_TRANSPORT_LE 2
518 typedef UINT8 tBT_TRANSPORT;
519
520 #define BLE_ADDR_IS_STATIC(x) ((x[0] & 0xC0) == 0xC0)
521
522 typedef struct {
523 tBLE_ADDR_TYPE type;
524 BD_ADDR bda;
525 } tBLE_BD_ADDR;
526
527 /* Device Types
528 */
529 #define BT_DEVICE_TYPE_BREDR 0x01
530 #define BT_DEVICE_TYPE_BLE 0x02
531 #define BT_DEVICE_TYPE_DUMO 0x03
532 typedef UINT8 tBT_DEVICE_TYPE;
533 /*****************************************************************************/
534
535 /* Define New Trace Type Definition */
536 /* TRACE_CTRL_TYPE 0x^^000000*/
537 #define TRACE_CTRL_MASK 0xff000000
538 #define TRACE_GET_CTRL(x) ((((UINT32)(x)) & TRACE_CTRL_MASK) >> 24)
539
540 #define TRACE_CTRL_GENERAL 0x00000000
541 #define TRACE_CTRL_STR_RESOURCE 0x01000000
542 #define TRACE_CTRL_SEQ_FLOW 0x02000000
543 #define TRACE_CTRL_MAX_NUM 3
544
545 /* LAYER SPECIFIC 0x00^^0000*/
546 #define TRACE_LAYER_MASK 0x00ff0000
547 #define TRACE_GET_LAYER(x) ((((UINT32)(x)) & TRACE_LAYER_MASK) >> 16)
548
549 #define TRACE_LAYER_NONE 0x00000000
550 #define TRACE_LAYER_USB 0x00010000
551 #define TRACE_LAYER_SERIAL 0x00020000
552 #define TRACE_LAYER_SOCKET 0x00030000
553 #define TRACE_LAYER_RS232 0x00040000
554 #define TRACE_LAYER_TRANS_MAX_NUM 5
555 #define TRACE_LAYER_TRANS_ALL 0x007f0000
556 #define TRACE_LAYER_LC 0x00050000
557 #define TRACE_LAYER_LM 0x00060000
558 #define TRACE_LAYER_HCI 0x00070000
559 #define TRACE_LAYER_L2CAP 0x00080000
560 #define TRACE_LAYER_RFCOMM 0x00090000
561 #define TRACE_LAYER_SDP 0x000a0000
562 #define TRACE_LAYER_TCS 0x000b0000
563 #define TRACE_LAYER_OBEX 0x000c0000
564 #define TRACE_LAYER_BTM 0x000d0000
565 #define TRACE_LAYER_GAP 0x000e0000
566 #define TRACE_LAYER_ICP 0x00110000
567 #define TRACE_LAYER_HSP2 0x00120000
568 #define TRACE_LAYER_SPP 0x00130000
569 #define TRACE_LAYER_CTP 0x00140000
570 #define TRACE_LAYER_BPP 0x00150000
571 #define TRACE_LAYER_HCRP 0x00160000
572 #define TRACE_LAYER_FTP 0x00170000
573 #define TRACE_LAYER_OPP 0x00180000
574 #define TRACE_LAYER_BTU 0x00190000
575 #define TRACE_LAYER_GKI 0x001a0000
576 #define TRACE_LAYER_BNEP 0x001b0000
577 #define TRACE_LAYER_PAN 0x001c0000
578 #define TRACE_LAYER_HFP 0x001d0000
579 #define TRACE_LAYER_HID 0x001e0000
580 #define TRACE_LAYER_BIP 0x001f0000
581 #define TRACE_LAYER_AVP 0x00200000
582 #define TRACE_LAYER_A2D 0x00210000
583 #define TRACE_LAYER_SAP 0x00220000
584 #define TRACE_LAYER_AMP 0x00230000
585 #define TRACE_LAYER_MCA 0x00240000
586 #define TRACE_LAYER_ATT 0x00250000
587 #define TRACE_LAYER_SMP 0x00260000
588 #define TRACE_LAYER_NFC 0x00270000
589 #define TRACE_LAYER_NCI 0x00280000
590 #define TRACE_LAYER_LLCP 0x00290000
591 #define TRACE_LAYER_NDEF 0x002a0000
592 #define TRACE_LAYER_RW 0x002b0000
593 #define TRACE_LAYER_CE 0x002c0000
594 #define TRACE_LAYER_P2P 0x002d0000
595 #define TRACE_LAYER_SNEP 0x002e0000
596 #define TRACE_LAYER_CHO 0x002f0000
597 #define TRACE_LAYER_NFA 0x00300000
598
599 #define TRACE_LAYER_MAX_NUM 0x0031
600
601
602 /* TRACE_ORIGINATOR 0x0000^^00*/
603 #define TRACE_ORG_MASK 0x0000ff00
604 #define TRACE_GET_ORG(x) ((((UINT32)(x)) & TRACE_ORG_MASK) >> 8)
605
606 #define TRACE_ORG_STACK 0x00000000
607 #define TRACE_ORG_HCI_TRANS 0x00000100
608 #define TRACE_ORG_PROTO_DISP 0x00000200
609 #define TRACE_ORG_RPC 0x00000300
610 #define TRACE_ORG_GKI 0x00000400
611 #define TRACE_ORG_APPL 0x00000500
612 #define TRACE_ORG_SCR_WRAPPER 0x00000600
613 #define TRACE_ORG_SCR_ENGINE 0x00000700
614 #define TRACE_ORG_USER_SCR 0x00000800
615 #define TRACE_ORG_TESTER 0x00000900
616 #define TRACE_ORG_MAX_NUM 10 /* 32-bit mask; must be < 32 */
617 #define TRACE_LITE_ORG_MAX_NUM 6
618 #define TRACE_ORG_ALL 0x03ff
619 #define TRACE_ORG_RPC_TRANS 0x04
620
621 #define TRACE_ORG_REG 0x00000909
622 #define TRACE_ORG_REG_SUCCESS 0x0000090a
623
624 /* TRACE_TYPE 0x000000^^*/
625 #define TRACE_TYPE_MASK 0x000000ff
626 #define TRACE_GET_TYPE(x) (((UINT32)(x)) & TRACE_TYPE_MASK)
627
628 #define TRACE_TYPE_ERROR 0x00000000
629 #define TRACE_TYPE_WARNING 0x00000001
630 #define TRACE_TYPE_API 0x00000002
631 #define TRACE_TYPE_EVENT 0x00000003
632 #define TRACE_TYPE_DEBUG 0x00000004
633 #define TRACE_TYPE_STACK_ONLY_MAX TRACE_TYPE_DEBUG
634 #define TRACE_TYPE_TX 0x00000005
635 #define TRACE_TYPE_RX 0x00000006
636 #define TRACE_TYPE_DEBUG_ASSERT 0x00000007
637 #define TRACE_TYPE_GENERIC 0x00000008
638 #define TRACE_TYPE_REG 0x00000009
639 #define TRACE_TYPE_REG_SUCCESS 0x0000000a
640 #define TRACE_TYPE_CMD_TX 0x0000000b
641 #define TRACE_TYPE_EVT_TX 0x0000000c
642 #define TRACE_TYPE_ACL_TX 0x0000000d
643 #define TRACE_TYPE_CMD_RX 0x0000000e
644 #define TRACE_TYPE_EVT_RX 0x0000000f
645 #define TRACE_TYPE_ACL_RX 0x00000010
646 #define TRACE_TYPE_TARGET_TRACE 0x00000011
647 #define TRACE_TYPE_SCO_TX 0x00000012
648 #define TRACE_TYPE_SCO_RX 0x00000013
649
650
651 #define TRACE_TYPE_MAX_NUM 20
652 #define TRACE_TYPE_ALL 0xffff
653
654 /* Define color for script type */
655 #define SCR_COLOR_DEFAULT 0
656 #define SCR_COLOR_TYPE_COMMENT 1
657 #define SCR_COLOR_TYPE_COMMAND 2
658 #define SCR_COLOR_TYPE_EVENT 3
659 #define SCR_COLOR_TYPE_SELECT 4
660
661 /* Define protocol trace flag values */
662 #define SCR_PROTO_TRACE_HCI_SUMMARY 0x00000001
663 #define SCR_PROTO_TRACE_HCI_DATA 0x00000002
664 #define SCR_PROTO_TRACE_L2CAP 0x00000004
665 #define SCR_PROTO_TRACE_RFCOMM 0x00000008
666 #define SCR_PROTO_TRACE_SDP 0x00000010
667 #define SCR_PROTO_TRACE_TCS 0x00000020
668 #define SCR_PROTO_TRACE_OBEX 0x00000040
669 #define SCR_PROTO_TRACE_OAPP 0x00000080 /* OBEX Application Profile */
670 #define SCR_PROTO_TRACE_AMP 0x00000100
671 #define SCR_PROTO_TRACE_BNEP 0x00000200
672 #define SCR_PROTO_TRACE_AVP 0x00000400
673 #define SCR_PROTO_TRACE_MCA 0x00000800
674 #define SCR_PROTO_TRACE_ATT 0x00001000
675 #define SCR_PROTO_TRACE_SMP 0x00002000
676 #define SCR_PROTO_TRACE_NCI 0x00004000
677 #define SCR_PROTO_TRACE_LLCP 0x00008000
678 #define SCR_PROTO_TRACE_NDEF 0x00010000
679 #define SCR_PROTO_TRACE_RW 0x00020000
680 #define SCR_PROTO_TRACE_CE 0x00040000
681 #define SCR_PROTO_TRACE_SNEP 0x00080000
682 #define SCR_PROTO_TRACE_CHO 0x00100000
683 #define SCR_PROTO_TRACE_ALL 0x001fffff
684 #define SCR_PROTO_TRACE_HCI_LOGGING_VSE 0x0800 /* Brcm vs event for logmsg and protocol traces */
685
686 #define MAX_SCRIPT_TYPE 5
687
688 #define TCS_PSM_INTERCOM 5
689 #define TCS_PSM_CORDLESS 7
690 #define BT_PSM_BNEP 0x000F
691 /* Define PSMs HID uses */
692 #define HID_PSM_CONTROL 0x0011
693 #define HID_PSM_INTERRUPT 0x0013
694
695 /* Define a function for logging */
696 typedef void (BT_LOG_FUNC) (int trace_type, const char *fmt_str, ...);
697
698 /* bd addr length and type */
699 #ifndef BD_ADDR_LEN
700 #define BD_ADDR_LEN 6
701 typedef uint8_t BD_ADDR[BD_ADDR_LEN];
702 #endif
703
704 // From bd.c
705
706 /*****************************************************************************
707 ** Constants
708 *****************************************************************************/
709
710 /* global constant for "any" bd addr */
711 static const BD_ADDR bd_addr_any = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
712 static const BD_ADDR bd_addr_null = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
713
714 /*****************************************************************************
715 ** Functions
716 *****************************************************************************/
717
718 /*******************************************************************************
719 **
720 ** Function bdcpy
721 **
722 ** Description Copy bd addr b to a.
723 **
724 **
725 ** Returns void
726 **
727 *******************************************************************************/
bdcpy(BD_ADDR a,const BD_ADDR b)728 static inline void bdcpy(BD_ADDR a, const BD_ADDR b)
729 {
730 int i;
731
732 for (i = BD_ADDR_LEN; i != 0; i--) {
733 *a++ = *b++;
734 }
735 }
736
737 /*******************************************************************************
738 **
739 ** Function bdcmp
740 **
741 ** Description Compare bd addr b to a.
742 **
743 **
744 ** Returns Zero if b==a, nonzero otherwise (like memcmp).
745 **
746 *******************************************************************************/
bdcmp(const BD_ADDR a,const BD_ADDR b)747 static inline int bdcmp(const BD_ADDR a, const BD_ADDR b)
748 {
749 int i;
750
751 for (i = BD_ADDR_LEN; i != 0; i--) {
752 if (*a++ != *b++) {
753 return -1;
754 }
755 }
756 return 0;
757 }
758
759 /*******************************************************************************
760 **
761 ** Function bdcmpany
762 **
763 ** Description Compare bd addr to "any" bd addr.
764 **
765 **
766 ** Returns Zero if a equals bd_addr_any.
767 **
768 *******************************************************************************/
bdcmpany(const BD_ADDR a)769 static inline int bdcmpany(const BD_ADDR a)
770 {
771 return bdcmp(a, bd_addr_any);
772 }
773
774 /*******************************************************************************
775 **
776 ** Function bdsetany
777 **
778 ** Description Set bd addr to "any" bd addr.
779 **
780 **
781 ** Returns void
782 **
783 *******************************************************************************/
bdsetany(BD_ADDR a)784 static inline void bdsetany(BD_ADDR a)
785 {
786 bdcpy(a, bd_addr_any);
787 }
788
789 /*******************************************************************************
790 **
791 ** Function bt_rcopy
792 **
793 ** Description memory reverse and copy.
794 **
795 **
796 ** Returns void
797 **
798 *******************************************************************************/
bt_rcopy(UINT8 * dst,UINT8 const * src,UINT16 len)799 static inline void bt_rcopy(UINT8 *dst, UINT8 const *src, UINT16 len)
800 {
801 src += len;
802 while (len --) {
803 *dst++ = *--src;
804 }
805 }
806 #endif
807
