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