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 "gki.h"
     29 
     30 /*****************************************************************************
     31 **  Constants and data types
     32 *****************************************************************************/
     33 
     34 /* vendor specific event handler function type */
     35 typedef BOOLEAN (tBTA_SYS_VS_EVT_HDLR)(UINT16 evt, void *p);
     36 
     37 /* event handler function type */
     38 typedef BOOLEAN (tBTA_SYS_EVT_HDLR)(BT_HDR *p_msg);
     39 
     40 /* disable function type */
     41 typedef void (tBTA_SYS_DISABLE)(void);
     42 
     43 
     44 /* HW modules */
     45 enum
     46 {
     47     BTA_SYS_HW_BLUETOOTH,
     48     BTA_SYS_HW_RT,
     49 
     50     BTA_SYS_MAX_HW_MODULES
     51 };
     52 
     53 typedef UINT16 tBTA_SYS_HW_MODULE;
     54 
     55 #ifndef BTA_DM_NUM_JV_ID
     56 #define BTA_DM_NUM_JV_ID    2
     57 #endif
     58 
     59 /* SW sub-systems */
     60 #define BTA_ID_SYS          0            /* system manager */
     61 /* BLUETOOTH PART - from 0 to BTA_ID_BLUETOOTH_MAX */
     62 #define BTA_ID_DM           1            /* device manager */
     63 #define BTA_ID_DM_SEARCH    2            /* device manager search */
     64 #define BTA_ID_DM_SEC       3            /* device manager security */
     65 #define BTA_ID_DG           4            /* data gateway */
     66 #define BTA_ID_AG           5            /* audio gateway */
     67 #define BTA_ID_OPC          6            /* object push client */
     68 #define BTA_ID_OPS          7            /* object push server */
     69 #define BTA_ID_FTS          8            /* file transfer server */
     70 #define BTA_ID_CT           9            /* cordless telephony terminal */
     71 #define BTA_ID_FTC          10           /* file transfer client */
     72 #define BTA_ID_SS           11           /* synchronization server */
     73 #define BTA_ID_PR           12           /* Printer client */
     74 #define BTA_ID_BIC          13           /* Basic Imaging Client */
     75 #define BTA_ID_PAN          14           /* Personal Area Networking */
     76 #define BTA_ID_BIS          15           /* Basic Imaging Server */
     77 #define BTA_ID_ACC          16           /* Advanced Camera Client */
     78 #define BTA_ID_SC           17           /* SIM Card Access server */
     79 #define BTA_ID_AV           18           /* Advanced audio/video */
     80 #define BTA_ID_AVK          19           /* Audio/video sink */
     81 #define BTA_ID_HD           20           /* HID Device */
     82 #define BTA_ID_CG           21           /* Cordless Gateway */
     83 #define BTA_ID_BP           22           /* Basic Printing Client */
     84 #define BTA_ID_HH           23           /* Human Interface Device Host */
     85 #define BTA_ID_PBS          24           /* Phone Book Access Server */
     86 #define BTA_ID_PBC          25           /* Phone Book Access Client */
     87 #define BTA_ID_JV           26           /* Java */
     88 #define BTA_ID_HS           27           /* Headset */
     89 #define BTA_ID_MSE          28           /* Message Server Equipment */
     90 #define BTA_ID_MCE          29           /* Message Client Equipment */
     91 #define BTA_ID_HL           30           /* Health Device Profile*/
     92 #define BTA_ID_GATTC        31           /* GATT Client */
     93 #define BTA_ID_GATTS        32           /* GATT Client */
     94 #define BTA_ID_SDP          33           /* SDP Client */
     95 #define BTA_ID_BLUETOOTH_MAX   34        /* last BT profile */
     96 
     97 /* GENERIC */
     98 #define BTA_ID_PRM          38
     99 #define BTA_ID_SYSTEM       39           /* platform-specific */
    100 #define BTA_ID_SWRAP        40           /* Insight script wrapper */
    101 #define BTA_ID_MIP          41           /* Multicase Individual Polling */
    102 #define BTA_ID_RT           42           /* Audio Routing module: This module is always on. */
    103 
    104 
    105 /* JV */
    106 #define BTA_ID_JV1          44           /* JV1 */
    107 #define BTA_ID_JV2          45           /* JV2 */
    108 
    109 #define BTA_ID_MAX          (44 + BTA_DM_NUM_JV_ID)
    110 
    111 typedef UINT8 tBTA_SYS_ID;
    112 
    113 
    114 #define BTA_SYS_CONN_OPEN           0x00
    115 #define BTA_SYS_CONN_CLOSE          0x01
    116 #define BTA_SYS_APP_OPEN            0x02
    117 #define BTA_SYS_APP_CLOSE           0x03
    118 #define BTA_SYS_SCO_OPEN            0x04
    119 #define BTA_SYS_SCO_CLOSE           0x05
    120 #define BTA_SYS_CONN_IDLE           0x06
    121 #define BTA_SYS_CONN_BUSY           0x07
    122 
    123 /* for link policy */
    124 #define BTA_SYS_PLCY_SET            0x10 /* set the link policy to the given addr */
    125 #define BTA_SYS_PLCY_CLR            0x11 /* clear the link policy to the given addr */
    126 #define BTA_SYS_PLCY_DEF_SET        0x12 /* set the default link policy */
    127 #define BTA_SYS_PLCY_DEF_CLR        0x13 /* clear the default link policy */
    128 #define BTA_SYS_ROLE_CHANGE         0x14 /* role change */
    129 
    130 typedef UINT8 tBTA_SYS_CONN_STATUS;
    131 
    132 /* Bitmask of sys features */
    133 #define BTA_SYS_FEAT_PCM2           0x0001
    134 #define BTA_SYS_FEAT_PCM2_MASTER    0x0002
    135 
    136 /* tBTA_PREF_ROLES */
    137 typedef UINT8 tBTA_SYS_PREF_ROLES;
    138 
    139 /* conn callback for role / low power manager*/
    140 typedef void (tBTA_SYS_CONN_CBACK)(tBTA_SYS_CONN_STATUS status,UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
    141 
    142 /* conn callback for role / low power manager*/
    143 typedef void (tBTA_SYS_SSR_CFG_CBACK)(UINT8 id, UINT8 app_id, UINT16 latency, UINT16 tout);
    144 
    145 #if (BTA_EIR_CANNED_UUID_LIST != TRUE)
    146 /* eir callback for adding/removeing UUID */
    147 typedef void (tBTA_SYS_EIR_CBACK)(UINT16 uuid16, BOOLEAN adding);
    148 #endif
    149 
    150 /* registration structure */
    151 typedef struct
    152 {
    153     tBTA_SYS_EVT_HDLR   *evt_hdlr;
    154     tBTA_SYS_DISABLE    *disable;
    155 } tBTA_SYS_REG;
    156 
    157 /* data type to send events to BTA SYS HW manager */
    158 typedef struct
    159 {
    160     BT_HDR                hdr;
    161     tBTA_SYS_HW_MODULE   hw_module;
    162 } tBTA_SYS_HW_MSG;
    163 
    164 /*****************************************************************************
    165 **  Global data
    166 *****************************************************************************/
    167 
    168 /* trace level */
    169 extern UINT8 appl_trace_level;
    170 
    171 /*****************************************************************************
    172 **  Macros
    173 *****************************************************************************/
    174 
    175 /* Calculate start of event enumeration; id is top 8 bits of event */
    176 #define BTA_SYS_EVT_START(id)       ((id) << 8)
    177 
    178 /*****************************************************************************
    179 **  events for BTA SYS HW manager
    180 *****************************************************************************/
    181 
    182 /* events sent to SYS HW manager - must be kept synchronized with tables in bta_sys_main.c */
    183 enum
    184 {
    185     /* device manager local device API events */
    186     BTA_SYS_API_ENABLE_EVT = BTA_SYS_EVT_START(BTA_ID_SYS),
    187     BTA_SYS_EVT_ENABLED_EVT,
    188     BTA_SYS_EVT_STACK_ENABLED_EVT,
    189     BTA_SYS_API_DISABLE_EVT,
    190     BTA_SYS_EVT_DISABLED_EVT,
    191     BTA_SYS_ERROR_EVT,
    192 
    193     BTA_SYS_MAX_EVT
    194 };
    195 
    196 
    197 
    198 /* SYS HW status events - returned by SYS HW manager to other modules. */
    199 enum
    200 {
    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 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 #ifdef __cplusplus
    218 extern "C" {
    219 #endif
    220 
    221 extern void bta_sys_init(void);
    222 extern void bta_sys_free(void);
    223 extern void bta_sys_event(BT_HDR *p_msg);
    224 extern void bta_sys_set_trace_level(UINT8 level);
    225 extern void bta_sys_register(UINT8 id, const tBTA_SYS_REG *p_reg);
    226 extern void bta_sys_deregister(UINT8 id);
    227 extern BOOLEAN bta_sys_is_register(UINT8 id);
    228 extern UINT16 bta_sys_get_sys_features(void);
    229 extern void bta_sys_sendmsg(void *p_msg);
    230 extern void bta_sys_start_timer(TIMER_LIST_ENT *p_tle, UINT16 type, INT32 timeout_ms);
    231 extern void bta_sys_stop_timer(TIMER_LIST_ENT *p_tle);
    232 extern void bta_sys_disable(tBTA_SYS_HW_MODULE module);
    233 extern UINT32 bta_sys_get_remaining_ticks(TIMER_LIST_ENT *p_target_tle);
    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 extern BOOLEAN bta_sys_vs_hdl(UINT16 evt, void *p);
    282 
    283 #ifdef __cplusplus
    284 }
    285 #endif
    286 
    287 #endif /* BTA_SYS_H */
    288