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