rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-15 05:06:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

c-user: Regenerate for IDLE task allocator option

Browse Source 
Update #4524.
This commit is contained in:
Sebastian Huber 2021-10-19 16:42:04 +02:00
parent df5be4c97a
commit 46dbb6dd7f
1 changed files with 37 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
c-user/config/task-stack-alloc.rst
View File

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. Copyright (C) 1988, 2021 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
.. generated. If you find something that needs to be fixed or
@ -93,6 +93,42 @@ NOTES:
This configuration option may be used if a custom task stack allocator is
configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`.
.. Generated from spec:/acfg/if/task-stack-allocator-for-idle
.. index:: CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE
.. index:: task stack allocator for IDLE tasks
.. _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_default``, which
indicates that IDLE task stacks will be allocated from an area statically
allocated 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 stack allocator
allocate handler used to allocate the task stack of each
:term:`IDLE task`.
NOTES:
This configuration option is independent of the other thread stack allocator
configuration options. It is assumed that any memory allocated for the stack
of an :term:`IDLE task` will not be from the RTEMS Workspace or the
memory statically allocated by default.
.. Generated from spec:/acfg/if/task-stack-allocator-init
.. index:: CONFIGURE_TASK_STACK_ALLOCATOR_INIT
@ -199,36 +235,3 @@ 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.