Home | History | Annotate | Download | only in include
      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 #define BT_EVT_DATA_TO_AMP_1        0x5100
    142 #define BT_EVT_DATA_TO_AMP_15       0x5f00
    143 
    144 /* HSP Events */
    145 
    146 #define BT_EVT_BTU_HSP2             0x6000
    147 
    148 #define BT_EVT_TO_BTU_HSP2_EVT     (0x0001 | BT_EVT_BTU_HSP2)
    149 
    150 /* BPP Events */
    151 #define BT_EVT_TO_BPP_PR_CMDS       0x6100      /* Printer Events */
    152 #define BT_EVT_TO_BPP_SND_CMDS      0x6200      /* BPP Sender Events */
    153 
    154 /* BIP Events */
    155 #define BT_EVT_TO_BIP_CMDS          0x6300
    156 
    157 /* HCRP Events */
    158 
    159 #define BT_EVT_BTU_HCRP             0x7000
    160 
    161 #define BT_EVT_TO_BTU_HCRP_EVT     (0x0001 | BT_EVT_BTU_HCRP)
    162 #define BT_EVT_TO_BTU_HCRPM_EVT    (0x0002 | BT_EVT_BTU_HCRP)
    163 
    164 
    165 #define BT_EVT_BTU_HFP              0x8000
    166 #define BT_EVT_TO_BTU_HFP_EVT      (0x0001 | BT_EVT_BTU_HFP)
    167 
    168 #define BT_EVT_BTU_IPC_EVT          0x9000
    169 #define BT_EVT_BTU_IPC_LOGMSG_EVT  (0x0000 | BT_EVT_BTU_IPC_EVT)
    170 #define BT_EVT_BTU_IPC_ACL_EVT     (0x0001 | BT_EVT_BTU_IPC_EVT)
    171 #define BT_EVT_BTU_IPC_BTU_EVT     (0x0002 | BT_EVT_BTU_IPC_EVT)
    172 #define BT_EVT_BTU_IPC_L2C_EVT     (0x0003 | BT_EVT_BTU_IPC_EVT)
    173 #define BT_EVT_BTU_IPC_L2C_MSG_EVT (0x0004 | BT_EVT_BTU_IPC_EVT)
    174 #define BT_EVT_BTU_IPC_BTM_EVT     (0x0005 | BT_EVT_BTU_IPC_EVT)
    175 #define BT_EVT_BTU_IPC_AVDT_EVT    (0x0006 | BT_EVT_BTU_IPC_EVT)
    176 #define BT_EVT_BTU_IPC_SLIP_EVT    (0x0007 | BT_EVT_BTU_IPC_EVT)
    177 #define BT_EVT_BTU_IPC_MGMT_EVT    (0x0008 | BT_EVT_BTU_IPC_EVT)
    178 #define BT_EVT_BTU_IPC_BTTRC_EVT   (0x0009 | BT_EVT_BTU_IPC_EVT)
    179 #define BT_EVT_BTU_IPC_BURST_EVT   (0x000A | BT_EVT_BTU_IPC_EVT)
    180 
    181 /* Define the header of each buffer used in the Bluetooth stack.
    182 */
    183 typedef struct
    184 {
    185     UINT16          event;
    186     UINT16          len;
    187     UINT16          offset;
    188     UINT16          layer_specific;
    189 } BT_HDR;
    190 
    191 #define BT_HDR_SIZE (sizeof (BT_HDR))
    192 
    193 #define BT_PSM_SDP                      0x0001
    194 #define BT_PSM_RFCOMM                   0x0003
    195 #define BT_PSM_TCS                      0x0005
    196 #define BT_PSM_CTP                      0x0007
    197 #define BT_PSM_BNEP                     0x000F
    198 #define BT_PSM_HIDC                     0x0011
    199 #define BT_PSM_HIDI                     0x0013
    200 #define BT_PSM_UPNP                     0x0015
    201 #define BT_PSM_AVCTP                    0x0017
    202 #define BT_PSM_AVDTP                    0x0019
    203 #define BT_PSM_AVCTP_13                 0x001B /* Advanced Control - Browsing */
    204 #define BT_PSM_UDI_CP                   0x001D /* Unrestricted Digital Information Profile C-Plane  */
    205 #define BT_PSM_ATT                      0x001F /* Attribute Protocol  */
    206 #define BT_PSM_3DS                      0x0021 /* 3D sync */
    207 
    208 
    209 /* These macros extract the HCI opcodes from a buffer
    210 */
    211 #define HCI_GET_CMD_HDR_OPCODE(p)    (UINT16)((*((UINT8 *)((p) + 1) + p->offset) + \
    212                                               (*((UINT8 *)((p) + 1) + p->offset + 1) << 8)))
    213 #define HCI_GET_CMD_HDR_PARAM_LEN(p) (UINT8)  (*((UINT8 *)((p) + 1) + p->offset + 2))
    214 
    215 #define HCI_GET_EVT_HDR_OPCODE(p)    (UINT8)(*((UINT8 *)((p) + 1) + p->offset))
    216 #define HCI_GET_EVT_HDR_PARAM_LEN(p) (UINT8)  (*((UINT8 *)((p) + 1) + p->offset + 1))
    217 
    218 
    219 /********************************************************************************
    220 ** Macros to get and put bytes to and from a stream (Little Endian format).
    221 */
    222 #define UINT32_TO_STREAM(p, u32) {*(p)++ = (UINT8)(u32); *(p)++ = (UINT8)((u32) >> 8); *(p)++ = (UINT8)((u32) >> 16); *(p)++ = (UINT8)((u32) >> 24);}
    223 #define UINT24_TO_STREAM(p, u24) {*(p)++ = (UINT8)(u24); *(p)++ = (UINT8)((u24) >> 8); *(p)++ = (UINT8)((u24) >> 16);}
    224 #define UINT16_TO_STREAM(p, u16) {*(p)++ = (UINT8)(u16); *(p)++ = (UINT8)((u16) >> 8);}
    225 #define UINT8_TO_STREAM(p, u8)   {*(p)++ = (UINT8)(u8);}
    226 #define INT8_TO_STREAM(p, u8)    {*(p)++ = (INT8)(u8);}
    227 #define ARRAY32_TO_STREAM(p, a)  {register int ijk; for (ijk = 0; ijk < 32;           ijk++) *(p)++ = (UINT8) a[31 - ijk];}
    228 #define ARRAY16_TO_STREAM(p, a)  {register int ijk; for (ijk = 0; ijk < 16;           ijk++) *(p)++ = (UINT8) a[15 - ijk];}
    229 #define ARRAY8_TO_STREAM(p, a)   {register int ijk; for (ijk = 0; ijk < 8;            ijk++) *(p)++ = (UINT8) a[7 - ijk];}
    230 #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];}
    231 #define LAP_TO_STREAM(p, a)      {register int ijk; for (ijk = 0; ijk < LAP_LEN;      ijk++) *(p)++ = (UINT8) a[LAP_LEN - 1 - ijk];}
    232 #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];}
    233 #define ARRAY_TO_STREAM(p, a, len) {register int ijk; for (ijk = 0; ijk < len;        ijk++) *(p)++ = (UINT8) a[ijk];}
    234 #define REVERSE_ARRAY_TO_STREAM(p, a, len)  {register int ijk; for (ijk = 0; ijk < len; ijk++) *(p)++ = (UINT8) a[len - 1 - ijk];}
    235 
    236 #define STREAM_TO_UINT8(u8, p)   {u8 = (UINT8)(*(p)); (p) += 1;}
    237 #define STREAM_TO_UINT16(u16, p) {u16 = ((UINT16)(*(p)) + (((UINT16)(*((p) + 1))) << 8)); (p) += 2;}
    238 #define STREAM_TO_UINT24(u32, p) {u32 = (((UINT32)(*(p))) + ((((UINT32)(*((p) + 1)))) << 8) + ((((UINT32)(*((p) + 2)))) << 16) ); (p) += 3;}
    239 #define STREAM_TO_UINT32(u32, p) {u32 = (((UINT32)(*(p))) + ((((UINT32)(*((p) + 1)))) << 8) + ((((UINT32)(*((p) + 2)))) << 16) + ((((UINT32)(*((p) + 3)))) << 24)); (p) += 4;}
    240 #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++;}
    241 #define STREAM_TO_ARRAY32(a, p)  {register int ijk; register UINT8 *_pa = (UINT8 *)a + 31; for (ijk = 0; ijk < 32; ijk++) *_pa-- = *p++;}
    242 #define STREAM_TO_ARRAY16(a, p)  {register int ijk; register UINT8 *_pa = (UINT8 *)a + 15; for (ijk = 0; ijk < 16; ijk++) *_pa-- = *p++;}
    243 #define STREAM_TO_ARRAY8(a, p)   {register int ijk; register UINT8 *_pa = (UINT8 *)a + 7; for (ijk = 0; ijk < 8; ijk++) *_pa-- = *p++;}
    244 #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++;}
    245 #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++;}
    246 #define STREAM_TO_ARRAY(a, p, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) ((UINT8 *) a)[ijk] = *p++;}
    247 #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++;}
    248 
    249 /********************************************************************************
    250 ** Macros to get and put bytes to and from a field (Little Endian format).
    251 ** These are the same as to stream, except the pointer is not incremented.
    252 */
    253 #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);}
    254 #define UINT24_TO_FIELD(p, u24) {*(UINT8 *)(p) = (UINT8)(u24); *((UINT8 *)(p)+1) = (UINT8)((u24) >> 8); *((UINT8 *)(p)+2) = (UINT8)((u24) >> 16);}
    255 #define UINT16_TO_FIELD(p, u16) {*(UINT8 *)(p) = (UINT8)(u16); *((UINT8 *)(p)+1) = (UINT8)((u16) >> 8);}
    256 #define UINT8_TO_FIELD(p, u8)   {*(UINT8 *)(p) = (UINT8)(u8);}
    257 
    258 
    259 /********************************************************************************
    260 ** Macros to get and put bytes to and from a stream (Big Endian format)
    261 */
    262 #define UINT32_TO_BE_STREAM(p, u32) {*(p)++ = (UINT8)((u32) >> 24);  *(p)++ = (UINT8)((u32) >> 16); *(p)++ = (UINT8)((u32) >> 8); *(p)++ = (UINT8)(u32); }
    263 #define UINT24_TO_BE_STREAM(p, u24) {*(p)++ = (UINT8)((u24) >> 16); *(p)++ = (UINT8)((u24) >> 8); *(p)++ = (UINT8)(u24);}
    264 #define UINT16_TO_BE_STREAM(p, u16) {*(p)++ = (UINT8)((u16) >> 8); *(p)++ = (UINT8)(u16);}
    265 #define UINT8_TO_BE_STREAM(p, u8)   {*(p)++ = (UINT8)(u8);}
    266 #define ARRAY_TO_BE_STREAM(p, a, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) *(p)++ = (UINT8) a[ijk];}
    267 
    268 #define BE_STREAM_TO_UINT8(u8, p)   {u8 = (UINT8)(*(p)); (p) += 1;}
    269 #define BE_STREAM_TO_UINT16(u16, p) {u16 = (UINT16)(((UINT16)(*(p)) << 8) + (UINT16)(*((p) + 1))); (p) += 2;}
    270 #define BE_STREAM_TO_UINT24(u32, p) {u32 = (((UINT32)(*((p) + 2))) + ((UINT32)(*((p) + 1)) << 8) + ((UINT32)(*(p)) << 16)); (p) += 3;}
    271 #define BE_STREAM_TO_UINT32(u32, p) {u32 = ((UINT32)(*((p) + 3)) + ((UINT32)(*((p) + 2)) << 8) + ((UINT32)(*((p) + 1)) << 16) + ((UINT32)(*(p)) << 24)); (p) += 4;}
    272 #define BE_STREAM_TO_ARRAY(p, a, len) {register int ijk; for (ijk = 0; ijk < len; ijk++) ((UINT8 *) a)[ijk] = *p++;}
    273 
    274 
    275 /********************************************************************************
    276 ** Macros to get and put bytes to and from a field (Big Endian format).
    277 ** These are the same as to stream, except the pointer is not incremented.
    278 */
    279 #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); }
    280 #define UINT24_TO_BE_FIELD(p, u24) {*(UINT8 *)(p) = (UINT8)((u24) >> 16); *((UINT8 *)(p)+1) = (UINT8)((u24) >> 8); *((UINT8 *)(p)+2) = (UINT8)(u24);}
    281 #define UINT16_TO_BE_FIELD(p, u16) {*(UINT8 *)(p) = (UINT8)((u16) >> 8); *((UINT8 *)(p)+1) = (UINT8)(u16);}
    282 #define UINT8_TO_BE_FIELD(p, u8)   {*(UINT8 *)(p) = (UINT8)(u8);}
    283 
    284 
    285 /* Common Bluetooth field definitions */
    286 #define BD_ADDR_LEN     6                   /* Device address length */
    287 typedef UINT8 BD_ADDR[BD_ADDR_LEN];         /* Device address */
    288 typedef UINT8 *BD_ADDR_PTR;                 /* Pointer to Device Address */
    289 
    290 #define AMP_KEY_TYPE_GAMP       0
    291 #define AMP_KEY_TYPE_WIFI       1
    292 #define AMP_KEY_TYPE_UWB        2
    293 typedef UINT8 tAMP_KEY_TYPE;
    294 
    295 #define BT_OCTET8_LEN    8
    296 typedef UINT8 BT_OCTET8[BT_OCTET8_LEN];   /* octet array: size 16 */
    297 
    298 #define LINK_KEY_LEN    16
    299 typedef UINT8 LINK_KEY[LINK_KEY_LEN];       /* Link Key */
    300 
    301 #define AMP_LINK_KEY_LEN        32
    302 typedef UINT8 AMP_LINK_KEY[AMP_LINK_KEY_LEN];   /* Dedicated AMP and GAMP Link Keys */
    303 
    304 #define BT_OCTET16_LEN    16
    305 typedef UINT8 BT_OCTET16[BT_OCTET16_LEN];   /* octet array: size 16 */
    306 
    307 #define PIN_CODE_LEN    16
    308 typedef UINT8 PIN_CODE[PIN_CODE_LEN];       /* Pin Code (upto 128 bits) MSB is 0 */
    309 typedef UINT8 *PIN_CODE_PTR;                /* Pointer to Pin Code */
    310 
    311 #define DEV_CLASS_LEN   3
    312 typedef UINT8 DEV_CLASS[DEV_CLASS_LEN];     /* Device class */
    313 typedef UINT8 *DEV_CLASS_PTR;               /* Pointer to Device class */
    314 
    315 #define EXT_INQ_RESP_LEN   3
    316 typedef UINT8 EXT_INQ_RESP[EXT_INQ_RESP_LEN];/* Extended Inquiry Response */
    317 typedef UINT8 *EXT_INQ_RESP_PTR;             /* Pointer to Extended Inquiry Response */
    318 
    319 #define BD_NAME_LEN     248
    320 typedef UINT8 BD_NAME[BD_NAME_LEN + 1];         /* Device name */
    321 typedef UINT8 *BD_NAME_PTR;                 /* Pointer to Device name */
    322 
    323 #define BD_FEATURES_LEN 8
    324 typedef UINT8 BD_FEATURES[BD_FEATURES_LEN]; /* LMP features supported by device */
    325 
    326 #define BT_EVENT_MASK_LEN  8
    327 typedef UINT8 BT_EVENT_MASK[BT_EVENT_MASK_LEN];   /* Event Mask */
    328 
    329 #define LAP_LEN         3
    330 typedef UINT8 LAP[LAP_LEN];                 /* IAC as passed to Inquiry (LAP) */
    331 typedef UINT8 INQ_LAP[LAP_LEN];             /* IAC as passed to Inquiry (LAP) */
    332 
    333 #define RAND_NUM_LEN    16
    334 typedef UINT8 RAND_NUM[RAND_NUM_LEN];
    335 
    336 #define ACO_LEN         12
    337 typedef UINT8 ACO[ACO_LEN];                 /* Authenticated ciphering offset */
    338 
    339 #define COF_LEN         12
    340 typedef UINT8 COF[COF_LEN];                 /* ciphering offset number */
    341 
    342 typedef struct {
    343     UINT8               qos_flags;          /* TBD */
    344     UINT8               service_type;       /* see below */
    345     UINT32              token_rate;         /* bytes/second */
    346     UINT32              token_bucket_size;  /* bytes */
    347     UINT32              peak_bandwidth;     /* bytes/second */
    348     UINT32              latency;            /* microseconds */
    349     UINT32              delay_variation;    /* microseconds */
    350 } FLOW_SPEC;
    351 
    352 /* Values for service_type */
    353 #define NO_TRAFFIC      0
    354 #define BEST_EFFORT     1
    355 #define GUARANTEED      2
    356 
    357 /* Service class of the CoD */
    358 #define SERV_CLASS_NETWORKING               (1 << 1)
    359 #define SERV_CLASS_RENDERING                (1 << 2)
    360 #define SERV_CLASS_CAPTURING                (1 << 3)
    361 #define SERV_CLASS_OBJECT_TRANSFER          (1 << 4)
    362 #define SERV_CLASS_OBJECT_AUDIO             (1 << 5)
    363 #define SERV_CLASS_OBJECT_TELEPHONY         (1 << 6)
    364 #define SERV_CLASS_OBJECT_INFORMATION       (1 << 7)
    365 
    366 /* Second byte */
    367 #define SERV_CLASS_LIMITED_DISC_MODE        (0x20)
    368 
    369 /* Field size definitions. Note that byte lengths are rounded up. */
    370 #define ACCESS_CODE_BIT_LEN             72
    371 #define ACCESS_CODE_BYTE_LEN            9
    372 #define SHORTENED_ACCESS_CODE_BIT_LEN   68
    373 
    374 typedef UINT8 ACCESS_CODE[ACCESS_CODE_BYTE_LEN];
    375 
    376 #define SYNTH_TX                1           /* want synth code to TRANSMIT at this freq */
    377 #define SYNTH_RX                2           /* want synth code to RECEIVE at this freq */
    378 
    379 #define SYNC_REPS 1             /* repeats of sync word transmitted to start of burst */
    380 
    381 /* Bluetooth CLK27 */
    382 #define BT_CLK27            (2 << 26)
    383 
    384 /* Bluetooth CLK12 is 1.28 sec */
    385 #define BT_CLK12_TO_MS(x)    ((x) * 1280)
    386 #define BT_MS_TO_CLK12(x)    ((x) / 1280)
    387 #define BT_CLK12_TO_SLOTS(x) ((x) << 11)
    388 
    389 /* Bluetooth CLK is 0.625 msec */
    390 #define BT_CLK_TO_MS(x)      (((x) * 5 + 3) / 8)
    391 #define BT_MS_TO_CLK(x)      (((x) * 8 + 2) / 5)
    392 
    393 #define BT_CLK_TO_MICROSECS(x)  (((x) * 5000 + 3) / 8)
    394 #define BT_MICROSECS_TO_CLK(x)  (((x) * 8 + 2499) / 5000)
    395 
    396 /* Maximum UUID size - 16 bytes, and structure to hold any type of UUID. */
    397 #define MAX_UUID_SIZE              16
    398 typedef struct
    399 {
    400 #define LEN_UUID_16     2
    401 #define LEN_UUID_32     4
    402 #define LEN_UUID_128    16
    403 
    404     UINT16          len;
    405 
    406     union
    407     {
    408         UINT16      uuid16;
    409         UINT32      uuid32;
    410         UINT8       uuid128[MAX_UUID_SIZE];
    411     } uu;
    412 
    413 } tBT_UUID;
    414 
    415 #define BT_EIR_FLAGS_TYPE                   0x01
    416 #define BT_EIR_MORE_16BITS_UUID_TYPE        0x02
    417 #define BT_EIR_COMPLETE_16BITS_UUID_TYPE    0x03
    418 #define BT_EIR_MORE_32BITS_UUID_TYPE        0x04
    419 #define BT_EIR_COMPLETE_32BITS_UUID_TYPE    0x05
    420 #define BT_EIR_MORE_128BITS_UUID_TYPE       0x06
    421 #define BT_EIR_COMPLETE_128BITS_UUID_TYPE   0x07
    422 #define BT_EIR_SHORTENED_LOCAL_NAME_TYPE    0x08
    423 #define BT_EIR_COMPLETE_LOCAL_NAME_TYPE     0x09
    424 #define BT_EIR_TX_POWER_LEVEL_TYPE          0x0A
    425 #define BT_EIR_OOB_BD_ADDR_TYPE             0x0C
    426 #define BT_EIR_OOB_COD_TYPE                 0x0D
    427 #define BT_EIR_OOB_SSP_HASH_C_TYPE          0x0E
    428 #define BT_EIR_OOB_SSP_RAND_R_TYPE          0x0F
    429 #define BT_EIR_3D_SYNC_TYPE                 0x3D
    430 #define BT_EIR_MANUFACTURER_SPECIFIC_TYPE   0xFF
    431 
    432 #define BT_OOB_COD_SIZE            3
    433 #define BT_OOB_HASH_C_SIZE         16
    434 #define BT_OOB_RAND_R_SIZE         16
    435 
    436 /* Broadcom proprietary UUIDs and reserved PSMs
    437 **
    438 ** The lowest 4 bytes byte of the UUID or GUID depends on the feature. Typically,
    439 ** the value of those bytes will be the PSM or SCN, but it is up to the features.
    440 */
    441 #define BRCM_PROPRIETARY_UUID_BASE  0xDA, 0x23, 0x41, 0x02, 0xA3, 0xBB, 0xC1, 0x71, 0xBA, 0x09, 0x6f, 0x21
    442 #define BRCM_PROPRIETARY_GUID_BASE  0xda23, 0x4102, 0xa3, 0xbb, 0xc1, 0x71, 0xba, 0x09, 0x6f, 0x21
    443 
    444 /* We will not allocate a PSM in the reserved range to 3rd party apps
    445 */
    446 #define BRCM_RESERVED_PSM_START	    0x5AE1
    447 #define BRCM_RESERVED_PSM_END	    0x5AFF
    448 
    449 #define BRCM_UTILITY_SERVICE_PSM    0x5AE1
    450 #define BRCM_MATCHER_PSM            0x5AE3
    451 
    452 /* Connection statistics
    453 */
    454 
    455 /* Structure to hold connection stats */
    456 #ifndef BT_CONN_STATS_DEFINED
    457 #define BT_CONN_STATS_DEFINED
    458 
    459 /* These bits are used in the bIsConnected field */
    460 #define BT_CONNECTED_USING_BREDR   1
    461 #define BT_CONNECTED_USING_AMP     2
    462 
    463 typedef struct
    464 {
    465     UINT32   is_connected;
    466     INT32    rssi;
    467     UINT32   bytes_sent;
    468     UINT32   bytes_rcvd;
    469     UINT32   duration;
    470 } tBT_CONN_STATS;
    471 
    472 #endif
    473 
    474 /* AMP transport selection criteria definitions.
    475 ** NOTE: if underlying L2CAP connection uses basic mode than it can use only BR/EDR.
    476 **       For such L2CAP connections AMP connection the criteria provided by application
    477 **       is reset by AMP manager to AMP_USE_AMP_NEVER.
    478 */
    479 #define AMP_USE_AMP_NEVER                      0   /* Connection only via BR/EDR controller, no AMP allowed        */
    480 #define AMP_USE_AMP_IF_PEER_TRIES_IT           1   /* Allow AMP to be used if the peer tries to use it             */
    481 #define AMP_USE_AMP_IF_PHY_CONN_EXISTS         2   /* Use AMP if there is already a physical connection (default)  */
    482 #define AMP_USE_AMP_IF_LC_POWER_ON             3   /* Only try to use AMP if the Local Controller is powered on    */
    483 #define AMP_USE_AMP_IF_LC_AND_PEER_POWER_ON    4   /* Only try to use AMP if both LC and peer are powered on       */
    484 #define AMP_USE_AMP_IF_POSSIBLE                5   /* Try to use AMP if at all possible                            */
    485 #define AMP_USE_AMP_ONLY                       6   /* Only use AMP, never use BR/EDR                               */
    486 #define AMP_USE_AMP_MAX_DEF            AMP_USE_AMP_ONLY /* Maximum enum defined for AMP Criteria                        */
    487 
    488 #define	AMP_AUTOSWITCH_ALLOWED 		           0x80000000  /* flag to indicate that this connection is auto-switch ready */
    489 #define AMP_USE_CURRENT_CRITERIA               0xFFFFFFFF  /* Flag if previous criteria was to be still used        */
    490 
    491 typedef UINT32 tAMP_CRITERIA;
    492 
    493 
    494 /*****************************************************************************
    495 **                          Low Energy definitions
    496 **
    497 ** Address types
    498 */
    499 #define BLE_ADDR_PUBLIC         0x00
    500 #define BLE_ADDR_RANDOM         0x01
    501 #define BLE_ADDR_TYPE_MASK      (BLE_ADDR_RANDOM | BLE_ADDR_PUBLIC)
    502 typedef UINT8 tBLE_ADDR_TYPE;
    503 
    504 #define BLE_ADDR_IS_STATIC(x)   ((x[0] & 0xC0) == 0xC0)
    505 
    506 typedef struct
    507 {
    508     tBLE_ADDR_TYPE      type;
    509     BD_ADDR             bda;
    510 } tBLE_BD_ADDR;
    511 
    512 /* Device Types
    513 */
    514 #define BT_DEVICE_TYPE_BREDR   0x01
    515 #define BT_DEVICE_TYPE_BLE     0x02
    516 #define BT_DEVICE_TYPE_DUMO    0x03
    517 typedef UINT8 tBT_DEVICE_TYPE;
    518 /*****************************************************************************/
    519 
    520 
    521 /* Define trace levels */
    522 #define BT_TRACE_LEVEL_NONE    0          /* No trace messages to be generated    */
    523 #define BT_TRACE_LEVEL_ERROR   1          /* Error condition trace messages       */
    524 #define BT_TRACE_LEVEL_WARNING 2          /* Warning condition trace messages     */
    525 #define BT_TRACE_LEVEL_API     3          /* API traces                           */
    526 #define BT_TRACE_LEVEL_EVENT   4          /* Debug messages for events            */
    527 #define BT_TRACE_LEVEL_DEBUG   5          /* Full debug messages                  */
    528 
    529 #define MAX_TRACE_LEVEL        5
    530 
    531 
    532 /* Define New Trace Type Definition */
    533 /* TRACE_CTRL_TYPE                  0x^^000000*/
    534 #define TRACE_CTRL_MASK             0xff000000
    535 #define TRACE_GET_CTRL(x)           ((((UINT32)(x)) & TRACE_CTRL_MASK) >> 24)
    536 
    537 #define TRACE_CTRL_GENERAL          0x00000000
    538 #define TRACE_CTRL_STR_RESOURCE     0x01000000
    539 #define TRACE_CTRL_SEQ_FLOW         0x02000000
    540 #define TRACE_CTRL_MAX_NUM          3
    541 
    542 /* LAYER SPECIFIC                   0x00^^0000*/
    543 #define TRACE_LAYER_MASK            0x00ff0000
    544 #define TRACE_GET_LAYER(x)          ((((UINT32)(x)) & TRACE_LAYER_MASK) >> 16)
    545 
    546 #define TRACE_LAYER_NONE            0x00000000
    547 #define TRACE_LAYER_USB             0x00010000
    548 #define TRACE_LAYER_SERIAL          0x00020000
    549 #define TRACE_LAYER_SOCKET          0x00030000
    550 #define TRACE_LAYER_RS232           0x00040000
    551 #define TRACE_LAYER_TRANS_MAX_NUM   5
    552 #define TRACE_LAYER_TRANS_ALL       0x007f0000
    553 #define TRACE_LAYER_LC              0x00050000
    554 #define TRACE_LAYER_LM              0x00060000
    555 #define TRACE_LAYER_HCI             0x00070000
    556 #define TRACE_LAYER_L2CAP           0x00080000
    557 #define TRACE_LAYER_RFCOMM          0x00090000
    558 #define TRACE_LAYER_SDP             0x000a0000
    559 #define TRACE_LAYER_TCS             0x000b0000
    560 #define TRACE_LAYER_OBEX            0x000c0000
    561 #define TRACE_LAYER_BTM             0x000d0000
    562 #define TRACE_LAYER_GAP             0x000e0000
    563 #define TRACE_LAYER_DUN             0x000f0000
    564 #define TRACE_LAYER_GOEP            0x00100000
    565 #define TRACE_LAYER_ICP             0x00110000
    566 #define TRACE_LAYER_HSP2            0x00120000
    567 #define TRACE_LAYER_SPP             0x00130000
    568 #define TRACE_LAYER_CTP             0x00140000
    569 #define TRACE_LAYER_BPP             0x00150000
    570 #define TRACE_LAYER_HCRP            0x00160000
    571 #define TRACE_LAYER_FTP             0x00170000
    572 #define TRACE_LAYER_OPP             0x00180000
    573 #define TRACE_LAYER_BTU             0x00190000
    574 #define TRACE_LAYER_GKI             0x001a0000
    575 #define TRACE_LAYER_BNEP            0x001b0000
    576 #define TRACE_LAYER_PAN             0x001c0000
    577 #define TRACE_LAYER_HFP             0x001d0000
    578 #define TRACE_LAYER_HID             0x001e0000
    579 #define TRACE_LAYER_BIP             0x001f0000
    580 #define TRACE_LAYER_AVP             0x00200000
    581 #define TRACE_LAYER_A2D             0x00210000
    582 #define TRACE_LAYER_SAP             0x00220000
    583 #define TRACE_LAYER_AMP             0x00230000
    584 #define TRACE_LAYER_MCA             0x00240000
    585 #define TRACE_LAYER_ATT             0x00250000
    586 #define TRACE_LAYER_SMP             0x00260000
    587 #define TRACE_LAYER_NFC             0x00270000
    588 #define TRACE_LAYER_NCI             0x00280000 /*it's overwritten in nfc_types.h*/
    589 #define TRACE_LAYER_LLCP            0x00290000
    590 #define TRACE_LAYER_NDEF            0x002a0000
    591 #define TRACE_LAYER_RW              0x002b0000
    592 #define TRACE_LAYER_CE              0x002c0000
    593 #define TRACE_LAYER_P2P             0x002d0000
    594 #define TRACE_LAYER_SNEP            0x002e0000
    595 #define TRACE_LAYER_CHO             0x002f0000
    596 #define TRACE_LAYER_NFA             0x00300000
    597 #define TRACE_LAYER_HAL             0x00310000 /*it's overwritten in nfc_types.h*/
    598 #define TRACE_LAYER_MAX_NUM         0x0032
    599 
    600 
    601 /* TRACE_ORIGINATOR                 0x0000^^00*/
    602 #define TRACE_ORG_MASK              0x0000ff00
    603 #define TRACE_GET_ORG(x)            ((((UINT32)(x)) & TRACE_ORG_MASK) >> 8)
    604 
    605 #define TRACE_ORG_STACK             0x00000000
    606 #define TRACE_ORG_HCI_TRANS         0x00000100
    607 #define TRACE_ORG_PROTO_DISP        0x00000200
    608 #define TRACE_ORG_RPC               0x00000300
    609 #define TRACE_ORG_GKI               0x00000400
    610 #define TRACE_ORG_APPL              0x00000500
    611 #define TRACE_ORG_SCR_WRAPPER       0x00000600
    612 #define TRACE_ORG_SCR_ENGINE        0x00000700
    613 #define TRACE_ORG_USER_SCR          0x00000800
    614 #define TRACE_ORG_TESTER            0x00000900
    615 #define TRACE_ORG_MAX_NUM           10          /* 32-bit mask; must be < 32 */
    616 #define TRACE_LITE_ORG_MAX_NUM		6
    617 #define TRACE_ORG_ALL               0x03ff
    618 #define TRACE_ORG_RPC_TRANS         0x04
    619 
    620 #define TRACE_ORG_REG               0x00000909
    621 #define TRACE_ORG_REG_SUCCESS       0x0000090a
    622 
    623 /* TRACE_TYPE                       0x000000^^*/
    624 #define TRACE_TYPE_MASK             0x000000ff
    625 #define TRACE_GET_TYPE(x)           (((UINT32)(x)) & TRACE_TYPE_MASK)
    626 
    627 #define TRACE_TYPE_ERROR            0x00000000
    628 #define TRACE_TYPE_WARNING          0x00000001
    629 #define TRACE_TYPE_API              0x00000002
    630 #define TRACE_TYPE_EVENT            0x00000003
    631 #define TRACE_TYPE_DEBUG            0x00000004
    632 #define TRACE_TYPE_STACK_ONLY_MAX   TRACE_TYPE_DEBUG
    633 #define TRACE_TYPE_TX               0x00000005
    634 #define TRACE_TYPE_RX               0x00000006
    635 #define TRACE_TYPE_DEBUG_ASSERT     0x00000007
    636 #define TRACE_TYPE_GENERIC          0x00000008
    637 #define TRACE_TYPE_REG              0x00000009
    638 #define TRACE_TYPE_REG_SUCCESS      0x0000000a
    639 #define TRACE_TYPE_CMD_TX           0x0000000b
    640 #define TRACE_TYPE_EVT_TX           0x0000000c
    641 #define TRACE_TYPE_ACL_TX           0x0000000d
    642 #define TRACE_TYPE_CMD_RX           0x0000000e
    643 #define TRACE_TYPE_EVT_RX           0x0000000f
    644 #define TRACE_TYPE_ACL_RX           0x00000010
    645 #define TRACE_TYPE_TARGET_TRACE     0x00000011
    646 #define TRACE_TYPE_SCO_TX           0x00000012
    647 #define TRACE_TYPE_SCO_RX           0x00000013
    648 
    649 
    650 #define TRACE_TYPE_MAX_NUM          20
    651 #define TRACE_TYPE_ALL              0xffff
    652 
    653 /* Define color for script type */
    654 #define SCR_COLOR_DEFAULT       0
    655 #define SCR_COLOR_TYPE_COMMENT  1
    656 #define SCR_COLOR_TYPE_COMMAND  2
    657 #define SCR_COLOR_TYPE_EVENT    3
    658 #define SCR_COLOR_TYPE_SELECT   4
    659 
    660 /* Define protocol trace flag values */
    661 #define SCR_PROTO_TRACE_HCI_SUMMARY 0x00000001
    662 #define SCR_PROTO_TRACE_HCI_DATA    0x00000002
    663 #define SCR_PROTO_TRACE_L2CAP       0x00000004
    664 #define SCR_PROTO_TRACE_RFCOMM      0x00000008
    665 #define SCR_PROTO_TRACE_SDP         0x00000010
    666 #define SCR_PROTO_TRACE_TCS         0x00000020
    667 #define SCR_PROTO_TRACE_OBEX        0x00000040
    668 #define SCR_PROTO_TRACE_OAPP        0x00000080 /* OBEX Application Profile */
    669 #define SCR_PROTO_TRACE_AMP         0x00000100
    670 #define SCR_PROTO_TRACE_BNEP        0x00000200
    671 #define SCR_PROTO_TRACE_AVP         0x00000400
    672 #define SCR_PROTO_TRACE_MCA         0x00000800
    673 #define SCR_PROTO_TRACE_ATT         0x00001000
    674 #define SCR_PROTO_TRACE_SMP         0x00002000
    675 #define SCR_PROTO_TRACE_NCI         0x00004000
    676 #define SCR_PROTO_TRACE_LLCP        0x00008000
    677 #define SCR_PROTO_TRACE_NDEF        0x00010000
    678 #define SCR_PROTO_TRACE_RW          0x00020000
    679 #define SCR_PROTO_TRACE_CE          0x00040000
    680 #define SCR_PROTO_TRACE_SNEP        0x00080000
    681 #define SCR_PROTO_TRACE_CHO         0x00100000
    682 #define SCR_PROTO_TRACE_ALL         0x001fffff
    683 #define SCR_PROTO_TRACE_HCI_LOGGING_VSE 0x0800 /* Brcm vs event for logmsg and protocol traces */
    684 
    685 #define MAX_SCRIPT_TYPE             5
    686 
    687 #define TCS_PSM_INTERCOM        5
    688 #define TCS_PSM_CORDLESS        7
    689 #define BT_PSM_BNEP             0x000F
    690 /* Define PSMs HID uses */
    691 #define HID_PSM_CONTROL         0x0011
    692 #define HID_PSM_INTERRUPT       0x0013
    693 
    694 #if defined(UCD_HID_INCLUDED) && (UCD_HID_INCLUDED == TRUE)
    695 #define UCD_PSM_MIN     0x8001
    696 #define UCD_PSM_MAX     0x8003
    697 #define UCD_PSM_HID_CTRL 0x8001
    698 #define UCD_PSM_HID_INTR 0x8003
    699 #endif
    700 
    701 #if defined(HIDH_UCD_INCLUDED) && (HIDH_UCD_INCLUDED == TRUE)
    702 #define HID_UCD_PSM_CONTROL 0x8001
    703 #define HID_UCD_PSM_INTERRUPT 0x8003
    704 #endif
    705 
    706 /* Define a function for logging */
    707 typedef void (BT_LOG_FUNC) (int trace_type, const char *fmt_str, ...);
    708 
    709 #endif
    710 
    711