bta_sys.h revision 1e61ce1ae3fe8ef72443b30907f1cf8acae39674 
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 */
35typedef BOOLEAN (tBTA_SYS_VS_EVT_HDLR)(UINT16 evt, void *p);
36
37/* event handler function type */
38typedef BOOLEAN (tBTA_SYS_EVT_HDLR)(BT_HDR *p_msg);
39
40/* disable function type */
41typedef void (tBTA_SYS_DISABLE)(void);
42
43
44/* HW modules */
45enum
46{
47    BTA_SYS_HW_BLUETOOTH,
48    BTA_SYS_HW_RT,
49
50    BTA_SYS_MAX_HW_MODULES
51};
52
53typedef 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_BLUETOOTH_MAX   33        /* last BT profile */
95
96/* GENERIC */
97#define BTA_ID_PRM          38
98#define BTA_ID_SYSTEM       39           /* platform-specific */
99#define BTA_ID_SWRAP        40           /* Insight script wrapper */
100#define BTA_ID_MIP          41           /* Multicase Individual Polling */
101#define BTA_ID_RT           42           /* Audio Routing module: This module is always on. */
102
103
104/* JV */
105#define BTA_ID_JV1          43           /* JV1 */
106#define BTA_ID_JV2          44           /* JV2 */
107
108#define BTA_ID_MAX          (43 + BTA_DM_NUM_JV_ID)
109
110typedef UINT8 tBTA_SYS_ID;
111
112
113#define BTA_SYS_CONN_OPEN           0x00
114#define BTA_SYS_CONN_CLOSE          0x01
115#define BTA_SYS_APP_OPEN            0x02
116#define BTA_SYS_APP_CLOSE           0x03
117#define BTA_SYS_SCO_OPEN            0x04
118#define BTA_SYS_SCO_CLOSE           0x05
119#define BTA_SYS_CONN_IDLE           0x06
120#define BTA_SYS_CONN_BUSY           0x07
121
122/* for link policy */
123#define BTA_SYS_PLCY_SET            0x10 /* set the link policy to the given addr */
124#define BTA_SYS_PLCY_CLR            0x11 /* clear the link policy to the given addr */
125#define BTA_SYS_PLCY_DEF_SET        0x12 /* set the default link policy */
126#define BTA_SYS_PLCY_DEF_CLR        0x13 /* clear the default link policy */
127#define BTA_SYS_ROLE_CHANGE         0x14 /* role change */
128
129typedef UINT8 tBTA_SYS_CONN_STATUS;
130
131/* Bitmask of sys features */
132#define BTA_SYS_FEAT_PCM2           0x0001
133#define BTA_SYS_FEAT_PCM2_MASTER    0x0002
134
135/* tBTA_PREF_ROLES */
136typedef UINT8 tBTA_SYS_PREF_ROLES;
137
138/* conn callback for role / low power manager*/
139typedef void (tBTA_SYS_CONN_CBACK)(tBTA_SYS_CONN_STATUS status,UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
140
141/* conn callback for role / low power manager*/
142typedef void (tBTA_SYS_SSR_CFG_CBACK)(UINT8 id, UINT8 app_id, UINT16 latency, UINT16 tout);
143
144#if (BTA_EIR_CANNED_UUID_LIST != TRUE)
145/* eir callback for adding/removeing UUID */
146typedef void (tBTA_SYS_EIR_CBACK)(UINT16 uuid16, BOOLEAN adding);
147#endif
148
149/* registration structure */
150typedef struct
151{
152    tBTA_SYS_EVT_HDLR   *evt_hdlr;
153    tBTA_SYS_DISABLE    *disable;
154} tBTA_SYS_REG;
155
156/* data type to send events to BTA SYS HW manager */
157typedef struct
158{
159    BT_HDR                hdr;
160    tBTA_SYS_HW_MODULE   hw_module;
161} tBTA_SYS_HW_MSG;
162
163/* GKI task mailbox event for BTA. */
164#ifndef BTA_MBOX_EVT
165#define BTA_MBOX_EVT                TASK_MBOX_2_EVT_MASK
166#endif
167
168/* GKI task mailbox for BTA. */
169#ifndef BTA_MBOX
170#define BTA_MBOX                    TASK_MBOX_2
171#endif
172
173/* GKI timer id used for protocol timer for BTA. */
174#ifndef BTA_TIMER
175#define BTA_TIMER                   TIMER_1
176#endif
177
178/*****************************************************************************
179**  Global data
180*****************************************************************************/
181
182/* trace level */
183extern UINT8 appl_trace_level;
184
185/*****************************************************************************
186**  Macros
187*****************************************************************************/
188
189/* Calculate start of event enumeration; id is top 8 bits of event */
190#define BTA_SYS_EVT_START(id)       ((id) << 8)
191
192/*****************************************************************************
193**  events for BTA SYS HW manager
194*****************************************************************************/
195
196/* events sent to SYS HW manager - must be kept synchronized with tables in bta_sys_main.c */
197enum
198{
199    /* device manager local device API events */
200    BTA_SYS_API_ENABLE_EVT = BTA_SYS_EVT_START(BTA_ID_SYS),
201    BTA_SYS_EVT_ENABLED_EVT,
202    BTA_SYS_EVT_STACK_ENABLED_EVT,
203    BTA_SYS_API_DISABLE_EVT,
204    BTA_SYS_EVT_DISABLED_EVT,
205    BTA_SYS_ERROR_EVT,
206
207    BTA_SYS_MAX_EVT
208};
209
210
211
212/* SYS HW status events - returned by SYS HW manager to other modules. */
213enum
214{
215    BTA_SYS_HW_OFF_EVT,
216    BTA_SYS_HW_ON_EVT,
217    BTA_SYS_HW_STARTING_EVT,
218    BTA_SYS_HW_STOPPING_EVT,
219    BTA_SYS_HW_ERROR_EVT
220
221};
222typedef UINT8 tBTA_SYS_HW_EVT;
223
224/* HW enable callback type */
225typedef void (tBTA_SYS_HW_CBACK)(tBTA_SYS_HW_EVT status);
226
227/*****************************************************************************
228**  Function declarations
229*****************************************************************************/
230
231#ifdef __cplusplus
232extern "C" {
233#endif
234
235extern void bta_sys_init(void);
236extern void bta_sys_free(void);
237extern void bta_sys_event(BT_HDR *p_msg);
238extern void bta_sys_timer_update(void);
239extern void bta_sys_disable_timers(void);
240extern void bta_sys_set_trace_level(UINT8 level);
241extern void bta_sys_register(UINT8 id, const tBTA_SYS_REG *p_reg);
242extern void bta_sys_deregister(UINT8 id);
243extern BOOLEAN bta_sys_is_register(UINT8 id);
244extern UINT16 bta_sys_get_sys_features(void);
245extern void bta_sys_sendmsg(void *p_msg);
246extern void bta_sys_start_timer(TIMER_LIST_ENT *p_tle, UINT16 type, INT32 timeout_ms);
247extern void bta_sys_stop_timer(TIMER_LIST_ENT *p_tle);
248extern void bta_sys_disable(tBTA_SYS_HW_MODULE module);
249
250extern void bta_sys_hw_register( tBTA_SYS_HW_MODULE module, tBTA_SYS_HW_CBACK *cback);
251extern void bta_sys_hw_unregister( tBTA_SYS_HW_MODULE module );
252
253
254extern void bta_sys_rm_register(tBTA_SYS_CONN_CBACK * p_cback);
255extern void bta_sys_pm_register(tBTA_SYS_CONN_CBACK * p_cback);
256
257extern void bta_sys_policy_register(tBTA_SYS_CONN_CBACK * p_cback);
258extern void bta_sys_sco_register(tBTA_SYS_CONN_CBACK * p_cback);
259
260
261extern void bta_sys_conn_open(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
262extern void bta_sys_conn_close(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
263extern void bta_sys_app_open(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
264extern void bta_sys_app_close(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
265extern void bta_sys_sco_open(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
266extern void bta_sys_sco_close(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
267extern void bta_sys_sco_use(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
268extern void bta_sys_sco_unuse(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
269extern void bta_sys_idle(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
270extern void bta_sys_busy(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
271
272#if (BTM_SSR_INCLUDED == TRUE)
273extern void bta_sys_ssr_cfg_register(tBTA_SYS_SSR_CFG_CBACK * p_cback);
274extern void bta_sys_chg_ssr_config (UINT8 id, UINT8 app_id, UINT16 max_latency, UINT16 min_tout);
275#endif
276
277extern void bta_sys_role_chg_register(tBTA_SYS_CONN_CBACK * p_cback);
278extern void bta_sys_notify_role_chg(BD_ADDR_PTR p_bda, UINT8 new_role, UINT8 hci_status);
279extern void bta_sys_collision_register(UINT8 bta_id, tBTA_SYS_CONN_CBACK *p_cback);
280extern void bta_sys_notify_collision (BD_ADDR_PTR p_bda);
281
282#if (BTA_EIR_CANNED_UUID_LIST != TRUE)
283extern void bta_sys_eir_register(tBTA_SYS_EIR_CBACK * p_cback);
284extern void bta_sys_add_uuid(UINT16 uuid16);
285extern void bta_sys_remove_uuid(UINT16 uuid16);
286#else
287#define bta_sys_eir_register(ut)
288#define bta_sys_add_uuid(ut)
289#define bta_sys_remove_uuid(ut)
290#endif
291
292extern void bta_sys_set_policy (UINT8 id, UINT8 policy, BD_ADDR peer_addr);
293extern void bta_sys_clear_policy (UINT8 id, UINT8 policy, BD_ADDR peer_addr);
294extern void bta_sys_set_default_policy (UINT8 id, UINT8 policy);
295extern void bta_sys_clear_default_policy (UINT8 id, UINT8 policy);
296extern BOOLEAN bta_sys_vs_hdl(UINT16 evt, void *p);
297
298#ifdef __cplusplus
299}
300#endif
301
302#endif /* BTA_SYS_H */
303