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