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