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