Keil Studio Cloud
Mistake on this page?
Report an issue in GitHub or email us
bb_ble_api_whitelist.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief BLE baseband whitelist interface file.
6  *
7  * Copyright (c) 2016-2017 ARM Ltd. All Rights Reserved.
8  *
9  * Copyright (c) 2019-2020 Packetcraft, Inc.
10  *
11  * Licensed under the Apache License, Version 2.0 (the "License");
12  * you may not use this file except in compliance with the License.
13  * You may obtain a copy of the License at
14  *
15  * http://www.apache.org/licenses/LICENSE-2.0
16  *
17  * Unless required by applicable law or agreed to in writing, software
18  * distributed under the License is distributed on an "AS IS" BASIS,
19  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20  * See the License for the specific language governing permissions and
21  * limitations under the License.
22  */
23 /*************************************************************************************************/
24 
25 #ifndef BB_BLE_API_WHITELIST_H
26 #define BB_BLE_API_WHITELIST_H
27 
28 #include "wsf_types.h"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 /*! \addtogroup BB_API_BLE_WL
35  * \{ */
36 
37 /**************************************************************************************************
38  Function Declarations
39 **************************************************************************************************/
40 
41 /*************************************************************************************************/
42 /*!
43  * \brief Check if address is white listed.
44  *
45  * \param randAddr TRUE if random address, FALSE if public.
46  * \param addr Bluetooth device address.
47  *
48  * \return TRUE if white listed, FALSE otherwise.
49  */
50 /*************************************************************************************************/
51 bool_t BbBleWhiteListCheckAddr(bool_t randAddr, uint64_t addr);
52 
53 /*************************************************************************************************/
54 /*!
55  * \brief Get white list size.
56  *
57  * \return Total number of white list entries.
58  *
59  * Read the white list capacity supported by the BB.
60  */
61 /*************************************************************************************************/
62 uint8_t BbBleWhiteListGetSize(void);
63 
64 /*************************************************************************************************/
65 /*!
66  * \brief Clear all white list entries.
67  *
68  * Clear all white list entries stored in the BB.
69  *
70  * \note No resource synchronization is required to modify the white list resource as
71  * the LL modifies the white list only when advertising events are disabled.
72  */
73 /*************************************************************************************************/
74 void BbBleWhiteListClear(void);
75 
76 /*************************************************************************************************/
77 /*!
78  * \brief Add device to the white list.
79  *
80  * \param randAddr TRUE if random address, FALSE if public.
81  * \param addr Bluetooth device address.
82  *
83  * \return TRUE if successful, FALSE if list full.
84  *
85  * Adds the given address to the white list stored in the BB.
86  *
87  * \note No resource synchronization is required to modify the white list resource as
88  * the LL modifies the white list only when advertising events are disabled.
89  */
90 /*************************************************************************************************/
91 bool_t BbBleWhiteListAdd(bool_t randAddr, uint64_t addr);
92 
93 /*************************************************************************************************/
94 /*!
95  * \brief Remove device from the white list.
96  *
97  * \param randAddr TRUE if random address, FALSE if public.
98  * \param addr Bluetooth device address.
99  *
100  * \return TRUE if successful, FALSE if address not in the list.
101  *
102  * Removes the given address from the white list stored in the BB.
103  *
104  * \note No resource synchronization is required to modify the white list resource as
105  * the LL modifies the white list only when advertising events are disabled.
106  */
107 /*************************************************************************************************/
108 bool_t BbBleWhiteListRemove(bool_t randAddr, uint64_t addr);
109 
110 /*************************************************************************************************/
111 /*!
112  * \brief Add anonymous device to the white list.
113  */
114 /*************************************************************************************************/
115 void BbBleWhiteListAddAnonymous(void);
116 
117 /*************************************************************************************************/
118 /*!
119  * \brief Remove anonymous device from the white list.
120  */
121 /*************************************************************************************************/
122 void BbBleWhiteListRemoveAnonymous(void);
123 
124 /*************************************************************************************************/
125 /*!
126  * \brief Check if anonymous peer is allowed.
127  *
128  * \return TRUE if anonymous allowed, FALSE if disallowed.
129  */
130 /*************************************************************************************************/
131 bool_t BbBleWhiteListIsAnonymousAllowed(void);
132 
133 /*! \} */ /* BB_API_BLE_WL */
134 
135 #ifdef __cplusplus
136 };
137 #endif
138 
139 #endif /* BB_BLE_API_WHITELIST_H */
BbBleWhiteListGetSize
uint8_t BbBleWhiteListGetSize(void)
Get white list size.
BbBleWhiteListAddAnonymous
void BbBleWhiteListAddAnonymous(void)
Add anonymous device to the white list.
BbBleWhiteListIsAnonymousAllowed
bool_t BbBleWhiteListIsAnonymousAllowed(void)
Check if anonymous peer is allowed.
BbBleWhiteListRemoveAnonymous
void BbBleWhiteListRemoveAnonymous(void)
Remove anonymous device from the white list.
wsf_types.h
Platform-independent data types.
BbBleWhiteListCheckAddr
bool_t BbBleWhiteListCheckAddr(bool_t randAddr, uint64_t addr)
Check if address is white listed.
BbBleWhiteListAdd
bool_t BbBleWhiteListAdd(bool_t randAddr, uint64_t addr)
Add device to the white list.
BbBleWhiteListClear
void BbBleWhiteListClear(void)
Clear all white list entries.
BbBleWhiteListRemove
bool_t BbBleWhiteListRemove(bool_t randAddr, uint64_t addr)
Remove device from the white list.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.