summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoel Sherrill <joel@rtems.org>2021-10-05 14:37:01 -0500
committerJoel Sherrill <joel@rtems.org>2021-10-07 16:30:59 -0500
commit30e5832dea28bb537c8a1d4de6361c2bac58033d (patch)
tree8533416a67d374986b64e729ef2e205935841250
parent7c43a4b4023587ab386d94c57b5c1f8a4afc604e (diff)
downloadrtems-docs-5.tar.bz2
task-stack-alloc.rst: Add CONFIGURE_TASK_STACK_FROM_ALLOCATOR5
Updates #4520.
-rw-r--r--c-user/config/task-stack-alloc.rst36
1 files changed, 35 insertions, 1 deletions
diff --git a/c-user/config/task-stack-alloc.rst b/c-user/config/task-stack-alloc.rst
index 297c624..a779c9f 100644
--- a/c-user/config/task-stack-alloc.rst
+++ b/c-user/config/task-stack-alloc.rst
@@ -1,7 +1,7 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+.. Copyright (C) 1988, 2008, 2021 On-Line Applications Research Corporation (OAR)
Task Stack Allocator Configuration
==================================
@@ -171,3 +171,37 @@ 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.
+