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 audio gateway (AG) subsystem
22  *  of BTA, Broadcom's Bluetooth application layer for mobile phones.
23  *
24  ******************************************************************************/
25 #ifndef BTA_AG_API_H
26 #define BTA_AG_API_H
27 
28 #include "bta_api.h"
29 
30 #include <string>
31 #include <vector>
32 
33 /*****************************************************************************
34  *  Constants and data types
35  ****************************************************************************/
36 /* Number of SCBs (AG service instances that can be registered) */
37 #define BTA_AG_MAX_NUM_CLIENTS 6
38 
39 #define HFP_HSP_VERSION_UNKNOWN 0x0000
40 #define HFP_VERSION_1_1 0x0101
41 #define HFP_VERSION_1_5 0x0105
42 #define HFP_VERSION_1_6 0x0106
43 #define HFP_VERSION_1_7 0x0107
44 
45 #define HSP_VERSION_1_0 0x0100
46 #define HSP_VERSION_1_2 0x0102
47 
48 #define HFP_VERSION_CONFIG_KEY "HfpVersion"
49 #define HFP_SDP_FEATURES_CONFIG_KEY "HfpSdpFeatures"
50 
51 /* Note, if you change the default version here, please also change the one in
52  * bta_hs_api.h, they are meant to be the same.
53  */
54 #ifndef BTA_HFP_VERSION
55 #define BTA_HFP_VERSION HFP_VERSION_1_7
56 #endif
57 
58 /* AG feature masks */
59 #define BTA_AG_FEAT_3WAY 0x00000001   /* Three-way calling */
60 #define BTA_AG_FEAT_ECNR 0x00000002   /* Echo cancellation/noise reduction */
61 #define BTA_AG_FEAT_VREC 0x00000004   /* Voice recognition */
62 #define BTA_AG_FEAT_INBAND 0x00000008 /* In-band ring tone */
63 #define BTA_AG_FEAT_VTAG 0x00000010   /* Attach a phone number to a voice tag */
64 #define BTA_AG_FEAT_REJECT 0x00000020 /* Ability to reject incoming call */
65 #define BTA_AG_FEAT_ECS 0x00000040    /* Enhanced Call Status */
66 #define BTA_AG_FEAT_ECC 0x00000080    /* Enhanced Call Control */
67 #define BTA_AG_FEAT_EXTERR 0x00000100 /* Extended error codes */
68 #define BTA_AG_FEAT_CODEC 0x00000200  /* Codec Negotiation */
69 
70 /* AG SDP feature masks */
71 #define BTA_AG_FEAT_WBS_SUPPORT 0x0020 /* Supports WBS */
72 
73 /* Only SDP feature bits 0 to 4 matches BRSF feature bits */
74 #define HFP_SDP_BRSF_FEATURES_MASK 0x001F
75 
76 /* Valid feature bit mask for HFP 1.6 (and below) */
77 #define HFP_1_6_FEAT_MASK 0x000003FF
78 
79 /* HFP 1.7+ */
80 #define BTA_AG_FEAT_HF_IND 0x00000400 /* HF Indicators */
81 #define BTA_AG_FEAT_ESCO 0x00000800   /* eSCO S4 (and T2) setting supported */
82 
83 /* Proprietary features: using 31 ~ 16 bits */
84 #define BTA_AG_FEAT_BTRH 0x00010000    /* CCAP incoming call hold */
85 #define BTA_AG_FEAT_UNAT 0x00020000    /* Pass unknown AT commands to app */
86 #define BTA_AG_FEAT_NOSCO 0x00040000   /* No SCO control performed by BTA AG */
87 #define BTA_AG_FEAT_NO_ESCO 0x00080000 /* Do not allow or use eSCO */
88 #define BTA_AG_FEAT_VOIP 0x00100000    /* VoIP call */
89 
90 typedef uint32_t tBTA_AG_FEAT;
91 
92 /* AG open status */
93 #define BTA_AG_SUCCESS 0        /* Connection successfully opened */
94 #define BTA_AG_FAIL_SDP 1       /* Open failed due to SDP */
95 #define BTA_AG_FAIL_RFCOMM 2    /* Open failed due to RFCOMM */
96 #define BTA_AG_FAIL_RESOURCES 3 /* out of resources failure */
97 
98 /* Status to disallow passing AT Events after BTIF */
99 #define BTA_AG_DISALLOW_AT 5
100 
101 typedef uint8_t tBTA_AG_STATUS;
102 
103 /* handle values used with BTA_AgResult */
104 #define BTA_AG_HANDLE_NONE 0
105 #define BTA_AG_HANDLE_ALL 0xFFFF
106 /* It is safe to use the same value as BTA_AG_HANDLE_ALL
107  * HANDLE_ALL is used for delivering indication
108  * SCO_NO_CHANGE is used for changing sco behavior
109  * They donot interfere with each other
110  */
111 
112 /* Number of supported HF indicators, there is one HF indicator so far i.e.
113                                                    enhanced driver status. */
114 /* Number of supported HF indicators,
115    1 for Enhanced Safety Status
116    2 for Battery Level Status */
117 #ifndef BTA_AG_NUM_LOCAL_HF_IND
118 #define BTA_AG_NUM_LOCAL_HF_IND 2
119 #endif
120 
121 #define BTA_AG_HANDLE_SCO_NO_CHANGE 0xFFFF
122 
123 /* AG result codes used with BTA_AgResult */
124 #define BTA_AG_SPK_RES 0         /* Update speaker volume */
125 #define BTA_AG_MIC_RES 1         /* Update microphone volume */
126 #define BTA_AG_INBAND_RING_RES 2 /* Update inband ring state */
127 #define BTA_AG_CIND_RES 3        /* Send indicator response for AT+CIND */
128 #define BTA_AG_BINP_RES 4     /* Send phone number for voice tag for AT+BINP */
129 #define BTA_AG_IND_RES 5      /* Update an indicator value */
130 #define BTA_AG_BVRA_RES 6     /* Update voice recognition state */
131 #define BTA_AG_CNUM_RES 7     /* Send subscriber number response for AT+CNUM */
132 #define BTA_AG_BTRH_RES 8     /* Send CCAP incoming call hold */
133 #define BTA_AG_CLCC_RES 9     /* Query list of calls */
134 #define BTA_AG_COPS_RES 10    /* Read network operator */
135 #define BTA_AG_IN_CALL_RES 11 /* Indicate incoming phone call */
136 #define BTA_AG_IN_CALL_CONN_RES 12  /* Incoming phone call connected */
137 #define BTA_AG_CALL_WAIT_RES 13     /* Call waiting notification */
138 #define BTA_AG_OUT_CALL_ORIG_RES 14 /* Outgoing phone call origination */
139 
140 /* Outgoing phone call alerting remote party */
141 #define BTA_AG_OUT_CALL_ALERT_RES 15
142 #define BTA_AG_OUT_CALL_CONN_RES 16 /* Outgoing phone call connected */
143 
144 /* Incoming/outgoing 3-way canceled before connected */
145 #define BTA_AG_CALL_CANCEL_RES 17
146 #define BTA_AG_END_CALL_RES 18     /* End call */
147 #define BTA_AG_IN_CALL_HELD_RES 19 /* Incoming call held */
148 #define BTA_AG_UNAT_RES 20         /* Response to unknown AT command event */
149 #define BTA_AG_MULTI_CALL_RES 21   /* SLC at three way call */
150 #define BTA_AG_BIND_RES 22         /* Activate/Deactivate HF indicator */
151 #define BTA_AG_IND_RES_ON_DEMAND 33 /* Update an indicator value forcible */
152 
153 typedef uint8_t tBTA_AG_RES;
154 
155 /* HFP peer features */
156 #define BTA_AG_PEER_FEAT_ECNR 0x0001   /* Echo cancellation/noise reduction */
157 #define BTA_AG_PEER_FEAT_3WAY 0x0002   /* Call waiting and three-way calling */
158 #define BTA_AG_PEER_FEAT_CLI 0x0004    /* Caller ID presentation capability */
159 #define BTA_AG_PEER_FEAT_VREC 0x0008   /* Voice recognition activation */
160 #define BTA_AG_PEER_FEAT_VOL 0x0010    /* Remote volume control */
161 #define BTA_AG_PEER_FEAT_ECS 0x0020    /* Enhanced Call Status */
162 #define BTA_AG_PEER_FEAT_ECC 0x0040    /* Enhanced Call Control */
163 #define BTA_AG_PEER_FEAT_CODEC 0x0080  /* Codec Negotiation */
164 #define BTA_AG_PEER_FEAT_HF_IND 0x0100 /* HF Indicators */
165 #define BTA_AG_PEER_FEAT_ESCO 0x0200   /* eSCO S4 (and T2) setting supported */
166 
167 /* Proprietary features: using bits after 12 */
168 
169 /* Pass unknown AT command responses to application */
170 #define BTA_AG_PEER_FEAT_UNAT 0x1000
171 #define BTA_AG_PEER_FEAT_VOIP 0x2000 /* VoIP call */
172 
173 typedef uint16_t tBTA_AG_PEER_FEAT;
174 
175 /* HFP peer supported codec masks */
176 // TODO(google) This should use common definitions
177 #define BTA_AG_CODEC_NONE BTM_SCO_CODEC_NONE
178 #define BTA_AG_CODEC_CVSD BTM_SCO_CODEC_CVSD /* CVSD */
179 #define BTA_AG_CODEC_MSBC BTM_SCO_CODEC_MSBC /* mSBC */
180 typedef uint16_t tBTA_AG_PEER_CODEC;
181 
182 /* HFP errcode - Set when BTA_AG_OK_ERROR is returned in 'ok_flag' */
183 #define BTA_AG_ERR_PHONE_FAILURE 0     /* Phone Failure */
184 #define BTA_AG_ERR_NO_CONN_PHONE 1     /* No connection to phone */
185 #define BTA_AG_ERR_OP_NOT_ALLOWED 3    /* Operation not allowed */
186 #define BTA_AG_ERR_OP_NOT_SUPPORTED 4  /* Operation not supported */
187 #define BTA_AG_ERR_PHSIM_PIN_REQ 5     /* PH-SIM PIN required */
188 #define BTA_AG_ERR_SIM_NOT_INSERTED 10 /* SIM not inserted */
189 #define BTA_AG_ERR_SIM_PIN_REQ 11      /* SIM PIN required */
190 #define BTA_AG_ERR_SIM_PUK_REQ 12      /* SIM PUK required */
191 #define BTA_AG_ERR_SIM_FAILURE 13      /* SIM failure */
192 #define BTA_AG_ERR_SIM_BUSY 14         /* SIM busy */
193 #define BTA_AG_ERR_INCORRECT_PWD 16    /* Incorrect password */
194 #define BTA_AG_ERR_SIM_PIN2_REQ 17     /* SIM PIN2 required */
195 #define BTA_AG_ERR_SIM_PUK2_REQ 18     /* SIM PUK2 required */
196 #define BTA_AG_ERR_MEMORY_FULL 20      /* Memory full */
197 #define BTA_AG_ERR_INVALID_INDEX 21    /* Invalid index */
198 #define BTA_AG_ERR_MEMORY_FAILURE 23   /* Memory failure */
199 #define BTA_AG_ERR_TEXT_TOO_LONG 24    /* Text string too long */
200 #define BTA_AG_ERR_INV_CHAR_IN_TSTR 25 /* Invalid characters in text string */
201 #define BTA_AG_ERR_DSTR_TOO_LONG 26    /* Dial string too long */
202 #define BTA_AG_ERR_INV_CHAR_IN_DSTR 27 /* Invalid characters in dial string */
203 #define BTA_AG_ERR_NO_NETWORK_SERV 30  /* No network service */
204 #define BTA_AG_ERR_NETWORK_TIME_OUT 31 /* Network timeout */
205 /* Network not allowed - emergency service only */
206 #define BTA_AG_ERR_NO_NET_EMG_ONLY 32
207 /* AG cannot create simultaneous VoIP and CS calls */
208 #define BTA_AG_ERR_VOIP_CS_CALLS 33
209 #define BTA_AG_ERR_NOT_FOR_VOIP 34  /* Not supported on this call type(VoIP) */
210 #define BTA_AG_ERR_SIP_RESP_CODE 35 /* SIP 3 digit response code */
211 
212 #if 0 /* Not Used in Bluetooth HFP 1.5 Specification */
213 #define BTA_AG_ERR_PHADAP_LNK_RES 2   /* Phone-adapter link reserved */
214 #define BTA_AG_ERR_PHFSIM_PIN_REQ 6   /* PH-FSIM PIN required */
215 #define BTA_AG_ERR_PHFSIM_PUK_REQ 7   /* PH-FSIM PUK required */
216 #define BTA_AG_ERR_SIM_WRONG 15       /* SIM wrong */
217 #define BTA_AG_ERR_NOT_FOUND 22       /* Not found */
218 #define BTA_AG_ERR_NETWORK_TIMEOUT 31 /* Network timeout */
219 #define BTA_AG_ERR_NET_PIN_REQ 40     /* Network personalization PIN required */
220 #define BTA_AG_ERR_NET_PUK_REQ 41     /* Network personalization PUK required */
221 /* Network subset personalization PIN required */
222 #define BTA_AG_ERR_SUBSET_PIN_REQ 42
223 /* Network subset personalization PUK required */
224 #define BTA_AG_ERR_SUBSET_PUK_REQ 43
225 /* Service provider personalization PIN required */
226 #define BTA_AG_ERR_SERVPRO_PIN_REQ 44
227 /* Service provider personalization PUK required */
228 #define BTA_AG_ERR_SERVPRO_PUK_REQ 45
229 /* Corporate personalization PIN required */
230 #define BTA_AG_ERR_CORP_PIN_REQ 46
231 /* Corporate personalization PUK required */
232 #define BTA_AG_ERR_CORP_PUK_REQ 47
233 #define BTA_AG_ERR_UNKNOWN 100 /* Unknown error */
234 
235 /* GPRS-related errors */
236 #define BTA_AG_ERR_ILL_MS 103  /* Illegal MS (#3) */
237 #define BTA_AG_ERR_ILL_ME 106  /* Illegal ME (#6) */
238 #define BTA_AG_ERR_GPRS_NOT_ALLOWED 107 /* GPRS services not allowed (#7) */
239 #define BTA_AG_ERR_PLMN_NOT_ALLOWED 111 /* PLMN services not allowed (#11) */
240 #define BTA_AG_ERR_LOC_NOT_ALLOWED 112  /* Location area not allowed (#12) */
241 /* Roaming not allowed in this location area (#13) */
242 #define BTA_AG_ERR_ROAM_NOT_ALLOWED 113
243 /* Errors related to a failure to Activate a Context */
244 #define BTA_AG_ERR_OPT_NOT_SUPP 132 /* Service option not supported (#32) */
245 /* Requested service option not subscribed (#33) */
246 #define BTA_AG_ERR_OPT_NOT_SUBSCR 133
247 /* Service option temporarily out of order (#34) */
248 #define BTA_AG_ERR_OPT_OUT_OF_ORDER 134
249 #define BTA_AG_ERR_PDP_AUTH_FAILURE 149 /* PDP authentication failure */
250 /* Other GPRS errors */
251 #define BTA_AG_ERR_INV_MOBILE_CLASS 150 /* Invalid mobile class */
252 #define BTA_AG_ERR_UNSPEC_GPRS_ERR 148  /* Unspecified GPRS error */
253 #endif                                  /* Unused error codes */
254 
255 /* HFP result data 'ok_flag' */
256 #define BTA_AG_OK_CONTINUE 0 /* Send out response (more responses coming) */
257 #define BTA_AG_OK_DONE 1     /* Send out response followed by OK (finished) */
258 #define BTA_AG_OK_ERROR 2    /* Error response */
259 
260 /* BTRH values */
261 #define BTA_AG_BTRH_SET_HOLD 0 /* Put incoming call on hold */
262 #define BTA_AG_BTRH_SET_ACC 1  /* Accept incoming call on hold */
263 #define BTA_AG_BTRH_SET_REJ 2  /* Reject incoming call on hold */
264 #define BTA_AG_BTRH_READ 3     /* Read the current value */
265 #define BTA_AG_BTRH_NO_RESP 4  /* Not in RH States (reply to read) */
266 
267 /* clip type constants */
268 #define BTA_AG_CLIP_TYPE_MIN 128
269 #define BTA_AG_CLIP_TYPE_MAX 175
270 #define BTA_AG_CLIP_TYPE_DEFAULT 129
271 #define BTA_AG_CLIP_TYPE_VOIP 255
272 
273 /* ASCII character string of arguments to the AT command or result */
274 #ifndef BTA_AG_AT_MAX_LEN
275 #define BTA_AG_AT_MAX_LEN 256
276 #endif
277 
278 /* data associated with BTA_AG_IND_RES */
279 typedef struct {
280   uint16_t id;
281   uint16_t value;
282   bool on_demand;
283 } tBTA_AG_IND;
284 
285 /* data type for BTA_AgResult() */
286 struct tBTA_AG_RES_DATA {
287   char str[BTA_AG_AT_MAX_LEN + 1];
288   tBTA_AG_IND ind;
289   uint16_t num;
290   uint16_t audio_handle;
291   uint16_t errcode; /* Valid only if 'ok_flag' is set to BTA_AG_OK_ERROR */
292   uint8_t
293       ok_flag; /* Indicates if response is finished, and if error occurred */
294   bool state;
295   static const tBTA_AG_RES_DATA kEmpty;
296 };
297 
298 /* AG callback events */
299 #define BTA_AG_ENABLE_EVT 0      /* AG enabled */
300 #define BTA_AG_REGISTER_EVT 1    /* AG registered */
301 #define BTA_AG_OPEN_EVT 2        /* AG connection open */
302 #define BTA_AG_CLOSE_EVT 3       /* AG connection closed */
303 #define BTA_AG_CONN_EVT 4        /* Service level connection opened */
304 #define BTA_AG_AUDIO_OPEN_EVT 5  /* Audio connection open */
305 #define BTA_AG_AUDIO_CLOSE_EVT 6 /* Audio connection closed */
306 #define BTA_AG_SPK_EVT 7         /* Speaker volume changed */
307 #define BTA_AG_MIC_EVT 8         /* Microphone volume changed */
308 #define BTA_AG_AT_CKPD_EVT 9     /* CKPD from the HS */
309 #define BTA_AG_DISABLE_EVT 30    /* AG disabled */
310 #define BTA_AG_WBS_EVT 31 /* SCO codec info */
311 /* Values below are for HFP only */
312 #define BTA_AG_AT_A_EVT 10    /* Answer a call */
313 #define BTA_AG_AT_D_EVT 11    /* Place a call using number or memory dial */
314 #define BTA_AG_AT_CHLD_EVT 12 /* Call hold */
315 #define BTA_AG_AT_CHUP_EVT 13 /* Hang up a call */
316 #define BTA_AG_AT_CIND_EVT 14 /* Read indicator settings */
317 #define BTA_AG_AT_VTS_EVT 15  /* Transmit DTMF tone */
318 #define BTA_AG_AT_BINP_EVT 16 /* Retrieve number from voice tag */
319 #define BTA_AG_AT_BLDN_EVT 17 /* Place call to last dialed number */
320 #define BTA_AG_AT_BVRA_EVT 18 /* Enable/disable voice recognition */
321 #define BTA_AG_AT_NREC_EVT 19 /* Disable echo canceling */
322 #define BTA_AG_AT_CNUM_EVT 20 /* Retrieve subscriber number */
323 #define BTA_AG_AT_BTRH_EVT 21 /* CCAP-style incoming call hold */
324 #define BTA_AG_AT_CLCC_EVT 22 /* Query list of current calls */
325 #define BTA_AG_AT_COPS_EVT 23 /* Query list of current calls */
326 #define BTA_AG_AT_UNAT_EVT 24 /* Unknown AT command */
327 #define BTA_AG_AT_CBC_EVT 25  /* Battery Level report from HF */
328 #define BTA_AG_AT_BAC_EVT 26  /* avablable codec */
329 #define BTA_AG_AT_BCS_EVT 27  /* Codec select */
330 #define BTA_AG_AT_BIND_EVT 28 /* HF indicator */
331 #define BTA_AG_AT_BIEV_EVT 29 /* HF indicator updates from peer */
332 #define BTA_AG_AT_BIA_EVT 32  /* AG indicator activation event from peer */
333 
334 typedef uint8_t tBTA_AG_EVT;
335 
336 /* data associated with most non-AT events */
337 typedef struct {
338   uint16_t handle;
339   uint8_t app_id;
340   tBTA_AG_STATUS status;
341 } tBTA_AG_HDR;
342 
343 /* data associated with BTA_AG_REGISTER_EVT */
344 typedef struct {
345   tBTA_AG_HDR hdr;
346   tBTA_AG_STATUS status;
347 } tBTA_AG_REGISTER;
348 
349 /* data associated with BTA_AG_OPEN_EVT */
350 typedef struct {
351   tBTA_AG_HDR hdr;
352   RawAddress bd_addr;
353   tBTA_SERVICE_ID service_id;
354   tBTA_AG_STATUS status;
355 } tBTA_AG_OPEN;
356 
357 /* data associated with BTA_AG_CLOSE_EVT */
358 typedef struct {
359   tBTA_AG_HDR hdr;
360   RawAddress bd_addr;
361 } tBTA_AG_CLOSE;
362 
363 /* data associated with BTA_AG_CONN_EVT */
364 typedef struct {
365   tBTA_AG_HDR hdr;
366   tBTA_AG_PEER_FEAT peer_feat;
367   RawAddress bd_addr;
368   tBTA_AG_PEER_CODEC peer_codec;
369 } tBTA_AG_CONN;
370 
371 /* data associated with AT command event */
372 typedef struct {
373   tBTA_AG_HDR hdr;
374   RawAddress bd_addr;
375   char str[BTA_AG_AT_MAX_LEN + 1];
376   uint32_t num;
377   uint8_t idx;   /* call number used by CLCC and CHLD */
378   uint16_t lidx; /* long index, ex, HF indicator */
379 } tBTA_AG_VAL;
380 
381 /* union of data associated with AG callback */
382 typedef union {
383   tBTA_AG_HDR hdr;
384   tBTA_AG_REGISTER reg;
385   tBTA_AG_OPEN open;
386   tBTA_AG_CLOSE close;
387   tBTA_AG_CONN conn;
388   tBTA_AG_VAL val;
389 } tBTA_AG;
390 
391 /* AG callback */
392 typedef void(tBTA_AG_CBACK)(tBTA_AG_EVT event, tBTA_AG* p_data);
393 
394 /* indicator constants HFP 1.1 and later */
395 #define BTA_AG_IND_CALL 1      /* position of call indicator */
396 #define BTA_AG_IND_CALLSETUP 2 /* position of callsetup indicator */
397 #define BTA_AG_IND_SERVICE 3   /* position of service indicator */
398 
399 /* indicator constants HFP 1.5 and later */
400 #define BTA_AG_IND_SIGNAL 4   /* position of signal strength indicator */
401 #define BTA_AG_IND_ROAM 5     /* position of roaming indicator */
402 #define BTA_AG_IND_BATTCHG 6  /* position of battery charge indicator */
403 #define BTA_AG_IND_CALLHELD 7 /* position of callheld indicator */
404 #define BTA_AG_IND_BEARER 8   /* position of bearer indicator */
405 
406 /* call indicator values */
407 #define BTA_AG_CALL_INACTIVE 0 /* Phone call inactive */
408 #define BTA_AG_CALL_ACTIVE 1   /* Phone call active */
409 
410 /* callsetup indicator values */
411 #define BTA_AG_CALLSETUP_NONE 0     /* Not currently in call set up */
412 #define BTA_AG_CALLSETUP_INCOMING 1 /* Incoming call process ongoing */
413 #define BTA_AG_CALLSETUP_OUTGOING 2 /* Outgoing call set up is ongoing */
414 /* Remote party being alerted in an outgoing call */
415 #define BTA_AG_CALLSETUP_ALERTING 3
416 
417 /* service indicator values */
418 #define BTA_AG_SERVICE_NONE 0    /* Neither CS nor VoIP service is available */
419 #define BTA_AG_SERVICE_CS 1      /* Only CS service is available */
420 #define BTA_AG_SERVICE_VOIP 2    /* Only VoIP service is available */
421 #define BTA_AG_SERVICE_CS_VOIP 3 /* Both CS and VoIP services available */
422 
423 /* callheld indicator values */
424 #define BTA_AG_CALLHELD_INACTIVE 0 /* No held calls */
425 #define BTA_AG_CALLHELD_ACTIVE 1   /* Call held and call active */
426 #define BTA_AG_CALLHELD_NOACTIVE 2 /* Call held and no call active */
427 
428 /* signal strength indicator values */
429 #define BTA_AG_ROAMING_INACTIVE 0 /* Phone call inactive */
430 #define BTA_AG_ROAMING_ACTIVE 1   /* Phone call active */
431 
432 /* bearer indicator values */
433 #define BTA_AG_BEARER_WLAN 0      /* WLAN         */
434 #define BTA_AG_BEARER_BLUETOOTH 1 /* Bluetooth    */
435 #define BTA_AG_BEARER_WIRED 2     /* Wired        */
436 #define BTA_AG_BEARER_2G3G 3      /* 2G 3G        */
437 #define BTA_AG_BEARER_WIMAX 4     /* WIMAX        */
438 #define BTA_AG_BEARER_RES1 5      /* Reserved     */
439 #define BTA_AG_BEARER_RES2 6      /* Reserved     */
440 #define BTA_AG_BEARER_RES3 7      /* Reserved     */
441 
442 /* type for HF indicator */
443 typedef struct {
444   uint16_t ind_id;
445   bool is_supported;
446   bool is_enable;
447   uint32_t ind_min_val;
448   uint32_t ind_max_val;
449 } tBTA_AG_HF_IND;
450 
451 /* AG configuration structure */
452 typedef struct {
453   const char* cind_info;
454   const char* bind_info;
455   uint8_t num_local_hf_ind;
456   int32_t conn_tout;
457   uint16_t sco_pkt_types;
458   const char* chld_val_ecc;
459   const char* chld_val;
460 } tBTA_AG_CFG;
461 
462 /*****************************************************************************
463  *  External Function Declarations
464  ****************************************************************************/
465 
466 /*******************************************************************************
467  *
468  * Function         BTA_AgEnable
469  *
470  * Description      Enable the audio gateway service. When the enable
471  *                  operation is complete the callback function will be
472  *                  called with a BTA_AG_ENABLE_EVT. This function must
473  *                  be called before other function in the AG API are
474  *                  called.
475  *
476  * Returns          BTA_SUCCESS if OK, BTA_FAILURE otherwise.
477  *
478  ******************************************************************************/
479 tBTA_STATUS BTA_AgEnable(tBTA_AG_CBACK* p_cback);
480 
481 /*******************************************************************************
482  *
483  * Function         BTA_AgDisable
484  *
485  * Description      Disable the audio gateway service
486  *
487  *
488  * Returns          void
489  *
490  ******************************************************************************/
491 void BTA_AgDisable();
492 
493 /*******************************************************************************
494  *
495  * Function         BTA_AgRegister
496  *
497  * Description      Register an Audio Gateway service.
498  *
499  *
500  * Returns          void
501  *
502  ******************************************************************************/
503 void BTA_AgRegister(tBTA_SERVICE_MASK services, tBTA_SEC sec_mask,
504                     tBTA_AG_FEAT features,
505                     const std::vector<std::string>& service_names,
506                     uint8_t app_id);
507 
508 /*******************************************************************************
509  *
510  * Function         BTA_AgDeregister
511  *
512  * Description      Deregister an audio gateway service.
513  *
514  *
515  * Returns          void
516  *
517  ******************************************************************************/
518 void BTA_AgDeregister(uint16_t handle);
519 
520 /*******************************************************************************
521  *
522  * Function         BTA_AgOpen
523  *
524  * Description      Opens a connection to a headset or hands-free device.
525  *                  When connection is open callback function is called
526  *                  with a BTA_AG_OPEN_EVT. Only the data connection is
527  *                  opened. The audio connection is not opened.
528  *
529  *
530  * Returns          void
531  *
532  ******************************************************************************/
533 void BTA_AgOpen(uint16_t handle, const RawAddress& bd_addr, tBTA_SEC sec_mask);
534 
535 /*******************************************************************************
536  *
537  * Function         BTA_AgClose
538  *
539  * Description      Close the current connection to a headset or a handsfree
540  *                  Any current audio connection will also be closed
541  *
542  *
543  * Returns          void
544  *
545  ******************************************************************************/
546 void BTA_AgClose(uint16_t handle);
547 
548 /*******************************************************************************
549  *
550  * Function         BTA_AgAudioOpen
551  *
552  * Description      Opens an audio connection to the currently connected
553  *                  headset or hnadsfree
554  *
555  *
556  * Returns          void
557  *
558  ******************************************************************************/
559 void BTA_AgAudioOpen(uint16_t handle);
560 
561 /*******************************************************************************
562  *
563  * Function         BTA_AgAudioClose
564  *
565  * Description      Close the currently active audio connection to a headset
566  *                  or hnadsfree. The data connection remains open
567  *
568  *
569  * Returns          void
570  *
571  ******************************************************************************/
572 void BTA_AgAudioClose(uint16_t handle);
573 
574 /*******************************************************************************
575  *
576  * Function         BTA_AgResult
577  *
578  * Description      Send an AT result code to a headset or hands-free device.
579  *
580  *
581  * Returns          void
582  *
583  ******************************************************************************/
584 void BTA_AgResult(uint16_t handle, tBTA_AG_RES result,
585                   const tBTA_AG_RES_DATA& data);
586 
587 /*******************************************************************************
588  *
589  * Function         BTA_AgSetCodec
590  *
591  * Description      Specify the codec type to be used for the subsequent
592  *                  audio connection.
593  *
594  *
595  *
596  * Returns          void
597  *
598  ******************************************************************************/
599 void BTA_AgSetCodec(uint16_t handle, tBTA_AG_PEER_CODEC codec);
600 
601 void BTA_AgSetScoAllowed(bool value);
602 
603 void BTA_AgSetActiveDevice(const RawAddress& active_device_addr);
604 
605 #endif /* BTA_AG_API_H */
606