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