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