1 /******************************************************************************
2 *
3 * Copyright 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 <base/strings/stringprintf.h>
28 #include <bluetooth/log.h>
29
30 #include <chrono>
31 #include <cstdint>
32 #include <string>
33
34 #include "internal_include/bt_target.h"
35 #include "macros.h"
36 #include "osi/include/alarm.h"
37 #include "stack/include/bt_hdr.h"
38 #include "stack/include/hci_error_code.h"
39 #include "types/bluetooth/uuid.h"
40 #include "types/hci_role.h"
41 #include "types/raw_address.h"
42
43 /*****************************************************************************
44 * Constants and data types
45 ****************************************************************************/
46
47 /* vendor specific event handler function type */
48 typedef bool(tBTA_SYS_VS_EVT_HDLR)(uint16_t evt, void* p);
49
50 /* event handler function type */
51 typedef bool(tBTA_SYS_EVT_HDLR)(const BT_HDR_RIGID* p_msg);
52 static_assert(sizeof(BT_HDR) == sizeof(BT_HDR_RIGID),
53 "Rigid replacement should be same size struct with flexible member");
54
55 /* disable function type */
56 typedef void(tBTA_SYS_DISABLE)(void);
57
58 template <typename T, typename U>
Specialize(U * u)59 inline const T* Specialize(U* u) {
60 return const_cast<const T*>(reinterpret_cast<T*>(u));
61 }
62
63 #ifndef BTA_DM_NUM_JV_ID
64 #define BTA_DM_NUM_JV_ID 2
65 #endif
66
67 typedef enum : uint8_t {
68 /* SW sub-systems */
69 BTA_ID_SYS = 0, /* system manager */
70 /* BLUETOOTH PART - from = 0, to BTA_ID_BLUETOOTH_MAX */
71 BTA_ID_DM_SEC = 3, /* device manager security */
72 BTA_ID_DG = 4, /* data gateway */
73 BTA_ID_AG = 5, /* audio gateway */
74 BTA_ID_OPC = 6, /* object push client */
75 BTA_ID_OPS = 7, /* object push server */
76 BTA_ID_FTS = 8, /* file transfer server */
77 BTA_ID_CT = 9, /* cordless telephony terminal */
78 BTA_ID_FTC = 10, /* file transfer client */
79 BTA_ID_SS = 11, /* synchronization server */
80 BTA_ID_PR = 12, /* Printer client */
81 BTA_ID_BIC = 13, /* Basic Imaging Client */
82 BTA_ID_PAN = 14, /* Personal Area Networking */
83 BTA_ID_BIS = 15, /* Basic Imaging Server */
84 BTA_ID_ACC = 16, /* Advanced Camera Client */
85 BTA_ID_SC = 17, /* SIM Card Access server */
86 BTA_ID_AV = 18, /* Advanced audio/video */
87 BTA_ID_AVK = 19, /* Audio/video sink */
88 BTA_ID_HD = 20, /* HID Device */
89 BTA_ID_CG = 21, /* Cordless Gateway */
90 BTA_ID_BP = 22, /* Basic Printing Client */
91 BTA_ID_HH = 23, /* Human Interface Device Host */
92 BTA_ID_PBS = 24, /* Phone Book Access Server */
93 BTA_ID_PBC = 25, /* Phone Book Access Client */
94 BTA_ID_JV = 26, /* Java */
95 BTA_ID_HS = 27, /* Headset */
96 BTA_ID_MSE = 28, /* Message Server Equipment */
97 BTA_ID_MCE = 29, /* Message Client Equipment */
98 BTA_ID_HL = 30, /* Health Device Profile*/
99 BTA_ID_GATTC = 31, /* GATT Client */
100 BTA_ID_GATTS = 32, /* GATT Client */
101 BTA_ID_SDP = 33, /* SDP Client */
102 BTA_ID_BLUETOOTH_MAX = 34, /* last BT profile */
103
104 BTA_ID_MAX = (44 + BTA_DM_NUM_JV_ID),
105 } tBTA_SYS_ID;
106
BtaIdSysText(const tBTA_SYS_ID & sys_id)107 inline std::string BtaIdSysText(const tBTA_SYS_ID& sys_id) {
108 switch (sys_id) {
109 CASE_RETURN_TEXT(BTA_ID_SYS);
110 CASE_RETURN_TEXT(BTA_ID_DM_SEC);
111 CASE_RETURN_TEXT(BTA_ID_DG);
112 CASE_RETURN_TEXT(BTA_ID_AG);
113 CASE_RETURN_TEXT(BTA_ID_OPC);
114 CASE_RETURN_TEXT(BTA_ID_OPS);
115 CASE_RETURN_TEXT(BTA_ID_FTS);
116 CASE_RETURN_TEXT(BTA_ID_CT);
117 CASE_RETURN_TEXT(BTA_ID_FTC);
118 CASE_RETURN_TEXT(BTA_ID_SS);
119 CASE_RETURN_TEXT(BTA_ID_PR);
120 CASE_RETURN_TEXT(BTA_ID_BIC);
121 CASE_RETURN_TEXT(BTA_ID_PAN);
122 CASE_RETURN_TEXT(BTA_ID_BIS);
123 CASE_RETURN_TEXT(BTA_ID_ACC);
124 CASE_RETURN_TEXT(BTA_ID_SC);
125 CASE_RETURN_TEXT(BTA_ID_AV);
126 CASE_RETURN_TEXT(BTA_ID_AVK);
127 CASE_RETURN_TEXT(BTA_ID_HD);
128 CASE_RETURN_TEXT(BTA_ID_CG);
129 CASE_RETURN_TEXT(BTA_ID_BP);
130 CASE_RETURN_TEXT(BTA_ID_HH);
131 CASE_RETURN_TEXT(BTA_ID_PBS);
132 CASE_RETURN_TEXT(BTA_ID_PBC);
133 CASE_RETURN_TEXT(BTA_ID_JV);
134 CASE_RETURN_TEXT(BTA_ID_HS);
135 CASE_RETURN_TEXT(BTA_ID_MSE);
136 CASE_RETURN_TEXT(BTA_ID_MCE);
137 CASE_RETURN_TEXT(BTA_ID_HL);
138 CASE_RETURN_TEXT(BTA_ID_GATTC);
139 CASE_RETURN_TEXT(BTA_ID_GATTS);
140 CASE_RETURN_TEXT(BTA_ID_SDP);
141 CASE_RETURN_TEXT(BTA_ID_BLUETOOTH_MAX);
142 default:
143 return base::StringPrintf("Unknown[%hhu]", sys_id);
144 }
145 }
146
147 typedef enum : uint8_t {
148 BTA_SYS_CONN_OPEN = 0x00,
149 BTA_SYS_CONN_CLOSE = 0x01,
150 BTA_SYS_APP_OPEN = 0x02,
151 BTA_SYS_APP_CLOSE = 0x03,
152 BTA_SYS_SCO_OPEN = 0x04,
153 BTA_SYS_SCO_CLOSE = 0x05,
154 BTA_SYS_CONN_IDLE = 0x06,
155 BTA_SYS_CONN_BUSY = 0x07,
156 BTA_SYS_ROLE_CHANGE = 0x14, /* role change */
157 } tBTA_SYS_CONN_STATUS;
158
bta_sys_conn_status_text(tBTA_SYS_CONN_STATUS status)159 inline std::string bta_sys_conn_status_text(tBTA_SYS_CONN_STATUS status) {
160 switch (status) {
161 case BTA_SYS_CONN_OPEN:
162 return std::string("BTA_SYS_CONN_OPEN");
163 case BTA_SYS_CONN_CLOSE:
164 return std::string("BTA_SYS_CONN_CLOSE");
165 case BTA_SYS_APP_OPEN:
166 return std::string("BTA_SYS_APP_OPEN");
167 case BTA_SYS_APP_CLOSE:
168 return std::string("BTA_SYS_APP_CLOSE");
169 case BTA_SYS_SCO_OPEN:
170 return std::string("BTA_SYS_SCO_OPEN");
171 case BTA_SYS_SCO_CLOSE:
172 return std::string("BTA_SYS_SCO_CLOSE");
173 case BTA_SYS_CONN_IDLE:
174 return std::string("BTA_SYS_CONN_IDLE");
175 case BTA_SYS_CONN_BUSY:
176 return std::string("BTA_SYS_CONN_BUSY");
177 case BTA_SYS_ROLE_CHANGE:
178 return std::string("BTA_SYS_ROLE_CHANGE");
179 default:
180 return std::string("UNKNOWN");
181 }
182 }
183
184 /* conn callback for power mode manager */
185 typedef void(tBTA_SYS_CONN_CBACK)(tBTA_SYS_CONN_STATUS status, const tBTA_SYS_ID id, uint8_t app_id,
186 const RawAddress& peer_addr);
187 /* conn callback for sco change */
188 typedef void(tBTA_SYS_CONN_SCO_CBACK)(tBTA_SYS_CONN_STATUS status, uint8_t num_sco_links,
189 uint8_t app_id, const RawAddress& peer_addr);
190 /* callback for role switch */
191 typedef void(tBTA_SYS_ROLE_SWITCH_CBACK)(tBTA_SYS_CONN_STATUS status, tHCI_ROLE new_role,
192 tHCI_STATUS hci_status, const RawAddress& peer_addr);
193 /* callback for sniff subrating updates */
194 typedef void(tBTA_SYS_SSR_CFG_CBACK)(uint8_t id, uint8_t app_id, uint16_t latency, uint16_t tout);
195
196 typedef void(tBTA_SYS_SNIFF_CBACK)(uint8_t id, uint8_t app_id, const RawAddress& peer_addr);
197
198 typedef struct {
199 bluetooth::Uuid custom_uuid;
200 uint32_t handle;
201 } tBTA_CUSTOM_UUID;
202
203 /* eir callback for adding/removeing UUID */
204 typedef void(tBTA_SYS_EIR_CBACK)(uint16_t uuid16, bool adding);
205 typedef void(tBTA_SYS_CUST_EIR_CBACK)(const tBTA_CUSTOM_UUID& curr, bool adding);
206
207 /* registration structure */
208 typedef struct {
209 tBTA_SYS_EVT_HDLR* evt_hdlr;
210 tBTA_SYS_DISABLE* disable;
211 } tBTA_SYS_REG;
212
213 /*****************************************************************************
214 * Macros
215 ****************************************************************************/
216 /* Calculate start of event enumeration; id is top 8 bits of event */
217 #define BTA_SYS_EVT_START(id) ((id) << 8)
218
219 /*****************************************************************************
220 * Function declarations
221 ****************************************************************************/
222 void bta_sys_init(void);
223 void bta_sys_register(uint8_t id, const tBTA_SYS_REG* p_reg);
224 void bta_sys_deregister(uint8_t id);
225 bool bta_sys_is_register(uint8_t id);
226 void bta_sys_sendmsg(void* p_msg);
227 void bta_sys_sendmsg_delayed(void* p_msg, std::chrono::microseconds delay);
228 void bta_sys_start_timer(alarm_t* alarm, uint64_t interval_ms, uint16_t event,
229 uint16_t layer_specific);
230 void bta_sys_disable();
231
232 void bta_sys_rm_register(tBTA_SYS_CONN_CBACK* p_cback);
233 void bta_sys_pm_register(tBTA_SYS_CONN_CBACK* p_cback);
234 void bta_sys_sniff_register(tBTA_SYS_SNIFF_CBACK* p_cback);
235 void bta_sys_sco_register(tBTA_SYS_CONN_SCO_CBACK* p_cback);
236
237 void bta_sys_conn_open(tBTA_SYS_ID id, uint8_t app_id, const RawAddress& peer_addr);
238 void bta_sys_conn_close(tBTA_SYS_ID id, uint8_t app_id, const RawAddress& peer_addr);
239 void bta_sys_app_open(tBTA_SYS_ID id, uint8_t app_id, const RawAddress& peer_addr);
240 void bta_sys_app_close(tBTA_SYS_ID id, uint8_t app_id, const RawAddress& peer_addr);
241 void bta_sys_sco_open(tBTA_SYS_ID id, uint8_t app_id, const RawAddress& peer_addr);
242 void bta_sys_sco_close(tBTA_SYS_ID id, uint8_t app_id, const RawAddress& peer_addr);
243 void bta_sys_sco_use(tBTA_SYS_ID id, uint8_t app_id, const RawAddress& peer_addr);
244 void bta_sys_sco_unuse(tBTA_SYS_ID id, uint8_t app_id, const RawAddress& peer_addr);
245 void bta_sys_idle(tBTA_SYS_ID id, uint8_t app_id, const RawAddress& peer_addr);
246 void bta_sys_busy(tBTA_SYS_ID id, uint8_t app_id, const RawAddress& peer_addr);
247 void bta_sys_reset_sniff(uint8_t id, uint8_t app_id, const RawAddress& peer_addr);
248
249 void bta_sys_role_chg_register(tBTA_SYS_ROLE_SWITCH_CBACK* p_cback);
250 void bta_sys_notify_role_chg(const RawAddress& peer_addr, tHCI_ROLE new_role,
251 tHCI_STATUS hci_status);
252 void bta_sys_collision_register(tBTA_SYS_ID bta_id, tBTA_SYS_CONN_CBACK* p_cback);
253 void bta_sys_notify_collision(const RawAddress& peer_addr);
254
255 void bta_sys_eir_register(tBTA_SYS_EIR_CBACK* p_cback);
256 void bta_sys_eir_unregister();
257 void bta_sys_add_uuid(uint16_t uuid16);
258 void bta_sys_remove_uuid(uint16_t uuid16);
259 void bta_sys_cust_eir_register(tBTA_SYS_CUST_EIR_CBACK* p_cback);
260 void bta_sys_add_cust_uuid(const tBTA_CUSTOM_UUID& curr);
261 void bta_sys_remove_cust_uuid(const tBTA_CUSTOM_UUID& curr);
262
263 namespace std {
264 template <>
265 struct formatter<tBTA_SYS_ID> : enum_formatter<tBTA_SYS_ID> {};
266 template <>
267 struct formatter<tBTA_SYS_CONN_STATUS> : enum_formatter<tBTA_SYS_CONN_STATUS> {};
268 } // namespace std
269
270 #endif /* BTA_SYS_H */
271