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