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