bt_types.h revision f7a43fded30571221d9eace447afe2da19a2c211
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_NCI_VS        0x4200      /* Vendor specific message */
126#define BT_EVT_TO_NFC_MSGS          0x4300      /* messages between NFC and NCI task */
127
128#define BT_EVT_TO_NFCCSIM_NCI       0x4a00      /* events to NFCC simulation (NCI packets) */
129
130/* HCISU Events */
131
132#define BT_EVT_HCISU                0x5000
133
134#define BT_EVT_TO_HCISU_LP_APP_SLEEPING_EVT     (0x0005 | BT_EVT_HCISU)
135#define BT_EVT_TO_HCISU_LP_ALLOW_BT_SLEEP_EVT   (0x0006 | BT_EVT_HCISU)
136#define BT_EVT_TO_HCISU_LP_WAKEUP_HOST_EVT      (0x0007 | BT_EVT_HCISU)
137#define BT_EVT_TO_HCISU_LP_RCV_H4IBSS_EVT       (0x0008 | BT_EVT_HCISU)
138#define BT_EVT_TO_HCISU_H5_RESET_EVT            (0x0009 | BT_EVT_HCISU)
139#define BT_EVT_HCISU_START_QUICK_TIMER          (0x000a | BT_EVT_HCISU)
140
141/* HSP Events */
142
143#define BT_EVT_BTU_HSP2             0x6000
144
145#define BT_EVT_TO_BTU_HSP2_EVT     (0x0001 | BT_EVT_BTU_HSP2)
146
147/* BPP Events */
148#define BT_EVT_TO_BPP_PR_CMDS       0x6100      /* Printer Events */
149#define BT_EVT_TO_BPP_SND_CMDS      0x6200      /* BPP Sender Events */
150
151/* BIP Events */
152#define BT_EVT_TO_BIP_CMDS          0x6300
153
154/* HCRP Events */
155
156#define BT_EVT_BTU_HCRP             0x7000
157
158#define BT_EVT_TO_BTU_HCRP_EVT     (0x0001 | BT_EVT_BTU_HCRP)
159#define BT_EVT_TO_BTU_HCRPM_EVT    (0x0002 | BT_EVT_BTU_HCRP)
160
161
162#define BT_EVT_BTU_HFP              0x8000
163#define BT_EVT_TO_BTU_HFP_EVT      (0x0001 | BT_EVT_BTU_HFP)
164
165#define BT_EVT_BTU_IPC_EVT          0x9000
166#define BT_EVT_BTU_IPC_LOGMSG_EVT  (0x0000 | BT_EVT_BTU_IPC_EVT)
167#define BT_EVT_BTU_IPC_ACL_EVT     (0x0001 | BT_EVT_BTU_IPC_EVT)
168#define BT_EVT_BTU_IPC_BTU_EVT     (0x0002 | BT_EVT_BTU_IPC_EVT)
169#define BT_EVT_BTU_IPC_L2C_EVT     (0x0003 | BT_EVT_BTU_IPC_EVT)
170#define BT_EVT_BTU_IPC_L2C_MSG_EVT (0x0004 | BT_EVT_BTU_IPC_EVT)
171#define BT_EVT_BTU_IPC_BTM_EVT     (0x0005 | BT_EVT_BTU_IPC_EVT)
172#define BT_EVT_BTU_IPC_AVDT_EVT    (0x0006 | BT_EVT_BTU_IPC_EVT)
173#define BT_EVT_BTU_IPC_SLIP_EVT    (0x0007 | BT_EVT_BTU_IPC_EVT)
174#define BT_EVT_BTU_IPC_MGMT_EVT    (0x0008 | BT_EVT_BTU_IPC_EVT)
175#define BT_EVT_BTU_IPC_BTTRC_EVT   (0x0009 | BT_EVT_BTU_IPC_EVT)
176#define BT_EVT_BTU_IPC_BURST_EVT   (0x000A | BT_EVT_BTU_IPC_EVT)
177
178/* Define the header of each buffer used in the Bluetooth stack.
179*/
180typedef struct
181{
182    UINT16          event;
183    UINT16          len;
184    UINT16          offset;
185    UINT16          layer_specific;
186} BT_HDR;
187
188#define BT_HDR_SIZE (sizeof (BT_HDR))
189
190/* These macros extract the HCI opcodes from a buffer
191*/
192#define HCI_GET_CMD_HDR_OPCODE(p)    (UINT16)((*((UINT8 *)((p) + 1) + p->offset) + \
193                                              (*((UINT8 *)((p) + 1) + p->offset + 1) << 8)))
194#define HCI_GET_CMD_HDR_PARAM_LEN(p) (UINT8)  (*((UINT8 *)((p) + 1) + p->offset + 2))
195
196#define HCI_GET_EVT_HDR_OPCODE(p)    (UINT8)(*((UINT8 *)((p) + 1) + p->offset))
197#define HCI_GET_EVT_HDR_PARAM_LEN(p) (UINT8)  (*((UINT8 *)((p) + 1) + p->offset + 1))
198
199
200/********************************************************************************
201** Macros to get and put bytes to and from a stream (Little Endian format).
202*/
203#define UINT32_TO_STREAM(p, u32) {*(p)++ = (UINT8)(u32); *(p)++ = (UINT8)((u32) >> 8); *(p)++ = (UINT8)((u32) >> 16); *(p)++ = (UINT8)((u32) >> 24);}
204#define UINT24_TO_STREAM(p, u24) {*(p)++ = (UINT8)(u24); *(p)++ = (UINT8)((u24) >> 8); *(p)++ = (UINT8)((u24) >> 16);}
205#define UINT16_TO_STREAM(p, u16) {*(p)++ = (UINT8)(u16); *(p)++ = (UINT8)((u16) >> 8);}
206#define UINT8_TO_STREAM(p, u8)   {*(p)++ = (UINT8)(u8);}
207#define INT8_TO_STREAM(p, u8)    {*(p)++ = (INT8)(u8);}
208#define ARRAY32_TO_STREAM(p, a)  {register int ijk; for (ijk = 0; ijk < 32;           ijk++) *(p)++ = (UINT8) a[31 - ijk];}
209#define ARRAY16_TO_STREAM(p, a)  {register int ijk; for (ijk = 0; ijk < 16;           ijk++) *(p)++ = (UINT8) a[15 - ijk];}
210#define ARRAY8_TO_STREAM(p, a)   {register int ijk; for (ijk = 0; ijk < 8;            ijk++) *(p)++ = (UINT8) a[7 - ijk];}
211#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];}
212#define LAP_TO_STREAM(p, a)      {register int ijk; for (ijk = 0; ijk < LAP_LEN;      ijk++) *(p)++ = (UINT8) a[LAP_LEN - 1 - ijk];}
213#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];}
214#define ARRAY_TO_STREAM(p, a, len) {register int ijk; for (ijk = 0; ijk < len;        ijk++) *(p)++ = (UINT8) a[ijk];}
215#define REVERSE_ARRAY_TO_STREAM(p, a, len)  {register int ijk; for (ijk = 0; ijk < len; ijk++) *(p)++ = (UINT8) a[len - 1 - ijk];}
216
217#define STREAM_TO_UINT8(u8, p)   {u8 = (UINT8)(*(p)); (p) += 1;}
218#define STREAM_TO_UINT16(u16, p) {u16 = ((UINT16)(*(p)) + (((UINT16)(*((p) + 1))) << 8)); (p) += 2;}
219#define STREAM_TO_UINT24(u32, p) {u32 = (((UINT32)(*(p))) + ((((UINT32)(*((p) + 1)))) << 8) + ((((UINT32)(*((p) + 2)))) << 16) ); (p) += 3;}
220#define STREAM_TO_UINT32(u32, p) {u32 = (((UINT32)(*(p))) + ((((UINT32)(*((p) + 1)))) << 8) + ((((UINT32)(*((p) + 2)))) << 16) + ((((UINT32)(*((p) + 3)))) << 24)); (p) += 4;}
221#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++;}
222#define STREAM_TO_ARRAY32(a, p)  {register int ijk; register UINT8 *_pa = (UINT8 *)a + 31; for (ijk = 0; ijk < 32; ijk++) *_pa-- = *p++;}
223#define STREAM_TO_ARRAY16(a, p)  {register int ijk; register UINT8 *_pa = (UINT8 *)a + 15; for (ijk = 0; ijk < 16; ijk++) *_pa-- = *p++;}
224#define STREAM_TO_ARRAY8(a, p)   {register int ijk; register UINT8 *_pa = (UINT8 *)a + 7; for (ijk = 0; ijk < 8; ijk++) *_pa-- = *p++;}
225#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++;}
226#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++;}
227#define STREAM_TO_ARRAY(a, p, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) ((UINT8 *) a)[ijk] = *p++;}
228#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++;}
229
230/********************************************************************************
231** Macros to get and put bytes to and from a field (Little Endian format).
232** These are the same as to stream, except the pointer is not incremented.
233*/
234#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);}
235#define UINT24_TO_FIELD(p, u24) {*(UINT8 *)(p) = (UINT8)(u24); *((UINT8 *)(p)+1) = (UINT8)((u24) >> 8); *((UINT8 *)(p)+2) = (UINT8)((u24) >> 16);}
236#define UINT16_TO_FIELD(p, u16) {*(UINT8 *)(p) = (UINT8)(u16); *((UINT8 *)(p)+1) = (UINT8)((u16) >> 8);}
237#define UINT8_TO_FIELD(p, u8)   {*(UINT8 *)(p) = (UINT8)(u8);}
238
239
240/********************************************************************************
241** Macros to get and put bytes to and from a stream (Big Endian format)
242*/
243#define UINT32_TO_BE_STREAM(p, u32) {*(p)++ = (UINT8)((u32) >> 24);  *(p)++ = (UINT8)((u32) >> 16); *(p)++ = (UINT8)((u32) >> 8); *(p)++ = (UINT8)(u32); }
244#define UINT24_TO_BE_STREAM(p, u24) {*(p)++ = (UINT8)((u24) >> 16); *(p)++ = (UINT8)((u24) >> 8); *(p)++ = (UINT8)(u24);}
245#define UINT16_TO_BE_STREAM(p, u16) {*(p)++ = (UINT8)((u16) >> 8); *(p)++ = (UINT8)(u16);}
246#define UINT8_TO_BE_STREAM(p, u8)   {*(p)++ = (UINT8)(u8);}
247#define ARRAY_TO_BE_STREAM(p, a, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) *(p)++ = (UINT8) a[ijk];}
248
249#define BE_STREAM_TO_UINT8(u8, p)   {u8 = (UINT8)(*(p)); (p) += 1;}
250#define BE_STREAM_TO_UINT16(u16, p) {u16 = (UINT16)(((UINT16)(*(p)) << 8) + (UINT16)(*((p) + 1))); (p) += 2;}
251#define BE_STREAM_TO_UINT24(u32, p) {u32 = (((UINT32)(*((p) + 2))) + ((UINT32)(*((p) + 1)) << 8) + ((UINT32)(*(p)) << 16)); (p) += 3;}
252#define BE_STREAM_TO_UINT32(u32, p) {u32 = ((UINT32)(*((p) + 3)) + ((UINT32)(*((p) + 2)) << 8) + ((UINT32)(*((p) + 1)) << 16) + ((UINT32)(*(p)) << 24)); (p) += 4;}
253#define BE_STREAM_TO_ARRAY(p, a, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) ((UINT8 *) a)[ijk] = *p++;}
254
255
256/********************************************************************************
257** Macros to get and put bytes to and from a field (Big Endian format).
258** These are the same as to stream, except the pointer is not incremented.
259*/
260#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); }
261#define UINT24_TO_BE_FIELD(p, u24) {*(UINT8 *)(p) = (UINT8)((u24) >> 16); *((UINT8 *)(p)+1) = (UINT8)((u24) >> 8); *((UINT8 *)(p)+2) = (UINT8)(u24);}
262#define UINT16_TO_BE_FIELD(p, u16) {*(UINT8 *)(p) = (UINT8)((u16) >> 8); *((UINT8 *)(p)+1) = (UINT8)(u16);}
263#define UINT8_TO_BE_FIELD(p, u8)   {*(UINT8 *)(p) = (UINT8)(u8);}
264
265
266/* Common Bluetooth field definitions */
267#define BD_ADDR_LEN     6                   /* Device address length */
268typedef UINT8 BD_ADDR[BD_ADDR_LEN];         /* Device address */
269typedef UINT8 *BD_ADDR_PTR;                 /* Pointer to Device Address */
270
271#define BT_OCTET8_LEN    8
272typedef UINT8 BT_OCTET8[BT_OCTET8_LEN];   /* octet array: size 16 */
273
274#define LINK_KEY_LEN    16
275typedef UINT8 LINK_KEY[LINK_KEY_LEN];       /* Link Key */
276
277#define BT_OCTET16_LEN    16
278typedef UINT8 BT_OCTET16[BT_OCTET16_LEN];   /* octet array: size 16 */
279
280#define PIN_CODE_LEN    16
281typedef UINT8 PIN_CODE[PIN_CODE_LEN];       /* Pin Code (upto 128 bits) MSB is 0 */
282typedef UINT8 *PIN_CODE_PTR;                /* Pointer to Pin Code */
283
284#define DEV_CLASS_LEN   3
285typedef UINT8 DEV_CLASS[DEV_CLASS_LEN];     /* Device class */
286typedef UINT8 *DEV_CLASS_PTR;               /* Pointer to Device class */
287
288#define EXT_INQ_RESP_LEN   3
289typedef UINT8 EXT_INQ_RESP[EXT_INQ_RESP_LEN];/* Extended Inquiry Response */
290typedef UINT8 *EXT_INQ_RESP_PTR;             /* Pointer to Extended Inquiry Response */
291
292#define BD_NAME_LEN     248
293typedef UINT8 BD_NAME[BD_NAME_LEN + 1];         /* Device name */
294typedef UINT8 *BD_NAME_PTR;                 /* Pointer to Device name */
295
296#define BD_FEATURES_LEN 8
297typedef UINT8 BD_FEATURES[BD_FEATURES_LEN]; /* LMP features supported by device */
298
299#define BT_EVENT_MASK_LEN  8
300typedef UINT8 BT_EVENT_MASK[BT_EVENT_MASK_LEN];   /* Event Mask */
301
302#define LAP_LEN         3
303typedef UINT8 LAP[LAP_LEN];                 /* IAC as passed to Inquiry (LAP) */
304typedef UINT8 INQ_LAP[LAP_LEN];             /* IAC as passed to Inquiry (LAP) */
305
306#define RAND_NUM_LEN    16
307typedef UINT8 RAND_NUM[RAND_NUM_LEN];
308
309#define ACO_LEN         12
310typedef UINT8 ACO[ACO_LEN];                 /* Authenticated ciphering offset */
311
312#define COF_LEN         12
313typedef UINT8 COF[COF_LEN];                 /* ciphering offset number */
314
315typedef struct {
316    UINT8               qos_flags;          /* TBD */
317    UINT8               service_type;       /* see below */
318    UINT32              token_rate;         /* bytes/second */
319    UINT32              token_bucket_size;  /* bytes */
320    UINT32              peak_bandwidth;     /* bytes/second */
321    UINT32              latency;            /* microseconds */
322    UINT32              delay_variation;    /* microseconds */
323} FLOW_SPEC;
324
325/* Values for service_type */
326#define NO_TRAFFIC      0
327#define BEST_EFFORT     1
328#define GUARANTEED      2
329
330/* Service class of the CoD */
331#define SERV_CLASS_NETWORKING               (1 << 1)
332#define SERV_CLASS_RENDERING                (1 << 2)
333#define SERV_CLASS_CAPTURING                (1 << 3)
334#define SERV_CLASS_OBJECT_TRANSFER          (1 << 4)
335#define SERV_CLASS_OBJECT_AUDIO             (1 << 5)
336#define SERV_CLASS_OBJECT_TELEPHONY         (1 << 6)
337#define SERV_CLASS_OBJECT_INFORMATION       (1 << 7)
338
339/* Second byte */
340#define SERV_CLASS_LIMITED_DISC_MODE        (0x20)
341
342/* Field size definitions. Note that byte lengths are rounded up. */
343#define ACCESS_CODE_BIT_LEN             72
344#define ACCESS_CODE_BYTE_LEN            9
345#define SHORTENED_ACCESS_CODE_BIT_LEN   68
346
347typedef UINT8 ACCESS_CODE[ACCESS_CODE_BYTE_LEN];
348
349#define SYNTH_TX                1           /* want synth code to TRANSMIT at this freq */
350#define SYNTH_RX                2           /* want synth code to RECEIVE at this freq */
351
352#define SYNC_REPS 1             /* repeats of sync word transmitted to start of burst */
353
354/* Bluetooth CLK27 */
355#define BT_CLK27            (2 << 26)
356
357/* Bluetooth CLK12 is 1.28 sec */
358#define BT_CLK12_TO_MS(x)    ((x) * 1280)
359#define BT_MS_TO_CLK12(x)    ((x) / 1280)
360#define BT_CLK12_TO_SLOTS(x) ((x) << 11)
361
362/* Bluetooth CLK is 0.625 msec */
363#define BT_CLK_TO_MS(x)      (((x) * 5 + 3) / 8)
364#define BT_MS_TO_CLK(x)      (((x) * 8 + 2) / 5)
365
366#define BT_CLK_TO_MICROSECS(x)  (((x) * 5000 + 3) / 8)
367#define BT_MICROSECS_TO_CLK(x)  (((x) * 8 + 2499) / 5000)
368
369/* Maximum UUID size - 16 bytes, and structure to hold any type of UUID. */
370#define MAX_UUID_SIZE              16
371typedef struct
372{
373#define LEN_UUID_16     2
374#define LEN_UUID_32     4
375#define LEN_UUID_128    16
376
377    UINT16          len;
378
379    union
380    {
381        UINT16      uuid16;
382        UINT32      uuid32;
383        UINT8       uuid128[MAX_UUID_SIZE];
384    } uu;
385
386} tBT_UUID;
387
388#define BT_EIR_FLAGS_TYPE                   0x01
389#define BT_EIR_MORE_16BITS_UUID_TYPE        0x02
390#define BT_EIR_COMPLETE_16BITS_UUID_TYPE    0x03
391#define BT_EIR_MORE_32BITS_UUID_TYPE        0x04
392#define BT_EIR_COMPLETE_32BITS_UUID_TYPE    0x05
393#define BT_EIR_MORE_128BITS_UUID_TYPE       0x06
394#define BT_EIR_COMPLETE_128BITS_UUID_TYPE   0x07
395#define BT_EIR_SHORTENED_LOCAL_NAME_TYPE    0x08
396#define BT_EIR_COMPLETE_LOCAL_NAME_TYPE     0x09
397#define BT_EIR_TX_POWER_LEVEL_TYPE          0x0A
398#define BT_EIR_OOB_BD_ADDR_TYPE             0x0C
399#define BT_EIR_OOB_COD_TYPE                 0x0D
400#define BT_EIR_OOB_SSP_HASH_C_TYPE          0x0E
401#define BT_EIR_OOB_SSP_RAND_R_TYPE          0x0F
402#define BT_EIR_3D_SYNC_TYPE                 0x3D
403#define BT_EIR_MANUFACTURER_SPECIFIC_TYPE   0xFF
404
405#define BT_OOB_COD_SIZE            3
406#define BT_OOB_HASH_C_SIZE         16
407#define BT_OOB_RAND_R_SIZE         16
408
409/* Broadcom proprietary UUIDs and reserved PSMs
410**
411** The lowest 4 bytes byte of the UUID or GUID depends on the feature. Typically,
412** the value of those bytes will be the PSM or SCN, but it is up to the features.
413*/
414#define BRCM_PROPRIETARY_UUID_BASE  0xDA, 0x23, 0x41, 0x02, 0xA3, 0xBB, 0xC1, 0x71, 0xBA, 0x09, 0x6f, 0x21
415#define BRCM_PROPRIETARY_GUID_BASE  0xda23, 0x4102, 0xa3, 0xbb, 0xc1, 0x71, 0xba, 0x09, 0x6f, 0x21
416
417/* We will not allocate a PSM in the reserved range to 3rd party apps
418*/
419#define BRCM_RESERVED_PSM_START	    0x5AE1
420#define BRCM_RESERVED_PSM_END	    0x5AFF
421
422#define BRCM_UTILITY_SERVICE_PSM    0x5AE1
423#define BRCM_MATCHER_PSM            0x5AE3
424
425/* Define trace levels */
426#define BT_TRACE_LEVEL_NONE    0          /* No trace messages to be generated    */
427#define BT_TRACE_LEVEL_ERROR   1          /* Error condition trace messages       */
428#define BT_TRACE_LEVEL_WARNING 2          /* Warning condition trace messages     */
429#define BT_TRACE_LEVEL_API     3          /* API traces                           */
430#define BT_TRACE_LEVEL_EVENT   4          /* Debug messages for events            */
431#define BT_TRACE_LEVEL_DEBUG   5          /* Full debug messages                  */
432
433#define MAX_TRACE_LEVEL        5
434
435
436/* Define New Trace Type Definition */
437/* TRACE_CTRL_TYPE                  0x^^000000*/
438#define TRACE_CTRL_MASK             0xff000000
439#define TRACE_GET_CTRL(x)           ((((UINT32)(x)) & TRACE_CTRL_MASK) >> 24)
440
441#define TRACE_CTRL_GENERAL          0x00000000
442#define TRACE_CTRL_STR_RESOURCE     0x01000000
443#define TRACE_CTRL_SEQ_FLOW         0x02000000
444#define TRACE_CTRL_MAX_NUM          3
445
446/* LAYER SPECIFIC                   0x00^^0000*/
447#define TRACE_LAYER_MASK            0x00ff0000
448#define TRACE_GET_LAYER(x)          ((((UINT32)(x)) & TRACE_LAYER_MASK) >> 16)
449
450#define TRACE_LAYER_NONE            0x00000000
451#define TRACE_LAYER_USB             0x00010000
452#define TRACE_LAYER_SERIAL          0x00020000
453#define TRACE_LAYER_SOCKET          0x00030000
454#define TRACE_LAYER_HCI             0x00070000
455#define TRACE_LAYER_BTU             0x00190000
456#define TRACE_LAYER_GKI             0x001a0000
457#define TRACE_LAYER_NFC             0x00270000
458#define TRACE_LAYER_NCI             0x00280000 /*it's overwritten in nfc_types.h*/
459#define TRACE_LAYER_LLCP            0x00290000
460#define TRACE_LAYER_NDEF            0x002a0000
461#define TRACE_LAYER_RW              0x002b0000
462#define TRACE_LAYER_CE              0x002c0000
463#define TRACE_LAYER_P2P             0x002d0000
464#define TRACE_LAYER_SNEP            0x002e0000
465#define TRACE_LAYER_CHO             0x002f0000
466#define TRACE_LAYER_NFA             0x00300000
467#define TRACE_LAYER_HAL             0x00310000 /*it's overwritten in nfc_types.h*/
468#define TRACE_LAYER_MAX_NUM         0x0032
469
470
471/* TRACE_ORIGINATOR                 0x0000^^00*/
472#define TRACE_ORG_MASK              0x0000ff00
473#define TRACE_GET_ORG(x)            ((((UINT32)(x)) & TRACE_ORG_MASK) >> 8)
474
475#define TRACE_ORG_STACK             0x00000000
476#define TRACE_ORG_HCI_TRANS         0x00000100
477#define TRACE_ORG_PROTO_DISP        0x00000200
478#define TRACE_ORG_RPC               0x00000300
479#define TRACE_ORG_GKI               0x00000400
480#define TRACE_ORG_APPL              0x00000500
481#define TRACE_ORG_SCR_WRAPPER       0x00000600
482#define TRACE_ORG_SCR_ENGINE        0x00000700
483#define TRACE_ORG_USER_SCR          0x00000800
484#define TRACE_ORG_TESTER            0x00000900
485#define TRACE_ORG_MAX_NUM           10          /* 32-bit mask; must be < 32 */
486#define TRACE_LITE_ORG_MAX_NUM		6
487#define TRACE_ORG_ALL               0x03ff
488#define TRACE_ORG_RPC_TRANS         0x04
489
490#define TRACE_ORG_REG               0x00000909
491#define TRACE_ORG_REG_SUCCESS       0x0000090a
492
493/* TRACE_TYPE                       0x000000^^*/
494#define TRACE_TYPE_MASK             0x000000ff
495#define TRACE_GET_TYPE(x)           (((UINT32)(x)) & TRACE_TYPE_MASK)
496
497#define TRACE_TYPE_ERROR            0x00000000
498#define TRACE_TYPE_WARNING          0x00000001
499#define TRACE_TYPE_API              0x00000002
500#define TRACE_TYPE_EVENT            0x00000003
501#define TRACE_TYPE_DEBUG            0x00000004
502#define TRACE_TYPE_STACK_ONLY_MAX   TRACE_TYPE_DEBUG
503#define TRACE_TYPE_TX               0x00000005
504#define TRACE_TYPE_RX               0x00000006
505#define TRACE_TYPE_DEBUG_ASSERT     0x00000007
506#define TRACE_TYPE_GENERIC          0x00000008
507#define TRACE_TYPE_REG              0x00000009
508#define TRACE_TYPE_REG_SUCCESS      0x0000000a
509#define TRACE_TYPE_CMD_TX           0x0000000b
510#define TRACE_TYPE_EVT_TX           0x0000000c
511#define TRACE_TYPE_ACL_TX           0x0000000d
512#define TRACE_TYPE_CMD_RX           0x0000000e
513#define TRACE_TYPE_EVT_RX           0x0000000f
514#define TRACE_TYPE_ACL_RX           0x00000010
515#define TRACE_TYPE_TARGET_TRACE     0x00000011
516
517#define TRACE_TYPE_MAX_NUM          20
518#define TRACE_TYPE_ALL              0xffff
519
520/* Define protocol trace flag values */
521#define SCR_PROTO_TRACE_HCI_SUMMARY 0x00000001
522#define SCR_PROTO_TRACE_NCI         0x00004000
523#define SCR_PROTO_TRACE_ALL         0x001fffff
524#define SCR_PROTO_TRACE_HCI_LOGGING_VSE 0x0800 /* Brcm vs event for logmsg and protocol traces */
525
526#define MAX_SCRIPT_TYPE             5
527
528/* Define a function for logging */
529typedef void (BT_LOG_FUNC) (int trace_type, const char *fmt_str, ...);
530
531#endif
532
533