Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]

Detailed Description

Macros

#define BLE_BD_ADDR_LEN   (0x06)
 
#define BLE_MASTER   (0x00)
 
#define BLE_SLAVE   (0x01)
 
#define BLE_GAP_ADDR_PUBLIC   (0x00)
 
#define BLE_GAP_ADDR_RAND   (0x01)
 
#define BLE_GAP_ADDR_RPA_ID_PUBLIC   (0x02)
 Resolvable Private Address. More...
 
#define BLE_GAP_ADDR_RPA_ID_RANDOM   (0x03)
 Resolvable Private Address. More...
 
#define BLE_GAP_AD_FLAGS_LE_LIM_DISC_MODE   (0x01)
 LE Limited Discoverable Mode flag used in AD type. More...
 
#define BLE_GAP_AD_FLAGS_LE_GEN_DISC_MODE   (0x02)
 LE General Discoverable Mode flag used in AD type. More...
 
#define BLE_GAP_AD_FLAGS_BR_EDR_NOT_SUPPORTED   (0x04)
 BR/EDR Not Supported flag used in AD type. More...
 
#define BLE_GAP_ADV_DATA_MODE   (0x00)
 Advertising data. More...
 
#define BLE_GAP_SCAN_RSP_DATA_MODE   (0x01)
 Scan response data. More...
 
#define BLE_GAP_PERD_ADV_DATA_MODE   (0x02)
 Periodic advertising data. More...
 
#define BLE_GAP_ADV_CH_37   (0x01)
 Use 37 CH. More...
 
#define BLE_GAP_ADV_CH_38   (0x02)
 Use 38 CH. More...
 
#define BLE_GAP_ADV_CH_39   (0x04)
 Use 39 CH. More...
 
#define BLE_GAP_ADV_CH_ALL   (0x07)
 Use 37 - 39 CH. More...
 
#define BLE_GAP_SCAN_PASSIVE   (0x00)
 Passive Scan. More...
 
#define BLE_GAP_SCAN_ACTIVE   (0x01)
 Active Scan. More...
 
#define BLE_GAP_SCAN_INTV_MIN   (0x0004)
 Active Scan. More...
 
#define BLE_GAP_SCAN_FILT_DUPLIC_DISABLE   (0x00)
 Duplicate filter disabled. More...
 
#define BLE_GAP_SCAN_FILT_DUPLIC_ENABLE   (0x01)
 Duplicate filter enabled. More...
 
#define BLE_GAP_SCAN_FILT_DUPLIC_ENABLE_FOR_PERIOD   (0x02)
 Duplicate filtering enabled, reset for each scan period. More...
 
#define BLE_GAP_SCAN_ALLOW_ADV_ALL   (0x00)
 Accept all advertising and scan response PDUs except directed advertising PDUs not addressed to local device. More...
 
#define BLE_GAP_SCAN_ALLOW_ADV_WLST   (0x01)
 Accept only advertising and scan response PDUs from remote devices whose address is registered in the White List. Directed advertising PDUs which are not addressed to local device is ignored. More...
 
#define BLE_GAP_SCAN_ALLOW_ADV_EXCEPT_DIRECTED   (0x02)
 Accept all advertising and scan response PDUs except directed advertising PDUs whose the target address is identity address but doesn't address local device. However directed advertising PDUs whose the target address is the local resolvable private address are accepted. More...
 
#define BLE_GAP_SCAN_ALLOW_ADV_EXCEPT_DIRECTED_WLST   (0x03)
 Accept all advertising and scan response PDUs.
The following are excluded. More...
 
#define BLE_GAP_INIT_FILT_USE_ADDR   (0x00)
 White List is not used. More...
 
#define BLE_GAP_INIT_FILT_USE_WLST   (0x01)
 White List is used. More...
 
#define BLE_GAP_DATA_0_CLEAR   (0x01)
 Clear the advertising data/scan response data/periodic advertising data in the advertising set. More...
 
#define BLE_GAP_DATA_0_DID_UPD   (0x02)
 Update Advertising DID without changing advertising data. More...
 
#define BLE_GAP_NET_PRIV_MODE   (0x00)
 Network Privacy Mode. More...
 
#define BLE_GAP_DEV_PRIV_MODE   (0x01)
 Device Privacy Mode. More...
 
#define BLE_GAP_REM_FEATURE_SIZE   (0x08)
 The length of the features supported by a remote device. More...
 
#define BLE_GAP_NOT_AUTHORIZED   (0x00)
 Not authorize the remote device. More...
 
#define BLE_GAP_AUTHORIZED   (0x01)
 Authorize the remote device. More...
 
#define BLE_GAP_RMV_ADV_SET_REM_OP   (0x01)
 Delete an advertising set. More...
 
#define BLE_GAP_RMV_ADV_SET_CLR_OP   (0x02)
 Delete all the advertising sets. More...
 
#define BLE_GAP_SC_PROC_GEN   (0x02)
 General Discovery Procedure. More...
 
#define BLE_GAP_SC_PROC_LIM   (0x01)
 Limited Discovery Procedure. More...
 
#define BLE_GAP_SC_PROC_OBS   (0x00)
 Observation Procedure. More...
 
#define BLE_GAP_LIST_ADD_DEV   (0x01)
 Add the device to the list. More...
 
#define BLE_GAP_LIST_REM_DEV   (0x02)
 Delete the device from the list. More...
 
#define BLE_GAP_LIST_CLR   (0x03)
 Clear the list. More...
 
#define BLE_GAP_WHITE_LIST_MAX_ENTRY   (0x04)
 The maximum entry number of White List. More...
 
#define BLE_GAP_RSLV_LIST_MAX_ENTRY   (0x08)
 The maximum entry number of Resolving List. More...
 
#define BLE_GAP_PERD_LIST_MAX_ENTRY   (0x04)
 The maximum entry number of Periodic Advertiser List. More...
 
#define BLE_GAP_RPA_DISABLED   (0x00)
 Disable RPA generation/resolution. More...
 
#define BLE_GAP_RPA_ENABLED   (0x01)
 Enable RPA generation/resolution. More...
 
#define BLE_GAP_RL_LOC_KEY_ALL_ZERO   (0x00)
 All-zero IRK. More...
 
#define BLE_GAP_RL_LOC_KEY_REGISTERED   (0x01)
 The IRK registered by R_BLE_GAP_SetLocIdInfo(). More...
 
#define BLE_MAX_NO_OF_ADV_SETS_SUPPORTED   (BLE_ABS_CFG_RF_ADVERTISING_SET_MAXIMUM)
 The maximum number of advertising set which the Controller supports. More...
 
#define BLE_GAP_LEGACY_PROP_ADV_IND   (0x0013)
 Connectable and scannable undirected Legacy Advertising Packet. More...
 
#define BLE_GAP_LEGACY_PROP_ADV_DIRECT_IND   (0x0015)
 Connectable directed (low duty cycle) Legacy Advertising Packet. More...
 
#define BLE_GAP_LEGACY_PROP_ADV_HDC_DIRECT_IND   (0x001D)
 Connectable directed (high duty cycle) Legacy Advertising Packet. More...
 
#define BLE_GAP_LEGACY_PROP_ADV_SCAN_IND   (0x0012)
 Scannable undirected Legacy Advertising Packet. More...
 
#define BLE_GAP_LEGACY_PROP_ADV_NONCONN_IND   (0x0010)
 Non-connectable and non-scannable undirected Legacy Advertising Packet. More...
 
#define BLE_GAP_EXT_PROP_ADV_CONN_NOSCAN_UNDIRECT   (0x0001)
 Connectable and non-scannable undirected Extended Advertising Packet. More...
 
#define BLE_GAP_EXT_PROP_ADV_CONN_NOSCAN_DIRECT   (0x0005)
 Connectable and non-scannable directed (low duty cycle) Extended Advertising Packet. More...
 
#define BLE_GAP_EXT_PROP_ADV_CONN_NOSCAN_HDC_DIRECT   (0x000D)
 Connectable and non-scannable directed (high duty cycle) Extended Advertising Packet. More...
 
#define BLE_GAP_EXT_PROP_ADV_NOCONN_SCAN_UNDIRECT   (0x0002)
 Non-connectable and scannable undirected Extended Advertising Packet. More...
 
#define BLE_GAP_EXT_PROP_ADV_NOCONN_SCAN_DIRECT   (0x0006)
 Non-connectable and scannable directed (low duty cycle) Extended Advertising Packet. More...
 
#define BLE_GAP_EXT_PROP_ADV_NOCONN_SCAN_HDC_DIRECT   (0x000E)
 Non-connectable and scannable directed (high duty cycle) Extended Advertising Packet. More...
 
#define BLE_GAP_EXT_PROP_ADV_NOCONN_NOSCAN_UNDIRECT   (0x0000)
 Non-connectable and non-scannable undirected Extended Advertising Packet. More...
 
#define BLE_GAP_EXT_PROP_ADV_NOCONN_NOSCAN_DIRECT   (0x0004)
 Non-connectable and non-scannable directed (low duty cycle) Extended Advertising Packet. More...
 
#define BLE_GAP_EXT_PROP_ADV_NOCONN_NOSCAN_HDC_DIRECT   (0x000C)
 Non-connectable and non-scannable directed (high duty cycle) Extended Advertising Packet. More...
 
#define BLE_GAP_EXT_PROP_ADV_ANONYMOUS   (0x0020)
 Omit the advertiser address from Extended Advertising Packet. More...
 
#define BLE_GAP_EXT_PROP_ADV_INCLUDE_TX_POWER   (0x0040)
 Indicate that the advertising data includes TX Power. More...
 
#define BLE_GAP_ADV_ALLOW_SCAN_ANY_CONN_ANY   (0x00)
 Process scan and connection requests from all devices. More...
 
#define BLE_GAP_ADV_ALLOW_SCAN_WLST_CONN_ANY   (0x01)
 Process connection requests from all devices and scan requests from only devices that are in the White List. More...
 
#define BLE_GAP_ADV_ALLOW_SCAN_ANY_CONN_WLST   (0x02)
 Process scan requests from all devices and connection requests from only devices that are in the White List. More...
 
#define BLE_GAP_ADV_ALLOW_SCAN_WLST_CONN_WLST   (0x03)
 Process scan and connection requests from only devices in the White List. More...
 
#define BLE_GAP_ADV_PHY_1M   (0x01)
 Use 1M PHY. More...
 
#define BLE_GAP_ADV_PHY_2M   (0x02)
 Use 2M PHY. More...
 
#define BLE_GAP_ADV_PHY_CD   (0x03)
 Use Coded PHY. More...
 
#define BLE_GAP_SCAN_REQ_NTF_DISABLE   (0x00)
 Disable Scan Request Notification. More...
 
#define BLE_GAP_SCAN_REQ_NTF_ENABLE   (0x01)
 Enable Scan Request Notification. More...
 
#define BLE_GAP_PERD_PROP_TX_POWER   (0x0040)
 Indicate that periodic advertising data includes Tx Power. More...
 
#define BLE_GAP_INVALID_ADV_HDL   (0xFF)
 Invalid advertising handle. More...
 
#define BLE_GAP_SET_PHYS_HOST_PREF_1M   (0x01)
 Use 1M PHY. More...
 
#define BLE_GAP_SET_PHYS_HOST_PREF_2M   (0x02)
 Use 2M PHY. More...
 
#define BLE_GAP_SET_PHYS_HOST_PREF_CD   (0x04)
 Use Coded PHY. More...
 
#define BLE_GAP_SET_PHYS_OP_HOST_NO_PREF   (0x00)
 No preferred coding. More...
 
#define BLE_GAP_SET_PHYS_OP_HOST_PREF_S_2   (0x01)
 Use S=2 coding. More...
 
#define BLE_GAP_SET_PHYS_OP_HOST_PREF_S_8   (0x02)
 Use S=8 coding. More...
 
#define BLE_GAP_CONN_UPD_MODE_REQ   (0x01)
 Request for updating the connection parameters. More...
 
#define BLE_GAP_CONN_UPD_MODE_RSP   (0x02)
 Reply a connection parameter update request. More...
 
#define BLE_GAP_CONN_UPD_ACCEPT   (0x0000)
 Accept the update request. More...
 
#define BLE_GAP_CONN_UPD_REJECT   (0x0001)
 Reject the update request. More...
 
#define BLE_GAP_CH_MAP_SIZE   (0x05)
 The size of channel map. More...
 
#define BLE_GAP_INVALID_CONN_HDL   (0xFFFF)
 Invalid Connection handle. More...
 
#define BLE_GAP_NOT_USE_CONN_HDL   BLE_GAP_INVALID_CONN_HDL
 This macro indicates that connection handle is not used. More...
 
#define BLE_GAP_INIT_CONN_HDL   BLE_GAP_INVALID_CONN_HDL
 Initial Connection handle. More...
 
#define BLE_GAP_PAIRING_ACCEPT   (0x00)
 Accept a request regarding pairing. More...
 
#define BLE_GAP_PAIRING_REJECT   (0x01)
 Reject a request regarding pairing. More...
 
#define BLE_GAP_LTK_REQ_ACCEPT   (0x00)
 Reply for the LTK request. More...
 
#define BLE_GAP_LTK_REQ_DENY   (0x01)
 Reject the LTK request. More...
 
#define BLE_GAP_LESC_PASSKEY_ENTRY_STARTED   (0x00)
 Notify that passkey entry started. More...
 
#define BLE_GAP_LESC_PASSKEY_DIGIT_ENTERED   (0x01)
 Notify that passkey digit entered. More...
 
#define BLE_GAP_LESC_PASSKEY_DIGIT_ERASED   (0x02)
 Notify that passkey digit erased. More...
 
#define BLE_GAP_LESC_PASSKEY_CLEARED   (0x03)
 Notify that passkey cleared. More...
 
#define BLE_GAP_LESC_PASSKEY_ENTRY_COMPLETED   (0x04)
 Notify that passkey entry completed. More...
 
#define BLE_GAP_SEC_MITM_BEST_EFFORT   (0x00)
 MITM Protection not required. More...
 
#define BLE_GAP_SEC_MITM_STRICT   (0x01)
 MITM Protection required. More...
 
#define BLE_GAP_KEY_DIST_ENCKEY   (0x01)
 LTK. More...
 
#define BLE_GAP_KEY_DIST_IDKEY   (0x02)
 IRK and Identity Address. More...
 
#define BLE_GAP_KEY_DIST_SIGNKEY   (0x04)
 CSRK. More...
 
#define BLE_GAP_ID_ADDR_SIZE   (0x07)
 The size of identity address. More...
 
#define BLE_GAP_IRK_SIZE   (0x10)
 The size of IRK. More...
 
#define BLE_GAP_CSRK_SIZE   (0x10)
 The size of CSRK. More...
 
#define BLE_GAP_LTK_SIZE   (0x10)
 The size of LTK. More...
 
#define BLE_GAP_EDIV_SIZE   (0x02)
 The size of EDIV. More...
 
#define BLE_GAP_RAND_64_BIT_SIZE   (0x08)
 The size of Rand. More...
 
#define BLE_GAP_UNAUTH_PAIRING   (0x01)
 Unauthenticated pairing. More...
 
#define BLE_GAP_AUTH_PAIRING   (0x02)
 Authenticated pairing. More...
 
#define BLE_GAP_LEGACY_PAIRING   (0x01)
 Legacy pairing. More...
 
#define BLE_GAP_LESC_PAIRING   (0x02)
 Secure Connections. More...
 
#define BLE_GAP_BONDING_NONE   (0x00)
 The device doesn't support Bonding. More...
 
#define BLE_GAP_BONDING   (0x01)
 The device supports Bonding. More...
 
#define BLE_GAP_IOCAP_DISPLAY_ONLY   (0x00)
 Display Only iocapability. More...
 
#define BLE_GAP_IOCAP_DISPLAY_YESNO   (0x01)
 Display Yes/No iocapability. More...
 
#define BLE_GAP_IOCAP_KEYBOARD_ONLY   (0x02)
 Keyboard Only iocapability. More...
 
#define BLE_GAP_IOCAP_NOINPUT_NOOUTPUT   (0x03)
 No Input No Output iocapability. More...
 
#define BLE_GAP_IOCAP_KEYBOARD_DISPLAY   (0x04)
 Keyboard Display iocapability. More...
 
#define BLE_GAP_OOB_DATA_NOT_PRESENT   (0x00)
 Reply that No OOB data has been received when pairing. More...
 
#define BLE_GAP_OOB_DATA_PRESENT   (0x01)
 Reply that the OOB data has been received when pairing. More...
 
#define BLE_GAP_SC_BEST_EFFORT   (0x00)
 Accept Legacy pairing and Secure Connections. More...
 
#define BLE_GAP_SC_STRICT   (0x01)
 Accept only Secure Connections. More...
 
#define BLE_GAP_SC_KEY_PRESS_NTF_NOT_SPRT   (0x00)
 Not support for Key Press Notification. More...
 
#define BLE_GAP_SC_KEY_PRESS_NTF_SPRT   (0x01)
 Support for Key Press Notification. More...
 
#define BLE_GAP_LEGACY_OOB_SIZE   (0x10)
 The size of Temporary Key for OOB in legacy pairing. More...
 
#define BLE_GAP_OOB_CONFIRM_VAL_SIZE   (0x10)
 The size of Confirmation Value for OOB in Secure Connections. More...
 
#define BLE_GAP_OOB_RANDOM_VAL_SIZE   (0x10)
 The size of Rand for OOB in Secure Connections. More...
 
#define BLE_GAP_SEC_DEL_LOC_NONE   (0x00)
 Delete no local keys. More...
 
#define BLE_GAP_SEC_DEL_LOC_IRK   (0x01)
 Delete local IRK. More...
 
#define BLE_GAP_SEC_DEL_LOC_CSRK   (0x02)
 Delete local CSRK. More...
 
#define BLE_GAP_SEC_DEL_LOC_ALL   (0x03)
 Delete all local keys. More...
 
#define BLE_GAP_SEC_DEL_REM_NONE   (0x00)
 Delete no remote device keys. More...
 
#define BLE_GAP_SEC_DEL_REM_SA   (0x01)
 Delete a key specified by the p_addr parameter. More...
 
#define BLE_GAP_SEC_DEL_REM_NOT_CONN   (0x02)
 Delete keys of not connected remote devices. More...
 
#define BLE_GAP_SEC_DEL_REM_ALL   (0x03)
 Delete all remote device keys. More...
 

Macro Definition Documentation

◆ BLE_BD_ADDR_LEN

#define BLE_BD_ADDR_LEN   (0x06)

Bluetooth Device Address Size

◆ BLE_MASTER

#define BLE_MASTER   (0x00)

Master Role.

◆ BLE_SLAVE

#define BLE_SLAVE   (0x01)

Slave Role.

◆ BLE_GAP_ADDR_PUBLIC

#define BLE_GAP_ADDR_PUBLIC   (0x00)

Public Address.

◆ BLE_GAP_ADDR_RAND

#define BLE_GAP_ADDR_RAND   (0x01)

Random Address.

◆ BLE_GAP_ADDR_RPA_ID_PUBLIC

#define BLE_GAP_ADDR_RPA_ID_PUBLIC   (0x02)

Resolvable Private Address.

If the IRK of local device has not been registered in Resolving List, public address is used.

◆ BLE_GAP_ADDR_RPA_ID_RANDOM

#define BLE_GAP_ADDR_RPA_ID_RANDOM   (0x03)

Resolvable Private Address.

If the IRK of local device has not been registered in Resolving List, random address is used.

◆ BLE_GAP_AD_FLAGS_LE_LIM_DISC_MODE

#define BLE_GAP_AD_FLAGS_LE_LIM_DISC_MODE   (0x01)

LE Limited Discoverable Mode flag used in AD type.

◆ BLE_GAP_AD_FLAGS_LE_GEN_DISC_MODE

#define BLE_GAP_AD_FLAGS_LE_GEN_DISC_MODE   (0x02)

LE General Discoverable Mode flag used in AD type.

◆ BLE_GAP_AD_FLAGS_BR_EDR_NOT_SUPPORTED

#define BLE_GAP_AD_FLAGS_BR_EDR_NOT_SUPPORTED   (0x04)

BR/EDR Not Supported flag used in AD type.

◆ BLE_GAP_ADV_DATA_MODE

#define BLE_GAP_ADV_DATA_MODE   (0x00)

Advertising data.

◆ BLE_GAP_SCAN_RSP_DATA_MODE

#define BLE_GAP_SCAN_RSP_DATA_MODE   (0x01)

Scan response data.

◆ BLE_GAP_PERD_ADV_DATA_MODE

#define BLE_GAP_PERD_ADV_DATA_MODE   (0x02)

Periodic advertising data.

◆ BLE_GAP_ADV_CH_37

#define BLE_GAP_ADV_CH_37   (0x01)

Use 37 CH.

◆ BLE_GAP_ADV_CH_38

#define BLE_GAP_ADV_CH_38   (0x02)

Use 38 CH.

◆ BLE_GAP_ADV_CH_39

#define BLE_GAP_ADV_CH_39   (0x04)

Use 39 CH.

◆ BLE_GAP_ADV_CH_ALL

#define BLE_GAP_ADV_CH_ALL   (0x07)

Use 37 - 39 CH.

◆ BLE_GAP_SCAN_PASSIVE

#define BLE_GAP_SCAN_PASSIVE   (0x00)

Passive Scan.

◆ BLE_GAP_SCAN_ACTIVE

#define BLE_GAP_SCAN_ACTIVE   (0x01)

Active Scan.

◆ BLE_GAP_SCAN_INTV_MIN

#define BLE_GAP_SCAN_INTV_MIN   (0x0004)

Active Scan.

◆ BLE_GAP_SCAN_FILT_DUPLIC_DISABLE

#define BLE_GAP_SCAN_FILT_DUPLIC_DISABLE   (0x00)

Duplicate filter disabled.

◆ BLE_GAP_SCAN_FILT_DUPLIC_ENABLE

#define BLE_GAP_SCAN_FILT_DUPLIC_ENABLE   (0x01)

Duplicate filter enabled.

◆ BLE_GAP_SCAN_FILT_DUPLIC_ENABLE_FOR_PERIOD

#define BLE_GAP_SCAN_FILT_DUPLIC_ENABLE_FOR_PERIOD   (0x02)

Duplicate filtering enabled, reset for each scan period.

◆ BLE_GAP_SCAN_ALLOW_ADV_ALL

#define BLE_GAP_SCAN_ALLOW_ADV_ALL   (0x00)

Accept all advertising and scan response PDUs except directed advertising PDUs not addressed to local device.

◆ BLE_GAP_SCAN_ALLOW_ADV_WLST

#define BLE_GAP_SCAN_ALLOW_ADV_WLST   (0x01)

Accept only advertising and scan response PDUs from remote devices whose address is registered in the White List. Directed advertising PDUs which are not addressed to local device is ignored.

◆ BLE_GAP_SCAN_ALLOW_ADV_EXCEPT_DIRECTED

#define BLE_GAP_SCAN_ALLOW_ADV_EXCEPT_DIRECTED   (0x02)

Accept all advertising and scan response PDUs except directed advertising PDUs whose the target address is identity address but doesn't address local device. However directed advertising PDUs whose the target address is the local resolvable private address are accepted.

◆ BLE_GAP_SCAN_ALLOW_ADV_EXCEPT_DIRECTED_WLST

#define BLE_GAP_SCAN_ALLOW_ADV_EXCEPT_DIRECTED_WLST   (0x03)

Accept all advertising and scan response PDUs.
The following are excluded.

  • Advertising and scan response PDUs where the advertiser's identity address is not in the White List.
  • Directed advertising PDUs whose the target address is identity address but doesn't address local device. However directed advertising PDUs whose the target address is the local resolvable private address are accepted.

◆ BLE_GAP_INIT_FILT_USE_ADDR

#define BLE_GAP_INIT_FILT_USE_ADDR   (0x00)

White List is not used.

◆ BLE_GAP_INIT_FILT_USE_WLST

#define BLE_GAP_INIT_FILT_USE_WLST   (0x01)

White List is used.

◆ BLE_GAP_DATA_0_CLEAR

#define BLE_GAP_DATA_0_CLEAR   (0x01)

Clear the advertising data/scan response data/periodic advertising data in the advertising set.

◆ BLE_GAP_DATA_0_DID_UPD

#define BLE_GAP_DATA_0_DID_UPD   (0x02)

Update Advertising DID without changing advertising data.

◆ BLE_GAP_NET_PRIV_MODE

#define BLE_GAP_NET_PRIV_MODE   (0x00)

Network Privacy Mode.

◆ BLE_GAP_DEV_PRIV_MODE

#define BLE_GAP_DEV_PRIV_MODE   (0x01)

Device Privacy Mode.

◆ BLE_GAP_REM_FEATURE_SIZE

#define BLE_GAP_REM_FEATURE_SIZE   (0x08)

The length of the features supported by a remote device.

◆ BLE_GAP_NOT_AUTHORIZED

#define BLE_GAP_NOT_AUTHORIZED   (0x00)

Not authorize the remote device.

◆ BLE_GAP_AUTHORIZED

#define BLE_GAP_AUTHORIZED   (0x01)

Authorize the remote device.

◆ BLE_GAP_RMV_ADV_SET_REM_OP

#define BLE_GAP_RMV_ADV_SET_REM_OP   (0x01)

Delete an advertising set.

◆ BLE_GAP_RMV_ADV_SET_CLR_OP

#define BLE_GAP_RMV_ADV_SET_CLR_OP   (0x02)

Delete all the advertising sets.

◆ BLE_GAP_SC_PROC_GEN

#define BLE_GAP_SC_PROC_GEN   (0x02)

General Discovery Procedure.

◆ BLE_GAP_SC_PROC_LIM

#define BLE_GAP_SC_PROC_LIM   (0x01)

Limited Discovery Procedure.

◆ BLE_GAP_SC_PROC_OBS

#define BLE_GAP_SC_PROC_OBS   (0x00)

Observation Procedure.

◆ BLE_GAP_LIST_ADD_DEV

#define BLE_GAP_LIST_ADD_DEV   (0x01)

Add the device to the list.

◆ BLE_GAP_LIST_REM_DEV

#define BLE_GAP_LIST_REM_DEV   (0x02)

Delete the device from the list.

◆ BLE_GAP_LIST_CLR

#define BLE_GAP_LIST_CLR   (0x03)

Clear the list.

◆ BLE_GAP_WHITE_LIST_MAX_ENTRY

#define BLE_GAP_WHITE_LIST_MAX_ENTRY   (0x04)

The maximum entry number of White List.

◆ BLE_GAP_RSLV_LIST_MAX_ENTRY

#define BLE_GAP_RSLV_LIST_MAX_ENTRY   (0x08)

The maximum entry number of Resolving List.

◆ BLE_GAP_PERD_LIST_MAX_ENTRY

#define BLE_GAP_PERD_LIST_MAX_ENTRY   (0x04)

The maximum entry number of Periodic Advertiser List.

◆ BLE_GAP_RPA_DISABLED

#define BLE_GAP_RPA_DISABLED   (0x00)

Disable RPA generation/resolution.

◆ BLE_GAP_RPA_ENABLED

#define BLE_GAP_RPA_ENABLED   (0x01)

Enable RPA generation/resolution.

◆ BLE_GAP_RL_LOC_KEY_ALL_ZERO

#define BLE_GAP_RL_LOC_KEY_ALL_ZERO   (0x00)

All-zero IRK.

◆ BLE_GAP_RL_LOC_KEY_REGISTERED

#define BLE_GAP_RL_LOC_KEY_REGISTERED   (0x01)

The IRK registered by R_BLE_GAP_SetLocIdInfo().

◆ BLE_MAX_NO_OF_ADV_SETS_SUPPORTED

#define BLE_MAX_NO_OF_ADV_SETS_SUPPORTED   (BLE_ABS_CFG_RF_ADVERTISING_SET_MAXIMUM)

The maximum number of advertising set which the Controller supports.

◆ BLE_GAP_LEGACY_PROP_ADV_IND

#define BLE_GAP_LEGACY_PROP_ADV_IND   (0x0013)

Connectable and scannable undirected Legacy Advertising Packet.

◆ BLE_GAP_LEGACY_PROP_ADV_DIRECT_IND

#define BLE_GAP_LEGACY_PROP_ADV_DIRECT_IND   (0x0015)

Connectable directed (low duty cycle) Legacy Advertising Packet.

◆ BLE_GAP_LEGACY_PROP_ADV_HDC_DIRECT_IND

#define BLE_GAP_LEGACY_PROP_ADV_HDC_DIRECT_IND   (0x001D)

Connectable directed (high duty cycle) Legacy Advertising Packet.

◆ BLE_GAP_LEGACY_PROP_ADV_SCAN_IND

#define BLE_GAP_LEGACY_PROP_ADV_SCAN_IND   (0x0012)

Scannable undirected Legacy Advertising Packet.

◆ BLE_GAP_LEGACY_PROP_ADV_NONCONN_IND

#define BLE_GAP_LEGACY_PROP_ADV_NONCONN_IND   (0x0010)

Non-connectable and non-scannable undirected Legacy Advertising Packet.

◆ BLE_GAP_EXT_PROP_ADV_CONN_NOSCAN_UNDIRECT

#define BLE_GAP_EXT_PROP_ADV_CONN_NOSCAN_UNDIRECT   (0x0001)

Connectable and non-scannable undirected Extended Advertising Packet.

◆ BLE_GAP_EXT_PROP_ADV_CONN_NOSCAN_DIRECT

#define BLE_GAP_EXT_PROP_ADV_CONN_NOSCAN_DIRECT   (0x0005)

Connectable and non-scannable directed (low duty cycle) Extended Advertising Packet.

◆ BLE_GAP_EXT_PROP_ADV_CONN_NOSCAN_HDC_DIRECT

#define BLE_GAP_EXT_PROP_ADV_CONN_NOSCAN_HDC_DIRECT   (0x000D)

Connectable and non-scannable directed (high duty cycle) Extended Advertising Packet.

◆ BLE_GAP_EXT_PROP_ADV_NOCONN_SCAN_UNDIRECT

#define BLE_GAP_EXT_PROP_ADV_NOCONN_SCAN_UNDIRECT   (0x0002)

Non-connectable and scannable undirected Extended Advertising Packet.

◆ BLE_GAP_EXT_PROP_ADV_NOCONN_SCAN_DIRECT

#define BLE_GAP_EXT_PROP_ADV_NOCONN_SCAN_DIRECT   (0x0006)

Non-connectable and scannable directed (low duty cycle) Extended Advertising Packet.

◆ BLE_GAP_EXT_PROP_ADV_NOCONN_SCAN_HDC_DIRECT

#define BLE_GAP_EXT_PROP_ADV_NOCONN_SCAN_HDC_DIRECT   (0x000E)

Non-connectable and scannable directed (high duty cycle) Extended Advertising Packet.

◆ BLE_GAP_EXT_PROP_ADV_NOCONN_NOSCAN_UNDIRECT

#define BLE_GAP_EXT_PROP_ADV_NOCONN_NOSCAN_UNDIRECT   (0x0000)

Non-connectable and non-scannable undirected Extended Advertising Packet.

◆ BLE_GAP_EXT_PROP_ADV_NOCONN_NOSCAN_DIRECT

#define BLE_GAP_EXT_PROP_ADV_NOCONN_NOSCAN_DIRECT   (0x0004)

Non-connectable and non-scannable directed (low duty cycle) Extended Advertising Packet.

◆ BLE_GAP_EXT_PROP_ADV_NOCONN_NOSCAN_HDC_DIRECT

#define BLE_GAP_EXT_PROP_ADV_NOCONN_NOSCAN_HDC_DIRECT   (0x000C)

Non-connectable and non-scannable directed (high duty cycle) Extended Advertising Packet.

◆ BLE_GAP_EXT_PROP_ADV_ANONYMOUS

#define BLE_GAP_EXT_PROP_ADV_ANONYMOUS   (0x0020)

Omit the advertiser address from Extended Advertising Packet.

◆ BLE_GAP_EXT_PROP_ADV_INCLUDE_TX_POWER

#define BLE_GAP_EXT_PROP_ADV_INCLUDE_TX_POWER   (0x0040)

Indicate that the advertising data includes TX Power.

◆ BLE_GAP_ADV_ALLOW_SCAN_ANY_CONN_ANY

#define BLE_GAP_ADV_ALLOW_SCAN_ANY_CONN_ANY   (0x00)

Process scan and connection requests from all devices.

◆ BLE_GAP_ADV_ALLOW_SCAN_WLST_CONN_ANY

#define BLE_GAP_ADV_ALLOW_SCAN_WLST_CONN_ANY   (0x01)

Process connection requests from all devices and scan requests from only devices that are in the White List.

◆ BLE_GAP_ADV_ALLOW_SCAN_ANY_CONN_WLST

#define BLE_GAP_ADV_ALLOW_SCAN_ANY_CONN_WLST   (0x02)

Process scan requests from all devices and connection requests from only devices that are in the White List.

◆ BLE_GAP_ADV_ALLOW_SCAN_WLST_CONN_WLST

#define BLE_GAP_ADV_ALLOW_SCAN_WLST_CONN_WLST   (0x03)

Process scan and connection requests from only devices in the White List.

◆ BLE_GAP_ADV_PHY_1M

#define BLE_GAP_ADV_PHY_1M   (0x01)

Use 1M PHY.

◆ BLE_GAP_ADV_PHY_2M

#define BLE_GAP_ADV_PHY_2M   (0x02)

Use 2M PHY.

◆ BLE_GAP_ADV_PHY_CD

#define BLE_GAP_ADV_PHY_CD   (0x03)

Use Coded PHY.

◆ BLE_GAP_SCAN_REQ_NTF_DISABLE

#define BLE_GAP_SCAN_REQ_NTF_DISABLE   (0x00)

Disable Scan Request Notification.

◆ BLE_GAP_SCAN_REQ_NTF_ENABLE

#define BLE_GAP_SCAN_REQ_NTF_ENABLE   (0x01)

Enable Scan Request Notification.

◆ BLE_GAP_PERD_PROP_TX_POWER

#define BLE_GAP_PERD_PROP_TX_POWER   (0x0040)

Indicate that periodic advertising data includes Tx Power.

◆ BLE_GAP_INVALID_ADV_HDL

#define BLE_GAP_INVALID_ADV_HDL   (0xFF)

Invalid advertising handle.

◆ BLE_GAP_SET_PHYS_HOST_PREF_1M

#define BLE_GAP_SET_PHYS_HOST_PREF_1M   (0x01)

Use 1M PHY.

◆ BLE_GAP_SET_PHYS_HOST_PREF_2M

#define BLE_GAP_SET_PHYS_HOST_PREF_2M   (0x02)

Use 2M PHY.

◆ BLE_GAP_SET_PHYS_HOST_PREF_CD

#define BLE_GAP_SET_PHYS_HOST_PREF_CD   (0x04)

Use Coded PHY.

◆ BLE_GAP_SET_PHYS_OP_HOST_NO_PREF

#define BLE_GAP_SET_PHYS_OP_HOST_NO_PREF   (0x00)

No preferred coding.

◆ BLE_GAP_SET_PHYS_OP_HOST_PREF_S_2

#define BLE_GAP_SET_PHYS_OP_HOST_PREF_S_2   (0x01)

Use S=2 coding.

◆ BLE_GAP_SET_PHYS_OP_HOST_PREF_S_8

#define BLE_GAP_SET_PHYS_OP_HOST_PREF_S_8   (0x02)

Use S=8 coding.

◆ BLE_GAP_CONN_UPD_MODE_REQ

#define BLE_GAP_CONN_UPD_MODE_REQ   (0x01)

Request for updating the connection parameters.

◆ BLE_GAP_CONN_UPD_MODE_RSP

#define BLE_GAP_CONN_UPD_MODE_RSP   (0x02)

Reply a connection parameter update request.

◆ BLE_GAP_CONN_UPD_ACCEPT

#define BLE_GAP_CONN_UPD_ACCEPT   (0x0000)

Accept the update request.

◆ BLE_GAP_CONN_UPD_REJECT

#define BLE_GAP_CONN_UPD_REJECT   (0x0001)

Reject the update request.

◆ BLE_GAP_CH_MAP_SIZE

#define BLE_GAP_CH_MAP_SIZE   (0x05)

The size of channel map.

◆ BLE_GAP_INVALID_CONN_HDL

#define BLE_GAP_INVALID_CONN_HDL   (0xFFFF)

Invalid Connection handle.

◆ BLE_GAP_NOT_USE_CONN_HDL

#define BLE_GAP_NOT_USE_CONN_HDL   BLE_GAP_INVALID_CONN_HDL

This macro indicates that connection handle is not used.

◆ BLE_GAP_INIT_CONN_HDL

#define BLE_GAP_INIT_CONN_HDL   BLE_GAP_INVALID_CONN_HDL

Initial Connection handle.

◆ BLE_GAP_PAIRING_ACCEPT

#define BLE_GAP_PAIRING_ACCEPT   (0x00)

Accept a request regarding pairing.

◆ BLE_GAP_PAIRING_REJECT

#define BLE_GAP_PAIRING_REJECT   (0x01)

Reject a request regarding pairing.

◆ BLE_GAP_LTK_REQ_ACCEPT

#define BLE_GAP_LTK_REQ_ACCEPT   (0x00)

Reply for the LTK request.

◆ BLE_GAP_LTK_REQ_DENY

#define BLE_GAP_LTK_REQ_DENY   (0x01)

Reject the LTK request.

◆ BLE_GAP_LESC_PASSKEY_ENTRY_STARTED

#define BLE_GAP_LESC_PASSKEY_ENTRY_STARTED   (0x00)

Notify that passkey entry started.

◆ BLE_GAP_LESC_PASSKEY_DIGIT_ENTERED

#define BLE_GAP_LESC_PASSKEY_DIGIT_ENTERED   (0x01)

Notify that passkey digit entered.

◆ BLE_GAP_LESC_PASSKEY_DIGIT_ERASED

#define BLE_GAP_LESC_PASSKEY_DIGIT_ERASED   (0x02)

Notify that passkey digit erased.

◆ BLE_GAP_LESC_PASSKEY_CLEARED

#define BLE_GAP_LESC_PASSKEY_CLEARED   (0x03)

Notify that passkey cleared.

◆ BLE_GAP_LESC_PASSKEY_ENTRY_COMPLETED

#define BLE_GAP_LESC_PASSKEY_ENTRY_COMPLETED   (0x04)

Notify that passkey entry completed.

◆ BLE_GAP_SEC_MITM_BEST_EFFORT

#define BLE_GAP_SEC_MITM_BEST_EFFORT   (0x00)

MITM Protection not required.

◆ BLE_GAP_SEC_MITM_STRICT

#define BLE_GAP_SEC_MITM_STRICT   (0x01)

MITM Protection required.

◆ BLE_GAP_KEY_DIST_ENCKEY

#define BLE_GAP_KEY_DIST_ENCKEY   (0x01)

LTK.

◆ BLE_GAP_KEY_DIST_IDKEY

#define BLE_GAP_KEY_DIST_IDKEY   (0x02)

IRK and Identity Address.

◆ BLE_GAP_KEY_DIST_SIGNKEY

#define BLE_GAP_KEY_DIST_SIGNKEY   (0x04)

CSRK.

◆ BLE_GAP_ID_ADDR_SIZE

#define BLE_GAP_ID_ADDR_SIZE   (0x07)

The size of identity address.

◆ BLE_GAP_IRK_SIZE

#define BLE_GAP_IRK_SIZE   (0x10)

The size of IRK.

◆ BLE_GAP_CSRK_SIZE

#define BLE_GAP_CSRK_SIZE   (0x10)

The size of CSRK.

◆ BLE_GAP_LTK_SIZE

#define BLE_GAP_LTK_SIZE   (0x10)

The size of LTK.

◆ BLE_GAP_EDIV_SIZE

#define BLE_GAP_EDIV_SIZE   (0x02)

The size of EDIV.

◆ BLE_GAP_RAND_64_BIT_SIZE

#define BLE_GAP_RAND_64_BIT_SIZE   (0x08)

The size of Rand.

◆ BLE_GAP_UNAUTH_PAIRING

#define BLE_GAP_UNAUTH_PAIRING   (0x01)

Unauthenticated pairing.

◆ BLE_GAP_AUTH_PAIRING

#define BLE_GAP_AUTH_PAIRING   (0x02)

Authenticated pairing.

◆ BLE_GAP_LEGACY_PAIRING

#define BLE_GAP_LEGACY_PAIRING   (0x01)

Legacy pairing.

◆ BLE_GAP_LESC_PAIRING

#define BLE_GAP_LESC_PAIRING   (0x02)

Secure Connections.

◆ BLE_GAP_BONDING_NONE

#define BLE_GAP_BONDING_NONE   (0x00)

The device doesn't support Bonding.

◆ BLE_GAP_BONDING

#define BLE_GAP_BONDING   (0x01)

The device supports Bonding.

◆ BLE_GAP_IOCAP_DISPLAY_ONLY

#define BLE_GAP_IOCAP_DISPLAY_ONLY   (0x00)

Display Only iocapability.

Output function : Local device has the ability to display a 6 digit decimal number.
Input function : None

◆ BLE_GAP_IOCAP_DISPLAY_YESNO

#define BLE_GAP_IOCAP_DISPLAY_YESNO   (0x01)

Display Yes/No iocapability.

Output function : Output function : Local device has the ability to display a 6 digit decimal number.
Input function : Local device has the ability to indicate 'yes' or 'no'

◆ BLE_GAP_IOCAP_KEYBOARD_ONLY

#define BLE_GAP_IOCAP_KEYBOARD_ONLY   (0x02)

Keyboard Only iocapability.

Output function : None
Input function : Local device has the ability to input the number '0' - '9'.

◆ BLE_GAP_IOCAP_NOINPUT_NOOUTPUT

#define BLE_GAP_IOCAP_NOINPUT_NOOUTPUT   (0x03)

No Input No Output iocapability.

Output function : None
Input function : None

◆ BLE_GAP_IOCAP_KEYBOARD_DISPLAY

#define BLE_GAP_IOCAP_KEYBOARD_DISPLAY   (0x04)

Keyboard Display iocapability.

Output function : Output function : Local device has the ability to display a 6 digit decimal number.
Input function : Local device has the ability to input the number '0' - '9'.

◆ BLE_GAP_OOB_DATA_NOT_PRESENT

#define BLE_GAP_OOB_DATA_NOT_PRESENT   (0x00)

Reply that No OOB data has been received when pairing.

◆ BLE_GAP_OOB_DATA_PRESENT

#define BLE_GAP_OOB_DATA_PRESENT   (0x01)

Reply that the OOB data has been received when pairing.

◆ BLE_GAP_SC_BEST_EFFORT

#define BLE_GAP_SC_BEST_EFFORT   (0x00)

Accept Legacy pairing and Secure Connections.

◆ BLE_GAP_SC_STRICT

#define BLE_GAP_SC_STRICT   (0x01)

Accept only Secure Connections.

◆ BLE_GAP_SC_KEY_PRESS_NTF_NOT_SPRT

#define BLE_GAP_SC_KEY_PRESS_NTF_NOT_SPRT   (0x00)

Not support for Key Press Notification.

◆ BLE_GAP_SC_KEY_PRESS_NTF_SPRT

#define BLE_GAP_SC_KEY_PRESS_NTF_SPRT   (0x01)

Support for Key Press Notification.

◆ BLE_GAP_LEGACY_OOB_SIZE

#define BLE_GAP_LEGACY_OOB_SIZE   (0x10)

The size of Temporary Key for OOB in legacy pairing.

◆ BLE_GAP_OOB_CONFIRM_VAL_SIZE

#define BLE_GAP_OOB_CONFIRM_VAL_SIZE   (0x10)

The size of Confirmation Value for OOB in Secure Connections.

◆ BLE_GAP_OOB_RANDOM_VAL_SIZE

#define BLE_GAP_OOB_RANDOM_VAL_SIZE   (0x10)

The size of Rand for OOB in Secure Connections.

◆ BLE_GAP_SEC_DEL_LOC_NONE

#define BLE_GAP_SEC_DEL_LOC_NONE   (0x00)

Delete no local keys.

◆ BLE_GAP_SEC_DEL_LOC_IRK

#define BLE_GAP_SEC_DEL_LOC_IRK   (0x01)

Delete local IRK.

◆ BLE_GAP_SEC_DEL_LOC_CSRK

#define BLE_GAP_SEC_DEL_LOC_CSRK   (0x02)

Delete local CSRK.

◆ BLE_GAP_SEC_DEL_LOC_ALL

#define BLE_GAP_SEC_DEL_LOC_ALL   (0x03)

Delete all local keys.

◆ BLE_GAP_SEC_DEL_REM_NONE

#define BLE_GAP_SEC_DEL_REM_NONE   (0x00)

Delete no remote device keys.

◆ BLE_GAP_SEC_DEL_REM_SA

#define BLE_GAP_SEC_DEL_REM_SA   (0x01)

Delete a key specified by the p_addr parameter.

◆ BLE_GAP_SEC_DEL_REM_NOT_CONN

#define BLE_GAP_SEC_DEL_REM_NOT_CONN   (0x02)

Delete keys of not connected remote devices.

◆ BLE_GAP_SEC_DEL_REM_ALL

#define BLE_GAP_SEC_DEL_REM_ALL   (0x03)

Delete all remote device keys.