Home | History | Annotate | Download | only in ag
      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 private interface file for the BTA audio gateway.
     22  *
     23  ******************************************************************************/
     24 #ifndef BTA_AG_INT_H
     25 #define BTA_AG_INT_H
     26 
     27 #include "bta_ag_api.h"
     28 #include "bta_ag_at.h"
     29 #include "bta_api.h"
     30 #include "bta_sys.h"
     31 
     32 /*****************************************************************************
     33  *  Constants
     34  ****************************************************************************/
     35 /* Number of SCBs (AG service instances that can be registered) */
     36 #ifndef BTA_AG_NUM_SCB
     37 #define BTA_AG_NUM_SCB 2
     38 #endif
     39 
     40 /* Time to wait for retry in case of collision */
     41 #ifndef BTA_AG_COLLISION_TIMEOUT_MS
     42 #define BTA_AG_COLLISION_TIMEOUT_MS (2 * 1000) /* 2 seconds */
     43 #endif
     44 
     45 /* RFCOMM MTU SIZE */
     46 #define BTA_AG_MTU 256
     47 
     48 /* Max number of peer and local HF indicators */
     49 #define BTA_AG_MAX_NUM_PEER_HF_IND 20
     50 #define BTA_AG_MAX_NUM_LOCAL_HF_IND 4
     51 
     52 /* Internal profile indexes */
     53 #define BTA_AG_HSP 0     /* index for HSP */
     54 #define BTA_AG_HFP 1     /* index for HFP */
     55 #define BTA_AG_NUM_IDX 2 /* number of profile indexes */
     56 
     57 /* profile role for connection */
     58 #define BTA_AG_ACP 0 /* accepted connection */
     59 #define BTA_AG_INT 1 /* initiating connection */
     60 
     61 /* feature mask that matches spec */
     62 #define BTA_AG_BSRF_FEAT_SPEC                                   \
     63   (BTA_AG_FEAT_3WAY | BTA_AG_FEAT_ECNR | BTA_AG_FEAT_VREC |     \
     64    BTA_AG_FEAT_INBAND | BTA_AG_FEAT_VTAG | BTA_AG_FEAT_REJECT | \
     65    BTA_AG_FEAT_ECS | BTA_AG_FEAT_ECC | BTA_AG_FEAT_EXTERR |     \
     66    BTA_AG_FEAT_CODEC | BTA_AG_FEAT_HF_IND | BTA_AG_FEAT_ESCO |  \
     67    BTA_AG_FEAT_VOIP)
     68 
     69 #define BTA_AG_SDP_FEAT_SPEC                                \
     70   (BTA_AG_FEAT_3WAY | BTA_AG_FEAT_ECNR | BTA_AG_FEAT_VREC | \
     71    BTA_AG_FEAT_INBAND | BTA_AG_FEAT_VTAG)
     72 
     73 enum {
     74   /* these events are handled by the state machine */
     75   BTA_AG_API_REGISTER_EVT = BTA_SYS_EVT_START(BTA_ID_AG),
     76   BTA_AG_API_DEREGISTER_EVT,
     77   BTA_AG_API_OPEN_EVT,
     78   BTA_AG_API_CLOSE_EVT,
     79   BTA_AG_API_AUDIO_OPEN_EVT,
     80   BTA_AG_API_AUDIO_CLOSE_EVT,
     81   BTA_AG_API_RESULT_EVT,
     82   BTA_AG_API_SETCODEC_EVT,
     83   BTA_AG_RFC_OPEN_EVT,
     84   BTA_AG_RFC_CLOSE_EVT,
     85   BTA_AG_RFC_SRV_CLOSE_EVT,
     86   BTA_AG_RFC_DATA_EVT,
     87   BTA_AG_SCO_OPEN_EVT,
     88   BTA_AG_SCO_CLOSE_EVT,
     89   BTA_AG_DISC_ACP_RES_EVT,
     90   BTA_AG_DISC_INT_RES_EVT,
     91   BTA_AG_DISC_OK_EVT,
     92   BTA_AG_DISC_FAIL_EVT,
     93   BTA_AG_CI_RX_WRITE_EVT,
     94   BTA_AG_RING_TIMEOUT_EVT,
     95   BTA_AG_SVC_TIMEOUT_EVT,
     96   BTA_AG_CI_SCO_DATA_EVT,
     97   BTA_AG_CI_SLC_READY_EVT,
     98   BTA_AG_MAX_EVT,
     99 
    100   /* these events are handled outside of the state machine */
    101   BTA_AG_API_ENABLE_EVT,
    102   BTA_AG_API_DISABLE_EVT
    103 };
    104 
    105 /* Actions to perform after a SCO event */
    106 enum {
    107   BTA_AG_POST_SCO_NONE,      /* no action */
    108   BTA_AG_POST_SCO_CLOSE_RFC, /* close RFCOMM channel after SCO closes */
    109   BTA_AG_POST_SCO_RING,      /* send RING result code after SCO opens */
    110   BTA_AG_POST_SCO_CALL_CONN, /* send call indicators after SCO opens/closes */
    111   BTA_AG_POST_SCO_CALL_ORIG, /* send call indicators after SCO closes */
    112   BTA_AG_POST_SCO_CALL_END,  /* send call indicators after SCO closes */
    113   BTA_AG_POST_SCO_CALL_END_INCALL /* send call indicators for end call &
    114                                      incoming call after SCO closes */
    115 };
    116 
    117 /* sco states */
    118 enum {
    119   BTA_AG_SCO_SHUTDOWN_ST,   /* no sco listening, all sco connections closed */
    120   BTA_AG_SCO_LISTEN_ST,     /* sco listening */
    121   BTA_AG_SCO_CODEC_ST,      /* sco codec negotiation */
    122   BTA_AG_SCO_OPENING_ST,    /* sco connection opening */
    123   BTA_AG_SCO_OPEN_CL_ST,    /* opening sco connection being closed */
    124   BTA_AG_SCO_OPEN_XFER_ST,  /* opening sco connection being transferred */
    125   BTA_AG_SCO_OPEN_ST,       /* sco open */
    126   BTA_AG_SCO_CLOSING_ST,    /* sco closing */
    127   BTA_AG_SCO_CLOSE_OP_ST,   /* closing sco being opened */
    128   BTA_AG_SCO_CLOSE_XFER_ST, /* closing sco being transferred */
    129   BTA_AG_SCO_SHUTTING_ST    /* sco shutting down */
    130 };
    131 
    132 /*****************************************************************************
    133  *  Data types
    134  ****************************************************************************/
    135 
    136 /* data type for BTA_AG_API_ENABLE_EVT */
    137 typedef struct {
    138   BT_HDR hdr;
    139   tBTA_AG_PARSE_MODE parse_mode;
    140   tBTA_AG_CBACK* p_cback;
    141 } tBTA_AG_API_ENABLE;
    142 
    143 /* data type for BTA_AG_API_REGISTER_EVT */
    144 typedef struct {
    145   BT_HDR hdr;
    146   char p_name[2][BTA_SERVICE_NAME_LEN + 1];
    147   tBTA_SERVICE_MASK services;
    148   tBTA_SEC sec_mask;
    149   tBTA_AG_FEAT features;
    150   uint8_t app_id;
    151 } tBTA_AG_API_REGISTER;
    152 
    153 /* data type for BTA_AG_API_OPEN_EVT */
    154 typedef struct {
    155   BT_HDR hdr;
    156   BD_ADDR bd_addr;
    157   tBTA_SERVICE_MASK services;
    158   tBTA_SEC sec_mask;
    159 } tBTA_AG_API_OPEN;
    160 
    161 /* data type for BTA_AG_API_RESULT_EVT */
    162 typedef struct {
    163   BT_HDR hdr;
    164   tBTA_AG_RES result;
    165   tBTA_AG_RES_DATA data;
    166 } tBTA_AG_API_RESULT;
    167 
    168 /* data type for BTA_AG_API_SETCODEC_EVT */
    169 typedef struct {
    170   BT_HDR hdr;
    171   tBTA_AG_PEER_CODEC codec;
    172 } tBTA_AG_API_SETCODEC;
    173 
    174 /* data type for BTA_AG_DISC_RESULT_EVT */
    175 typedef struct {
    176   BT_HDR hdr;
    177   uint16_t status;
    178 } tBTA_AG_DISC_RESULT;
    179 
    180 /* data type for RFCOMM events */
    181 typedef struct {
    182   BT_HDR hdr;
    183   uint16_t port_handle;
    184 } tBTA_AG_RFC;
    185 
    186 /* data type for BTA_AG_CI_RX_WRITE_EVT */
    187 typedef struct {
    188   BT_HDR hdr;
    189   //    char            p_data[BTA_AG_MTU+1];
    190 } tBTA_AG_CI_RX_WRITE;
    191 
    192 /* union of all event datatypes */
    193 typedef union {
    194   BT_HDR hdr;
    195   tBTA_AG_API_ENABLE api_enable;
    196   tBTA_AG_API_REGISTER api_register;
    197   tBTA_AG_API_OPEN api_open;
    198   tBTA_AG_API_RESULT api_result;
    199   tBTA_AG_API_SETCODEC api_setcodec;
    200   tBTA_AG_DISC_RESULT disc_result;
    201   tBTA_AG_RFC rfc;
    202   tBTA_AG_CI_RX_WRITE ci_rx_write;
    203 } tBTA_AG_DATA;
    204 
    205 /* type for each profile */
    206 typedef struct {
    207   uint32_t sdp_handle;
    208   uint8_t scn;
    209 } tBTA_AG_PROFILE;
    210 
    211 typedef enum {
    212   BTA_AG_SCO_MSBC_SETTINGS_T2 = 0, /* preferred/default when codec is mSBC */
    213   BTA_AG_SCO_MSBC_SETTINGS_T1,
    214 } tBTA_AG_SCO_MSBC_SETTINGS;
    215 
    216 /* type for each service control block */
    217 typedef struct {
    218   char clip[BTA_AG_AT_MAX_LEN + 1];     /* number string used for CLIP */
    219   uint16_t serv_handle[BTA_AG_NUM_IDX]; /* RFCOMM server handles */
    220   tBTA_AG_AT_CB at_cb;                  /* AT command interpreter */
    221   BD_ADDR peer_addr;                    /* peer bd address */
    222   tSDP_DISCOVERY_DB* p_disc_db;         /* pointer to discovery database */
    223   tBTA_SERVICE_MASK reg_services;       /* services specified in register API */
    224   tBTA_SERVICE_MASK open_services;      /* services specified in open API */
    225   uint16_t conn_handle;                 /* RFCOMM handle of connected service */
    226   tBTA_SEC serv_sec_mask;               /* server security mask */
    227   tBTA_SEC cli_sec_mask;                /* client security mask */
    228   tBTA_AG_FEAT features;                /* features registered by application */
    229   tBTA_AG_PEER_FEAT peer_features;      /* peer device features */
    230   uint16_t peer_version;                /* profile version of peer device */
    231   uint16_t hsp_version;                 /* HSP profile version before SDP */
    232   uint16_t sco_idx;                     /* SCO handle */
    233   bool in_use;                          /* scb in use */
    234   bool dealloc;                         /* true if service shutting down */
    235   bool clip_enabled;        /* set to true if HF enables CLIP reporting */
    236   bool ccwa_enabled;        /* set to true if HF enables CCWA reporting */
    237   bool cmer_enabled;        /* set to true if HF enables CMER reporting */
    238   bool cmee_enabled;        /* set to true if HF enables CME ERROR reporting */
    239   bool inband_enabled;      /* set to true if inband ring enabled */
    240   bool svc_conn;            /* set to true when service level connection up */
    241   uint8_t state;            /* state machine state */
    242   uint8_t conn_service;     /* connected service */
    243   uint8_t peer_scn;         /* peer scn */
    244   uint8_t app_id;           /* application id */
    245   uint8_t role;             /* initiator/acceptor role */
    246   uint8_t post_sco;         /* action to perform after sco event */
    247   uint8_t call_ind;         /* CIEV call indicator value */
    248   uint8_t callsetup_ind;    /* CIEV callsetup indicator value */
    249   uint8_t service_ind;      /* CIEV service indicator value */
    250   uint8_t signal_ind;       /* CIEV signal indicator value */
    251   uint8_t roam_ind;         /* CIEV roam indicator value */
    252   uint8_t battchg_ind;      /* CIEV battery charge indicator value */
    253   uint8_t callheld_ind;     /* CIEV call held indicator value */
    254   uint32_t bia_masked_out;  /* indicators HF does not want us to send */
    255   alarm_t* collision_timer;
    256   alarm_t* ring_timer;
    257   alarm_t* codec_negotiation_timer;
    258   tBTA_AG_PEER_CODEC peer_codecs; /* codecs for eSCO supported by the peer */
    259   tBTA_AG_PEER_CODEC sco_codec;   /* codec to be used for eSCO connection */
    260   tBTA_AG_PEER_CODEC
    261       inuse_codec;     /* codec being used for the current SCO connection */
    262   bool codec_updated;  /* set to true whenever the app updates codec type */
    263   bool codec_fallback; /* If sco nego fails for mSBC, fallback to CVSD */
    264   tBTA_AG_SCO_MSBC_SETTINGS
    265       codec_msbc_settings; /* settings to be used for the impending eSCO */
    266 
    267   tBTA_AG_HF_IND
    268       peer_hf_indicators[BTA_AG_MAX_NUM_PEER_HF_IND]; /* Peer supported
    269                                                   HF indicators */
    270   tBTA_AG_HF_IND
    271       local_hf_indicators[BTA_AG_MAX_NUM_LOCAL_HF_IND]; /* Local supported
    272                                                     HF indicators */
    273 } tBTA_AG_SCB;
    274 
    275 /* type for sco data */
    276 typedef struct {
    277   tBTM_ESCO_CONN_REQ_EVT_DATA conn_data; /* SCO data for pending conn request */
    278   tBTA_AG_SCB* p_curr_scb;  /* SCB associated with SCO connection */
    279   tBTA_AG_SCB* p_xfer_scb;  /* SCB associated with SCO transfer */
    280   uint16_t cur_idx;         /* SCO handle */
    281   uint8_t state;            /* SCO state variable */
    282   bool is_local;            /* SCO connection initiated locally or remotely */
    283 } tBTA_AG_SCO_CB;
    284 
    285 /* type for AG control block */
    286 typedef struct {
    287   tBTA_AG_SCB scb[BTA_AG_NUM_SCB];         /* service control blocks */
    288   tBTA_AG_PROFILE profile[BTA_AG_NUM_IDX]; /* profile-specific data */
    289   tBTA_AG_SCO_CB sco;                      /* SCO data */
    290   tBTA_AG_CBACK* p_cback;                  /* application callback */
    291   tBTA_AG_PARSE_MODE parse_mode;           /* parse/pass-through mode */
    292 } tBTA_AG_CB;
    293 
    294 /*****************************************************************************
    295  *  Global data
    296  ****************************************************************************/
    297 
    298 /* constant lookup tables */
    299 extern const uint16_t bta_ag_uuid[BTA_AG_NUM_IDX];
    300 extern const uint8_t bta_ag_sec_id[BTA_AG_NUM_IDX];
    301 extern const tBTA_AG_AT_CMD* bta_ag_at_tbl[BTA_AG_NUM_IDX];
    302 
    303 /* control block declaration */
    304 extern tBTA_AG_CB bta_ag_cb;
    305 
    306 /* config struct */
    307 extern tBTA_AG_CFG* p_bta_ag_cfg;
    308 extern const tBTA_AG_HF_IND bta_ag_local_hf_ind_cfg[];
    309 
    310 /*****************************************************************************
    311  *  Function prototypes
    312  ****************************************************************************/
    313 
    314 /* main functions */
    315 extern void bta_ag_scb_dealloc(tBTA_AG_SCB* p_scb);
    316 extern uint16_t bta_ag_scb_to_idx(tBTA_AG_SCB* p_scb);
    317 extern tBTA_AG_SCB* bta_ag_scb_by_idx(uint16_t idx);
    318 extern uint8_t bta_ag_service_to_idx(tBTA_SERVICE_MASK services);
    319 extern uint16_t bta_ag_idx_by_bdaddr(BD_ADDR peer_addr);
    320 extern bool bta_ag_other_scb_open(tBTA_AG_SCB* p_curr_scb);
    321 extern bool bta_ag_scb_open(tBTA_AG_SCB* p_curr_scb);
    322 extern tBTA_AG_SCB* bta_ag_get_other_idle_scb(tBTA_AG_SCB* p_curr_scb);
    323 extern void bta_ag_sm_execute(tBTA_AG_SCB* p_scb, uint16_t event,
    324                               tBTA_AG_DATA* p_data);
    325 extern bool bta_ag_hdl_event(BT_HDR* p_msg);
    326 extern void bta_ag_collision_cback(tBTA_SYS_CONN_STATUS status, uint8_t id,
    327                                    uint8_t app_id, BD_ADDR peer_addr);
    328 extern void bta_ag_resume_open(tBTA_AG_SCB* p_scb);
    329 
    330 /* SDP functions */
    331 extern bool bta_ag_add_record(uint16_t service_uuid, char* p_service_name,
    332                               uint8_t scn, tBTA_AG_FEAT features,
    333                               uint32_t sdp_handle);
    334 extern void bta_ag_create_records(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    335 extern void bta_ag_del_records(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    336 extern bool bta_ag_sdp_find_attr(tBTA_AG_SCB* p_scb, tBTA_SERVICE_MASK service);
    337 extern void bta_ag_do_disc(tBTA_AG_SCB* p_scb, tBTA_SERVICE_MASK service);
    338 extern void bta_ag_free_db(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    339 
    340 /* RFCOMM functions */
    341 extern void bta_ag_start_servers(tBTA_AG_SCB* p_scb,
    342                                  tBTA_SERVICE_MASK services);
    343 extern void bta_ag_close_servers(tBTA_AG_SCB* p_scb,
    344                                  tBTA_SERVICE_MASK services);
    345 extern bool bta_ag_is_server_closed(tBTA_AG_SCB* p_scb);
    346 extern void bta_ag_rfc_do_close(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    347 extern void bta_ag_rfc_do_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    348 
    349 /* SCO functions */
    350 extern bool bta_ag_sco_is_open(tBTA_AG_SCB* p_scb);
    351 extern bool bta_ag_sco_is_opening(tBTA_AG_SCB* p_scb);
    352 extern void bta_ag_sco_conn_rsp(tBTA_AG_SCB* p_scb,
    353                                 tBTM_ESCO_CONN_REQ_EVT_DATA* p_data);
    354 
    355 /* AT command functions */
    356 extern void bta_ag_at_hsp_cback(tBTA_AG_SCB* p_scb, uint16_t cmd,
    357                                 uint8_t arg_type, char* p_arg, int16_t int_arg);
    358 extern void bta_ag_at_hfp_cback(tBTA_AG_SCB* p_scb, uint16_t cmd,
    359                                 uint8_t arg_type, char* p_arg, int16_t int_arg);
    360 extern void bta_ag_at_err_cback(tBTA_AG_SCB* p_scb, bool unknown, char* p_arg);
    361 extern bool bta_ag_inband_enabled(tBTA_AG_SCB* p_scb);
    362 extern void bta_ag_send_call_inds(tBTA_AG_SCB* p_scb, tBTA_AG_RES result);
    363 
    364 /* Action functions */
    365 extern void bta_ag_register(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    366 extern void bta_ag_deregister(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    367 extern void bta_ag_start_dereg(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    368 extern void bta_ag_start_close(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    369 extern void bta_ag_start_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    370 extern void bta_ag_disc_int_res(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    371 extern void bta_ag_disc_acp_res(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    372 extern void bta_ag_disc_fail(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    373 extern void bta_ag_open_fail(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    374 extern void bta_ag_rfc_fail(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    375 extern void bta_ag_rfc_close(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    376 extern void bta_ag_rfc_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    377 extern void bta_ag_rfc_acp_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    378 extern void bta_ag_rfc_data(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    379 extern void bta_ag_sco_listen(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    380 extern void bta_ag_sco_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    381 extern void bta_ag_sco_close(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    382 extern void bta_ag_sco_codec_nego(tBTA_AG_SCB* p_scb, bool result);
    383 extern void bta_ag_codec_negotiate(tBTA_AG_SCB* p_scb);
    384 extern void bta_ag_sco_shutdown(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    385 extern void bta_ag_sco_conn_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    386 extern void bta_ag_sco_conn_close(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    387 extern void bta_ag_post_sco_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    388 extern void bta_ag_post_sco_close(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    389 extern void bta_ag_svc_conn_open(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    390 extern void bta_ag_result(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    391 extern void bta_ag_setcodec(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    392 extern void bta_ag_send_bcs(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    393 extern void bta_ag_send_ring(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    394 extern void bta_ag_ci_sco_data(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    395 extern void bta_ag_ci_rx_data(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    396 extern void bta_ag_rcvd_slc_ready(tBTA_AG_SCB* p_scb, tBTA_AG_DATA* p_data);
    397 
    398 #endif /* BTA_AG_INT_H */
    399