Changeset 46dbb6d in rtems-docs


Ignore:
Timestamp:
Oct 19, 2021, 2:42:04 PM (3 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
feb4687
Parents:
df5be4c
git-author:
Sebastian Huber <sebastian.huber@…> (10/19/21 14:42:04)
git-committer:
Sebastian Huber <sebastian.huber@…> (10/25/21 06:13:47)
Message:

c-user: Regenerate for IDLE task allocator option

Update #4524.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/config/task-stack-alloc.rst

    rdf5be4c r46dbb6d  
    22
    33.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
    4 .. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
     4.. Copyright (C) 1988, 2021 On-Line Applications Research Corporation (OAR)
    55
    66.. This file is part of the RTEMS quality process and was automatically
     
    9494    configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`.
    9595
     96.. Generated from spec:/acfg/if/task-stack-allocator-for-idle
     97
     98.. index:: CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE
     99.. index:: task stack allocator for IDLE tasks
     100
     101.. _CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE:
     102
     103CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE
     104---------------------------------------
     105
     106CONSTANT:
     107    ``CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE``
     108
     109OPTION TYPE:
     110    This configuration option is an initializer define.
     111
     112DEFAULT VALUE:
     113    The default value is ``_Stack_Allocator_allocate_for_idle_default``, which
     114    indicates that IDLE task stacks will be allocated from an area statically
     115    allocated by ``<rtems/confdefs.h>``.
     116
     117VALUE CONSTRAINTS:
     118    The value of this configuration option shall be defined to a valid function
     119    pointer of the type ``void *( *allocate )( uint32_t, size_t )``.
     120
     121DESCRIPTION:
     122    The value of this configuration option is the address for the stack allocator
     123    allocate handler used to allocate the task stack of each
     124    :term:`IDLE task`.
     125
     126NOTES:
     127    This configuration option is independent of the other thread stack allocator
     128    configuration options.  It is assumed that any memory allocated for the stack
     129    of an :term:`IDLE task` will not be from the RTEMS Workspace or the
     130    memory statically allocated by default.
     131
    96132.. Generated from spec:/acfg/if/task-stack-allocator-init
    97133
     
    200236    This configuration option may be used if a custom task stack allocator is
    201237    configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`.
    202 
    203 .. index:: _CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE
    204 .. index:: IDLE task stack allocator
    205 
    206 .. _CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE:
    207 
    208 CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE
    209 ---------------------------------------
    210 
    211 CONSTANT:
    212     ``CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE``
    213 
    214 OPTION TYPE:
    215     This configuration option is an initializer define.
    216 
    217 DEFAULT VALUE:
    218     The default value is ``_Stack_Allocator_allocate_for_idle``, which
    219     indicates that IDLE task stacks will be allocated from an area statically
    220     reserved by `<rtems/confdefs.h>``.
    221 
    222 VALUE CONSTRAINTS:
    223     The value of this configuration option shall be defined to a valid
    224     function pointer of the type ``void *( *allocate )( uint32_t, size_t )``.
    225 
    226 DESCRIPTION:
    227     The value of this configuration option is the address for the the
    228     IDLE stack allocator allocate handler.
    229 
    230 NOTES:
    231     This configuration option is independent of the other thread stack allocator
    232     configuration options. It is assumed that any memory allocated for IDLE
    233     task stacks will not be from the RTEMS Workspace or the memory statically
    234     reserved by default.
Note: See TracChangeset for help on using the changeset viewer.