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