Keil Studio Cloud
Mistake on this page?
Report an issue in GitHub or email us
bb_ble_api_periodiclist.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief BLE baseband periodiclist 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_PERIODICLIST_H
26 #define BB_BLE_API_PERIODICLIST_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 periodic listed.
44  *
45  * \param addrType Address type.
46  * \param addr Bluetooth device address.
47  * \param SID Set ID.
48  *
49  * \return TRUE if white listed, FALSE otherwise.
50  */
51 /*************************************************************************************************/
52 bool_t BbBlePeriodicListCheckAddr(uint8_t addrType, uint64_t addr, uint8_t SID);
53 
54 /*************************************************************************************************/
55 /*!
56  * \brief Get periodic list size.
57  *
58  * \return Total number of periodic list entries.
59  *
60  * Read the periodic list capacity supported by the BB.
61  */
62 /*************************************************************************************************/
63 uint8_t BbBlePeriodicListGetSize(void);
64 
65 /*************************************************************************************************/
66 /*!
67  * \brief Clear all periodic list entries.
68  *
69  * Clear all periodic list entries stored in the BB.
70  *
71  * \note No resource synchronization is required to modify the periodic list resource as
72  * the LL modifies the periodic list only when advertising events are disabled.
73  */
74 /*************************************************************************************************/
75 void BbBlePeriodicListClear(void);
76 
77 /*************************************************************************************************/
78 /*!
79  * \brief Add device to the periodic list.
80  *
81  * \param addrType Address type.
82  * \param addr Bluetooth device address.
83  * \param SID Set ID.
84  *
85  * \return TRUE if successful, FALSE if list full.
86  *
87  * Adds the given address to the periodic list stored in the BB.
88  *
89  * \note No resource synchronization is required to modify the periodic list resource as
90  * the LL modifies the periodic list only when advertising events are disabled.
91  */
92 /*************************************************************************************************/
93 bool_t BbBlePeriodicListAdd(uint8_t addrType, uint64_t addr, uint8_t SID);
94 
95 /*************************************************************************************************/
96 /*!
97  * \brief Remove device from the periodic list.
98  *
99  * \param randAddr TRUE if random address, FALSE if public.
100  * \param addr Bluetooth device address.
101  * \param SID Set ID.
102  *
103  *
104  * \return TRUE if successful, FALSE if address not in the list.
105  *
106  * Removes the given address from the periodic list stored in the BB.
107  *
108  * \note No resource synchronization is required to modify the white list resource as
109  * the LL modifies the white list only when advertising events are disabled.
110  */
111 /*************************************************************************************************/
112 bool_t BbBlePeriodicListRemove(bool_t randAddr, uint64_t addr, uint8_t SID);
113 
114 /*! \} */ /* BB_API_BLE_WL */
115 
116 #ifdef __cplusplus
117 };
118 #endif
119 
120 #endif /* BB_BLE_API_WHITELIST_H */
BbBlePeriodicListGetSize
uint8_t BbBlePeriodicListGetSize(void)
Get periodic list size.
BbBlePeriodicListAdd
bool_t BbBlePeriodicListAdd(uint8_t addrType, uint64_t addr, uint8_t SID)
Add device to the periodic list.
wsf_types.h
Platform-independent data types.
BbBlePeriodicListCheckAddr
bool_t BbBlePeriodicListCheckAddr(uint8_t addrType, uint64_t addr, uint8_t SID)
Check if address is periodic listed.
BbBlePeriodicListClear
void BbBlePeriodicListClear(void)
Clear all periodic list entries.
BbBlePeriodicListRemove
bool_t BbBlePeriodicListRemove(bool_t randAddr, uint64_t addr, uint8_t SID)
Remove device from the periodic 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.