From ae4fb20f6733e06a7473d8ba3211515e7316198c Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Fri, 21 May 2021 11:13:38 -0400 Subject: [PATCH] doc: kernel: add documentation for queues Add missing introduction to queues which are basically FIFOs and in zephyr are used to implement both FIFO and LIFO objects. Fixes #35199 Signed-off-by: Anas Nashif --- doc/reference/kernel/data_passing/queues.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/reference/kernel/data_passing/queues.rst b/doc/reference/kernel/data_passing/queues.rst index 8fc6d3ecdf8..af8593f3940 100644 --- a/doc/reference/kernel/data_passing/queues.rst +++ b/doc/reference/kernel/data_passing/queues.rst @@ -3,6 +3,12 @@ Queues ###### +A Queue in Zephyr is a kernel object that implements a traditional queue, allowing +threads and ISRs to add and remove data items of any size. The queue is similar +to a FIFO and serves as the underlying implementation for both :ref:`k_fifo +` and :ref:`k_lifo `. For more information on usage see +:ref:`k_fifo `. + Configuration Options *********************