From 4c7aeb252d81c480488ae5f57e3f0199ba531c9a Mon Sep 17 00:00:00 2001 From: Peter Mitsis Date: Mon, 19 Jun 2023 09:41:31 -0400 Subject: [PATCH] doc: Correct msgq data item size discrepancy Updates the data passing summary table to indicate that the size of a message queue data item must be a multiple of its data alignment. This brings the documentation in both the summary table and the message queue documentation into alignment. Signed-off-by: Peter Mitsis --- doc/kernel/services/index.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/kernel/services/index.rst b/doc/kernel/services/index.rst index 82c49ba3b7..cb56ccd367 100644 --- a/doc/kernel/services/index.rst +++ b/doc/kernel/services/index.rst @@ -59,7 +59,7 @@ Object Bidirectional? Data structure Data item size FIFO No Queue Arbitrary [1] 4 B [2] Yes [3] Yes N/A LIFO No Queue Arbitrary [1] 4 B [2] Yes [3] Yes N/A Stack No Array Word Word Yes [3] Yes Undefined behavior -Message queue No Ring buffer Power of two Power of two Yes [3] Yes Pend thread or return -errno +Message queue No Ring buffer Arbitrary [6] Power of two Yes [3] Yes Pend thread or return -errno Mailbox Yes Queue Arbitrary [1] Arbitrary No No N/A Pipe No Ring buffer [4] Arbitrary Arbitrary Yes [5] Yes [5] Pend thread or return -errno =============== ============== =================== ============== ============== ================= ============== =============================== @@ -79,6 +79,8 @@ argument. [5] ISRS can send and/or receive only when passing K_NO_WAIT as the timeout argument. +[6] Data item size must be a multiple of the data alignment. + .. toctree:: :maxdepth: 1