bta/sys/bta_sys.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 BTA system manager.
  22  *
  23  ******************************************************************************/
  24 #ifndef BTA_SYS_H
  25 #define BTA_SYS_H
  26
  27 #include "bt_common.h"
  28 #include "bt_target.h"
  29 #include "osi/include/alarm.h"
  30
  31 #include <base/logging.h>
  32 #include <base/threading/thread.h>
  33
  34 /*****************************************************************************
  35  *  Constants and data types
  36  ****************************************************************************/
  37
  38 /* vendor specific event handler function type */
  39 typedef bool(tBTA_SYS_VS_EVT_HDLR)(uint16_t evt, void* p);
  40
  41 /* event handler function type */
  42 typedef bool(tBTA_SYS_EVT_HDLR)(BT_HDR* p_msg);
  43
  44 /* disable function type */
  45 typedef void(tBTA_SYS_DISABLE)(void);
  46
  47 /* HW modules */
  48 enum {
  49   BTA_SYS_HW_BLUETOOTH,
  50   BTA_SYS_HW_RT,
  51
  52   BTA_SYS_MAX_HW_MODULES
  53 };
  54
  55 typedef uint16_t tBTA_SYS_HW_MODULE;
  56
  57 #ifndef BTA_DM_NUM_JV_ID
  58 #define BTA_DM_NUM_JV_ID 2
  59 #endif
  60
  61 /* SW sub-systems */
  62 #define BTA_ID_SYS 0 /* system manager */
  63 /* BLUETOOTH PART - from 0 to BTA_ID_BLUETOOTH_MAX */
  64 #define BTA_ID_DM 1             /* device manager */
  65 #define BTA_ID_DM_SEARCH 2      /* device manager search */
  66 #define BTA_ID_DM_SEC 3         /* device manager security */
  67 #define BTA_ID_DG 4             /* data gateway */
  68 #define BTA_ID_AG 5             /* audio gateway */
  69 #define BTA_ID_OPC 6            /* object push client */
  70 #define BTA_ID_OPS 7            /* object push server */
  71 #define BTA_ID_FTS 8            /* file transfer server */
  72 #define BTA_ID_CT 9             /* cordless telephony terminal */
  73 #define BTA_ID_FTC 10           /* file transfer client */
  74 #define BTA_ID_SS 11            /* synchronization server */
  75 #define BTA_ID_PR 12            /* Printer client */
  76 #define BTA_ID_BIC 13           /* Basic Imaging Client */
  77 #define BTA_ID_PAN 14           /* Personal Area Networking */
  78 #define BTA_ID_BIS 15           /* Basic Imaging Server */
  79 #define BTA_ID_ACC 16           /* Advanced Camera Client */
  80 #define BTA_ID_SC 17            /* SIM Card Access server */
  81 #define BTA_ID_AV 18            /* Advanced audio/video */
  82 #define BTA_ID_AVK 19           /* Audio/video sink */
  83 #define BTA_ID_HD 20            /* HID Device */
  84 #define BTA_ID_CG 21            /* Cordless Gateway */
  85 #define BTA_ID_BP 22            /* Basic Printing Client */
  86 #define BTA_ID_HH 23            /* Human Interface Device Host */
  87 #define BTA_ID_PBS 24           /* Phone Book Access Server */
  88 #define BTA_ID_PBC 25           /* Phone Book Access Client */
  89 #define BTA_ID_JV 26            /* Java */
  90 #define BTA_ID_HS 27            /* Headset */
  91 #define BTA_ID_MSE 28           /* Message Server Equipment */
  92 #define BTA_ID_MCE 29           /* Message Client Equipment */
  93 #define BTA_ID_HL 30            /* Health Device Profile*/
  94 #define BTA_ID_GATTC 31         /* GATT Client */
  95 #define BTA_ID_GATTS 32         /* GATT Client */
  96 #define BTA_ID_SDP 33           /* SDP Client */
  97 #define BTA_ID_BLUETOOTH_MAX 34 /* last BT profile */
  98
  99 /* GENERIC */
 100 #define BTA_ID_PRM 38
 101 #define BTA_ID_SYSTEM 39  /* platform-specific */
 102 #define BTA_ID_SWRAP 40   /* Insight script wrapper */
 103 #define BTA_ID_MIP 41     /* Multicase Individual Polling */
 104 #define BTA_ID_RT 42      /* Audio Routing module: This module is always on. */
 105 #define BTA_ID_CLOSURE 43 /* Generic C++ closure  */
 106
 107 /* JV */
 108 #define BTA_ID_JV1 44 /* JV1 */
 109 #define BTA_ID_JV2 45 /* JV2 */
 110
 111 #define BTA_ID_MAX (44 + BTA_DM_NUM_JV_ID)
 112
 113 typedef uint8_t tBTA_SYS_ID;
 114
 115 #define BTA_SYS_CONN_OPEN 0x00
 116 #define BTA_SYS_CONN_CLOSE 0x01
 117 #define BTA_SYS_APP_OPEN 0x02
 118 #define BTA_SYS_APP_CLOSE 0x03
 119 #define BTA_SYS_SCO_OPEN 0x04
 120 #define BTA_SYS_SCO_CLOSE 0x05
 121 #define BTA_SYS_CONN_IDLE 0x06
 122 #define BTA_SYS_CONN_BUSY 0x07
 123
 124 /* for link policy */
 125 #define BTA_SYS_PLCY_SET 0x10     /* set the link policy to the given addr */
 126 #define BTA_SYS_PLCY_CLR 0x11     /* clear the link policy to the given addr */
 127 #define BTA_SYS_PLCY_DEF_SET 0x12 /* set the default link policy */
 128 #define BTA_SYS_PLCY_DEF_CLR 0x13 /* clear the default link policy */
 129 #define BTA_SYS_ROLE_CHANGE 0x14  /* role change */
 130
 131 typedef uint8_t tBTA_SYS_CONN_STATUS;
 132
 133 /* Bitmask of sys features */
 134 #define BTA_SYS_FEAT_PCM2 0x0001
 135 #define BTA_SYS_FEAT_PCM2_MASTER 0x0002
 136
 137 /* tBTA_PREF_ROLES */
 138 typedef uint8_t tBTA_SYS_PREF_ROLES;
 139
 140 /* conn callback for role / low power manager*/
 141 typedef void(tBTA_SYS_CONN_CBACK)(tBTA_SYS_CONN_STATUS status, uint8_t id,
 142                                   uint8_t app_id, const RawAddress* peer_addr);
 143
 144 /* conn callback for role / low power manager*/
 145 typedef void(tBTA_SYS_SSR_CFG_CBACK)(uint8_t id, uint8_t app_id,
 146                                      uint16_t latency, uint16_t tout);
 147
 148 #if (BTA_EIR_CANNED_UUID_LIST != TRUE)
 149 /* eir callback for adding/removeing UUID */
 150 typedef void(tBTA_SYS_EIR_CBACK)(uint16_t uuid16, bool adding);
 151 #endif
 152
 153 /* registration structure */
 154 typedef struct {
 155   tBTA_SYS_EVT_HDLR* evt_hdlr;
 156   tBTA_SYS_DISABLE* disable;
 157 } tBTA_SYS_REG;
 158
 159 /* data type to send events to BTA SYS HW manager */
 160 typedef struct {
 161   BT_HDR hdr;
 162   tBTA_SYS_HW_MODULE hw_module;
 163 } tBTA_SYS_HW_MSG;
 164
 165 typedef void (*tBTA_SYS_REGISTER)(uint8_t id, const tBTA_SYS_REG* p_reg);
 166
 167 /*****************************************************************************
 168  *  Global data
 169  ****************************************************************************/
 170
 171 /* trace level */
 172 extern uint8_t appl_trace_level;
 173
 174 /*****************************************************************************
 175  *  Macros
 176  ****************************************************************************/
 177
 178 /* Calculate start of event enumeration; id is top 8 bits of event */
 179 #define BTA_SYS_EVT_START(id) ((id) << 8)
 180
 181 /*****************************************************************************
 182  *  events for BTA SYS HW manager
 183  ****************************************************************************/
 184
 185 /* events sent to SYS HW manager - must be kept synchronized with tables in
 186  * bta_sys_main.cc */
 187 enum {
 188   /* device manager local device API events */
 189   BTA_SYS_API_ENABLE_EVT = BTA_SYS_EVT_START(BTA_ID_SYS),
 190   BTA_SYS_EVT_ENABLED_EVT,
 191   BTA_SYS_EVT_STACK_ENABLED_EVT,
 192   BTA_SYS_API_DISABLE_EVT,
 193   BTA_SYS_EVT_DISABLED_EVT,
 194   BTA_SYS_ERROR_EVT,
 195
 196   BTA_SYS_MAX_EVT
 197 };
 198
 199 /* SYS HW status events - returned by SYS HW manager to other modules. */
 200 enum {
 201   BTA_SYS_HW_OFF_EVT,
 202   BTA_SYS_HW_ON_EVT,
 203   BTA_SYS_HW_STARTING_EVT,
 204   BTA_SYS_HW_STOPPING_EVT,
 205   BTA_SYS_HW_ERROR_EVT
 206
 207 };
 208 typedef uint8_t tBTA_SYS_HW_EVT;
 209
 210 /* HW enable callback type */
 211 typedef void(tBTA_SYS_HW_CBACK)(tBTA_SYS_HW_EVT status);
 212
 213 /*****************************************************************************
 214  *  Function declarations
 215  ****************************************************************************/
 216
 217 extern void bta_sys_init(void);
 218 extern void bta_sys_free(void);
 219 extern void bta_sys_event(BT_HDR* p_msg);
 220 extern void bta_sys_set_trace_level(uint8_t level);
 221 extern void bta_sys_register(uint8_t id, const tBTA_SYS_REG* p_reg);
 222 extern void bta_sys_deregister(uint8_t id);
 223 extern bool bta_sys_is_register(uint8_t id);
 224 extern uint16_t bta_sys_get_sys_features(void);
 225 extern void bta_sys_sendmsg(void* p_msg);
 226 extern void do_in_bta_thread(const tracked_objects::Location& from_here,
 227                              const base::Closure& task);
 228 extern void bta_sys_start_timer(alarm_t* alarm, period_ms_t interval,
 229                                 uint16_t event, uint16_t layer_specific);
 230 extern void bta_sys_disable(tBTA_SYS_HW_MODULE module);
 231
 232 extern void bta_sys_hw_register(tBTA_SYS_HW_MODULE module,
 233                                 tBTA_SYS_HW_CBACK* cback);
 234 extern void bta_sys_hw_unregister(tBTA_SYS_HW_MODULE module);
 235
 236 extern void bta_sys_rm_register(tBTA_SYS_CONN_CBACK* p_cback);
 237 extern void bta_sys_pm_register(tBTA_SYS_CONN_CBACK* p_cback);
 238
 239 extern void bta_sys_policy_register(tBTA_SYS_CONN_CBACK* p_cback);
 240 extern void bta_sys_sco_register(tBTA_SYS_CONN_CBACK* p_cback);
 241
 242 extern void bta_sys_conn_open(uint8_t id, uint8_t app_id,
 243                               const RawAddress& peer_addr);
 244 extern void bta_sys_conn_close(uint8_t id, uint8_t app_id,
 245                                const RawAddress& peer_addr);
 246 extern void bta_sys_app_open(uint8_t id, uint8_t app_id,
 247                              const RawAddress& peer_addr);
 248 extern void bta_sys_app_close(uint8_t id, uint8_t app_id,
 249                               const RawAddress& peer_addr);
 250 extern void bta_sys_sco_open(uint8_t id, uint8_t app_id,
 251                              const RawAddress& peer_addr);
 252 extern void bta_sys_sco_close(uint8_t id, uint8_t app_id,
 253                               const RawAddress& peer_addr);
 254 extern void bta_sys_sco_use(uint8_t id, uint8_t app_id,
 255                             const RawAddress& peer_addr);
 256 extern void bta_sys_sco_unuse(uint8_t id, uint8_t app_id,
 257                               const RawAddress& peer_addr);
 258 extern void bta_sys_idle(uint8_t id, uint8_t app_id,
 259                          const RawAddress& peer_addr);
 260 extern void bta_sys_busy(uint8_t id, uint8_t app_id,
 261                          const RawAddress& peer_addr);
 262
 263 #if (BTM_SSR_INCLUDED == TRUE)
 264 extern void bta_sys_ssr_cfg_register(tBTA_SYS_SSR_CFG_CBACK* p_cback);
 265 extern void bta_sys_chg_ssr_config(uint8_t id, uint8_t app_id,
 266                                    uint16_t max_latency, uint16_t min_tout);
 267 #endif
 268
 269 extern void bta_sys_role_chg_register(tBTA_SYS_CONN_CBACK* p_cback);
 270 extern void bta_sys_notify_role_chg(const RawAddress& p_bda, uint8_t new_role,
 271                                     uint8_t hci_status);
 272 extern void bta_sys_collision_register(uint8_t bta_id,
 273                                        tBTA_SYS_CONN_CBACK* p_cback);
 274 extern void bta_sys_notify_collision(const RawAddress& p_bda);
 275
 276 #if (BTA_EIR_CANNED_UUID_LIST != TRUE)
 277 extern void bta_sys_eir_register(tBTA_SYS_EIR_CBACK* p_cback);
 278 extern void bta_sys_add_uuid(uint16_t uuid16);
 279 extern void bta_sys_remove_uuid(uint16_t uuid16);
 280 #else
 281 #define bta_sys_eir_register(ut)
 282 #define bta_sys_add_uuid(ut)
 283 #define bta_sys_remove_uuid(ut)
 284 #endif
 285
 286 extern void bta_sys_set_policy(uint8_t id, uint8_t policy,
 287                                const RawAddress& peer_addr);
 288 extern void bta_sys_clear_policy(uint8_t id, uint8_t policy,
 289                                  const RawAddress& peer_addr);
 290 extern void bta_sys_set_default_policy(uint8_t id, uint8_t policy);
 291 extern void bta_sys_clear_default_policy(uint8_t id, uint8_t policy);
 292
 293 #endif /* BTA_SYS_H */