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