task-stack-alloc.rst: Add CONFIGURE_TASK_STACK_FROM_ALLOCATOR

Updates #4520.
This commit is contained in:
Joel Sherrill
2021-10-05 14:37:01 -05:00
parent 7c43a4b402
commit 30e5832dea

View File

@@ -1,7 +1,7 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0 .. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) .. 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 Task Stack Allocator Configuration
================================== ==================================
@@ -171,3 +171,37 @@ DESCRIPTION:
NOTES: NOTES:
This configuration option may be used if a custom task stack allocator is This configuration option may be used if a custom task stack allocator is
configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`. 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.