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_common.h"
28 #include "bt_target.h"
29 #include "osi/include/alarm.h"
30 
31 /*****************************************************************************
32  *  Constants and data types
33  ****************************************************************************/
34 
35 /* vendor specific event handler function type */
36 typedef bool(tBTA_SYS_VS_EVT_HDLR)(uint16_t evt, void* p);
37 
38 /* event handler function type */
39 typedef bool(tBTA_SYS_EVT_HDLR)(BT_HDR* p_msg);
40 
41 /* disable function type */
42 typedef void(tBTA_SYS_DISABLE)(void);
43 
44 /* HW modules */
45 enum {
46   BTA_SYS_HW_BLUETOOTH,
47   BTA_SYS_HW_RT,
48 
49   BTA_SYS_MAX_HW_MODULES
50 };
51 
52 typedef uint16_t tBTA_SYS_HW_MODULE;
53 
54 #ifndef BTA_DM_NUM_JV_ID
55 #define BTA_DM_NUM_JV_ID 2
56 #endif
57 
58 /* SW sub-systems */
59 #define BTA_ID_SYS 0 /* system manager */
60 /* BLUETOOTH PART - from 0 to BTA_ID_BLUETOOTH_MAX */
61 #define BTA_ID_DM 1             /* device manager */
62 #define BTA_ID_DM_SEARCH 2      /* device manager search */
63 #define BTA_ID_DM_SEC 3         /* device manager security */
64 #define BTA_ID_DG 4             /* data gateway */
65 #define BTA_ID_AG 5             /* audio gateway */
66 #define BTA_ID_OPC 6            /* object push client */
67 #define BTA_ID_OPS 7            /* object push server */
68 #define BTA_ID_FTS 8            /* file transfer server */
69 #define BTA_ID_CT 9             /* cordless telephony terminal */
70 #define BTA_ID_FTC 10           /* file transfer client */
71 #define BTA_ID_SS 11            /* synchronization server */
72 #define BTA_ID_PR 12            /* Printer client */
73 #define BTA_ID_BIC 13           /* Basic Imaging Client */
74 #define BTA_ID_PAN 14           /* Personal Area Networking */
75 #define BTA_ID_BIS 15           /* Basic Imaging Server */
76 #define BTA_ID_ACC 16           /* Advanced Camera Client */
77 #define BTA_ID_SC 17            /* SIM Card Access server */
78 #define BTA_ID_AV 18            /* Advanced audio/video */
79 #define BTA_ID_AVK 19           /* Audio/video sink */
80 #define BTA_ID_HD 20            /* HID Device */
81 #define BTA_ID_CG 21            /* Cordless Gateway */
82 #define BTA_ID_BP 22            /* Basic Printing Client */
83 #define BTA_ID_HH 23            /* Human Interface Device Host */
84 #define BTA_ID_PBS 24           /* Phone Book Access Server */
85 #define BTA_ID_PBC 25           /* Phone Book Access Client */
86 #define BTA_ID_JV 26            /* Java */
87 #define BTA_ID_HS 27            /* Headset */
88 #define BTA_ID_MSE 28           /* Message Server Equipment */
89 #define BTA_ID_MCE 29           /* Message Client Equipment */
90 #define BTA_ID_HL 30            /* Health Device Profile*/
91 #define BTA_ID_GATTC 31         /* GATT Client */
92 #define BTA_ID_GATTS 32         /* GATT Client */
93 #define BTA_ID_SDP 33           /* SDP Client */
94 #define BTA_ID_BLUETOOTH_MAX 34 /* 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 #define BTA_ID_CLOSURE 43 /* Generic C++ closure  */
103 
104 /* JV */
105 #define BTA_ID_JV1 44 /* JV1 */
106 #define BTA_ID_JV2 45 /* JV2 */
107 
108 #define BTA_ID_MAX (44 + BTA_DM_NUM_JV_ID)
109 
110 typedef uint8_t tBTA_SYS_ID;
111 
112 #define BTA_SYS_CONN_OPEN 0x00
113 #define BTA_SYS_CONN_CLOSE 0x01
114 #define BTA_SYS_APP_OPEN 0x02
115 #define BTA_SYS_APP_CLOSE 0x03
116 #define BTA_SYS_SCO_OPEN 0x04
117 #define BTA_SYS_SCO_CLOSE 0x05
118 #define BTA_SYS_CONN_IDLE 0x06
119 #define BTA_SYS_CONN_BUSY 0x07
120 
121 /* for link policy */
122 #define BTA_SYS_PLCY_SET 0x10     /* set the link policy to the given addr */
123 #define BTA_SYS_PLCY_CLR 0x11     /* clear the link policy to the given addr */
124 #define BTA_SYS_PLCY_DEF_SET 0x12 /* set the default link policy */
125 #define BTA_SYS_PLCY_DEF_CLR 0x13 /* clear the default link policy */
126 #define BTA_SYS_ROLE_CHANGE 0x14  /* role change */
127 
128 typedef uint8_t tBTA_SYS_CONN_STATUS;
129 
130 /* Bitmask of sys features */
131 #define BTA_SYS_FEAT_PCM2 0x0001
132 #define BTA_SYS_FEAT_PCM2_MASTER 0x0002
133 
134 /* tBTA_PREF_ROLES */
135 typedef uint8_t tBTA_SYS_PREF_ROLES;
136 
137 /* conn callback for role / low power manager*/
138 typedef void(tBTA_SYS_CONN_CBACK)(tBTA_SYS_CONN_STATUS status, uint8_t id,
139                                   uint8_t app_id, BD_ADDR peer_addr);
140 
141 /* conn callback for role / low power manager*/
142 typedef void(tBTA_SYS_SSR_CFG_CBACK)(uint8_t id, uint8_t app_id,
143                                      uint16_t latency, uint16_t 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_t uuid16, bool adding);
148 #endif
149 
150 /* registration structure */
151 typedef struct {
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 */
157 typedef struct {
158   BT_HDR hdr;
159   tBTA_SYS_HW_MODULE hw_module;
160 } tBTA_SYS_HW_MSG;
161 
162 typedef void (*tBTA_SYS_REGISTER)(uint8_t id, const tBTA_SYS_REG* p_reg);
163 typedef void (*tBTA_SYS_SENDMSG)(void* p_msg);
164 
165 /*****************************************************************************
166  *  Global data
167  ****************************************************************************/
168 
169 /* trace level */
170 extern uint8_t 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
184  * bta_sys_main.cc */
185 enum {
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 /* SYS HW status events - returned by SYS HW manager to other modules. */
198 enum {
199   BTA_SYS_HW_OFF_EVT,
200   BTA_SYS_HW_ON_EVT,
201   BTA_SYS_HW_STARTING_EVT,
202   BTA_SYS_HW_STOPPING_EVT,
203   BTA_SYS_HW_ERROR_EVT
204 
205 };
206 typedef uint8_t tBTA_SYS_HW_EVT;
207 
208 /* HW enable callback type */
209 typedef void(tBTA_SYS_HW_CBACK)(tBTA_SYS_HW_EVT status);
210 
211 /*****************************************************************************
212  *  Function declarations
213  ****************************************************************************/
214 
215 extern void bta_sys_init(void);
216 extern void bta_sys_free(void);
217 extern void bta_sys_event(BT_HDR* p_msg);
218 extern void bta_sys_set_trace_level(uint8_t level);
219 extern void bta_sys_register(uint8_t id, const tBTA_SYS_REG* p_reg);
220 extern void bta_sys_deregister(uint8_t id);
221 extern bool bta_sys_is_register(uint8_t id);
222 extern uint16_t bta_sys_get_sys_features(void);
223 extern void bta_sys_sendmsg(void* p_msg);
224 extern void bta_sys_start_timer(alarm_t* alarm, period_ms_t interval,
225                                 uint16_t event, uint16_t layer_specific);
226 extern void bta_sys_disable(tBTA_SYS_HW_MODULE module);
227 
228 extern void bta_sys_hw_register(tBTA_SYS_HW_MODULE module,
229                                 tBTA_SYS_HW_CBACK* cback);
230 extern void bta_sys_hw_unregister(tBTA_SYS_HW_MODULE module);
231 
232 extern void bta_sys_rm_register(tBTA_SYS_CONN_CBACK* p_cback);
233 extern void bta_sys_pm_register(tBTA_SYS_CONN_CBACK* p_cback);
234 
235 extern void bta_sys_policy_register(tBTA_SYS_CONN_CBACK* p_cback);
236 extern void bta_sys_sco_register(tBTA_SYS_CONN_CBACK* p_cback);
237 
238 extern void bta_sys_conn_open(uint8_t id, uint8_t app_id, BD_ADDR peer_addr);
239 extern void bta_sys_conn_close(uint8_t id, uint8_t app_id, BD_ADDR peer_addr);
240 extern void bta_sys_app_open(uint8_t id, uint8_t app_id, BD_ADDR peer_addr);
241 extern void bta_sys_app_close(uint8_t id, uint8_t app_id, BD_ADDR peer_addr);
242 extern void bta_sys_sco_open(uint8_t id, uint8_t app_id, BD_ADDR peer_addr);
243 extern void bta_sys_sco_close(uint8_t id, uint8_t app_id, BD_ADDR peer_addr);
244 extern void bta_sys_sco_use(uint8_t id, uint8_t app_id, BD_ADDR peer_addr);
245 extern void bta_sys_sco_unuse(uint8_t id, uint8_t app_id, BD_ADDR peer_addr);
246 extern void bta_sys_idle(uint8_t id, uint8_t app_id, BD_ADDR peer_addr);
247 extern void bta_sys_busy(uint8_t id, uint8_t app_id, BD_ADDR peer_addr);
248 
249 #if (BTM_SSR_INCLUDED == TRUE)
250 extern void bta_sys_ssr_cfg_register(tBTA_SYS_SSR_CFG_CBACK* p_cback);
251 extern void bta_sys_chg_ssr_config(uint8_t id, uint8_t app_id,
252                                    uint16_t max_latency, uint16_t min_tout);
253 #endif
254 
255 extern void bta_sys_role_chg_register(tBTA_SYS_CONN_CBACK* p_cback);
256 extern void bta_sys_notify_role_chg(BD_ADDR_PTR p_bda, uint8_t new_role,
257                                     uint8_t hci_status);
258 extern void bta_sys_collision_register(uint8_t bta_id,
259                                        tBTA_SYS_CONN_CBACK* p_cback);
260 extern void bta_sys_notify_collision(BD_ADDR_PTR p_bda);
261 
262 #if (BTA_EIR_CANNED_UUID_LIST != TRUE)
263 extern void bta_sys_eir_register(tBTA_SYS_EIR_CBACK* p_cback);
264 extern void bta_sys_add_uuid(uint16_t uuid16);
265 extern void bta_sys_remove_uuid(uint16_t uuid16);
266 #else
267 #define bta_sys_eir_register(ut)
268 #define bta_sys_add_uuid(ut)
269 #define bta_sys_remove_uuid(ut)
270 #endif
271 
272 extern void bta_sys_set_policy(uint8_t id, uint8_t policy, BD_ADDR peer_addr);
273 extern void bta_sys_clear_policy(uint8_t id, uint8_t policy, BD_ADDR peer_addr);
274 extern void bta_sys_set_default_policy(uint8_t id, uint8_t policy);
275 extern void bta_sys_clear_default_policy(uint8_t id, uint8_t policy);
276 
277 #endif /* BTA_SYS_H */
278