mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
f93025b7f9
feat(nimble): Exposed macros used by GAP service to menuconfig (v5.1) See merge request espressif/esp-idf!29505
1044 lines
34 KiB
Plaintext
1044 lines
34 KiB
Plaintext
|
|
choice BT_NIMBLE_MEM_ALLOC_MODE
|
|
prompt "Memory allocation strategy"
|
|
default BT_NIMBLE_MEM_ALLOC_MODE_INTERNAL
|
|
help
|
|
Allocation strategy for NimBLE host stack, essentially provides ability to
|
|
allocate all required dynamic allocations from,
|
|
|
|
- Internal DRAM memory only
|
|
- External SPIRAM memory only
|
|
- Either internal or external memory based on default malloc()
|
|
behavior in ESP-IDF
|
|
- Internal IRAM memory wherever applicable else internal DRAM
|
|
|
|
config BT_NIMBLE_MEM_ALLOC_MODE_INTERNAL
|
|
bool "Internal memory"
|
|
|
|
config BT_NIMBLE_MEM_ALLOC_MODE_EXTERNAL
|
|
bool "External SPIRAM"
|
|
depends on SPIRAM_USE_CAPS_ALLOC || SPIRAM_USE_MALLOC
|
|
|
|
config BT_NIMBLE_MEM_ALLOC_MODE_DEFAULT
|
|
bool "Default alloc mode"
|
|
|
|
config BT_NIMBLE_MEM_ALLOC_MODE_IRAM_8BIT
|
|
bool "Internal IRAM"
|
|
depends on ESP32_IRAM_AS_8BIT_ACCESSIBLE_MEMORY
|
|
help
|
|
Allows to use IRAM memory region as 8bit accessible region.
|
|
|
|
Every unaligned (8bit or 16bit) access will result in an exception
|
|
and incur penalty of certain clock cycles per unaligned read/write.
|
|
|
|
endchoice #BT_NIMBLE_MEM_ALLOC_MODE
|
|
|
|
choice BT_NIMBLE_LOG_LEVEL
|
|
prompt "NimBLE Host log verbosity"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default BT_NIMBLE_LOG_LEVEL_INFO
|
|
help
|
|
Select NimBLE log level. Please make a note that the selected NimBLE log
|
|
verbosity can not exceed the level set in "Component config --> Log output
|
|
--> Default log verbosity".
|
|
|
|
config BT_NIMBLE_LOG_LEVEL_NONE
|
|
bool "No logs"
|
|
config BT_NIMBLE_LOG_LEVEL_ERROR
|
|
bool "Error logs"
|
|
config BT_NIMBLE_LOG_LEVEL_WARNING
|
|
bool "Warning logs"
|
|
config BT_NIMBLE_LOG_LEVEL_INFO
|
|
bool "Info logs"
|
|
config BT_NIMBLE_LOG_LEVEL_DEBUG
|
|
bool "Debug logs"
|
|
endchoice #BT_NIMBLE_LOG_LEVEL
|
|
|
|
config BT_NIMBLE_LOG_LEVEL
|
|
int
|
|
default 0 if BT_NIMBLE_LOG_LEVEL_DEBUG
|
|
default 1 if BT_NIMBLE_LOG_LEVEL_INFO
|
|
default 2 if BT_NIMBLE_LOG_LEVEL_WARNING
|
|
default 3 if BT_NIMBLE_LOG_LEVEL_ERROR
|
|
default 4 if BT_NIMBLE_LOG_LEVEL_NONE
|
|
|
|
config BT_NIMBLE_MAX_CONNECTIONS
|
|
int "Maximum number of concurrent connections"
|
|
range 1 2 if IDF_TARGET_ESP32C2
|
|
range 1 70 if IDF_TARGET_ESP32C6
|
|
range 1 35 if IDF_TARGET_ESP32H2
|
|
range 1 9
|
|
default 2 if IDF_TARGET_ESP32C2
|
|
default 3
|
|
depends on BT_NIMBLE_ENABLED
|
|
help
|
|
Defines maximum number of concurrent BLE connections. For ESP32, user
|
|
is expected to configure BTDM_CTRL_BLE_MAX_CONN from controller menu
|
|
along with this option. Similarly for ESP32-C3 or ESP32-S3, user is expected to
|
|
configure BT_CTRL_BLE_MAX_ACT from controller menu.
|
|
For ESP32C2, ESP32C6 and ESP32H2, each connection will take about 1k DRAM.
|
|
|
|
config BT_NIMBLE_MAX_BONDS
|
|
int "Maximum number of bonds to save across reboots"
|
|
default 3
|
|
depends on BT_NIMBLE_ENABLED
|
|
help
|
|
Defines maximum number of bonds to save for peer security and our security
|
|
|
|
config BT_NIMBLE_MAX_CCCDS
|
|
int "Maximum number of CCC descriptors to save across reboots"
|
|
default 8
|
|
depends on BT_NIMBLE_ENABLED
|
|
help
|
|
Defines maximum number of CCC descriptors to save
|
|
|
|
config BT_NIMBLE_L2CAP_COC_MAX_NUM
|
|
int "Maximum number of connection oriented channels"
|
|
range 0 9
|
|
depends on BT_NIMBLE_ENABLED
|
|
default 0
|
|
help
|
|
Defines maximum number of BLE Connection Oriented Channels. When set to (0), BLE COC is not compiled in
|
|
|
|
choice BT_NIMBLE_PINNED_TO_CORE_CHOICE
|
|
prompt "The CPU core on which NimBLE host will run"
|
|
depends on BT_NIMBLE_ENABLED && !FREERTOS_UNICORE
|
|
help
|
|
The CPU core on which NimBLE host will run. You can choose Core 0 or Core 1.
|
|
Cannot specify no-affinity
|
|
|
|
config BT_NIMBLE_PINNED_TO_CORE_0
|
|
bool "Core 0 (PRO CPU)"
|
|
config BT_NIMBLE_PINNED_TO_CORE_1
|
|
bool "Core 1 (APP CPU)"
|
|
depends on !FREERTOS_UNICORE
|
|
endchoice
|
|
|
|
config BT_NIMBLE_PINNED_TO_CORE
|
|
int
|
|
depends on BT_NIMBLE_ENABLED
|
|
default 0 if BT_NIMBLE_PINNED_TO_CORE_0
|
|
default 1 if BT_NIMBLE_PINNED_TO_CORE_1
|
|
default 0
|
|
|
|
config BT_NIMBLE_HOST_TASK_STACK_SIZE
|
|
int "NimBLE Host task stack size"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default 5120 if BLE_MESH
|
|
default 4096
|
|
help
|
|
This configures stack size of NimBLE host task
|
|
|
|
config BT_NIMBLE_ROLE_CENTRAL
|
|
bool "Enable BLE Central role"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default y
|
|
help
|
|
Enables central role
|
|
|
|
config BT_NIMBLE_ROLE_PERIPHERAL
|
|
bool "Enable BLE Peripheral role"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default y
|
|
help
|
|
Enable peripheral role
|
|
|
|
config BT_NIMBLE_ROLE_BROADCASTER
|
|
bool "Enable BLE Broadcaster role"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default y
|
|
help
|
|
Enables broadcaster role
|
|
|
|
config BT_NIMBLE_ROLE_OBSERVER
|
|
bool "Enable BLE Observer role"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default y
|
|
help
|
|
Enables observer role
|
|
|
|
config BT_NIMBLE_NVS_PERSIST
|
|
bool "Persist the BLE Bonding keys in NVS"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default n
|
|
help
|
|
Enable this flag to make bonding persistent across device reboots
|
|
|
|
menuconfig BT_NIMBLE_SECURITY_ENABLE
|
|
bool "Enable BLE SM feature"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default y
|
|
help
|
|
Enable BLE sm feature
|
|
|
|
config BT_NIMBLE_SM_LEGACY
|
|
bool "Security manager legacy pairing"
|
|
depends on BT_NIMBLE_SECURITY_ENABLE
|
|
default y
|
|
help
|
|
Enable security manager legacy pairing
|
|
|
|
config BT_NIMBLE_SM_SC
|
|
bool "Security manager secure connections (4.2)"
|
|
depends on BT_NIMBLE_SECURITY_ENABLE
|
|
default y
|
|
help
|
|
Enable security manager secure connections
|
|
|
|
config BT_NIMBLE_SM_SC_DEBUG_KEYS
|
|
bool "Use predefined public-private key pair"
|
|
default n
|
|
depends on BT_NIMBLE_SECURITY_ENABLE && BT_NIMBLE_SM_SC
|
|
help
|
|
If this option is enabled, SM uses predefined DH key pair as described
|
|
in Core Specification, Vol. 3, Part H, 2.3.5.6.1. This allows to
|
|
decrypt air traffic easily and thus should only be used for debugging.
|
|
|
|
config BT_NIMBLE_LL_CFG_FEAT_LE_ENCRYPTION
|
|
bool "Enable LE encryption"
|
|
depends on BT_NIMBLE_SECURITY_ENABLE && BT_NIMBLE_ENABLED
|
|
default y
|
|
help
|
|
Enable encryption connection
|
|
|
|
config BT_NIMBLE_SM_SC_LVL
|
|
int "Security level"
|
|
depends on BT_NIMBLE_SECURITY_ENABLE
|
|
default 0
|
|
help
|
|
LE Security Mode 1 Levels:
|
|
1. No Security
|
|
2. Unauthenticated pairing with encryption
|
|
3. Authenticated pairing with encryption
|
|
4. Authenticated LE Secure Connections pairing with encryption using a 128-bit strength encryption key.
|
|
|
|
config BT_NIMBLE_DEBUG
|
|
bool "Enable extra runtime asserts and host debugging"
|
|
default n
|
|
depends on BT_NIMBLE_ENABLED
|
|
help
|
|
This enables extra runtime asserts and host debugging
|
|
|
|
config BT_NIMBLE_DYNAMIC_SERVICE
|
|
bool "Enable dynamic services"
|
|
depends on BT_NIMBLE_ENABLED
|
|
help
|
|
This enables user to add/remove Gatt services at runtime
|
|
|
|
config BT_NIMBLE_SVC_GAP_DEVICE_NAME
|
|
string "BLE GAP default device name"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default "nimble"
|
|
help
|
|
The Device Name characteristic shall contain the name of the device as an UTF-8 string.
|
|
This name can be changed by using API ble_svc_gap_device_name_set()
|
|
|
|
config BT_NIMBLE_GAP_DEVICE_NAME_MAX_LEN
|
|
int "Maximum length of BLE device name in octets"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default 31
|
|
help
|
|
Device Name characteristic value shall be 0 to 248 octets in length
|
|
|
|
config BT_NIMBLE_ATT_PREFERRED_MTU
|
|
int "Preferred MTU size in octets"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default 256
|
|
help
|
|
This is the default value of ATT MTU indicated by the device during an ATT MTU exchange.
|
|
This value can be changed using API ble_att_set_preferred_mtu()
|
|
|
|
config BT_NIMBLE_SVC_GAP_APPEARANCE
|
|
hex "External appearance of the device"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default 0
|
|
help
|
|
Standard BLE GAP Appearance value in HEX format e.g. 0x02C0
|
|
|
|
|
|
menu "Memory Settings"
|
|
config BT_NIMBLE_MSYS_1_BLOCK_COUNT
|
|
int "MSYS_1 Block Count"
|
|
default 24 if SOC_ESP_NIMBLE_CONTROLLER
|
|
default 12 if !SOC_ESP_NIMBLE_CONTROLLER
|
|
help
|
|
MSYS is a system level mbuf registry. For prepare write & prepare
|
|
responses MBUFs are allocated out of msys_1 pool. For NIMBLE_MESH
|
|
enabled cases, this block count is increased by 8 than user defined
|
|
count.
|
|
|
|
config BT_NIMBLE_MSYS_1_BLOCK_SIZE
|
|
int "MSYS_1 Block Size"
|
|
default 128 if SOC_ESP_NIMBLE_CONTROLLER
|
|
default 256 if !SOC_ESP_NIMBLE_CONTROLLER
|
|
help
|
|
Dynamic memory size of block 1
|
|
|
|
config BT_NIMBLE_MSYS_2_BLOCK_COUNT
|
|
int "MSYS_2 Block Count"
|
|
default 24
|
|
help
|
|
Dynamic memory count
|
|
|
|
config BT_NIMBLE_MSYS_2_BLOCK_SIZE
|
|
int "MSYS_2 Block Size"
|
|
default 320
|
|
help
|
|
Dynamic memory size of block 2
|
|
|
|
config BT_NIMBLE_MSYS_BUF_FROM_HEAP
|
|
bool "Get Msys Mbuf from heap"
|
|
default y
|
|
depends on BT_LE_MSYS_INIT_IN_CONTROLLER
|
|
help
|
|
This option sets the source of the shared msys mbuf memory between
|
|
the Host and the Controller. Allocate the memory from the heap if
|
|
this option is sets, from the mempool otherwise.
|
|
|
|
config BT_NIMBLE_TRANSPORT_ACL_FROM_LL_COUNT
|
|
int "ACL Buffer count"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default 24
|
|
help
|
|
The number of ACL data buffers allocated for host.
|
|
|
|
config BT_NIMBLE_TRANSPORT_ACL_SIZE
|
|
int "Transport ACL Buffer size"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default 255
|
|
help
|
|
This is the maximum size of the data portion of HCI ACL data packets.
|
|
It does not include the HCI data header (of 4 bytes)
|
|
|
|
config BT_NIMBLE_TRANSPORT_EVT_SIZE
|
|
int "Transport Event Buffer size"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default 257 if BT_NIMBLE_EXT_ADV
|
|
default 70
|
|
help
|
|
This is the size of each HCI event buffer in bytes. In case of
|
|
extended advertising, packets can be fragmented. 257 bytes is the
|
|
maximum size of a packet.
|
|
|
|
config BT_NIMBLE_TRANSPORT_EVT_COUNT
|
|
int "Transport Event Buffer count"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default 30
|
|
help
|
|
This is the high priority HCI events' buffer size. High-priority
|
|
event buffers are for everything except advertising reports. If there
|
|
are no free high-priority event buffers then host will try to allocate a
|
|
low-priority buffer instead
|
|
|
|
config BT_NIMBLE_TRANSPORT_EVT_DISCARD_COUNT
|
|
int "Discardable Transport Event Buffer count"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default 8
|
|
help
|
|
This is the low priority HCI events' buffer size. Low-priority event
|
|
buffers are only used for advertising reports. If there are no free
|
|
low-priority event buffers, then an incoming advertising report will
|
|
get dropped
|
|
|
|
endmenu
|
|
|
|
config BT_NIMBLE_GATT_MAX_PROCS
|
|
int "Maximum number of GATT client procedures"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default 4
|
|
help
|
|
Maximum number of GATT client procedures that can be executed.
|
|
|
|
config BT_NIMBLE_HS_FLOW_CTRL
|
|
bool "Enable Host Flow control"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default y if IDF_TARGET_ESP32
|
|
default n
|
|
help
|
|
Enable Host Flow control
|
|
|
|
config BT_NIMBLE_HS_FLOW_CTRL_ITVL
|
|
int "Host Flow control interval"
|
|
depends on BT_NIMBLE_HS_FLOW_CTRL
|
|
default 1000
|
|
help
|
|
Host flow control interval in msecs
|
|
|
|
config BT_NIMBLE_HS_FLOW_CTRL_THRESH
|
|
int "Host Flow control threshold"
|
|
depends on BT_NIMBLE_HS_FLOW_CTRL
|
|
default 2
|
|
help
|
|
Host flow control threshold, if the number of free buffers are at or
|
|
below this threshold, send an immediate number-of-completed-packets
|
|
event
|
|
|
|
config BT_NIMBLE_HS_FLOW_CTRL_TX_ON_DISCONNECT
|
|
bool "Host Flow control on disconnect"
|
|
depends on BT_NIMBLE_HS_FLOW_CTRL
|
|
default y
|
|
help
|
|
Enable this option to send number-of-completed-packets event to
|
|
controller after disconnection
|
|
|
|
config BT_NIMBLE_RPA_TIMEOUT
|
|
int "RPA timeout in seconds"
|
|
range 1 41400
|
|
depends on BT_NIMBLE_ENABLED
|
|
default 900
|
|
help
|
|
Time interval between RPA address change.
|
|
|
|
menuconfig BT_NIMBLE_MESH
|
|
bool "Enable BLE mesh functionality"
|
|
select BT_NIMBLE_SM_SC
|
|
depends on BT_NIMBLE_ENABLED
|
|
default n
|
|
help
|
|
Enable BLE Mesh example present in upstream mynewt-nimble and not maintained by Espressif.
|
|
|
|
IDF maintains ESP-BLE-MESH as the official Mesh solution. Please refer to ESP-BLE-MESH guide at:
|
|
`https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/esp-ble-mesh/ble-mesh-index.html`
|
|
|
|
config BT_NIMBLE_MESH_PROXY
|
|
bool "Enable mesh proxy functionality"
|
|
default n
|
|
depends on BT_NIMBLE_MESH
|
|
help
|
|
Enable proxy. This is automatically set whenever NIMBLE_MESH_PB_GATT or
|
|
NIMBLE_MESH_GATT_PROXY is set
|
|
|
|
|
|
config BT_NIMBLE_MESH_PROV
|
|
bool "Enable BLE mesh provisioning"
|
|
default y
|
|
depends on BT_NIMBLE_MESH
|
|
help
|
|
Enable mesh provisioning
|
|
|
|
config BT_NIMBLE_MESH_PB_ADV
|
|
bool "Enable mesh provisioning over advertising bearer"
|
|
default y
|
|
depends on BT_NIMBLE_MESH_PROV
|
|
help
|
|
Enable this option to allow the device to be provisioned over
|
|
the advertising bearer
|
|
|
|
|
|
config BT_NIMBLE_MESH_PB_GATT
|
|
bool "Enable mesh provisioning over GATT bearer"
|
|
default y
|
|
select BT_NIMBLE_MESH_PROXY
|
|
depends on BT_NIMBLE_MESH_PROV
|
|
help
|
|
Enable this option to allow the device to be provisioned over the GATT
|
|
bearer
|
|
|
|
config BT_NIMBLE_MESH_GATT_PROXY
|
|
bool "Enable GATT Proxy functionality"
|
|
default y
|
|
select BT_NIMBLE_MESH_PROXY
|
|
depends on BT_NIMBLE_MESH
|
|
help
|
|
This option enables support for the Mesh GATT Proxy Service,
|
|
i.e. the ability to act as a proxy between a Mesh GATT Client
|
|
and a Mesh network
|
|
|
|
config BT_NIMBLE_MESH_RELAY
|
|
bool "Enable mesh relay functionality"
|
|
default n
|
|
depends on BT_NIMBLE_MESH
|
|
help
|
|
Support for acting as a Mesh Relay Node
|
|
|
|
config BT_NIMBLE_MESH_LOW_POWER
|
|
bool "Enable mesh low power mode"
|
|
default n
|
|
depends on BT_NIMBLE_MESH
|
|
help
|
|
Enable this option to be able to act as a Low Power Node
|
|
|
|
config BT_NIMBLE_MESH_FRIEND
|
|
bool "Enable mesh friend functionality"
|
|
default n
|
|
depends on BT_NIMBLE_MESH
|
|
help
|
|
Enable this option to be able to act as a Friend Node
|
|
|
|
config BT_NIMBLE_MESH_DEVICE_NAME
|
|
string "Set mesh device name"
|
|
default "nimble-mesh-node"
|
|
depends on BT_NIMBLE_MESH
|
|
help
|
|
This value defines Bluetooth Mesh device/node name
|
|
|
|
config BT_NIMBLE_MESH_NODE_COUNT
|
|
int "Set mesh node count"
|
|
default 1
|
|
depends on BT_NIMBLE_MESH
|
|
help
|
|
Defines mesh node count.
|
|
|
|
config BT_NIMBLE_MESH_PROVISIONER
|
|
bool "Enable BLE mesh provisioner"
|
|
default 0
|
|
depends on BT_NIMBLE_MESH
|
|
help
|
|
Enable mesh provisioner.
|
|
|
|
config BT_NIMBLE_CRYPTO_STACK_MBEDTLS
|
|
bool "Override TinyCrypt with mbedTLS for crypto computations"
|
|
default y
|
|
depends on BT_NIMBLE_ENABLED
|
|
select MBEDTLS_ECP_RESTARTABLE
|
|
select MBEDTLS_CMAC_C
|
|
help
|
|
Enable this option to choose mbedTLS instead of TinyCrypt for crypto
|
|
computations.
|
|
|
|
config BT_NIMBLE_HS_STOP_TIMEOUT_MS
|
|
int "BLE host stop timeout in msec"
|
|
default 2000
|
|
depends on BT_NIMBLE_ENABLED
|
|
help
|
|
BLE Host stop procedure timeout in milliseconds.
|
|
|
|
config BT_NIMBLE_HOST_BASED_PRIVACY
|
|
bool "Enable host based privacy for random address."
|
|
default n
|
|
depends on BT_NIMBLE_ENABLED && IDF_TARGET_ESP32
|
|
help
|
|
Use this option to do host based Random Private Address resolution.
|
|
If this option is disabled then controller based privacy is used.
|
|
|
|
config BT_NIMBLE_ENABLE_CONN_REATTEMPT
|
|
bool "Enable connection reattempts on connection establishment error"
|
|
default y if (IDF_TARGET_ESP32C3 || IDF_TARGET_ESP32S3 || SOC_ESP_NIMBLE_CONTROLLER)
|
|
default n if IDF_TARGET_ESP32
|
|
help
|
|
Enable to make the NimBLE host to reattempt GAP connection on connection
|
|
establishment failure.
|
|
|
|
config BT_NIMBLE_MAX_CONN_REATTEMPT
|
|
int "Maximum number connection reattempts"
|
|
range 1 255
|
|
default 3
|
|
depends on BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLE_CONN_REATTEMPT
|
|
help
|
|
Defines maximum number of connection reattempts.
|
|
|
|
menuconfig BT_NIMBLE_50_FEATURE_SUPPORT
|
|
bool "Enable BLE 5 feature"
|
|
depends on BT_NIMBLE_ENABLED && (SOC_BLE_50_SUPPORTED || !BT_CONTROLLER_ENABLED)
|
|
default y
|
|
help
|
|
Enable BLE 5 feature
|
|
|
|
config BT_NIMBLE_LL_CFG_FEAT_LE_2M_PHY
|
|
bool "Enable 2M Phy"
|
|
depends on BT_NIMBLE_50_FEATURE_SUPPORT
|
|
default y
|
|
help
|
|
Enable 2M-PHY
|
|
|
|
config BT_NIMBLE_LL_CFG_FEAT_LE_CODED_PHY
|
|
bool "Enable coded Phy"
|
|
depends on BT_NIMBLE_50_FEATURE_SUPPORT
|
|
default y
|
|
help
|
|
Enable coded-PHY
|
|
|
|
config BT_NIMBLE_EXT_ADV
|
|
bool "Enable extended advertising"
|
|
depends on BT_NIMBLE_50_FEATURE_SUPPORT
|
|
default n
|
|
help
|
|
Enable this option to do extended advertising. Extended advertising
|
|
will be supported from BLE 5.0 onwards.
|
|
|
|
if BT_NIMBLE_EXT_ADV
|
|
config BT_NIMBLE_MAX_EXT_ADV_INSTANCES
|
|
int "Maximum number of extended advertising instances."
|
|
range 0 4
|
|
default 1 if BT_NIMBLE_EXT_ADV
|
|
default 0
|
|
depends on BT_NIMBLE_EXT_ADV
|
|
help
|
|
Change this option to set maximum number of extended advertising
|
|
instances. Minimum there is always one instance of
|
|
advertising. Enter how many more advertising instances you
|
|
want.
|
|
For ESP32C2, ESP32C6 and ESP32H2, each extended advertising instance
|
|
will take about 0.5k DRAM.
|
|
|
|
config BT_NIMBLE_EXT_ADV_MAX_SIZE
|
|
int "Maximum length of the advertising data."
|
|
range 0 1650
|
|
default 1650 if BT_NIMBLE_EXT_ADV
|
|
default 0
|
|
depends on BT_NIMBLE_EXT_ADV
|
|
help
|
|
Defines the length of the extended adv data. The value should not
|
|
exceed 1650.
|
|
|
|
config BT_NIMBLE_ENABLE_PERIODIC_ADV
|
|
bool "Enable periodic advertisement."
|
|
default y
|
|
depends on BT_NIMBLE_EXT_ADV
|
|
help
|
|
Enable this option to start periodic advertisement.
|
|
|
|
config BT_NIMBLE_PERIODIC_ADV_SYNC_TRANSFER
|
|
bool "Enable Transer Sync Events"
|
|
depends on BT_NIMBLE_ENABLE_PERIODIC_ADV
|
|
default y
|
|
help
|
|
This enables controller transfer periodic sync events to host
|
|
endif
|
|
|
|
config BT_NIMBLE_MAX_PERIODIC_SYNCS
|
|
int "Maximum number of periodic advertising syncs"
|
|
depends on BT_NIMBLE_50_FEATURE_SUPPORT
|
|
range 0 3 if IDF_TARGET_ESP32C2
|
|
range 0 8
|
|
default 1 if BT_NIMBLE_ENABLE_PERIODIC_ADV
|
|
default 0
|
|
help
|
|
Set this option to set the upper limit for number of periodic sync
|
|
connections. This should be less than maximum connections allowed by
|
|
controller.
|
|
|
|
config BT_NIMBLE_MAX_PERIODIC_ADVERTISER_LIST
|
|
int "Maximum number of periodic advertiser list"
|
|
depends on BT_NIMBLE_50_FEATURE_SUPPORT && SOC_ESP_NIMBLE_CONTROLLER
|
|
range 1 5
|
|
default 5 if BT_NIMBLE_50_FEATURE_SUPPORT
|
|
help
|
|
Set this option to set the upper limit for number of periodic advertiser list.
|
|
|
|
config BT_NIMBLE_BLE_POWER_CONTROL
|
|
bool "Enable support for BLE Power Control"
|
|
depends on BT_NIMBLE_50_FEATURE_SUPPORT && SOC_BLE_POWER_CONTROL_SUPPORTED
|
|
default n
|
|
help
|
|
Set this option to enable the Power Control feature
|
|
|
|
config BT_NIMBLE_PERIODIC_ADV_ENH
|
|
bool "Periodic adv enhancements(adi support)"
|
|
depends on BT_NIMBLE_ENABLE_PERIODIC_ADV && BT_NIMBLE_50_FEATURE_SUPPORT && SOC_BLE_PERIODIC_ADV_ENH_SUPPORTED
|
|
help
|
|
Enable the periodic advertising enhancements
|
|
|
|
menuconfig BT_NIMBLE_GATT_CACHING
|
|
bool "Enable GATT caching"
|
|
depends on BT_NIMBLE_ENABLED && BT_NIMBLE_50_FEATURE_SUPPORT
|
|
help
|
|
Enable GATT caching
|
|
config BT_NIMBLE_GATT_CACHING_MAX_CONNS
|
|
int "Maximum connections to be cached"
|
|
depends on BT_NIMBLE_GATT_CACHING
|
|
default 1
|
|
help
|
|
Set this option to set the upper limit on number of connections to be cached.
|
|
config BT_NIMBLE_GATT_CACHING_MAX_SVCS
|
|
int "Maximum number of services per connection"
|
|
depends on BT_NIMBLE_GATT_CACHING
|
|
default 64
|
|
help
|
|
Set this option to set the upper limit on number of services per connection to be cached.
|
|
config BT_NIMBLE_GATT_CACHING_MAX_CHRS
|
|
int "Maximum number of characteristics per connection"
|
|
depends on BT_NIMBLE_GATT_CACHING
|
|
default 64
|
|
help
|
|
Set this option to set the upper limit on number of characteristics per connection to be cached.
|
|
config BT_NIMBLE_GATT_CACHING_MAX_DSCS
|
|
int "Maximum number of descriptors per connection"
|
|
depends on BT_NIMBLE_GATT_CACHING
|
|
default 64
|
|
help
|
|
Set this option to set the upper limit on number of discriptors per connection to be cached.
|
|
|
|
config BT_NIMBLE_WHITELIST_SIZE
|
|
int "BLE white list size"
|
|
depends on BT_NIMBLE_ENABLED
|
|
range 1 15
|
|
default 12
|
|
help
|
|
BLE list size
|
|
|
|
config BT_NIMBLE_TEST_THROUGHPUT_TEST
|
|
bool "Throughput Test Mode enable"
|
|
default n
|
|
help
|
|
Enable the throughput test mode
|
|
|
|
config BT_NIMBLE_BLUFI_ENABLE
|
|
bool "Enable blufi functionality"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default n
|
|
help
|
|
Set this option to enable blufi functionality.
|
|
|
|
config BT_NIMBLE_USE_ESP_TIMER
|
|
bool "Enable Esp Timer for Nimble"
|
|
default y
|
|
help
|
|
Set this option to use Esp Timer which has higher priority timer instead of FreeRTOS timer
|
|
|
|
config BT_NIMBLE_LEGACY_VHCI_ENABLE
|
|
bool
|
|
default y if (IDF_TARGET_ESP32 || IDF_TARGET_ESP32C3 || IDF_TARGET_ESP32S3)
|
|
default n
|
|
help
|
|
This option is used to distinguish whether a previous version of VHCI is being used
|
|
|
|
config BT_NIMBLE_BLE_GATT_BLOB_TRANSFER
|
|
bool "Blob transfer"
|
|
help
|
|
This option is used when data to be sent is more than 512 bytes. For peripheral role,
|
|
BT_NIMBLE_MSYS_1_BLOCK_COUNT needs to be increased according to the need.
|
|
|
|
menu "GAP Service"
|
|
menu "GAP Appearance write permissions"
|
|
config BT_NIMBLE_SVC_GAP_APPEAR_WRITE
|
|
bool "Write"
|
|
default n
|
|
help
|
|
Enable write permission (BLE_GATT_CHR_F_WRITE)
|
|
|
|
config BT_NIMBLE_SVC_GAP_APPEAR_WRITE_ENC
|
|
depends on BT_NIMBLE_SVC_GAP_APPEAR_WRITE
|
|
bool "Write with encryption"
|
|
default n
|
|
help
|
|
Enable write with encryption permission (BLE_GATT_CHR_F_WRITE_ENC)
|
|
|
|
config BT_NIMBLE_SVC_GAP_APPEAR_WRITE_AUTHEN
|
|
depends on BT_NIMBLE_SVC_GAP_APPEAR_WRITE
|
|
bool "Write with authentication"
|
|
default n
|
|
help
|
|
Enable write with authentication permission (BLE_GATT_CHR_F_WRITE_AUTHEN)
|
|
|
|
config BT_NIMBLE_SVC_GAP_APPEAR_WRITE_AUTHOR
|
|
depends on BT_NIMBLE_SVC_GAP_APPEAR_WRITE
|
|
bool "Write with authorisation"
|
|
default n
|
|
help
|
|
Enable write with authorisation permission (BLE_GATT_CHR_F_WRITE_AUTHOR)
|
|
endmenu
|
|
|
|
config BT_NIMBLE_SVC_GAP_APPEAR_WRITE_PERM
|
|
int
|
|
default 0 if !BT_NIMBLE_SVC_GAP_APPEAR_WRITE
|
|
default 8 if BT_NIMBLE_SVC_GAP_APPEAR_WRITE
|
|
|
|
config BT_NIMBLE_SVC_GAP_APPEAR_WRITE_PERM_ENC
|
|
int
|
|
default 0 if !BT_NIMBLE_SVC_GAP_APPEAR_WRITE_ENC
|
|
default 4096 if BT_NIMBLE_SVC_GAP_APPEAR_WRITE_ENC
|
|
|
|
config BT_NIMBLE_SVC_GAP_APPEAR_WRITE_PERM_ATHN
|
|
int
|
|
default 0 if !BT_NIMBLE_SVC_GAP_APPEAR_WRITE_AUTHEN
|
|
default 8192 if BT_NIMBLE_SVC_GAP_APPEAR_WRITE_AUTHEN
|
|
|
|
config BT_NIMBLE_SVC_GAP_APPEAR_WRITE_PERM_ATHR
|
|
int
|
|
default 0 if !BT_NIMBLE_SVC_GAP_APPEAR_WRITE_AUTHOR
|
|
default 16384 if BT_NIMBLE_SVC_GAP_APPEAR_WRITE_AUTHOR
|
|
|
|
choice BT_NIMBLE_SVC_GAP_CENT_ADDR_RESOLUTION
|
|
prompt "GAP Characteristic - Central Address Resolution"
|
|
default BT_NIMBLE_SVC_GAP_CAR_CHAR_NOT_SUPP
|
|
help
|
|
Weather or not Central Address Resolution characteristic is supported on
|
|
the device, and if supported, weather or not Central Address Resolution
|
|
is supported.
|
|
|
|
- Central Address Resolution characteristic not supported
|
|
- Central Address Resolution not supported
|
|
- Central Address Resolution supported
|
|
|
|
config BT_NIMBLE_SVC_GAP_CAR_CHAR_NOT_SUPP
|
|
bool "Characteristic not supported"
|
|
|
|
config BT_NIMBLE_SVC_GAP_CAR_NOT_SUPP
|
|
bool "Central Address Resolution not supported"
|
|
|
|
config BT_NIMBLE_SVC_GAP_CAR_SUPP
|
|
bool "Central Address Resolution supported"
|
|
endchoice
|
|
|
|
config BT_NIMBLE_SVC_GAP_CENT_ADDR_RESOLUTION
|
|
int
|
|
default -1 if BT_NIMBLE_SVC_GAP_CAR_CHAR_NOT_SUPP
|
|
default 0 if BT_NIMBLE_SVC_GAP_CAR_NOT_SUPP
|
|
default 1 if BT_NIMBLE_SVC_GAP_CAR_SUPP
|
|
|
|
menu "GAP device name write permissions"
|
|
config BT_NIMBLE_SVC_GAP_NAME_WRITE
|
|
bool "Write"
|
|
default n
|
|
help
|
|
Enable write permission (BLE_GATT_CHR_F_WRITE)
|
|
|
|
config BT_NIMBLE_SVC_GAP_NAME_WRITE_ENC
|
|
depends on BT_NIMBLE_SVC_GAP_NAME_WRITE
|
|
bool "Write with encryption"
|
|
default n
|
|
help
|
|
Enable write with encryption permission (BLE_GATT_CHR_F_WRITE_ENC)
|
|
|
|
config BT_NIMBLE_SVC_GAP_NAME_WRITE_AUTHEN
|
|
depends on BT_NIMBLE_SVC_GAP_NAME_WRITE
|
|
bool "Write with authentication"
|
|
default n
|
|
help
|
|
Enable write with authentication permission (BLE_GATT_CHR_F_WRITE_AUTHEN)
|
|
|
|
config BT_NIMBLE_SVC_GAP_NAME_WRITE_AUTHOR
|
|
depends on BT_NIMBLE_SVC_GAP_NAME_WRITE
|
|
bool "Write with authorisation"
|
|
default n
|
|
help
|
|
Enable write with authorisation permission (BLE_GATT_CHR_F_WRITE_AUTHOR)
|
|
endmenu
|
|
|
|
config BT_NIMBLE_SVC_GAP_NAME_WRITE_PERM
|
|
int
|
|
default 0 if !BT_NIMBLE_SVC_GAP_NAME_WRITE
|
|
default 8 if BT_NIMBLE_SVC_GAP_NAME_WRITE
|
|
|
|
config BT_NIMBLE_SVC_GAP_NAME_WRITE_PERM_ENC
|
|
int
|
|
default 0 if !BT_NIMBLE_SVC_GAP_NAME_WRITE_ENC
|
|
default 4096 if BT_NIMBLE_SVC_GAP_NAME_WRITE_ENC
|
|
|
|
config BT_NIMBLE_SVC_GAP_NAME_WRITE_PERM_AUTHEN
|
|
int
|
|
default 0 if !BT_NIMBLE_SVC_GAP_NAME_WRITE_AUTHEN
|
|
default 8192 if BT_NIMBLE_SVC_GAP_NAME_WRITE_AUTHEN
|
|
|
|
config BT_NIMBLE_SVC_GAP_NAME_WRITE_PERM_AUTHOR
|
|
int
|
|
default 0 if !BT_NIMBLE_SVC_GAP_NAME_WRITE_AUTHOR
|
|
default 16384 if BT_NIMBLE_SVC_GAP_NAME_WRITE_AUTHOR
|
|
|
|
config BT_NIMBLE_SVC_GAP_PPCP_MAX_CONN_INTERVAL
|
|
int "PPCP Connection Interval Max (Unit: 1.25 ms)"
|
|
depends on BT_NIMBLE_ROLE_PERIPHERAL
|
|
default 0
|
|
help
|
|
Peripheral Preferred Connection Parameter: Connection Interval maximum value
|
|
Interval Max = value * 1.25 ms
|
|
|
|
config BT_NIMBLE_SVC_GAP_PPCP_MIN_CONN_INTERVAL
|
|
int "PPCP Connection Interval Min (Unit: 1.25 ms)"
|
|
depends on BT_NIMBLE_ROLE_PERIPHERAL
|
|
default 0
|
|
help
|
|
Peripheral Preferred Connection Parameter: Connection Interval minimum value
|
|
Interval Min = value * 1.25 ms
|
|
|
|
config BT_NIMBLE_SVC_GAP_PPCP_SLAVE_LATENCY
|
|
int "PPCP Slave Latency"
|
|
default 0
|
|
help
|
|
Peripheral Preferred Connection Parameter: Slave Latency
|
|
|
|
config BT_NIMBLE_SVC_GAP_PPCP_SUPERVISION_TMO
|
|
int "PPCP Supervision Timeout (Uint: 10 ms)"
|
|
default 0
|
|
help
|
|
Peripheral Preferred Connection Parameter: Supervision Timeout
|
|
Timeout = Value * 10 ms
|
|
|
|
endmenu
|
|
|
|
menu "BLE Services"
|
|
menuconfig BT_NIMBLE_HID_SERVICE
|
|
bool "HID service"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default n
|
|
help
|
|
Enable HID service support
|
|
|
|
config BT_NIMBLE_SVC_HID_MAX_INSTANCES
|
|
depends on BT_NIMBLE_HID_SERVICE
|
|
int "Maximum HID service instances"
|
|
default 2
|
|
help
|
|
Defines maximum number of HID service instances
|
|
|
|
config BT_NIMBLE_SVC_HID_MAX_RPTS
|
|
depends on BT_NIMBLE_HID_SERVICE
|
|
int "Maximum HID Report characteristics per service instance"
|
|
default 3
|
|
help
|
|
Defines maximum number of report characteristics per service instance
|
|
endmenu
|
|
|
|
config BT_NIMBLE_VS_SUPPORT
|
|
bool "Enable support for VSC and VSE"
|
|
help
|
|
This option is used to enable support for sending Vendor Specific HCI commands and handling
|
|
Vendor Specific HCI Events.
|
|
|
|
config BT_NIMBLE_OPTIMIZE_MULTI_CONN
|
|
bool "Enable the optimization of multi-connection"
|
|
depends on SOC_BLE_MULTI_CONN_OPTIMIZATION
|
|
select BT_NIMBLE_VS_SUPPORT
|
|
default n
|
|
help
|
|
This option enables the use of vendor-specific APIs for multi-connections, which can
|
|
greatly enhance the stability of coexistence between numerous central and peripheral
|
|
devices. It will prohibit the usage of standard APIs.
|
|
|
|
config BT_NIMBLE_ENC_ADV_DATA
|
|
bool "Encrypted Advertising Data"
|
|
depends on SOC_ESP_NIMBLE_CONTROLLER
|
|
select BT_NIMBLE_EXT_ADV
|
|
help
|
|
This option is used to enable encrypted advertising data.
|
|
|
|
config BT_NIMBLE_MAX_EADS
|
|
int "Maximum number of EAD devices to save across reboots"
|
|
default 10
|
|
depends on BT_NIMBLE_ENABLED && BT_NIMBLE_ENC_ADV_DATA
|
|
help
|
|
Defines maximum number of encrypted advertising data key material to save
|
|
|
|
config BT_NIMBLE_HIGH_DUTY_ADV_ITVL
|
|
bool "Enable BLE high duty advertising interval feature"
|
|
depends on BT_NIMBLE_ENABLED
|
|
help
|
|
This enable BLE high duty advertising interval feature
|
|
|
|
config BT_NIMBLE_HOST_QUEUE_CONG_CHECK
|
|
bool "BLE queue congestion check"
|
|
depends on BT_NIMBLE_ENABLED
|
|
default n
|
|
help
|
|
When scanning and scan duplicate is not enabled, if there are a lot of adv packets around
|
|
or application layer handling adv packets is slow, it will cause the controller memory
|
|
to run out. if enabled, adv packets will be lost when host queue is congested.
|
|
|
|
menu "Host-controller Transport"
|
|
config BT_NIMBLE_TRANSPORT_UART
|
|
bool "Enable Uart Transport"
|
|
default y
|
|
depends on BT_CONTROLLER_DISABLED
|
|
help
|
|
Use UART transport
|
|
|
|
config BT_NIMBLE_TRANSPORT_UART_PORT
|
|
int "Uart port"
|
|
depends on BT_CONTROLLER_DISABLED && BT_NIMBLE_TRANSPORT_UART
|
|
default 1
|
|
help
|
|
Uart port
|
|
|
|
choice BT_NIMBLE_HCI_USE_UART_BAUDRATE
|
|
prompt "Uart Hci Baud Rate"
|
|
default UART_BAUDRATE_921600
|
|
depends on BT_CONTROLLER_DISABLED && BT_NIMBLE_TRANSPORT_UART
|
|
help
|
|
Uart Baud Rate
|
|
|
|
config UART_BAUDRATE_115200
|
|
bool "115200"
|
|
config UART_BAUDRATE_230400
|
|
bool "230400"
|
|
config UART_BAUDRATE_460800
|
|
bool "460800"
|
|
config UART_BAUDRATE_921600
|
|
bool "921600"
|
|
endchoice
|
|
|
|
config BT_NIMBLE_HCI_UART_BAUDRATE
|
|
depends on BT_CONTROLLER_DISABLED && BT_NIMBLE_TRANSPORT_UART
|
|
int
|
|
default 115200 if UART_BAUDRATE_115200
|
|
default 230400 if UART_BAUDRATE_230400
|
|
default 460800 if UART_BAUDRATE_460800
|
|
default 921600 if UART_BAUDRATE_921600
|
|
|
|
choice BT_NIMBLE_USE_HCI_UART_PARITY
|
|
prompt "Uart PARITY"
|
|
default UART_PARITY_NONE
|
|
depends on BT_CONTROLLER_DISABLED && BT_NIMBLE_TRANSPORT_UART
|
|
help
|
|
Uart Parity
|
|
|
|
config UART_PARITY_NONE
|
|
bool "None"
|
|
config UART_PARITY_ODD
|
|
bool "Odd"
|
|
config UART_PARITY_EVEN
|
|
bool "Even"
|
|
endchoice
|
|
|
|
config BT_NIMBLE_TRANSPORT_UART_PARITY_NONE
|
|
int
|
|
default 0 if !UART_PARITY_NONE
|
|
default 1 if UART_PARITY_NONE
|
|
depends on BT_CONTROLLER_DISABLED && BT_NIMBLE_TRANSPORT_UART
|
|
|
|
config BT_NIMBLE_TRANSPORT_UART_PARITY_ODD
|
|
int
|
|
default 0 if !UART_PARITY_ODD
|
|
default 1 if UART_PARITY_ODD
|
|
depends on BT_CONTROLLER_DISABLED && BT_NIMBLE_TRANSPORT_UART
|
|
|
|
config BT_NIMBLE_TRANSPORT_UART_PARITY_EVEN
|
|
int
|
|
default 0 if !UART_PARITY_EVEN
|
|
default 1 if UART_PARITY_EVEN
|
|
depends on BT_CONTROLLER_DISABLED && BT_NIMBLE_TRANSPORT_UART
|
|
|
|
config BT_NIMBLE_UART_RX_PIN
|
|
int "UART Rx pin"
|
|
depends on BT_CONTROLLER_DISABLED && BT_NIMBLE_TRANSPORT_UART
|
|
default 5
|
|
help
|
|
Rx pin for Nimble Transport
|
|
|
|
config BT_NIMBLE_UART_TX_PIN
|
|
int "UART Tx pin"
|
|
depends on BT_CONTROLLER_DISABLED && BT_NIMBLE_TRANSPORT_UART
|
|
default 4
|
|
help
|
|
Tx pin for Nimble Transport
|
|
|
|
choice BT_NIMBLE_USE_HCI_UART_FLOW_CTRL
|
|
prompt "Uart Flow Control"
|
|
default UART_HW_FLOWCTRL_DISABLE
|
|
help
|
|
Uart Flow Control
|
|
|
|
config UART_HW_FLOWCTRL_DISABLE
|
|
bool "Disable"
|
|
config UART_HW_FLOWCTRL_CTS_RTS
|
|
bool "Enable hardware flow control"
|
|
endchoice
|
|
|
|
config BT_NIMBLE_HCI_UART_FLOW_CTRL
|
|
int
|
|
default 0 if UART_HW_FLOWCTRL_DISABLE
|
|
default 1 if UART_HW_FLOWCTRL_CTS_RTS
|
|
|
|
config BT_NIMBLE_HCI_UART_RTS_PIN
|
|
int "UART Rts Pin"
|
|
default 19
|
|
help
|
|
UART HCI RTS pin
|
|
|
|
config BT_NIMBLE_HCI_UART_CTS_PIN
|
|
int "UART Cts Pin"
|
|
default 23
|
|
help
|
|
UART HCI CTS pin
|
|
endmenu
|