mirror of
https://github.com/espressif/esp-idf.git
synced 2026-09-22 13:01:16 +03:00
e2d38955de
Move ble_log_spi_out.c and ble_log_spi_out.h into a deprecated/ subdirectory under components/bt/common/ble_log/. Extract all BT_BLE_LOG_SPI_OUT_* Kconfig options into deprecated/Kconfig.in with an if-block to reduce depends-on repetition, sourced from ble_log/Kconfig.in inside a "Legacy SPI Log Output (Deprecated)" menu. Add mutual exclusion with BLE_LOG_ENABLED so that the legacy SPI Out and the new BLE Log Module cannot be enabled simultaneously. Update CMakeLists.txt source path and add deprecated/include to include dirs so existing callers are unaffected. The BLE Log Module's SPI Master DMA peripheral transport is the replacement.
250 lines
9.4 KiB
Plaintext
250 lines
9.4 KiB
Plaintext
config BLE_LOG_ENABLED
|
|
bool "Enable BLE Log Module (Experimental)"
|
|
default n
|
|
help
|
|
Enable BLE Log Module
|
|
|
|
if BLE_LOG_ENABLED
|
|
config BLE_LOG_TASK_STACK_SIZE
|
|
int "Stack size for BLE Log Task"
|
|
default 1024 if IDF_TARGET_ARCH_RISCV
|
|
default 2048 if IDF_TARGET_ARCH_XTENSA
|
|
default 1024
|
|
help
|
|
Stack size for BLE Log Task
|
|
|
|
config BLE_LOG_LBM_TRANS_SIZE
|
|
int "Buffer size for each peripheral transport"
|
|
default 512
|
|
help
|
|
There're 2 log buffer managers (LBMs) with compare-and-swap
|
|
(CAS) protection, 1 LBM with FreeRTOS mutex protection, 1 LBM
|
|
without protection for critical section. Each LBM is managing
|
|
2 ping-pong buffers, which means there will be 4 * 2 *
|
|
BLE_LOG_LBM_TRANS_SIZE bytes buffer allocated
|
|
|
|
config BLE_LOG_LBM_ATOMIC_LOCK_TASK_CNT
|
|
int "Count of log buffer managers with atomic lock protection for task context"
|
|
default 2
|
|
help
|
|
BLE Log module will search for an LBM with atomic lock protection first; if
|
|
all LBMs with atomic lock protection are unavailable, BLE Log module will
|
|
try to use the LBM with spin lock protection. So the more LBMs with atomic
|
|
lock protection are created, the better the logging performance will be.
|
|
|
|
config BLE_LOG_LBM_ATOMIC_LOCK_ISR_CNT
|
|
int "Count of log buffer managers with atomic lock protection for ISR context"
|
|
default 1
|
|
help
|
|
BLE Log module will search for an LBM with atomic lock protection first; if
|
|
all LBMs with atomic lock protection are unavailable, BLE Log module will
|
|
try to use the LBM with spin lock protection. So the more LBMs with atomic
|
|
lock protection are created, the more ISRs can nest.
|
|
|
|
config BLE_LOG_IS_ESP_CONTROLLER
|
|
bool "Current BLE Controller is ESP BLE Controller"
|
|
depends on BT_CONTROLLER_ENABLED
|
|
depends on SOC_ESP_NIMBLE_CONTROLLER
|
|
default y
|
|
select BT_LE_CONTROLLER_LOG_ENABLED
|
|
select BT_LE_CONTROLLER_LOG_MODE_BLE_LOG_V2
|
|
select BLE_LOG_LL_ENABLED
|
|
help
|
|
Current BLE Controller is ESP BLE Controller
|
|
|
|
config BLE_LOG_IS_ESP_LEGACY_CONTROLLER
|
|
bool "Current BLE Controller is ESP BLE Legacy Controller"
|
|
depends on BT_CONTROLLER_ENABLED
|
|
depends on !SOC_ESP_NIMBLE_CONTROLLER
|
|
depends on BT_CTRL_RUN_IN_FLASH_ONLY
|
|
default y
|
|
select BT_CTRL_LE_LOG_EN
|
|
select BLE_LOG_LL_ENABLED
|
|
help
|
|
Current BLE Controller is ESP BLE Legacy Controller
|
|
|
|
config BLE_LOG_LL_ENABLED
|
|
bool "Enable BLE Log for Link Layer"
|
|
depends on BT_CONTROLLER_ENABLED
|
|
default n
|
|
help
|
|
Enable BLE Log for Link Layer
|
|
|
|
if BLE_LOG_LL_ENABLED
|
|
config BLE_LOG_LBM_LL_TRANS_SIZE
|
|
int "Buffer size for each peripheral transport of Link Layer LBM"
|
|
default 1024
|
|
help
|
|
There're 2 Link Layer dedicated log buffer managers (LBMs) with
|
|
compare-and-swap (CAS) protection. Each LBM is managing 2 ping-
|
|
pong buffers, which means there will be additional 2 * 2 *
|
|
BLE_LOG_LBM_LL_TRANS_SIZE bytes buffer allocated
|
|
|
|
config BLE_LOG_LL_HCI_LOG_PAYLOAD_LEN_LIMIT_ENABLED
|
|
bool "Enable LL HCI Log Payload Length Limit"
|
|
default n
|
|
help
|
|
Enable length limit for LL HCI Log payload (addr_append).
|
|
When enabled, if len_append exceeds the configured limit,
|
|
it will be truncated to the maximum length.
|
|
|
|
config BLE_LOG_LL_HCI_LOG_PAYLOAD_LEN_LIMIT
|
|
int "LL HCI Log Payload Length Limit (bytes)"
|
|
depends on BLE_LOG_LL_HCI_LOG_PAYLOAD_LEN_LIMIT_ENABLED
|
|
default 32
|
|
help
|
|
Maximum length for LL HCI Log payload (len_append).
|
|
When the feature is enabled and len_append exceeds this value,
|
|
it will be truncated.
|
|
endif
|
|
|
|
config BLE_LOG_HOST_SIDE_HCI_LOG_ENABLED
|
|
bool "Enable BLE Host side HCI Logging"
|
|
default y
|
|
help
|
|
Enable BLE Host side HCI Logging
|
|
|
|
config BLE_LOG_PAYLOAD_CHECKSUM_ENABLED
|
|
bool "Enable payload checksum for BLE Log data integrity check"
|
|
default y
|
|
help
|
|
Checksum is the default method for BLE Log data integrity check,
|
|
but for targets with slow CPU speed, it may cause significant system
|
|
performance decrease; a compromise could be made to balance the
|
|
realtime performance and log data integrity, which is calculating the
|
|
checksum of frame head and payload all together by default, or only
|
|
calculate the checksum of frame head to minimize performance decrease
|
|
|
|
config BLE_LOG_XOR_CHECKSUM_ENABLED
|
|
bool "Enable XOR checksum for BLE Log payload integrity check"
|
|
default y
|
|
help
|
|
XOR checksum is introduced for integrity check performance optimization.
|
|
|
|
config BLE_LOG_ENH_STAT_ENABLED
|
|
bool "Enable enhanced statistics for BLE Log"
|
|
default n
|
|
help
|
|
Enable enhanced statistics for written/lost frame/bytes count, which may
|
|
cost additional ~100kB memory
|
|
|
|
config BLE_LOG_TS_ENABLED
|
|
bool "Enable BLE Log Timestamp Synchronization (TS)"
|
|
default n
|
|
help
|
|
Enable BLE Log TS with external logging module
|
|
|
|
if BLE_LOG_TS_ENABLED
|
|
config BLE_LOG_SYNC_IO_NUM
|
|
int "GPIO number for Timestamp Synchronization (TS) toggle output"
|
|
depends on BLE_LOG_TS_ENABLED
|
|
default 0
|
|
help
|
|
GPIO number for TS toggle output
|
|
|
|
config BLE_LOG_TS_TRIGGER_TIMEOUT_MS
|
|
int "Timeout (ms) for Timestamp Synchronization toggle"
|
|
default 1000
|
|
help
|
|
Timeout (ms) for Timestamp Synchronization toggle
|
|
|
|
choice BLE_LOG_TS_TRIGGER_CHOICE
|
|
prompt "BLE Log Timestamp Synchronization trigger choice"
|
|
default BLE_LOG_TS_TRIGGER_TASK_EVENT
|
|
help
|
|
Choose BLE Log Timestamp Synchronization trigger
|
|
|
|
config BLE_LOG_TS_TRIGGER_ESP_TIMER
|
|
bool "BLE Log Timestamp Synchronization trigger - ESP Timer"
|
|
help
|
|
ESP Timer based periodic TS trigger
|
|
|
|
config BLE_LOG_TS_TRIGGER_TASK_EVENT
|
|
bool "BLE Log Timestamp Synchronization trigger - Task Event"
|
|
help
|
|
Task Event based TS trigger (Light Sleep Test Compatibility)
|
|
endchoice
|
|
|
|
config BLE_LOG_TS_TRIGGER_ESP_TIMER_ISR_DISPATCH_METHOD
|
|
bool "Utilize ISR dispatch method for ESP Timer as Timestamp Synchronization trigger"
|
|
default n
|
|
select ESP_TIMER_SUPPORTS_ISR_DISPATCH_METHOD
|
|
select GPIO_CTRL_FUNC_IN_IRAM
|
|
depends on BLE_LOG_TS_TRIGGER_ESP_TIMER
|
|
help
|
|
Utilize ISR dispatch method for ESP Timer as Timestamp Synchronization trigger
|
|
endif
|
|
|
|
choice BLE_LOG_PRPH_CHOICE
|
|
prompt "BLE Log peripheral choice"
|
|
default BLE_LOG_PRPH_DUMMY
|
|
help
|
|
Choose BLE Log peripheral
|
|
|
|
config BLE_LOG_PRPH_DUMMY
|
|
bool "Dummy transport"
|
|
help
|
|
Dummy transport (dump only)
|
|
|
|
config BLE_LOG_PRPH_SPI_MASTER_DMA
|
|
bool "Utilize SPI master DMA driver as transport"
|
|
depends on SOC_GPSPI_SUPPORTED
|
|
help
|
|
Utilize SPI master DMA driver as transport
|
|
|
|
config BLE_LOG_PRPH_UART_DMA
|
|
bool "Utilize UART DMA driver as transport"
|
|
depends on SOC_UHCI_SUPPORTED
|
|
help
|
|
Utilize UART DMA driver as transport
|
|
endchoice
|
|
|
|
if BLE_LOG_PRPH_SPI_MASTER_DMA
|
|
config BLE_LOG_PRPH_SPI_MASTER_DMA_MOSI_IO_NUM
|
|
int "GPIO number of MOSI port for SPI master DMA transport"
|
|
default 0
|
|
help
|
|
GPIO number of MOSI port for SPI master DMA transport
|
|
|
|
config BLE_LOG_PRPH_SPI_MASTER_DMA_SCLK_IO_NUM
|
|
int "GPIO number of SCLK port for SPI master DMA transport"
|
|
default 0
|
|
help
|
|
GPIO number of SCLK port for SPI master DMA transport
|
|
|
|
config BLE_LOG_PRPH_SPI_MASTER_DMA_CS_IO_NUM
|
|
int "GPIO number of CS port for SPI master DMA transport"
|
|
default 0
|
|
help
|
|
GPIO number of CS port for SPI master DMA transport
|
|
endif
|
|
|
|
if BLE_LOG_PRPH_UART_DMA
|
|
config BLE_LOG_PRPH_UART_DMA_PORT
|
|
int "UART port number for UART DMA transport"
|
|
default 0
|
|
help
|
|
UART port number for UART DMA
|
|
|
|
config BLE_LOG_PRPH_UART_DMA_BAUD_RATE
|
|
int "Baud rate of UART port for UART DMA transport"
|
|
default 921600
|
|
help
|
|
Determine the baud rate of UART port
|
|
|
|
config BLE_LOG_PRPH_UART_DMA_TX_IO_NUM
|
|
int "GPIO number for UART TX"
|
|
default 0
|
|
help
|
|
GPIO number for UART TX
|
|
endif
|
|
|
|
menu "Settings of BLE Log Compression"
|
|
source "$IDF_PATH/components/bt/common/ble_log/extension/log_compression/Kconfig.in"
|
|
endmenu
|
|
endif
|
|
|
|
menu "Legacy SPI Log Output (Deprecated - use BLE Log Module instead)"
|
|
source "$IDF_PATH/components/bt/common/ble_log/deprecated/Kconfig.in"
|
|
endmenu
|