bta/include/bta_mce_api.h

   1 /******************************************************************************
   2  *
   3  *  Copyright 2014 The Android Open Source Project
   4  *  Copyright 2006-2012 Broadcom Corporation
   5  *
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at:
   9  *
  10  *  http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  ******************************************************************************/
  19
  20 /******************************************************************************
  21  *
  22  *  This is the public interface file the BTA MCE I/F
  23  *
  24  ******************************************************************************/
  25 #ifndef BTA_MCE_API_H
  26 #define BTA_MCE_API_H
  27
  28 #include "bt_target.h"
  29 #include "bt_types.h"
  30 #include "bta_api.h"
  31 #include "btm_api.h"
  32
  33 /*****************************************************************************
  34  *  Constants and data types
  35  ****************************************************************************/
  36 /* status values */
  37 #define BTA_MCE_SUCCESS 0 /* Successful operation. */
  38 #define BTA_MCE_FAILURE 1 /* Generic failure. */
  39 #define BTA_MCE_BUSY 2    /* Temporarily can not handle this request. */
  40
  41 typedef uint8_t tBTA_MCE_STATUS;
  42
  43 /* MCE I/F callback events */
  44 /* events received by tBTA_MCE_DM_CBACK */
  45 #define BTA_MCE_ENABLE_EVT 0             /* MCE enabled */
  46 #define BTA_MCE_MAS_DISCOVERY_COMP_EVT 1 /* SDP MAS discovery complete */
  47 #define BTA_MCE_MAX_EVT 2                /* max number of MCE events */
  48
  49 #define BTA_MCE_MAX_MAS_INSTANCES 12
  50
  51 typedef uint16_t tBTA_MCE_EVT;
  52
  53 typedef struct {
  54   uint8_t scn;
  55   char* p_srv_name;
  56   uint16_t srv_name_len;
  57   uint8_t instance_id;
  58   uint8_t msg_type;
  59 } tBTA_MCE_MAS_INFO;
  60
  61 /* data associated with BTA_MCE_MAS_DISCOVERY_COMP_EVT */
  62 typedef struct {
  63   tBTA_MCE_STATUS status;
  64   RawAddress remote_addr;
  65   int num_mas;
  66   tBTA_MCE_MAS_INFO mas[BTA_MCE_MAX_MAS_INSTANCES];
  67 } tBTA_MCE_MAS_DISCOVERY_COMP;
  68
  69 /* union of data associated with MCE callback */
  70 typedef union {
  71   tBTA_MCE_STATUS status; /* BTA_MCE_ENABLE_EVT */
  72   tBTA_MCE_MAS_DISCOVERY_COMP
  73       mas_disc_comp; /* BTA_MCE_MAS_DISCOVERY_COMP_EVT */
  74 } tBTA_MCE;
  75
  76 /* MCE DM Interface callback */
  77 typedef void(tBTA_MCE_DM_CBACK)(tBTA_MCE_EVT event, tBTA_MCE* p_data,
  78                                 void* user_data);
  79
  80 /* MCE configuration structure */
  81 typedef struct {
  82   uint16_t sdp_db_size;        /* The size of p_sdp_db */
  83   tSDP_DISCOVERY_DB* p_sdp_db; /* The data buffer to keep SDP database */
  84 } tBTA_MCE_CFG;
  85
  86 /*****************************************************************************
  87  *  External Function Declarations
  88  ****************************************************************************/
  89
  90 /*******************************************************************************
  91  *
  92  * Function         BTA_MceEnable
  93  *
  94  * Description      Enable the MCE I/F service. When the enable
  95  *                  operation is complete the callback function will be
  96  *                  called with a BTA_MCE_ENABLE_EVT. This function must
  97  *                  be called before other functions in the MCE API are
  98  *                  called.
  99  *
 100  * Returns          BTA_MCE_SUCCESS if successful.
 101  *                  BTA_MCE_FAIL if internal failure.
 102  *
 103  ******************************************************************************/
 104 extern tBTA_MCE_STATUS BTA_MceEnable(tBTA_MCE_DM_CBACK* p_cback);
 105
 106 /*******************************************************************************
 107  *
 108  * Function         BTA_MceGetRemoteMasInstances
 109  *
 110  * Description      This function performs service discovery for the MAS service
 111  *                  by the given peer device. When the operation is completed
 112  *                  the tBTA_MCE_DM_CBACK callback function will be  called with
 113  *                  a BTA_MCE_MAS_DISCOVERY_COMP_EVT.
 114  *
 115  * Returns          BTA_MCE_SUCCESS, if the request is being processed.
 116  *                  BTA_MCE_FAILURE, otherwise.
 117  *
 118  ******************************************************************************/
 119 extern tBTA_MCE_STATUS BTA_MceGetRemoteMasInstances(const RawAddress& bd_addr);
 120
 121 #endif /* BTA_MCE_API_H */