Changeset 05a5366 in rtems-docs

Timestamp:

Oct 22, 2018, 12:22:45 PM (2 years ago)

Author:

Sebastian Huber <sebastian.huber@…>

Branches:

5, am, 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:

• c-user/configuring_a_system.rst (modified) (3 diffs)

c-user/configuring_a_system.rst

@@ -1657 +1657 @@
     configuration option.
 
+    In releases before RTEMS 5.1 the ``CONFIGURE_MINIMUM_TASK_STACK_SIZE`` was
+    used to define the default value of :ref:`CONFIGURE_INTERRUPT_STACK_SIZE
+    <CONFIGURE_INTERRUPT_STACK_SIZE>`.
+
 .. index:: CONFIGURE_INTERRUPT_STACK_SIZE
 .. index:: interrupt stack size
@@ -1669 +1673 @@
 
 DATA TYPE:
-    Unsigned integer (``uint32_t``).
+    Unsigned integer.
 
 RANGE:
@@ -1675 +1679 @@
 
 DEFAULT VALUE:
-    The default value is CONFIGURE_MINIMUM_TASK_STACK_SIZE, which is the
-    minimum interrupt stack size.
-
-DESCRIPTION:
-    ``CONFIGURE_INTERRUPT_STACK_SIZE`` is set to the size of the interrupt
-    stack.  The interrupt stack size is often set by the BSP but since this
-    memory may be allocated from the RTEMS Workspace, it must be accounted for.
-
-NOTES:
-    In some BSPs, changing this constant does NOT change the size of the
-    interrupt stack, only the amount of memory reserved for it.
-
-    Patches which result in this constant only being used in memory
-    calculations when the interrupt stack is intended to be allocated from the
-    RTEMS Workspace would be welcomed by the RTEMS Project.
+    The default value is ``BSP_INTERRUPT_STACK_SIZE`` in case it is defined,
+    otherwise the default value is ``CPU_STACK_MINIMUM_SIZE``.
+
+DESCRIPTION:
+    The ``CONFIGURE_INTERRUPT_STACK_SIZE`` configuration option defines the
+    size of an interrupt stack in bytes.
+
+NOTES:
+    The interrupt stack size must be aligned according to
+    ``CPU_INTERRUPT_STACK_ALIGNMENT``.
+
+    There is one interrupt stack available for each configured processor
+    (:ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>`).  The
+    interrupt stack areas are statically allocated in a special linker section
+    (``.rtemsstack.interrupt``).  The placement of this linker section is
+    BSP-specific.
+
+    Some BSPs use the interrupt stack as the initialization stack which is used
+    to perform the sequential system initialization before the multithreading
+    is started.
+
+    The interrupt stacks are covered by the :ref:`stack checker
+    <CONFIGURE_STACK_CHECKER_ENABLED>`.  However, using a too small interrupt
+    stack size may still result in undefined behaviour.
+
+    In releases before RTEMS 5.1 the default value was
+    :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE
+    <CONFIGURE_MINIMUM_TASK_STACK_SIZE>` instead of ``CPU_STACK_MINIMUM_SIZE``.
 
 .. index:: CONFIGURE_EXTRA_TASK_STACKS