bta_sys.h revision e448862a47c08eb23185aaed574b39264f5005fc 
1/*****************************************************************************
2**
3**  Name:           bta_sys.h
4**
5**  Description:    This is the public interface file for the BTA system
6**                  manager.
7**
8**  Copyright (c) 2003-2011, Broadcom Corp., All Rights Reserved.
9**  Broadcom Bluetooth Core. Proprietary and confidential.
10**
11*****************************************************************************/
12#ifndef BTA_SYS_H
13#define BTA_SYS_H
14
15#include "bt_target.h"
16#include "gki.h"
17
18/*****************************************************************************
19**  Constants and data types
20*****************************************************************************/
21
22/* event handler function type */
23typedef BOOLEAN (tBTA_SYS_EVT_HDLR)(BT_HDR *p_msg);
24
25/* disable function type */
26typedef void (tBTA_SYS_DISABLE)(void);
27
28
29/* HW modules */
30enum
31{
32    BTA_SYS_HW_BLUETOOTH,
33    BTA_SYS_HW_FMRX,
34    BTA_SYS_HW_FMTX,
35    BTA_SYS_HW_GPS,
36    BTA_SYS_HW_SENSOR,
37    BTA_SYS_HW_NFC,
38    BTA_SYS_HW_RT,
39
40    BTA_SYS_MAX_HW_MODULES
41};
42
43typedef UINT16 tBTA_SYS_HW_MODULE;
44
45#ifndef BTA_DM_NUM_JV_ID
46#define BTA_DM_NUM_JV_ID    2
47#endif
48
49/* SW sub-systems */
50#define BTA_ID_SYS          0            /* system manager */
51/* BLUETOOTH PART - from 0 to BTA_ID_BLUETOOTH_MAX */
52#define BTA_ID_DM           1            /* device manager */
53#define BTA_ID_DM_SEARCH    2            /* device manager search */
54#define BTA_ID_DM_SEC       3            /* device manager security */
55#define BTA_ID_DG           4            /* data gateway */
56#define BTA_ID_AG           5            /* audio gateway */
57#define BTA_ID_OPC          6            /* object push client */
58#define BTA_ID_OPS          7            /* object push server */
59#define BTA_ID_FTS          8            /* file transfer server */
60#define BTA_ID_CT           9            /* cordless telephony terminal */
61#define BTA_ID_FTC          10           /* file transfer client */
62#define BTA_ID_SS           11           /* synchronization server */
63#define BTA_ID_PR           12           /* Printer client */
64#define BTA_ID_BIC          13           /* Basic Imaging Client */
65#define BTA_ID_PAN          14           /* Personal Area Networking */
66#define BTA_ID_BIS          15           /* Basic Imaging Server */
67#define BTA_ID_ACC          16           /* Advanced Camera Client */
68#define BTA_ID_SC           17           /* SIM Card Access server */
69#define BTA_ID_AV           18           /* Advanced audio/video */
70#define BTA_ID_AVK          19           /* Audio/video sink */
71#define BTA_ID_HD           20           /* HID Device */
72#define BTA_ID_CG           21           /* Cordless Gateway */
73#define BTA_ID_BP           22           /* Basic Printing Client */
74#define BTA_ID_HH           23           /* Human Interface Device Host */
75#define BTA_ID_PBS          24           /* Phone Book Access Server */
76#define BTA_ID_PBC          25           /* Phone Book Access Client */
77#define BTA_ID_JV           26           /* Java */
78#define BTA_ID_HS           27           /* Headset */
79#define BTA_ID_MSE          28           /* Message Server Equipment */
80#define BTA_ID_MCE          29           /* Message Client Equipment */
81#define BTA_ID_HL           30           /* Health Device Profile*/
82#define BTA_ID_GATTC        31           /* GATT Client */
83#define BTA_ID_GATTS        32           /* GATT Client */
84#define BTA_ID_BLUETOOTH_MAX   33        /* last BT profile */
85
86/* FM */
87#define BTA_ID_FM           34           /* FM  */
88#define BTA_ID_FMTX         35           /* FM TX */
89
90/* SENSOR */
91#define BTA_ID_SSR          36           /* Sensor  */
92
93/* GPS */
94#define BTA_ID_GPS          37           /* GPS  */
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 ( BTM_EIR_SERVER_INCLUDED == TRUE )&&(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/* system manager configuration structure */
157typedef struct
158{
159    UINT16          mbox_evt;                       /* GKI mailbox event */
160    UINT8           mbox;                           /* GKI mailbox id */
161    UINT8           timer;                          /* GKI timer id */
162    UINT8           trace_level;                    /* initial trace level */
163} tBTA_SYS_CFG;
164
165/* data type to send events to BTA SYS HW manager */
166typedef struct
167{
168    BT_HDR                hdr;
169    tBTA_SYS_HW_MODULE   hw_module;
170} tBTA_SYS_HW_MSG;
171
172
173
174/*****************************************************************************
175**  Global data
176*****************************************************************************/
177
178/* trace level */
179extern UINT8 appl_trace_level;
180
181/*****************************************************************************
182**  Macros
183*****************************************************************************/
184
185/* Calculate start of event enumeration; id is top 8 bits of event */
186#define BTA_SYS_EVT_START(id)       ((id) << 8)
187
188/*****************************************************************************
189**  events for BTA SYS HW manager
190*****************************************************************************/
191
192/* events sent to SYS HW manager - must be kept synchronized with tables in bta_sys_main.c */
193enum
194{
195    /* device manager local device API events */
196    BTA_SYS_API_ENABLE_EVT = BTA_SYS_EVT_START(BTA_ID_SYS),
197    BTA_SYS_EVT_ENABLED_EVT,
198    BTA_SYS_EVT_STACK_ENABLED_EVT,
199    BTA_SYS_API_DISABLE_EVT,
200    BTA_SYS_EVT_DISABLED_EVT,
201    BTA_SYS_ERROR_EVT,
202
203    BTA_SYS_MAX_EVT
204};
205
206
207
208/* SYS HW status events - returned by SYS HW manager to other modules. */
209enum
210{
211    BTA_SYS_HW_OFF_EVT,
212    BTA_SYS_HW_ON_EVT,
213    BTA_SYS_HW_STARTING_EVT,
214    BTA_SYS_HW_STOPPING_EVT,
215    BTA_SYS_HW_ERROR_EVT
216
217};
218typedef UINT8 tBTA_SYS_HW_EVT;
219
220/* HW enable callback type */
221typedef void (tBTA_SYS_HW_CBACK)(tBTA_SYS_HW_EVT status);
222
223/*****************************************************************************
224**  Function declarations
225*****************************************************************************/
226
227#ifdef __cplusplus
228extern "C" {
229#endif
230
231BTA_API extern void bta_sys_init(void);
232BTA_API extern void bta_sys_event(BT_HDR *p_msg);
233BTA_API extern void bta_sys_timer_update(void);
234BTA_API extern void bta_sys_disable_timers(void);
235BTA_API extern void bta_sys_set_trace_level(UINT8 level);
236extern void bta_sys_register(UINT8 id, const tBTA_SYS_REG *p_reg);
237extern void bta_sys_deregister(UINT8 id);
238extern BOOLEAN bta_sys_is_register(UINT8 id);
239extern UINT16 bta_sys_get_sys_features(void);
240extern void bta_sys_sendmsg(void *p_msg);
241extern void bta_sys_start_timer(TIMER_LIST_ENT *p_tle, UINT16 type, INT32 timeout);
242extern void bta_sys_stop_timer(TIMER_LIST_ENT *p_tle);
243extern void bta_sys_disable(tBTA_SYS_HW_MODULE module);
244
245extern void bta_sys_hw_register( tBTA_SYS_HW_MODULE module, tBTA_SYS_HW_CBACK *cback);
246extern void bta_sys_hw_unregister( tBTA_SYS_HW_MODULE module );
247
248
249extern void bta_sys_rm_register(tBTA_SYS_CONN_CBACK * p_cback);
250extern void bta_sys_pm_register(tBTA_SYS_CONN_CBACK * p_cback);
251
252extern void bta_sys_policy_register(tBTA_SYS_CONN_CBACK * p_cback);
253extern void bta_sys_sco_register(tBTA_SYS_CONN_CBACK * p_cback);
254
255
256extern void bta_sys_conn_open(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
257extern void bta_sys_conn_close(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
258extern void bta_sys_app_open(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
259extern void bta_sys_app_close(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
260extern void bta_sys_sco_open(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
261extern void bta_sys_sco_close(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
262extern void bta_sys_sco_use(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
263extern void bta_sys_sco_unuse(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
264extern void bta_sys_idle(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
265extern void bta_sys_busy(UINT8 id, UINT8 app_id, BD_ADDR peer_addr);
266
267#if (BTM_SSR_INCLUDED == TRUE)
268extern void bta_sys_ssr_cfg_register(tBTA_SYS_SSR_CFG_CBACK * p_cback);
269extern void bta_sys_chg_ssr_config (UINT8 id, UINT8 app_id, UINT16 max_latency, UINT16 min_tout);
270#endif
271
272extern void bta_sys_role_chg_register(tBTA_SYS_CONN_CBACK * p_cback);
273extern void bta_sys_notify_role_chg(BD_ADDR_PTR p_bda, UINT8 new_role, UINT8 hci_status);
274extern void bta_sys_collision_register(UINT8 bta_id, tBTA_SYS_CONN_CBACK *p_cback);
275extern void bta_sys_notify_collision (BD_ADDR_PTR p_bda);
276
277#if ( BTM_EIR_SERVER_INCLUDED == TRUE )&&(BTA_EIR_CANNED_UUID_LIST != TRUE)
278extern void bta_sys_eir_register(tBTA_SYS_EIR_CBACK * p_cback);
279extern void bta_sys_add_uuid(UINT16 uuid16);
280extern void bta_sys_remove_uuid(UINT16 uuid16);
281#else
282#define bta_sys_eir_register(ut)
283#define bta_sys_add_uuid(ut)
284#define bta_sys_remove_uuid(ut)
285#endif
286
287extern void bta_sys_set_policy (UINT8 id, UINT8 policy, BD_ADDR peer_addr);
288extern void bta_sys_clear_policy (UINT8 id, UINT8 policy, BD_ADDR peer_addr);
289extern void bta_sys_set_default_policy (UINT8 id, UINT8 policy);
290extern void bta_sys_clear_default_policy (UINT8 id, UINT8 policy);
291
292#ifdef __cplusplus
293}
294#endif
295
296#endif /* BTA_SYS_H */
297