summaryrefslogtreecommitdiffstats
path: root/c-user/config/idle-task.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-11-16 08:17:31 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-11-17 09:08:53 +0100
commit1c8ce332e273bb9f10cdb18e32e977cb9301fbad (patch)
tree8622528cf6fb748d6196ba5b9a46bf8c10b941bc /c-user/config/idle-task.rst
parentc-user: CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS (diff)
downloadrtems-docs-1c8ce332e273bb9f10cdb18e32e977cb9301fbad.tar.bz2
c-user: Use rubric for configuration options
Clear the page for each configuration options similar to the directives. Use a rubric instead of a definition list for the application configuration options similar to the directive documentation pages. For direcives and application configuration options use the same rubric order. Generalize value constraints to constraints. This patch does not change hand written content.
Diffstat (limited to 'c-user/config/idle-task.rst')
-rw-r--r--c-user/config/idle-task.rst159
1 files changed, 94 insertions, 65 deletions
diff --git a/c-user/config/idle-task.rst b/c-user/config/idle-task.rst
index 1234f42..5cf8364 100644
--- a/c-user/config/idle-task.rst
+++ b/c-user/config/idle-task.rst
@@ -27,6 +27,10 @@ This section describes configuration options related to the idle tasks.
.. Generated from spec:/acfg/if/idle-task-body
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IDLE_TASK_BODY
.. _CONFIGURE_IDLE_TASK_BODY:
@@ -34,33 +38,43 @@ This section describes configuration options related to the idle tasks.
CONFIGURE_IDLE_TASK_BODY
------------------------
-CONSTANT:
- ``CONFIGURE_IDLE_TASK_BODY``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IDLE_TASK_BODY``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is an initializer define.
+
+.. rubric:: DEFAULT VALUE:
-OPTION TYPE:
- This configuration option is an initializer define.
+If :ref:`BSP_IDLE_TASK_BODY` is defined, then this will be the default value,
+otherwise the default value is ``_CPU_Thread_Idle_body``.
-DEFAULT VALUE:
- If :ref:`BSP_IDLE_TASK_BODY` is defined, then this will be the default value,
- otherwise the default value is ``_CPU_Thread_Idle_body``.
+.. rubric:: DESCRIPTION:
-VALUE CONSTRAINTS:
- The value of this configuration option shall be defined to a valid function
- pointer of the type ``void *( *idle_body )( uintptr_t )``.
+The value of this configuration option initializes the IDLE thread body.
-DESCRIPTION:
- The value of this configuration option initializes the IDLE thread body.
+.. rubric:: NOTES:
-NOTES:
- IDLE threads shall not block. A blocking IDLE thread results in undefined
- system behaviour because the scheduler assume that at least one ready thread
- exists.
+IDLE threads shall not block. A blocking IDLE thread results in undefined
+system behaviour because the scheduler assume that at least one ready thread
+exists.
- IDLE threads can be used to initialize the application, see configuration
- option :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`.
+IDLE threads can be used to initialize the application, see configuration
+option :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`.
+
+.. rubric:: CONSTRAINTS:
+
+The value of the configuration option shall be defined to a valid function
+pointer of the type ``void *( *idle_body )( uintptr_t )``.
.. Generated from spec:/acfg/if/idle-task-init-appl
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
.. _CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION:
@@ -68,47 +82,56 @@ NOTES:
CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
-------------------------------------------
-CONSTANT:
- ``CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION``
+
+.. rubric:: OPTION TYPE:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+This configuration option is a boolean feature define.
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the user is assumed to
- provide one or more initialization tasks.
+.. rubric:: DEFAULT CONFIGURATION:
-DESCRIPTION:
- This configuration option is defined to indicate that the user has configured
- **no** user initialization tasks or threads and that the user provided IDLE
- task will perform application initialization and then transform itself into
- an IDLE task.
+If this configuration option is undefined, then the user is assumed to
+provide one or more initialization tasks.
-NOTES:
- If you use this option be careful, the user IDLE task **cannot** block at all
- during the initialization sequence. Further, once application
- initialization is complete, it shall make itself preemptible and enter an idle
- body loop.
+.. rubric:: DESCRIPTION:
- The IDLE task shall run at the lowest priority of all tasks in the system.
+This configuration option is defined to indicate that the user has configured
+**no** user initialization tasks or threads and that the user provided IDLE
+task will perform application initialization and then transform itself into
+an IDLE task.
- If this configuration option is defined, then it is mandatory to configure a
- user IDLE task with the :ref:`CONFIGURE_IDLE_TASK_BODY` configuration option,
- otherwise a compile time error in the configuration file will occur.
+.. rubric:: NOTES:
- The application shall define exactly one of the following configuration
- options
+If you use this option be careful, the user IDLE task **cannot** block at all
+during the initialization sequence. Further, once application
+initialization is complete, it shall make itself preemptible and enter an idle
+body loop.
- * :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`,
+The IDLE task shall run at the lowest priority of all tasks in the system.
- * :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or
+If this configuration option is defined, then it is mandatory to configure a
+user IDLE task with the :ref:`CONFIGURE_IDLE_TASK_BODY` configuration option,
+otherwise a compile time error in the configuration file will occur.
- * ``CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION``
+The application shall define exactly one of the following configuration
+options
- otherwise a compile time error in the configuration file will occur.
+* :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`,
+
+* :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or
+
+* ``CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION``
+
+otherwise a compile time error in the configuration file will occur.
.. Generated from spec:/acfg/if/idle-task-stack-size
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IDLE_TASK_STACK_SIZE
.. _CONFIGURE_IDLE_TASK_STACK_SIZE:
@@ -116,30 +139,36 @@ NOTES:
CONFIGURE_IDLE_TASK_STACK_SIZE
------------------------------
-CONSTANT:
- ``CONFIGURE_IDLE_TASK_STACK_SIZE``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IDLE_TASK_STACK_SIZE``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is an integer define.
+
+.. rubric:: DEFAULT VALUE:
+
+The default value is :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
+
+.. rubric:: DESCRIPTION:
-OPTION TYPE:
- This configuration option is an integer define.
+The value of this configuration option defines the task stack size for an
+IDLE task.
-DEFAULT VALUE:
- The default value is :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
+.. rubric:: NOTES:
-VALUE CONSTRAINTS:
- The value of this configuration option shall satisfy all of the following
- constraints:
+In SMP configurations, there is one IDLE task per configured processor, see
+:ref:`CONFIGURE_MAXIMUM_PROCESSORS`.
- * It shall be greater than or equal to a BSP-specific and
- application-specific minimum value.
+.. rubric:: CONSTRAINTS:
- * It shall be small enough so that the IDLE task stack area calculation
- carried out by ``<rtems/confdefs.h>`` does not overflow an integer of
- type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
+The following constraints apply to this configuration option:
-DESCRIPTION:
- The value of this configuration option defines the task stack size for an
- IDLE task.
+* The value of the configuration option shall be greater than or equal to a
+ BSP-specific and application-specific minimum value.
-NOTES:
- In SMP configurations, there is one IDLE task per configured processor, see
- :ref:`CONFIGURE_MAXIMUM_PROCESSORS`.
+* The value of the configuration option shall be small enough so that the IDLE
+ task stack area calculation carried out by ``<rtems/confdefs.h>`` does not
+ overflow an integer of type `size_t
+ <https://en.cppreference.com/w/c/types/size_t>`_.