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 /* Values below are for HFP only */
162 #define BTA_AG_AT_A_EVT         10 /* Answer a incoming call */
163 #define BTA_AG_AT_D_EVT         11 /* Place a call using number or memory dial */
164 #define BTA_AG_AT_CHLD_EVT      12 /* Call hold */
165 #define BTA_AG_AT_CHUP_EVT      13 /* Hang up a call */
166 #define BTA_AG_AT_CIND_EVT      14 /* Read indicator settings */
167 #define BTA_AG_AT_VTS_EVT       15 /* Transmit DTMF tone */
168 #define BTA_AG_AT_BINP_EVT      16 /* Retrieve number from voice tag */
169 #define BTA_AG_AT_BLDN_EVT      17 /* Place call to last dialed number */
170 #define BTA_AG_AT_BVRA_EVT      18 /* Enable/disable voice recognition */
171 #define BTA_AG_AT_NREC_EVT      19 /* Disable echo canceling */
172 #define BTA_AG_AT_CNUM_EVT      20 /* Retrieve subscriber number */
173 #define BTA_AG_AT_BTRH_EVT      21 /* CCAP-style incoming call hold */
174 #define BTA_AG_AT_CLCC_EVT      22 /* Query list of current calls */
175 #define BTA_AG_AT_COPS_EVT      23 /* Query Current Operator Name on AG */
176 #define BTA_AG_AT_UNAT_EVT      24 /* Unknown AT command */
177 #define BTA_AG_AT_CBC_EVT       25 /* Indicator Update */
178 #define BTA_AG_AT_BAC_EVT       26 /* avablable codec */
179 #define BTA_AG_AT_BCS_EVT       27 /* Codec select */
180 typedef UINT8 tBTA_AG_EVT;
181 
182 /* HFP errcode - Set when BTA_AG_OK_ERROR is returned in 'ok_flag' */
183 #define BTA_AG_ERR_PHONE_FAILURE    0       /* Phone Failure */
184 #define BTA_AG_ERR_NO_CONN_PHONE    1       /* No connection to phone */
185 #define BTA_AG_ERR_OP_NOT_ALLOWED   3       /* Operation not allowed */
186 #define BTA_AG_ERR_OP_NOT_SUPPORTED 4       /* Operation not supported */
187 #define BTA_AG_ERR_PHSIM_PIN_REQ    5       /* PH-SIM PIN required */
188 #define BTA_AG_ERR_SIM_NOT_INSERTED 10      /* SIM not inserted */
189 #define BTA_AG_ERR_SIM_PIN_REQ      11      /* SIM PIN required */
190 #define BTA_AG_ERR_SIM_PUK_REQ      12      /* SIM PUK required */
191 #define BTA_AG_ERR_SIM_FAILURE      13      /* SIM failure */
192 #define BTA_AG_ERR_SIM_BUSY         14      /* SIM busy */
193 #define BTA_AG_ERR_INCORRECT_PWD    16      /* Incorrect password */
194 #define BTA_AG_ERR_SIM_PIN2_REQ     17      /* SIM PIN2 required */
195 #define BTA_AG_ERR_SIM_PUK2_REQ     18      /* SIM PUK2 required */
196 #define BTA_AG_ERR_MEMORY_FULL      20      /* Memory full */
197 #define BTA_AG_ERR_INVALID_INDEX    21      /* Invalid index */
198 #define BTA_AG_ERR_MEMORY_FAILURE   23      /* Memory failure */
199 #define BTA_AG_ERR_TEXT_TOO_LONG    24      /* Text string too long */
200 #define BTA_AG_ERR_INV_CHAR_IN_TSTR 25      /* Invalid characters in text string */
201 #define BTA_AG_ERR_DSTR_TOO_LONG    26      /* Dial string too long */
202 #define BTA_AG_ERR_INV_CHAR_IN_DSTR 27      /* Invalid characters in dial string */
203 #define BTA_AG_ERR_NO_NETWORK_SERV  30      /* No network service */
204 #define BTA_AG_ERR_NETWORK_TIME_OUT 31      /* Network timeout */
205 #define BTA_AG_ERR_NO_NET_EMG_ONLY  32      /* Network not allowed - emergency service only */
206 #define BTA_AG_ERR_VOIP_CS_CALLS    33      /* AG cannot create simultaneous VoIP and CS calls */
207 #define BTA_AG_ERR_NOT_FOR_VOIP     34      /* Not supported on this call type(VoIP) */
208 #define BTA_AG_ERR_SIP_RESP_CODE    35      /* SIP 3 digit response code */
209 typedef UINT8 tBTA_AG_ERR_TYPE;
210 
211 #if 0   /* Not Used in Bluetooth HFP 1.5 Specification */
212 #define BTA_AG_ERR_PHADAP_LNK_RES   2       /* Phone-adapter link reserved */
213 #define BTA_AG_ERR_PHFSIM_PIN_REQ   6       /* PH-FSIM PIN required */
214 #define BTA_AG_ERR_PHFSIM_PUK_REQ   7       /* PH-FSIM PUK required */
215 #define BTA_AG_ERR_SIM_WRONG        15      /* SIM wrong */
216 #define BTA_AG_ERR_NOT_FOUND        22      /* Not found */
217 #define BTA_AG_ERR_NETWORK_TIMEOUT  31      /* Network timeout */
218 #define BTA_AG_ERR_NET_PIN_REQ      40      /* Network personalization PIN required */
219 #define BTA_AG_ERR_NET_PUK_REQ      41      /* Network personalization PUK required */
220 #define BTA_AG_ERR_SUBSET_PIN_REQ   42      /* Network subset personalization PIN required */
221 #define BTA_AG_ERR_SUBSET_PUK_REQ   43      /* Network subset personalization PUK required */
222 #define BTA_AG_ERR_SERVPRO_PIN_REQ  44      /* Service provider personalization PIN required */
223 #define BTA_AG_ERR_SERVPRO_PUK_REQ  45      /* Service provider personalization PUK required */
224 #define BTA_AG_ERR_CORP_PIN_REQ     46      /* Corporate personalization PIN required */
225 #define BTA_AG_ERR_CORP_PUK_REQ     47      /* Corporate personalization PUK required */
226 #define BTA_AG_ERR_UNKNOWN          100    /* Unknown error */
227 /* GPRS-related errors */
228 #define BTA_AG_ERR_ILL_MS           103    /* Illegal MS (#3) */
229 #define BTA_AG_ERR_ILL_ME           106    /* Illegal ME (#6) */
230 #define BTA_AG_ERR_GPRS_NOT_ALLOWED 107    /* GPRS services not allowed (#7) */
231 #define BTA_AG_ERR_PLMN_NOT_ALLOWED 111    /* PLMN services not allowed (#11) */
232 #define BTA_AG_ERR_LOC_NOT_ALLOWED  112    /* Location area not allowed (#12) */
233 #define BTA_AG_ERR_ROAM_NOT_ALLOWED 113    /* Roaming not allowed in this location area (#13) */
234 /* Errors related to a failure to Activate a Context */
235 #define BTA_AG_ERR_OPT_NOT_SUPP     132    /* Service option not supported (#32) */
236 #define BTA_AG_ERR_OPT_NOT_SUBSCR   133    /* Requested service option not subscribed (#33) */
237 #define BTA_AG_ERR_OPT_OUT_OF_ORDER 134    /* Service option temporarily out of order (#34) */
238 #define BTA_AG_ERR_PDP_AUTH_FAILURE 149    /* PDP authentication failure */
239 /* Other GPRS errors */
240 #define BTA_AG_ERR_INV_MOBILE_CLASS 150    /* Invalid mobile class */
241 #define BTA_AG_ERR_UNSPEC_GPRS_ERR  148    /* Unspecified GPRS error */
242 #endif  /* Unused error codes */
243 
244 /* HFP result data 'ok_flag' */
245 #define BTA_AG_OK_CONTINUE          0       /* Send out response (more responses coming) */
246 #define BTA_AG_OK_DONE              1       /* Send out response followed by OK (finished) */
247 #define BTA_AG_OK_ERROR             2       /* Error response */
248 typedef UINT8 tBTA_AG_AT_RESULT_TYPE;
249 
250 /* BTRH values */
251 #define BTA_AG_BTRH_SET_HOLD        0       /* Put incoming call on hold */
252 #define BTA_AG_BTRH_SET_ACC         1       /* Accept incoming call on hold */
253 #define BTA_AG_BTRH_SET_REJ         2       /* Reject incoming call on hold */
254 #define BTA_AG_BTRH_READ            3       /* Read the current value */
255 #define BTA_AG_BTRH_NO_RESP         4       /* Not in RH States (reply to read) */
256 typedef UINT8 tBTA_AG_BTRH_TYPE;
257 
258 /* ASCII character string of arguments to the AT command or result */
259 #ifndef BTA_AG_AT_MAX_LEN
260 #define BTA_AG_AT_MAX_LEN           256
261 #endif
262 
263 /* indicator constants HFP 1.1 and later */
264 #define BTA_AG_IND_CALL             0   /* position of call indicator */
265 #define BTA_AG_IND_CALLSETUP        1   /* position of callsetup indicator */
266 #define BTA_AG_IND_SERVICE          2   /* position of service indicator */
267 /* indicator constants HFP 1.5 and later */
268 #define BTA_AG_IND_SIGNAL           3   /* position of signal strength indicator */
269 #define BTA_AG_IND_ROAM             4   /* position of roaming indicator */
270 #define BTA_AG_IND_BATTCHG          5   /* position of battery charge indicator */
271 #define BTA_AG_IND_CALLHELD         6   /* position of callheld indicator */
272 #define BTA_AG_IND_BEARER           7   /* position of bearer indicator */
273 typedef UINT16 tBTA_AG_IND_TYPE;
274 
275 /* call indicator values */
276 #define BTA_AG_CALL_INACTIVE        0   /* Phone call inactive */
277 #define BTA_AG_CALL_ACTIVE          1   /* Phone call active */
278 /* callsetup indicator values */
279 #define BTA_AG_CALLSETUP_NONE       0   /* Not currently in call set up */
280 #define BTA_AG_CALLSETUP_INCOMING   1   /* Incoming call process ongoing */
281 #define BTA_AG_CALLSETUP_OUTGOING   2   /* Outgoing call set up is ongoing */
282 #define BTA_AG_CALLSETUP_ALERTING   3   /* Remote party being alerted in an outgoing call */
283 /* service indicator values */
284 #define BTA_AG_SERVICE_NONE         0   /* Neither CS nor VoIP service is available     */
285 #define BTA_AG_SERVICE_CS           1   /* Only CS service is available                 */
286 #define BTA_AG_SERVICE_VOIP         2   /* Only VoIP service is available               */
287 #define BTA_AG_SERVICE_CS_VOIP      3   /* Both CS and VoIP services available          */
288 /* callheld indicator values */
289 #define BTA_AG_CALLHELD_INACTIVE    0   /* No held calls */
290 #define BTA_AG_CALLHELD_ACTIVE      1   /* Call held and call active */
291 #define BTA_AG_CALLHELD_NOACTIVE    2   /* Call held and no call active */
292 /* signal strength indicator values */
293 #define BTA_AG_ROAMING_INACTIVE     0   /* Phone call inactive */
294 #define BTA_AG_ROAMING_ACTIVE       1   /* Phone call active */
295 /* bearer indicator values */
296 #define BTA_AG_BEARER_WLAN          0   /* WLAN         */
297 #define BTA_AG_BEARER_BLUETOOTH     1   /* Bluetooth    */
298 #define BTA_AG_BEARER_WIRED         2   /* Wired        */
299 #define BTA_AG_BEARER_2G3G          3   /* 2G 3G        */
300 #define BTA_AG_BEARER_WIMAX         4   /* WIMAX        */
301 #define BTA_AG_BEARER_RES1          5   /* Reserved     */
302 #define BTA_AG_BEARER_RES2          6   /* Reserved     */
303 #define BTA_AG_BEARER_RES3          7   /* Reserved     */
304 
305 /* data associated with BTA_AG_IND_RES */
306 typedef struct
307 {
308     tBTA_AG_IND_TYPE  type;
309     UINT16            value;
310 } tBTA_AG_IND;
311 
312 /* data type for BTA_AgResult() */
313 typedef struct
314 {
315     char            str[BTA_AG_AT_MAX_LEN+1]; /* used for cops,clcc,cnum... */
316     tBTA_AG_IND     ind;            /* used for indicator type */
317     UINT16          num;            /* used for codec state */
318     UINT16          audio_handle;   /* used for audio path */
319     UINT16          errcode;        /* Valid only if 'ok_flag' is set to BTA_AG_OK_ERROR */
320     UINT8           ok_flag;        /* Indicates if response is finished, and if error occurred */
321     BOOLEAN         state;
322 } tBTA_AG_RES_DATA;
323 
324 /* data associated with most non-AT events */
325 typedef struct
326 {
327     UINT16              handle;
328     UINT8               app_id;
329     tBTA_AG_STATUS      status;
330 } tBTA_AG_HDR;
331 
332 /* data associated with BTA_AG_REGISTER_EVT */
333 typedef struct
334 {
335     tBTA_AG_HDR         hdr;
336 } tBTA_AG_REGISTER;
337 
338 /* data associated with BTA_AG_OPEN_EVT */
339 typedef struct
340 {
341     tBTA_AG_HDR         hdr;
342     BD_ADDR             bd_addr;
343     tBTA_SERVICE_ID     service_id;
344 } tBTA_AG_OPEN;
345 
346 /* data associated with BTA_AG_CLOSE_EVT */
347 typedef struct
348 {
349     tBTA_AG_HDR         hdr;
350     BD_ADDR             bd_addr;
351 } tBTA_AG_CLOSE;
352 
353 /* data associated with BTA_AG_CONN_EVT */
354 typedef struct
355 {
356     tBTA_AG_HDR         hdr;
357     tBTA_AG_PEER_FEAT   peer_feat;
358     BD_ADDR             bd_addr;
359     tBTA_AG_PEER_CODEC  peer_codec;
360     tBTA_AG_CHLD_FEAT   chld_feat;
361 } tBTA_AG_CONN;
362 
363 /* data associated with AT command event */
364 typedef struct
365 {
366     tBTA_AG_HDR         hdr;
367     BD_ADDR             bd_addr;
368     char                str[BTA_AG_AT_MAX_LEN+1];
369     UINT16              num;    /* voice recognition state*/
370     UINT8               idx;    /* call number used by CLCC and CHLD */
371     UINT16              value;
372 } tBTA_AG_VAL;
373 
374 /* data associated with BTA_AG_CLIP_EVT and BTA_AG_CCWA_EVT*/
375 #define BTA_AG_NUMBER_LEN 32
376 typedef struct {
377     char      number[BTA_AG_NUMBER_LEN + 1];
378 } tBTA_AG_NUMBER;
379 
380 /* data associated with BTA_HF_CLIENT_OPERATOR_NAME_EVT */
381 #define BTA_AG_COPS_LEN 16
382 typedef struct {
383     char      name[BTA_AG_COPS_LEN + 1];
384 } tBTA_AG_COPS;
385 
386 /* data associated with BTA_AG_AT_RESULT_EVT event */
387 typedef struct {
388     tBTA_AG_AT_RESULT_TYPE      type;
389     UINT16                      cme;
390 } tBTA_AG_AT_RESULT;
391 
392 /* data associated with BTA_AG_CLCC_EVT event */
393 typedef struct {
394     UINT32                     idx;
395     BOOLEAN                    inc;
396     UINT8                      status;
397     BOOLEAN                    mpty;
398     BOOLEAN                    number_present;
399     char                       number[BTA_AG_NUMBER_LEN + 1];
400 } tBTA_AG_CLCC;
401 
402 /* data associated with BTA_AG_CNUM_EVT event */
403 typedef struct {
404     UINT16                     service;
405     char                       number[BTA_AG_NUMBER_LEN + 1];
406 } tBTA_AG_CNUM;
407 
408 /* union of data associated with AG callback */
409 typedef union
410 {
411     tBTA_AG_HDR              hdr;
412     tBTA_AG_REGISTER         reg;
413     tBTA_AG_OPEN             open;
414     tBTA_AG_CLOSE            close;
415     tBTA_AG_CONN             conn;
416     tBTA_AG_IND              ind;
417     tBTA_AG_VAL              val;
418     //add
419     tBTA_AG_COPS             operator;
420     tBTA_AG_NUMBER           number;
421     tBTA_AG_AT_RESULT        result;
422     tBTA_AG_CLCC             clcc;
423     tBTA_AG_CNUM             cnum;
424 } tBTA_AG;
425 
426 /* AG callback */
427 typedef void (tBTA_AG_CBACK)(tBTA_AG_EVT event, tBTA_AG *p_data);
428 
429 /* AG configuration structure */
430 typedef struct
431 {
432     char         *cind_info;
433     INT32        conn_tout;
434     UINT16       sco_pkt_types;
435     char         *chld_val_ecc;
436     char         *chld_val;
437 } tBTA_AG_CFG;
438 
439 #ifdef __cplusplus
440 extern "C"
441 {
442 #endif
443 
444 /*****************************************************************************
445 **  External Function Declarations
446 *****************************************************************************/
447 
448 /*******************************************************************************
449 **
450 ** Function         BTA_AgEnable
451 **
452 ** Description      Enable the audio gateway service. When the enable
453 **                  operation is complete the callback function will be
454 **                  called with a BTA_AG_ENABLE_EVT. This function must
455 **                  be called before other function in the AG API are
456 **                  called.
457 **
458 ** Returns          BTA_SUCCESS if OK, BTA_FAILURE otherwise.
459 **
460 *******************************************************************************/
461 tBTA_STATUS BTA_AgEnable(tBTA_AG_PARSE_MODE parse_mode, tBTA_AG_CBACK *p_cback);
462 
463 /*******************************************************************************
464 **
465 ** Function         BTA_AgDisable
466 **
467 ** Description      Disable the audio gateway service
468 **
469 **
470 ** Returns          void
471 **
472 *******************************************************************************/
473 void BTA_AgDisable(void);
474 
475 /*******************************************************************************
476 **
477 ** Function         BTA_AgRegister
478 **
479 ** Description      Register an Audio Gateway service.
480 **
481 **
482 ** Returns          void
483 **
484 *******************************************************************************/
485 void BTA_AgRegister(tBTA_SERVICE_MASK services, tBTA_SEC sec_mask,
486                     tBTA_AG_FEAT features, char *p_service_names[], UINT8 app_id);
487 
488 /*******************************************************************************
489 **
490 ** Function         BTA_AgDeregister
491 **
492 ** Description      Deregister an audio gateway service.
493 **
494 **
495 ** Returns          void
496 **
497 *******************************************************************************/
498 void BTA_AgDeregister(UINT16 handle);
499 
500 /*******************************************************************************
501 **
502 ** Function         BTA_AgOpen
503 **
504 ** Description      Opens a connection to a headset or hands-free device.
505 **                  When connection is open callback function is called
506 **                  with a BTA_AG_OPEN_EVT. Only the data connection is
507 **                  opened. The audio connection is not opened.
508 **
509 **
510 ** Returns          void
511 **
512 *******************************************************************************/
513 void BTA_AgOpen(UINT16 handle, BD_ADDR bd_addr, tBTA_SEC sec_mask, tBTA_SERVICE_MASK services);
514 
515 /*******************************************************************************
516 **
517 ** Function         BTA_AgClose
518 **
519 ** Description      Close the current connection to a headset or a handsfree
520 **                  Any current audio connection will also be closed
521 **
522 **
523 ** Returns          void
524 **
525 *******************************************************************************/
526 void BTA_AgClose(UINT16 handle);
527 
528 /*******************************************************************************
529 **
530 ** Function         BTA_AgAudioOpen
531 **
532 ** Description      Opens an audio connection to the currently connected
533 **                  headset or hnadsfree
534 **
535 **
536 ** Returns          void
537 **
538 *******************************************************************************/
539 void BTA_AgAudioOpen(UINT16 handle);
540 
541 /*******************************************************************************
542 **
543 ** Function         BTA_AgAudioClose
544 **
545 ** Description      Close the currently active audio connection to a headset
546 **                  or hnadsfree. The data connection remains open
547 **
548 **
549 ** Returns          void
550 **
551 *******************************************************************************/
552 void BTA_AgAudioClose(UINT16 handle);
553 
554 /*******************************************************************************
555 **
556 ** Function         BTA_AgResult
557 **
558 ** Description      Send an AT result code to a headset or hands-free device.
559 **                  This function is only used when the AG parse mode is set
560 **                  to BTA_AG_PARSE.
561 **
562 **
563 ** Returns          void
564 **
565 *******************************************************************************/
566 void BTA_AgResult(UINT16 handle, tBTA_AG_RES result, tBTA_AG_RES_DATA *p_data);
567 
568 /*******************************************************************************
569 **
570 ** Function         BTA_AgSetCodec
571 **
572 ** Description      Specify the codec type to be used for the subsequent
573 **                  audio connection.
574 **
575 **
576 **
577 ** Returns          void
578 **
579 *******************************************************************************/
580 void BTA_AgSetCodec(UINT16 handle, tBTA_AG_PEER_CODEC codec);
581 
582 
583 #if (BTM_SCO_HCI_INCLUDED == TRUE )
584 /*******************************************************************************
585 **
586 ** Function         BTA_AgCiData
587 **
588 ** Description      Give an EVT to BTA that tell outgoing data is ready.
589 **
590 **
591 ** Returns          void
592 **
593 *******************************************************************************/
594 void BTA_AgCiData(UINT16 handle);
595 #endif /*#if (BTM_SCO_HCI_INCLUDED == TRUE ) */
596 
597 #ifdef __cplusplus
598 }
599 #endif
600 
601 #endif /* #if (BTA_AG_INCLUDED == TRUE) */
602 
603 #endif /* BTA_HF_API_H */
604