summaryrefslogtreecommitdiffstats
path: root/c-user/config/scheduler-general.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/scheduler-general.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/scheduler-general.rst')
-rw-r--r--c-user/config/scheduler-general.rst725
1 files changed, 427 insertions, 298 deletions
diff --git a/c-user/config/scheduler-general.rst b/c-user/config/scheduler-general.rst
index d78b14a..7c42039 100644
--- a/c-user/config/scheduler-general.rst
+++ b/c-user/config/scheduler-general.rst
@@ -49,6 +49,10 @@ configuration option.
.. Generated from spec:/acfg/if/cbs-max-servers
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_CBS_MAXIMUM_SERVERS
.. _CONFIGURE_CBS_MAXIMUM_SERVERS:
@@ -56,38 +60,47 @@ configuration option.
CONFIGURE_CBS_MAXIMUM_SERVERS
-----------------------------
-CONSTANT:
- ``CONFIGURE_CBS_MAXIMUM_SERVERS``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_CBS_MAXIMUM_SERVERS``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is an integer define.
+
+.. rubric:: DEFAULT VALUE:
+
+The default value is :ref:`CONFIGURE_MAXIMUM_TASKS`.
-OPTION TYPE:
- This configuration option is an integer define.
+.. rubric:: DESCRIPTION:
-DEFAULT VALUE:
- The default value is :ref:`CONFIGURE_MAXIMUM_TASKS`.
+The value of this configuration option defines the maximum number Constant
+Bandwidth Servers that can be concurrently active.
-VALUE CONSTRAINTS:
- The value of this configuration option shall satisfy all of the following
- constraints:
+.. rubric:: NOTES:
- * It shall be greater than or equal to zero.
+This configuration option is only evaluated if the configuration option
+:ref:`CONFIGURE_SCHEDULER_CBS` is defined.
- * It shall be less than or equal to `SIZE_MAX
- <https://en.cppreference.com/w/c/types/limits>`_.
+.. rubric:: CONSTRAINTS:
- * It shall be less than or equal to a BSP-specific and application-specific
- value which depends on the size of the memory available to the
- application.
+The following constraints apply to this configuration option:
-DESCRIPTION:
- The value of this configuration option defines the maximum number Constant
- Bandwidth Servers that can be concurrently active.
+* The value of the configuration option shall be greater than or equal to zero.
-NOTES:
- This configuration option is only evaluated if the configuration option
- :ref:`CONFIGURE_SCHEDULER_CBS` is defined.
+* The value of the configuration option shall be less than or equal to
+ `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
+
+* The value of the configuration option shall be less than or equal to a
+ BSP-specific and application-specific value which depends on the size of the
+ memory available to the application.
.. Generated from spec:/acfg/if/max-priority
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_MAXIMUM_PRIORITY
.. index:: maximum priority
.. index:: number of priority levels
@@ -97,57 +110,67 @@ NOTES:
CONFIGURE_MAXIMUM_PRIORITY
--------------------------
-CONSTANT:
- ``CONFIGURE_MAXIMUM_PRIORITY``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_MAXIMUM_PRIORITY``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is an integer define.
-OPTION TYPE:
- This configuration option is an integer define.
+.. rubric:: DEFAULT VALUE:
-DEFAULT VALUE:
- The default value is 255.
+The default value is 255.
-VALUE CONSTRAINTS:
- The value of this configuration option shall be equal to 3, 7, 31, 63, 127,
- or 255.
+.. rubric:: DESCRIPTION:
-DESCRIPTION:
- For the following schedulers
+For the following schedulers
- * :ref:`SchedulerPriority`, which is the default in uniprocessor
- configurations and can be configured through the
- :ref:`CONFIGURE_SCHEDULER_PRIORITY` configuration option,
+* :ref:`SchedulerPriority`, which is the default in uniprocessor
+ configurations and can be configured through the
+ :ref:`CONFIGURE_SCHEDULER_PRIORITY` configuration option,
- * :ref:`SchedulerSMPPriority` which can be configured through the
- :ref:`CONFIGURE_SCHEDULER_PRIORITY_SMP` configuration option, and
+* :ref:`SchedulerSMPPriority` which can be configured through the
+ :ref:`CONFIGURE_SCHEDULER_PRIORITY_SMP` configuration option, and
- * :ref:`SchedulerSMPPriorityAffinity` which can be configured through the
- :ref:`CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP` configuration option
+* :ref:`SchedulerSMPPriorityAffinity` which can be configured through the
+ :ref:`CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP` configuration option
- this configuration option specifies the maximum numeric priority of any task
- for these schedulers and one less that the number of priority levels for
- these schedulers. For all other schedulers provided by RTEMS, this
- configuration option has no effect.
+this configuration option specifies the maximum numeric priority of any task
+for these schedulers and one less that the number of priority levels for
+these schedulers. For all other schedulers provided by RTEMS, this
+configuration option has no effect.
-NOTES:
- The numerically greatest priority is the logically lowest priority in the
- system and will thus be used by the IDLE task.
+.. rubric:: NOTES:
- Priority zero is reserved for internal use by RTEMS and is not available to
- applications.
+The numerically greatest priority is the logically lowest priority in the
+system and will thus be used by the IDLE task.
- Reducing the number of priorities through this configuration option reduces
- the amount of memory allocated by the schedulers listed above. These
- schedulers use a chain control structure per priority and this structure
- consists of three pointers. On a 32-bit architecture, the allocated memory
- is 12 bytes * (``CONFIGURE_MAXIMUM_PRIORITY`` + 1), e.g. 3072 bytes for 256
- priority levels (default), 48 bytes for 4 priority levels
- (``CONFIGURE_MAXIMUM_PRIORITY == 3``).
+Priority zero is reserved for internal use by RTEMS and is not available to
+applications.
- The default value is 255, because RTEMS shall support 256 priority levels to
- be compliant with various standards. These priorities range from 0 to 255.
+Reducing the number of priorities through this configuration option reduces
+the amount of memory allocated by the schedulers listed above. These
+schedulers use a chain control structure per priority and this structure
+consists of three pointers. On a 32-bit architecture, the allocated memory
+is 12 bytes * (``CONFIGURE_MAXIMUM_PRIORITY`` + 1), e.g. 3072 bytes for 256
+priority levels (default), 48 bytes for 4 priority levels
+(``CONFIGURE_MAXIMUM_PRIORITY == 3``).
+
+The default value is 255, because RTEMS shall support 256 priority levels to
+be compliant with various standards. These priorities range from 0 to 255.
+
+.. rubric:: CONSTRAINTS:
+
+The value of the configuration option shall be equal to 3, 7, 31, 63, 127, or
+255.
.. Generated from spec:/acfg/if/scheduler-assignments
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_SCHEDULER_ASSIGNMENTS
.. _CONFIGURE_SCHEDULER_ASSIGNMENTS:
@@ -155,41 +178,51 @@ NOTES:
CONFIGURE_SCHEDULER_ASSIGNMENTS
-------------------------------
-CONSTANT:
- ``CONFIGURE_SCHEDULER_ASSIGNMENTS``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_SCHEDULER_ASSIGNMENTS``
+
+.. rubric:: OPTION TYPE:
-OPTION TYPE:
- This configuration option is an initializer define.
+This configuration option is an initializer define.
-DEFAULT VALUE:
- The default value of this configuration option is computed so that the
- default scheduler is assigned to each configured processor (up to 32).
+.. rubric:: DEFAULT VALUE:
-VALUE CONSTRAINTS:
- The value of this configuration option shall satisfy all of the following
- constraints:
+The default value of this configuration option is computed so that the
+default scheduler is assigned to each configured processor (up to 32).
- * It shall be a list of the following macros:
+.. rubric:: DESCRIPTION:
- * ``RTEMS_SCHEDULER_ASSIGN( processor_index, attributes )``
+The value of this configuration option is used to initialize the initial
+scheduler to processor assignments.
- * ``RTEMS_SCHEDULER_ASSIGN_NO_SCHEDULER``
+.. rubric:: NOTES:
- * It shall be a list of exactly :ref:`CONFIGURE_MAXIMUM_PROCESSORS`
- elements.
+This configuration option is only evaluated in SMP configurations.
-DESCRIPTION:
- The value of this configuration option is used to initialize the initial
- scheduler to processor assignments.
+This is an advanced configuration option, see
+:ref:`ConfigurationSchedulersClustered`.
-NOTES:
- This configuration option is only evaluated in SMP configurations.
+.. rubric:: CONSTRAINTS:
- This is an advanced configuration option, see
- :ref:`ConfigurationSchedulersClustered`.
+The following constraints apply to this configuration option:
+
+* The value of the configuration option shall be a list of the following
+ macros:
+
+ * ``RTEMS_SCHEDULER_ASSIGN( processor_index, attributes )``
+
+ * ``RTEMS_SCHEDULER_ASSIGN_NO_SCHEDULER``
+
+* The value of the configuration option shall be a list of exactly
+ :ref:`CONFIGURE_MAXIMUM_PROCESSORS` elements.
.. Generated from spec:/acfg/if/scheduler-cbs
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_SCHEDULER_CBS
.. _CONFIGURE_SCHEDULER_CBS:
@@ -197,30 +230,39 @@ NOTES:
CONFIGURE_SCHEDULER_CBS
-----------------------
-CONSTANT:
- ``CONFIGURE_SCHEDULER_CBS``
+.. rubric:: CONSTANT:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+``CONFIGURE_SCHEDULER_CBS``
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+.. rubric:: OPTION TYPE:
-DESCRIPTION:
- In case this configuration option is defined, then the
- :ref:`SchedulerCBS`
- algorithm is made available to the application.
+This configuration option is a boolean feature define.
-NOTES:
- This scheduler configuration option is an advanced configuration option.
- Think twice before you use it.
+.. rubric:: DEFAULT CONFIGURATION:
- In case no explicit :ref:`ConfigurationSchedulersClustered`
- is present, then it is used as the scheduler for exactly one processor.
+If this configuration option is undefined, then the described feature is not
+enabled.
+
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the
+:ref:`SchedulerCBS`
+algorithm is made available to the application.
+
+.. rubric:: NOTES:
+
+This scheduler configuration option is an advanced configuration option.
+Think twice before you use it.
+
+In case no explicit :ref:`ConfigurationSchedulersClustered`
+is present, then it is used as the scheduler for exactly one processor.
.. Generated from spec:/acfg/if/scheduler-edf
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_SCHEDULER_EDF
.. _CONFIGURE_SCHEDULER_EDF:
@@ -228,30 +270,39 @@ NOTES:
CONFIGURE_SCHEDULER_EDF
-----------------------
-CONSTANT:
- ``CONFIGURE_SCHEDULER_EDF``
+.. rubric:: CONSTANT:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+``CONFIGURE_SCHEDULER_EDF``
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+.. rubric:: OPTION TYPE:
-DESCRIPTION:
- In case this configuration option is defined, then the
- :ref:`SchedulerEDF`
- algorithm is made available to the application.
+This configuration option is a boolean feature define.
-NOTES:
- This scheduler configuration option is an advanced configuration option.
- Think twice before you use it.
+.. rubric:: DEFAULT CONFIGURATION:
- In case no explicit :ref:`ConfigurationSchedulersClustered`
- is present, then it is used as the scheduler for exactly one processor.
+If this configuration option is undefined, then the described feature is not
+enabled.
+
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the
+:ref:`SchedulerEDF`
+algorithm is made available to the application.
+
+.. rubric:: NOTES:
+
+This scheduler configuration option is an advanced configuration option.
+Think twice before you use it.
+
+In case no explicit :ref:`ConfigurationSchedulersClustered`
+is present, then it is used as the scheduler for exactly one processor.
.. Generated from spec:/acfg/if/scheduler-edf-smp
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_SCHEDULER_EDF_SMP
.. _CONFIGURE_SCHEDULER_EDF_SMP:
@@ -259,37 +310,46 @@ NOTES:
CONFIGURE_SCHEDULER_EDF_SMP
---------------------------
-CONSTANT:
- ``CONFIGURE_SCHEDULER_EDF_SMP``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_SCHEDULER_EDF_SMP``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DEFAULT CONFIGURATION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+If this configuration option is undefined, then the described feature is not
+enabled.
+
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the
+:ref:`SchedulerSMPEDF`
+algorithm is made available to the application.
-DESCRIPTION:
- In case this configuration option is defined, then the
- :ref:`SchedulerSMPEDF`
- algorithm is made available to the application.
+.. rubric:: NOTES:
-NOTES:
- This scheduler configuration option is an advanced configuration option.
- Think twice before you use it.
+This scheduler configuration option is an advanced configuration option.
+Think twice before you use it.
- This scheduler algorithm is only available when RTEMS is built with SMP
- support enabled.
+This scheduler algorithm is only available when RTEMS is built with SMP
+support enabled.
- In case no explicit :ref:`ConfigurationSchedulersClustered`
- is present, then it is used as the scheduler for up to 32 processors.
+In case no explicit :ref:`ConfigurationSchedulersClustered`
+is present, then it is used as the scheduler for up to 32 processors.
- This scheduler algorithm is the default in SMP configurations if
- :ref:`CONFIGURE_MAXIMUM_PROCESSORS` is
- greater than one.
+This scheduler algorithm is the default in SMP configurations if
+:ref:`CONFIGURE_MAXIMUM_PROCESSORS` is
+greater than one.
.. Generated from spec:/acfg/if/scheduler-name
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_SCHEDULER_NAME
.. _CONFIGURE_SCHEDULER_NAME:
@@ -297,49 +357,59 @@ NOTES:
CONFIGURE_SCHEDULER_NAME
------------------------
-CONSTANT:
- ``CONFIGURE_SCHEDULER_NAME``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_SCHEDULER_NAME``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is an integer define.
+
+.. rubric:: DEFAULT VALUE:
-OPTION TYPE:
- This configuration option is an integer define.
+The default value is
-DEFAULT VALUE:
- The default value is
+* ``"MEDF"`` for the :ref:`SchedulerSMPEDF`,
- * ``"MEDF"`` for the :ref:`SchedulerSMPEDF`,
+* ``"MPA "`` for the :ref:`SchedulerSMPPriorityAffinity`,
- * ``"MPA "`` for the :ref:`SchedulerSMPPriorityAffinity`,
+* ``"MPD "`` for the :ref:`SchedulerSMPPriority`,
- * ``"MPD "`` for the :ref:`SchedulerSMPPriority`,
+* ``"MPS "`` for the :ref:`SchedulerSMPPrioritySimple`,
- * ``"MPS "`` for the :ref:`SchedulerSMPPrioritySimple`,
+* ``"UCBS"`` for the :ref:`SchedulerCBS`,
- * ``"UCBS"`` for the :ref:`SchedulerCBS`,
+* ``"UEDF"`` for the :ref:`SchedulerEDF`,
- * ``"UEDF"`` for the :ref:`SchedulerEDF`,
+* ``"UPD "`` for the :ref:`SchedulerPriority`, and
- * ``"UPD "`` for the :ref:`SchedulerPriority`, and
+* ``"UPS "`` for the :ref:`SchedulerPrioritySimple`.
- * ``"UPS "`` for the :ref:`SchedulerPrioritySimple`.
+.. rubric:: DESCRIPTION:
-VALUE CONSTRAINTS:
- The value of this configuration option shall be convertible to an integer
- of type :c:type:`rtems_name`.
+The value of this configuration option defines the name of the default
+scheduler.
-DESCRIPTION:
- The value of this configuration option defines the name of the default
- scheduler.
+.. rubric:: NOTES:
-NOTES:
- This scheduler configuration option is an advanced configuration option.
- Think twice before you use it.
+This scheduler configuration option is an advanced configuration option.
+Think twice before you use it.
- Schedulers can be identified via :c:func:`rtems_scheduler_ident`.
+Schedulers can be identified via :c:func:`rtems_scheduler_ident`.
- Use :c:func:`rtems_build_name` to define the scheduler name.
+Use :c:func:`rtems_build_name` to define the scheduler name.
+
+.. rubric:: CONSTRAINTS:
+
+The value of the configuration option shall be convertible to an integer of
+type :c:type:`rtems_name`.
.. Generated from spec:/acfg/if/scheduler-priority
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_SCHEDULER_PRIORITY
.. _CONFIGURE_SCHEDULER_PRIORITY:
@@ -347,37 +417,46 @@ NOTES:
CONFIGURE_SCHEDULER_PRIORITY
----------------------------
-CONSTANT:
- ``CONFIGURE_SCHEDULER_PRIORITY``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_SCHEDULER_PRIORITY``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DEFAULT CONFIGURATION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+If this configuration option is undefined, then the described feature is not
+enabled.
-DESCRIPTION:
- In case this configuration option is defined, then the
- :ref:`SchedulerPriority`
- algorithm is made available to the application.
+.. rubric:: DESCRIPTION:
-NOTES:
- This scheduler configuration option is an advanced configuration option.
- Think twice before you use it.
+In case this configuration option is defined, then the
+:ref:`SchedulerPriority`
+algorithm is made available to the application.
- In case no explicit :ref:`ConfigurationSchedulersClustered`
- is present, then it is used as the scheduler for exactly one processor.
+.. rubric:: NOTES:
- This scheduler algorithm is the default when
- :ref:`CONFIGURE_MAXIMUM_PROCESSORS` is
- exactly one.
+This scheduler configuration option is an advanced configuration option.
+Think twice before you use it.
- The memory allocated for this scheduler depends on the
- :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.
+In case no explicit :ref:`ConfigurationSchedulersClustered`
+is present, then it is used as the scheduler for exactly one processor.
+
+This scheduler algorithm is the default when
+:ref:`CONFIGURE_MAXIMUM_PROCESSORS` is
+exactly one.
+
+The memory allocated for this scheduler depends on the
+:ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.
.. Generated from spec:/acfg/if/scheduler-priority-affinity-smp
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP
.. _CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP:
@@ -385,36 +464,45 @@ NOTES:
CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP
-----------------------------------------
-CONSTANT:
- ``CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP``
+
+.. 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 described feature is not
- enabled.
+.. rubric:: DEFAULT CONFIGURATION:
-DESCRIPTION:
- In case this configuration option is defined, then the
- :ref:`SchedulerSMPPriorityAffinity`
- algorithm is made available to the application.
+If this configuration option is undefined, then the described feature is not
+enabled.
-NOTES:
- This scheduler configuration option is an advanced configuration option.
- Think twice before you use it.
+.. rubric:: DESCRIPTION:
- This scheduler algorithm is only available when RTEMS is built with SMP
- support enabled.
+In case this configuration option is defined, then the
+:ref:`SchedulerSMPPriorityAffinity`
+algorithm is made available to the application.
- In case no explicit :ref:`ConfigurationSchedulersClustered`
- is present, then it is used as the scheduler for up to 32 processors.
+.. rubric:: NOTES:
- The memory allocated for this scheduler depends on the
- :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.
+This scheduler configuration option is an advanced configuration option.
+Think twice before you use it.
+
+This scheduler algorithm is only available when RTEMS is built with SMP
+support enabled.
+
+In case no explicit :ref:`ConfigurationSchedulersClustered`
+is present, then it is used as the scheduler for up to 32 processors.
+
+The memory allocated for this scheduler depends on the
+:ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.
.. Generated from spec:/acfg/if/scheduler-priority-smp
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_SCHEDULER_PRIORITY_SMP
.. _CONFIGURE_SCHEDULER_PRIORITY_SMP:
@@ -422,36 +510,45 @@ NOTES:
CONFIGURE_SCHEDULER_PRIORITY_SMP
--------------------------------
-CONSTANT:
- ``CONFIGURE_SCHEDULER_PRIORITY_SMP``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_SCHEDULER_PRIORITY_SMP``
+
+.. 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 described feature is not
- enabled.
+.. rubric:: DEFAULT CONFIGURATION:
-DESCRIPTION:
- In case this configuration option is defined, then the
- :ref:`SchedulerSMPPriority`
- algorithm is made available to the application.
+If this configuration option is undefined, then the described feature is not
+enabled.
-NOTES:
- This scheduler configuration option is an advanced configuration option.
- Think twice before you use it.
+.. rubric:: DESCRIPTION:
- This scheduler algorithm is only available when RTEMS is built with SMP
- support enabled.
+In case this configuration option is defined, then the
+:ref:`SchedulerSMPPriority`
+algorithm is made available to the application.
- In case no explicit :ref:`ConfigurationSchedulersClustered`
- is present, then it is used as the scheduler for up to 32 processors.
+.. rubric:: NOTES:
- The memory allocated for this scheduler depends on the
- :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.
+This scheduler configuration option is an advanced configuration option.
+Think twice before you use it.
+
+This scheduler algorithm is only available when RTEMS is built with SMP
+support enabled.
+
+In case no explicit :ref:`ConfigurationSchedulersClustered`
+is present, then it is used as the scheduler for up to 32 processors.
+
+The memory allocated for this scheduler depends on the
+:ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.
.. Generated from spec:/acfg/if/scheduler-simple
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_SCHEDULER_SIMPLE
.. _CONFIGURE_SCHEDULER_SIMPLE:
@@ -459,30 +556,39 @@ NOTES:
CONFIGURE_SCHEDULER_SIMPLE
--------------------------
-CONSTANT:
- ``CONFIGURE_SCHEDULER_SIMPLE``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_SCHEDULER_SIMPLE``
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: OPTION TYPE:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+This configuration option is a boolean feature define.
-DESCRIPTION:
- In case this configuration option is defined, then the
- :ref:`SchedulerPrioritySimple`
- algorithm is made available to the application.
+.. rubric:: DEFAULT CONFIGURATION:
-NOTES:
- This scheduler configuration option is an advanced configuration option.
- Think twice before you use it.
+If this configuration option is undefined, then the described feature is not
+enabled.
- In case no explicit :ref:`ConfigurationSchedulersClustered`
- is present, then it is used as the scheduler for exactly one processor.
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the
+:ref:`SchedulerPrioritySimple`
+algorithm is made available to the application.
+
+.. rubric:: NOTES:
+
+This scheduler configuration option is an advanced configuration option.
+Think twice before you use it.
+
+In case no explicit :ref:`ConfigurationSchedulersClustered`
+is present, then it is used as the scheduler for exactly one processor.
.. Generated from spec:/acfg/if/scheduler-simple-smp
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_SCHEDULER_SIMPLE_SMP
.. _CONFIGURE_SCHEDULER_SIMPLE_SMP:
@@ -490,33 +596,42 @@ NOTES:
CONFIGURE_SCHEDULER_SIMPLE_SMP
------------------------------
-CONSTANT:
- ``CONFIGURE_SCHEDULER_SIMPLE_SMP``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_SCHEDULER_SIMPLE_SMP``
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: OPTION TYPE:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+This configuration option is a boolean feature define.
-DESCRIPTION:
- In case this configuration option is defined, then the
- :ref:`SchedulerSMPPrioritySimple`
- algorithm is made available to the application.
+.. rubric:: DEFAULT CONFIGURATION:
-NOTES:
- This scheduler configuration option is an advanced configuration option.
- Think twice before you use it.
+If this configuration option is undefined, then the described feature is not
+enabled.
- This scheduler algorithm is only available when RTEMS is built with SMP
- support enabled.
+.. rubric:: DESCRIPTION:
- In case no explicit :ref:`ConfigurationSchedulersClustered`
- is present, then it is used as the scheduler for up to 32 processors.
+In case this configuration option is defined, then the
+:ref:`SchedulerSMPPrioritySimple`
+algorithm is made available to the application.
+
+.. rubric:: NOTES:
+
+This scheduler configuration option is an advanced configuration option.
+Think twice before you use it.
+
+This scheduler algorithm is only available when RTEMS is built with SMP
+support enabled.
+
+In case no explicit :ref:`ConfigurationSchedulersClustered`
+is present, then it is used as the scheduler for up to 32 processors.
.. Generated from spec:/acfg/if/scheduler-strong-apa
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_SCHEDULER_STRONG_APA
.. _CONFIGURE_SCHEDULER_STRONG_APA:
@@ -524,31 +639,40 @@ NOTES:
CONFIGURE_SCHEDULER_STRONG_APA
------------------------------
-CONSTANT:
- ``CONFIGURE_SCHEDULER_STRONG_APA``
+.. rubric:: CONSTANT:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+``CONFIGURE_SCHEDULER_STRONG_APA``
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+.. rubric:: OPTION TYPE:
-DESCRIPTION:
- In case this configuration option is defined, then the Strong APA algorithm
- is made available to the application.
+This configuration option is a boolean feature define.
-NOTES:
- This scheduler configuration option is an advanced configuration option.
- Think twice before you use it.
+.. rubric:: DEFAULT CONFIGURATION:
- This scheduler algorithm is only available when RTEMS is built with SMP
- support enabled.
+If this configuration option is undefined, then the described feature is not
+enabled.
- This scheduler algorithm is not correctly implemented. Do not use it.
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the Strong APA algorithm
+is made available to the application.
+
+.. rubric:: NOTES:
+
+This scheduler configuration option is an advanced configuration option.
+Think twice before you use it.
+
+This scheduler algorithm is only available when RTEMS is built with SMP
+support enabled.
+
+This scheduler algorithm is not correctly implemented. Do not use it.
.. Generated from spec:/acfg/if/scheduler-user
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_SCHEDULER_USER
.. _CONFIGURE_SCHEDULER_USER:
@@ -556,42 +680,47 @@ NOTES:
CONFIGURE_SCHEDULER_USER
------------------------
-CONSTANT:
- ``CONFIGURE_SCHEDULER_USER``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_SCHEDULER_USER``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
+
+.. rubric:: DEFAULT CONFIGURATION:
+
+If this configuration option is undefined, then the described feature is not
+enabled.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DESCRIPTION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+In case this configuration option is defined, then the user shall provide a
+scheduler algorithm to the application.
-DESCRIPTION:
- In case this configuration option is defined, then the user shall provide a
- scheduler algorithm to the application.
+.. rubric:: NOTES:
-NOTES:
- This scheduler configuration option is an advanced configuration option.
- Think twice before you use it.
+This scheduler configuration option is an advanced configuration option.
+Think twice before you use it.
- RTEMS allows the application to provide its own task/thread scheduling
- algorithm. In order to do this, one shall define
- ``CONFIGURE_SCHEDULER_USER`` to indicate the application provides its own
- scheduling algorithm. If ``CONFIGURE_SCHEDULER_USER`` is defined then the
- following additional macros shall be defined:
+RTEMS allows the application to provide its own task/thread scheduling
+algorithm. In order to do this, one shall define
+``CONFIGURE_SCHEDULER_USER`` to indicate the application provides its own
+scheduling algorithm. If ``CONFIGURE_SCHEDULER_USER`` is defined then the
+following additional macros shall be defined:
- * ``CONFIGURE_SCHEDULER`` shall be defined to a static definition of
- the scheduler data structures of the user scheduler.
+* ``CONFIGURE_SCHEDULER`` shall be defined to a static definition of
+ the scheduler data structures of the user scheduler.
- * ``CONFIGURE_SCHEDULER_TABLE_ENTRIES`` shall be defined to a scheduler
- table entry initializer for the user scheduler.
+* ``CONFIGURE_SCHEDULER_TABLE_ENTRIES`` shall be defined to a scheduler
+ table entry initializer for the user scheduler.
- * ``CONFIGURE_SCHEDULER_USER_PER_THREAD`` shall be defined to the type of
- the per-thread information of the user scheduler.
+* ``CONFIGURE_SCHEDULER_USER_PER_THREAD`` shall be defined to the type of
+ the per-thread information of the user scheduler.
- At this time, the mechanics and requirements for writing a new scheduler
- are evolving and not fully documented. It is recommended that you look at
- the existing Deterministic Priority Scheduler in
- ``cpukit/score/src/schedulerpriority*.c`` for guidance. For guidance on
- the configuration macros, please examine ``cpukit/sapi/include/confdefs.h``
- for how these are defined for the Deterministic Priority Scheduler.
+At this time, the mechanics and requirements for writing a new scheduler
+are evolving and not fully documented. It is recommended that you look at
+the existing Deterministic Priority Scheduler in
+``cpukit/score/src/schedulerpriority*.c`` for guidance. For guidance on
+the configuration macros, please examine ``cpukit/sapi/include/confdefs.h``
+for how these are defined for the Deterministic Priority Scheduler.