From b42013ada8daa646917d226101fdc0f765246d4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20Pl=C3=B6ger?= Date: Mon, 2 Jun 2025 14:25:23 +0200 Subject: [PATCH] doc: update heap references according to auto heap calculation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add and exchange global heap configuration CONFIG_HEAP_MEM_POOL_SIZE against configuration used for auto heap calculation CONFIG_HEAP_MEM_POOL_ADD_SIZE_ZBUS. Add CONFIG_HEAP_MEM_POOL_ADD_SIZE_ZBUS as related configuration Clarify that HEAP is used for zbus in a whole Consistent naming 'Zbus'/'zbus' to 'ZBus' Signed-off-by: Matthias Plöger --- doc/services/zbus/index.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/services/zbus/index.rst b/doc/services/zbus/index.rst index 3ed574835b9..ef1fce08739 100644 --- a/doc/services/zbus/index.rst +++ b/doc/services/zbus/index.rst @@ -401,7 +401,7 @@ rate by following design tips: ZBus uses :zephyr_file:`include/zephyr/net_buf.h` (network buffers) to exchange data with message subscribers. Thus, choose carefully the configurations :kconfig:option:`CONFIG_ZBUS_MSG_SUBSCRIBER_NET_BUF_POOL_SIZE` and - :kconfig:option:`CONFIG_HEAP_MEM_POOL_SIZE`. They are crucial to a proper VDED execution + :kconfig:option:`CONFIG_HEAP_MEM_POOL_ADD_SIZE_ZBUS`. They are crucial to a proper VDED execution (delivery guarantee) considering message subscribers. If you want to keep an isolated pool for a specific set of channels, you can use :kconfig:option:`CONFIG_ZBUS_MSG_SUBSCRIBER_NET_BUF_POOL_ISOLATION` with a dedicated pool. Look @@ -943,6 +943,8 @@ Related configuration options: a pool for the message subscriber for a set of channels; * :kconfig:option:`CONFIG_ZBUS_MSG_SUBSCRIBER_NET_BUF_STATIC_DATA_SIZE` the biggest message of zbus channels to be transported into a message buffer; +* :kconfig:option:`CONFIG_HEAP_MEM_POOL_ADD_SIZE_ZBUS` the reserved heap size for ZBus in a whole + including message buffer allocation; * :kconfig:option:`CONFIG_ZBUS_RUNTIME_OBSERVERS` enables the runtime observer registration; * :kconfig:option:`CONFIG_ZBUS_RUNTIME_OBSERVERS_NODE_ALLOC_DYNAMIC` allocate the runtime observers dynamically using the heap;