michaelh/zephyr
1
0
Fork 0
Code Releases Activity

mem_pool: Simplify task_mem_pool_alloc() API family

Browse source 
Changes the mem_pool API so that the timeout parameter must be specified
when invoking task_mem_pool_alloc() thereby obsoleting the following APIs:
	task_mem_pool_alloc_wait()
	task_mem_pool_alloc_wait_alloc()
	_task_mem_pool_alloc()

Change-Id: Ifa88f13bca98ca3c7d0e1a3b64b40a00068619e0
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
This commit is contained in:
Peter Mitsis 2015-12-02 12:05:13 -05:00 • committed by Anas Nashif
commit 9cc9bdcd53
9 changed files with 59 additions and 103 deletions
Download patch file Download diff file Expand all files Collapse all files

16
doc/kernel/microkernel/microkernel_memory_pools.rst
View file

@ -125,7 +125,7 @@ available, then fills it with zeroes.
struct k_block block;
task_mem_pool_alloc_wait(&block, MYPOOL, 80);
task_mem_pool_alloc(&block, MYPOOL, 80, TICKS_UNLIMITED);
memset(block.pointer_to_data, 0, 80);
@ -140,7 +140,7 @@ in that time.
struct k_block block;
if (task_mem_pool_alloc_wait_timeout(&block, MYPOOL, 80, 5) == RC_OK) {
if (task_mem_pool_alloc(&block, MYPOOL, 80, 5) == RC_OK) {
/* use memory block */
} else {
printf('Memory allocation timeout');
@ -156,7 +156,7 @@ a memory block of 80 bytes.
struct k_block block;
if (task_mem_pool_alloc (&block, MYPOOL, 80) == RC_OK) {
if (task_mem_pool_alloc (&block, MYPOOL, 80, TICKS_NONE) == RC_OK) {
/* use memory block */
} else {
printf('Memory allocation timeout');
@ -171,7 +171,7 @@ This code releases a memory block back to a pool when it is no longer needed.
struct k_block block;
task_mem_pool_alloc(&block, MYPOOL, size);
task_mem_pool_alloc(&block, MYPOOL, size, TICKS_NONE);
/* use memory block */
task_mem_pool_free(&block);
@ -194,12 +194,6 @@ APIs
The following Memory Pools APIs are provided by :file:`microkernel.h`:
:c:func:`task_mem_pool_alloc()`
Allocates a block from a memory pool.
:c:func:`task_mem_pool_alloc_wait()`
Waits for a block of memory until it is available.
:c:func:`task_mem_pool_alloc_wait_timeout()`
Waits for a block of memory for the time period defined by the time-out
parameter.
@ -207,4 +201,4 @@ The following Memory Pools APIs are provided by :file:`microkernel.h`:
Returns a block of memory to a memory pool.
:c:func:`task_mem_pool_defragment()`
Defragments a memory pool.
Defragments a memory pool.