ble_gapm.h
Go to the documentation of this file.
1 /**
2 ****************************************************************************************
3 *
4 * @file ble_gapm.h
5 *
6 * @brief BLE GAPM API
7 *
8 ****************************************************************************************
9 * @attention
10 #####Copyright (c) 2019 GOODIX
11 All rights reserved.
12
13 Redistribution and use in source and binary forms, with or without
14 modification, are permitted provided that the following conditions are met:
15 * Redistributions of source code must retain the above copyright
16 notice, this list of conditions and the following disclaimer.
17 * Redistributions in binary form must reproduce the above copyright
18 notice, this list of conditions and the following disclaimer in the
19 documentation and/or other materials provided with the distribution.
20 * Neither the name of GOODIX nor the names of its contributors may be used
21 to endorse or promote products derived from this software without
22 specific prior written permission.
23
24 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 POSSIBILITY OF SUCH DAMAGE.
35 *****************************************************************************************
36 */
37
38 /**
39 * @addtogroup BLE
40 * @{
41 * @brief Definitions and prototypes for the BLE SDK interface.
42 */
43
44 /**
45 * @addtogroup BLE_GAP Generic Access Profile (GAP)
46 * @{
47 * @brief Definitions and prototypes for the GAP interface.
48 */
49
50 #ifndef __BLE_GAPM_H__
51 #define __BLE_GAPM_H__
52
53 /*
54 * INCLUDE FILES
55 ****************************************************************************************
56 */
57 #include "ble_error.h"
58 #include "ble_gapc.h"
59 #include <stdint.h>
60 #include <stddef.h>
61
62
63 /**
64 @addtogroup BLE_GAPM Generic Access Profile (GAP) Management
65 @{
66 @brief Definitions and prototypes for the GAP Management interface.
67 */
68
69 /** @addtogroup BLE_GAPM_DEFINES Defines
70 * @{ */
71
72 #define CO_BIT(pos)(1UL<<(pos)) /**< Bit operation helper. */
73 #define BLE_GAP_MAX_ADV_NUM 5 /**< Maximal advertising instance number. */
74 #define BLE_GAP_MAX_PER_SYNC_NUM 5 /**< Maximal periodic syncronization instance number. */
75 #define BLE_GAP_MAX_WL_NUM 10 /**< Maximal white list number. */
76 #define BLE_GAP_MAX_PRD_ADV_NUM 4 /**< Maximal periodic advertising list number. */
77 #define BLE_GAP_MAX_KEY_LEN 16 /**< The key length. */
78 #define BLE_GAP_INVALID_ADV_IDX 0xFF /**< Invalid adv index. */
79 #define BLE_GAP_DEVNAME_DEFAULT "GOODIX_BLE" /**< Default device name value. */
80 #define BLE_GAP_DEVNAME_MAX_LEN 248 /**< Maximal length of device name. */
81
82 #define BLE_GAP_MAX_ANTENNA_ID_NUM 0x4B /**< Maximal number of Antenna IDs. */
83
84 #define BLE_APPEARANCE_UNKNOWN 0 /**< Unknown. */
85 #define BLE_APPEARANCE_GENERIC_PHONE 64 /**< Generic Phone. */
86 #define BLE_APPEARANCE_GENERIC_COMPUTER 128 /**< Generic Computer. */
87 #define BLE_APPEARANCE_GENERIC_WATCH 192 /**< Generic Watch. */
88 #define BLE_APPEARANCE_WATCH_SPORTS_WATCH 193 /**< Watch: Sports Watch. */
89 #define BLE_APPEARANCE_GENERIC_CLOCK 256 /**< Generic Clock. */
90 #define BLE_APPEARANCE_GENERIC_DISPLAY 320 /**< Generic Display. */
91 #define BLE_APPEARANCE_GENERIC_REMOTE_CONTROL 384 /**< Generic Remote Control. */
92 #define BLE_APPEARANCE_GENERIC_EYE_GLASSES 448 /**< Generic Eye-glasses. */
93 #define BLE_APPEARANCE_GENERIC_TAG 512 /**< Generic Tag. */
94 #define BLE_APPEARANCE_GENERIC_KEYRING 576 /**< Generic Keyring. */
95 #define BLE_APPEARANCE_GENERIC_MEDIA_PLAYER 640 /**< Generic Media Player. */
96 #define BLE_APPEARANCE_GENERIC_BARCODE_SCANNER 704 /**< Generic Barcode Scanner. */
97 #define BLE_APPEARANCE_GENERIC_THERMOMETER 768 /**< Generic Thermometer. */
98 #define BLE_APPEARANCE_THERMOMETER_EAR 769 /**< Thermometer: Ear. */
99 #define BLE_APPEARANCE_GENERIC_HEART_RATE_SENSOR 832 /**< Generic Heart Rate Sensor. */
100 #define BLE_APPEARANCE_HEART_RATE_SENSOR_HEART_RATE_BELT 833 /**< Heart Rate Sensor: Heart Rate Belt. */
101 #define BLE_APPEARANCE_GENERIC_BLOOD_PRESSURE 896 /**< Generic Blood Pressure. */
102 #define BLE_APPEARANCE_BLOOD_PRESSURE_ARM 897 /**< Blood Pressure: Arm. */
103 #define BLE_APPEARANCE_BLOOD_PRESSURE_WRIST 898 /**< Blood Pressure: Wrist. */
104 #define BLE_APPEARANCE_GENERIC_HID 960 /**< Human Interface Device (HID). */
105 #define BLE_APPEARANCE_HID_KEYBOARD 961 /**< Keyboard (HID Subtype). */
106 #define BLE_APPEARANCE_HID_MOUSE 962 /**< Mouse (HID Subtype). */
107 #define BLE_APPEARANCE_HID_JOYSTICK 963 /**< Joystick (HID Subtype). */
108 #define BLE_APPEARANCE_HID_GAMEPAD 964 /**< Gamepad (HID Subtype). */
109 #define BLE_APPEARANCE_HID_DIGITIZERSUBTYPE 965 /**< Digitizer Tablet (HID Subtype). */
110 #define BLE_APPEARANCE_HID_CARD_READER 966 /**< Card Reader (HID Subtype). */
111 #define BLE_APPEARANCE_HID_DIGITAL_PEN 967 /**< Digital Pen (HID Subtype). */
112 #define BLE_APPEARANCE_HID_BARCODE 968 /**< Barcode Scanner (HID Subtype). */
113 #define BLE_APPEARANCE_GENERIC_GLUCOSE_METER 1024 /**< Generic Glucose Meter. */
114 #define BLE_APPEARANCE_GENERIC_RUNNING_WALKING_SENSOR 1088 /**< Generic Running Walking Sensor. */
115 #define BLE_APPEARANCE_RUNNING_WALKING_SENSOR_IN_SHOE 1089 /**< Running Walking Sensor: In-Shoe. */
116 #define BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_SHOE 1090 /**< Running Walking Sensor: On-Shoe. */
117 #define BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_HIP 1091 /**< Running Walking Sensor: On-Hip. */
118 #define BLE_APPEARANCE_GENERIC_CYCLING 1152 /**< Generic Cycling. */
119 #define BLE_APPEARANCE_CYCLING_CYCLING_COMPUTER 1153 /**< Cycling: Cycling Computer. */
120 #define BLE_APPEARANCE_CYCLING_SPEED_SENSOR 1154 /**< Cycling: Speed Sensor. */
121 #define BLE_APPEARANCE_CYCLING_CADENCE_SENSOR 1155 /**< Cycling: Cadence Sensor. */
122 #define BLE_APPEARANCE_CYCLING_POWER_SENSOR 1156 /**< Cycling: Power Sensor. */
123 #define BLE_APPEARANCE_CYCLING_SPEED_CADENCE_SENSOR 1157 /**< Cycling: Speed and Cadence Sensor. */
124 #define BLE_APPEARANCE_GENERIC_PULSE_OXIMETER 3136 /**< Generic Pulse Oximeter. */
125 #define BLE_APPEARANCE_PULSE_OXIMETER_FINGERTIP 3137 /**< Fingertip (Pulse Oximeter subtype). */
126 #define BLE_APPEARANCE_PULSE_OXIMETER_WRIST_WORN 3138 /**< Wrist Worn(Pulse Oximeter subtype). */
127 #define BLE_APPEARANCE_GENERIC_WEIGHT_SCALE 3200 /**< Generic Weight Scale. */
128 #define BLE_APPEARANCE_GENERIC_OUTDOOR_SPORTS_ACT 5184 /**< Generic Outdoor Sports Activity. */
129 #define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_DISP 5185 /**< Location Display Device (Outdoor Sports Activity subtype). */
130 #define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_AND_NAV_DISP 5186 /**< Location and Navigation Display Device (Outdoor Sports Activity subtype). */
131 #define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_POD 5187 /**< Location Pod (Outdoor Sports Activity subtype). */
132 #define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_AND_NAV_POD 5188 /**< Location and Navigation Pod (Outdoor Sports Activity subtype). */
133
134 /**@defgroup BLE_GAP_PHYS GAP PHYs (bitmask)
135 * @{ */
136 #define BLE_GAP_PHY_ANY 0x00 /**< No preferred PHY. */
137 #define BLE_GAP_PHY_LE_1MBPS (1 << 0) /**< LE 1M PHY preferred for an active link. */
138 #define BLE_GAP_PHY_LE_2MBPS (1 << 1) /**< LE 2M PHY preferred for an active link. */
139 #define BLE_GAP_PHY_LE_CODED (1 << 2) /**< LE Coded PHY preferred for an active link. */
140 /**@} */
141
142
143 /**@defgroup BLE_GAP_ADV_CHANNEL GAP ADV CHANNEL (bitmask)
144 * @{ */
145 #define BLE_GAP_ADV_CHANNEL_37 0x01 /**< Advertising Channel 37 (2402MHz). */
146 #define BLE_GAP_ADV_CHANNEL_38 0x02 /**< Advertising Channel 38 (2426MHz). */
147 #define BLE_GAP_ADV_CHANNEL_39 0x04 /**< Advertising Channel 39 (2480MHz). */
148 #define BLE_GAP_ADV_CHANNEL_37_38_39 0x07 /**< Advertising Channel 37, 38, 39. */
149 /**@} */
150 /**@} */
151
152 /** @addtogroup BLE_GAPM_ENUMERATIONS Enumerations
153 * @{ */
154 /**
155 * @brief GAP role options
156 */
157 typedef enum
158 {
159 BLE_GAP_ROLE_NONE = 0x00, /**< No role set yet. */
160 BLE_GAP_ROLE_OBSERVER = 0x01, /**< Observer role. */
161 BLE_GAP_ROLE_BROADCASTER = 0x02, /**< Broadcaster role. */
162 BLE_GAP_ROLE_CENTRAL = (0x04 | BLE_GAP_ROLE_OBSERVER), /**< Master/Central role. */
163 BLE_GAP_ROLE_PERIPHERAL = (0x08 | BLE_GAP_ROLE_BROADCASTER), /**< Peripheral/Slave role. */
164 BLE_GAP_ROLE_ALL = (BLE_GAP_ROLE_CENTRAL | BLE_GAP_ROLE_PERIPHERAL), /**< Device has all roles, both peripheral and central. */
165 } ble_gap_role_t;
166
167 /**
168 * @brief Own BD address source of the device
169 */
170 typedef enum
171 {
172 BLE_GAP_OWN_ADDR_STATIC = 0, /**< Public or Private Static Address according to device address configuration. */
173 BLE_GAP_OWN_ADDR_GEN_RSLV, /**< Generated resolvable private random address. */
174 BLE_GAP_OWN_ADDR_GEN_NON_RSLV, /**< Generated non-resolvable private random address. */
175 } ble_gap_own_addr_t;
176
177 /**
178 * @brief Write permissions of the device name characteristic
179 */
180 typedef enum
181 {
182 BLE_GAP_WRITE_PERM_DISABLE = 0, /**< Disable write access. */
183 BLE_GAP_WRITE_PERM_NOAUTH, /**< LE Security Mode 1, Level 1. Link does not need to be encrypted or authenticated. */
184 BLE_GAP_WRITE_PERM_UNAUTH, /**< LE Security Mode 1, Level 2. Link needs to be encrypted, but not to be authenticated. */
185 BLE_GAP_WRITE_PERM_AUTH, /**< LE Security Mode 1, Level 3. Link needs to be encrypted and authenticated (MITM). */
186 BLE_GAP_WRITE_PERM_SEC_CON, /**< LE Security Mode 1, Level 4. Link needs to be encrypted and authenticated (secure connections). */
187 } ble_gap_dev_name_write_perm_t;
188
189 /**
190 * @brief Advertising data type
191 */
192 typedef enum
193 {
194 BLE_GAP_ADV_DATA_TYPE_DATA = 0, /**< Advertising data. */
195 BLE_GAP_ADV_DATA_TYPE_SCAN_RSP, /**< Scan response data. */
196 BLE_GAP_ADV_DATA_TYPE_PER_DATA, /**< Periodic advertising data. */
197 } ble_gap_adv_data_type_t;
198
199
200 /**@brief Get device parameters operation code. */
201 typedef enum
202 {
203 BLE_GAP_GET_DEV_VERSION = 0, /**< Get version information for the local Controller. */
204 BLE_GAP_GET_DEV_BDADDR, /**< Get local device BD Address. */
205 //BLE_GAP_GET_DEV_ADV_TX_POWER, /**< Get the transmit power level used for LE advertising channel packets. */
206 BLE_GAP_GET_SUGGESTED_DFLT_LE_DATA_LEN, /**< Get suggested values (SuggestedMaxTxOctets and SuggestedMaxTxTime)
207 for the Controller's maximum transmitted number of payload octets
208 and maximum packet transmission time to be used for new connections. */
209 BLE_GAP_GET_MAX_LE_DATA_LEN, /**< Get the Controller' maximum supported payload octets and packet duration
210 times for transmission and reception (supportedMaxTxOctets and supportedMaxTxTime,
211 supportedMaxRxOctets, and supportedMaxRxTime). */
212 BLE_GAP_GET_NB_ADV_SETS, /**< Read the maximum number of advertising sets currently supported by the controller. */
213 BLE_GAP_GET_MAX_LE_ADV_DATA_LEN, /**< Get maximum data length for advertising data. */
214 BLE_GAP_GET_DEV_TX_POWER, /**< Read the minimum and maximum transmit powers supported by the Controller. */
215 BLE_GAP_GET_DEV_RF_RF_PATH_COMP, /**< Get RF path compensation values. */
216 BLE_GAP_GET_ANTENNA_INFO, /**< Get antenna information. */
217 } ble_gap_dev_info_get_type_t;
218
219 /**@brief GAP advertising modes. */
220 typedef enum
221 {
222 BLE_GAP_ADV_TYPE_ADV_IND = 0, /**< Undirected connectable and scannable mode. */
223 BLE_GAP_ADV_TYPE_ADV_NONCONN_IND, /**< Non-connectable and non-scanable mode. */
224 BLE_GAP_ADV_TYPE_ADV_SCAN_IND, /**< Undirected scannable mode. */
225 BLE_GAP_ADV_TYPE_ADV_HIGH_DIRECT_IND, /**< Directed high duty cycle mode. */
226 BLE_GAP_ADV_TYPE_ADV_LOW_DIRECT_IND, /**< Directed low duty cycle mode. */
227 } ble_gap_adv_mode_t;
228
229 /**@brief GAP discoverability modes. */
230 typedef enum
231 {
232 BLE_GAP_DISC_MODE_NON_DISCOVERABLE = 0, /**< Non-discoverable mode. */
233 BLE_GAP_DISC_MODE_GEN_DISCOVERABLE, /**< General-discoverable mode. */
234 BLE_GAP_DISC_MODE_LIM_DISCOVERABLE, /**< Limited-discoverable mode. */
235 BLE_GAP_DISC_MODE_BROADCASTER, /**< Broadcaster mode. */
236 } ble_gap_disc_mode_t;
237
238 /**
239 * @brief Advertising filter policy
240 */
241 typedef enum
242 {
243 BLE_GAP_ADV_ALLOW_SCAN_ANY_CON_ANY = 0, /**< Allow both scan and connection requests from anyone. */
244 BLE_GAP_ADV_ALLOW_SCAN_WLST_CON_ANY, /**< Allow scan req from white-list devices only and connection req from anyone. */
245 BLE_GAP_ADV_ALLOW_SCAN_ANY_CON_WLST, /**< Allow scan req from anyone and connection req from white-list devices only. */
246 BLE_GAP_ADV_ALLOW_SCAN_WLST_CON_WLST, /**< Allow scan and connection requests from white-list devices only. */
247 } ble_gap_adv_filter_policy_t;
248
249 /**
250 * @brief Specify what PHY the Controller has changed for TX/RX. HCI:7.7.65.12
251 */
252 typedef enum
253 {
254 BLE_GAP_PHY_UNDEF_VALUE = 0, /**< Undefined LE PHY. */
255 BLE_GAP_PHY_1MBPS_VALUE = 1, /**< LE 1M PHY. */
256 BLE_GAP_PHY_2MBPS_VALUE = 2, /**< LE 2M PHY. */
257 BLE_GAP_PHY_CODED_VALUE = 3, /**< LE Coded PHY. */
258 } ble_gap_le_phy_value_t;
259
260 /**
261 * @brief Advertising type
262 */
263 typedef enum
264 {
265 BLE_GAP_ADV_TYPE_LEGACY = 0, /**< Legacy advertising. */
266 BLE_GAP_ADV_TYPE_EXTENDED, /**< Extended advertising. */
267 BLE_GAP_ADV_TYPE_PERIODIC, /**< Periodic advertising. */
268 } ble_gap_adv_type_t;
269
270 /**
271 * @brief Advertising properties bit field and bit positions
272 */
273 typedef enum
274 {
275 BLE_GAP_ADV_PROP_CONNECTABLE_POS = 0, /**< Indicate that advertising is connectable, reception of CONNECT_REQ or
276 UX_CONNECT_REQ PDUs is accepted. Not applicable for periodic advertising. */
277 BLE_GAP_ADV_PROP_SCANNABLE_POS, /**< Indicate that advertising is scannable, reception of SCAN_REQ or AUX_SCAN_REQ PDUs is accepted. */
278 BLE_GAP_ADV_PROP_DIRECTED_POS, /**< Indicate that advertising targets at a specific device. Only applicable in following cases:
279 - Legacy advertising: if connectable
280 - Extended advertising: connectable or (non-connectable and non-discoverable). */
281 BLE_GAP_ADV_PROP_HDC_POS, /**< Indicate that High Duty Cycle has to be used for advertising on primary channel,
282 applicable only if created advertising is not an extended advertising. */
283 BLE_GAP_ADV_PROP_USE_LEGACY_PDUS_POS, /**< Use legacy advertising PDUs. */
284 BLE_GAP_ADV_PROP_ANONYMOUS_POS, /**< Enable anonymous mode. Device address will not appear in sending PDUs.
285 Valid only if the created advertising is an extended advertising. */
286 BLE_GAP_ADV_PROP_TX_PWR_POS, /**< Include TX power in the extended header of the advertising PDU.
287 Valid only if the created advertising is not a legacy advertising. */
288 BLE_GAP_ADV_PROP_PER_TX_PWR_POS, /**< Include TX power in the periodic advertising PDU.
289 Valid only if the created advertising is a periodic advertising. */
290 BLE_GAP_ADV_PROP_SCAN_REQ_NTF_EN_POS, /**< Indicate if application must be informed about receiving scan request PDUs. */
291 } ble_gap_adv_prop_pos_t;
292
293 /**
294 * @brief Advertising properties bit field bit value
295 */
296 typedef enum
297 {
298 BLE_GAP_ADV_PROP_CONNECTABLE_BIT = CO_BIT(BLE_GAP_ADV_PROP_CONNECTABLE_POS),
299 BLE_GAP_ADV_PROP_SCANNABLE_BIT = CO_BIT(BLE_GAP_ADV_PROP_SCANNABLE_POS),
300 BLE_GAP_ADV_PROP_DIRECTED_BIT = CO_BIT(BLE_GAP_ADV_PROP_DIRECTED_POS),
301 BLE_GAP_ADV_PROP_HDC_BIT = CO_BIT(BLE_GAP_ADV_PROP_HDC_POS),
302 BLE_GAP_ADV_PROP_USE_LEGACY_PDUS_BIT = CO_BIT(BLE_GAP_ADV_PROP_USE_LEGACY_PDUS_POS),
303 BLE_GAP_ADV_PROP_ANONYMOUS_BIT = CO_BIT(BLE_GAP_ADV_PROP_ANONYMOUS_POS),
304 BLE_GAP_ADV_PROP_TX_PWR_BIT = CO_BIT(BLE_GAP_ADV_PROP_TX_PWR_POS),
305 BLE_GAP_ADV_PROP_PER_TX_PWR_BIT = CO_BIT(BLE_GAP_ADV_PROP_PER_TX_PWR_POS),
306 BLE_GAP_ADV_PROP_SCAN_REQ_NTF_EN_BIT = CO_BIT(BLE_GAP_ADV_PROP_SCAN_REQ_NTF_EN_POS),
307 } ble_gap_adv_prop_t;
308
309 /**
310 * @brief Scanning types
311 */
312 typedef enum
313 {
314 BLE_GAP_SCAN_ACTIVE = 0, /**< Active scan type. */
315 BLE_GAP_SCAN_PASSIVE, /**< Passive scan type. */
316 } ble_gap_scan_type_t;
317
318 /**
319 * @brief Scanning modes
320 */
321 typedef enum
322 {
323 BLE_GAP_SCAN_GEN_DISC_MODE = 0, /**< General discoverable mode. */
324 BLE_GAP_SCAN_LIM_DISC_MODE, /**< Limited discoverable mode. */
325 BLE_GAP_SCAN_OBSERVER_MODE, /**< Observer mode. */
326 } ble_gap_scan_mode_t;
327
328 /**
329 * @brief Duplicate filter policy
330 */
331 typedef enum
332 {
333 BLE_GAP_SCAN_FILT_DUPLIC_DIS = 0, /**< Disable filtering of duplicate packets. */
334 BLE_GAP_SCAN_FILT_DUPLIC_EN, /**< Enable filtering of duplicate packets. */
335 } ble_gap_scan_dup_filt_policy_t;
336
337 /**
338 * @brief Extended scanning types
339 */
340 typedef enum
341 {
342 BLE_GAP_EXT_SCAN_TYPE_GEN_DISC = 0, /**< General discovery. */
343 BLE_GAP_EXT_SCAN_TYPE_LIM_DISC, /**< Limited discovery. */
344 BLE_GAP_EXT_SCAN_TYPE_OBSERVER, /**< Observer. */
345 BLE_GAP_EXT_SCAN_TYPE_SEL_OBSERVER, /**< Selective observer. */
346 BLE_GAP_EXT_SCAN_TYPE_CONN_DISC, /**< Connectable discovery. */
347 BLE_GAP_EXT_SCAN_TYPE_SEL_CONN_DISC, /**< Selective connectable discovery. */
348 } ble_gap_ext_scan_type_t;
349
350 /**
351 * @brief Filtering policy for duplicated packets
352 */
353 typedef enum
354 {
355 BLE_GAP_EXT_DUP_FILT_DIS = 0, /**< Disable filtering of duplicated packets. */
356 BLE_GAP_EXT_DUP_FILT_EN, /**< Enable filtering of duplicated packets. */
357 BLE_GAP_EXT_DUP_FILT_EN_PERIOD, /**< Enable filtering of duplicated packets, reset for each scan period. */
358 } ble_gap_ext_scan_dup_filt_policy_t;
359
360 /**
361 * @brief Initiating types
362 */
363 typedef enum
364 {
365 BLE_GAP_INIT_TYPE_DIRECT_CONN_EST = 0, /**< Direct connection establishment: establish a connection with an indicated device. */
366 BLE_GAP_INIT_TYPE_AUTO_CONN_EST, /**< Automatic connection establishment: establish a connection with all devices whose address is present in the white list. */
367 BLE_GAP_INIT_TYPE_NAME_DISC, /**< Name discovery: establish a connection with an indicated device in order to read content of its device name characteristic. Connection is closed once this operation is stopped. */
368 } ble_gap_init_type_t;
369
370 /**
371 * @brief Initiating properties
372 */
373 typedef enum
374 {
375 BLE_GAP_INIT_PROP_1M_BIT = (1 << 0), /**< Scan connectable advertisements on the LE 1M PHY. Connection parameters for the LE 1M PHY are provided. */
376 BLE_GAP_INIT_PROP_2M_BIT = (1 << 1), /**< Connection parameters for the LE 2M PHY are provided. */
377 BLE_GAP_INIT_PROP_CODED_BIT = (1 << 2), /**< Scan connectable advertisements on the LE Coded PHY. Connection parameters for the LE Coded PHY are provided. */
378 } ble_gap_init_prop_t;
379
380 /**
381 * @brief Scanning properties bit field bit value
382 */
383 typedef enum
384 {
385 BLE_GAP_SCAN_PROP_PHY_1M_BIT = (1 << 0), /**< Scan advertisement on the LE 1M PHY. */
386 BLE_GAP_SCAN_PROP_PHY_CODED_BIT = (1 << 1), /**< Scan advertisement on the LE Coded PHY. */
387 BLE_GAP_SCAN_PROP_ACTIVE_1M_BIT = (1 << 2), /**< Active scan on LE 1M PHY (scan request PDUs may be sent). */
388 BLE_GAP_SCAN_PROP_ACTIVE_CODED_BIT = (1 << 3), /**< Active scan on LE Coded PHY (scan request PDUs may be sent). */
389 BLE_GAP_SCAN_PROP_ACCEPT_RPA_BIT = (1 << 4), /**< Accept directed advertising packets if the used RPA and target address cannot be solved by the controller. */
390 BLE_GAP_SCAN_PROP_FILT_TRUNC_BIT = (1 << 5), /**< Filter truncated advertising or scan response reports. */
391 } ble_gap_scan_prop_t;
392
393 /**
394 * @brief Periodic synchronization types
395 */
396 typedef enum
397 {
398 BLE_GAP_PER_SYNC_TYPE_GENERAL = 0, /**< Do not use periodic advertiser list for synchronization. */
399 BLE_GAP_PER_SYNC_TYPE_SELECTIVE, /**< Use periodic advertiser list for synchronization. */
400 BLE_GAP_PER_SYNC_TYPE_PAST, /**< Use Periodic advertising sync transfer information send through connection for synchronization. */
401 } ble_gap_per_sync_type_t;
402
403 /**
404 * @brief Constant Tone Extension sync filtering type
405 */
406 enum gap_sync_cte_type
407 {
408 BLE_GAP_NO_SYNC_IGNORE = 0, /**< The presence or absence of a Constant Tone Extension is irrelevant. */
409 BLE_GAP_NO_SYNC_WITH_AOA = (1 << 0), /**< Do not sync to packets with an AoA Constant Tone Extension. */
410 BLE_GAP_NO_SYNC_WITH_AOD_1US_SLOT = (1 << 1), /**< Do not sync to packets with an AoD Constant Tone Extension with 1us slots. */
411 BLE_GAP_NO_SYNC_WITH_AOD_2US_SLOT = (1 << 2), /**< Do not sync to packets with an AoD Constant Tone Extension with 2us slots. */
412 BLE_GAP_NO_SYNC_WITHOUT_CTE = (1 << 4), /**< Do not sync to packets without a Constant Tone Extension. */
413 };
414
415 /**
416 * @brief Periodic advertising sync information reception mode
417 */
418 enum gap_per_adv_sync_info_rec_mode
419 {
420 BLE_GAP_SYNC_REP_DIS = 0x01, /**< synchronize to the periodic advertising, per adv report events will be disabled. */
421 BLE_GAP_SYNC_REP_EN = 0x02, /**< synchronize to the periodic advertising, per adv report events will be enabled, duplicate filtering disabled. */
422 BLE_GAP_SYNC_REP_EN_DUP = 0x03, /**< synchronize to the periodic advertising, per adv report events will be enabled, duplicate filtering enabled. */
423 };
424
425 /**
426 * @brief Supported AoA AoD switching sampling rate
427 */
428 enum gap_switch_sampling_rate
429 {
430 BLE_GAP_AOD_TX_1_US = (1 << 0), /**< 1 us switching supported for AoD transmission. */
431 BLE_GAP_AOD_RX_1_US = (1 << 1), /**< 1 us switching supported for AoD reception. */
432 BLE_GAP_AOA_RX_1_US = (1 << 2), /**< 1 us switching and sampling supported for AoA reception. */
433 };
434
435 /**
436 * @brief Slot duration type for IQ sampling
437 */
438 enum gap_slot_dur_type
439 {
440 BLE_GAP_SLOT_DURA_1US = 0x01, /**< Switching and sampling slots are 1 us each. */
441 BLE_GAP_SLOT_DURA_2US = 0x02, /**< Switching and sampling slots are 2 us each. */
442 };
443
444 /**
445 * @brief Security level types
446 */
447 enum gap_sec_lvl_type
448 {
449 BLE_GAP_SEC_LVL_NO_SECURITY = 0, /**< No encryption or auth. */
450 BLE_GAP_SEC_LVL_ENC_NO_AUTH, /**< Encryption with no auth. */
451 BLE_GAP_SEC_LVL_LE_ENC_AUTH, /**< Legacy encryption with auth. */
452 BLE_GAP_SEC_LVL_SC_ENC_AUTH, /**< Security connection encryption with auth. */
453 };
454
455 /**
456 * @brief GAP advertising types
457 */
458 typedef enum
459 {
460 BLE_GAP_AD_TYPE_FLAGS = 0x01, /**< Flag. */
461 BLE_GAP_AD_TYPE_MORE_16_BIT_UUID = 0x02, /**< Use of more than 16-bit UUID. */
462 BLE_GAP_AD_TYPE_COMPLETE_LIST_16_BIT_UUID = 0x03, /**< Complete List of 16-bit UUID. */
463 BLE_GAP_AD_TYPE_MORE_32_BIT_UUID = 0x04, /**< Use of more than 32-bit UUD. */
464 BLE_GAP_AD_TYPE_COMPLETE_LIST_32_BIT_UUID = 0x05, /**< Complete List of 32-bit UUID. */
465 BLE_GAP_AD_TYPE_MORE_128_BIT_UUID = 0x06, /**< Use of more than 128-bit UUID. */
466 BLE_GAP_AD_TYPE_COMPLETE_LIST_128_BIT_UUID = 0x07, /**< Complete List of 128-bit UUID. */
467 BLE_GAP_AD_TYPE_SHORTENED_NAME = 0x08, /**< Shortened Device name. */
468 BLE_GAP_AD_TYPE_COMPLETE_NAME = 0x09, /**< Complete Device name. */
469 BLE_GAP_AD_TYPE_TRANSMIT_POWER = 0x0A, /**< Transmit power. */
470 BLE_GAP_AD_TYPE_CLASS_OF_DEVICE = 0x0D, /**< Class of device. */
471 BLE_GAP_AD_TYPE_SP_HASH_C = 0x0E, /**< Simple Pairing Hash C. */
472 BLE_GAP_AD_TYPE_SP_RANDOMIZER_R = 0x0F, /**< Simple Pairing Randomizer. */
473 BLE_GAP_AD_TYPE_TK_VALUE = 0x10, /**< Temporary key value. */
474 BLE_GAP_AD_TYPE_OOB_FLAGS = 0x11, /**< Out of Band Flag. */
475 BLE_GAP_AD_TYPE_SLAVE_CONN_INT_RANGE = 0x12, /**< Slave connection interval range. */
476 BLE_GAP_AD_TYPE_RQRD_16_BIT_SVC_UUID = 0x14, /**< Require 16-bit service UUID. */
477 BLE_GAP_AD_TYPE_RQRD_32_BIT_SVC_UUID = 0x1F, /**< Require 32-bit service UUID. */
478 BLE_GAP_AD_TYPE_RQRD_128_BIT_SVC_UUID = 0x15, /**< Require 128-bit service UUID. */
479 BLE_GAP_AD_TYPE_SERVICE_16_BIT_DATA = 0x16, /**< Service data 16-bit UUID. */
480 BLE_GAP_AD_TYPE_SERVICE_32_BIT_DATA = 0x20, /**< Service data 32-bit UUID. */
481 BLE_GAP_AD_TYPE_SERVICE_128_BIT_DATA = 0x21, /**< Service data 128-bit UUID. */
482 BLE_GAP_AD_TYPE_PUB_TGT_ADDR = 0x17, /**< Public Target Address. */
483 BLE_GAP_AD_TYPE_RAND_TGT_ADDR = 0x18, /**< Random Target Address. */
484 BLE_GAP_AD_TYPE_APPEARANCE = 0x19, /**< Appearance. */
485 BLE_GAP_AD_TYPE_ADV_INTV = 0x1A, /**< Advertising Interval. */
486 BLE_GAP_AD_TYPE_LE_BT_ADDR = 0x1B, /**< LE Bluetooth Device Address. */
487 BLE_GAP_AD_TYPE_LE_ROLE = 0x1C, /**< LE Role. */
488 BLE_GAP_AD_TYPE_SPAIR_HASH = 0x1D, /**< Simple Pairing Hash C-256. */
489 BLE_GAP_AD_TYPE_SPAIR_RAND = 0x1E, /**< Simple Pairing Randomizer R-256. */
490 BLE_GAP_AD_TYPE_3D_INFO = 0x3D, /**< 3D Information Data. */
491
492 BLE_GAP_AD_TYPE_MANU_SPECIFIC_DATA = 0xFF, /**< Manufacturer specific data. */
493 } ble_gap_ad_type_t;
494
495 /** @brief Advertising report type. */
496 typedef enum
497 {
498 BLE_GAP_REPORT_TYPE_ADV_EXT = 0, /**< Extended advertising report. */
499 BLE_GAP_REPORT_TYPE_ADV_LEG, /**< Legacy advertising report. */
500 BLE_GAP_REPORT_TYPE_SCAN_RSP_EXT, /**< Extended scan response report. */
501 BLE_GAP_REPORT_TYPE_SCAN_RSP_LEG, /**< Legacy scan response report. */
502 BLE_GAP_REPORT_TYPE_PER_ADV, /**< Periodic advertising report. */
503 } ble_gap_adv_report_type_t;
504
505 /** @brief Advertising report information. */
506 typedef enum
507 {
508 BLE_GAP_REPORT_INFO_COMPLETE_BIT = (1 << 0), /**< Report is complete. */
509 BLE_GAP_REPORT_INFO_CONN_ADV_BIT = (1 << 1), /**< Connectable advertising. */
510 BLE_GAP_REPORT_INFO_SCAN_ADV_BIT = (1 << 2), /**< Scannable advertising. */
511 BLE_GAP_REPORT_INFO_DIR_ADV_BIT = (1 << 3), /**< Directed advertising. */
512 } ble_gap_adv_report_info_t;
513
514 /** @brief Stop reason code. */
515 typedef enum
516 {
517 BLE_GAP_STOPPED_REASON_TIMEOUT = 0, /**< Stop with timeout. */
518 BLE_GAP_STOPPED_REASON_ON_USER, /**< Stop with user stopping it actively. */
519 BLE_GAP_STOPPED_REASON_CONN_EST /**< Stop with connection established. */
520 } ble_gap_stopped_reason_t;
521
522 /**
523 * @brief AD Type Flag - Bit mask.
524 */
525 typedef enum
526 {
527 BLE_GAP_ADV_FLAG_LE_LIMITED_DISC_MODE = 0x01, /**< Limited discovery flag: AD Flag. */
528 BLE_GAP_ADV_FLAG_LE_GENERAL_DISC_MODE = 0x02, /**< General discovery flag: AD Flag. */
529 BLE_GAP_ADV_FLAG_BR_EDR_NOT_SUPPORTED = 0x04, /**< Legacy BT not supported: AD Flag. */
530 BLE_GAP_ADV_FLAG_SIMUL_BR_EDR_LE_CONTROLLER = 0x08, /**< Dual mode for controller supported (BR/EDR/LE): AD Flag. */
531 BLE_GAP_ADV_FLAG_SIMUL_BR_EDR_LE_HOST = 0x10, /**< Dual mode for host supported (BR/EDR/LE): AD Flag. */
532 } ble_gap_adv_flags_t;
533
534 /**
535 * @brief Privacy mode.
536 */
537
538 typedef enum
539 {
540 BLE_GAP_PRIVACY_MODE_NETWORK= 0x00, /**< Set to the network privacy mode for the peer device. */
541 BLE_GAP_PRIVACY_MODE_DEVICE = 0x01, /**< Set to the device privacy mode for the peer device. */
542 } ble_gap_privacy_mode_t;
543
544 /**
545 * @brief Possible roles of the activity.
546 */
547 typedef enum
548 {
549 BLE_GAP_ACTIVITY_ROLE_ADV = 0, /**< Adertise role. */
550 BLE_GAP_ACTIVITY_ROLE_CON = 1, /**< Connect role. */
551 BLE_GAP_ACTIVITY_ROLE_SCAN_INIT = 2, /**< Scann role. */
552 BLE_GAP_ACTIVITY_ROLE_UNKNOWN = 0xf, /**< Unknown role. */
553 } ble_gap_actv_role_t;
554
555 /**
556 * @brief Activity type.
557 */
558 typedef enum
559 {
560 BLE_GAP_ACTV_TYPE_ADV = 0,
561 BLE_GAP_ACTV_TYPE_SCAN,
562 BLE_GAP_ACTV_TYPE_INIT,
563 BLE_GAP_ACTV_TYPE_PER_SYNC,
564 } ble_gap_actv_type_t;
565 /** @} */
566
567 /**@addtogroup BLE_GAPM_STRUCTURES Structures
568 * @{ */
569
570 /**
571 * @brief Advertising parameters for legacy advertising
572 */
573 typedef struct
574 {
575 uint8_t adv_mode; /**< Advertising mode (see enum @ref ble_gap_adv_mode_t). */
576 uint8_t disc_mode; /**< Discovery mode (see enum @ref ble_gap_disc_mode_t). */
577 uint8_t filter_pol; /**< Advertising filtering policy (see enum @ref ble_gap_adv_filter_policy_t). */
578 ble_gap_bdaddr_t peer_addr; /**< Peer address configuration (only used in case of directed advertising, or used to locate the IRK list). */
579 uint16_t adv_intv_min; /**< Minimum advertising interval (in unit of 625 μs). Must be greater than 20 ms. */
580 uint16_t adv_intv_max; /**< Maximum advertising interval (in unit of 625 μs). Must be greater than 20 ms. */
581 uint8_t chnl_map; /**< Advertising channel map. See @ref BLE_GAP_ADV_CHANNEL. */
582 bool scan_req_ind_en; /**< Indicate if the application should be informed when receiving a scan request from the scanner. */
583 int8_t max_tx_pwr; /**< Maximum power level at which the advertising packets have to be transmitted (between -127 dBm and 127 dBm).
584 For the real value, please refer to GR551x Datasheet. */
585 } ble_gap_adv_param_t;
586
587 /**
588 * @brief Configuration for advertising on primary channel
589 */
590 typedef struct
591 {
592 uint32_t adv_intv_min; /**< Minimum advertising interval (in unit of 625 μs). Must be greater than 20 ms. */
593 uint32_t adv_intv_max; /**< Maximum advertising interval (in unit of 625 μs). Must be greater than 20 ms. */
594 uint8_t chnl_map; /**< Bit field indicating the channel map. See @ref BLE_GAP_ADV_CHANNEL. */
595 ble_gap_le_phy_value_t phy; /**< Indicate on which PHY primary advertising has to be performed. See enum @ref ble_gap_le_phy_value_t.
596 Note that LE 2M PHY is not allowed and that legacy advertising only supports LE 1M PHY. */
597 } ble_gap_adv_prim_cfg_t;
598
599 /**
600 * @brief Configuration for advertising on secondary channel
601 */
602 typedef struct
603 {
604 uint8_t max_skip; /**< Maximum number of advertising events the controller can skip before sending the AUX_ADV_IND packets.
605 The range is 0x00 to 0xFF. 0x00 means that AUX_ADV_IND PDUs shall be sent prior to each advertising events. */
606 ble_gap_le_phy_value_t phy; /**< Indicate on which PHY secondary advertising has to be performed. See enum @ref ble_gap_le_phy_value_t. */
607 uint8_t adv_sid; /**< Advertising SID. Allowed range is 0x00 to 0x0F. */
608 } ble_gap_adv_second_cfg_t;
609
610 /**
611 * @brief Configuration for periodic advertising
612 */
613 typedef struct
614 {
615 uint16_t adv_intv_min; /**< Minimum advertising interval (in unit of 1.25 ms). Must be greater than 20 ms. */
616 uint16_t adv_intv_max; /**< Maximum advertising interval (in unit of 1.25 ms). Must be greater than 20 ms. */
617 bool inc_adi_flag; /**< Flag for include the ADI field in AUX_SYNC_IND PDUs. */
618 } ble_gap_adv_period_cfg_t;
619
620 /**
621 * @brief Advertising parameters for extended advertising and periodic advertising
622 */
623 typedef struct
624 {
625 uint8_t type; /**< Advertising type (see enum @ref ble_gap_adv_type_t). */
626 uint8_t disc_mode; /**< Discovery mode (see enum @ref ble_gap_disc_mode_t). */
627 uint16_t prop; /**< Bit field value provided by advertising properties. See enum @ref ble_gap_adv_prop_t for bit signification. */
628 int8_t max_tx_pwr; /**< Maximum power level at which the advertising packets have to be transmitted (support value:[-20, -13, -9, -5, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8]). */
629 uint8_t filter_pol; /**< Advertising filtering policy (see enum @ref ble_gap_adv_filter_policy_t). */
630 ble_gap_bdaddr_t peer_addr; /**< Peer address configuration (only used in case of directed advertising or used to locate the IRK list). */
631 ble_gap_adv_prim_cfg_t prim_cfg; /**< Configuration for primary advertising. */
632 ble_gap_adv_second_cfg_t second_cfg; /**< Configuration for secondary advertising (valid only if advertising type is GAP_ADV_TYPE_EXTENDED or GAP_ADV_TYPE_PERIODIC). */
633 ble_gap_adv_period_cfg_t period_cfg; /**< Configuration for periodic advertising (valid only if advertising type is GAP_ADV_TYPE_PERIODIC). */
634 } ble_gap_ext_adv_param_t;
635
636 /**
637 * @brief Advertising timing parameter
638 */
639 typedef struct
640 {
641 uint16_t duration; /**< Advertising duration (in unit of 10ms). 0 means that advertising continues until the host disables it.
642 If Advertising discovery mode is GAP_DISC_MODE_LIM_DISCOVERABLE (see enum @ref ble_gap_disc_mode_t),
643 the setting duration range is [1, 18000].
644 If adv mode is high duty, duration time range is [1, 128]. */
645 uint8_t max_adv_evt; /**< Maximum number of extended advertising events. The controller shall attempt to send prior to terminating the extending advertising.
646 The range is [0, 255]. 0 means no maximum number of advertising events. Valid only if the created advertising is an extended advertising. */
647 } ble_gap_adv_time_param_t;
648
649 /**
650 * @brief Security key
651 */
652 typedef struct
653 {
654 uint8_t key[BLE_GAP_MAX_KEY_LEN]; /**< Key value MSB -> LSB (MSB followed by LSB). */
655 } ble_gap_sec_key_t;
656
657 /**
658 * @brief Parameters for legacy scanning
659 */
660 typedef struct
661 {
662 ble_gap_scan_type_t scan_type; /**< Active scanning or passive scanning. */
663 ble_gap_scan_mode_t scan_mode; /**< Scan mode. */
664 ble_gap_scan_dup_filt_policy_t scan_dup_filt; /**< Duplicate filter policy. */
665 bool use_whitelist; /**< Filter policy. */
666 uint16_t interval; /**< Scan interval between 0x0004 and 0x4000 in 0.625 ms (range: 2.5 ms to 10.24s). */
667 uint16_t window; /**< Scan window between 0x0004 and 0x4000 in 0.625 ms (range: 2.5 ms to 10.24s). */
668 uint16_t timeout; /**< Scan timeout should be a value between 0x0001 and 0xFFFF(unit: 10 ms). 0x0000 indicates that the timeout has no effect. */
669 } ble_gap_scan_param_t;
670
671 /**
672 * @brief Scan Window operation parameters
673 */
674 typedef struct
675 {
676 uint16_t scan_intv; /**< Scan interval between 0x0004 and 0xFFFF in 0.625 ms (range: 2.5 ms to 40.959375s). */
677 uint16_t scan_wd; /**< Scan window between 0x0004 and 0xFFFF in 0.625 ms (range: 2.5 ms to 40.959375s). */
678 } ble_gap_scan_wd_op_param_t;
679
680 /**
681 * @brief Parameters for extended scanning
682 */
683 typedef struct
684 {
685 uint8_t type; /**< Type of scanning to be started (see enum @ref ble_gap_ext_scan_type_t). */
686 uint8_t prop; /**< Properties for the scan procedure (see enum @ref ble_gap_scan_prop_t for bit signification). */
687 uint8_t dup_filt_pol; /**< Duplicate packet filtering policy (see enum @ref ble_gap_ext_scan_dup_filt_policy_t). */
688 uint8_t rsvd; /**< Reserved for future use. */
689 ble_gap_scan_wd_op_param_t scan_param_1m; /**< Scan window opening parameters for LE 1M PHY. */
690 ble_gap_scan_wd_op_param_t scan_param_coded; /**< Scan window opening parameters for LE Coded PHY. */
691 uint16_t duration; /**< Scan duration (in unit of 10ms). 0 means that the controller will scan continuously
692 until receiving a stop command from the application (10 ms to 655.35s). */
693 uint16_t period; /**< Scan period, which is the time interval between two consequent starts of a scan duration by the controller.
694 0 means that the scan procedure is not periodic, in unit of 1.28s (1.28s to 83,884.8s). */
695 } ble_gap_ext_scan_param_t;
696
697 /**
698 * @brief Periodic advertising information
699 */
700 typedef struct
701 {
702 ble_gap_bdaddr_t bd_addr; /**< Advertiser address information. */
703 uint8_t adv_sid; /**< Advertising SID. */
704 } ble_gap_period_adv_addr_cfg_t;
705
706 /**
707 * @brief Periodic advertising synchronization parameters
708 */
709 typedef struct
710 {
711 uint16_t skip; /**< Number of periodic advertising that can be skipped after a successful reception.
712 Maximum authorized value is 499. */
713 uint16_t sync_to; /**< Synchronization timeout for the periodic advertising (in unit of 10ms between 100ms and 163.84s). */
714 uint8_t type; /**< Periodic synchronization type (see enum @ref ble_gap_per_sync_type_t). */
715 uint8_t rsvd; /**< Reserved for future use.*/
716 ble_gap_period_adv_addr_cfg_t adv_addr; /**< Address of advertiser with which synchronization has to be established(used only if use_pal is false). */
717 bool report_disable; /**< true to disable periodic advertising report, false to enable them by default.*/
718 uint8_t cte_type; /**< Type of Constant Tone Extension device should sync on (@see enum gap_sync_cte_type). */
719 } ble_gap_per_sync_param_t;
720
721 /**
722 * @brief Set connectionless CTE transmit parameters
723 */
724 typedef struct
725 {
726 uint8_t cte_len; /**< CTE length (8us unit, range 0x02 to 0x14). */
727 uint8_t cte_type; /**< CTE type (0: AOA | 1: AOD-1us | 2: AOD-2us) (@see enum gap_cte_type_t). */
728 uint8_t cte_count; /**< CTE count (number of CTEs to transmit in each periodic advertising interval, range 0x01 to 0x10). */
729 uint8_t num_antenna; /**< The number of Antenna IDs in the pattern (range 0x02 to 0x4B). */
730 uint8_t *antenna_id; /**< List of Antenna IDs in the pattern. */
731 } gap_connless_cte_trans_param_t;
732
733 /**
734 * @brief Set connectionless IQ sampling enable parameter
735 */
736 typedef struct
737 {
738 uint8_t slot_dur; /**< The slot duration for IQ sampling, see enum @ref gap_slot_dur_type. */
739 uint8_t max_smaple_cte; /**< The maximum number of CTE to sample and report in each periodic advertising interval (range 0x00 to 0x10).
740 0x00: Sample and report all available CTE. */
741 uint8_t antenna_num; /**< The number of antenna IDs in the pattern (range 0x02 to 0x4B). */
742 uint8_t *antenna_id; /**< List of Antenna IDs in the pattern. */
743 } ble_gap_connless_iq_sample_param_t;
744
745 /**
746 * @brief Legacy initiating parameters
747 */
748 typedef struct
749 {
750 uint8_t type; /**< Initiating type (see enum @ref ble_gap_init_type_t). */
751 ble_gap_bdaddr_t peer_addr; /**< Peer device address. */
752 uint16_t interval_min; /**< Minimum value for the connection interval (in unit of 1.25ms). Shall be less than or equal to interval_max value.
753 Allowed range is 7.5 ms to 4s. */
754 uint16_t interval_max; /**< Maximum value for the connection interval (in unit of 1.25ms). Shall be greater than or equal to interval_min value.
755 Allowed range is 7.5 ms to 4s. */
756 uint16_t slave_latency; /**< Slave latency. Number of events that can be missed by a connected slave device. */
757 uint16_t sup_timeout; /**< Link supervision timeout (in unit of 10ms). Allowed range is 100 ms to 32s. */
758 uint16_t conn_timeout; /**< Timeout for connection establishment (in unit of 10ms).
759 Cancel the procedure if connection has not been connected when the timeout occurs.
760 0 means there is no timeout. */
761 } ble_gap_init_param_t;
762
763
764 /**
765 * @brief Connection parameters
766 */
767 typedef struct
768 {
769 uint16_t conn_intv_min; /**< Minimum value for the connection interval (in unit of 1.25ms). Shall be less than or equal to conn_intv_max value.
770 Allowed range is 7.5 ms to 4s. */
771 uint16_t conn_intv_max; /**< Maximum value for the connection interval (in unit of 1.25ms). Shall be greater than or equal to conn_intv_min value.
772 Allowed range is 7.5 ms to 4s. */
773 uint16_t conn_latency; /**< Slave latency. Number of events that can be missed by a connected slave device. */
774 uint16_t supervision_to; /**< Link supervision timeout (in unit of 10ms). Allowed range is 100 ms to 32s. */
775 uint16_t ce_len; /**< The length of connection event needed for this LE connection. Range: 0x0002 to 0xFFFF, Unit:0.625 ms, Time Range: 1.25 ms to 40.9s. */
776 } ble_gap_ext_conn_param_t;
777
778 /**
779 * @brief Extended initiating parameters
780 */
781 typedef struct
782 {
783 uint8_t type; /**< Initiating type (see enum @ref ble_gap_init_type_t). */
784 uint8_t prop; /**< Properties for the initiating procedure (see enum @ref ble_gap_init_prop_t for bit signification). */
785 uint16_t conn_to; /**< Timeout for automatic connection establishment (in unit of 10ms).
786 Cancel the procedure if connection has not been connected when the timeout occurs.
787 0 means there is no timeout. */
788 ble_gap_scan_wd_op_param_t scan_param_1m; /**< Scan window opening parameters for LE 1M PHY. */
789 ble_gap_scan_wd_op_param_t scan_param_coded; /**< Scan window opening parameters for LE Coded PHY. */
790 ble_gap_ext_conn_param_t conn_param_1m; /**< Connection parameters for LE 1M PHY. */
791 ble_gap_ext_conn_param_t conn_param_2m; /**< Connection parameters for LE 2M PHY. */
792 ble_gap_ext_conn_param_t conn_param_coded; /**< Connection parameters for LE Coded PHY. */
793 ble_gap_bdaddr_t peer_addr; /**< Address of peer device in case white list is not used for connection. */
794 } ble_gap_ext_init_param_t;
795
796 /**
797 * @brief LE Protocol/Service Multiplexer information
798 */
799 typedef struct
800 {
801 uint16_t le_psm; /**< LE Protocol/Service Multiplexer (range: 1 to 255), PSMs should be odd. */
802 uint8_t sec_lvl; /**< Security level requirement, see @ref gap_sec_lvl_type. */
803 bool mks_flag; /**< Whether to use maximum-size key (16 bytes) or not. */
804 } ble_gap_lepsm_register_t;
805
806 /**
807 * @brief Bonded device list
808 */
809 typedef struct
810 {
811 uint8_t num; /**< Number of bonded device. */
812 ble_gap_bdaddr_t *items; /**< Bonded device addr info. */
813 } ble_gap_bond_dev_list_t;
814
815 /**
816 * @brief White list
817 */
818 typedef struct
819 {
820 uint8_t num; /**< Number of available items. */
821 ble_gap_bdaddr_t items[BLE_GAP_MAX_WL_NUM]; /**< Content of each item. */
822 } ble_gap_white_list_t;
823
824 /**
825 * @brief Periodic advertising list
826 */
827 typedef struct
828 {
829 uint8_t num; /**< Number of available items. */
830 ble_gap_period_adv_addr_cfg_t items[BLE_GAP_MAX_PRD_ADV_NUM]; /**< Content of each item. */
831 } ble_gap_period_adv_list_t;
832
833 /**
834 * @brief RPA list item info
835 */
836 typedef struct
837 {
838 ble_gap_bdaddr_t bd_addr; /**< Peer device identity. */
839 uint8_t priv_mode; /**< Privacy mode, see enum @ref ble_gap_privacy_mode_t. */
840 uint8_t peer_irk[BLE_GAP_MAX_KEY_LEN]; /**< Peer IRK. */
841 uint8_t local_irk[BLE_GAP_MAX_KEY_LEN]; /**< Local IRK. */
842 } ble_gap_ral_dev_info_t;
843
844 /**
845 * @brief RPA list info
846 */
847 typedef struct
848 {
849 uint8_t offset; /**< offset of RPA list. */
850 uint8_t num; /**< Number of RPA list. */
851 ble_gap_ral_dev_info_t *items; /**< RPA list item info. */
852 } ble_gap_ral_dev_list_t;
853
854 /**
855 * @brief Operation code used to read resolvable address.
856 */
857 typedef enum
858 {
859 BLE_GAP_OPCODE_LOCAL_RSLV_ADDR_READ, /**< Local resolvable address operation. */
860 BLE_GAP_OPCODE_PEER_RSLV_ADDR_READ, /**< Peer resolvable address operation. */
861 } ble_gap_rslv_addr_read_op_id_t;
862
863 /** @brief Get device info event for @ref BLE_GAPM_EVT_DEV_INFO_GOT. */
864 typedef struct
865 {
866 uint8_t operation; /**< Operation code. @ref ble_gap_dev_info_get_type_t. */
867 ble_gap_dev_info_t dev_info; /**< Device info. */
868 } ble_gap_evt_dev_info_get_t;
869
870 /** @brief Advertising Stop info. */
871 typedef struct
872 {
873 ble_gap_stopped_reason_t reason; /**< The reason for the advertising stop. */
874 } ble_gap_evt_adv_stop_t;
875
876 /** @brief Scan request info. */
877 typedef struct
878 {
879 ble_gap_bdaddr_t peer_addr; /**< Peer address. */
880 } ble_gap_evt_scan_req_t;
881
882 /** @brief Scan Stop info struct. */
883 typedef struct
884 {
885 ble_gap_stopped_reason_t reason; /**< The reason why the scan stopped. */
886 } ble_gap_evt_scan_stop_t;
887
888 /** @brief Advertising report event for @ref BLE_GAPM_EVT_ADV_REPORT. */
889 typedef struct
890 {
891 ble_gap_adv_report_type_t adv_type; /**< Advertising type. @ref ble_gap_adv_report_type_t. */
892 ble_gap_adv_report_info_t adv_info; /**< Bit field providing information about the received report. @ref ble_gap_adv_report_info_t. */
893 ble_gap_bdaddr_t broadcaster_addr; /**< Broadcaster device address. */
894 ble_gap_bdaddr_t direct_addr; /**< Target address (in case of a directed advertising report). */
895 int8_t tx_pwr; /**< TX power (in dBm). */
896 int8_t rssi; /**< RSSI (between -127 and +20 dBm). */
897 uint8_t phy_prim; /**< Primary PHY on which advertising report has been received. */
898 uint8_t phy_second; /**< Secondary PHY on which advertising report has been received. */
899 uint8_t adv_sid; /**< Advertising SID , valid only for periodic advertising report. */
900 uint16_t period_adv_intv; /**< Periodic advertising interval (in unit of 1.25ms, min is 7.5ms), valid only for periodic advertising report. */
901 uint8_t per_sync_idx; /**< Periodic syncronization index, valid only for periodic advertising report. */
902 uint16_t length; /**< Report length. */
903 uint8_t *data; /**< Report data. */
904 } ble_gap_evt_adv_report_t;
905
906 /** @brief Sync established event for @ref BLE_GAPM_EVT_SYNC_ESTABLISH. */
907 typedef struct
908 {
909 uint8_t phy; /**< PHY on which synchronization has been established. */
910 uint16_t intv; /**< Periodic advertising interval (in unit of 1.25ms, min is 7.5ms). */
911 uint8_t adv_sid; /**< Advertising SID. */
912 uint8_t clk_acc; /**< Advertiser clock accuracy. */
913 ble_gap_bdaddr_t bd_addr; /**< Advertiser address. */
914 uint16_t sync_hdl; /**< Sync handle. */
915 } ble_gap_evt_sync_established_t;
916
917 /** @brief Read resolvable address event for @ref BLE_GAPM_EVT_READ_RSLV_ADDR. */
918 typedef struct
919 {
920 uint8_t op_code; /**< Operation code. @ref ble_gap_rslv_addr_read_op_id_t. */
921 ble_gap_addr_t gap_addr; /**< Resolvable address info. */
922 } ble_gap_evt_rslv_addr_read_t;
923
924 /** @brief Resolvable address report event for @ref BLE_GAPM_EVT_RSLV_ADDR_REPORT. */
925 typedef struct
926 {
927 ble_gap_actv_type_t type; /**< Activity type. @ref ble_gap_actv_type_t. */
928 ble_gap_addr_t rpa_addr; /**< rpa address info. */
929 } ble_gap_evt_rslv_addr_report_t;
930
931 /**@brief BLE GAPM event structure. */
932 typedef struct
933 {
934 uint8_t index; /**< Index of connection or advertising. */
935 union
936 {
937 ble_gap_evt_dev_info_get_t dev_info; /**< Device info parameters. */
938 ble_gap_evt_adv_stop_t adv_stop; /**< Advertising stop parameter. */
939 ble_gap_evt_scan_req_t scan_req; /**< Scan Request parameter. */
940 ble_gap_evt_scan_stop_t scan_stop; /**< Scan Stop parameter. */
941 ble_gap_evt_adv_report_t adv_report; /**< Advertising Report parameter. */
942 ble_gap_evt_sync_established_t sync_established; /**< Periodic Advertising Synchronization Established parameter. */
943 ble_gap_evt_rslv_addr_read_t rslv_addr; /**< Read Resolvable Address parameter, generated by controller. */
944 ble_gap_evt_rslv_addr_report_t rslv_addr_report; /**< Resolvable Address report parameter, generated by host. */
945 } params; /**< Event Parameters. */
946 } ble_gapm_evt_t;
947 /** @} */
948
949
950
951 /** @addtogroup BLE_GAPM_FUNCTION Functions
952 * @{ */
953
954 /**
955 ****************************************************************************************
956 * @brief Decide whether to support the pair feature.
957 *
958 * @param[in] enable: Support flag.
959 ****************************************************************************************
960 */
961 void ble_gap_pair_enable(bool enable);
962
963 /**
964 ****************************************************************************************
965 * @brief Set the device identity address (public or random static).
966 *
967 * @param[in] p_addr: Provided public or static random address. If addr_type = 0, it means public address,
968 * If addr_type = 1, it means static random address.
969 *
970 * @retval SDK_SUCCESS: Operation is successful.
971 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
972 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
973 ****************************************************************************************
974 */
975 uint16_t ble_gap_addr_set(ble_gap_bdaddr_t const *p_addr);
976
977 /**
978 ****************************************************************************************
979 * @brief Get the device identity address (public or random static).
980 *
981 * @param[in] p_addr: The pointer for the returned identity address.
982 *
983 * @retval SDK_SUCCESS: Operation is successful.
984 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
985 ****************************************************************************************
986 */
987 uint16_t ble_gap_addr_get(ble_gap_bdaddr_t *p_addr);
988
989 /**
990 ****************************************************************************************
991 * @brief Set the tx power
992 *
993 * @param[in] role: Select the role to set tx power. @ref ble_gap_actv_role_t for possible roles.
994 * @param[in] index: The idx parameter is interpreted on role.
995 * -If role is @ref BLE_GAP_ACTIVITY_ROLE_ADV, it's the index of Advertising.
996 * -If role is @ref BLE_GAP_ACTIVITY_ROLE_CON, it's the index of connection.
997 * -For all other roles, it should be ignored.
998 * @param[in] txpwr_dbm: Tx power, unit(dBm).
999 * support value:[-20, -13, -9, -5, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8]
1000 *
1001 * @retval SDK_SUCCESS: Operation is Success.
1002 * @retval SDK_ERR_INVALID_CONN_IDX: Invalid connection index supplied.
1003 * @retval SDK_ERR_INVALID_ADV_IDX: Invalid advertising index supplied.
1004 * @retval SDK_ERR_INVALID_HANDLE: Invalid handle supplied.
1005 ****************************************************************************************
1006 */
1007 uint16_t ble_gap_tx_power_set(ble_gap_actv_role_t role, uint8_t index, int8_t txpwr_dbm);
1008
1009 /**
1010 ****************************************************************************************
1011 * @brief Get the tx power
1012 *
1013 * @param[in] role: Select the role to Get tx power. @ref ble_gap_actv_role_t for possible roles.
1014 * @param[in] index: The idx parameter is interpreted on role.
1015 * If role is @ref BLE_GAP_ACTIVITY_ROLE_ADV, it's the index of Advertising.
1016 * If role is @ref BLE_GAP_ACTIVITY_ROLE_CON, it's the index of connection.
1017 * For all other roles, it should be ignored.
1018 * @param[out] txpwr_dbm: Tx power, unit(dBm).
1019 * support value:[-20, -13, -9, -5, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8]
1020 *
1021 * @retval SDK_SUCCESS: Operation is Success.
1022 * @retval SDK_ERR_INVALID_CONN_IDX: Invalid connection index supplied.
1023 * @retval SDK_ERR_INVALID_ADV_IDX: Invalid advertising index supplied.
1024 * @retval SDK_ERR_INVALID_HANDLE: Invalid handle supplied.
1025 ****************************************************************************************
1026 */
1027 uint16_t ble_gap_tx_power_get(ble_gap_actv_role_t role, uint8_t index, int8_t *txpwr_dbm);
1028
1029 /**
1030 ****************************************************************************************
1031 * @brief Set IRK used for resolvable random BD address generation (LSB first).
1032 *
1033 * @param[in] p_irk: Device IRK (Identity Resolving Key).
1034 *
1035 * @retval SDK_SUCCESS: Operation is successful.
1036 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1037 ****************************************************************************************
1038 */
1039 uint16_t ble_gap_irk_set(ble_gap_sec_key_t* p_irk);
1040
1041 /**
1042 ****************************************************************************************
1043 * @brief Set privacy related parameters.
1044 * @param[in] renew_dur: Duration before regenerating a device address when privacy is enabled in seconds. Range: 0x0001 (1s) ~ 0xA1B8 (11.5 hr).
1045 * The suggested time is 900s(15 minutes).
1046 * @param[in] enable_flag: Indicate the controller privacy is enabled or disabled.
1047 *
1048 * @retval SDK_SUCCESS: Operation is successful.
1049 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1050 ****************************************************************************************
1051 */
1052 uint16_t ble_gap_privacy_params_set(uint16_t renew_dur, bool enable_flag);
1053
1054 /**
1055 ****************************************************************************************
1056 * @brief Set suggested default LE data length.
1057 *
1058 * @param[in] sugg_max_tx_octet: Suggested value for the Controller's maximum transmitted number of payload octets to be used, the range is 27~251.
1059 * @param[in] sugg_max_tx_time: Suggested value for the Controller's maximum packet transmission time to be used, the range is 328~2120.
1060 *
1061 * @retval SDK_SUCCESS: Operation is successful.
1062 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1063 ****************************************************************************************
1064 */
1065 uint16_t ble_gap_data_length_set(uint16_t sugg_max_tx_octet,uint16_t sugg_max_tx_time);
1066
1067 /**
1068 ****************************************************************************************
1069 * @brief Set L2CAP related parameters.
1070 *
1071 * @param[in] max_mtu: Maximal MTU acceptable for device, the range is 65~512.
1072 * @param[in] max_mps: Maximal MPS Packet size acceptable for device (for COC SDU), the range is 65~max_mtu.
1073 * @param[in] max_nb_lecb: Maximum number of LE Credit based connection that can be established, this range is 0x00~0x20.
1074 * The actual number is decided by resource available.
1075 *
1076 * @retval SDK_SUCCESS: Operation is successful.
1077 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1078 *
1079 * @note If these parameters are not set, the stack will config the default value as (max_mtu = 512, max_mps = 512 and max_nb_lecb = 10).
1080 ****************************************************************************************
1081 */
1082 uint16_t ble_gap_l2cap_params_set(uint16_t max_mtu,uint16_t max_mps,uint8_t max_nb_lecb);
1083
1084 /**
1085 ****************************************************************************************
1086 * @brief Set the preferred values for the transmitter PHY and receiver PHY.
1087 *
1088 * @param[in] tx_pref_phy: A bit field that indicates the transmitter PHYs that the Host prefers the Controller to use(see @ref BLE_GAP_PHYS).
1089 * @param[in] rx_pref_phy: A bit field that indicates the receiver PHYs that the Host prefers the Controller to use(see @ref BLE_GAP_PHYS).
1090 ****************************************************************************************
1091 */
1092 void ble_gap_pref_phy_set(uint8_t tx_pref_phy, uint8_t rx_pref_phy);
1093
1094 /**
1095 ****************************************************************************************
1096 * @brief Set the RF path gain or loss between the RF transceiver and the antenna contributed by intermediate components.
1097 *
1098 * @param[in] tx_path_comp: RF TX Path Compensation value (from -128dB to 128dB, unit is 0.1dB).
1099 * @param[in] rx_path_comp: RF RX Path Compensation value (from -128dB to 128dB, unit is 0.1dB).
1100 *
1101 * @retval SDK_SUCCESS: Operation is successful.
1102 * @retval SDK_ERR_INVALID_PARAM: The parameter is invalid.
1103 ****************************************************************************************
1104 */
1105 uint16_t ble_gap_path_compensation_set(int16_t tx_path_comp, int16_t rx_path_comp);
1106
1107 /**
1108 ****************************************************************************************
1109 * @brief Set GAP Peripheral Preferred Connection Parameters present flag.
1110 *
1111 * @param[in] present_flag: Present or not.
1112 ****************************************************************************************
1113 */
1114 void ble_gap_ppcp_present_set(bool present_flag);
1115
1116 /**
1117 ****************************************************************************************
1118 * @brief Set advertising channel map before advertising starting.
1119 * @note This API is asynchronous.
1120 * @note Once the operation has completed, the event @ref BLE_GAP_OPCODE_CHNL_MAP_SET will be called.
1121 *
1122 * @param[in] p_chnl_map: Bitmask of LE channel map. See enum @ref ble_gap_chnl_map_t for BT Core Spec version <= 4.2.
1123 *
1124 * @retval SDK_SUCCESS: Operation is successful.
1125 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1126 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1127 *
1128 ****************************************************************************************
1129 */
1130 uint16_t ble_gap_chnl_map_set(ble_gap_chnl_map_t* p_chnl_map);
1131
1132 /**
1133 ****************************************************************************************
1134 * @brief Get all bonded devices.
1135 *
1136 * @param[in] p_bond_list: Pointer to the bond list.
1137 * @param[in] max_num: max number of bond devices can be gotten.
1138 *
1139 * @retval SDK_SUCCESS: Operation is successful.
1140 * @retval SDK_ERR_SDK_INTERNAL: SDK internal error.
1141 * @retval SDK_ERR_NVDS_NOT_INIT: NVDS is not initiated.
1142 * @retval SDK_ERR_LIST_ITEM_NOT_FOUND: Item not found in list.
1143 * @retval SDK_ERR_LIST_FULL: List is full.
1144 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1145 ****************************************************************************************
1146 */
1147 uint16_t ble_gap_bond_devs_get(ble_gap_bond_dev_list_t *p_bond_list, uint8_t max_num);
1148
1149 /**
1150 ****************************************************************************************
1151 * @brief Clear all bonded devices.
1152 *
1153 * @retval SDK_SUCCESS: Operation is successful.
1154 * @retval SDK_ERR_SDK_INTERNAL: SDK internal error.
1155 * @retval SDK_ERR_NVDS_NOT_INIT: NVDS is not initiated.
1156 * @retval SDK_ERR_LIST_ITEM_NOT_FOUND: Item not found in list.
1157 * @retval SDK_ERR_LIST_FULL: List is full.
1158 ****************************************************************************************
1159 */
1160 uint16_t ble_gap_bond_devs_clear(void);
1161
1162 /**
1163 ****************************************************************************************
1164 * @brief Delete a bond device with the specified BD address.
1165 *
1166 * @param[in] p_peer_addr: Pointer to the BD addrss.
1167 *
1168 * @retval SDK_SUCCESS: Operation is successful.
1169 * @retval SDK_ERR_SDK_INTERNAL: SDK internal error.
1170 * @retval SDK_ERR_NVDS_NOT_INIT: NVDS is not initiated.
1171 * @retval SDK_ERR_LIST_ITEM_NOT_FOUND: Item not found in list.
1172 * @retval SDK_ERR_LIST_FULL: List is full.
1173 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1174 ****************************************************************************************
1175 */
1176 uint16_t ble_gap_bond_dev_del(const ble_gap_bdaddr_t *p_peer_addr);
1177
1178 /**
1179 ****************************************************************************************
1180 * @brief Get the content of the whole white list.
1181 *
1182 * @param[in] p_whitelist: Pointer to the output white list.
1183 *
1184 * @retval SDK_SUCCESS: Operation is successful.
1185 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1186 ****************************************************************************************
1187 */
1188 uint16_t ble_gap_whitelist_get(ble_gap_white_list_t *p_whitelist);
1189
1190 /**
1191 ****************************************************************************************
1192 * @brief Add the devices into current white list. If white list is full or there are duplicated entries, it will return error.
1193 * @note This API is asynchronous.
1194 * @note Once the operation has completed, the event @ref BLE_GAP_OPCODE_WHITELIST_SET will be called.
1195 *
1196 * @param[in] p_whitelist: Pointer to input white list.
1197 *
1198 * @retval SDK_SUCCESS: Operation is successful.
1199 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1200 * @retval SDK_ERR_LIST_ITEM_ALREADY_EXISTED: Item already existed in list.
1201 * @retval SDK_ERR_LIST_FULL: List is full.
1202 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1203 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1204 *
1205 ****************************************************************************************
1206 */
1207 uint16_t ble_gap_whitelist_add(const ble_gap_white_list_t *p_whitelist);
1208
1209 /**
1210 ****************************************************************************************
1211 * @brief Delete the devices out of current white list. If the entries do not exist in the current white list, it will return error.
1212 * @note This API is asynchronous.
1213 * @note Once the operation has completed, the event @ref BLE_GAP_OPCODE_WHITELIST_SET will be called.
1214 *
1215 * @param[in] p_whitelist: Pointer to input white list.
1216 *
1217 * @retval SDK_SUCCESS: Operation is successful.
1218 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1219 * @retval SDK_ERR_LIST_ITEM_NOT_FOUND: Item not found in list.
1220 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1221 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1222 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1223 *
1224 ****************************************************************************************
1225 */
1226 uint16_t ble_gap_whitelist_del(const ble_gap_white_list_t *p_whitelist);
1227
1228 /**
1229 ****************************************************************************************
1230 * @brief Clear all the entries in the current white list.
1231 * @note This API is asynchronous.
1232 * @note once the operation has completed, the event @ref BLE_GAP_OPCODE_WHITELIST_SET will be called.
1233 *
1234 * @retval SDK_SUCCESS: Operation is successful.
1235 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1236 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1237 *
1238 ****************************************************************************************
1239 */
1240 uint16_t ble_gap_whitelist_clear(void);
1241
1242 /**
1243 ****************************************************************************************
1244 * @brief Get the content of the whole periodic advertising list.
1245 *
1246 * @param[in] p_pal_list: Pointer to the output periodic advertising list.
1247 *
1248 * @retval SDK_SUCCESS: Operation is successful.
1249 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1250 ****************************************************************************************
1251 */
1252 uint16_t ble_gap_per_adv_list_get(ble_gap_period_adv_list_t *p_pal_list);
1253
1254 /**
1255 ****************************************************************************************
1256 * @brief Add the devices into current periodic advertising list. If periodic advertising list is full or there are
1257 * duplicated entries, it will return error.
1258 * @note This API is asynchronous.
1259 * @note Once the operation has completed, the event @ref BLE_GAP_OPCODE_PER_ADV_LIST_SET will be called.
1260 *
1261 * @param[in] p_pal_list: Pointer to input periodic advertising list.
1262 *
1263
1264 *
1265 * @retval SDK_SUCCESS: Operation is successful.
1266 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1267 * @retval SDK_ERR_LIST_ITEM_ALREADY_EXISTED: Item already existed in list.
1268 * @retval SDK_ERR_LIST_FULL: List is full.
1269 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1270 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1271 *
1272 ****************************************************************************************
1273 */
1274 uint16_t ble_gap_per_adv_list_add(const ble_gap_period_adv_list_t *p_pal_list);
1275
1276 /**
1277 ****************************************************************************************
1278 * @brief Delete the devices out of periodic advertising list. If the entries do not exist in the current list, an error will be returned.
1279 * @note This API is asynchronous.
1280 * @note Once the operation has completed, the event @ref BLE_GAP_OPCODE_PER_ADV_LIST_SET will be called.
1281 *
1282 * @param[in] p_pal_list: Pointer to input periodic advertising list.
1283 *
1284 * @retval SDK_SUCCESS: Operation is successful.
1285 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1286 * @retval SDK_ERR_LIST_ITEM_NOT_FOUND: Item not found in list.
1287 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1288 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1289 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1290 *
1291 ****************************************************************************************
1292 */
1293 uint16_t ble_gap_per_adv_list_del(const ble_gap_period_adv_list_t *p_pal_list);
1294
1295 /**
1296 ****************************************************************************************
1297 * @brief Clear all the entries in the current periodic advertising list.
1298 * @note This API is asynchronous.
1299 * @note Once the operation has completed, the event @ref BLE_GAP_OPCODE_PER_ADV_LIST_SET will be called.
1300 *
1301 * @retval SDK_SUCCESS: Operation is successful.
1302 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1303 ****************************************************************************************
1304 */
1305 uint16_t ble_gap_per_adv_list_clear(void);
1306
1307 /**
1308 ****************************************************************************************
1309 * @brief Get the RPA list info.
1310 * @param[in] p_rpa_list: Pointer to the output RPA list.
1311 * @param[in] max_num: Max number of rpa list can be gotten.
1312 *
1313 * @retval SDK_SUCCESS: Operation is successful.
1314 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1315 ****************************************************************************************
1316 */
1317 uint16_t ble_gap_rpa_list_get(ble_gap_ral_dev_list_t *p_rpa_list, uint8_t max_num);
1318
1319 /**
1320 ****************************************************************************************
1321 * @brief Get the device information according to param type.
1322 * @note This API is asynchronous.
1323 * @note Once the requested parameters has been got, the event @ref BLE_GAPM_EVT_DEV_INFO_GOT will be called.
1324 *
1325 * @param[in] type: Param type.
1326 *
1327 * @retval SDK_SUCCESS: Operation is successful.
1328 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1329 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1330 *
1331 ****************************************************************************************
1332 */
1333 uint16_t ble_gap_dev_info_get(ble_gap_dev_info_get_type_t type);
1334
1335 /**
1336 ****************************************************************************************
1337 * @brief Set parameters for advertising. Note that this function must be called prior to advertising started.
1338 * @param[in] adv_idx: Advertising index, range is 0 to 4.
1339 * @param[in] own_addr_type: Own BD address source of the local device.
1340 * @param[in] p_adv_param: The advertising parameters.
1341 *
1342 * @retval SDK_SUCCESS: Operation is successful.
1343 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1344 * @retval SDK_ERR_INVALID_ADV_IDX: Invalid advertising index supplied.
1345 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1346 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1347 *
1348
1349 * @note Discovery mode param contains Flags AD type, setting adv data should not set the Flags AD type.
1350 * @note This API is for legacy advertsing (BT Core Spec version <= 4.2).
1351 ****************************************************************************************
1352 */
1353 uint16_t ble_gap_adv_param_set(uint8_t adv_idx, ble_gap_own_addr_t own_addr_type, ble_gap_adv_param_t* p_adv_param);
1354
1355 /**
1356 ****************************************************************************************
1357 * @brief Set extended parameters for advertising. Note that this function must be called prior to advertising.
1358 * @param[in] adv_idx: Advertising index, range is 0 to 4.
1359 * @param[in] own_addr_type: Own BD address source of the local device.
1360 * @param[in] p_adv_param: The advertising parameters.
1361 *
1362 * @retval SDK_SUCCESS: Operation is successful.
1363 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1364 * @retval SDK_ERR_INVALID_ADV_IDX: Invalid advertising index supplied.
1365 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1366 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1367 *
1368 * @note This API is for extended and periodic advertising (BT Core Spec version >= 5.0).
1369 ****************************************************************************************
1370 */
1371 uint16_t ble_gap_ext_adv_param_set(uint8_t adv_idx, ble_gap_own_addr_t own_addr_type, ble_gap_ext_adv_param_t* p_adv_param);
1372
1373 /**
1374 ****************************************************************************************
1375 * @brief Set Advertising Data, Scan Response Data and Periodic Advertising Data. See ENUM @ref ble_gap_ad_type_t
1376 for ADV Type definitions. See ENUM @ref ble_gap_adv_flags_t for ADV flag definitions.
1377 *
1378 * @param[in] adv_idx: Advertising index, range is 0 to 4.
1379 * @param[in] type: Data type.
1380 * @param[in] p_data: The data pointer.
1381 * @param[in] length: Data length.
1382 *
1383 * @retval SDK_SUCCESS: Operation is successful.
1384 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1385 * @retval SDK_ERR_INVALID_ADV_IDX: Invalid advertising index supplied.
1386 * @retval SDK_ERR_INVALID_ADV_DATA_TYPE: Invalid advertising data type supplied.
1387 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1388 *
1389 * @note User should not add extra Flags AD type as the BLE Stack has added the Flags AD type already.
1390 ****************************************************************************************
1391 */
1392 uint16_t ble_gap_adv_data_set(uint8_t adv_idx, ble_gap_adv_data_type_t type, const uint8_t* p_data, uint16_t length);
1393
1394 /**
1395 ****************************************************************************************
1396 * @brief Update Advertising Data, Scan Response Data and Periodic Advertising Data. See ENUM @ref ble_gap_ad_type_t
1397 * for ADV Type definitions. See ENUM @ref ble_gap_adv_flags_t for ADV flag definitions.
1398 *
1399 * @param[in] adv_idx: Advertising index, range is 0 to 4.
1400 * @param[in] type: Data type.
1401 * @param[in] p_data: The data pointer.
1402 * @param[in] length: Data length.
1403 *
1404 * @retval SDK_SUCCESS: Operation is successful.
1405 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1406 * @retval SDK_ERR_INVALID_ADV_IDX: Invalid advertising index supplied.
1407 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1408 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1409 *
1410 * @note User should not add extra Flags AD type as the BLE Stack has added the Flags AD type already.
1411 ****************************************************************************************
1412 */
1413 uint16_t ble_gap_update_adv_data(uint8_t adv_idx, ble_gap_adv_data_type_t type, const uint8_t* p_data, uint16_t length);
1414
1415 /**
1416 ****************************************************************************************
1417 * @brief Start advertising.
1418 * @param[in] adv_idx: Advertising index, range is 0 to 4.
1419 * @param[in] p_timeout: Advertising timing parameter.
1420 *
1421 * @retval SDK_SUCCESS: Operation is successful.
1422 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1423 * @retval SDK_ERR_INVALID_ADV_IDX: Invalid advertising index supplied.
1424 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1425 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1426 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1427 *
1428 * @note If advertising mode is directed high duty cycle mode, duration should be set nonzero and not be greater than 1.28s.
1429 * @note This API is asynchronous.
1430 * @note If the field scan_req_ind_en in @ref ble_gap_adv_param_t is TRUE passed in @ref ble_gap_adv_param_set function, or if the
1431 GAP_ADV_PROP_SCAN_REQ_NTF_EN_BIT is set in @ref ble_gap_adv_prop_t and passed in @ref ble_gap_ext_adv_param_set function,
1432 @ref BLE_GAPM_EVT_SCAN_REQUEST event will be triggered once a scan request has been received.
1433 * @note @ref BLE_GAPM_EVT_ADV_START event will be triggered once the operation has completed.
1434 ****************************************************************************************
1435 */
1436 uint16_t ble_gap_adv_start(uint8_t adv_idx, ble_gap_adv_time_param_t* p_timeout);
1437
1438 /**
1439 ****************************************************************************************
1440 * @brief Stop advertising.
1441 * @param[in] adv_idx: Advertising index, range is 0 to 4.
1442 *
1443 * @retval SDK_SUCCESS: Operation is successful.
1444 * @retval SDK_ERR_INVALID_ADV_IDX: Invalid advertising index supplied.
1445 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1446 *
1447 * @note This API is asynchronous.
1448 * @note event @ref BLE_GAPM_EVT_ADV_STOP will be triggered once the operation has completed or advertising has been stopped.
1449 ****************************************************************************************
1450 */
1451 uint16_t ble_gap_adv_stop(uint8_t adv_idx);
1452
1453 /**
1454 ****************************************************************************************
1455 * @brief Set parameters for scanning. Note that this function must be called prior to scanning started.
1456 * @param[in] own_addr_type: Own BD address source of the local device.
1457 * @param[in] p_scan_param: The scanning parameters.
1458 *
1459 * @retval SDK_SUCCESS: Operation is successful.
1460 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1461 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1462 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1463 *
1464 * @note This API is for legacy scanning (BT Core Spec version <= 4.2).
1465 ****************************************************************************************
1466 */
1467 uint16_t ble_gap_scan_param_set(ble_gap_own_addr_t own_addr_type, ble_gap_scan_param_t* p_scan_param);
1468
1469 /**
1470 ****************************************************************************************
1471 * @brief Set extended parameters for scanning. Note that this function must be called prior to scanning started.
1472 * @param[in] own_addr_type: Own BD address source of the local device.
1473 * @param[in] p_scan_param: The scanning parameters.
1474 *
1475 * @retval SDK_SUCCESS: Operation is successful.
1476 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1477 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1478 *
1479 * @note This API is for extended scanning (BT Core Spec version >= 5.0).
1480 * The Scan window in p_scan_param should be enough to recieve one packet. For example.
1481 * If you want to recieve packects with 1270 bytes on coded phy(S8), the scan_wd should be greater than 82ms.
1482 * If you want to recieve packects with 1270 bytes on coded phy(S2), the scan_wd should be greater than 21ms.
1483 ****************************************************************************************
1484 */
1485 uint16_t ble_gap_ext_scan_param_set(ble_gap_own_addr_t own_addr_type, ble_gap_ext_scan_param_t* p_scan_param);
1486
1487 /**
1488 ****************************************************************************************
1489 * @brief Start scanning
1490 * @note This API is asynchronous.
1491 * @note Once the advertising report has been received, the event @ref BLE_GAPM_EVT_ADV_REPORT will be called.
1492 * @note Once the scanning has been stopped, the event @ref BLE_GAPM_EVT_SCAN_STOP will be called.
1493 * @note Once the operation has completed, the event @ref BLE_GAPM_EVT_SCAN_START will be called.
1494 *
1495 * @retval SDK_SUCCESS: Operation is successful.
1496 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1497 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1498 *
1499 ****************************************************************************************
1500 */
1501 uint16_t ble_gap_scan_start(void);
1502
1503 /**
1504 ****************************************************************************************
1505 * @brief Stop scanning
1506 *
1507 * @retval SDK_SUCCESS: Operation is successful.
1508 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1509 *
1510 * @note This API is asynchronous.
1511 * @note event @ref BLE_GAPM_EVT_SCAN_STOP will be triggered once the operation has completed or the scanning has been stopped.
1512 ****************************************************************************************
1513 */
1514 uint16_t ble_gap_scan_stop(void);
1515
1516 /**
1517 ****************************************************************************************
1518 * @brief Set the parameters used for periodic sync.
1519 * @param[in] per_sync_idx: Periodic synchronization index (range is 0 to 4).
1520 * @param[in] p_per_sync_param: Periodic synchronization parameters.
1521 *
1522 * @retval SDK_SUCCESS: Operation is successful.
1523 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1524 * @retval SDK_ERR_INVALID_PER_SYNC_IDX: Invalid periodic syncronization index supplied.
1525 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1526 ****************************************************************************************
1527 */
1528 uint16_t ble_gap_per_sync_param_set(uint8_t per_sync_idx, ble_gap_per_sync_param_t* p_per_sync_param);
1529
1530 /**
1531 ****************************************************************************************
1532 * @brief Start to synchronize with periodic advertising from an advertiser and begin receiving periodic advertising packets.
1533 * @param[in] per_sync_idx: Periodic synchronization index (range is 0 to 4).
1534 *
1535 * @retval SDK_SUCCESS: Operation is successful.
1536 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1537 * @retval SDK_ERR_INVALID_PER_SYNC_IDX: Invalid periodic syncronization index supplied.
1538 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1539 *
1540 * @note This API is asynchronous.
1541 * @note event @ref BLE_GAPM_EVT_SYNC_ESTABLISH will be triggered once the periodic advertising synchronization has been established.
1542 ****************************************************************************************
1543 */
1544 uint16_t ble_gap_per_sync_start(uint8_t per_sync_idx);
1545
1546 /**
1547 ****************************************************************************************
1548 * @brief Stop periodic synchronization.
1549 * @param[in] per_sync_idx: Periodic synchronization index (range is 0 to 4).
1550 *
1551 * @retval SDK_SUCCESS: Operation is successful.
1552 * @retval SDK_ERR_INVALID_PER_SYNC_IDX: Invalid periodic syncronization index supplied.
1553 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1554 *
1555 * @note This API is asynchronous.
1556 * @note event @ref BLE_GAPM_EVT_SYNC_STOP will be triggered once the operation has completed.
1557 ****************************************************************************************
1558 */
1559 uint16_t ble_gap_per_sync_stop(uint8_t per_sync_idx);
1560
1561 /**
1562 ****************************************************************************************
1563 * @brief Start a legacy connection to a device.
1564 * @param[in] own_addr_type: Own BD address source of the local device.
1565 * @param[in] p_init_param: Initiate parameters.
1566 *
1567 * @retval SDK_SUCCESS: Operation is successful.
1568 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1569 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1570 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1571 *
1572 * @note This API is for legacy connection (BT Core Spec version <= 4.2).
1573 *
1574 * @note This API is asynchronous.
1575 * @note event @ref BLE_GAPC_EVT_CONNECTED will be triggered once the operation has completed or the connection has been completed.
1576 * @note event @ref BLE_GAPC_EVT_PEER_NAME_GOT will be triggered once the peer name has been got for the
1577 Name Discovery Procedure. See enum @ref BLE_GAP_INIT_TYPE_NAME_DISC of type @ref ble_gap_init_type_t.
1578 ****************************************************************************************
1579 */
1580 uint16_t ble_gap_connect(ble_gap_own_addr_t own_addr_type, ble_gap_init_param_t* p_init_param);
1581
1582 /**
1583 ****************************************************************************************
1584 * @brief Start an extended connection to a device.
1585 * @param[in] own_addr_type: Own BD address source of the local device.
1586 * @param[in] p_init_param: Initiate parameters.
1587 *
1588 * @retval SDK_SUCCESS: Operation is successful.
1589 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1590 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1591 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1592 *
1593 * @note This API is for extended connection (BT Core Spec version >= 5.0).
1594 *
1595 * @note This API is asynchronous.
1596 * @note event @ref BLE_GAPC_EVT_CONNECTED will be triggered once the operation has completed or the connection has been completed.
1597 ****************************************************************************************
1598 */
1599 uint16_t ble_gap_ext_connect(ble_gap_own_addr_t own_addr_type, ble_gap_ext_init_param_t* p_init_param);
1600
1601 /**
1602 ****************************************************************************************
1603 * @brief Cancel an initiated connection.
1604 *
1605 * @retval SDK_SUCCESS: Operation is successful.
1606 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1607 *
1608 * @note This API is asynchronous.
1609 * @note event @ref BLE_GAPC_EVT_CONNECT_CANCLE will be triggered once the operation has completed.
1610 ****************************************************************************************
1611 */
1612 uint16_t ble_gap_connect_cancel(void);
1613
1614 /**
1615 ****************************************************************************************
1616 * @brief Set GAP appearance value.
1617 * @param[in] appearance: Appearance value.
1618 ****************************************************************************************
1619 */
1620 void ble_gap_appearance_set(uint16_t appearance);
1621
1622 /**
1623 ****************************************************************************************
1624 * @brief Get GAP appearance value.
1625 * @param[out] p_appearance: The pointer to appearance value.
1626 *
1627 * @retval SDK_SUCCESS: Operation is successful.
1628 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1629 ****************************************************************************************
1630 */
1631 uint16_t ble_gap_appearance_get(uint16_t *p_appearance);
1632
1633 /**
1634 ****************************************************************************************
1635 * @brief Set GAP Peripheral Preferred Connection Parameters.
1636 * @param[in] p_conn_params: The pointer to PPCP values.
1637 *
1638 * @retval SDK_SUCCESS: Operation is successful.
1639 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1640 ****************************************************************************************
1641 */
1642 uint16_t ble_gap_ppcp_set(ble_gap_conn_param_t const *p_conn_params);
1643
1644 /**
1645 ****************************************************************************************
1646 * @brief Get GAP Peripheral Preferred Connection Parameters.
1647 * @param[out] p_conn_params: The pointer to PPCP values.
1648 *
1649 * @retval SDK_SUCCESS: Operation is successful.
1650 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1651 ****************************************************************************************
1652 */
1653 uint16_t ble_gap_ppcp_get(ble_gap_conn_param_t *p_conn_params);
1654
1655 /**
1656 ****************************************************************************************
1657 * @brief Set GAP device name.
1658 * @param[in] write_perm: Write permissions of the device name characteristic.
1659 * @param[in] p_dev_name: The pointer to device name value. If p_dev_name is NULL, this function will only set write permissions of the device name.
1660 * @param[in] length: Device name length.
1661 *
1662 * @retval SDK_SUCCESS: Operation is successful.
1663 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1664 ****************************************************************************************
1665 */
1666 uint16_t ble_gap_device_name_set(ble_gap_dev_name_write_perm_t write_perm, uint8_t const *p_dev_name, uint16_t length);
1667
1668 /**
1669 ****************************************************************************************
1670 * @brief Get GAP device name.
1671 * @param[out] p_dev_name: The pointer to device name value, set to NULL to obtain the complete device name length.
1672 * @param[in, out] p_length: Length of the buffer pointed by p_dev_name, complete device name length on output.
1673 *
1674 * @retval SDK_SUCCESS: Operation is successful.
1675 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1676 * @retval SDK_ERR_INVALID_DATA_LENGTH: Invalid data size(s) supplied.
1677 *
1678 * @note If device name was not set, the default device name "GOODIX_BLE" will be available.
1679 * @note If the device name is longer than the size of the supplied buffer,p_len will return the complete device name length,
1680 * and not the number of bytes actually returned in p_dev_name.
1681 * The application may use this information to allocate a suitable buffer size.
1682 ****************************************************************************************
1683 */
1684 uint16_t ble_gap_device_name_get(uint8_t *p_dev_name, uint16_t *p_length);
1685
1686 /**
1687 ****************************************************************************************
1688 * @brief Register a LE Protocol/Service Multiplexer.
1689 * @param[in] p_lepsm: The lepsm information to be registerred.
1690 *
1691 * @retval SDK_SUCCESS: Operation is successful.
1692 * @retval SDK_ERR_POINTER_NULL: Invalid pointer supplied.
1693 * @retval SDK_ERR_INVALID_PSM_NUM: Invalid psm number.
1694 * @retval SDK_ERR_INVALID_PSM_EXCEEDED_MAX_PSM_NUM: The maximum psm number limit is exceeded.
1695 * @retval SDK_ERR_INVALID_PSM_ALREADY_REGISTERED: The psm number has been registered.
1696 *
1697 * @note This API is asynchronous.
1698 * @ref BLE_GAPM_EVT_LEPSM_REGISTER event with op_id: @ref BLE_GAP_OPCODE_LEPSM_REGISTER will be triggered.
1699 ****************************************************************************************
1700 */
1701 uint16_t ble_gap_lepsm_register(ble_gap_lepsm_register_t* p_lepsm);
1702
1703 /**
1704 ****************************************************************************************
1705 * @brief Unregister a LE Protocol/Service Multiplexer.
1706 * @param[in] le_psm: LE Protocol/Service Multiplexer (1 to 255).
1707 *
1708 * @retval SDK_SUCCESS: Operation is successful.
1709 * @retval SDK_ERR_INVALID_PSM_NUM: Invalid psm number.
1710 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1711 *
1712 * @note This API is asynchronous.
1713 * @ref BLE_GAPM_EVT_LEPSM_UNREGISTER event with op_id: @ref BLE_GAP_OPCODE_LEPSM_UNREGISTER will be triggered.
1714 ****************************************************************************************
1715 */
1716 uint16_t ble_gap_lepsm_unregister(uint16_t le_psm);
1717
1718 /**
1719 ****************************************************************************************
1720 * @brief Set privacy mode for peer device.
1721 * @param[in] peer_addr: The peer address.
1722 * @param[in] mode: Privacy mode (see @ref ble_gap_privacy_mode_t).
1723 *
1724 * @retval SDK_SUCCESS: Operation is successful.
1725 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1726 * @retval SDK_ERR_DISALLOWED: Operation is disallowed.
1727 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1728 *
1729 ****************************************************************************************
1730 */
1731 uint16_t ble_gap_privacy_mode_set(ble_gap_bdaddr_t peer_addr, ble_gap_privacy_mode_t mode);
1732
1733 /**
1734 ****************************************************************************************
1735 * @brief Read peer or local resolvable address, this address generated by controller.
1736 * @param[in] op_code: The operation code (see @ref ble_gap_rslv_addr_read_op_id_t).
1737 * @param[in] peer_iden_addr: The peer identity address.
1738 *
1739 * @retval SDK_SUCCESS: Operation is successful.
1740 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1741 *
1742 ****************************************************************************************
1743 */
1744 uint16_t ble_gap_rslv_addr_read(ble_gap_rslv_addr_read_op_id_t op_code, ble_gap_bdaddr_t peer_iden_addr);
1745
1746 /**
1747 ****************************************************************************************
1748 * @brief Control periodic advertising report.
1749 * @param[in] per_sync_index: The index of the periodic syncronization instance.
1750 * @param[in] enable_flag: Per adv report flag.
1751 * bit0: Reporting enabled(true report or false not report).
1752 * bit1: Duplicate filtering enabled.
1753 *
1754 * @retval SDK_SUCCESS: Operation is successful.
1755 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1756 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1757 ****************************************************************************************
1758 */
1759 uint16_t ble_gap_per_adv_report_ctrl(uint8_t per_sync_index, bool enable_flag);
1760
1761 /**
1762 ****************************************************************************************
1763 * @brief Set connectionless CTE transmit parameters.
1764 * @param[in] per_adv_index: The index of the periodic advertising.
1765 * @param[in] param: Connectionless CTE transmit arameters.
1766 *
1767 * @retval SDK_SUCCESS: Operation is successful.
1768 * @retval SDK_ERR_INVALID_ADV_IDX: Invalid advertising index supplied.
1769 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1770 ****************************************************************************************
1771 */
1772 uint16_t ble_gap_connless_cte_trans_param_set(uint8_t per_adv_index, gap_connless_cte_trans_param_t *param);
1773
1774 /**
1775 ****************************************************************************************
1776 * @brief Set connectionless CTE transmit enable.
1777 * @param[in] per_adv_index: The index of the periodic advertising.
1778 * @param[in] enable_flag: Whether enable to transmit connectionless cte.
1779 *
1780 * @retval SDK_SUCCESS: Operation is successful.
1781 * @retval SDK_ERR_INVALID_ADV_IDX: Invalid advertising index supplied.
1782 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1783 ****************************************************************************************
1784 */
1785 uint16_t ble_gap_connless_cte_trans_enable_set(uint8_t per_adv_index, bool enable_flag);
1786
1787 /**
1788 ****************************************************************************************
1789 * @brief Set connectionless IQ sampling enable.
1790 * @param[in] per_sync_index: The index of the periodic syncronization instance.
1791 * @param[in] enable_flag: Whether enable connectionless iq sampling. if enable_flag is false, the param shall be NULL.
1792 * @param[in] param: Enable connectionless iq sampling parameters (see @ref ble_gap_connless_iq_sample_param_t).
1793 *
1794 * @retval SDK_SUCCESS: Operation is successful.
1795 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1796 * @retval SDK_ERR_INVALID_PER_SYNC_IDX: Invalid periodic synchronization index supplied.
1797 * @retval SDK_ERR_NO_RESOURCES: Not enough resources.
1798 ****************************************************************************************
1799 */
1800 uint16_t ble_gap_connless_iq_sample_enable_set(uint8_t per_sync_index, bool enable_flag, ble_gap_connless_iq_sample_param_t *param);
1801
1802 /**
1803 ****************************************************************************************
1804 * @brief Register connectionless iq report event callback.
1805 *
1806 * @param[in] cb: The callback for connectionless IQ report event.
1807 *
1808 * @retval void.
1809 ****************************************************************************************
1810 */
1811 void ble_gap_register_conless_iq_report_cb(void (*cb)(uint8_t per_sync_idx, const ble_gap_connless_iq_report_t *iq_report));
1812
1813 /**
1814 ****************************************************************************************
1815 * @brief Set ranging parameter.
1816 *
1817 * @param[in] base_addr: The base address.
1818 * @param[in] cte_len: The length for cte.
1819 *
1820 * @retval SDK_SUCCESS: Operation is successful.
1821 * @retval SDK_ERR_INVALID_PARAM: Invalid parameter supplied.
1822 ****************************************************************************************
1823 */
1824 uint16_t ble_gap_set_gdx_ranging_param(uint32_t base_addr, uint8_t cte_len);
1825
1826 /** @} */
1827
1828 #endif
1829 /** @} */
1830
1831 /** @} */
1832 /** @} */
ble_gap_evt_sync_established_t::phy
uint8_t phy
PHY on which synchronization has been established.
Definition: ble_gapm.h:909
ble_gap_per_sync_type_t
ble_gap_per_sync_type_t
Periodic synchronization types.
Definition: ble_gapm.h:397
ble_gap_rslv_addr_read
uint16_t ble_gap_rslv_addr_read(ble_gap_rslv_addr_read_op_id_t op_code, ble_gap_bdaddr_t peer_iden_addr)
Read peer or local resolvable address, this address generated by controller.
BLE_GAP_NO_SYNC_IGNORE
@ BLE_GAP_NO_SYNC_IGNORE
The presence or absence of a Constant Tone Extension is irrelevant.
Definition: ble_gapm.h:408
BLE_GAP_AD_TYPE_RQRD_32_BIT_SVC_UUID
@ BLE_GAP_AD_TYPE_RQRD_32_BIT_SVC_UUID
Require 32-bit service UUID.
Definition: ble_gapm.h:477
BLE_GAP_ROLE_PERIPHERAL
@ BLE_GAP_ROLE_PERIPHERAL
Peripheral/Slave role.
Definition: ble_gapm.h:163
BLE_GAP_ADV_PROP_SCANNABLE_POS
@ BLE_GAP_ADV_PROP_SCANNABLE_POS
Indicate that advertising is scannable, reception of SCAN_REQ or AUX_SCAN_REQ PDUs is accepted.
Definition: ble_gapm.h:277
BLE_GAP_PRIVACY_MODE_NETWORK
@ BLE_GAP_PRIVACY_MODE_NETWORK
Set to the network privacy mode for the peer device.
Definition: ble_gapm.h:540
ble_gap_adv_second_cfg_t::max_skip
uint8_t max_skip
Maximum number of advertising events the controller can skip before sending the AUX_ADV_IND packets.
Definition: ble_gapm.h:604
ble_gap_ext_init_param_t::conn_to
uint16_t conn_to
Timeout for automatic connection establishment (in unit of 10ms).
Definition: ble_gapm.h:785
ble_gap_ext_init_param_t::scan_param_1m
ble_gap_scan_wd_op_param_t scan_param_1m
Scan window opening parameters for LE 1M PHY.
Definition: ble_gapm.h:788
ble_gap_pref_phy_set
void ble_gap_pref_phy_set(uint8_t tx_pref_phy, uint8_t rx_pref_phy)
Set the preferred values for the transmitter PHY and receiver PHY.
ble_gap_bond_dev_list_t::items
ble_gap_bdaddr_t * items
Bonded device addr info.
Definition: ble_gapm.h:812
ble_gap_per_adv_list_del
uint16_t ble_gap_per_adv_list_del(const ble_gap_period_adv_list_t *p_pal_list)
Delete the devices out of periodic advertising list.
BLE_GAP_PHY_CODED_VALUE
@ BLE_GAP_PHY_CODED_VALUE
LE Coded PHY.
Definition: ble_gapm.h:257
ble_gap_ext_scan_param_t::dup_filt_pol
uint8_t dup_filt_pol
Duplicate packet filtering policy (see enum ble_gap_ext_scan_dup_filt_policy_t).
Definition: ble_gapm.h:687
gap_sync_cte_type
gap_sync_cte_type
Constant Tone Extension sync filtering type.
Definition: ble_gapm.h:407
ble_gap_init_param_t::sup_timeout
uint16_t sup_timeout
Link supervision timeout (in unit of 10ms).
Definition: ble_gapm.h:757
BLE_GAP_AD_TYPE_TRANSMIT_POWER
@ BLE_GAP_AD_TYPE_TRANSMIT_POWER
Transmit power.
Definition: ble_gapm.h:469
BLE_GAP_NO_SYNC_WITH_AOD_2US_SLOT
@ BLE_GAP_NO_SYNC_WITH_AOD_2US_SLOT
Do not sync to packets with an AoD Constant Tone Extension with 2us slots.
Definition: ble_gapm.h:411
BLE_GAP_ACTV_TYPE_INIT
@ BLE_GAP_ACTV_TYPE_INIT
Definition: ble_gapm.h:562
BLE_GAP_SCAN_GEN_DISC_MODE
@ BLE_GAP_SCAN_GEN_DISC_MODE
General discoverable mode.
Definition: ble_gapm.h:323
ble_gap_whitelist_add
uint16_t ble_gap_whitelist_add(const ble_gap_white_list_t *p_whitelist)
Add the devices into current white list.
ble_gap_adv_prim_cfg_t
Configuration for advertising on primary channel.
Definition: ble_gapm.h:591
ble_gap_irk_set
uint16_t ble_gap_irk_set(ble_gap_sec_key_t *p_irk)
Set IRK used for resolvable random BD address generation (LSB first).
ble_gap_ral_dev_list_t::offset
uint8_t offset
offset of RPA list.
Definition: ble_gapm.h:849
ble_gap_ppcp_get
uint16_t ble_gap_ppcp_get(ble_gap_conn_param_t *p_conn_params)
Get GAP Peripheral Preferred Connection Parameters.
ble_gap_scan_wd_op_param_t
Scan Window operation parameters.
Definition: ble_gapm.h:675
ble_gap_adv_param_t::peer_addr
ble_gap_bdaddr_t peer_addr
Peer address configuration (only used in case of directed advertising, or used to locate the IRK list...
Definition: ble_gapm.h:578
ble_gap_evt_scan_req_t::peer_addr
ble_gap_bdaddr_t peer_addr
Peer address.
Definition: ble_gapm.h:879
BLE_GAP_ACTIVITY_ROLE_ADV
@ BLE_GAP_ACTIVITY_ROLE_ADV
Adertise role.
Definition: ble_gapm.h:549
BLE_GAP_REPORT_TYPE_PER_ADV
@ BLE_GAP_REPORT_TYPE_PER_ADV
Periodic advertising report.
Definition: ble_gapm.h:502
BLE_GAP_SEC_LVL_LE_ENC_AUTH
@ BLE_GAP_SEC_LVL_LE_ENC_AUTH
Legacy encryption with auth.
Definition: ble_gapm.h:451
ble_gap_ext_adv_param_t::max_tx_pwr
int8_t max_tx_pwr
Maximum power level at which the advertising packets have to be transmitted (support value:[-20,...
Definition: ble_gapm.h:628
BLE_GAP_GET_MAX_LE_ADV_DATA_LEN
@ BLE_GAP_GET_MAX_LE_ADV_DATA_LEN
Get maximum data length for advertising data.
Definition: ble_gapm.h:213
BLE_GAP_ADV_ALLOW_SCAN_WLST_CON_ANY
@ BLE_GAP_ADV_ALLOW_SCAN_WLST_CON_ANY
Allow scan req from white-list devices only and connection req from anyone.
Definition: ble_gapm.h:244
ble_gap_ext_adv_param_t::prim_cfg
ble_gap_adv_prim_cfg_t prim_cfg
Configuration for primary advertising.
Definition: ble_gapm.h:631
BLE_GAP_SEC_LVL_NO_SECURITY
@ BLE_GAP_SEC_LVL_NO_SECURITY
No encryption or auth.
Definition: ble_gapm.h:449
BLE_GAP_ROLE_BROADCASTER
@ BLE_GAP_ROLE_BROADCASTER
Broadcaster role.
Definition: ble_gapm.h:161
ble_gap_scan_start
uint16_t ble_gap_scan_start(void)
Start scanning.
ble_gap_scan_param_t
Parameters for legacy scanning.
Definition: ble_gapm.h:661
BLE_GAP_ADV_PROP_PER_TX_PWR_POS
@ BLE_GAP_ADV_PROP_PER_TX_PWR_POS
Include TX power in the periodic advertising PDU.
Definition: ble_gapm.h:288
BLE_GAP_SYNC_REP_EN_DUP
@ BLE_GAP_SYNC_REP_EN_DUP
synchronize to the periodic advertising, per adv report events will be enabled, duplicate filtering e...
Definition: ble_gapm.h:422
ble_gap_white_list_t
White list.
Definition: ble_gapm.h:819
BLE_GAP_AD_TYPE_MORE_32_BIT_UUID
@ BLE_GAP_AD_TYPE_MORE_32_BIT_UUID
Use of more than 32-bit UUD.
Definition: ble_gapm.h:463
BLE_GAP_REPORT_INFO_CONN_ADV_BIT
@ BLE_GAP_REPORT_INFO_CONN_ADV_BIT
Connectable advertising.
Definition: ble_gapm.h:509
ble_gap_privacy_mode_t
ble_gap_privacy_mode_t
Privacy mode.
Definition: ble_gapm.h:539
ble_gapm_evt_t::rslv_addr_report
ble_gap_evt_rslv_addr_report_t rslv_addr_report
Resolvable Address report parameter, generated by host.
Definition: ble_gapm.h:944
BLE_GAP_EXT_SCAN_TYPE_LIM_DISC
@ BLE_GAP_EXT_SCAN_TYPE_LIM_DISC
Limited discovery.
Definition: ble_gapm.h:343
ble_gap_ext_scan_param_t::rsvd
uint8_t rsvd
Reserved for future use.
Definition: ble_gapm.h:688
BLE_GAP_ADV_PROP_HDC_BIT
@ BLE_GAP_ADV_PROP_HDC_BIT
Definition: ble_gapm.h:301
BLE_GAP_WRITE_PERM_UNAUTH
@ BLE_GAP_WRITE_PERM_UNAUTH
LE Security Mode 1, Level 2.
Definition: ble_gapm.h:184
BLE_GAP_ROLE_CENTRAL
@ BLE_GAP_ROLE_CENTRAL
Master/Central role.
Definition: ble_gapm.h:162
BLE_GAP_ADV_PROP_TX_PWR_BIT
@ BLE_GAP_ADV_PROP_TX_PWR_BIT
Definition: ble_gapm.h:304
BLE_GAP_ADV_TYPE_LEGACY
@ BLE_GAP_ADV_TYPE_LEGACY
Legacy advertising.
Definition: ble_gapm.h:265
BLE_GAP_ADV_PROP_SCAN_REQ_NTF_EN_POS
@ BLE_GAP_ADV_PROP_SCAN_REQ_NTF_EN_POS
Indicate if application must be informed about receiving scan request PDUs.
Definition: ble_gapm.h:290
ble_gap_scan_dup_filt_policy_t
ble_gap_scan_dup_filt_policy_t
Duplicate filter policy.
Definition: ble_gapm.h:332
BLE_GAP_ROLE_ALL
@ BLE_GAP_ROLE_ALL
Device has all roles, both peripheral and central.
Definition: ble_gapm.h:164
ble_gap_addr_t
The struct of address.
Definition: ble_gapc.h:271
BLE_GAP_ACTV_TYPE_SCAN
@ BLE_GAP_ACTV_TYPE_SCAN
Definition: ble_gapm.h:561
gap_connless_cte_trans_param_t::num_antenna
uint8_t num_antenna
The number of Antenna IDs in the pattern (range 0x02 to 0x4B).
Definition: ble_gapm.h:729
BLE_GAP_GET_DEV_BDADDR
@ BLE_GAP_GET_DEV_BDADDR
Get local device BD Address.
Definition: ble_gapm.h:204
ble_gap_adv_data_type_t
ble_gap_adv_data_type_t
Advertising data type.
Definition: ble_gapm.h:193
ble_gap_dev_info_get
uint16_t ble_gap_dev_info_get(ble_gap_dev_info_get_type_t type)
Get the device information according to param type.
ble_gap_ext_conn_param_t::conn_latency
uint16_t conn_latency
Slave latency.
Definition: ble_gapm.h:773
BLE_GAP_GET_DEV_VERSION
@ BLE_GAP_GET_DEV_VERSION
Get version information for the local Controller.
Definition: ble_gapm.h:203
ble_gap_ext_adv_param_t::peer_addr
ble_gap_bdaddr_t peer_addr
Peer address configuration (only used in case of directed advertising or used to locate the IRK list)...
Definition: ble_gapm.h:630
BLE_GAP_ADV_FLAG_BR_EDR_NOT_SUPPORTED
@ BLE_GAP_ADV_FLAG_BR_EDR_NOT_SUPPORTED
Legacy BT not supported: AD Flag.
Definition: ble_gapm.h:529
ble_gap_connect_cancel
uint16_t ble_gap_connect_cancel(void)
Cancel an initiated connection.
BLE_GAP_AD_TYPE_COMPLETE_NAME
@ BLE_GAP_AD_TYPE_COMPLETE_NAME
Complete Device name.
Definition: ble_gapm.h:468
BLE_GAP_GET_ANTENNA_INFO
@ BLE_GAP_GET_ANTENNA_INFO
Get antenna information.
Definition: ble_gapm.h:216
BLE_GAP_ACTV_TYPE_ADV
@ BLE_GAP_ACTV_TYPE_ADV
Definition: ble_gapm.h:560
ble_gap_pair_enable
void ble_gap_pair_enable(bool enable)
Decide whether to support the pair feature.
ble_gap_bdaddr_t
The struct of broadcast address with broadcast type.
Definition: ble_gapc.h:277
ble_gap_evt_adv_report_t::length
uint16_t length
Report length.
Definition: ble_gapm.h:902
gap_connless_cte_trans_param_t
Set connectionless CTE transmit parameters.
Definition: ble_gapm.h:725
BLE_GAP_OWN_ADDR_STATIC
@ BLE_GAP_OWN_ADDR_STATIC
Public or Private Static Address according to device address configuration.
Definition: ble_gapm.h:172
BLE_GAP_ADV_FLAG_LE_GENERAL_DISC_MODE
@ BLE_GAP_ADV_FLAG_LE_GENERAL_DISC_MODE
General discovery flag: AD Flag.
Definition: ble_gapm.h:528
ble_gap_lepsm_register_t::mks_flag
bool mks_flag
Whether to use maximum-size key (16 bytes) or not.
Definition: ble_gapm.h:803
ble_gap_dev_info_t
Device info.
Definition: ble_gapc.h:354
ble_gap_ext_adv_param_t::disc_mode
uint8_t disc_mode
Discovery mode (see enum ble_gap_disc_mode_t).
Definition: ble_gapm.h:626
BLE_GAP_SCAN_ACTIVE
@ BLE_GAP_SCAN_ACTIVE
Active scan type.
Definition: ble_gapm.h:314
BLE_GAP_REPORT_INFO_DIR_ADV_BIT
@ BLE_GAP_REPORT_INFO_DIR_ADV_BIT
Directed advertising.
Definition: ble_gapm.h:511
BLE_GAP_ACTIVITY_ROLE_CON
@ BLE_GAP_ACTIVITY_ROLE_CON
Connect role.
Definition: ble_gapm.h:550
BLE_GAP_AD_TYPE_MORE_16_BIT_UUID
@ BLE_GAP_AD_TYPE_MORE_16_BIT_UUID
Use of more than 16-bit UUID.
Definition: ble_gapm.h:461
BLE_GAP_ADV_ALLOW_SCAN_WLST_CON_WLST
@ BLE_GAP_ADV_ALLOW_SCAN_WLST_CON_WLST
Allow scan and connection requests from white-list devices only.
Definition: ble_gapm.h:246
ble_gap_per_adv_report_ctrl
uint16_t ble_gap_per_adv_report_ctrl(uint8_t per_sync_index, bool enable_flag)
Control periodic advertising report.
ble_gap_ral_dev_list_t
RPA list info.
Definition: ble_gapm.h:848
BLE_GAP_SLOT_DURA_2US
@ BLE_GAP_SLOT_DURA_2US
Switching and sampling slots are 2 us each.
Definition: ble_gapm.h:441
BLE_GAP_OWN_ADDR_GEN_RSLV
@ BLE_GAP_OWN_ADDR_GEN_RSLV
Generated resolvable private random address.
Definition: ble_gapm.h:173
ble_gap_evt_adv_report_t
Advertising report event for BLE_GAPM_EVT_ADV_REPORT.
Definition: ble_gapm.h:890
ble_gap_per_sync_param_t::sync_to
uint16_t sync_to
Synchronization timeout for the periodic advertising (in unit of 10ms between 100ms and 163....
Definition: ble_gapm.h:713
BLE_GAP_SCAN_LIM_DISC_MODE
@ BLE_GAP_SCAN_LIM_DISC_MODE
Limited discoverable mode.
Definition: ble_gapm.h:324
ble_gap_bond_devs_clear
uint16_t ble_gap_bond_devs_clear(void)
Clear all bonded devices.
BLE_GAP_ADV_PROP_TX_PWR_POS
@ BLE_GAP_ADV_PROP_TX_PWR_POS
Include TX power in the extended header of the advertising PDU.
Definition: ble_gapm.h:286
ble_gap_adv_prim_cfg_t::chnl_map
uint8_t chnl_map
Bit field indicating the channel map.
Definition: ble_gapm.h:594
ble_gap_adv_param_t::max_tx_pwr
int8_t max_tx_pwr
Maximum power level at which the advertising packets have to be transmitted (between -127 dBm and 127...
Definition: ble_gapm.h:583
gap_switch_sampling_rate
gap_switch_sampling_rate
Supported AoA AoD switching sampling rate.
Definition: ble_gapm.h:429
ble_gap_adv_time_param_t
Advertising timing parameter.
Definition: ble_gapm.h:640
BLE_GAP_AD_TYPE_SERVICE_16_BIT_DATA
@ BLE_GAP_AD_TYPE_SERVICE_16_BIT_DATA
Service data 16-bit UUID.
Definition: ble_gapm.h:479
BLE_GAP_AD_TYPE_LE_BT_ADDR
@ BLE_GAP_AD_TYPE_LE_BT_ADDR
LE Bluetooth Device Address.
Definition: ble_gapm.h:486
ble_gap_tx_power_get
uint16_t ble_gap_tx_power_get(ble_gap_actv_role_t role, uint8_t index, int8_t *txpwr_dbm)
Get the tx power.
ble_gap_addr_set
uint16_t ble_gap_addr_set(ble_gap_bdaddr_t const *p_addr)
Set the device identity address (public or random static).
ble_gap_adv_prop_pos_t
ble_gap_adv_prop_pos_t
Advertising properties bit field and bit positions.
Definition: ble_gapm.h:274
BLE_GAP_STOPPED_REASON_CONN_EST
@ BLE_GAP_STOPPED_REASON_CONN_EST
Stop with connection established.
Definition: ble_gapm.h:519
ble_gap_per_sync_param_t::adv_addr
ble_gap_period_adv_addr_cfg_t adv_addr
Address of advertiser with which synchronization has to be established(used only if use_pal is false)...
Definition: ble_gapm.h:716
ble_gap_period_adv_addr_cfg_t::bd_addr
ble_gap_bdaddr_t bd_addr
Advertiser address information.
Definition: ble_gapm.h:702
ble_gap_data_length_set
uint16_t ble_gap_data_length_set(uint16_t sugg_max_tx_octet, uint16_t sugg_max_tx_time)
Set suggested default LE data length.
BLE_GAP_STOPPED_REASON_TIMEOUT
@ BLE_GAP_STOPPED_REASON_TIMEOUT
Stop with timeout.
Definition: ble_gapm.h:517
ble_gap_role_t
ble_gap_role_t
GAP role options.
Definition: ble_gapm.h:158
ble_gap_period_adv_addr_cfg_t
Periodic advertising information.
Definition: ble_gapm.h:701
ble_gap_device_name_set
uint16_t ble_gap_device_name_set(ble_gap_dev_name_write_perm_t write_perm, uint8_t const *p_dev_name, uint16_t length)
Set GAP device name.
ble_gap_ext_scan_type_t
ble_gap_ext_scan_type_t
Extended scanning types.
Definition: ble_gapm.h:341
ble_gap_ext_scan_param_t::scan_param_coded
ble_gap_scan_wd_op_param_t scan_param_coded
Scan window opening parameters for LE Coded PHY.
Definition: ble_gapm.h:690
gap_per_adv_sync_info_rec_mode
gap_per_adv_sync_info_rec_mode
Periodic advertising sync information reception mode.
Definition: ble_gapm.h:419
ble_gap_ext_scan_param_t::type
uint8_t type
Type of scanning to be started (see enum ble_gap_ext_scan_type_t).
Definition: ble_gapm.h:685
ble_gap_adv_mode_t
ble_gap_adv_mode_t
GAP advertising modes.
Definition: ble_gapm.h:221
BLE_GAP_NO_SYNC_WITH_AOD_1US_SLOT
@ BLE_GAP_NO_SYNC_WITH_AOD_1US_SLOT
Do not sync to packets with an AoD Constant Tone Extension with 1us slots.
Definition: ble_gapm.h:410
ble_gap_evt_adv_report_t::adv_info
ble_gap_adv_report_info_t adv_info
Bit field providing information about the received report.
Definition: ble_gapm.h:892
BLE_GAP_ADV_PROP_ANONYMOUS_BIT
@ BLE_GAP_ADV_PROP_ANONYMOUS_BIT
Definition: ble_gapm.h:303
BLE_GAP_PHY_1MBPS_VALUE
@ BLE_GAP_PHY_1MBPS_VALUE
LE 1M PHY.
Definition: ble_gapm.h:255
ble_gap_actv_role_t
ble_gap_actv_role_t
Possible roles of the activity.
Definition: ble_gapm.h:548
ble_gap_ext_init_param_t
Extended initiating parameters.
Definition: ble_gapm.h:782
BLE_GAP_ADV_TYPE_ADV_LOW_DIRECT_IND
@ BLE_GAP_ADV_TYPE_ADV_LOW_DIRECT_IND
Directed low duty cycle mode.
Definition: ble_gapm.h:226
ble_gap_connless_cte_trans_param_set
uint16_t ble_gap_connless_cte_trans_param_set(uint8_t per_adv_index, gap_connless_cte_trans_param_t *param)
Set connectionless CTE transmit parameters.
ble_gap_le_phy_value_t
ble_gap_le_phy_value_t
Specify what PHY the Controller has changed for TX/RX.
Definition: ble_gapm.h:253
BLE_GAP_ADV_PROP_DIRECTED_BIT
@ BLE_GAP_ADV_PROP_DIRECTED_BIT
Definition: ble_gapm.h:300
ble_gap_evt_sync_established_t::clk_acc
uint8_t clk_acc
Advertiser clock accuracy.
Definition: ble_gapm.h:912
ble_gap_lepsm_register_t::sec_lvl
uint8_t sec_lvl
Security level requirement, see gap_sec_lvl_type.
Definition: ble_gapm.h:802
BLE_GAP_AD_TYPE_COMPLETE_LIST_128_BIT_UUID
@ BLE_GAP_AD_TYPE_COMPLETE_LIST_128_BIT_UUID
Complete List of 128-bit UUID.
Definition: ble_gapm.h:466
ble_gap_adv_prim_cfg_t::adv_intv_max
uint32_t adv_intv_max
Maximum advertising interval (in unit of 625 μs).
Definition: ble_gapm.h:593
BLE_GAP_ADV_PROP_SCAN_REQ_NTF_EN_BIT
@ BLE_GAP_ADV_PROP_SCAN_REQ_NTF_EN_BIT
Definition: ble_gapm.h:306
BLE_GAP_WRITE_PERM_DISABLE
@ BLE_GAP_WRITE_PERM_DISABLE
Disable write access.
Definition: ble_gapm.h:182
ble_gap_bond_dev_del
uint16_t ble_gap_bond_dev_del(const ble_gap_bdaddr_t *p_peer_addr)
Delete a bond device with the specified BD address.
ble_gap_whitelist_get
uint16_t ble_gap_whitelist_get(ble_gap_white_list_t *p_whitelist)
Get the content of the whole white list.
ble_gap_ext_conn_param_t::conn_intv_max
uint16_t conn_intv_max
Maximum value for the connection interval (in unit of 1.25ms).
Definition: ble_gapm.h:771
BLE_GAP_EXT_SCAN_TYPE_CONN_DISC
@ BLE_GAP_EXT_SCAN_TYPE_CONN_DISC
Connectable discovery.
Definition: ble_gapm.h:346
BLE_GAP_AOA_RX_1_US
@ BLE_GAP_AOA_RX_1_US
1 us switching and sampling supported for AoA reception.
Definition: ble_gapm.h:432
ble_gap_per_sync_param_t
Periodic advertising synchronization parameters.
Definition: ble_gapm.h:710
ble_gap_evt_rslv_addr_read_t
Read resolvable address event for BLE_GAPM_EVT_READ_RSLV_ADDR.
Definition: ble_gapm.h:919
ble_gap_rslv_addr_read_op_id_t
ble_gap_rslv_addr_read_op_id_t
Operation code used to read resolvable address.
Definition: ble_gapm.h:858
ble_gap_evt_dev_info_get_t::operation
uint8_t operation
Operation code.
Definition: ble_gapm.h:866
BLE_GAP_AD_TYPE_PUB_TGT_ADDR
@ BLE_GAP_AD_TYPE_PUB_TGT_ADDR
Public Target Address.
Definition: ble_gapm.h:482
BLE_GAP_GET_DEV_TX_POWER
@ BLE_GAP_GET_DEV_TX_POWER
Read the minimum and maximum transmit powers supported by the Controller.
Definition: ble_gapm.h:214
ble_gap_lepsm_register_t
LE Protocol/Service Multiplexer information.
Definition: ble_gapm.h:800
BLE_GAP_ADV_ALLOW_SCAN_ANY_CON_ANY
@ BLE_GAP_ADV_ALLOW_SCAN_ANY_CON_ANY
Allow both scan and connection requests from anyone.
Definition: ble_gapm.h:243
gap_sec_lvl_type
gap_sec_lvl_type
Security level types.
Definition: ble_gapm.h:448
ble_gap_scan_param_t::scan_type
ble_gap_scan_type_t scan_type
Active scanning or passive scanning.
Definition: ble_gapm.h:662
BLE_GAP_ADV_PROP_PER_TX_PWR_BIT
@ BLE_GAP_ADV_PROP_PER_TX_PWR_BIT
Definition: ble_gapm.h:305
ble_gap_ext_conn_param_t::conn_intv_min
uint16_t conn_intv_min
Minimum value for the connection interval (in unit of 1.25ms).
Definition: ble_gapm.h:769
BLE_GAP_ADV_DATA_TYPE_DATA
@ BLE_GAP_ADV_DATA_TYPE_DATA
Advertising data.
Definition: ble_gapm.h:194
ble_gap_per_sync_param_set
uint16_t ble_gap_per_sync_param_set(uint8_t per_sync_idx, ble_gap_per_sync_param_t *p_per_sync_param)
Set the parameters used for periodic sync.
ble_gap_per_sync_start
uint16_t ble_gap_per_sync_start(uint8_t per_sync_idx)
Start to synchronize with periodic advertising from an advertiser and begin receiving periodic advert...
ble_gap_evt_scan_req_t
Scan request info.
Definition: ble_gapm.h:878
ble_gap_adv_param_t::disc_mode
uint8_t disc_mode
Discovery mode (see enum ble_gap_disc_mode_t).
Definition: ble_gapm.h:576
gap_connless_cte_trans_param_t::cte_type
uint8_t cte_type
CTE type (0: AOA | 1: AOD-1us | 2: AOD-2us) (.
Definition: ble_gapm.h:727
ble_gap_evt_adv_report_t::adv_sid
uint8_t adv_sid
Advertising SID , valid only for periodic advertising report.
Definition: ble_gapm.h:899
BLE_GAP_NO_SYNC_WITH_AOA
@ BLE_GAP_NO_SYNC_WITH_AOA
Do not sync to packets with an AoA Constant Tone Extension.
Definition: ble_gapm.h:409
BLE_GAP_SLOT_DURA_1US
@ BLE_GAP_SLOT_DURA_1US
Switching and sampling slots are 1 us each.
Definition: ble_gapm.h:440
BLE_GAP_SCAN_PROP_FILT_TRUNC_BIT
@ BLE_GAP_SCAN_PROP_FILT_TRUNC_BIT
Filter truncated advertising or scan response reports.
Definition: ble_gapm.h:390
ble_gap_init_param_t
Legacy initiating parameters.
Definition: ble_gapm.h:749
BLE_GAP_SCAN_PROP_PHY_CODED_BIT
@ BLE_GAP_SCAN_PROP_PHY_CODED_BIT
Scan advertisement on the LE Coded PHY.
Definition: ble_gapm.h:386
BLE_GAP_ADV_PROP_SCANNABLE_BIT
@ BLE_GAP_ADV_PROP_SCANNABLE_BIT
Definition: ble_gapm.h:299
BLE_GAP_AD_TYPE_RQRD_128_BIT_SVC_UUID
@ BLE_GAP_AD_TYPE_RQRD_128_BIT_SVC_UUID
Require 128-bit service UUID.
Definition: ble_gapm.h:478
BLE_GAP_SCAN_FILT_DUPLIC_EN
@ BLE_GAP_SCAN_FILT_DUPLIC_EN
Enable filtering of duplicate packets.
Definition: ble_gapm.h:334
BLE_GAP_ADV_PROP_USE_LEGACY_PDUS_BIT
@ BLE_GAP_ADV_PROP_USE_LEGACY_PDUS_BIT
Definition: ble_gapm.h:302
BLE_GAP_REPORT_TYPE_SCAN_RSP_LEG
@ BLE_GAP_REPORT_TYPE_SCAN_RSP_LEG
Legacy scan response report.
Definition: ble_gapm.h:501
ble_gap_connless_iq_sample_param_t
Set connectionless IQ sampling enable parameter.
Definition: ble_gapm.h:737
ble_gap_per_sync_param_t::type
uint8_t type
Periodic synchronization type (see enum ble_gap_per_sync_type_t).
Definition: ble_gapm.h:714
BLE_GAP_SCAN_FILT_DUPLIC_DIS
@ BLE_GAP_SCAN_FILT_DUPLIC_DIS
Disable filtering of duplicate packets.
Definition: ble_gapm.h:333
BLE_GAP_ADV_PROP_USE_LEGACY_PDUS_POS
@ BLE_GAP_ADV_PROP_USE_LEGACY_PDUS_POS
Use legacy advertising PDUs.
Definition: ble_gapm.h:283
ble_gap_update_adv_data
uint16_t ble_gap_update_adv_data(uint8_t adv_idx, ble_gap_adv_data_type_t type, const uint8_t *p_data, uint16_t length)
Update Advertising Data, Scan Response Data and Periodic Advertising Data.
ble_gap_ext_scan_dup_filt_policy_t
ble_gap_ext_scan_dup_filt_policy_t
Filtering policy for duplicated packets.
Definition: ble_gapm.h:354
ble_gap_evt_adv_report_t::per_sync_idx
uint8_t per_sync_idx
Periodic syncronization index, valid only for periodic advertising report.
Definition: ble_gapm.h:901
BLE_GAP_ADV_TYPE_ADV_IND
@ BLE_GAP_ADV_TYPE_ADV_IND
Undirected connectable and scannable mode.
Definition: ble_gapm.h:222
ble_gap_evt_scan_stop_t
Scan Stop info struct.
Definition: ble_gapm.h:884
ble_gap_evt_scan_stop_t::reason
ble_gap_stopped_reason_t reason
The reason why the scan stopped.
Definition: ble_gapm.h:885
BLE_GAP_PHY_UNDEF_VALUE
@ BLE_GAP_PHY_UNDEF_VALUE
Undefined LE PHY.
Definition: ble_gapm.h:254
BLE_GAP_AD_TYPE_COMPLETE_LIST_16_BIT_UUID
@ BLE_GAP_AD_TYPE_COMPLETE_LIST_16_BIT_UUID
Complete List of 16-bit UUID.
Definition: ble_gapm.h:462
ble_gapm_evt_t::dev_info
ble_gap_evt_dev_info_get_t dev_info
Device info parameters.
Definition: ble_gapm.h:937
ble_gap_ext_adv_param_t::period_cfg
ble_gap_adv_period_cfg_t period_cfg
Configuration for periodic advertising (valid only if advertising type is GAP_ADV_TYPE_PERIODIC).
Definition: ble_gapm.h:633
ble_gap_evt_rslv_addr_report_t::rpa_addr
ble_gap_addr_t rpa_addr
rpa address info.
Definition: ble_gapm.h:928
BLE_GAP_PRIVACY_MODE_DEVICE
@ BLE_GAP_PRIVACY_MODE_DEVICE
Set to the device privacy mode for the peer device.
Definition: ble_gapm.h:541
BLE_GAP_SCAN_PROP_ACTIVE_CODED_BIT
@ BLE_GAP_SCAN_PROP_ACTIVE_CODED_BIT
Active scan on LE Coded PHY (scan request PDUs may be sent).
Definition: ble_gapm.h:388
CO_BIT
#define CO_BIT(pos)
Bit operation helper.
Definition: ble_gapm.h:72
ble_gapm_evt_t
BLE GAPM event structure.
Definition: ble_gapm.h:933
ble_gap_per_sync_param_t::cte_type
uint8_t cte_type
Type of Constant Tone Extension device should sync on (.
Definition: ble_gapm.h:718
ble_gap_ext_scan_param_t::prop
uint8_t prop
Properties for the scan procedure (see enum ble_gap_scan_prop_t for bit signification).
Definition: ble_gapm.h:686
ble_gap_adv_period_cfg_t::adv_intv_max
uint16_t adv_intv_max
Maximum advertising interval (in unit of 1.25 ms).
Definition: ble_gapm.h:616
BLE_GAP_ACTIVITY_ROLE_SCAN_INIT
@ BLE_GAP_ACTIVITY_ROLE_SCAN_INIT
Scann role.
Definition: ble_gapm.h:551
BLE_GAP_DISC_MODE_BROADCASTER
@ BLE_GAP_DISC_MODE_BROADCASTER
Broadcaster mode.
Definition: ble_gapm.h:235
ble_gap_actv_type_t
ble_gap_actv_type_t
Activity type.
Definition: ble_gapm.h:559
BLE_GAP_ADV_PROP_ANONYMOUS_POS
@ BLE_GAP_ADV_PROP_ANONYMOUS_POS
Enable anonymous mode.
Definition: ble_gapm.h:284
BLE_GAP_ADV_FLAG_LE_LIMITED_DISC_MODE
@ BLE_GAP_ADV_FLAG_LE_LIMITED_DISC_MODE
Limited discovery flag: AD Flag.
Definition: ble_gapm.h:527
ble_gap_adv_param_t::adv_mode
uint8_t adv_mode
Advertising mode (see enum ble_gap_adv_mode_t).
Definition: ble_gapm.h:575
ble_gapm_evt_t::scan_req
ble_gap_evt_scan_req_t scan_req
Scan Request parameter.
Definition: ble_gapm.h:939
ble_gap_period_adv_addr_cfg_t::adv_sid
uint8_t adv_sid
Advertising SID.
Definition: ble_gapm.h:703
ble_gap_ext_adv_param_t::prop
uint16_t prop
Bit field value provided by advertising properties.
Definition: ble_gapm.h:627
BLE_GAP_ADV_ALLOW_SCAN_ANY_CON_WLST
@ BLE_GAP_ADV_ALLOW_SCAN_ANY_CON_WLST
Allow scan req from anyone and connection req from white-list devices only.
Definition: ble_gapm.h:245
BLE_GAP_AD_TYPE_SPAIR_RAND
@ BLE_GAP_AD_TYPE_SPAIR_RAND
Simple Pairing Randomizer R-256.
Definition: ble_gapm.h:489
BLE_GAP_GET_DEV_RF_RF_PATH_COMP
@ BLE_GAP_GET_DEV_RF_RF_PATH_COMP
Get RF path compensation values.
Definition: ble_gapm.h:215
ble_gap_period_adv_list_t::num
uint8_t num
Number of available items.
Definition: ble_gapm.h:829
BLE_GAP_GET_MAX_LE_DATA_LEN
@ BLE_GAP_GET_MAX_LE_DATA_LEN
Get the Controller' maximum supported payload octets and packet duration times for transmission and r...
Definition: ble_gapm.h:209
ble_gap_ext_init_param_t::conn_param_2m
ble_gap_ext_conn_param_t conn_param_2m
Connection parameters for LE 2M PHY.
Definition: ble_gapm.h:791
ble_gap_connless_iq_sample_param_t::slot_dur
uint8_t slot_dur
The slot duration for IQ sampling, see enum gap_slot_dur_type.
Definition: ble_gapm.h:738
ble_gap_per_sync_stop
uint16_t ble_gap_per_sync_stop(uint8_t per_sync_idx)
Stop periodic synchronization.
ble_gap_evt_rslv_addr_read_t::op_code
uint8_t op_code
Operation code.
Definition: ble_gapm.h:920
ble_gap_evt_dev_info_get_t::dev_info
ble_gap_dev_info_t dev_info
Device info.
Definition: ble_gapm.h:867
ble_gap_path_compensation_set
uint16_t ble_gap_path_compensation_set(int16_t tx_path_comp, int16_t rx_path_comp)
Set the RF path gain or loss between the RF transceiver and the antenna contributed by intermediate c...
ble_gap_evt_adv_report_t::tx_pwr
int8_t tx_pwr
TX power (in dBm).
Definition: ble_gapm.h:895
BLE_GAP_OPCODE_PEER_RSLV_ADDR_READ
@ BLE_GAP_OPCODE_PEER_RSLV_ADDR_READ
Peer resolvable address operation.
Definition: ble_gapm.h:860
BLE_GAP_AD_TYPE_LE_ROLE
@ BLE_GAP_AD_TYPE_LE_ROLE
LE Role.
Definition: ble_gapm.h:487
BLE_GAP_ADV_TYPE_ADV_NONCONN_IND
@ BLE_GAP_ADV_TYPE_ADV_NONCONN_IND
Non-connectable and non-scanable mode.
Definition: ble_gapm.h:223
ble_gap_conn_param_t
The parameter of connection.
Definition: ble_gapc.h:369
BLE_GAP_AD_TYPE_SLAVE_CONN_INT_RANGE
@ BLE_GAP_AD_TYPE_SLAVE_CONN_INT_RANGE
Slave connection interval range.
Definition: ble_gapm.h:475
BLE_GAP_ROLE_NONE
@ BLE_GAP_ROLE_NONE
No role set yet.
Definition: ble_gapm.h:159
ble_gap_evt_adv_stop_t::reason
ble_gap_stopped_reason_t reason
The reason for the advertising stop.
Definition: ble_gapm.h:873
BLE_GAP_SEC_LVL_SC_ENC_AUTH
@ BLE_GAP_SEC_LVL_SC_ENC_AUTH
Security connection encryption with auth.
Definition: ble_gapm.h:452
ble_error.h
File that contains error codes.
BLE_GAP_ADV_PROP_HDC_POS
@ BLE_GAP_ADV_PROP_HDC_POS
Indicate that High Duty Cycle has to be used for advertising on primary channel, applicable only if c...
Definition: ble_gapm.h:281
ble_gapc.h
BLE GAPC API.
ble_gap_ral_dev_info_t
RPA list item info.
Definition: ble_gapm.h:837
ble_gap_connect
uint16_t ble_gap_connect(ble_gap_own_addr_t own_addr_type, ble_gap_init_param_t *p_init_param)
Start a legacy connection to a device.
ble_gap_ext_init_param_t::conn_param_coded
ble_gap_ext_conn_param_t conn_param_coded
Connection parameters for LE Coded PHY.
Definition: ble_gapm.h:792
ble_gap_init_type_t
ble_gap_init_type_t
Initiating types.
Definition: ble_gapm.h:364
BLE_GAP_REPORT_INFO_SCAN_ADV_BIT
@ BLE_GAP_REPORT_INFO_SCAN_ADV_BIT
Scannable advertising.
Definition: ble_gapm.h:510
BLE_GAP_ADV_PROP_CONNECTABLE_POS
@ BLE_GAP_ADV_PROP_CONNECTABLE_POS
Indicate that advertising is connectable, reception of CONNECT_REQ or UX_CONNECT_REQ PDUs is accepted...
Definition: ble_gapm.h:275
BLE_GAP_EXT_DUP_FILT_DIS
@ BLE_GAP_EXT_DUP_FILT_DIS
Disable filtering of duplicated packets.
Definition: ble_gapm.h:355
ble_gapm_evt_t::adv_report
ble_gap_evt_adv_report_t adv_report
Advertising Report parameter.
Definition: ble_gapm.h:941
BLE_GAP_INIT_TYPE_AUTO_CONN_EST
@ BLE_GAP_INIT_TYPE_AUTO_CONN_EST
Automatic connection establishment: establish a connection with all devices whose address is present ...
Definition: ble_gapm.h:366
ble_gap_scan_param_t::use_whitelist
bool use_whitelist
Filter policy.
Definition: ble_gapm.h:665
BLE_GAP_REPORT_INFO_COMPLETE_BIT
@ BLE_GAP_REPORT_INFO_COMPLETE_BIT
Report is complete.
Definition: ble_gapm.h:508
ble_gap_connless_iq_sample_param_t::max_smaple_cte
uint8_t max_smaple_cte
The maximum number of CTE to sample and report in each periodic advertising interval (range 0x00 to 0...
Definition: ble_gapm.h:739
BLE_GAP_REPORT_TYPE_ADV_LEG
@ BLE_GAP_REPORT_TYPE_ADV_LEG
Legacy advertising report.
Definition: ble_gapm.h:499
ble_gap_adv_type_t
ble_gap_adv_type_t
Advertising type.
Definition: ble_gapm.h:264
ble_gap_white_list_t::num
uint8_t num
Number of available items.
Definition: ble_gapm.h:820
ble_gap_adv_second_cfg_t::adv_sid
uint8_t adv_sid
Advertising SID.
Definition: ble_gapm.h:607
ble_gap_scan_prop_t
ble_gap_scan_prop_t
Scanning properties bit field bit value.
Definition: ble_gapm.h:384
BLE_GAP_ADV_TYPE_ADV_SCAN_IND
@ BLE_GAP_ADV_TYPE_ADV_SCAN_IND
Undirected scannable mode.
Definition: ble_gapm.h:224
ble_gap_evt_sync_established_t
Sync established event for BLE_GAPM_EVT_SYNC_ESTABLISH.
Definition: ble_gapm.h:908
ble_gap_sec_key_t
Security key.
Definition: ble_gapm.h:653
ble_gap_scan_type_t
ble_gap_scan_type_t
Scanning types.
Definition: ble_gapm.h:313
BLE_GAP_ADV_FLAG_SIMUL_BR_EDR_LE_HOST
@ BLE_GAP_ADV_FLAG_SIMUL_BR_EDR_LE_HOST
Dual mode for host supported (BR/EDR/LE): AD Flag.
Definition: ble_gapm.h:531
ble_gap_evt_adv_report_t::data
uint8_t * data
Report data.
Definition: ble_gapm.h:903
ble_gap_evt_adv_report_t::phy_second
uint8_t phy_second
Secondary PHY on which advertising report has been received.
Definition: ble_gapm.h:898
ble_gap_adv_start
uint16_t ble_gap_adv_start(uint8_t adv_idx, ble_gap_adv_time_param_t *p_timeout)
Start advertising.
BLE_GAP_EXT_DUP_FILT_EN_PERIOD
@ BLE_GAP_EXT_DUP_FILT_EN_PERIOD
Enable filtering of duplicated packets, reset for each scan period.
Definition: ble_gapm.h:357
ble_gap_adv_time_param_t::duration
uint16_t duration
Advertising duration (in unit of 10ms).
Definition: ble_gapm.h:641
ble_gap_bond_dev_list_t
Bonded device list.
Definition: ble_gapm.h:810
BLE_GAP_ADV_FLAG_SIMUL_BR_EDR_LE_CONTROLLER
@ BLE_GAP_ADV_FLAG_SIMUL_BR_EDR_LE_CONTROLLER
Dual mode for controller supported (BR/EDR/LE): AD Flag.
Definition: ble_gapm.h:530
BLE_GAP_INIT_TYPE_NAME_DISC
@ BLE_GAP_INIT_TYPE_NAME_DISC
Name discovery: establish a connection with an indicated device in order to read content of its devic...
Definition: ble_gapm.h:367
BLE_GAP_ADV_DATA_TYPE_PER_DATA
@ BLE_GAP_ADV_DATA_TYPE_PER_DATA
Periodic advertising data.
Definition: ble_gapm.h:196
ble_gap_disc_mode_t
ble_gap_disc_mode_t
GAP discoverability modes.
Definition: ble_gapm.h:231
BLE_GAP_SCAN_PROP_ACTIVE_1M_BIT
@ BLE_GAP_SCAN_PROP_ACTIVE_1M_BIT
Active scan on LE 1M PHY (scan request PDUs may be sent).
Definition: ble_gapm.h:387
ble_gap_dev_name_write_perm_t
ble_gap_dev_name_write_perm_t
Write permissions of the device name characteristic.
Definition: ble_gapm.h:181
ble_gap_scan_wd_op_param_t::scan_wd
uint16_t scan_wd
Scan window between 0x0004 and 0xFFFF in 0.625 ms (range: 2.5 ms to 40.959375s).
Definition: ble_gapm.h:677
BLE_GAP_ADV_TYPE_PERIODIC
@ BLE_GAP_ADV_TYPE_PERIODIC
Periodic advertising.
Definition: ble_gapm.h:267
ble_gap_scan_stop
uint16_t ble_gap_scan_stop(void)
Stop scanning.
ble_gap_adv_prim_cfg_t::adv_intv_min
uint32_t adv_intv_min
Minimum advertising interval (in unit of 625 μs).
Definition: ble_gapm.h:592
ble_gap_per_adv_list_get
uint16_t ble_gap_per_adv_list_get(ble_gap_period_adv_list_t *p_pal_list)
Get the content of the whole periodic advertising list.
ble_gap_adv_param_t::scan_req_ind_en
bool scan_req_ind_en
Indicate if the application should be informed when receiving a scan request from the scanner.
Definition: ble_gapm.h:582
BLE_GAP_AOD_TX_1_US
@ BLE_GAP_AOD_TX_1_US
1 us switching supported for AoD transmission.
Definition: ble_gapm.h:430
BLE_GAP_AD_TYPE_APPEARANCE
@ BLE_GAP_AD_TYPE_APPEARANCE
Appearance.
Definition: ble_gapm.h:484
BLE_GAP_REPORT_TYPE_ADV_EXT
@ BLE_GAP_REPORT_TYPE_ADV_EXT
Extended advertising report.
Definition: ble_gapm.h:498
ble_gap_per_sync_param_t::rsvd
uint8_t rsvd
Reserved for future use.
Definition: ble_gapm.h:715
BLE_GAP_EXT_SCAN_TYPE_SEL_OBSERVER
@ BLE_GAP_EXT_SCAN_TYPE_SEL_OBSERVER
Selective observer.
Definition: ble_gapm.h:345
ble_gap_ppcp_present_set
void ble_gap_ppcp_present_set(bool present_flag)
Set GAP Peripheral Preferred Connection Parameters present flag.
ble_gap_init_param_t::interval_min
uint16_t interval_min
Minimum value for the connection interval (in unit of 1.25ms).
Definition: ble_gapm.h:752
BLE_GAP_DISC_MODE_LIM_DISCOVERABLE
@ BLE_GAP_DISC_MODE_LIM_DISCOVERABLE
Limited-discoverable mode.
Definition: ble_gapm.h:234
ble_gap_ext_connect
uint16_t ble_gap_ext_connect(ble_gap_own_addr_t own_addr_type, ble_gap_ext_init_param_t *p_init_param)
Start an extended connection to a device.
ble_gap_init_param_t::interval_max
uint16_t interval_max
Maximum value for the connection interval (in unit of 1.25ms).
Definition: ble_gapm.h:754
BLE_GAP_SYNC_REP_DIS
@ BLE_GAP_SYNC_REP_DIS
synchronize to the periodic advertising, per adv report events will be disabled.
Definition: ble_gapm.h:420
ble_gap_whitelist_del
uint16_t ble_gap_whitelist_del(const ble_gap_white_list_t *p_whitelist)
Delete the devices out of current white list.
BLE_GAP_MAX_KEY_LEN
#define BLE_GAP_MAX_KEY_LEN
The key length.
Definition: ble_gapm.h:77
ble_gap_chnl_map_set
uint16_t ble_gap_chnl_map_set(ble_gap_chnl_map_t *p_chnl_map)
Set advertising channel map before advertising starting.
BLE_GAP_OPCODE_LOCAL_RSLV_ADDR_READ
@ BLE_GAP_OPCODE_LOCAL_RSLV_ADDR_READ
Local resolvable address operation.
Definition: ble_gapm.h:859
BLE_GAP_AD_TYPE_SERVICE_128_BIT_DATA
@ BLE_GAP_AD_TYPE_SERVICE_128_BIT_DATA
Service data 128-bit UUID.
Definition: ble_gapm.h:481
ble_gap_adv_period_cfg_t::inc_adi_flag
bool inc_adi_flag
Flag for include the ADI field in AUX_SYNC_IND PDUs.
Definition: ble_gapm.h:617
ble_gap_adv_flags_t
ble_gap_adv_flags_t
AD Type Flag - Bit mask.
Definition: ble_gapm.h:526
BLE_GAP_AD_TYPE_3D_INFO
@ BLE_GAP_AD_TYPE_3D_INFO
3D Information Data.
Definition: ble_gapm.h:490
gap_slot_dur_type
gap_slot_dur_type
Slot duration type for IQ sampling.
Definition: ble_gapm.h:439
BLE_GAP_AD_TYPE_SHORTENED_NAME
@ BLE_GAP_AD_TYPE_SHORTENED_NAME
Shortened Device name.
Definition: ble_gapm.h:467
BLE_GAP_PER_SYNC_TYPE_GENERAL
@ BLE_GAP_PER_SYNC_TYPE_GENERAL
Do not use periodic advertiser list for synchronization.
Definition: ble_gapm.h:398
BLE_GAP_AD_TYPE_SERVICE_32_BIT_DATA
@ BLE_GAP_AD_TYPE_SERVICE_32_BIT_DATA
Service data 32-bit UUID.
Definition: ble_gapm.h:480
BLE_GAP_INIT_PROP_CODED_BIT
@ BLE_GAP_INIT_PROP_CODED_BIT
Scan connectable advertisements on the LE Coded PHY.
Definition: ble_gapm.h:377
ble_gap_l2cap_params_set
uint16_t ble_gap_l2cap_params_set(uint16_t max_mtu, uint16_t max_mps, uint8_t max_nb_lecb)
Set L2CAP related parameters.
BLE_GAP_AD_TYPE_SP_HASH_C
@ BLE_GAP_AD_TYPE_SP_HASH_C
Simple Pairing Hash C.
Definition: ble_gapm.h:471
BLE_GAP_EXT_SCAN_TYPE_SEL_CONN_DISC
@ BLE_GAP_EXT_SCAN_TYPE_SEL_CONN_DISC
Selective connectable discovery.
Definition: ble_gapm.h:347
ble_gap_adv_param_t
Advertising parameters for legacy advertising.
Definition: ble_gapm.h:574
BLE_GAP_EXT_SCAN_TYPE_OBSERVER
@ BLE_GAP_EXT_SCAN_TYPE_OBSERVER
Observer.
Definition: ble_gapm.h:344
ble_gap_bond_devs_get
uint16_t ble_gap_bond_devs_get(ble_gap_bond_dev_list_t *p_bond_list, uint8_t max_num)
Get all bonded devices.
ble_gap_privacy_mode_set
uint16_t ble_gap_privacy_mode_set(ble_gap_bdaddr_t peer_addr, ble_gap_privacy_mode_t mode)
Set privacy mode for peer device.
ble_gap_stopped_reason_t
ble_gap_stopped_reason_t
Stop reason code.
Definition: ble_gapm.h:516
ble_gapm_evt_t::index
uint8_t index
Index of connection or advertising.
Definition: ble_gapm.h:934
ble_gapm_evt_t::rslv_addr
ble_gap_evt_rslv_addr_read_t rslv_addr
Read Resolvable Address parameter, generated by controller.
Definition: ble_gapm.h:943
ble_gap_ral_dev_info_t::bd_addr
ble_gap_bdaddr_t bd_addr
Peer device identity.
Definition: ble_gapm.h:838
BLE_GAP_STOPPED_REASON_ON_USER
@ BLE_GAP_STOPPED_REASON_ON_USER
Stop with user stopping it actively.
Definition: ble_gapm.h:518
ble_gap_scan_param_t::scan_mode
ble_gap_scan_mode_t scan_mode
Scan mode.
Definition: ble_gapm.h:663
BLE_GAP_NO_SYNC_WITHOUT_CTE
@ BLE_GAP_NO_SYNC_WITHOUT_CTE
Do not sync to packets without a Constant Tone Extension.
Definition: ble_gapm.h:412
ble_gap_evt_adv_report_t::rssi
int8_t rssi
RSSI (between -127 and +20 dBm).
Definition: ble_gapm.h:896
ble_gap_ral_dev_list_t::num
uint8_t num
Number of RPA list.
Definition: ble_gapm.h:850
ble_gap_ppcp_set
uint16_t ble_gap_ppcp_set(ble_gap_conn_param_t const *p_conn_params)
Set GAP Peripheral Preferred Connection Parameters.
ble_gap_ext_adv_param_t::type
uint8_t type
Advertising type (see enum ble_gap_adv_type_t).
Definition: ble_gapm.h:625
ble_gap_connless_iq_report_t
Connectionless IQ Report info.
Definition: ble_gapc.h:528
ble_gap_adv_second_cfg_t::phy
ble_gap_le_phy_value_t phy
Indicate on which PHY secondary advertising has to be performed.
Definition: ble_gapm.h:606
BLE_GAP_SCAN_PROP_PHY_1M_BIT
@ BLE_GAP_SCAN_PROP_PHY_1M_BIT
Scan advertisement on the LE 1M PHY.
Definition: ble_gapm.h:385
ble_gap_per_adv_list_clear
uint16_t ble_gap_per_adv_list_clear(void)
Clear all the entries in the current periodic advertising list.
ble_gap_ext_scan_param_t::period
uint16_t period
Scan period, which is the time interval between two consequent starts of a scan duration by the contr...
Definition: ble_gapm.h:693
ble_gap_evt_adv_report_t::phy_prim
uint8_t phy_prim
Primary PHY on which advertising report has been received.
Definition: ble_gapm.h:897
ble_gap_lepsm_register
uint16_t ble_gap_lepsm_register(ble_gap_lepsm_register_t *p_lepsm)
Register a LE Protocol/Service Multiplexer.
ble_gap_evt_adv_report_t::broadcaster_addr
ble_gap_bdaddr_t broadcaster_addr
Broadcaster device address.
Definition: ble_gapm.h:893
ble_gap_connless_iq_sample_enable_set
uint16_t ble_gap_connless_iq_sample_enable_set(uint8_t per_sync_index, bool enable_flag, ble_gap_connless_iq_sample_param_t *param)
Set connectionless IQ sampling enable.
ble_gap_ext_adv_param_t::second_cfg
ble_gap_adv_second_cfg_t second_cfg
Configuration for secondary advertising (valid only if advertising type is GAP_ADV_TYPE_EXTENDED or G...
Definition: ble_gapm.h:632
ble_gapm_evt_t::sync_established
ble_gap_evt_sync_established_t sync_established
Periodic Advertising Synchronization Established parameter.
Definition: ble_gapm.h:942
ble_gapm_evt_t::scan_stop
ble_gap_evt_scan_stop_t scan_stop
Scan Stop parameter.
Definition: ble_gapm.h:940
ble_gapm_evt_t::adv_stop
ble_gap_evt_adv_stop_t adv_stop
Advertising stop parameter.
Definition: ble_gapm.h:938
ble_gap_ext_scan_param_t
Parameters for extended scanning.
Definition: ble_gapm.h:684
ble_gap_adv_stop
uint16_t ble_gap_adv_stop(uint8_t adv_idx)
Stop advertising.
ble_gap_ext_conn_param_t
Connection parameters.
Definition: ble_gapm.h:768
BLE_GAP_GET_NB_ADV_SETS
@ BLE_GAP_GET_NB_ADV_SETS
Read the maximum number of advertising sets currently supported by the controller.
Definition: ble_gapm.h:212
ble_gap_lepsm_unregister
uint16_t ble_gap_lepsm_unregister(uint16_t le_psm)
Unregister a LE Protocol/Service Multiplexer.
BLE_GAP_ADV_TYPE_ADV_HIGH_DIRECT_IND
@ BLE_GAP_ADV_TYPE_ADV_HIGH_DIRECT_IND
Directed high duty cycle mode.
Definition: ble_gapm.h:225
ble_gap_appearance_set
void ble_gap_appearance_set(uint16_t appearance)
Set GAP appearance value.
BLE_GAP_DISC_MODE_NON_DISCOVERABLE
@ BLE_GAP_DISC_MODE_NON_DISCOVERABLE
Non-discoverable mode.
Definition: ble_gapm.h:232
BLE_GAP_AOD_RX_1_US
@ BLE_GAP_AOD_RX_1_US
1 us switching supported for AoD reception.
Definition: ble_gapm.h:431
BLE_GAP_WRITE_PERM_NOAUTH
@ BLE_GAP_WRITE_PERM_NOAUTH
LE Security Mode 1, Level 1.
Definition: ble_gapm.h:183
BLE_GAP_DISC_MODE_GEN_DISCOVERABLE
@ BLE_GAP_DISC_MODE_GEN_DISCOVERABLE
General-discoverable mode.
Definition: ble_gapm.h:233
ble_gap_adv_period_cfg_t
Configuration for periodic advertising.
Definition: ble_gapm.h:614
BLE_GAP_MAX_WL_NUM
#define BLE_GAP_MAX_WL_NUM
Maximal white list number.
Definition: ble_gapm.h:75
ble_gap_evt_adv_stop_t
Advertising Stop info.
Definition: ble_gapm.h:872
ble_gap_dev_info_get_type_t
ble_gap_dev_info_get_type_t
Get device parameters operation code.
Definition: ble_gapm.h:202
ble_gap_addr_get
uint16_t ble_gap_addr_get(ble_gap_bdaddr_t *p_addr)
Get the device identity address (public or random static).
ble_gap_evt_adv_report_t::period_adv_intv
uint16_t period_adv_intv
Periodic advertising interval (in unit of 1.25ms, min is 7.5ms), valid only for periodic advertising ...
Definition: ble_gapm.h:900
ble_gap_ext_init_param_t::scan_param_coded
ble_gap_scan_wd_op_param_t scan_param_coded
Scan window opening parameters for LE Coded PHY.
Definition: ble_gapm.h:789
BLE_GAP_GET_SUGGESTED_DFLT_LE_DATA_LEN
@ BLE_GAP_GET_SUGGESTED_DFLT_LE_DATA_LEN
Get suggested values (SuggestedMaxTxOctets and SuggestedMaxTxTime) for the Controller's maximum trans...
Definition: ble_gapm.h:206
ble_gap_scan_param_t::window
uint16_t window
Scan window between 0x0004 and 0x4000 in 0.625 ms (range: 2.5 ms to 10.24s).
Definition: ble_gapm.h:667
BLE_GAP_PER_SYNC_TYPE_SELECTIVE
@ BLE_GAP_PER_SYNC_TYPE_SELECTIVE
Use periodic advertiser list for synchronization.
Definition: ble_gapm.h:399
BLE_GAP_AD_TYPE_FLAGS
@ BLE_GAP_AD_TYPE_FLAGS
Flag.
Definition: ble_gapm.h:460
BLE_GAP_PER_SYNC_TYPE_PAST
@ BLE_GAP_PER_SYNC_TYPE_PAST
Use Periodic advertising sync transfer information send through connection for synchronization.
Definition: ble_gapm.h:400
BLE_GAP_INIT_PROP_1M_BIT
@ BLE_GAP_INIT_PROP_1M_BIT
Scan connectable advertisements on the LE 1M PHY.
Definition: ble_gapm.h:375
ble_gap_period_adv_list_t
Periodic advertising list.
Definition: ble_gapm.h:828
BLE_GAP_MAX_PRD_ADV_NUM
#define BLE_GAP_MAX_PRD_ADV_NUM
Maximal periodic advertising list number.
Definition: ble_gapm.h:76
BLE_GAP_SCAN_PROP_ACCEPT_RPA_BIT
@ BLE_GAP_SCAN_PROP_ACCEPT_RPA_BIT
Accept directed advertising packets if the used RPA and target address cannot be solved by the contro...
Definition: ble_gapm.h:389
ble_gap_ext_init_param_t::type
uint8_t type
Initiating type (see enum ble_gap_init_type_t).
Definition: ble_gapm.h:783
ble_gap_adv_param_t::chnl_map
uint8_t chnl_map
Advertising channel map.
Definition: ble_gapm.h:581
BLE_GAP_ACTIVITY_ROLE_UNKNOWN
@ BLE_GAP_ACTIVITY_ROLE_UNKNOWN
Unknown role.
Definition: ble_gapm.h:552
BLE_GAP_SCAN_PASSIVE
@ BLE_GAP_SCAN_PASSIVE
Passive scan type.
Definition: ble_gapm.h:315
ble_gap_evt_adv_report_t::adv_type
ble_gap_adv_report_type_t adv_type
Advertising type.
Definition: ble_gapm.h:891
ble_gap_ext_scan_param_t::scan_param_1m
ble_gap_scan_wd_op_param_t scan_param_1m
Scan window opening parameters for LE 1M PHY.
Definition: ble_gapm.h:689
BLE_GAP_AD_TYPE_CLASS_OF_DEVICE
@ BLE_GAP_AD_TYPE_CLASS_OF_DEVICE
Class of device.
Definition: ble_gapm.h:470
ble_gap_adv_prim_cfg_t::phy
ble_gap_le_phy_value_t phy
Indicate on which PHY primary advertising has to be performed.
Definition: ble_gapm.h:595
ble_gap_appearance_get
uint16_t ble_gap_appearance_get(uint16_t *p_appearance)
Get GAP appearance value.
BLE_GAP_AD_TYPE_OOB_FLAGS
@ BLE_GAP_AD_TYPE_OOB_FLAGS
Out of Band Flag.
Definition: ble_gapm.h:474
BLE_GAP_AD_TYPE_RAND_TGT_ADDR
@ BLE_GAP_AD_TYPE_RAND_TGT_ADDR
Random Target Address.
Definition: ble_gapm.h:483
ble_gap_ext_scan_param_t::duration
uint16_t duration
Scan duration (in unit of 10ms).
Definition: ble_gapm.h:691
ble_gap_ext_init_param_t::prop
uint8_t prop
Properties for the initiating procedure (see enum ble_gap_init_prop_t for bit signification).
Definition: ble_gapm.h:784
ble_gap_adv_data_set
uint16_t ble_gap_adv_data_set(uint8_t adv_idx, ble_gap_adv_data_type_t type, const uint8_t *p_data, uint16_t length)
Set Advertising Data, Scan Response Data and Periodic Advertising Data.
ble_gap_adv_report_type_t
ble_gap_adv_report_type_t
Advertising report type.
Definition: ble_gapm.h:497
ble_gap_init_param_t::slave_latency
uint16_t slave_latency
Slave latency.
Definition: ble_gapm.h:756
ble_gap_adv_param_set
uint16_t ble_gap_adv_param_set(uint8_t adv_idx, ble_gap_own_addr_t own_addr_type, ble_gap_adv_param_t *p_adv_param)
Set parameters for advertising.
gap_connless_cte_trans_param_t::cte_count
uint8_t cte_count
CTE count (number of CTEs to transmit in each periodic advertising interval, range 0x01 to 0x10).
Definition: ble_gapm.h:728
BLE_GAP_AD_TYPE_COMPLETE_LIST_32_BIT_UUID
@ BLE_GAP_AD_TYPE_COMPLETE_LIST_32_BIT_UUID
Complete List of 32-bit UUID.
Definition: ble_gapm.h:464
ble_gap_scan_mode_t
ble_gap_scan_mode_t
Scanning modes.
Definition: ble_gapm.h:322
BLE_GAP_REPORT_TYPE_SCAN_RSP_EXT
@ BLE_GAP_REPORT_TYPE_SCAN_RSP_EXT
Extended scan response report.
Definition: ble_gapm.h:500
ble_gap_bond_dev_list_t::num
uint8_t num
Number of bonded device.
Definition: ble_gapm.h:811
BLE_GAP_ROLE_OBSERVER
@ BLE_GAP_ROLE_OBSERVER
Observer role.
Definition: ble_gapm.h:160
ble_gap_scan_wd_op_param_t::scan_intv
uint16_t scan_intv
Scan interval between 0x0004 and 0xFFFF in 0.625 ms (range: 2.5 ms to 40.959375s).
Definition: ble_gapm.h:676
ble_gap_ext_init_param_t::peer_addr
ble_gap_bdaddr_t peer_addr
Address of peer device in case white list is not used for connection.
Definition: ble_gapm.h:793
gap_connless_cte_trans_param_t::cte_len
uint8_t cte_len
CTE length (8us unit, range 0x02 to 0x14).
Definition: ble_gapm.h:726
BLE_GAP_SEC_LVL_ENC_NO_AUTH
@ BLE_GAP_SEC_LVL_ENC_NO_AUTH
Encryption with no auth.
Definition: ble_gapm.h:450
BLE_GAP_AD_TYPE_MANU_SPECIFIC_DATA
@ BLE_GAP_AD_TYPE_MANU_SPECIFIC_DATA
Manufacturer specific data.
Definition: ble_gapm.h:492
ble_gap_ext_adv_param_t::filter_pol
uint8_t filter_pol
Advertising filtering policy (see enum ble_gap_adv_filter_policy_t).
Definition: ble_gapm.h:629
ble_gap_connless_iq_sample_param_t::antenna_id
uint8_t * antenna_id
List of Antenna IDs in the pattern.
Definition: ble_gapm.h:742
ble_gap_device_name_get
uint16_t ble_gap_device_name_get(uint8_t *p_dev_name, uint16_t *p_length)
Get GAP device name.
BLE_GAP_OWN_ADDR_GEN_NON_RSLV
@ BLE_GAP_OWN_ADDR_GEN_NON_RSLV
Generated non-resolvable private random address.
Definition: ble_gapm.h:174
ble_gap_set_gdx_ranging_param
uint16_t ble_gap_set_gdx_ranging_param(uint32_t base_addr, uint8_t cte_len)
Set ranging parameter.
ble_gap_connless_cte_trans_enable_set
uint16_t ble_gap_connless_cte_trans_enable_set(uint8_t per_adv_index, bool enable_flag)
Set connectionless CTE transmit enable.
BLE_GAP_AD_TYPE_MORE_128_BIT_UUID
@ BLE_GAP_AD_TYPE_MORE_128_BIT_UUID
Use of more than 128-bit UUID.
Definition: ble_gapm.h:465
ble_gap_per_adv_list_add
uint16_t ble_gap_per_adv_list_add(const ble_gap_period_adv_list_t *p_pal_list)
Add the devices into current periodic advertising list.
ble_gap_own_addr_t
ble_gap_own_addr_t
Own BD address source of the device.
Definition: ble_gapm.h:171
BLE_GAP_AD_TYPE_RQRD_16_BIT_SVC_UUID
@ BLE_GAP_AD_TYPE_RQRD_16_BIT_SVC_UUID
Require 16-bit service UUID.
Definition: ble_gapm.h:476
ble_gap_evt_rslv_addr_report_t::type
ble_gap_actv_type_t type
Activity type.
Definition: ble_gapm.h:927
ble_gap_adv_period_cfg_t::adv_intv_min
uint16_t adv_intv_min
Minimum advertising interval (in unit of 1.25 ms).
Definition: ble_gapm.h:615
ble_gap_connless_iq_sample_param_t::antenna_num
uint8_t antenna_num
The number of antenna IDs in the pattern (range 0x02 to 0x4B).
Definition: ble_gapm.h:741
BLE_GAP_INIT_PROP_2M_BIT
@ BLE_GAP_INIT_PROP_2M_BIT
Connection parameters for the LE 2M PHY are provided.
Definition: ble_gapm.h:376
ble_gap_evt_rslv_addr_read_t::gap_addr
ble_gap_addr_t gap_addr
Resolvable address info.
Definition: ble_gapm.h:921
BLE_GAP_AD_TYPE_SP_RANDOMIZER_R
@ BLE_GAP_AD_TYPE_SP_RANDOMIZER_R
Simple Pairing Randomizer.
Definition: ble_gapm.h:472
ble_gap_per_sync_param_t::report_disable
bool report_disable
true to disable periodic advertising report, false to enable them by default.
Definition: ble_gapm.h:717
ble_gap_scan_param_t::interval
uint16_t interval
Scan interval between 0x0004 and 0x4000 in 0.625 ms (range: 2.5 ms to 10.24s).
Definition: ble_gapm.h:666
ble_gap_per_sync_param_t::skip
uint16_t skip
Number of periodic advertising that can be skipped after a successful reception.
Definition: ble_gapm.h:711
ble_gap_ext_init_param_t::conn_param_1m
ble_gap_ext_conn_param_t conn_param_1m
Connection parameters for LE 1M PHY.
Definition: ble_gapm.h:790
BLE_GAP_AD_TYPE_ADV_INTV
@ BLE_GAP_AD_TYPE_ADV_INTV
Advertising Interval.
Definition: ble_gapm.h:485
ble_gap_evt_adv_report_t::direct_addr
ble_gap_bdaddr_t direct_addr
Target address (in case of a directed advertising report).
Definition: ble_gapm.h:894
ble_gap_chnl_map_t
Channel map structure.
Definition: ble_gapc.h:394
ble_gap_evt_dev_info_get_t
Get device info event for BLE_GAPM_EVT_DEV_INFO_GOT.
Definition: ble_gapm.h:865
BLE_GAP_ACTV_TYPE_PER_SYNC
@ BLE_GAP_ACTV_TYPE_PER_SYNC
Definition: ble_gapm.h:563
ble_gap_adv_time_param_t::max_adv_evt
uint8_t max_adv_evt
Maximum number of extended advertising events.
Definition: ble_gapm.h:645
ble_gap_adv_second_cfg_t
Configuration for advertising on secondary channel.
Definition: ble_gapm.h:603
ble_gap_privacy_params_set
uint16_t ble_gap_privacy_params_set(uint16_t renew_dur, bool enable_flag)
Set privacy related parameters.
ble_gap_rpa_list_get
uint16_t ble_gap_rpa_list_get(ble_gap_ral_dev_list_t *p_rpa_list, uint8_t max_num)
Get the RPA list info.
ble_gap_evt_rslv_addr_report_t
Resolvable address report event for BLE_GAPM_EVT_RSLV_ADDR_REPORT.
Definition: ble_gapm.h:926
ble_gap_scan_param_t::timeout
uint16_t timeout
Scan timeout should be a value between 0x0001 and 0xFFFF(unit: 10 ms).
Definition: ble_gapm.h:668
BLE_GAP_EXT_DUP_FILT_EN
@ BLE_GAP_EXT_DUP_FILT_EN
Enable filtering of duplicated packets.
Definition: ble_gapm.h:356
ble_gap_ral_dev_list_t::items
ble_gap_ral_dev_info_t * items
RPA list item info.
Definition: ble_gapm.h:851
BLE_GAP_ADV_TYPE_EXTENDED
@ BLE_GAP_ADV_TYPE_EXTENDED
Extended advertising.
Definition: ble_gapm.h:266
ble_gap_scan_param_t::scan_dup_filt
ble_gap_scan_dup_filt_policy_t scan_dup_filt
Duplicate filter policy.
Definition: ble_gapm.h:664
ble_gap_init_param_t::conn_timeout
uint16_t conn_timeout
Timeout for connection establishment (in unit of 10ms).
Definition: ble_gapm.h:758
BLE_GAP_WRITE_PERM_AUTH
@ BLE_GAP_WRITE_PERM_AUTH
LE Security Mode 1, Level 3.
Definition: ble_gapm.h:185
ble_gap_adv_param_t::adv_intv_max
uint16_t adv_intv_max
Maximum advertising interval (in unit of 625 μs).
Definition: ble_gapm.h:580
ble_gap_ext_adv_param_t
Advertising parameters for extended advertising and periodic advertising.
Definition: ble_gapm.h:624
gap_connless_cte_trans_param_t::antenna_id
uint8_t * antenna_id
List of Antenna IDs in the pattern.
Definition: ble_gapm.h:730
ble_gap_evt_sync_established_t::bd_addr
ble_gap_bdaddr_t bd_addr
Advertiser address.
Definition: ble_gapm.h:913
ble_gap_adv_param_t::adv_intv_min
uint16_t adv_intv_min
Minimum advertising interval (in unit of 625 μs).
Definition: ble_gapm.h:579
BLE_GAP_ADV_PROP_DIRECTED_POS
@ BLE_GAP_ADV_PROP_DIRECTED_POS
Indicate that advertising targets at a specific device.
Definition: ble_gapm.h:278
ble_gap_ral_dev_info_t::priv_mode
uint8_t priv_mode
Privacy mode, see enum ble_gap_privacy_mode_t.
Definition: ble_gapm.h:839
ble_gap_whitelist_clear
uint16_t ble_gap_whitelist_clear(void)
Clear all the entries in the current white list.
BLE_GAP_EXT_SCAN_TYPE_GEN_DISC
@ BLE_GAP_EXT_SCAN_TYPE_GEN_DISC
General discovery.
Definition: ble_gapm.h:342
ble_gap_adv_filter_policy_t
ble_gap_adv_filter_policy_t
Advertising filter policy.
Definition: ble_gapm.h:242
ble_gap_scan_param_set
uint16_t ble_gap_scan_param_set(ble_gap_own_addr_t own_addr_type, ble_gap_scan_param_t *p_scan_param)
Set parameters for scanning.
ble_gap_evt_sync_established_t::adv_sid
uint8_t adv_sid
Advertising SID.
Definition: ble_gapm.h:911
ble_gap_ad_type_t
ble_gap_ad_type_t
GAP advertising types.
Definition: ble_gapm.h:459
ble_gap_ext_adv_param_set
uint16_t ble_gap_ext_adv_param_set(uint8_t adv_idx, ble_gap_own_addr_t own_addr_type, ble_gap_ext_adv_param_t *p_adv_param)
Set extended parameters for advertising.
ble_gap_adv_prop_t
ble_gap_adv_prop_t
Advertising properties bit field bit value.
Definition: ble_gapm.h:297
BLE_GAP_AD_TYPE_SPAIR_HASH
@ BLE_GAP_AD_TYPE_SPAIR_HASH
Simple Pairing Hash C-256.
Definition: ble_gapm.h:488
ble_gap_init_param_t::peer_addr
ble_gap_bdaddr_t peer_addr
Peer device address.
Definition: ble_gapm.h:751
BLE_GAP_ADV_PROP_CONNECTABLE_BIT
@ BLE_GAP_ADV_PROP_CONNECTABLE_BIT
Definition: ble_gapm.h:298
BLE_GAP_PHY_2MBPS_VALUE
@ BLE_GAP_PHY_2MBPS_VALUE
LE 2M PHY.
Definition: ble_gapm.h:256
ble_gap_adv_param_t::filter_pol
uint8_t filter_pol
Advertising filtering policy (see enum ble_gap_adv_filter_policy_t).
Definition: ble_gapm.h:577
ble_gap_evt_sync_established_t::intv
uint16_t intv
Periodic advertising interval (in unit of 1.25ms, min is 7.5ms).
Definition: ble_gapm.h:910
ble_gap_evt_sync_established_t::sync_hdl
uint16_t sync_hdl
Sync handle.
Definition: ble_gapm.h:914
ble_gap_ext_conn_param_t::supervision_to
uint16_t supervision_to
Link supervision timeout (in unit of 10ms).
Definition: ble_gapm.h:774
BLE_GAP_ADV_DATA_TYPE_SCAN_RSP
@ BLE_GAP_ADV_DATA_TYPE_SCAN_RSP
Scan response data.
Definition: ble_gapm.h:195
ble_gap_adv_report_info_t
ble_gap_adv_report_info_t
Advertising report information.
Definition: ble_gapm.h:507
ble_gap_lepsm_register_t::le_psm
uint16_t le_psm
LE Protocol/Service Multiplexer (range: 1 to 255), PSMs should be odd.
Definition: ble_gapm.h:801
ble_gap_ext_scan_param_set
uint16_t ble_gap_ext_scan_param_set(ble_gap_own_addr_t own_addr_type, ble_gap_ext_scan_param_t *p_scan_param)
Set extended parameters for scanning.
ble_gap_init_prop_t
ble_gap_init_prop_t
Initiating properties.
Definition: ble_gapm.h:374
ble_gap_init_param_t::type
uint8_t type
Initiating type (see enum ble_gap_init_type_t).
Definition: ble_gapm.h:750
BLE_GAP_SYNC_REP_EN
@ BLE_GAP_SYNC_REP_EN
synchronize to the periodic advertising, per adv report events will be enabled, duplicate filtering d...
Definition: ble_gapm.h:421
BLE_GAP_SCAN_OBSERVER_MODE
@ BLE_GAP_SCAN_OBSERVER_MODE
Observer mode.
Definition: ble_gapm.h:325
BLE_GAP_AD_TYPE_TK_VALUE
@ BLE_GAP_AD_TYPE_TK_VALUE
Temporary key value.
Definition: ble_gapm.h:473
ble_gap_tx_power_set
uint16_t ble_gap_tx_power_set(ble_gap_actv_role_t role, uint8_t index, int8_t txpwr_dbm)
Set the tx power.
ble_gap_ext_conn_param_t::ce_len
uint16_t ce_len
The length of connection event needed for this LE connection.
Definition: ble_gapm.h:775
BLE_GAP_INIT_TYPE_DIRECT_CONN_EST
@ BLE_GAP_INIT_TYPE_DIRECT_CONN_EST
Direct connection establishment: establish a connection with an indicated device.
Definition: ble_gapm.h:365
BLE_GAP_WRITE_PERM_SEC_CON
@ BLE_GAP_WRITE_PERM_SEC_CON
LE Security Mode 1, Level 4.
Definition: ble_gapm.h:186
ble_gap_register_conless_iq_report_cb
void ble_gap_register_conless_iq_report_cb(void(*cb)(uint8_t per_sync_idx, const ble_gap_connless_iq_report_t *iq_report))
Register connectionless iq report event callback.