bta_ag_int.h revision 0681fefcf5f5c9d7471986b7c9f20f69e94d4fb1
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 private interface file for the BTA audio gateway. 22 * 23 ******************************************************************************/ 24#ifndef BTA_AG_INT_H 25#define BTA_AG_INT_H 26 27#include "bta_ag_api.h" 28#include "bta_ag_at.h" 29#include "bta_api.h" 30#include "bta_sys.h" 31 32/***************************************************************************** 33 * Constants 34 ****************************************************************************/ 35/* Number of SCBs (AG service instances that can be registered) */ 36#ifndef BTA_AG_NUM_SCB 37#define BTA_AG_NUM_SCB 2 38#endif 39 40/* Time to wait for retry in case of collision */ 41#ifndef BTA_AG_COLLISION_TIMEOUT_MS 42#define BTA_AG_COLLISION_TIMEOUT_MS (2 * 1000) /* 2 seconds */ 43#endif 44 45/* RFCOMM MTU SIZE */ 46#define BTA_AG_MTU 256 47 48/* Max number of peer and local HF indicators */ 49#define BTA_AG_MAX_NUM_PEER_HF_IND 20 50#define BTA_AG_MAX_NUM_LOCAL_HF_IND 4 51 52/* Internal profile indexes */ 53#define BTA_AG_HSP 0 /* index for HSP */ 54#define BTA_AG_HFP 1 /* index for HFP */ 55#define BTA_AG_NUM_IDX 2 /* number of profile indexes */ 56 57/* profile role for connection */ 58#define BTA_AG_ACP 0 /* accepted connection */ 59#define BTA_AG_INT 1 /* initiating connection */ 60 61#define BTA_AG_SDP_FEAT_SPEC \ 62 (BTA_AG_FEAT_3WAY | BTA_AG_FEAT_ECNR | BTA_AG_FEAT_VREC | \ 63 BTA_AG_FEAT_INBAND | BTA_AG_FEAT_VTAG) 64 65enum { 66 /* these events are handled by the state machine */ 67 BTA_AG_API_REGISTER_EVT = BTA_SYS_EVT_START(BTA_ID_AG), 68 BTA_AG_API_DEREGISTER_EVT, 69 BTA_AG_API_OPEN_EVT, 70 BTA_AG_API_CLOSE_EVT, 71 BTA_AG_API_AUDIO_OPEN_EVT, 72 BTA_AG_API_AUDIO_CLOSE_EVT, 73 BTA_AG_API_RESULT_EVT, 74 BTA_AG_API_SETCODEC_EVT, 75 BTA_AG_RFC_OPEN_EVT, 76 BTA_AG_RFC_CLOSE_EVT, 77 BTA_AG_RFC_SRV_CLOSE_EVT, 78 BTA_AG_RFC_DATA_EVT, 79 BTA_AG_SCO_OPEN_EVT, 80 BTA_AG_SCO_CLOSE_EVT, 81 BTA_AG_DISC_ACP_RES_EVT, 82 BTA_AG_DISC_INT_RES_EVT, 83 BTA_AG_DISC_OK_EVT, 84 BTA_AG_DISC_FAIL_EVT, 85 BTA_AG_RING_TIMEOUT_EVT, 86 BTA_AG_SVC_TIMEOUT_EVT, 87 BTA_AG_MAX_EVT, 88 89 /* these events are handled outside of the state machine */ 90 BTA_AG_API_ENABLE_EVT, 91 BTA_AG_API_DISABLE_EVT, 92 BTA_AG_API_SET_SCO_ALLOWED_EVT, 93 BTA_AG_API_SET_ACTIVE_DEVICE_EVT 94}; 95 96/* Actions to perform after a SCO event */ 97enum { 98 BTA_AG_POST_SCO_NONE, /* no action */ 99 BTA_AG_POST_SCO_CLOSE_RFC, /* close RFCOMM channel after SCO closes */ 100 BTA_AG_POST_SCO_RING, /* send RING result code after SCO opens */ 101 BTA_AG_POST_SCO_CALL_CONN, /* send call indicators after SCO opens/closes */ 102 BTA_AG_POST_SCO_CALL_ORIG, /* send call indicators after SCO closes */ 103 BTA_AG_POST_SCO_CALL_END, /* send call indicators after SCO closes */ 104 BTA_AG_POST_SCO_CALL_END_INCALL /* send call indicators for end call & 105 incoming call after SCO closes */ 106}; 107 108/* sco states */ 109enum { 110 BTA_AG_SCO_SHUTDOWN_ST, /* no sco listening, all sco connections closed */ 111 BTA_AG_SCO_LISTEN_ST, /* sco listening */ 112 BTA_AG_SCO_CODEC_ST, /* sco codec negotiation */ 113 BTA_AG_SCO_OPENING_ST, /* sco connection opening */ 114 BTA_AG_SCO_OPEN_CL_ST, /* opening sco connection being closed */ 115 BTA_AG_SCO_OPEN_XFER_ST, /* opening sco connection being transferred */ 116 BTA_AG_SCO_OPEN_ST, /* sco open */ 117 BTA_AG_SCO_CLOSING_ST, /* sco closing */ 118 BTA_AG_SCO_CLOSE_OP_ST, /* closing sco being opened */ 119 BTA_AG_SCO_CLOSE_XFER_ST, /* closing sco being transferred */ 120 BTA_AG_SCO_SHUTTING_ST /* sco shutting down */ 121}; 122 123/***************************************************************************** 124 * Data types 125 ****************************************************************************/ 126 127/* data type for BTA_AG_API_ENABLE_EVT */ 128typedef struct { 129 BT_HDR hdr; 130 tBTA_AG_CBACK* p_cback; 131} tBTA_AG_API_ENABLE; 132 133/* data type for BTA_AG_API_REGISTER_EVT */ 134typedef struct { 135 BT_HDR hdr; 136 char p_name[2][BTA_SERVICE_NAME_LEN + 1]; 137 tBTA_SERVICE_MASK services; 138 tBTA_SEC sec_mask; 139 tBTA_AG_FEAT features; 140 uint8_t app_id; 141} tBTA_AG_API_REGISTER; 142 143/* data type for BTA_AG_API_OPEN_EVT */ 144typedef struct { 145 BT_HDR hdr; 146 RawAddress bd_addr; 147 tBTA_SERVICE_MASK services; 148 tBTA_SEC sec_mask; 149} tBTA_AG_API_OPEN; 150 151/* data type for BTA_AG_API_RESULT_EVT */ 152typedef struct { 153 BT_HDR hdr; 154 tBTA_AG_RES result; 155 tBTA_AG_RES_DATA data; 156} tBTA_AG_API_RESULT; 157 158/* data type for BTA_AG_API_SETCODEC_EVT */ 159typedef struct { 160 BT_HDR hdr; 161 tBTA_AG_PEER_CODEC codec; 162} tBTA_AG_API_SETCODEC; 163 164/* data type for BTA_AG_API_SET_SCO_ALLOWED_EVT */ 165typedef struct { 166 BT_HDR hdr; 167 bool value; 168} tBTA_AG_API_SET_SCO_ALLOWED; 169 170typedef struct { 171 BT_HDR hdr; 172 RawAddress active_device_addr; 173} tBTA_AG_API_SET_ACTIVE_DEVICE; 174 175/* data type for BTA_AG_DISC_RESULT_EVT */ 176typedef struct { 177 BT_HDR hdr; 178 uint16_t status; 179} tBTA_AG_DISC_RESULT; 180 181/* data type for RFCOMM events */ 182typedef struct { 183 BT_HDR hdr; 184 uint16_t port_handle; 185} tBTA_AG_RFC; 186 187/* union of all event datatypes */ 188typedef union { 189 BT_HDR hdr; 190 tBTA_AG_API_ENABLE api_enable; 191 tBTA_AG_API_REGISTER api_register; 192 tBTA_AG_API_OPEN api_open; 193 tBTA_AG_API_RESULT api_result; 194 tBTA_AG_API_SETCODEC api_setcodec; 195 tBTA_AG_API_SET_SCO_ALLOWED api_set_sco_allowed; 196 tBTA_AG_API_SET_ACTIVE_DEVICE api_set_active_device; 197 tBTA_AG_DISC_RESULT disc_result; 198 tBTA_AG_RFC rfc; 199} tBTA_AG_DATA; 200 201/* type for each profile */ 202typedef struct { 203 uint32_t sdp_handle; 204 uint8_t scn; 205} tBTA_AG_PROFILE; 206 207typedef enum { 208 BTA_AG_SCO_MSBC_SETTINGS_T2 = 0, /* preferred/default when codec is mSBC */ 209 BTA_AG_SCO_MSBC_SETTINGS_T1, 210} tBTA_AG_SCO_MSBC_SETTINGS; 211 212/* type for each service control block */ 213struct tBTA_AG_SCB { 214 char clip[BTA_AG_AT_MAX_LEN + 1]; /* number string used for CLIP */ 215 uint16_t serv_handle[BTA_AG_NUM_IDX]; /* RFCOMM server handles */ 216 tBTA_AG_AT_CB at_cb; /* AT command interpreter */ 217 RawAddress peer_addr; /* peer bd address */ 218 tSDP_DISCOVERY_DB* p_disc_db; /* pointer to discovery database */ 219 tBTA_SERVICE_MASK reg_services; /* services specified in register API */ 220 tBTA_SERVICE_MASK open_services; /* services specified in open API */ 221 uint16_t conn_handle; /* RFCOMM handle of connected service */ 222 tBTA_SEC serv_sec_mask; /* server security mask */ 223 tBTA_SEC cli_sec_mask; /* client security mask */ 224 tBTA_AG_FEAT features; /* features registered by application */ 225 tBTA_AG_PEER_FEAT peer_features; /* peer device features */ 226 uint16_t peer_version; /* profile version of peer device */ 227 uint16_t hsp_version; /* HSP profile version before SDP */ 228 uint16_t sco_idx; /* SCO handle */ 229 bool in_use; /* scb in use */ 230 bool dealloc; /* true if service shutting down */ 231 bool clip_enabled; /* set to true if HF enables CLIP reporting */ 232 bool ccwa_enabled; /* set to true if HF enables CCWA reporting */ 233 bool cmer_enabled; /* set to true if HF enables CMER reporting */ 234 bool cmee_enabled; /* set to true if HF enables CME ERROR reporting */ 235 bool inband_enabled; /* set to true if inband ring enabled */ 236 bool svc_conn; /* set to true when service level connection up */ 237 uint8_t state; /* state machine state */ 238 uint8_t conn_service; /* connected service */ 239 uint8_t peer_scn; /* peer scn */ 240 uint8_t app_id; /* application id */ 241 uint8_t role; /* initiator/acceptor role */ 242 uint8_t post_sco; /* action to perform after sco event */ 243 uint8_t call_ind; /* CIEV call indicator value */ 244 uint8_t callsetup_ind; /* CIEV callsetup indicator value */ 245 uint8_t service_ind; /* CIEV service indicator value */ 246 uint8_t signal_ind; /* CIEV signal indicator value */ 247 uint8_t roam_ind; /* CIEV roam indicator value */ 248 uint8_t battchg_ind; /* CIEV battery charge indicator value */ 249 uint8_t callheld_ind; /* CIEV call held indicator value */ 250 uint32_t bia_masked_out; /* indicators HF does not want us to send */ 251 alarm_t* collision_timer; 252 alarm_t* ring_timer; 253 alarm_t* codec_negotiation_timer; 254 tBTA_AG_PEER_CODEC peer_codecs; /* codecs for eSCO supported by the peer */ 255 tBTA_AG_PEER_CODEC sco_codec; /* codec to be used for eSCO connection */ 256 tBTA_AG_PEER_CODEC 257 inuse_codec; /* codec being used for the current SCO connection */ 258 bool codec_updated; /* set to true whenever the app updates codec type */ 259 bool codec_fallback; /* If sco nego fails for mSBC, fallback to CVSD */ 260 tBTA_AG_SCO_MSBC_SETTINGS 261 codec_msbc_settings; /* settings to be used for the impending eSCO */ 262 263 tBTA_AG_HF_IND 264 peer_hf_indicators[BTA_AG_MAX_NUM_PEER_HF_IND]; /* Peer supported 265 HF indicators */ 266 tBTA_AG_HF_IND 267 local_hf_indicators[BTA_AG_MAX_NUM_LOCAL_HF_IND]; /* Local supported 268 HF indicators */ 269}; 270 271/* type for sco data */ 272typedef struct { 273 tBTM_ESCO_CONN_REQ_EVT_DATA conn_data; /* SCO data for pending conn request */ 274 tBTA_AG_SCB* p_curr_scb; /* SCB associated with SCO connection */ 275 tBTA_AG_SCB* p_xfer_scb; /* SCB associated with SCO transfer */ 276 uint16_t cur_idx; /* SCO handle */ 277 uint8_t state; /* SCO state variable */ 278 bool is_local; /* SCO connection initiated locally or remotely */ 279} tBTA_AG_SCO_CB; 280 281/* type for AG control block */ 282typedef struct { 283 tBTA_AG_SCB scb[BTA_AG_NUM_SCB]; /* service control blocks */ 284 tBTA_AG_PROFILE profile[BTA_AG_NUM_IDX]; /* profile-specific data */ 285 tBTA_AG_SCO_CB sco; /* SCO data */ 286 tBTA_AG_CBACK* p_cback; /* application callback */ 287} tBTA_AG_CB; 288 289/***************************************************************************** 290 * Global data 291 ****************************************************************************/ 292 293/* constant lookup tables */ 294extern const uint16_t bta_ag_uuid[BTA_AG_NUM_IDX]; 295extern const uint8_t bta_ag_sec_id[BTA_AG_NUM_IDX]; 296extern const tBTA_AG_AT_CMD* bta_ag_at_tbl[BTA_AG_NUM_IDX]; 297 298/* control block declaration */ 299extern tBTA_AG_CB bta_ag_cb; 300 301/* config struct */ 302extern const tBTA_AG_CFG* p_bta_ag_cfg; 303extern const tBTA_AG_HF_IND bta_ag_local_hf_ind_cfg[]; 304 305/***************************************************************************** 306 * Function prototypes 307 ****************************************************************************/ 308 309/* main functions */ 310extern void bta_ag_scb_dealloc(tBTA_AG_SCB* p_scb); 311extern uint16_t bta_ag_scb_to_idx(tBTA_AG_SCB* p_scb); 312extern tBTA_AG_SCB* bta_ag_scb_by_idx(uint16_t idx); 313extern uint8_t bta_ag_service_to_idx(tBTA_SERVICE_MASK services); 314extern uint16_t bta_ag_idx_by_bdaddr(const RawAddress* peer_addr); 315extern bool bta_ag_other_scb_open(tBTA_AG_SCB* p_curr_scb); 316extern bool bta_ag_scb_open(tBTA_AG_SCB* p_curr_scb); 317extern tBTA_AG_SCB* bta_ag_get_other_idle_scb(tBTA_AG_SCB* p_curr_scb); 318extern void bta_ag_sm_execute(tBTA_AG_SCB* p_scb, uint16_t event, 319 tBTA_AG_DATA* p_data); 320extern bool bta_ag_hdl_event(BT_HDR* p_msg); 321extern void bta_ag_collision_cback(tBTA_SYS_CONN_STATUS status, uint8_t id, 322 uint8_t app_id, const RawAddress& peer_addr); 323extern void bta_ag_resume_open(tBTA_AG_SCB* p_scb); 324 325/* SDP functions */ 326extern bool bta_ag_add_record(uint16_t service_uuid, char* p_service_name, 327 uint8_t scn, tBTA_AG_FEAT features, 328 uint32_t sdp_handle); 329extern void bta_ag_create_records(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 330extern void bta_ag_del_records(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 331extern bool bta_ag_sdp_find_attr(tBTA_AG_SCB* p_scb, tBTA_SERVICE_MASK service); 332extern void bta_ag_do_disc(tBTA_AG_SCB* p_scb, tBTA_SERVICE_MASK service); 333extern void bta_ag_free_db(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 334 335/* RFCOMM functions */ 336extern void bta_ag_start_servers(tBTA_AG_SCB* p_scb, 337 tBTA_SERVICE_MASK services); 338extern void bta_ag_close_servers(tBTA_AG_SCB* p_scb, 339 tBTA_SERVICE_MASK services); 340extern bool bta_ag_is_server_closed(tBTA_AG_SCB* p_scb); 341extern void bta_ag_rfc_do_close(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 342extern void bta_ag_rfc_do_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 343 344/* SCO functions */ 345extern bool bta_ag_sco_is_open(tBTA_AG_SCB* p_scb); 346extern bool bta_ag_sco_is_opening(tBTA_AG_SCB* p_scb); 347extern void bta_ag_sco_conn_rsp(tBTA_AG_SCB* p_scb, 348 tBTM_ESCO_CONN_REQ_EVT_DATA* p_data); 349 350/* AT command functions */ 351extern void bta_ag_at_hsp_cback(tBTA_AG_SCB* p_scb, uint16_t cmd, 352 uint8_t arg_type, char* p_arg, int16_t int_arg); 353extern void bta_ag_at_hfp_cback(tBTA_AG_SCB* p_scb, uint16_t cmd, 354 uint8_t arg_type, char* p_arg, int16_t int_arg); 355extern void bta_ag_at_err_cback(tBTA_AG_SCB* p_scb, bool unknown, char* p_arg); 356extern bool bta_ag_inband_enabled(tBTA_AG_SCB* p_scb); 357extern void bta_ag_send_call_inds(tBTA_AG_SCB* p_scb, tBTA_AG_RES result); 358 359/* Action functions */ 360extern void bta_ag_register(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 361extern void bta_ag_deregister(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 362extern void bta_ag_start_dereg(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 363extern void bta_ag_start_close(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 364extern void bta_ag_start_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 365extern void bta_ag_disc_int_res(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 366extern void bta_ag_disc_acp_res(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 367extern void bta_ag_disc_fail(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 368extern void bta_ag_open_fail(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 369extern void bta_ag_rfc_fail(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 370extern void bta_ag_rfc_close(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 371extern void bta_ag_rfc_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 372extern void bta_ag_rfc_acp_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 373extern void bta_ag_rfc_data(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 374extern void bta_ag_sco_listen(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 375extern void bta_ag_sco_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 376extern void bta_ag_sco_close(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 377extern void bta_ag_sco_codec_nego(tBTA_AG_SCB* p_scb, bool result); 378extern void bta_ag_codec_negotiate(tBTA_AG_SCB* p_scb); 379extern void bta_ag_sco_shutdown(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 380extern void bta_ag_sco_conn_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 381extern void bta_ag_sco_conn_close(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 382extern void bta_ag_post_sco_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 383extern void bta_ag_post_sco_close(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 384extern void bta_ag_svc_conn_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 385extern void bta_ag_result(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 386extern void bta_ag_setcodec(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 387extern void bta_ag_send_bcs(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 388extern void bta_ag_send_ring(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data); 389extern void bta_ag_set_sco_allowed(tBTA_AG_DATA* p_data); 390extern const RawAddress& bta_ag_get_active_device(); 391extern void bta_clear_active_device(); 392extern void bta_ag_api_set_active_device(tBTA_AG_DATA* p_data); 393 394#endif /* BTA_AG_INT_H */ 395