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