1 /****************************************************************************** 2 * 3 * Copyright 2003-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 /****************************************************************************** 20 * 21 * This is the public interface file for the BTA system manager. 22 * 23 ******************************************************************************/ 24 #ifndef BTA_SYS_H 25 #define BTA_SYS_H 26 27 #include "bt_common.h" 28 #include "bt_target.h" 29 #include "osi/include/alarm.h" 30 31 #include <base/logging.h> 32 #include <base/threading/thread.h> 33 34 /***************************************************************************** 35 * Constants and data types 36 ****************************************************************************/ 37 38 /* vendor specific event handler function type */ 39 typedef bool(tBTA_SYS_VS_EVT_HDLR)(uint16_t evt, void* p); 40 41 /* event handler function type */ 42 typedef bool(tBTA_SYS_EVT_HDLR)(BT_HDR* p_msg); 43 44 /* disable function type */ 45 typedef void(tBTA_SYS_DISABLE)(void); 46 47 /* HW modules */ 48 enum { 49 BTA_SYS_HW_BLUETOOTH, 50 BTA_SYS_HW_RT, 51 52 BTA_SYS_MAX_HW_MODULES 53 }; 54 55 typedef uint16_t tBTA_SYS_HW_MODULE; 56 57 #ifndef BTA_DM_NUM_JV_ID 58 #define BTA_DM_NUM_JV_ID 2 59 #endif 60 61 /* SW sub-systems */ 62 #define BTA_ID_SYS 0 /* system manager */ 63 /* BLUETOOTH PART - from 0 to BTA_ID_BLUETOOTH_MAX */ 64 #define BTA_ID_DM_SEARCH 2 /* device manager search */ 65 #define BTA_ID_DM_SEC 3 /* device manager security */ 66 #define BTA_ID_DG 4 /* data gateway */ 67 #define BTA_ID_AG 5 /* audio gateway */ 68 #define BTA_ID_OPC 6 /* object push client */ 69 #define BTA_ID_OPS 7 /* object push server */ 70 #define BTA_ID_FTS 8 /* file transfer server */ 71 #define BTA_ID_CT 9 /* cordless telephony terminal */ 72 #define BTA_ID_FTC 10 /* file transfer client */ 73 #define BTA_ID_SS 11 /* synchronization server */ 74 #define BTA_ID_PR 12 /* Printer client */ 75 #define BTA_ID_BIC 13 /* Basic Imaging Client */ 76 #define BTA_ID_PAN 14 /* Personal Area Networking */ 77 #define BTA_ID_BIS 15 /* Basic Imaging Server */ 78 #define BTA_ID_ACC 16 /* Advanced Camera Client */ 79 #define BTA_ID_SC 17 /* SIM Card Access server */ 80 #define BTA_ID_AV 18 /* Advanced audio/video */ 81 #define BTA_ID_AVK 19 /* Audio/video sink */ 82 #define BTA_ID_HD 20 /* HID Device */ 83 #define BTA_ID_CG 21 /* Cordless Gateway */ 84 #define BTA_ID_BP 22 /* Basic Printing Client */ 85 #define BTA_ID_HH 23 /* Human Interface Device Host */ 86 #define BTA_ID_PBS 24 /* Phone Book Access Server */ 87 #define BTA_ID_PBC 25 /* Phone Book Access Client */ 88 #define BTA_ID_JV 26 /* Java */ 89 #define BTA_ID_HS 27 /* Headset */ 90 #define BTA_ID_MSE 28 /* Message Server Equipment */ 91 #define BTA_ID_MCE 29 /* Message Client Equipment */ 92 #define BTA_ID_HL 30 /* Health Device Profile*/ 93 #define BTA_ID_GATTC 31 /* GATT Client */ 94 #define BTA_ID_GATTS 32 /* GATT Client */ 95 #define BTA_ID_SDP 33 /* SDP Client */ 96 #define BTA_ID_BLUETOOTH_MAX 34 /* last BT profile */ 97 98 /* GENERIC */ 99 #define BTA_ID_PRM 38 100 #define BTA_ID_SYSTEM 39 /* platform-specific */ 101 #define BTA_ID_SWRAP 40 /* Insight script wrapper */ 102 #define BTA_ID_MIP 41 /* Multicase Individual Polling */ 103 #define BTA_ID_RT 42 /* Audio Routing module: This module is always on. */ 104 #define BTA_ID_CLOSURE 43 /* Generic C++ closure */ 105 106 /* JV */ 107 #define BTA_ID_JV1 44 /* JV1 */ 108 #define BTA_ID_JV2 45 /* JV2 */ 109 110 #define BTA_ID_MAX (44 + BTA_DM_NUM_JV_ID) 111 112 typedef uint8_t tBTA_SYS_ID; 113 114 #define BTA_SYS_CONN_OPEN 0x00 115 #define BTA_SYS_CONN_CLOSE 0x01 116 #define BTA_SYS_APP_OPEN 0x02 117 #define BTA_SYS_APP_CLOSE 0x03 118 #define BTA_SYS_SCO_OPEN 0x04 119 #define BTA_SYS_SCO_CLOSE 0x05 120 #define BTA_SYS_CONN_IDLE 0x06 121 #define BTA_SYS_CONN_BUSY 0x07 122 123 /* for link policy */ 124 #define BTA_SYS_PLCY_SET 0x10 /* set the link policy to the given addr */ 125 #define BTA_SYS_PLCY_CLR 0x11 /* clear the link policy to the given addr */ 126 #define BTA_SYS_PLCY_DEF_SET 0x12 /* set the default link policy */ 127 #define BTA_SYS_PLCY_DEF_CLR 0x13 /* clear the default link policy */ 128 #define BTA_SYS_ROLE_CHANGE 0x14 /* role change */ 129 130 typedef uint8_t tBTA_SYS_CONN_STATUS; 131 132 /* Bitmask of sys features */ 133 #define BTA_SYS_FEAT_PCM2 0x0001 134 #define BTA_SYS_FEAT_PCM2_MASTER 0x0002 135 136 /* tBTA_PREF_ROLES */ 137 typedef uint8_t tBTA_SYS_PREF_ROLES; 138 139 /* conn callback for role / low power manager*/ 140 typedef void(tBTA_SYS_CONN_CBACK)(tBTA_SYS_CONN_STATUS status, uint8_t id, 141 uint8_t app_id, const RawAddress& peer_addr); 142 143 /* conn callback for role / low power manager*/ 144 typedef void(tBTA_SYS_SSR_CFG_CBACK)(uint8_t id, uint8_t app_id, 145 uint16_t latency, uint16_t tout); 146 147 #if (BTA_EIR_CANNED_UUID_LIST != TRUE) 148 /* eir callback for adding/removeing UUID */ 149 typedef void(tBTA_SYS_EIR_CBACK)(uint16_t uuid16, bool adding); 150 #endif 151 152 /* registration structure */ 153 typedef struct { 154 tBTA_SYS_EVT_HDLR* evt_hdlr; 155 tBTA_SYS_DISABLE* disable; 156 } tBTA_SYS_REG; 157 158 /* data type to send events to BTA SYS HW manager */ 159 typedef struct { 160 BT_HDR hdr; 161 tBTA_SYS_HW_MODULE hw_module; 162 } tBTA_SYS_HW_MSG; 163 164 typedef void (*tBTA_SYS_REGISTER)(uint8_t id, const tBTA_SYS_REG* p_reg); 165 166 /***************************************************************************** 167 * Global data 168 ****************************************************************************/ 169 170 /* trace level */ 171 extern uint8_t appl_trace_level; 172 173 /***************************************************************************** 174 * Macros 175 ****************************************************************************/ 176 177 /* Calculate start of event enumeration; id is top 8 bits of event */ 178 #define BTA_SYS_EVT_START(id) ((id) << 8) 179 180 /***************************************************************************** 181 * events for BTA SYS HW manager 182 ****************************************************************************/ 183 184 /* events sent to SYS HW manager - must be kept synchronized with tables in 185 * bta_sys_main.cc */ 186 enum { 187 /* device manager local device API events */ 188 BTA_SYS_API_ENABLE_EVT = BTA_SYS_EVT_START(BTA_ID_SYS), 189 BTA_SYS_EVT_ENABLED_EVT, 190 BTA_SYS_EVT_STACK_ENABLED_EVT, 191 BTA_SYS_API_DISABLE_EVT, 192 BTA_SYS_EVT_DISABLED_EVT, 193 BTA_SYS_ERROR_EVT, 194 195 BTA_SYS_MAX_EVT 196 }; 197 198 /* SYS HW status events - returned by SYS HW manager to other modules. */ 199 enum { 200 BTA_SYS_HW_OFF_EVT, 201 BTA_SYS_HW_ON_EVT, 202 BTA_SYS_HW_STARTING_EVT, 203 BTA_SYS_HW_STOPPING_EVT, 204 BTA_SYS_HW_ERROR_EVT 205 206 }; 207 typedef uint8_t tBTA_SYS_HW_EVT; 208 209 /* HW enable callback type */ 210 typedef void(tBTA_SYS_HW_CBACK)(tBTA_SYS_HW_EVT status); 211 212 /***************************************************************************** 213 * Function declarations 214 ****************************************************************************/ 215 216 extern void bta_sys_init(void); 217 extern void bta_sys_free(void); 218 extern void bta_sys_event(BT_HDR* p_msg); 219 extern void bta_sys_set_trace_level(uint8_t level); 220 extern void bta_sys_register(uint8_t id, const tBTA_SYS_REG* p_reg); 221 extern void bta_sys_deregister(uint8_t id); 222 extern bool bta_sys_is_register(uint8_t id); 223 extern uint16_t bta_sys_get_sys_features(void); 224 extern void bta_sys_sendmsg(void* p_msg); 225 extern void bta_sys_start_timer(alarm_t* alarm, uint64_t interval_ms, 226 uint16_t event, uint16_t layer_specific); 227 extern void bta_sys_disable(tBTA_SYS_HW_MODULE module); 228 229 extern void bta_sys_hw_register(tBTA_SYS_HW_MODULE module, 230 tBTA_SYS_HW_CBACK* cback); 231 extern void bta_sys_hw_unregister(tBTA_SYS_HW_MODULE module); 232 233 extern void bta_sys_rm_register(tBTA_SYS_CONN_CBACK* p_cback); 234 extern void bta_sys_pm_register(tBTA_SYS_CONN_CBACK* p_cback); 235 236 extern void bta_sys_policy_register(tBTA_SYS_CONN_CBACK* p_cback); 237 extern void bta_sys_sco_register(tBTA_SYS_CONN_CBACK* p_cback); 238 239 extern void bta_sys_conn_open(uint8_t id, uint8_t app_id, 240 const RawAddress& peer_addr); 241 extern void bta_sys_conn_close(uint8_t id, uint8_t app_id, 242 const RawAddress& peer_addr); 243 extern void bta_sys_app_open(uint8_t id, uint8_t app_id, 244 const RawAddress& peer_addr); 245 extern void bta_sys_app_close(uint8_t id, uint8_t app_id, 246 const RawAddress& peer_addr); 247 extern void bta_sys_sco_open(uint8_t id, uint8_t app_id, 248 const RawAddress& peer_addr); 249 extern void bta_sys_sco_close(uint8_t id, uint8_t app_id, 250 const RawAddress& peer_addr); 251 extern void bta_sys_sco_use(uint8_t id, uint8_t app_id, 252 const RawAddress& peer_addr); 253 extern void bta_sys_sco_unuse(uint8_t id, uint8_t app_id, 254 const RawAddress& peer_addr); 255 extern void bta_sys_idle(uint8_t id, uint8_t app_id, 256 const RawAddress& peer_addr); 257 extern void bta_sys_busy(uint8_t id, uint8_t app_id, 258 const RawAddress& peer_addr); 259 260 #if (BTM_SSR_INCLUDED == TRUE) 261 extern void bta_sys_ssr_cfg_register(tBTA_SYS_SSR_CFG_CBACK* p_cback); 262 extern void bta_sys_chg_ssr_config(uint8_t id, uint8_t app_id, 263 uint16_t max_latency, uint16_t min_tout); 264 #endif 265 266 extern void bta_sys_role_chg_register(tBTA_SYS_CONN_CBACK* p_cback); 267 extern void bta_sys_notify_role_chg(const RawAddress& peer_addr, 268 uint8_t new_role, uint8_t hci_status); 269 extern void bta_sys_collision_register(uint8_t bta_id, 270 tBTA_SYS_CONN_CBACK* p_cback); 271 extern void bta_sys_notify_collision(const RawAddress& peer_addr); 272 273 #if (BTA_EIR_CANNED_UUID_LIST != TRUE) 274 extern void bta_sys_eir_register(tBTA_SYS_EIR_CBACK* p_cback); 275 extern void bta_sys_add_uuid(uint16_t uuid16); 276 extern void bta_sys_remove_uuid(uint16_t uuid16); 277 #else 278 #define bta_sys_eir_register(ut) 279 #define bta_sys_add_uuid(ut) 280 #define bta_sys_remove_uuid(ut) 281 #endif 282 283 extern void bta_sys_set_policy(uint8_t id, uint8_t policy, 284 const RawAddress& peer_addr); 285 extern void bta_sys_clear_policy(uint8_t id, uint8_t policy, 286 const RawAddress& peer_addr); 287 extern void bta_sys_set_default_policy(uint8_t id, uint8_t policy); 288 extern void bta_sys_clear_default_policy(uint8_t id, uint8_t policy); 289 290 #endif /* BTA_SYS_H */ 291