1 /******************************************************************************
3 * Copyright (C) 1999-2012 Broadcom Corporation
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 ******************************************************************************/
34 typedef uint8_t UINT8;
35 typedef uint16_t UINT16;
36 typedef uint32_t UINT32;
37 typedef uint64_t UINT64;
40 typedef int16_t INT16;
41 typedef int32_t INT32;
45 # define PACKED __packed
46 # define INLINE __inline
54 ** This section defines global events. These are events that cross layers.
55 ** Any event that passes between layers MUST be one of these events. Tasks
56 ** can use their own events internally, but a FUNDAMENTAL design issue is
57 ** that global events MUST be one of these events defined below.
59 ** The convention used is the the event name contains the layer that the
62 #define BT_EVT_MASK 0xFF00
63 #define BT_SUB_EVT_MASK 0x00FF
64 /* To Bluetooth Upper Layers */
65 /************************************/
66 #define BT_EVT_TO_BTU_L2C_EVT 0x0900 /* L2CAP event */
67 #define BT_EVT_TO_BTU_HCI_EVT 0x1000 /* HCI Event */
68 #define BT_EVT_TO_BTU_HCI_BR_EDR_EVT (0x0000 | BT_EVT_TO_BTU_HCI_EVT) /* event from BR/EDR controller */
69 #define BT_EVT_TO_BTU_HCI_AMP1_EVT (0x0001 | BT_EVT_TO_BTU_HCI_EVT) /* event from local AMP 1 controller */
70 #define BT_EVT_TO_BTU_HCI_AMP2_EVT (0x0002 | BT_EVT_TO_BTU_HCI_EVT) /* event from local AMP 2 controller */
71 #define BT_EVT_TO_BTU_HCI_AMP3_EVT (0x0003 | BT_EVT_TO_BTU_HCI_EVT) /* event from local AMP 3 controller */
73 #define BT_EVT_TO_BTU_HCI_ACL 0x1100 /* ACL Data from HCI */
74 #define BT_EVT_TO_BTU_HCI_SCO 0x1200 /* SCO Data from HCI */
75 #define BT_EVT_TO_BTU_HCIT_ERR 0x1300 /* HCI Transport Error */
77 #define BT_EVT_TO_BTU_SP_EVT 0x1400 /* Serial Port Event */
78 #define BT_EVT_TO_BTU_SP_DATA 0x1500 /* Serial Port Data */
80 #define BT_EVT_TO_BTU_HCI_CMD 0x1600 /* HCI command from upper layer */
83 #define BT_EVT_TO_BTU_L2C_SEG_XMIT 0x1900 /* L2CAP segment(s) transmitted */
85 #define BT_EVT_PROXY_INCOMING_MSG 0x1A00 /* BlueStackTester event: incoming message from target */
87 #define BT_EVT_BTSIM 0x1B00 /* Insight BTSIM event */
88 #define BT_EVT_BTISE 0x1C00 /* Insight Script Engine event */
91 /************************************/
92 #define BT_EVT_TO_LM_HCI_CMD 0x2000 /* HCI Command */
93 #define BT_EVT_TO_LM_HCI_ACL 0x2100 /* HCI ACL Data */
94 #define BT_EVT_TO_LM_HCI_SCO 0x2200 /* HCI SCO Data */
95 #define BT_EVT_TO_LM_HCIT_ERR 0x2300 /* HCI Transport Error */
96 #define BT_EVT_TO_LM_LC_EVT 0x2400 /* LC event */
97 #define BT_EVT_TO_LM_LC_LMP 0x2500 /* LC Received LMP command frame */
98 #define BT_EVT_TO_LM_LC_ACL 0x2600 /* LC Received ACL data */
99 #define BT_EVT_TO_LM_LC_SCO 0x2700 /* LC Received SCO data (not used) */
100 #define BT_EVT_TO_LM_LC_ACL_TX 0x2800 /* LMP data transmit complete */
101 #define BT_EVT_TO_LM_LC_LMPC_TX 0x2900 /* LMP Command transmit complete */
102 #define BT_EVT_TO_LM_LOCAL_ACL_LB 0x2a00 /* Data to be locally loopbacked */
103 #define BT_EVT_TO_LM_HCI_ACL_ACK 0x2b00 /* HCI ACL Data ack (not used) */
104 #define BT_EVT_TO_LM_DIAG 0x2c00 /* LM Diagnostics commands */
107 #define BT_EVT_TO_BTM_CMDS 0x2f00
108 #define BT_EVT_TO_BTM_PM_MDCHG_EVT (0x0001 | BT_EVT_TO_BTM_CMDS)
110 #define BT_EVT_TO_TCS_CMDS 0x3000
112 #define BT_EVT_TO_CTP_CMDS 0x3300
115 #define BT_EVT_TO_FTP_SRVR_CMDS 0x3600
116 #define BT_EVT_TO_FTP_CLNT_CMDS 0x3700
118 #define BT_EVT_TO_BTU_SAP 0x3800 /* SIM Access Profile events */
121 #define BT_EVT_TO_OPP_SRVR_CMDS 0x3900
122 #define BT_EVT_TO_OPP_CLNT_CMDS 0x3a00
125 #define BT_EVT_TO_GAP_MSG 0x3b00
128 /************************************/
129 #define BT_EVT_TO_NFC_NCI 0x4000 /* NCI Command, Notification or Data*/
130 #define BT_EVT_TO_NFC_INIT 0x4100 /* Initialization message */
131 #define BT_EVT_TO_NCI_LP 0x4200 /* Low power */
132 #define BT_EVT_TO_NFC_ERR 0x4300 /* Error notification to NFC Task */
134 #define BT_EVT_TO_NFCCSIM_NCI 0x4a00 /* events to NFCC simulation (NCI packets) */
138 #define BT_EVT_HCISU 0x5000
140 #define BT_EVT_TO_HCISU_RECONFIG_EVT (0x0001 | BT_EVT_HCISU)
141 #define BT_EVT_TO_HCISU_UPDATE_BAUDRATE_EVT (0x0002 | BT_EVT_HCISU)
142 #define BT_EVT_TO_HCISU_LP_ENABLE_EVT (0x0003 | BT_EVT_HCISU)
143 #define BT_EVT_TO_HCISU_LP_DISABLE_EVT (0x0004 | BT_EVT_HCISU)
144 #define BT_EVT_TO_HCISU_LP_APP_SLEEPING_EVT (0x0005 | BT_EVT_HCISU)
145 #define BT_EVT_TO_HCISU_LP_ALLOW_BT_SLEEP_EVT (0x0006 | BT_EVT_HCISU)
146 #define BT_EVT_TO_HCISU_LP_WAKEUP_HOST_EVT (0x0007 | BT_EVT_HCISU)
147 #define BT_EVT_TO_HCISU_LP_RCV_H4IBSS_EVT (0x0008 | BT_EVT_HCISU)
148 #define BT_EVT_TO_HCISU_H5_RESET_EVT (0x0009 | BT_EVT_HCISU)
149 #define BT_EVT_HCISU_START_QUICK_TIMER (0x000a | BT_EVT_HCISU)
151 #define BT_EVT_DATA_TO_AMP_1 0x5100
152 #define BT_EVT_DATA_TO_AMP_15 0x5f00
156 #define BT_EVT_BTU_HSP2 0x6000
158 #define BT_EVT_TO_BTU_HSP2_EVT (0x0001 | BT_EVT_BTU_HSP2)
161 #define BT_EVT_TO_BPP_PR_CMDS 0x6100 /* Printer Events */
162 #define BT_EVT_TO_BPP_SND_CMDS 0x6200 /* BPP Sender Events */
165 #define BT_EVT_TO_BIP_CMDS 0x6300
169 #define BT_EVT_BTU_HCRP 0x7000
171 #define BT_EVT_TO_BTU_HCRP_EVT (0x0001 | BT_EVT_BTU_HCRP)
172 #define BT_EVT_TO_BTU_HCRPM_EVT (0x0002 | BT_EVT_BTU_HCRP)
175 #define BT_EVT_BTU_HFP 0x8000
176 #define BT_EVT_TO_BTU_HFP_EVT (0x0001 | BT_EVT_BTU_HFP)
178 #define BT_EVT_BTU_IPC_EVT 0x9000
179 #define BT_EVT_BTU_IPC_LOGMSG_EVT (0x0000 | BT_EVT_BTU_IPC_EVT)
180 #define BT_EVT_BTU_IPC_ACL_EVT (0x0001 | BT_EVT_BTU_IPC_EVT)
181 #define BT_EVT_BTU_IPC_BTU_EVT (0x0002 | BT_EVT_BTU_IPC_EVT)
182 #define BT_EVT_BTU_IPC_L2C_EVT (0x0003 | BT_EVT_BTU_IPC_EVT)
183 #define BT_EVT_BTU_IPC_L2C_MSG_EVT (0x0004 | BT_EVT_BTU_IPC_EVT)
184 #define BT_EVT_BTU_IPC_BTM_EVT (0x0005 | BT_EVT_BTU_IPC_EVT)
185 #define BT_EVT_BTU_IPC_AVDT_EVT (0x0006 | BT_EVT_BTU_IPC_EVT)
186 #define BT_EVT_BTU_IPC_SLIP_EVT (0x0007 | BT_EVT_BTU_IPC_EVT)
187 #define BT_EVT_BTU_IPC_MGMT_EVT (0x0008 | BT_EVT_BTU_IPC_EVT)
188 #define BT_EVT_BTU_IPC_BTTRC_EVT (0x0009 | BT_EVT_BTU_IPC_EVT)
189 #define BT_EVT_BTU_IPC_BURST_EVT (0x000A | BT_EVT_BTU_IPC_EVT)
193 #define BT_EVT_BTIF 0xA000
194 #define BT_EVT_CONTEXT_SWITCH_EVT (0x0001 | BT_EVT_BTIF)
196 /* Define the header of each buffer used in the Bluetooth stack.
203 uint16_t layer_specific;
207 #define BT_HDR_SIZE (sizeof (BT_HDR))
209 #define BT_PSM_SDP 0x0001
210 #define BT_PSM_RFCOMM 0x0003
211 #define BT_PSM_TCS 0x0005
212 #define BT_PSM_CTP 0x0007
213 #define BT_PSM_BNEP 0x000F
214 #define BT_PSM_HIDC 0x0011
215 #define BT_PSM_HIDI 0x0013
216 #define BT_PSM_UPNP 0x0015
217 #define BT_PSM_AVCTP 0x0017
218 #define BT_PSM_AVDTP 0x0019
219 #define BT_PSM_AVCTP_13 0x001B /* Advanced Control - Browsing */
220 #define BT_PSM_UDI_CP 0x001D /* Unrestricted Digital Information Profile C-Plane */
221 #define BT_PSM_ATT 0x001F /* Attribute Protocol */
223 /* These macros extract the HCI opcodes from a buffer
225 #define HCI_GET_CMD_HDR_OPCODE(p) (UINT16)((*((UINT8 *)((p) + 1) + p->offset) + \
226 (*((UINT8 *)((p) + 1) + p->offset + 1) << 8)))
227 #define HCI_GET_CMD_HDR_PARAM_LEN(p) (UINT8) (*((UINT8 *)((p) + 1) + p->offset + 2))
229 #define HCI_GET_EVT_HDR_OPCODE(p) (UINT8)(*((UINT8 *)((p) + 1) + p->offset))
230 #define HCI_GET_EVT_HDR_PARAM_LEN(p) (UINT8) (*((UINT8 *)((p) + 1) + p->offset + 1))
233 /********************************************************************************
234 ** Macros to get and put bytes to and from a stream (Little Endian format).
236 #define UINT64_TO_BE_STREAM(p, u64) {*(p)++ = (UINT8)((u64) >> 56); *(p)++ = (UINT8)((u64) >> 48); *(p)++ = (UINT8)((u64) >> 40); *(p)++ = (UINT8)((u64) >> 32); \
237 *(p)++ = (UINT8)((u64) >> 24); *(p)++ = (UINT8)((u64) >> 16); *(p)++ = (UINT8)((u64) >> 8); *(p)++ = (UINT8)(u64); }
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];}
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++;}
265 #define STREAM_SKIP_UINT8(p) do { (p) += 1; } while (0)
266 #define STREAM_SKIP_UINT16(p) do { (p) += 2; } while (0)
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.
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);}
278 /********************************************************************************
279 ** Macros to get and put bytes to and from a stream (Big Endian format)
281 #define UINT32_TO_BE_STREAM(p, u32) {*(p)++ = (UINT8)((u32) >> 24); *(p)++ = (UINT8)((u32) >> 16); *(p)++ = (UINT8)((u32) >> 8); *(p)++ = (UINT8)(u32); }
282 #define UINT24_TO_BE_STREAM(p, u24) {*(p)++ = (UINT8)((u24) >> 16); *(p)++ = (UINT8)((u24) >> 8); *(p)++ = (UINT8)(u24);}
283 #define UINT16_TO_BE_STREAM(p, u16) {*(p)++ = (UINT8)((u16) >> 8); *(p)++ = (UINT8)(u16);}
284 #define UINT8_TO_BE_STREAM(p, u8) {*(p)++ = (UINT8)(u8);}
285 #define ARRAY_TO_BE_STREAM(p, a, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) *(p)++ = (UINT8) a[ijk];}
286 #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 #define BE_STREAM_TO_UINT8(u8, p) {u8 = (UINT8)(*(p)); (p) += 1;}
289 #define BE_STREAM_TO_UINT16(u16, p) {u16 = (UINT16)(((UINT16)(*(p)) << 8) + (UINT16)(*((p) + 1))); (p) += 2;}
290 #define BE_STREAM_TO_UINT24(u32, p) {u32 = (((UINT32)(*((p) + 2))) + ((UINT32)(*((p) + 1)) << 8) + ((UINT32)(*(p)) << 16)); (p) += 3;}
291 #define BE_STREAM_TO_UINT32(u32, p) {u32 = ((UINT32)(*((p) + 3)) + ((UINT32)(*((p) + 2)) << 8) + ((UINT32)(*((p) + 1)) << 16) + ((UINT32)(*(p)) << 24)); (p) += 4;}
292 #define BE_STREAM_TO_UINT64(u64, p) {u64 = ((UINT64)(*((p) + 7)) + ((UINT64)(*((p) + 6)) << 8) + \
293 ((UINT64)(*((p) + 5)) << 16) + ((UINT64)(*((p) + 4)) << 24) + \
294 ((UINT64)(*((p) + 3)) << 32) + ((UINT64)(*((p) + 2)) << 40) + \
295 ((UINT64)(*((p) + 1)) << 48) + ((UINT64)(*(p)) << 56)); \
297 #define BE_STREAM_TO_ARRAY(p, a, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) ((UINT8 *) a)[ijk] = *p++;}
300 /********************************************************************************
301 ** Macros to get and put bytes to and from a field (Big Endian format).
302 ** These are the same as to stream, except the pointer is not incremented.
304 #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); }
305 #define UINT24_TO_BE_FIELD(p, u24) {*(UINT8 *)(p) = (UINT8)((u24) >> 16); *((UINT8 *)(p)+1) = (UINT8)((u24) >> 8); *((UINT8 *)(p)+2) = (UINT8)(u24);}
306 #define UINT16_TO_BE_FIELD(p, u16) {*(UINT8 *)(p) = (UINT8)((u16) >> 8); *((UINT8 *)(p)+1) = (UINT8)(u16);}
307 #define UINT8_TO_BE_FIELD(p, u8) {*(UINT8 *)(p) = (UINT8)(u8);}
310 /* Common Bluetooth field definitions */
311 #define BD_ADDR_LEN 6 /* Device address length */
312 typedef UINT8 BD_ADDR[BD_ADDR_LEN]; /* Device address */
313 typedef UINT8 *BD_ADDR_PTR; /* Pointer to Device Address */
315 #define AMP_KEY_TYPE_GAMP 0
316 #define AMP_KEY_TYPE_WIFI 1
317 #define AMP_KEY_TYPE_UWB 2
318 typedef UINT8 tAMP_KEY_TYPE;
320 #define BT_OCTET8_LEN 8
321 typedef UINT8 BT_OCTET8[BT_OCTET8_LEN]; /* octet array: size 16 */
323 #define LINK_KEY_LEN 16
324 typedef UINT8 LINK_KEY[LINK_KEY_LEN]; /* Link Key */
326 #define AMP_LINK_KEY_LEN 32
327 typedef UINT8 AMP_LINK_KEY[AMP_LINK_KEY_LEN]; /* Dedicated AMP and GAMP Link Keys */
329 #define BT_OCTET16_LEN 16
330 typedef UINT8 BT_OCTET16[BT_OCTET16_LEN]; /* octet array: size 16 */
332 #define PIN_CODE_LEN 16
333 typedef UINT8 PIN_CODE[PIN_CODE_LEN]; /* Pin Code (upto 128 bits) MSB is 0 */
334 typedef UINT8 *PIN_CODE_PTR; /* Pointer to Pin Code */
336 #define BT_OCTET32_LEN 32
337 typedef UINT8 BT_OCTET32[BT_OCTET32_LEN]; /* octet array: size 32 */
339 #define DEV_CLASS_LEN 3
340 typedef UINT8 DEV_CLASS[DEV_CLASS_LEN]; /* Device class */
341 typedef UINT8 *DEV_CLASS_PTR; /* Pointer to Device class */
343 #define EXT_INQ_RESP_LEN 3
344 typedef UINT8 EXT_INQ_RESP[EXT_INQ_RESP_LEN];/* Extended Inquiry Response */
345 typedef UINT8 *EXT_INQ_RESP_PTR; /* Pointer to Extended Inquiry Response */
347 #define BD_NAME_LEN 248
348 typedef UINT8 BD_NAME[BD_NAME_LEN + 1]; /* Device name */
349 typedef UINT8 *BD_NAME_PTR; /* Pointer to Device name */
351 #define BD_FEATURES_LEN 8
352 typedef UINT8 BD_FEATURES[BD_FEATURES_LEN]; /* LMP features supported by device */
354 #define BT_EVENT_MASK_LEN 8
355 typedef UINT8 BT_EVENT_MASK[BT_EVENT_MASK_LEN]; /* Event Mask */
358 typedef UINT8 LAP[LAP_LEN]; /* IAC as passed to Inquiry (LAP) */
359 typedef UINT8 INQ_LAP[LAP_LEN]; /* IAC as passed to Inquiry (LAP) */
361 #define RAND_NUM_LEN 16
362 typedef UINT8 RAND_NUM[RAND_NUM_LEN];
365 typedef UINT8 ACO[ACO_LEN]; /* Authenticated ciphering offset */
368 typedef UINT8 COF[COF_LEN]; /* ciphering offset number */
371 UINT8 qos_flags; /* TBD */
372 UINT8 service_type; /* see below */
373 UINT32 token_rate; /* bytes/second */
374 UINT32 token_bucket_size; /* bytes */
375 UINT32 peak_bandwidth; /* bytes/second */
376 UINT32 latency; /* microseconds */
377 UINT32 delay_variation; /* microseconds */
380 /* Values for service_type */
382 #define BEST_EFFORT 1
385 /* Service class of the CoD */
386 #define SERV_CLASS_NETWORKING (1 << 1)
387 #define SERV_CLASS_RENDERING (1 << 2)
388 #define SERV_CLASS_CAPTURING (1 << 3)
389 #define SERV_CLASS_OBJECT_TRANSFER (1 << 4)
390 #define SERV_CLASS_OBJECT_AUDIO (1 << 5)
391 #define SERV_CLASS_OBJECT_TELEPHONY (1 << 6)
392 #define SERV_CLASS_OBJECT_INFORMATION (1 << 7)
395 #define SERV_CLASS_LIMITED_DISC_MODE (0x20)
397 /* Field size definitions. Note that byte lengths are rounded up. */
398 #define ACCESS_CODE_BIT_LEN 72
399 #define ACCESS_CODE_BYTE_LEN 9
400 #define SHORTENED_ACCESS_CODE_BIT_LEN 68
402 typedef UINT8 ACCESS_CODE[ACCESS_CODE_BYTE_LEN];
404 #define SYNTH_TX 1 /* want synth code to TRANSMIT at this freq */
405 #define SYNTH_RX 2 /* want synth code to RECEIVE at this freq */
407 #define SYNC_REPS 1 /* repeats of sync word transmitted to start of burst */
409 #define BT_1SEC_TIMEOUT_MS (1 * 1000) /* 1 second */
411 /* Maximum UUID size - 16 bytes, and structure to hold any type of UUID. */
412 #define MAX_UUID_SIZE 16
415 #define LEN_UUID_16 2
416 #define LEN_UUID_32 4
417 #define LEN_UUID_128 16
425 UINT8 uuid128[MAX_UUID_SIZE];
430 #define BT_EIR_FLAGS_TYPE 0x01
431 #define BT_EIR_MORE_16BITS_UUID_TYPE 0x02
432 #define BT_EIR_COMPLETE_16BITS_UUID_TYPE 0x03
433 #define BT_EIR_MORE_32BITS_UUID_TYPE 0x04
434 #define BT_EIR_COMPLETE_32BITS_UUID_TYPE 0x05
435 #define BT_EIR_MORE_128BITS_UUID_TYPE 0x06
436 #define BT_EIR_COMPLETE_128BITS_UUID_TYPE 0x07
437 #define BT_EIR_SHORTENED_LOCAL_NAME_TYPE 0x08
438 #define BT_EIR_COMPLETE_LOCAL_NAME_TYPE 0x09
439 #define BT_EIR_TX_POWER_LEVEL_TYPE 0x0A
440 #define BT_EIR_OOB_BD_ADDR_TYPE 0x0C
441 #define BT_EIR_OOB_COD_TYPE 0x0D
442 #define BT_EIR_OOB_SSP_HASH_C_TYPE 0x0E
443 #define BT_EIR_OOB_SSP_RAND_R_TYPE 0x0F
444 #define BT_EIR_SERVICE_DATA_TYPE 0x16
445 #define BT_EIR_SERVICE_DATA_16BITS_UUID_TYPE 0x16
446 #define BT_EIR_SERVICE_DATA_32BITS_UUID_TYPE 0x20
447 #define BT_EIR_SERVICE_DATA_128BITS_UUID_TYPE 0x21
448 #define BT_EIR_MANUFACTURER_SPECIFIC_TYPE 0xFF
450 #define BT_OOB_COD_SIZE 3
451 #define BT_OOB_HASH_C_SIZE 16
452 #define BT_OOB_RAND_R_SIZE 16
454 /* Broadcom proprietary UUIDs and reserved PSMs
456 ** The lowest 4 bytes byte of the UUID or GUID depends on the feature. Typically,
457 ** the value of those bytes will be the PSM or SCN, but it is up to the features.
459 #define BRCM_PROPRIETARY_UUID_BASE 0xDA, 0x23, 0x41, 0x02, 0xA3, 0xBB, 0xC1, 0x71, 0xBA, 0x09, 0x6f, 0x21
460 #define BRCM_PROPRIETARY_GUID_BASE 0xda23, 0x4102, 0xa3, 0xbb, 0xc1, 0x71, 0xba, 0x09, 0x6f, 0x21
462 /* We will not allocate a PSM in the reserved range to 3rd party apps
464 #define BRCM_RESERVED_PSM_START 0x5AE1
465 #define BRCM_RESERVED_PSM_END 0x5AFF
467 #define BRCM_UTILITY_SERVICE_PSM 0x5AE1
468 #define BRCM_MATCHER_PSM 0x5AE3
470 /* Connection statistics
473 /* Structure to hold connection stats */
474 #ifndef BT_CONN_STATS_DEFINED
475 #define BT_CONN_STATS_DEFINED
477 /* These bits are used in the bIsConnected field */
478 #define BT_CONNECTED_USING_BREDR 1
479 #define BT_CONNECTED_USING_AMP 2
493 /*****************************************************************************
494 ** Low Energy definitions
498 #define BLE_ADDR_PUBLIC 0x00
499 #define BLE_ADDR_RANDOM 0x01
500 #define BLE_ADDR_PUBLIC_ID 0x02
501 #define BLE_ADDR_RANDOM_ID 0x03
502 typedef UINT8 tBLE_ADDR_TYPE;
503 #define BLE_ADDR_TYPE_MASK (BLE_ADDR_RANDOM | BLE_ADDR_PUBLIC)
505 #define BT_TRANSPORT_INVALID 0
506 #define BT_TRANSPORT_BR_EDR 1
507 #define BT_TRANSPORT_LE 2
508 typedef UINT8 tBT_TRANSPORT;
510 #define BLE_ADDR_IS_STATIC(x) ((x[0] & 0xC0) == 0xC0)
520 #define BT_DEVICE_TYPE_BREDR 0x01
521 #define BT_DEVICE_TYPE_BLE 0x02
522 #define BT_DEVICE_TYPE_DUMO 0x03
523 typedef UINT8 tBT_DEVICE_TYPE;
524 /*****************************************************************************/
527 /* Define trace levels */
528 #define BT_TRACE_LEVEL_NONE 0 /* No trace messages to be generated */
529 #define BT_TRACE_LEVEL_ERROR 1 /* Error condition trace messages */
530 #define BT_TRACE_LEVEL_WARNING 2 /* Warning condition trace messages */
531 #define BT_TRACE_LEVEL_API 3 /* API traces */
532 #define BT_TRACE_LEVEL_EVENT 4 /* Debug messages for events */
533 #define BT_TRACE_LEVEL_DEBUG 5 /* Full debug messages */
534 #define BT_TRACE_LEVEL_VERBOSE 6 /* Verbose debug messages */
536 #define MAX_TRACE_LEVEL 6
539 /* Define New Trace Type Definition */
540 /* TRACE_CTRL_TYPE 0x^^000000*/
541 #define TRACE_CTRL_MASK 0xff000000
542 #define TRACE_GET_CTRL(x) ((((UINT32)(x)) & TRACE_CTRL_MASK) >> 24)
544 #define TRACE_CTRL_GENERAL 0x00000000
545 #define TRACE_CTRL_STR_RESOURCE 0x01000000
546 #define TRACE_CTRL_SEQ_FLOW 0x02000000
547 #define TRACE_CTRL_MAX_NUM 3
549 /* LAYER SPECIFIC 0x00^^0000*/
550 #define TRACE_LAYER_MASK 0x00ff0000
551 #define TRACE_GET_LAYER(x) ((((UINT32)(x)) & TRACE_LAYER_MASK) >> 16)
553 #define TRACE_LAYER_NONE 0x00000000
554 #define TRACE_LAYER_USB 0x00010000
555 #define TRACE_LAYER_SERIAL 0x00020000
556 #define TRACE_LAYER_SOCKET 0x00030000
557 #define TRACE_LAYER_RS232 0x00040000
558 #define TRACE_LAYER_TRANS_MAX_NUM 5
559 #define TRACE_LAYER_TRANS_ALL 0x007f0000
560 #define TRACE_LAYER_LC 0x00050000
561 #define TRACE_LAYER_LM 0x00060000
562 #define TRACE_LAYER_HCI 0x00070000
563 #define TRACE_LAYER_L2CAP 0x00080000
564 #define TRACE_LAYER_RFCOMM 0x00090000
565 #define TRACE_LAYER_SDP 0x000a0000
566 #define TRACE_LAYER_TCS 0x000b0000
567 #define TRACE_LAYER_OBEX 0x000c0000
568 #define TRACE_LAYER_BTM 0x000d0000
569 #define TRACE_LAYER_GAP 0x000e0000
570 #define TRACE_LAYER_ICP 0x00110000
571 #define TRACE_LAYER_HSP2 0x00120000
572 #define TRACE_LAYER_SPP 0x00130000
573 #define TRACE_LAYER_CTP 0x00140000
574 #define TRACE_LAYER_BPP 0x00150000
575 #define TRACE_LAYER_HCRP 0x00160000
576 #define TRACE_LAYER_FTP 0x00170000
577 #define TRACE_LAYER_OPP 0x00180000
578 #define TRACE_LAYER_BTU 0x00190000
579 #define TRACE_LAYER_GKI 0x001a0000 /* OBSOLETED */
580 #define TRACE_LAYER_BNEP 0x001b0000
581 #define TRACE_LAYER_PAN 0x001c0000
582 #define TRACE_LAYER_HFP 0x001d0000
583 #define TRACE_LAYER_HID 0x001e0000
584 #define TRACE_LAYER_BIP 0x001f0000
585 #define TRACE_LAYER_AVP 0x00200000
586 #define TRACE_LAYER_A2D 0x00210000
587 #define TRACE_LAYER_SAP 0x00220000
588 #define TRACE_LAYER_AMP 0x00230000
589 #define TRACE_LAYER_MCA 0x00240000
590 #define TRACE_LAYER_ATT 0x00250000
591 #define TRACE_LAYER_SMP 0x00260000
592 #define TRACE_LAYER_NFC 0x00270000
593 #define TRACE_LAYER_NCI 0x00280000
594 #define TRACE_LAYER_LLCP 0x00290000
595 #define TRACE_LAYER_NDEF 0x002a0000
596 #define TRACE_LAYER_RW 0x002b0000
597 #define TRACE_LAYER_CE 0x002c0000
598 #define TRACE_LAYER_P2P 0x002d0000
599 #define TRACE_LAYER_SNEP 0x002e0000
600 #define TRACE_LAYER_CHO 0x002f0000
601 #define TRACE_LAYER_NFA 0x00300000
603 #define TRACE_LAYER_MAX_NUM 0x0031
606 /* TRACE_ORIGINATOR 0x0000^^00*/
607 #define TRACE_ORG_MASK 0x0000ff00
608 #define TRACE_GET_ORG(x) ((((UINT32)(x)) & TRACE_ORG_MASK) >> 8)
610 #define TRACE_ORG_STACK 0x00000000
611 #define TRACE_ORG_HCI_TRANS 0x00000100
612 #define TRACE_ORG_PROTO_DISP 0x00000200
613 #define TRACE_ORG_RPC 0x00000300
614 #define TRACE_ORG_GKI 0x00000400 /* OBSOLETED */
615 #define TRACE_ORG_APPL 0x00000500
616 #define TRACE_ORG_SCR_WRAPPER 0x00000600
617 #define TRACE_ORG_SCR_ENGINE 0x00000700
618 #define TRACE_ORG_USER_SCR 0x00000800
619 #define TRACE_ORG_TESTER 0x00000900
620 #define TRACE_ORG_MAX_NUM 10 /* 32-bit mask; must be < 32 */
621 #define TRACE_LITE_ORG_MAX_NUM 6
622 #define TRACE_ORG_ALL 0x03ff
623 #define TRACE_ORG_RPC_TRANS 0x04
625 #define TRACE_ORG_REG 0x00000909
626 #define TRACE_ORG_REG_SUCCESS 0x0000090a
628 /* TRACE_TYPE 0x000000^^*/
629 #define TRACE_TYPE_MASK 0x000000ff
630 #define TRACE_GET_TYPE(x) (((UINT32)(x)) & TRACE_TYPE_MASK)
632 #define TRACE_TYPE_ERROR 0x00000000
633 #define TRACE_TYPE_WARNING 0x00000001
634 #define TRACE_TYPE_API 0x00000002
635 #define TRACE_TYPE_EVENT 0x00000003
636 #define TRACE_TYPE_DEBUG 0x00000004
637 #define TRACE_TYPE_STACK_ONLY_MAX TRACE_TYPE_DEBUG
638 #define TRACE_TYPE_TX 0x00000005
639 #define TRACE_TYPE_RX 0x00000006
640 #define TRACE_TYPE_DEBUG_ASSERT 0x00000007
641 #define TRACE_TYPE_GENERIC 0x00000008
642 #define TRACE_TYPE_REG 0x00000009
643 #define TRACE_TYPE_REG_SUCCESS 0x0000000a
644 #define TRACE_TYPE_CMD_TX 0x0000000b
645 #define TRACE_TYPE_EVT_TX 0x0000000c
646 #define TRACE_TYPE_ACL_TX 0x0000000d
647 #define TRACE_TYPE_CMD_RX 0x0000000e
648 #define TRACE_TYPE_EVT_RX 0x0000000f
649 #define TRACE_TYPE_ACL_RX 0x00000010
650 #define TRACE_TYPE_TARGET_TRACE 0x00000011
651 #define TRACE_TYPE_SCO_TX 0x00000012
652 #define TRACE_TYPE_SCO_RX 0x00000013
655 #define TRACE_TYPE_MAX_NUM 20
656 #define TRACE_TYPE_ALL 0xffff
658 /* Define color for script type */
659 #define SCR_COLOR_DEFAULT 0
660 #define SCR_COLOR_TYPE_COMMENT 1
661 #define SCR_COLOR_TYPE_COMMAND 2
662 #define SCR_COLOR_TYPE_EVENT 3
663 #define SCR_COLOR_TYPE_SELECT 4
665 /* Define protocol trace flag values */
666 #define SCR_PROTO_TRACE_HCI_SUMMARY 0x00000001
667 #define SCR_PROTO_TRACE_HCI_DATA 0x00000002
668 #define SCR_PROTO_TRACE_L2CAP 0x00000004
669 #define SCR_PROTO_TRACE_RFCOMM 0x00000008
670 #define SCR_PROTO_TRACE_SDP 0x00000010
671 #define SCR_PROTO_TRACE_TCS 0x00000020
672 #define SCR_PROTO_TRACE_OBEX 0x00000040
673 #define SCR_PROTO_TRACE_OAPP 0x00000080 /* OBEX Application Profile */
674 #define SCR_PROTO_TRACE_AMP 0x00000100
675 #define SCR_PROTO_TRACE_BNEP 0x00000200
676 #define SCR_PROTO_TRACE_AVP 0x00000400
677 #define SCR_PROTO_TRACE_MCA 0x00000800
678 #define SCR_PROTO_TRACE_ATT 0x00001000
679 #define SCR_PROTO_TRACE_SMP 0x00002000
680 #define SCR_PROTO_TRACE_NCI 0x00004000
681 #define SCR_PROTO_TRACE_LLCP 0x00008000
682 #define SCR_PROTO_TRACE_NDEF 0x00010000
683 #define SCR_PROTO_TRACE_RW 0x00020000
684 #define SCR_PROTO_TRACE_CE 0x00040000
685 #define SCR_PROTO_TRACE_SNEP 0x00080000
686 #define SCR_PROTO_TRACE_CHO 0x00100000
687 #define SCR_PROTO_TRACE_ALL 0x001fffff
688 #define SCR_PROTO_TRACE_HCI_LOGGING_VSE 0x0800 /* Brcm vs event for logmsg and protocol traces */
690 #define MAX_SCRIPT_TYPE 5
692 #define TCS_PSM_INTERCOM 5
693 #define TCS_PSM_CORDLESS 7
694 #define BT_PSM_BNEP 0x000F
695 /* Define PSMs HID uses */
696 #define HID_PSM_CONTROL 0x0011
697 #define HID_PSM_INTERRUPT 0x0013
699 /* Define a function for logging */
700 typedef void (BT_LOG_FUNC) (int trace_type, const char *fmt_str, ...);
702 /* bd addr length and type */
704 #define BD_ADDR_LEN 6
705 typedef uint8_t BD_ADDR[BD_ADDR_LEN];
710 /*****************************************************************************
712 *****************************************************************************/
714 /* global constant for "any" bd addr */
715 static const BD_ADDR bd_addr_any = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
716 static const BD_ADDR bd_addr_null= {0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
718 /*****************************************************************************
720 *****************************************************************************/
722 /*******************************************************************************
726 ** Description Copy bd addr b to a.
731 *******************************************************************************/
732 static inline void bdcpy(BD_ADDR a, const BD_ADDR b)
736 for (i = BD_ADDR_LEN; i != 0; i--)
742 /*******************************************************************************
746 ** Description Compare bd addr b to a.
749 ** Returns Zero if b==a, nonzero otherwise (like memcmp).
751 *******************************************************************************/
752 static inline int bdcmp(const BD_ADDR a, const BD_ADDR b)
756 for (i = BD_ADDR_LEN; i != 0; i--)
766 /*******************************************************************************
770 ** Description Compare bd addr to "any" bd addr.
773 ** Returns Zero if a equals bd_addr_any.
775 *******************************************************************************/
776 static inline int bdcmpany(const BD_ADDR a)
778 return bdcmp(a, bd_addr_any);
781 /*******************************************************************************
785 ** Description Set bd addr to "any" bd addr.
790 *******************************************************************************/
791 static inline void bdsetany(BD_ADDR a)
793 bdcpy(a, bd_addr_any);
796 static inline bool is_sample_ltk(const BT_OCTET16 ltk) {
797 /* Sample LTK from BT Spec 5.1 | Vol 6, Part C 1
798 * 0x4C68384139F574D836BCF34E9DFB01BF */
799 const uint8_t SAMPLE_LTK[] = {0xbf, 0x01, 0xfb, 0x9d, 0x4e, 0xf3, 0xbc, 0x36,
800 0xd8, 0x74, 0xf5, 0x39, 0x41, 0x38, 0x68, 0x4c};
801 return memcmp(ltk, SAMPLE_LTK, BT_OCTET16_LEN) == 0;