Changeset 05a5366 in rtems-docs


Ignore:
Timestamp:
Oct 22, 2018, 12:22:45 PM (6 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
ab83940
Parents:
969e60e
git-author:
Sebastian Huber <sebastian.huber@…> (10/22/18 12:22:45)
git-committer:
Sebastian Huber <sebastian.huber@…> (10/22/18 12:30:47)
Message:

c-user: Modify CONFIGURE_INTERRUPT_STACK_SIZE

Use CPU_STACK_MINIMUM_SIZE instead of CONFIGURE_MINIMUM_TASK_STACK_SIZE
to set the default value.

Clarify documentation.

Update #3480.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/configuring_a_system.rst

    r969e60e r05a5366  
    16571657    configuration option.
    16581658
     1659    In releases before RTEMS 5.1 the ``CONFIGURE_MINIMUM_TASK_STACK_SIZE`` was
     1660    used to define the default value of :ref:`CONFIGURE_INTERRUPT_STACK_SIZE
     1661    <CONFIGURE_INTERRUPT_STACK_SIZE>`.
     1662
    16591663.. index:: CONFIGURE_INTERRUPT_STACK_SIZE
    16601664.. index:: interrupt stack size
     
    16691673
    16701674DATA TYPE:
    1671     Unsigned integer (``uint32_t``).
     1675    Unsigned integer.
    16721676
    16731677RANGE:
     
    16751679
    16761680DEFAULT VALUE:
    1677     The default value is CONFIGURE_MINIMUM_TASK_STACK_SIZE, which is the
    1678     minimum interrupt stack size.
    1679 
    1680 DESCRIPTION:
    1681     ``CONFIGURE_INTERRUPT_STACK_SIZE`` is set to the size of the interrupt
    1682     stack.  The interrupt stack size is often set by the BSP but since this
    1683     memory may be allocated from the RTEMS Workspace, it must be accounted for.
    1684 
    1685 NOTES:
    1686     In some BSPs, changing this constant does NOT change the size of the
    1687     interrupt stack, only the amount of memory reserved for it.
    1688 
    1689     Patches which result in this constant only being used in memory
    1690     calculations when the interrupt stack is intended to be allocated from the
    1691     RTEMS Workspace would be welcomed by the RTEMS Project.
     1681    The default value is ``BSP_INTERRUPT_STACK_SIZE`` in case it is defined,
     1682    otherwise the default value is ``CPU_STACK_MINIMUM_SIZE``.
     1683
     1684DESCRIPTION:
     1685    The ``CONFIGURE_INTERRUPT_STACK_SIZE`` configuration option defines the
     1686    size of an interrupt stack in bytes.
     1687
     1688NOTES:
     1689    The interrupt stack size must be aligned according to
     1690    ``CPU_INTERRUPT_STACK_ALIGNMENT``.
     1691
     1692    There is one interrupt stack available for each configured processor
     1693    (:ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>`).  The
     1694    interrupt stack areas are statically allocated in a special linker section
     1695    (``.rtemsstack.interrupt``).  The placement of this linker section is
     1696    BSP-specific.
     1697
     1698    Some BSPs use the interrupt stack as the initialization stack which is used
     1699    to perform the sequential system initialization before the multithreading
     1700    is started.
     1701
     1702    The interrupt stacks are covered by the :ref:`stack checker
     1703    <CONFIGURE_STACK_CHECKER_ENABLED>`.  However, using a too small interrupt
     1704    stack size may still result in undefined behaviour.
     1705
     1706    In releases before RTEMS 5.1 the default value was
     1707    :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE
     1708    <CONFIGURE_MINIMUM_TASK_STACK_SIZE>` instead of ``CPU_STACK_MINIMUM_SIZE``.
    16921709
    16931710.. index:: CONFIGURE_EXTRA_TASK_STACKS
Note: See TracChangeset for help on using the changeset viewer.