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