From d0a2451b6de89ec9532653674a8d614a1eac25d6 Mon Sep 17 00:00:00 2001 From: Rodrigo Peixoto Date: Sat, 8 Jun 2024 14:24:13 -0300 Subject: [PATCH] doc: zbus: isolated pool by channel Add the information about the possibility of isolating the pool per channel. Signed-off-by: Rodrigo Peixoto --- doc/services/zbus/index.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/services/zbus/index.rst b/doc/services/zbus/index.rst index 1c4221373dabb0..eb8b9ad70998f4 100644 --- a/doc/services/zbus/index.rst +++ b/doc/services/zbus/index.rst @@ -398,10 +398,13 @@ rate by following design tips: .. warning:: ZBus uses :zephyr_file:`include/zephyr/net/buf.h` (network buffers) to exchange data with message - subscribers. So, chose carefully the configurations + 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 - (delivery guarantee) considering message subscribers. + (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 + at the :zephyr:code-sample:`zbus-msg-subscriber` to see the isolation in action. .. warning:: Subscribers will receive only the reference of the changing channel. A data loss may be perceived @@ -410,7 +413,6 @@ rate by following design tips: only the last data is there. - .. _zbus delivery sequence: Message delivery sequence @@ -898,6 +900,8 @@ Related configuration options: buffers; * :kconfig:option:`CONFIG_ZBUS_MSG_SUBSCRIBER_NET_BUF_POOL_SIZE` the available number of message buffers to be used simultaneously; +* :kconfig:option:`CONFIG_ZBUS_MSG_SUBSCRIBER_NET_BUF_POOL_ISOLATION` enables the developer to isolate + 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_ZBUS_RUNTIME_OBSERVERS` enables the runtime observer registration.