Outline ![]()
Files ![]()
loading...
SourceVu![]()
ESP-IDF Framework and Examples![]()
ESP-IDF![]()
components/bt/host/bluedroid/stack/btm/btm_ble_privacy.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
/******************************************************************************
*
* Copyright (C) 1999-2012 Broadcom Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
******************************************************************************/
/******************************************************************************
*
* This file contains functions for BLE controller based privacy.
*
******************************************************************************/
#include <string.h>
#include "common/bt_target.h"
#if (BLE_INCLUDED == TRUE && BLE_PRIVACY_SPT == TRUE)
#include "stack/bt_types.h"
#include "stack/hcimsgs.h"
#include "stack/btu.h"
//#include "vendor_hcidefs.h"
#include "btm_int.h"
#include "device/controller.h"
#include "stack/hcidefs.h"
#define HCI_VENDOR_BLE_RPA_VSC (0x0155 | HCI_GRP_VENDOR_SPECIFIC)
/* RPA offload VSC specifics */
#define BTM_BLE_META_IRK_ENABLE 0x01
#define BTM_BLE_META_ADD_IRK_ENTRY 0x02
#define BTM_BLE_META_REMOVE_IRK_ENTRY 0x03
#define BTM_BLE_META_CLEAR_IRK_LIST 0x04
#define BTM_BLE_META_READ_IRK_ENTRY 0x05
#define BTM_BLE_META_CS_RESOLVE_ADDR 0x00000001
#define BTM_BLE_IRK_ENABLE_LEN 2
#define BTM_BLE_META_ADD_IRK_LEN 24
#define BTM_BLE_META_REMOVE_IRK_LEN 8
#define BTM_BLE_META_CLEAR_IRK_LEN 1
#define BTM_BLE_META_READ_IRK_LEN 2
#define BTM_BLE_META_ADD_WL_ATTR_LEN 9
/*******************************************************************************
** Functions implemented controller based privacy using Resolving List
*******************************************************************************/
/*******************************************************************************
**
** Function btm_ble_enq_resolving_list_pending
**
** Description add target address into resolving pending operation queue
**
** Parameters target_bda: target device address
** add_entry: TRUE for add entry, FALSE for remove entry
**
** Returns void
**
*******************************************************************************/
void btm_ble_enq_resolving_list_pending(BD_ADDR pseudo_bda, UINT8 op_code)
{
tBTM_BLE_RESOLVE_Q *p_q = &btm_cb.ble_ctr_cb.resolving_list_pend_q;
memcpy(p_q->resolve_q_random_pseudo[p_q->q_next], pseudo_bda, BD_ADDR_LEN);
p_q->resolve_q_action[p_q->q_next] = op_code;
p_q->q_next ++;
p_q->q_next %= controller_get_interface()->get_ble_resolving_list_max_size();
}
/*******************************************************************************
**
** Function btm_ble_brcm_find_resolving_pending_entry
**
** Description check to see if the action is in pending list
**
** Parameters TRUE: action pending;
** FALSE: new action
**
** Returns void
**
*******************************************************************************/
BOOLEAN btm_ble_brcm_find_resolving_pending_entry(BD_ADDR pseudo_addr, UINT8 action)
{
tBTM_BLE_RESOLVE_Q *p_q = &btm_cb.ble_ctr_cb.resolving_list_pend_q;
for (UINT8 i = p_q->q_pending; i != p_q->q_next;) {
if (memcmp(p_q->resolve_q_random_pseudo[i], pseudo_addr, BD_ADDR_LEN) == 0 &&
action == p_q->resolve_q_action[i]) {
return TRUE;
}
i ++;
i %= controller_get_interface()->get_ble_resolving_list_max_size();
}
return FALSE;
}
/*******************************************************************************
**
** Function btm_ble_deq_resolving_pending
**
** Description dequeue target address from resolving pending operation queue
**
** Parameters pseudo_addr: pseudo_addr device address
**
** Returns void
**
*******************************************************************************/
BOOLEAN btm_ble_deq_resolving_pending(BD_ADDR pseudo_addr)
{
tBTM_BLE_RESOLVE_Q *p_q = &btm_cb.ble_ctr_cb.resolving_list_pend_q;
if (p_q->q_next != p_q->q_pending) {
memcpy(pseudo_addr, p_q->resolve_q_random_pseudo[p_q->q_pending], BD_ADDR_LEN);
memset(p_q->resolve_q_random_pseudo[p_q->q_pending], 0, BD_ADDR_LEN);
p_q->q_pending ++;
p_q->q_pending %= controller_get_interface()->get_ble_resolving_list_max_size();
return TRUE;
}
return FALSE;
}
/*******************************************************************************
**
** Function btm_ble_clear_irk_index
**
** Description clear IRK list index mask for availability
**
** Returns none
**
*******************************************************************************/
void btm_ble_clear_irk_index(UINT8 index)
{
UINT8 byte;
UINT8 bit;
if (index < controller_get_interface()->get_ble_resolving_list_max_size()) {
byte = index / 8;
bit = index % 8;
btm_cb.ble_ctr_cb.irk_list_mask[byte] &= (~(1 << bit));
}
}
/*******************************************************************************
**
** Function btm_ble_find_irk_index
**
** Description find the first available IRK list index
**
** Returns index from 0 ~ max (127 default)
**
*******************************************************************************/
UINT8 btm_ble_find_irk_index(void)
{
UINT8 i = 0;
UINT8 byte;
UINT8 bit;
while (i < controller_get_interface()->get_ble_resolving_list_max_size()) {
byte = i / 8;
bit = i % 8;
if ((btm_cb.ble_ctr_cb.irk_list_mask[byte] & (1 << bit)) == 0) {
btm_cb.ble_ctr_cb.irk_list_mask[byte] |= (1 << bit);
return i;
}
i++;
}
BTM_TRACE_ERROR ("%s failed, list full", __func__);
return i;
}
/*******************************************************************************
**
** Function btm_ble_update_resolving_list
**
** Description update resolving list entry in host maintained record
**
** Returns void
**
*******************************************************************************/
void btm_ble_update_resolving_list(BD_ADDR pseudo_bda, BOOLEAN add)
{
tBTM_SEC_DEV_REC *p_dev_rec = btm_find_dev(pseudo_bda);
if (p_dev_rec == NULL) {
return;
}
if (add) {
p_dev_rec->ble.in_controller_list |= BTM_RESOLVING_LIST_BIT;
if (!controller_get_interface()->supports_ble_privacy()) {
p_dev_rec->ble.resolving_list_index = btm_ble_find_irk_index();
}
} else {
p_dev_rec->ble.in_controller_list &= ~BTM_RESOLVING_LIST_BIT;
if (!controller_get_interface()->supports_ble_privacy()) {
/* clear IRK list index mask */
btm_ble_clear_irk_index(p_dev_rec->ble.resolving_list_index);
p_dev_rec->ble.resolving_list_index = 0;
}
}
}
/*******************************************************************************
**
** Function btm_ble_clear_resolving_list_complete
**
** Description This function is called when command complete for
** clear resolving list
**
** Returns void
**
*******************************************************************************/
void btm_ble_clear_resolving_list_complete(UINT8 *p, UINT16 evt_len)
{
UINT8 status = 0;
STREAM_TO_UINT8(status, p);
BTM_TRACE_DEBUG("%s status=%d", __func__, status);
if (status == HCI_SUCCESS) {
if (evt_len >= 3) {
/* VSC complete has one extra byte for op code and list size, skip it here */
p ++;
/* updated the available list size, and current list size */
uint8_t irk_list_sz_max = 0;
STREAM_TO_UINT8(irk_list_sz_max, p);
if (controller_get_interface()->get_ble_resolving_list_max_size() == 0) {
btm_ble_resolving_list_init(irk_list_sz_max);
}
uint8_t irk_mask_size = (irk_list_sz_max % 8) ?
(irk_list_sz_max / 8 + 1) : (irk_list_sz_max / 8);
memset(btm_cb.ble_ctr_cb.irk_list_mask, 0, irk_mask_size);
}
btm_cb.ble_ctr_cb.resolving_list_avail_size =
controller_get_interface()->get_ble_resolving_list_max_size();
BTM_TRACE_DEBUG("%s resolving_list_avail_size=%d",
__func__, btm_cb.ble_ctr_cb.resolving_list_avail_size);
list_node_t *p_node = NULL;
tBTM_SEC_DEV_REC *p_dev_rec = NULL;
for (p_node = list_begin(btm_cb.p_sec_dev_rec_list); p_node; p_node = list_next(p_node)) {
p_dev_rec = list_node(p_node);
p_dev_rec->ble.in_controller_list &= ~BTM_RESOLVING_LIST_BIT;
}
}
}
/*******************************************************************************
**
** Function btm_ble_add_resolving_list_entry_complete
**
** Description This function is called when command complete for
** add resolving list entry
**
** Returns void
**
*******************************************************************************/
void btm_ble_add_resolving_list_entry_complete(UINT8 *p, UINT16 evt_len)
{
UINT8 status;
STREAM_TO_UINT8(status, p);
if (btm_cb.devcb.p_add_dev_to_resolving_list_cmpl_cb) {
tBTM_ADD_DEV_TO_RESOLVING_LIST_CMPL_CBACK *p_cb = btm_cb.devcb.p_add_dev_to_resolving_list_cmpl_cb;
if (p_cb) {
(*p_cb)(status);
}
} else {
BTM_TRACE_DEBUG("no resolving list callback");
}
BTM_TRACE_DEBUG("%s status = %d", __func__, status);
BD_ADDR pseudo_bda;
if (!btm_ble_deq_resolving_pending(pseudo_bda)) {
BTM_TRACE_DEBUG("no pending resolving list operation");
return;
}
if (status == HCI_SUCCESS) {
/* privacy 1.2 command complete does not have these extra byte */
if (evt_len > 2) {
/* VSC complete has one extra byte for op code, skip it here */
p ++;
STREAM_TO_UINT8(btm_cb.ble_ctr_cb.resolving_list_avail_size, p);
} else {
btm_cb.ble_ctr_cb.resolving_list_avail_size --;
}
} else if (status == HCI_ERR_MEMORY_FULL) { /* BT_ERROR_CODE_MEMORY_CAPACITY_EXCEEDED */
btm_cb.ble_ctr_cb.resolving_list_avail_size = 0;
BTM_TRACE_ERROR("%s Resolving list Full ", __func__);
} else {
BTM_TRACE_ERROR("%s Add resolving list error %d ", __func__, status);
}
}
/*******************************************************************************
**
** Function btm_ble_remove_resolving_list_entry_complete
**
** Description This function is called when command complete for
** remove resolving list entry
**
** Returns void
**
*******************************************************************************/
void btm_ble_remove_resolving_list_entry_complete(UINT8 *p, UINT16 evt_len)
{
BD_ADDR pseudo_bda;
UINT8 status;
STREAM_TO_UINT8(status, p);
BTM_TRACE_DEBUG("%s status = %d", __func__, status);
if (!btm_ble_deq_resolving_pending(pseudo_bda)) {
BTM_TRACE_DEBUG("%s no pending resolving list operation", __func__);
return;
}
if (status == HCI_SUCCESS) {
/* proprietary: spec does not have these extra bytes */
if (evt_len > 2) {
p ++; /* skip opcode */
STREAM_TO_UINT8(btm_cb.ble_ctr_cb.resolving_list_avail_size, p);
} else {
btm_cb.ble_ctr_cb.resolving_list_avail_size++;
}
} else {
BTM_TRACE_ERROR("%s remove resolving list error 0x%x", __func__, status);
}
}
/*******************************************************************************
**
** Function btm_ble_read_resolving_list_entry_complete
**
** Description This function is called when command complete for
** remove resolving list entry
**
** Returns void
**
*******************************************************************************/
void btm_ble_read_resolving_list_entry_complete(UINT8 *p, UINT16 evt_len)
{
UINT8 status, rra_type = BTM_BLE_ADDR_PSEUDO;
BD_ADDR rra, pseudo_bda;
STREAM_TO_UINT8 (status, p);
BTM_TRACE_DEBUG("%s status = %d", __func__, status);
if (!btm_ble_deq_resolving_pending(pseudo_bda)) {
BTM_TRACE_ERROR("no pending resolving list operation");
return;
}
if (status == HCI_SUCCESS) {
/* proprietary spec has extra bytes */
if (evt_len > 8) {
p += (2 + 16 + 1 + 6); /* skip subcode, index, IRK value, address type, identity addr type */
STREAM_TO_BDADDR(rra, p);
BTM_TRACE_ERROR("%s peer_addr: %02x:%02x:%02x:%02x:%02x:%02x",
__func__, rra[0], rra[1], rra[2], rra[3], rra[4], rra[5]);
} else {
STREAM_TO_BDADDR(rra, p);
}
btm_ble_refresh_peer_resolvable_private_addr(pseudo_bda, rra, rra_type);
}
}
/*******************************************************************************
**
** Function btm_ble_set_addr_resolution_enable_complete
**
** Description This function is called when the command to set address
** resolution enable completes.
**
** Parameters p: Pointer to the command complete event data.
** evt_len: Length of the event data.
**
** Returns void
**
*******************************************************************************/
void btm_ble_set_addr_resolution_enable_complete(UINT8 *p, UINT16 evt_len)
{
UINT8 status;
STREAM_TO_UINT8(status, p);
BTM_TRACE_DEBUG("%s status = %d", __func__, status);
tBTM_LE_RANDOM_CB *random_cb = &btm_cb.ble_ctr_cb.addr_mgnt_cb;
if (!(random_cb && random_cb->set_local_privacy_cback)) {
return;
}
if (status == HCI_SUCCESS) {
random_cb->set_local_privacy_cback(BTM_SUCCESS);
return;
} else if (status == HCI_ERR_COMMAND_DISALLOWED) {
BTM_TRACE_ERROR("a non-connected activity is ongoing, such as advertising and scanning");
} else {
BTM_TRACE_ERROR("set local privacy failed");
}
random_cb->set_local_privacy_cback(BTM_ILLEGAL_VALUE);
}
/*******************************************************************************
**
** Function btm_ble_set_rpa_timeout_complete
**
** Description This function is called when the LE Set Resolvable Private
** Address Timeout command completes.
**
** Parameters p: Pointer to the command complete event data.
** evt_len: Length of the event data.
**
** Returns void
**
*******************************************************************************/
void btm_ble_set_rpa_timeout_complete(UINT8 *p, UINT16 evt_len)
{
UINT8 status;
// Extract the status of the command completion from the event data
STREAM_TO_UINT8(status, p);
BTM_TRACE_DEBUG("%s status = %d", __func__, status);
tBTM_SET_RPA_TIMEOUT_CMPL_CBACK *p_cb = btm_cb.devcb.p_ble_set_rpa_timeout_cmpl_cb;
if (p_cb) {
(*p_cb)(status);
}
}
/*******************************************************************************
**
** Function btm_ble_set_privacy_mode_complete
**
** Description This function is called when the LE Set Privacy Mode command completes.
**
** Parameters p: Pointer to the command complete event data.
** evt_len: Length of the event data.
**
** Returns void
**
*******************************************************************************/
void btm_ble_set_privacy_mode_complete(UINT8 *p, UINT16 evt_len)
{
UINT8 status;
// Extract the status of the command completion from the event data
STREAM_TO_UINT8(status, p);
BTM_TRACE_DEBUG("%s status = 0x%x", __func__, status);
tBTM_SET_PRIVACY_MODE_CMPL_CBACK *p_cb = btm_cb.devcb.p_set_privacy_mode_cmpl_cb;
if (p_cb) {
(*p_cb)(status);
}
}
/*******************************************************************************
VSC that implement controller based privacy
********************************************************************************/
/*******************************************************************************
**
** Function btm_ble_resolving_list_vsc_op_cmpl
**
** Description IRK operation VSC complete handler
**
** Parameters
**
** Returns void
**
*******************************************************************************/
void btm_ble_resolving_list_vsc_op_cmpl (tBTM_VSC_CMPL *p_params)
{
UINT8 *p = p_params->p_param_buf, op_subcode;
UINT16 evt_len = p_params->param_len;
op_subcode = *(p + 1);
BTM_TRACE_DEBUG("%s op_subcode = %d", __func__, op_subcode);
if (op_subcode == BTM_BLE_META_CLEAR_IRK_LIST) {
btm_ble_clear_resolving_list_complete(p, evt_len);
} else if (op_subcode == BTM_BLE_META_ADD_IRK_ENTRY) {
btm_ble_add_resolving_list_entry_complete(p, evt_len);
} else if (op_subcode == BTM_BLE_META_REMOVE_IRK_ENTRY) {
btm_ble_remove_resolving_list_entry_complete(p, evt_len);
} else if (op_subcode == BTM_BLE_META_READ_IRK_ENTRY) {
btm_ble_read_resolving_list_entry_complete(p, evt_len);
} else if (op_subcode == BTM_BLE_META_IRK_ENABLE) {
/* RPA offloading enable/disabled */
}
}
/*******************************************************************************
**
** Function btm_ble_remove_resolving_list_entry
**
** Description This function to remove an IRK entry from the list
**
** Parameters ble_addr_type: address type
** ble_addr: LE address
**
** Returns status
**
*******************************************************************************/
tBTM_STATUS btm_ble_remove_resolving_list_entry(tBTM_SEC_DEV_REC *p_dev_rec)
{
/* if controller does not support RPA offloading or privacy 1.2, skip */
if (controller_get_interface()->get_ble_resolving_list_max_size() == 0) {
return BTM_WRONG_MODE;
}
tBTM_STATUS st = BTM_NO_RESOURCES;
if (controller_get_interface()->supports_ble_privacy()) {
#if CONTROLLER_RPA_LIST_ENABLE
if (btsnd_hcic_ble_rm_device_resolving_list(p_dev_rec->ble.static_addr_type,
p_dev_rec->ble.static_addr)) {
st = BTM_CMD_STARTED;
}
#else
// do nothing
/* It will cause that scanner doesn't send scan request to advertiser
* which has sent IRK to us and we have stored the IRK in controller.
* It is a hardware limitation. The preliminary solution is not to
* send key to the controller, but to resolve the random address in host. */
#endif
} else {
UINT8 param[20] = {0};
UINT8 *p = param;
UINT8_TO_STREAM(p, BTM_BLE_META_REMOVE_IRK_ENTRY);
UINT8_TO_STREAM(p, p_dev_rec->ble.static_addr_type);
BDADDR_TO_STREAM(p, p_dev_rec->ble.static_addr);
st = BTM_VendorSpecificCommand(HCI_VENDOR_BLE_RPA_VSC,
BTM_BLE_META_REMOVE_IRK_LEN,
param,
btm_ble_resolving_list_vsc_op_cmpl);
}
if (st == BTM_CMD_STARTED) {
btm_ble_enq_resolving_list_pending( p_dev_rec->bd_addr, BTM_BLE_META_REMOVE_IRK_ENTRY);
}
return st;
}
/*******************************************************************************
**
** Function btm_ble_clear_resolving_list
**
** Description This function clears the resolving list
**
** Parameters None.
**
** Returns status
**
*******************************************************************************/
tBTM_STATUS btm_ble_clear_resolving_list(void)
{
tBTM_STATUS st = BTM_NO_RESOURCES;
if (controller_get_interface()->supports_ble_privacy()) {
if (btsnd_hcic_ble_clear_resolving_list()) {
st = BTM_SUCCESS;
}
} else {
UINT8 param[20] = {0};
UINT8 *p = param;
UINT8_TO_STREAM(p, BTM_BLE_META_CLEAR_IRK_LIST);
st = BTM_VendorSpecificCommand (HCI_VENDOR_BLE_RPA_VSC,
BTM_BLE_META_CLEAR_IRK_LEN,
param,
btm_ble_resolving_list_vsc_op_cmpl);
}
return st;
}
/*******************************************************************************
**
** Function btm_ble_read_resolving_list_entry
**
** Description This function read an IRK entry by index
**
** Parameters entry index.
**
** Returns status
**
*******************************************************************************/
tBTM_STATUS btm_ble_read_resolving_list_entry(tBTM_SEC_DEV_REC *p_dev_rec)
{
tBTM_STATUS st = BTM_NO_RESOURCES;
if (!(p_dev_rec->ble.in_controller_list & BTM_RESOLVING_LIST_BIT)) {
return BTM_WRONG_MODE;
}
if (controller_get_interface()->supports_ble_privacy()) {
if (btsnd_hcic_ble_read_resolvable_addr_peer(p_dev_rec->ble.static_addr_type,
p_dev_rec->ble.static_addr)) {
st = BTM_CMD_STARTED;
}
} else {
UINT8 param[20] = {0};
UINT8 *p = param;
UINT8_TO_STREAM(p, BTM_BLE_META_READ_IRK_ENTRY);
UINT8_TO_STREAM(p, p_dev_rec->ble.resolving_list_index);
st = BTM_VendorSpecificCommand (HCI_VENDOR_BLE_RPA_VSC,
BTM_BLE_META_READ_IRK_LEN,
param,
btm_ble_resolving_list_vsc_op_cmpl);
}
if (st == BTM_CMD_STARTED) {
btm_ble_enq_resolving_list_pending(p_dev_rec->bd_addr,
BTM_BLE_META_READ_IRK_ENTRY);
}
return st;
}
/*******************************************************************************
**
** Function btm_ble_suspend_resolving_list_activity
**
** Description This function suspends all resolving list activity, including
** scan, initiating, and advertising, if resolving list is being
** enabled.
**
** Parameters
**
** Returns TRUE if suspended; FALSE otherwise
**
*******************************************************************************/
BOOLEAN btm_ble_suspend_resolving_list_activity(void)
{
tBTM_BLE_CB *p_ble_cb = &btm_cb.ble_ctr_cb;
/* if resolving list is not enabled, do not need to terminate any activity */
/* if asking for stop all activity */
/* if already suspended */
if (p_ble_cb->suspended_rl_state != BTM_BLE_RL_IDLE) {
return TRUE;
}
/* direct connection active, wait until it completed */
if (btm_ble_get_conn_st() == BLE_DIR_CONN) {
BTM_TRACE_ERROR("resolving list can not be edited, EnQ now");
return FALSE;
}
p_ble_cb->suspended_rl_state = BTM_BLE_RL_IDLE;
if (p_ble_cb->inq_var.adv_mode == BTM_BLE_ADV_ENABLE) {
btm_ble_stop_adv();
p_ble_cb->suspended_rl_state |= BTM_BLE_RL_ADV;
}
if (BTM_BLE_IS_SCAN_ACTIVE(p_ble_cb->scan_activity)) {
btm_ble_stop_scan();
p_ble_cb->suspended_rl_state |= BTM_BLE_RL_SCAN;
}
if (btm_ble_suspend_bg_conn()) {
p_ble_cb->suspended_rl_state |= BTM_BLE_RL_INIT;
}
return TRUE;
}
/*******************************************************************************
**
** Function btm_ble_resume_resolving_list_activity
**
** Description This function resumes the resolving list activity, including
** scanning, initiating, and advertising, if any of these
** activities has been suspended earlier.
**
** Returns none
**
*******************************************************************************/
void btm_ble_resume_resolving_list_activity(void)
{
tBTM_BLE_CB *p_ble_cb = &btm_cb.ble_ctr_cb;
if (p_ble_cb->suspended_rl_state & BTM_BLE_RL_ADV) {
btm_ble_start_adv();
}
if (p_ble_cb->suspended_rl_state & BTM_BLE_RL_SCAN) {
btm_ble_start_scan();
}
if (p_ble_cb->suspended_rl_state & BTM_BLE_RL_INIT) {
btm_ble_resume_bg_conn();
}
p_ble_cb->suspended_rl_state = BTM_BLE_RL_IDLE;
}
/*******************************************************************************
**
** Function btm_ble_vendor_enable_irk_feature
**
** Description This function is called to enable or disable the RRA
** offloading feature.
**
** Parameters enable: enable or disable the RRA offloading feature
**
** Returns BTM_SUCCESS if successful
**
*******************************************************************************/
tBTM_STATUS btm_ble_vendor_enable_irk_feature(BOOLEAN enable)
{
UINT8 param[20], *p;
tBTM_STATUS st = BTM_MODE_UNSUPPORTED;
p = param;
memset(param, 0, 20);
/* select feature based on control block settings */
UINT8_TO_STREAM(p, BTM_BLE_META_IRK_ENABLE);
UINT8_TO_STREAM(p, enable ? 0x01 : 0x00);
st = BTM_VendorSpecificCommand (HCI_VENDOR_BLE_RPA_VSC, BTM_BLE_IRK_ENABLE_LEN,
param, btm_ble_resolving_list_vsc_op_cmpl);
return st;
}
/*******************************************************************************
**
** Function btm_ble_exe_disable_resolving_list
**
** Description execute resolving list disable
**
** Returns none
**
*******************************************************************************/
BOOLEAN btm_ble_exe_disable_resolving_list(void)
{
if (!btm_ble_suspend_resolving_list_activity()) {
return FALSE;
}
if (!controller_get_interface()->supports_ble_privacy()) {
btm_ble_vendor_enable_irk_feature(FALSE);
} else {
//btsnd_hcic_ble_set_addr_resolution_enable(FALSE);
}
return TRUE;
}
/*******************************************************************************
**
** Function btm_ble_exe_enable_resolving_list
**
** Description enable LE resolve address list
**
** Returns none
**
*******************************************************************************/
void btm_ble_exe_enable_resolving_list(void)
{
if (!btm_ble_suspend_resolving_list_activity()) {
return;
}
if (!controller_get_interface()->supports_ble_privacy()) {
btm_ble_vendor_enable_irk_feature(TRUE);
} else {
//btsnd_hcic_ble_set_addr_resolution_enable(TRUE);
}
}
/*******************************************************************************
**
** Function btm_ble_disable_resolving_list
**
** Description Disable LE Address resolution
**
** Returns none
**
*******************************************************************************/
BOOLEAN btm_ble_disable_resolving_list(UINT8 rl_mask, BOOLEAN to_resume )
{
UINT8 rl_state = btm_cb.ble_ctr_cb.rl_state;
/* if controller does not support RPA offloading or privacy 1.2, skip */
if (controller_get_interface()->get_ble_resolving_list_max_size() == 0) {
return FALSE;
}
btm_cb.ble_ctr_cb.rl_state &= ~rl_mask;
if (rl_state != BTM_BLE_RL_IDLE && btm_cb.ble_ctr_cb.rl_state == BTM_BLE_RL_IDLE) {
if (btm_ble_exe_disable_resolving_list()) {
if (to_resume) {
btm_ble_resume_resolving_list_activity();
}
return TRUE;
} else {
return FALSE;
}
}
return TRUE;
}
/*******************************************************************************
**
** Function btm_ble_resolving_list_load_dev
**
** Description This function add a device which is using RPA into white list
**
** Parameters pointer to device security record
**
** Returns TRUE if device added, otherwise falase.
**
*******************************************************************************/
BOOLEAN btm_ble_resolving_list_load_dev(tBTM_SEC_DEV_REC *p_dev_rec)
{
BOOLEAN rt = FALSE;
#if (SMP_INCLUDED == TRUE)
UINT8 rl_mask = btm_cb.ble_ctr_cb.rl_state;
BTM_TRACE_DEBUG("%s btm_cb.ble_ctr_cb.privacy_mode = %d\n", __func__,
btm_cb.ble_ctr_cb.privacy_mode);
/* if controller does not support RPA offloading or privacy 1.2, skip */
if (controller_get_interface()->get_ble_resolving_list_max_size() == 0) {
return FALSE;
}
BTM_TRACE_DEBUG("%s btm_cb.ble_ctr_cb.privacy_mode = %d\n",
__func__, btm_cb.ble_ctr_cb.privacy_mode);
/* only add RPA enabled device into resolving list */
if (p_dev_rec != NULL && /* RPA is being used and PID is known */
(p_dev_rec->sec_flags & BTM_SEC_IN_USE) != 0 &&
((p_dev_rec->ble.key_type & BTM_LE_KEY_PID) != 0 ||
(p_dev_rec->ble.key_type & BTM_LE_KEY_LID) != 0)) {
if (!(p_dev_rec->ble.in_controller_list & BTM_RESOLVING_LIST_BIT) &&
btm_ble_brcm_find_resolving_pending_entry(p_dev_rec->bd_addr,
BTM_BLE_META_ADD_IRK_ENTRY) == FALSE) {
if (btm_cb.ble_ctr_cb.resolving_list_avail_size > 0) {
if (rl_mask) {
if (!btm_ble_disable_resolving_list (rl_mask, FALSE)) {
return FALSE;
}
}
btm_ble_update_resolving_list(p_dev_rec->bd_addr, TRUE);
if (controller_get_interface()->supports_ble_privacy()) {
BD_ADDR dummy_bda = {0};
if (memcmp(p_dev_rec->ble.static_addr, dummy_bda, BD_ADDR_LEN) == 0) {
memcpy(p_dev_rec->ble.static_addr, p_dev_rec->bd_addr, BD_ADDR_LEN);
p_dev_rec->ble.static_addr_type = p_dev_rec->ble.ble_addr_type;
}
#if CONTROLLER_RPA_LIST_ENABLE
BTM_TRACE_DEBUG("%s:adding device to controller resolving list\n", __func__);
UINT8 *peer_irk = p_dev_rec->ble.keys.irk;
UINT8 *local_irk = btm_cb.devcb.id_keys.irk;
//use identical IRK for now
rt = btsnd_hcic_ble_add_device_resolving_list(p_dev_rec->ble.static_addr_type,
p_dev_rec->ble.static_addr, peer_irk, local_irk);
#else
// do nothing
/* It will cause that scanner doesn't send scan request to advertiser
* which has sent IRK to us and we have stored the IRK in controller.
* It is a hardware limitation. The preliminary solution is not to
* send key to the controller, but to resolve the random address in host. */
#endif
} else {
UINT8 param[40] = {0};
UINT8 *p = param;
UINT8_TO_STREAM(p, BTM_BLE_META_ADD_IRK_ENTRY);
ARRAY_TO_STREAM(p, p_dev_rec->ble.keys.irk, BT_OCTET16_LEN);
UINT8_TO_STREAM(p, p_dev_rec->ble.static_addr_type);
BDADDR_TO_STREAM(p, p_dev_rec->ble.static_addr);
if (BTM_VendorSpecificCommand (HCI_VENDOR_BLE_RPA_VSC,
BTM_BLE_META_ADD_IRK_LEN,
param,
btm_ble_resolving_list_vsc_op_cmpl)
== BTM_CMD_STARTED) {
rt = TRUE;
}
}
if (rt) {
btm_ble_enq_resolving_list_pending(p_dev_rec->bd_addr,
BTM_BLE_META_ADD_IRK_ENTRY);
}
/* if resolving list has been turned on, re-enable it */
// if (rl_mask) {
// btm_ble_enable_resolving_list(rl_mask);
// } else {
// btm_ble_enable_resolving_list(BTM_BLE_RL_INIT);
// }
} else {
BTM_TRACE_WARNING("%s Resolving list full ", __func__);
}
} else {
BTM_TRACE_DEBUG("Device already in Resolving list\n");
rt = TRUE;
}
} else {
BTM_TRACE_DEBUG("Device not a RPA enabled device\n");
}
#endif ///SMP_INCLUDED == TRUE
return rt;
}
/*******************************************************************************
**
** Function btm_ble_resolving_list_remove_dev
**
** Description This function removes the device from resolving list
**
** Parameters
**
** Returns status
**
*******************************************************************************/
void btm_ble_resolving_list_remove_dev(tBTM_SEC_DEV_REC *p_dev_rec)
{
UINT8 rl_mask = btm_cb.ble_ctr_cb.rl_state;
BTM_TRACE_EVENT ("%s\n", __func__);
if (rl_mask) {
if (!btm_ble_disable_resolving_list (rl_mask, FALSE)) {
return;
}
}
if ((p_dev_rec->ble.in_controller_list & BTM_RESOLVING_LIST_BIT) &&
btm_ble_brcm_find_resolving_pending_entry(p_dev_rec->bd_addr,
BTM_BLE_META_REMOVE_IRK_ENTRY) == FALSE) {
btm_ble_update_resolving_list( p_dev_rec->bd_addr, FALSE);
btm_ble_remove_resolving_list_entry(p_dev_rec);
} else {
BTM_TRACE_DEBUG("Device not in resolving list\n");
}
/* if resolving list has been turned on, re-enable it */
// if (rl_mask) {
// btm_ble_enable_resolving_list(rl_mask);
// }
}
/*******************************************************************************
**
** Function btm_ble_enable_resolving_list
**
** Description enable LE resolve address list
**
** Returns none
**
*******************************************************************************/
void btm_ble_enable_resolving_list(UINT8 rl_mask)
{
UINT8 rl_state = btm_cb.ble_ctr_cb.rl_state;
btm_cb.ble_ctr_cb.rl_state |= rl_mask;
if (rl_state == BTM_BLE_RL_IDLE &&
btm_cb.ble_ctr_cb.rl_state != BTM_BLE_RL_IDLE &&
controller_get_interface()->get_ble_resolving_list_max_size() != 0) {
btm_ble_exe_enable_resolving_list();
btm_ble_resume_resolving_list_activity();
}
}
#if 0 //Unused
/*******************************************************************************
**
** Function btm_ble_resolving_list_empty
**
** Description check to see if resolving list is empty or not
**
** Returns TRUE: empty; FALSE non-empty
**
*******************************************************************************/
BOOLEAN btm_ble_resolving_list_empty(void)
{
return (controller_get_interface()->get_ble_resolving_list_max_size() ==
btm_cb.ble_ctr_cb.resolving_list_avail_size);
}
#endif
/*******************************************************************************
**
** Function btm_ble_enable_resolving_list_for_platform
**
** Description enable/disable resolving list feature depending on if any
** resolving list is empty and whitelist is involoved in the
** operation.
**
** Returns none
**
*******************************************************************************/
void btm_ble_enable_resolving_list_for_platform (UINT8 rl_mask)
{
/* if controller does not support, skip */
if (controller_get_interface()->get_ble_resolving_list_max_size() == 0) {
return;
}
if (btm_cb.ble_ctr_cb.wl_state == BTM_BLE_WL_IDLE) {
if (controller_get_interface()->get_ble_resolving_list_max_size() >
btm_cb.ble_ctr_cb.resolving_list_avail_size) {
btm_ble_enable_resolving_list(rl_mask);
} else {
btm_ble_disable_resolving_list(rl_mask, TRUE);
}
return;
}
tBTM_SEC_DEV_REC *p_dev = NULL;
list_node_t *p_node = NULL;
for (p_node = list_begin(btm_cb.p_sec_dev_rec_list); p_node; p_node = list_next(p_node)) {
p_dev = list_node(p_node);
if ((p_dev->ble.in_controller_list & BTM_RESOLVING_LIST_BIT) &&
(p_dev->ble.in_controller_list & BTM_WHITE_LIST_BIT)) {
btm_ble_enable_resolving_list(rl_mask);
return;
}
}
btm_ble_disable_resolving_list(rl_mask, TRUE);
}
/*******************************************************************************
**
** Function btm_ble_resolving_list_init
**
** Description Initialize resolving list in host stack
**
** Parameters Max resolving list size
**
** Returns void
**
*******************************************************************************/
void btm_ble_resolving_list_init(UINT8 max_irk_list_sz)
{
tBTM_BLE_RESOLVE_Q *p_q = &btm_cb.ble_ctr_cb.resolving_list_pend_q;
UINT8 irk_mask_size = (max_irk_list_sz % 8) ?
(max_irk_list_sz / 8 + 1) : (max_irk_list_sz / 8);
if (max_irk_list_sz > 0) {
p_q->resolve_q_random_pseudo = (BD_ADDR *)osi_malloc(sizeof(BD_ADDR) * max_irk_list_sz);
p_q->resolve_q_action = (UINT8 *)osi_malloc(max_irk_list_sz);
/* RPA offloading feature */
if (btm_cb.ble_ctr_cb.irk_list_mask == NULL) {
btm_cb.ble_ctr_cb.irk_list_mask = (UINT8 *)osi_malloc(irk_mask_size);
}
BTM_TRACE_DEBUG ("%s max_irk_list_sz = %d", __func__, max_irk_list_sz);
}
controller_get_interface()->set_ble_resolving_list_max_size(max_irk_list_sz);
btm_ble_clear_resolving_list();
btm_cb.ble_ctr_cb.resolving_list_avail_size = max_irk_list_sz;
}
/*******************************************************************************
**
** Function btm_ble_resolving_list_cleanup
**
** Description Cleanup resolving list dynamic memory
**
** Parameters
**
** Returns void
**
*******************************************************************************/
void btm_ble_resolving_list_cleanup(void)
{
tBTM_BLE_RESOLVE_Q *p_q = &btm_cb.ble_ctr_cb.resolving_list_pend_q;
if (p_q->resolve_q_random_pseudo) {
osi_free(p_q->resolve_q_random_pseudo);
p_q->resolve_q_random_pseudo = NULL;
}
if (p_q->resolve_q_action) {
osi_free(p_q->resolve_q_action);
p_q->resolve_q_action = NULL;
}
controller_get_interface()->set_ble_resolving_list_max_size(0);
if (btm_cb.ble_ctr_cb.irk_list_mask) {
osi_free(btm_cb.ble_ctr_cb.irk_list_mask);
btm_cb.ble_ctr_cb.irk_list_mask = NULL;
}
}
void btm_ble_add_default_entry_to_resolving_list(void)
{
/*
* Add local IRK entry with 00:00:00:00:00:00 address. This entry will
* be used to generate RPA for non-directed advertising if own_addr_type
* is set to rpa_pub since we use all-zero address as peer address in
* such case. Peer IRK should be left all-zero since this is not for an
* actual peer.
*/
BD_ADDR peer_addr = {0x0, 0x0, 0x0, 0x0, 0x0, 0x0};
BT_OCTET16 peer_irk = {0x0};
// Remove the existing entry in resolving list When resetting the device identity
btsnd_hcic_ble_rm_device_resolving_list(BLE_ADDR_PUBLIC, peer_addr);
btsnd_hcic_ble_add_device_resolving_list (BLE_ADDR_PUBLIC, peer_addr, peer_irk, btm_cb.devcb.id_keys.irk);
}
#endif
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.