1 /******************************************************************************
3 * Copyright (C) 1999-2012 Broadcom Corporation
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 ******************************************************************************/
19 /******************************************************************************
21 * This file contains functions for BLE whitelist operation.
23 ******************************************************************************/
28 #include "device/include/controller.h"
29 #include "osi/include/allocator.h"
30 #include "osi/include/hash_map.h"
38 #ifndef BTM_BLE_SCAN_PARAM_TOUT
39 #define BTM_BLE_SCAN_PARAM_TOUT 50 /* 50 seconds */
42 #if (BLE_INCLUDED == TRUE)
44 static void btm_suspend_wl_activity(tBTM_BLE_WL_STATE wl_state);
45 static void btm_resume_wl_activity(tBTM_BLE_WL_STATE wl_state);
47 // Unfortunately (for now?) we have to maintain a copy of the device whitelist
48 // on the host to determine if a device is pending to be connected or not. This
49 // controls whether the host should keep trying to scan for whitelisted
50 // peripherals or not.
51 // TODO: Move all of this to controller/le/background_list or similar?
52 static const size_t background_connection_buckets = 42;
53 static hash_map_t *background_connections = NULL;
55 typedef struct background_connection_t {
57 } background_connection_t;
59 static bool bdaddr_equality_fn(const void *x, const void *y) {
60 return bdaddr_equals((bt_bdaddr_t *)x, (bt_bdaddr_t *)y);
63 static void background_connections_lazy_init()
65 if (!background_connections) {
66 background_connections = hash_map_new(background_connection_buckets,
67 hash_function_bdaddr, NULL, osi_free, bdaddr_equality_fn);
68 assert(background_connections);
72 static void background_connection_add(bt_bdaddr_t *address) {
74 background_connections_lazy_init();
75 background_connection_t *connection = hash_map_get(background_connections, address);
77 connection = osi_calloc(sizeof(background_connection_t));
78 connection->address = *address;
79 hash_map_set(background_connections, &(connection->address), connection);
83 static void background_connection_remove(bt_bdaddr_t *address) {
84 if (address && background_connections)
85 hash_map_erase(background_connections, address);
88 static void background_connections_clear() {
89 if (background_connections)
90 hash_map_clear(background_connections);
93 static bool background_connections_pending_cb(hash_map_entry_t *hash_entry, void *context) {
94 bool *pending_connections = context;
95 background_connection_t *connection = hash_entry->data;
96 const bool connected = BTM_IsAclConnectionUp(connection->address.address, BT_TRANSPORT_LE);
98 *pending_connections = true;
104 static bool background_connections_pending() {
105 bool pending_connections = false;
106 if (background_connections)
107 hash_map_foreach(background_connections, background_connections_pending_cb, &pending_connections);
108 return pending_connections;
111 /*******************************************************************************
113 ** Function btm_update_scanner_filter_policy
115 ** Description This function updates the filter policy of scanner
116 *******************************************************************************/
117 void btm_update_scanner_filter_policy(tBTM_BLE_SFP scan_policy)
119 tBTM_BLE_INQ_CB *p_inq = &btm_cb.ble_ctr_cb.inq_var;
121 UINT32 scan_interval = !p_inq->scan_interval ? BTM_BLE_GAP_DISC_SCAN_INT : p_inq->scan_interval;
122 UINT32 scan_window = !p_inq->scan_window ? BTM_BLE_GAP_DISC_SCAN_WIN : p_inq->scan_window;
124 BTM_TRACE_EVENT ("%s", __func__);
126 p_inq->sfp = scan_policy;
127 p_inq->scan_type = p_inq->scan_type == BTM_BLE_SCAN_MODE_NONE ? BTM_BLE_SCAN_MODE_ACTI : p_inq->scan_type;
129 if (btm_cb.cmn_ble_vsc_cb.extended_scan_support == 0)
131 btsnd_hcic_ble_set_scan_params(p_inq->scan_type, (UINT16)scan_interval,
133 btm_cb.ble_ctr_cb.addr_mgnt_cb.own_addr_type,
138 btm_ble_send_extended_scan_params(p_inq->scan_type, scan_interval, scan_window,
139 btm_cb.ble_ctr_cb.addr_mgnt_cb.own_addr_type,
143 /*******************************************************************************
145 ** Function btm_add_dev_to_controller
147 ** Description This function load the device into controller white list
148 *******************************************************************************/
149 BOOLEAN btm_add_dev_to_controller (BOOLEAN to_add, BD_ADDR bd_addr)
151 tBTM_SEC_DEV_REC *p_dev_rec = btm_find_dev (bd_addr);
152 tBLE_ADDR_TYPE addr_type = BLE_ADDR_PUBLIC;
153 BOOLEAN started = FALSE;
154 BD_ADDR dummy_bda = {0};
155 tBT_DEVICE_TYPE dev_type;
157 if (p_dev_rec != NULL &&
158 p_dev_rec->device_type & BT_DEVICE_TYPE_BLE)
162 if (p_dev_rec->ble.ble_addr_type == BLE_ADDR_PUBLIC || !BTM_BLE_IS_RESOLVE_BDA(bd_addr))
164 started = btsnd_hcic_ble_add_white_list (p_dev_rec->ble.ble_addr_type, bd_addr);
165 p_dev_rec->ble.in_controller_list |= BTM_WHITE_LIST_BIT;
167 else if (memcmp(p_dev_rec->ble.static_addr, bd_addr, BD_ADDR_LEN) != 0 &&
168 memcmp(p_dev_rec->ble.static_addr, dummy_bda, BD_ADDR_LEN) != 0)
170 started = btsnd_hcic_ble_add_white_list (p_dev_rec->ble.static_addr_type,
171 p_dev_rec->ble.static_addr);
172 p_dev_rec->ble.in_controller_list |= BTM_WHITE_LIST_BIT;
177 if (p_dev_rec->ble.ble_addr_type == BLE_ADDR_PUBLIC || !BTM_BLE_IS_RESOLVE_BDA(bd_addr))
179 started = btsnd_hcic_ble_remove_from_white_list (p_dev_rec->ble.ble_addr_type, bd_addr);
181 if (memcmp(p_dev_rec->ble.static_addr, dummy_bda, BD_ADDR_LEN) != 0 &&
182 memcmp(p_dev_rec->ble.static_addr, bd_addr, BD_ADDR_LEN) != 0)
184 started = btsnd_hcic_ble_remove_from_white_list (p_dev_rec->ble.static_addr_type, p_dev_rec->ble.static_addr);
186 p_dev_rec->ble.in_controller_list &= ~BTM_WHITE_LIST_BIT;
188 } /* if not a known device, shall we add it? */
191 BTM_ReadDevInfo(bd_addr, &dev_type, &addr_type);
193 started = btsnd_hcic_ble_remove_from_white_list (addr_type, bd_addr);
195 started = btsnd_hcic_ble_add_white_list (addr_type, bd_addr);
201 /*******************************************************************************
203 ** Function btm_execute_wl_dev_operation
205 ** Description execute the pending whitelist device operation(loading or removing)
206 *******************************************************************************/
207 BOOLEAN btm_execute_wl_dev_operation(void)
209 tBTM_BLE_WL_OP *p_dev_op = btm_cb.ble_ctr_cb.wl_op_q;
213 for (i = 0; i < BTM_BLE_MAX_BG_CONN_DEV_NUM && rt; i ++, p_dev_op ++)
215 if (p_dev_op->in_use)
217 rt = btm_add_dev_to_controller(p_dev_op->to_add, p_dev_op->bd_addr);
218 memset(p_dev_op, 0, sizeof(tBTM_BLE_WL_OP));
225 /*******************************************************************************
227 ** Function btm_enq_wl_dev_operation
229 ** Description enqueue the pending whitelist device operation(loading or removing).
230 *******************************************************************************/
231 void btm_enq_wl_dev_operation(BOOLEAN to_add, BD_ADDR bd_addr)
233 tBTM_BLE_WL_OP *p_dev_op = btm_cb.ble_ctr_cb.wl_op_q;
236 for (i = 0; i < BTM_BLE_MAX_BG_CONN_DEV_NUM; i ++, p_dev_op ++)
238 if (p_dev_op->in_use && !memcmp(p_dev_op->bd_addr, bd_addr, BD_ADDR_LEN))
240 p_dev_op->to_add = to_add;
243 else if (!p_dev_op->in_use)
246 if (i != BTM_BLE_MAX_BG_CONN_DEV_NUM)
248 p_dev_op->in_use = TRUE;
249 p_dev_op->to_add = to_add;
250 memcpy(p_dev_op->bd_addr, bd_addr, BD_ADDR_LEN);
254 BTM_TRACE_ERROR("max pending WL operation reached, discard");
259 /*******************************************************************************
261 ** Function btm_update_dev_to_white_list
263 ** Description This function adds or removes a device into/from
266 *******************************************************************************/
267 BOOLEAN btm_update_dev_to_white_list(BOOLEAN to_add, BD_ADDR bd_addr)
269 tBTM_BLE_CB *p_cb = &btm_cb.ble_ctr_cb;
271 if (to_add && p_cb->white_list_avail_size == 0)
273 BTM_TRACE_ERROR("%s Whitelist full, unable to add device", __func__);
278 background_connection_add((bt_bdaddr_t*)bd_addr);
280 background_connection_remove((bt_bdaddr_t*)bd_addr);
282 btm_suspend_wl_activity(p_cb->wl_state);
283 btm_enq_wl_dev_operation(to_add, bd_addr);
284 btm_resume_wl_activity(p_cb->wl_state);
288 /*******************************************************************************
290 ** Function btm_ble_clear_white_list
292 ** Description This function clears the white list.
294 *******************************************************************************/
295 void btm_ble_clear_white_list (void)
297 BTM_TRACE_EVENT ("btm_ble_clear_white_list");
298 btsnd_hcic_ble_clear_white_list();
299 background_connections_clear();
302 /*******************************************************************************
304 ** Function btm_ble_clear_white_list_complete
306 ** Description Indicates white list cleared.
308 *******************************************************************************/
309 void btm_ble_clear_white_list_complete(UINT8 *p_data, UINT16 evt_len)
311 tBTM_BLE_CB *p_cb = &btm_cb.ble_ctr_cb;
315 BTM_TRACE_EVENT ("btm_ble_clear_white_list_complete");
316 STREAM_TO_UINT8 (status, p_data);
318 if (status == HCI_SUCCESS)
319 p_cb->white_list_avail_size = controller_get_interface()->get_ble_white_list_size();
322 /*******************************************************************************
324 ** Function btm_ble_white_list_init
326 ** Description Initialize white list size
328 *******************************************************************************/
329 void btm_ble_white_list_init(UINT8 white_list_size)
331 BTM_TRACE_DEBUG("%s white_list_size = %d", __func__, white_list_size);
332 btm_cb.ble_ctr_cb.white_list_avail_size = white_list_size;
335 /*******************************************************************************
337 ** Function btm_ble_add_2_white_list_complete
339 ** Description White list element added
341 *******************************************************************************/
342 void btm_ble_add_2_white_list_complete(UINT8 status)
344 BTM_TRACE_EVENT("%s status=%d", __func__, status);
345 if (status == HCI_SUCCESS)
346 --btm_cb.ble_ctr_cb.white_list_avail_size;
349 /*******************************************************************************
351 ** Function btm_ble_remove_from_white_list_complete
353 ** Description White list element removal complete
355 *******************************************************************************/
356 void btm_ble_remove_from_white_list_complete(UINT8 *p, UINT16 evt_len)
359 BTM_TRACE_EVENT ("%s status=%d", __func__, *p);
360 if (*p == HCI_SUCCESS)
361 ++btm_cb.ble_ctr_cb.white_list_avail_size;
364 /*******************************************************************************
366 ** Function btm_ble_start_auto_conn
368 ** Description This function is to start/stop auto connection procedure.
370 ** Parameters start: TRUE to start; FALSE to stop.
374 *******************************************************************************/
375 BOOLEAN btm_ble_start_auto_conn(BOOLEAN start)
377 tBTM_BLE_CB *p_cb = &btm_cb.ble_ctr_cb;
378 BD_ADDR dummy_bda = {0};
382 UINT8 own_addr_type = p_cb->addr_mgnt_cb.own_addr_type;
383 UINT8 peer_addr_type = BLE_ADDR_PUBLIC;
387 if (p_cb->conn_state == BLE_CONN_IDLE && background_connections_pending()
388 && btm_ble_topology_check(BTM_BLE_STATE_INIT))
390 p_cb->wl_state |= BTM_BLE_WL_INIT;
392 btm_execute_wl_dev_operation();
394 #if BLE_PRIVACY_SPT == TRUE
395 btm_ble_enable_resolving_list_for_platform(BTM_BLE_RL_INIT);
397 scan_int = (p_cb->scan_int == BTM_BLE_SCAN_PARAM_UNDEF) ?
398 BTM_BLE_SCAN_SLOW_INT_1 : p_cb->scan_int;
399 scan_win = (p_cb->scan_win == BTM_BLE_SCAN_PARAM_UNDEF) ?
400 BTM_BLE_SCAN_SLOW_WIN_1 : p_cb->scan_win;
402 #if BLE_PRIVACY_SPT == TRUE
403 if (btm_cb.ble_ctr_cb.rl_state != BTM_BLE_RL_IDLE
404 && controller_get_interface()->supports_ble_privacy())
406 own_addr_type |= BLE_ADDR_TYPE_ID_BIT;
407 peer_addr_type |= BLE_ADDR_TYPE_ID_BIT;
411 if (!btsnd_hcic_ble_create_ll_conn (scan_int, /* UINT16 scan_int */
412 scan_win, /* UINT16 scan_win */
413 0x01, /* UINT8 white_list */
414 peer_addr_type, /* UINT8 addr_type_peer */
415 dummy_bda, /* BD_ADDR bda_peer */
416 own_addr_type, /* UINT8 addr_type_own */
417 BTM_BLE_CONN_INT_MIN_DEF, /* UINT16 conn_int_min */
418 BTM_BLE_CONN_INT_MAX_DEF, /* UINT16 conn_int_max */
419 BTM_BLE_CONN_SLAVE_LATENCY_DEF, /* UINT16 conn_latency */
420 BTM_BLE_CONN_TIMEOUT_DEF, /* UINT16 conn_timeout */
421 0, /* UINT16 min_len */
422 0)) /* UINT16 max_len */
424 /* start auto connection failed */
426 p_cb->wl_state &= ~BTM_BLE_WL_INIT;
430 btm_ble_set_conn_st (BLE_BG_CONN);
440 if (p_cb->conn_state == BLE_BG_CONN)
442 btsnd_hcic_ble_create_conn_cancel();
443 btm_ble_set_conn_st (BLE_CONN_CANCEL);
444 p_cb->wl_state &= ~BTM_BLE_WL_INIT;
448 BTM_TRACE_DEBUG("conn_st = %d, not in auto conn state, cannot stop", p_cb->conn_state);
455 /*******************************************************************************
457 ** Function btm_ble_start_select_conn
459 ** Description This function is to start/stop selective connection procedure.
461 ** Parameters start: TRUE to start; FALSE to stop.
462 ** p_select_cback: callback function to return application
465 ** Returns BOOLEAN: selective connectino procedure is started.
467 *******************************************************************************/
468 BOOLEAN btm_ble_start_select_conn(BOOLEAN start, tBTM_BLE_SEL_CBACK *p_select_cback)
470 tBTM_BLE_CB *p_cb = &btm_cb.ble_ctr_cb;
471 UINT32 scan_int = p_cb->scan_int == BTM_BLE_SCAN_PARAM_UNDEF ? BTM_BLE_SCAN_FAST_INT : p_cb->scan_int;
472 UINT32 scan_win = p_cb->scan_win == BTM_BLE_SCAN_PARAM_UNDEF ? BTM_BLE_SCAN_FAST_WIN : p_cb->scan_win;
474 BTM_TRACE_EVENT ("%s", __func__);
478 if (!BTM_BLE_IS_SCAN_ACTIVE(p_cb->scan_activity))
480 if (p_select_cback != NULL)
481 btm_cb.ble_ctr_cb.p_select_cback = p_select_cback;
483 btm_execute_wl_dev_operation();
485 btm_update_scanner_filter_policy(SP_ADV_WL);
486 btm_cb.ble_ctr_cb.inq_var.scan_type = BTM_BLE_SCAN_MODE_PASS;
488 /* Process advertising packets only from devices in the white list */
489 if (btm_cb.cmn_ble_vsc_cb.extended_scan_support == 0)
491 /* use passive scan by default */
492 if (!btsnd_hcic_ble_set_scan_params(BTM_BLE_SCAN_MODE_PASS,
495 p_cb->addr_mgnt_cb.own_addr_type,
503 if (!btm_ble_send_extended_scan_params(BTM_BLE_SCAN_MODE_PASS,
506 p_cb->addr_mgnt_cb.own_addr_type,
513 if (!btm_ble_topology_check(BTM_BLE_STATE_PASSIVE_SCAN))
515 BTM_TRACE_ERROR("peripheral device cannot initiate passive scan for a selective connection");
518 else if (background_connections_pending())
520 #if BLE_PRIVACY_SPT == TRUE
521 btm_ble_enable_resolving_list_for_platform(BTM_BLE_RL_SCAN);
523 if (!btsnd_hcic_ble_set_scan_enable(TRUE, TRUE)) /* duplicate filtering enabled */
526 /* mark up inquiry status flag */
527 p_cb->scan_activity |= BTM_LE_SELECT_CONN_ACTIVE;
528 p_cb->wl_state |= BTM_BLE_WL_SCAN;
533 BTM_TRACE_ERROR("scan active, can not start selective connection procedure");
537 else /* disable selective connection mode */
539 p_cb->scan_activity &= ~BTM_LE_SELECT_CONN_ACTIVE;
540 p_cb->p_select_cback = NULL;
541 p_cb->wl_state &= ~BTM_BLE_WL_SCAN;
544 if (!BTM_BLE_IS_SCAN_ACTIVE(p_cb->scan_activity))
545 btm_ble_stop_scan(); /* duplicate filtering enabled */
549 /*******************************************************************************
551 ** Function btm_ble_initiate_select_conn
553 ** Description This function is to start/stop selective connection procedure.
555 ** Parameters start: TRUE to start; FALSE to stop.
556 ** p_select_cback: callback function to return application
559 ** Returns BOOLEAN: selective connectino procedure is started.
561 *******************************************************************************/
562 void btm_ble_initiate_select_conn(BD_ADDR bda)
564 BTM_TRACE_EVENT ("btm_ble_initiate_select_conn");
566 /* use direct connection procedure to initiate connection */
567 if (!L2CA_ConnectFixedChnl(L2CAP_ATT_CID, bda))
569 BTM_TRACE_ERROR("btm_ble_initiate_select_conn failed");
572 /*******************************************************************************
574 ** Function btm_ble_suspend_bg_conn
576 ** Description This function is to suspend an active background connection
583 *******************************************************************************/
584 BOOLEAN btm_ble_suspend_bg_conn(void)
586 BTM_TRACE_EVENT ("%s", __func__);
588 if (btm_cb.ble_ctr_cb.bg_conn_type == BTM_BLE_CONN_AUTO)
589 return btm_ble_start_auto_conn(FALSE);
590 else if (btm_cb.ble_ctr_cb.bg_conn_type == BTM_BLE_CONN_SELECTIVE)
591 return btm_ble_start_select_conn(FALSE, NULL);
595 /*******************************************************************************
597 ** Function btm_suspend_wl_activity
599 ** Description This function is to suspend white list related activity
603 *******************************************************************************/
604 static void btm_suspend_wl_activity(tBTM_BLE_WL_STATE wl_state)
606 if (wl_state & BTM_BLE_WL_INIT)
608 btm_ble_start_auto_conn(FALSE);
610 if (wl_state & BTM_BLE_WL_SCAN)
612 btm_ble_start_select_conn(FALSE, NULL);
614 if (wl_state & BTM_BLE_WL_ADV)
620 /*******************************************************************************
622 ** Function btm_resume_wl_activity
624 ** Description This function is to resume white list related activity
628 *******************************************************************************/
629 static void btm_resume_wl_activity(tBTM_BLE_WL_STATE wl_state)
631 btm_ble_resume_bg_conn();
633 if (wl_state & BTM_BLE_WL_ADV)
639 /*******************************************************************************
641 ** Function btm_ble_resume_bg_conn
643 ** Description This function is to resume a background auto connection
650 *******************************************************************************/
651 BOOLEAN btm_ble_resume_bg_conn(void)
653 tBTM_BLE_CB *p_cb = &btm_cb.ble_ctr_cb;
656 if (p_cb->bg_conn_type != BTM_BLE_CONN_NONE)
658 if (p_cb->bg_conn_type == BTM_BLE_CONN_AUTO)
659 ret = btm_ble_start_auto_conn(TRUE);
661 if (p_cb->bg_conn_type == BTM_BLE_CONN_SELECTIVE)
662 ret = btm_ble_start_select_conn(TRUE, btm_cb.ble_ctr_cb.p_select_cback);
667 /*******************************************************************************
669 ** Function btm_ble_get_conn_st
671 ** Description This function get BLE connection state
673 ** Returns connection state
675 *******************************************************************************/
676 tBTM_BLE_CONN_ST btm_ble_get_conn_st(void)
678 return btm_cb.ble_ctr_cb.conn_state;
680 /*******************************************************************************
682 ** Function btm_ble_set_conn_st
684 ** Description This function set BLE connection state
688 *******************************************************************************/
689 void btm_ble_set_conn_st(tBTM_BLE_CONN_ST new_st)
691 btm_cb.ble_ctr_cb.conn_state = new_st;
693 if (new_st == BLE_BG_CONN || new_st == BLE_DIR_CONN)
694 btm_ble_set_topology_mask(BTM_BLE_STATE_INIT_BIT);
696 btm_ble_clear_topology_mask(BTM_BLE_STATE_INIT_BIT);
699 /*******************************************************************************
701 ** Function btm_ble_enqueue_direct_conn_req
703 ** Description This function enqueue the direct connection request
707 *******************************************************************************/
708 void btm_ble_enqueue_direct_conn_req(void *p_param)
710 tBTM_BLE_CONN_REQ *p = (tBTM_BLE_CONN_REQ *)GKI_getbuf(sizeof(tBTM_BLE_CONN_REQ));
712 p->p_param = p_param;
714 GKI_enqueue (&btm_cb.ble_ctr_cb.conn_pending_q, p);
716 /*******************************************************************************
718 ** Function btm_send_pending_direct_conn
720 ** Description This function send the pending direct connection request in queue
722 ** Returns TRUE if started, FALSE otherwise
724 *******************************************************************************/
725 BOOLEAN btm_send_pending_direct_conn(void)
727 tBTM_BLE_CONN_REQ *p_req;
730 if (!GKI_queue_is_empty(&btm_cb.ble_ctr_cb.conn_pending_q))
732 p_req = (tBTM_BLE_CONN_REQ*)GKI_dequeue (&btm_cb.ble_ctr_cb.conn_pending_q);
734 rt = l2cble_init_direct_conn((tL2C_LCB *)(p_req->p_param));
736 GKI_freebuf((void *)p_req);