adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

lib: os: spsc_pbuf: Clarify using cache management in the module

Browse source 
Packet buffer can be used for sharing data between cores. In that
case when any core has data cache then data cache handling must
be enabled in the module. However, it shall never be enabled when
the packet buffer is used on a single core. Adding that information
to the documentation.

Signed-off-by: Krzysztof Chruściński <krzysztof.chruscinski@nordicsemi.no>
This commit is contained in:
Krzysztof Chruściński 2024-06-27 06:20:07 +02:00 committed by Anas Nashif
parent b737598dcf
commit 0bb25d2e17
2 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
include/zephyr/sys/spsc_pbuf.h
View file

@ -25,7 +25,11 @@ extern "C" {
* @{
*/
/** @brief Flag indicating that cache shall be handled. */
/** @brief Flag indicating that cache shall be handled.
*
* It shall be used only when packet buffer is shared between two cores as on a single
* core cache shall not be handled manually because it results in data corruption.
*/
#define SPSC_PBUF_CACHE BIT(0)
/** @brief Size of the field which stores maximum utilization. */

4
lib/os/Kconfig
View file

@ -60,7 +60,9 @@ config SPSC_PBUF_CACHE_ALWAYS
bool "Always handle cache"
help
Handle cache writeback and invalidation for all instances. Option used
to avoid runtime check and thus reduce memory footprint.
to avoid runtime check and thus reduce memory footprint. Beware! It shall
be used only if all packet buffer instances are used for data sharing
between cores.
config SPSC_PBUF_CACHE_NEVER
bool "Never handle cache"