1 /******************************************************************************
2 *
3 * Copyright 1999-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 #ifndef BTM_BLE_INT_TYPES_H
20 #define BTM_BLE_INT_TYPES_H
21
22 #include "osi/include/alarm.h"
23
24 /* scanning enable status */
25 #define BTM_BLE_SCAN_ENABLE 0x01
26 #define BTM_BLE_SCAN_DISABLE 0x00
27
28 /* advertising enable status */
29 #define BTM_BLE_ADV_ENABLE 0x01
30 #define BTM_BLE_ADV_DISABLE 0x00
31
32 /* use the high 4 bits unused by inquiry mode */
33 #define BTM_BLE_SELECT_SCAN 0x20
34 #define BTM_BLE_NAME_REQUEST 0x40
35 #define BTM_BLE_OBSERVE 0x80
36
37 #define BTM_BLE_MAX_WL_ENTRY 1
38 #define BTM_BLE_AD_DATA_LEN 31
39
40 #define BTM_BLE_ENC_MASK 0x03
41
42 #define BTM_BLE_DUPLICATE_ENABLE 1
43 #define BTM_BLE_DUPLICATE_DISABLE 0
44
45 /* Interval(scan_int) = 11.25 ms= 0x0010 * 0.625 ms */
46 #define BTM_BLE_GAP_DISC_SCAN_INT 18
47 /* scan_window = 11.25 ms= 0x0010 * 0.625 ms */
48 #define BTM_BLE_GAP_DISC_SCAN_WIN 18
49 /* Tgap(gen_disc) = 1.28 s= 512 * 0.625 ms */
50 #define BTM_BLE_GAP_ADV_INT 512
51 /* Tgap(lim_timeout) = 180s max */
52 #define BTM_BLE_GAP_LIM_TIMEOUT_MS (180 * 1000)
53 /* Interval(scan_int) = 5s= 8000 * 0.625 ms */
54 #define BTM_BLE_LOW_LATENCY_SCAN_INT 8000
55 /* scan_window = 5s= 8000 * 0.625 ms */
56 #define BTM_BLE_LOW_LATENCY_SCAN_WIN 8000
57
58 /* TGAP(adv_fast_interval1) = 30(used) ~ 60 ms = 48 *0.625 */
59 #define BTM_BLE_GAP_ADV_FAST_INT_1 48
60 /* TGAP(adv_fast_interval2) = 100(used) ~ 150 ms = 160 * 0.625 ms */
61 #define BTM_BLE_GAP_ADV_FAST_INT_2 160
62 /* Tgap(adv_slow_interval) = 1.28 s= 512 * 0.625 ms */
63 #define BTM_BLE_GAP_ADV_SLOW_INT 2048
64 /* Tgap(dir_conn_adv_int_max) = 500 ms = 800 * 0.625 ms */
65 #define BTM_BLE_GAP_ADV_DIR_MAX_INT 800
66 /* Tgap(dir_conn_adv_int_min) = 250 ms = 400 * 0.625 ms */
67 #define BTM_BLE_GAP_ADV_DIR_MIN_INT 400
68
69 #define BTM_BLE_GAP_FAST_ADV_TIMEOUT_MS (30 * 1000)
70
71 #define BTM_BLE_SEC_REQ_ACT_NONE 0
72 /* encrypt the link using current key or key refresh */
73 #define BTM_BLE_SEC_REQ_ACT_ENCRYPT 1
74 #define BTM_BLE_SEC_REQ_ACT_PAIR 2
75 /* discard the sec request while encryption is started but not completed */
76 #define BTM_BLE_SEC_REQ_ACT_DISCARD 3
77 typedef uint8_t tBTM_BLE_SEC_REQ_ACT;
78
79 #define BLE_STATIC_PRIVATE_MSB_MASK 0x3f
80 /* most significant bit, bit7, bit6 is 01 to be resolvable random */
81 #define BLE_RESOLVE_ADDR_MSB 0x40
82 /* bit 6, and bit7 */
83 #define BLE_RESOLVE_ADDR_MASK 0xc0
BTM_BLE_IS_RESOLVE_BDA(const RawAddress & x)84 inline bool BTM_BLE_IS_RESOLVE_BDA(const RawAddress& x) {
85 return ((x.address)[0] & BLE_RESOLVE_ADDR_MASK) == BLE_RESOLVE_ADDR_MSB;
86 }
87
88 /* LE scan activity bit mask, continue with LE inquiry bits */
89 /* observe is in progress */
90 #define BTM_LE_OBSERVE_ACTIVE 0x80
91
92 /* BLE scan activity mask checking */
93 #define BTM_BLE_IS_SCAN_ACTIVE(x) ((x)&BTM_BLE_SCAN_ACTIVE_MASK)
94 #define BTM_BLE_IS_INQ_ACTIVE(x) ((x)&BTM_BLE_INQUIRY_MASK)
95 #define BTM_BLE_IS_OBS_ACTIVE(x) ((x)&BTM_LE_OBSERVE_ACTIVE)
96
97 /* BLE ADDR type ID bit */
98 #define BLE_ADDR_TYPE_ID_BIT 0x02
99
100 #define BTM_VSC_CHIP_CAPABILITY_L_VERSION 55
101 #define BTM_VSC_CHIP_CAPABILITY_M_VERSION 95
102
103 typedef struct {
104 uint16_t data_mask;
105 uint8_t* p_flags;
106 uint8_t ad_data[BTM_BLE_AD_DATA_LEN];
107 uint8_t* p_pad;
108 } tBTM_BLE_LOCAL_ADV_DATA;
109
110 typedef struct {
111 /* Used for determining if a response has already been received for the
112 * current inquiry operation. (We do not want to flood the caller with
113 * multiple responses from the same device. */
114 uint32_t inq_count;
115 bool scan_rsp;
116 tBLE_BD_ADDR le_bda;
117 } tINQ_LE_BDADDR;
118
119 #define BTM_BLE_ISVALID_PARAM(x, min, max) \
120 (((x) >= (min) && (x) <= (max)) || ((x) == BTM_BLE_CONN_PARAM_UNDEF))
121
122 typedef struct {
123 uint16_t discoverable_mode;
124 uint16_t connectable_mode;
125 uint32_t scan_window;
126 uint32_t scan_interval;
127 uint8_t scan_type; /* current scan type: active or passive */
128 uint8_t scan_duplicate_filter; /* duplicate filter enabled for scan */
129 uint16_t adv_interval_min;
130 uint16_t adv_interval_max;
131 tBTM_BLE_AFP afp; /* advertising filter policy */
132 tBTM_BLE_SFP sfp; /* scanning filter policy */
133
134 tBLE_ADDR_TYPE adv_addr_type;
135 uint8_t evt_type;
136 uint8_t adv_mode;
137 tBLE_BD_ADDR direct_bda;
138 tBTM_BLE_EVT directed_conn;
139 bool fast_adv_on;
140 alarm_t* fast_adv_timer;
141
142 /* inquiry BD addr database */
143 uint8_t num_bd_entries;
144 uint8_t max_bd_entries;
145 tBTM_BLE_LOCAL_ADV_DATA adv_data;
146 tBTM_BLE_ADV_CHNL_MAP adv_chnl_map;
147
148 alarm_t* inquiry_timer;
149 bool scan_rsp;
150 uint8_t state; /* Current state that the inquiry process is in */
151 int8_t tx_power;
152 } tBTM_BLE_INQ_CB;
153
154 /* random address resolving complete callback */
155 typedef void(tBTM_BLE_RESOLVE_CBACK)(void* match_rec, void* p);
156
157 typedef void(tBTM_BLE_ADDR_CBACK)(const RawAddress& static_random, void* p);
158
159 /* random address management control block */
160 typedef struct {
161 tBLE_ADDR_TYPE own_addr_type; /* local device LE address type */
162 RawAddress private_addr;
163 RawAddress random_bda;
164 tBTM_BLE_ADDR_CBACK* p_generate_cback;
165 void* p;
166 alarm_t* refresh_raddr_timer;
167 } tBTM_LE_RANDOM_CB;
168
169 typedef struct {
170 uint16_t min_conn_int;
171 uint16_t max_conn_int;
172 uint16_t slave_latency;
173 uint16_t supervision_tout;
174
175 } tBTM_LE_CONN_PRAMS;
176
177 typedef struct {
178 RawAddress bd_addr;
179 uint8_t attr;
180 bool is_connected;
181 bool in_use;
182 } tBTM_LE_BG_CONN_DEV;
183
184 /* white list using state as a bit mask */
185 constexpr uint8_t BTM_BLE_WL_IDLE = 0;
186 constexpr uint8_t BTM_BLE_WL_INIT = 1;
187
188 /* resolving list using state as a bit mask */
189 #define BTM_BLE_RL_IDLE 0
190 #define BTM_BLE_RL_INIT 1
191 #define BTM_BLE_RL_SCAN 2
192 #define BTM_BLE_RL_ADV 4
193 typedef uint8_t tBTM_BLE_RL_STATE;
194
195 /* BLE connection state */
196 #define BLE_CONN_IDLE 0
197 #define BLE_CONNECTING 2
198 #define BLE_CONN_CANCEL 3
199 typedef uint8_t tBTM_BLE_CONN_ST;
200
201 typedef struct { void* p_param; } tBTM_BLE_CONN_REQ;
202
203 /* LE state request */
204 #define BTM_BLE_STATE_INVALID 0
205 #define BTM_BLE_STATE_CONN_ADV 1
206 #define BTM_BLE_STATE_INIT 2
207 #define BTM_BLE_STATE_MASTER 3
208 #define BTM_BLE_STATE_SLAVE 4
209 #define BTM_BLE_STATE_LO_DUTY_DIR_ADV 5
210 #define BTM_BLE_STATE_HI_DUTY_DIR_ADV 6
211 #define BTM_BLE_STATE_NON_CONN_ADV 7
212 #define BTM_BLE_STATE_PASSIVE_SCAN 8
213 #define BTM_BLE_STATE_ACTIVE_SCAN 9
214 #define BTM_BLE_STATE_SCAN_ADV 10
215 #define BTM_BLE_STATE_MAX 11
216 typedef uint8_t tBTM_BLE_STATE;
217
218 #define BTM_BLE_STATE_CONN_ADV_BIT 0x0001
219 #define BTM_BLE_STATE_INIT_BIT 0x0002
220 #define BTM_BLE_STATE_MASTER_BIT 0x0004
221 #define BTM_BLE_STATE_SLAVE_BIT 0x0008
222 #define BTM_BLE_STATE_LO_DUTY_DIR_ADV_BIT 0x0010
223 #define BTM_BLE_STATE_HI_DUTY_DIR_ADV_BIT 0x0020
224 #define BTM_BLE_STATE_NON_CONN_ADV_BIT 0x0040
225 #define BTM_BLE_STATE_PASSIVE_SCAN_BIT 0x0080
226 #define BTM_BLE_STATE_ACTIVE_SCAN_BIT 0x0100
227 #define BTM_BLE_STATE_SCAN_ADV_BIT 0x0200
228 typedef uint16_t tBTM_BLE_STATE_MASK;
229
230 #define BTM_BLE_STATE_ALL_MASK 0x03ff
231 #define BTM_BLE_STATE_ALL_ADV_MASK \
232 (BTM_BLE_STATE_CONN_ADV_BIT | BTM_BLE_STATE_LO_DUTY_DIR_ADV_BIT | \
233 BTM_BLE_STATE_HI_DUTY_DIR_ADV_BIT | BTM_BLE_STATE_SCAN_ADV_BIT)
234 #define BTM_BLE_STATE_ALL_SCAN_MASK \
235 (BTM_BLE_STATE_PASSIVE_SCAN_BIT | BTM_BLE_STATE_ACTIVE_SCAN_BIT)
236 #define BTM_BLE_STATE_ALL_CONN_MASK \
237 (BTM_BLE_STATE_MASTER_BIT | BTM_BLE_STATE_SLAVE_BIT)
238
239 #ifndef BTM_LE_RESOLVING_LIST_MAX
240 #define BTM_LE_RESOLVING_LIST_MAX 0x20
241 #endif
242
243 typedef struct {
244 RawAddress* resolve_q_random_pseudo;
245 uint8_t* resolve_q_action;
246 uint8_t q_next;
247 uint8_t q_pending;
248 } tBTM_BLE_RESOLVE_Q;
249
250 typedef struct {
251 bool in_use;
252 bool to_add;
253 RawAddress bd_addr;
254 uint8_t attr;
255 } tBTM_BLE_WL_OP;
256
257 /* BLE privacy mode */
258 #define BTM_PRIVACY_NONE 0 /* BLE no privacy */
259 #define BTM_PRIVACY_1_1 1 /* BLE privacy 1.1, do not support privacy 1.0 */
260 #define BTM_PRIVACY_1_2 2 /* BLE privacy 1.2 */
261 #define BTM_PRIVACY_MIXED \
262 3 /* BLE privacy mixed mode, broadcom propietary mode */
263 typedef uint8_t tBTM_PRIVACY_MODE;
264
265 /* data length change event callback */
266 typedef void(tBTM_DATA_LENGTH_CHANGE_CBACK)(uint16_t max_tx_length,
267 uint16_t max_rx_length);
268
269 /* Define BLE Device Management control structure
270 */
271 typedef struct {
272 uint8_t scan_activity; /* LE scan activity mask */
273
274 /*****************************************************
275 ** BLE Inquiry
276 *****************************************************/
277 tBTM_BLE_INQ_CB inq_var;
278
279 /* observer callback and timer */
280 tBTM_INQ_RESULTS_CB* p_obs_results_cb;
281 tBTM_CMPL_CB* p_obs_cmpl_cb;
282 alarm_t* observer_timer;
283
284 /* background connection procedure cb value */
285 uint16_t scan_int;
286 uint16_t scan_win;
287
288 /* white list information */
289 uint8_t wl_state;
290
291 tBTM_BLE_CONN_ST conn_state;
292
293 /* random address management control block */
294 tBTM_LE_RANDOM_CB addr_mgnt_cb;
295
296 bool enabled;
297
298 #if (BLE_PRIVACY_SPT == TRUE)
299 bool mixed_mode; /* privacy 1.2 mixed mode is on or not */
300 tBTM_PRIVACY_MODE privacy_mode; /* privacy mode */
301 uint8_t resolving_list_avail_size; /* resolving list available size */
302 tBTM_BLE_RESOLVE_Q resolving_list_pend_q; /* Resolving list queue */
303 tBTM_BLE_RL_STATE suspended_rl_state; /* Suspended resolving list state */
304 uint8_t* irk_list_mask; /* IRK list availability mask, up to max entry bits */
305 tBTM_BLE_RL_STATE rl_state; /* Resolving list state */
306 #endif
307
308 /* current BLE link state */
309 tBTM_BLE_STATE_MASK cur_states; /* bit mask of tBTM_BLE_STATE */
310 uint8_t link_count[2]; /* total link count master and slave*/
311 } tBTM_BLE_CB;
312
313 #endif // BTM_BLE_INT_TYPES_H
314