bta/include/bta_ag_api.h

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