summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoel Sherrill <joel@rtems.org>2021-10-12 13:46:11 -0500
committerJoel Sherrill <joel@rtems.org>2021-10-12 13:46:11 -0500
commitdf5be4c97a80e9c6772ba4ca9179890724d22cee (patch)
tree6d1ef1d3a8685dcaf6552941472b6259d3baf634
parentglossary: Add terms (diff)
downloadrtems-docs-df5be4c97a80e9c6772ba4ca9179890724d22cee.tar.bz2
task-stack-alloc.rst: Add CONFIGURE_TASK_STACK_FROM_ALLOCATOR
Updates #4524.
-rw-r--r--c-user/config/task-stack-alloc.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/c-user/config/task-stack-alloc.rst b/c-user/config/task-stack-alloc.rst
index 3f779ff..5701dd3 100644
--- a/c-user/config/task-stack-alloc.rst
+++ b/c-user/config/task-stack-alloc.rst
@@ -199,3 +199,36 @@ DESCRIPTION:
NOTES:
This configuration option may be used if a custom task stack allocator is
configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`.
+
+.. index:: _CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE
+.. index:: IDLE task stack allocator
+
+.. _CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE:
+
+CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE
+---------------------------------------
+
+CONSTANT:
+ ``CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE``
+
+OPTION TYPE:
+ This configuration option is an initializer define.
+
+DEFAULT VALUE:
+ The default value is ``_Stack_Allocator_allocate_for_idle``, which
+ indicates that IDLE task stacks will be allocated from an area statically
+ reserved by `<rtems/confdefs.h>``.
+
+VALUE CONSTRAINTS:
+ The value of this configuration option shall be defined to a valid
+ function pointer of the type ``void *( *allocate )( uint32_t, size_t )``.
+
+DESCRIPTION:
+ The value of this configuration option is the address for the the
+ IDLE stack allocator allocate handler.
+
+NOTES:
+ This configuration option is independent of the other thread stack allocator
+ configuration options. It is assumed that any memory allocated for IDLE
+ task stacks will not be from the RTEMS Workspace or the memory statically
+ reserved by default.