patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

kernel: Remove supported size comments from HEAP_MEM_POOL_SIZE

Browse source 
The mempool implementation doesn't require specific sizes and can
support arbitrary sizes up to the limit of available memory. The
Kconfig documentation on this configuration was confusing user.

Fixes #20418

Signed-off-by: David Leach <david.leach@nxp.com>
This commit is contained in:
David Leach 2020-07-23 14:13:09 -05:00 committed by Ioannis Glaropoulos
parent d8e63e7161
commit db36b146e1
2 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/reference/kernel/memory/heap.rst
View file

@ -124,7 +124,9 @@ The size of the heap memory pool is specified using the
:option:`CONFIG_HEAP_MEM_POOL_SIZE` configuration option.
By default, the heap memory pool size is zero bytes. This value instructs
the kernel not to define the heap memory pool object.
the kernel not to define the heap memory pool object. The maximum size is limited
by the amount of available memory in the system. The project build will fail in
the link stage if the size specified can not be supported.
Allocating Memory
=================

6
kernel/Kconfig
View file

@ -473,9 +473,9 @@ config HEAP_MEM_POOL_SIZE
default 1024 if POSIX_MQUEUE
help
This option specifies the size of the heap memory pool used when
dynamically allocating memory using k_malloc(). Supported values
are: 256, 1024, 4096, and 16384. A size of zero means that no
heap memory pool is defined.
dynamically allocating memory using k_malloc(). The maximum size of
the memory pool is only limited to available memory. A size of zero
means that no heap memory pool is defined.
config HEAP_MEM_POOL_MIN_SIZE
int "The smallest blocks in the heap memory pool (in bytes)"