michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: clarify k_queue_alloc_append and related APIs

Browse source 
The data isn't copied, there's just an additional implicit
allocation.

Fixes: #15090

Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
This commit is contained in:
Andrew Boie 2019-04-01 12:28:03 -07:00 • committed by Anas Nashif
commit ac3dcc1106
1 changed files with 16 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

28
include/kernel.h
View file

@ -1812,9 +1812,10 @@ extern void k_queue_append(struct k_queue *queue, void *data);
/** /**
* @brief Append an element to a queue. * @brief Append an element to a queue.
* *
* This routine appends a data item to @a queue. There is an implicit * This routine appends a data item to @a queue. There is an implicit memory
* memory allocation from the calling thread's resource pool, which is * allocation to create an additional temporary bookkeeping data structure from
* automatically freed when the item is removed from the queue. * the calling thread's resource pool, which is automatically freed when the
* item is removed. The data itself is not copied.
* *
* @note Can be called by ISRs. * @note Can be called by ISRs.
* *
@ -1845,9 +1846,10 @@ extern void k_queue_prepend(struct k_queue *queue, void *data);
/** /**
* @brief Prepend an element to a queue. * @brief Prepend an element to a queue.
* *
* This routine prepends a data item to @a queue. There is an implicit * This routine prepends a data item to @a queue. There is an implicit memory
* memory allocation from the calling thread's resource pool, which is * allocation to create an additional temporary bookkeeping data structure from
* automatically freed when the item is removed from the queue. * the calling thread's resource pool, which is automatically freed when the
* item is removed. The data itself is not copied.
* *
* @note Can be called by ISRs. * @note Can be called by ISRs.
* *
@ -2117,9 +2119,10 @@ struct k_fifo {
/** /**
* @brief Add an element to a FIFO queue. * @brief Add an element to a FIFO queue.
* *
* This routine adds a data item to @a fifo. There is an implicit * This routine adds a data item to @a fifo. There is an implicit memory
* memory allocation from the calling thread's resource pool, which is * allocation to create an additional temporary bookkeeping data structure from
* automatically freed when the item is removed. * the calling thread's resource pool, which is automatically freed when the
* item is removed. The data itself is not copied.
* *
* @note Can be called by ISRs. * @note Can be called by ISRs.
* *
@ -2316,9 +2319,10 @@ struct k_lifo {
/** /**
* @brief Add an element to a LIFO queue. * @brief Add an element to a LIFO queue.
* *
* This routine adds a data item to @a lifo. There is an implicit * This routine adds a data item to @a lifo. There is an implicit memory
* memory allocation from the calling thread's resource pool, which is * allocation to create an additional temporary bookkeeping data structure from
* automatically freed when the item is removed. * the calling thread's resource pool, which is automatically freed when the
* item is removed. The data itself is not copied.
* *
* @note Can be called by ISRs. * @note Can be called by ISRs.
* *