Changeset 690b7f9 in rtems-docs

Timestamp:

03/07/18 13:10:50 (5 years ago)

Author:

Sebastian Huber <sebastian.huber@…>

Branches:

5, am, master

Children:

464d541

Parents:

c2ee227

git-author:

Sebastian Huber <sebastian.huber@…> (03/07/18 13:10:50)

git-committer:

Sebastian Huber <sebastian.huber@…> (03/07/18 14:32:41)

Message:

c-user: Sort scheduler configuration options

File:

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

c-user/configuring_a_system.rst

@@ -3307 +3307 @@
 configuration macros.
 
-.. index:: CONFIGURE_SCHEDULER_PRIORITY
-
-.. _CONFIGURE_SCHEDULER_PRIORITY:
-
-CONFIGURE_SCHEDULER_PRIORITY
-----------------------------
-
-CONSTANT:
-    ``CONFIGURE_SCHEDULER_PRIORITY``
-
-DATA TYPE:
-    Boolean feature macro.
-
-RANGE:
-    Defined or undefined.
-
-DEFAULT VALUE:
-    This is defined by default.  This is the default scheduler and specifying
-    this configuration parameter is redundant.
-
-DESCRIPTION:
-    The Deterministic Priority Scheduler is the default scheduler in RTEMS for
-    uni-processor applications and is designed for predictable performance
-    under the highest loads.  It can block or unblock a thread in a constant
-    amount of time.  This scheduler requires a variable amount of memory based
-    upon the number of priorities configured in the system.
-
-NOTES:
+.. index:: CONFIGURE_SCHEDULER_CBS
+
+.. _CONFIGURE_SCHEDULER_CBS:
+
+CONFIGURE_SCHEDULER_CBS
+-----------------------
+
+CONSTANT:
+    ``CONFIGURE_SCHEDULER_CBS``
+
+DATA TYPE:
+    Boolean feature macro.
+
+RANGE:
+    Defined or undefined.
+
+DEFAULT VALUE:
+    This is not defined by default.
+
+DESCRIPTION:
+    The Constant Bandwidth Server Scheduler (CBS) is an alternative scheduler
+    in RTEMS for uni-processor applications. The CBS is a budget aware
+    extension of EDF scheduler. The goal of this scheduler is to ensure
+    temporal isolation of tasks. The CBS is equipped with a set of additional
+    rules and provides with an extensive API.
+
     This scheduler may be explicitly selected by defining
-    ``CONFIGURE_SCHEDULER_PRIORITY`` although this is equivalent to the default
-    behavior.
-
-.. index:: CONFIGURE_SCHEDULER_SIMPLE
-
-.. _CONFIGURE_SCHEDULER_SIMPLE:
-
-CONFIGURE_SCHEDULER_SIMPLE
---------------------------
-
-CONSTANT:
-    ``CONFIGURE_SCHEDULER_SIMPLE``
-
-DATA TYPE:
-    Boolean feature macro.
-
-RANGE:
-    Defined or undefined.
-
-DEFAULT VALUE:
-    This is not defined by default.
-
-DESCRIPTION:
-    When defined, the Simple Priority Scheduler is used at the thread
-    scheduling algorithm. This is an alternative scheduler in RTEMS.  It is
-    designed to provide the same task scheduling behaviour as the Deterministic
-    Priority Scheduler while being simpler in implementation and uses less
-    memory for data management.  It maintains a single sorted list of all ready
-    threads.  Thus blocking or unblocking a thread is not a constant time
-    operation with this scheduler.
-
-    This scheduler may be explicitly selected by defining
-    ``CONFIGURE_SCHEDULER_SIMPLE``.
-
-NOTES:
-    This scheduler is appropriate for use in small systems where RAM is limited.
+    ``CONFIGURE_SCHEDULER_CBS``.
+
+NOTES:
+    None.
 
 .. index:: CONFIGURE_SCHEDULER_EDF
@@ -3435 +3401 @@
     None.
 
-.. index:: CONFIGURE_SCHEDULER_CBS
-
-.. _CONFIGURE_SCHEDULER_CBS:
-
-CONFIGURE_SCHEDULER_CBS
------------------------
-
-CONSTANT:
-    ``CONFIGURE_SCHEDULER_CBS``
-
-DATA TYPE:
-    Boolean feature macro.
-
-RANGE:
-    Defined or undefined.
-
-DEFAULT VALUE:
-    This is not defined by default.
-
-DESCRIPTION:
-    The Constant Bandwidth Server Scheduler (CBS) is an alternative scheduler
-    in RTEMS for uni-processor applications. The CBS is a budget aware
-    extension of EDF scheduler. The goal of this scheduler is to ensure
-    temporal isolation of tasks. The CBS is equipped with a set of additional
-    rules and provides with an extensive API.
-
-    This scheduler may be explicitly selected by defining
-    ``CONFIGURE_SCHEDULER_CBS``.
-
-NOTES:
-    None.
-
-.. index:: CONFIGURE_SCHEDULER_PRIORITY_SMP
-
-.. _CONFIGURE_SCHEDULER_PRIORITY_SMP:
-
-CONFIGURE_SCHEDULER_PRIORITY_SMP
---------------------------------
-
-CONSTANT:
-    ``CONFIGURE_SCHEDULER_PRIORITY_SMP``
-
-DATA TYPE:
-    Boolean feature macro.
-
-RANGE:
-    Defined or undefined.
-
-DEFAULT VALUE:
-    This is not defined by default.
-
-DESCRIPTION:
-    The Deterministic Priority SMP Scheduler is derived from the Deterministic
-    Priority Scheduler but is capable of scheduling threads across multiple
-    processors.
-
-    In a configuration with SMP enabled at configure time, it may be explicitly
-    selected by defining ``CONFIGURE_SCHEDULER_PRIORITY_SMP``.
-
-NOTES:
-    This scheduler is only available when RTEMS is configured with SMP support
-    enabled.
-
-    This scheduler is currently the default in SMP configurations and is only
-    selected when ``CONFIGURE_MAXIMUM_PROCESSORS`` is greater than one.
-
-.. index:: CONFIGURE_SCHEDULER_SIMPLE_SMP
-
-.. _CONFIGURE_SCHEDULER_SIMPLE_SMP:
-
-CONFIGURE_SCHEDULER_SIMPLE_SMP
-------------------------------
-
-CONSTANT:
-    ``CONFIGURE_SCHEDULER_SIMPLE_SMP``
-
-DATA TYPE:
-    Boolean feature macro.
-
-RANGE:
-    Defined or undefined.
-
-DEFAULT VALUE:
-    This is not defined by default.
-
-DESCRIPTION:
-    The Simple SMP Priority Scheduler is derived from the Simple Priority
-    Scheduler but is capable of scheduling threads across multiple processors.
-    It is designed to provide the same task scheduling behaviour as the
-    Deterministic Priority Scheduler while distributing threads across multiple
-    processors.  Being based upon the Simple Priority Scheduler, it also
-    maintains a single sorted list of all ready threads.  Thus blocking or
-    unblocking a thread is not a constant time operation with this scheduler.
-
-    In addition, when allocating threads to processors, the algorithm is not
-    constant time. This algorithm was not designed with efficiency as a primary
-    design goal.  Its primary design goal was to provide an SMP-aware
-    scheduling algorithm that is simple to understand.
-
-    In a configuration with SMP enabled at configure time, it may be explicitly
-    selected by defining ``CONFIGURE_SCHEDULER_SIMPLE_SMP``.
-
-NOTES:
-    This scheduler is only available when RTEMS is configured with SMP support
-    enabled.
-
 .. index:: CONFIGURE_SCHEDULER_NAME
 
@@ -3575 +3435 @@
 NOTES:
     None.
+
+.. index:: CONFIGURE_SCHEDULER_PRIORITY
+
+.. _CONFIGURE_SCHEDULER_PRIORITY:
+
+CONFIGURE_SCHEDULER_PRIORITY
+----------------------------
+
+CONSTANT:
+    ``CONFIGURE_SCHEDULER_PRIORITY``
+
+DATA TYPE:
+    Boolean feature macro.
+
+RANGE:
+    Defined or undefined.
+
+DEFAULT VALUE:
+    This is defined by default.  This is the default scheduler and specifying
+    this configuration parameter is redundant.
+
+DESCRIPTION:
+    The Deterministic Priority Scheduler is the default scheduler in RTEMS for
+    uni-processor applications and is designed for predictable performance
+    under the highest loads.  It can block or unblock a thread in a constant
+    amount of time.  This scheduler requires a variable amount of memory based
+    upon the number of priorities configured in the system.
+
+NOTES:
+    This scheduler may be explicitly selected by defining
+    ``CONFIGURE_SCHEDULER_PRIORITY`` although this is equivalent to the default
+    behavior.
+
+.. index:: CONFIGURE_SCHEDULER_PRIORITY_SMP
+
+.. _CONFIGURE_SCHEDULER_PRIORITY_SMP:
+
+CONFIGURE_SCHEDULER_PRIORITY_SMP
+--------------------------------
+
+CONSTANT:
+    ``CONFIGURE_SCHEDULER_PRIORITY_SMP``
+
+DATA TYPE:
+    Boolean feature macro.
+
+RANGE:
+    Defined or undefined.
+
+DEFAULT VALUE:
+    This is not defined by default.
+
+DESCRIPTION:
+    The Deterministic Priority SMP Scheduler is derived from the Deterministic
+    Priority Scheduler but is capable of scheduling threads across multiple
+    processors.
+
+    In a configuration with SMP enabled at configure time, it may be explicitly
+    selected by defining ``CONFIGURE_SCHEDULER_PRIORITY_SMP``.
+
+NOTES:
+    This scheduler is only available when RTEMS is configured with SMP support
+    enabled.
+
+    This scheduler is currently the default in SMP configurations and is only
+    selected when ``CONFIGURE_MAXIMUM_PROCESSORS`` is greater than one.
+
+.. index:: CONFIGURE_SCHEDULER_SIMPLE
+
+.. _CONFIGURE_SCHEDULER_SIMPLE:
+
+CONFIGURE_SCHEDULER_SIMPLE
+--------------------------
+
+CONSTANT:
+    ``CONFIGURE_SCHEDULER_SIMPLE``
+
+DATA TYPE:
+    Boolean feature macro.
+
+RANGE:
+    Defined or undefined.
+
+DEFAULT VALUE:
+    This is not defined by default.
+
+DESCRIPTION:
+    When defined, the Simple Priority Scheduler is used at the thread
+    scheduling algorithm. This is an alternative scheduler in RTEMS.  It is
+    designed to provide the same task scheduling behaviour as the Deterministic
+    Priority Scheduler while being simpler in implementation and uses less
+    memory for data management.  It maintains a single sorted list of all ready
+    threads.  Thus blocking or unblocking a thread is not a constant time
+    operation with this scheduler.
+
+    This scheduler may be explicitly selected by defining
+    ``CONFIGURE_SCHEDULER_SIMPLE``.
+
+NOTES:
+    This scheduler is appropriate for use in small systems where RAM is limited.
+
+.. index:: CONFIGURE_SCHEDULER_SIMPLE_SMP
+
+.. _CONFIGURE_SCHEDULER_SIMPLE_SMP:
+
+CONFIGURE_SCHEDULER_SIMPLE_SMP
+------------------------------
+
+CONSTANT:
+    ``CONFIGURE_SCHEDULER_SIMPLE_SMP``
+
+DATA TYPE:
+    Boolean feature macro.
+
+RANGE:
+    Defined or undefined.
+
+DEFAULT VALUE:
+    This is not defined by default.
+
+DESCRIPTION:
+    The Simple SMP Priority Scheduler is derived from the Simple Priority
+    Scheduler but is capable of scheduling threads across multiple processors.
+    It is designed to provide the same task scheduling behaviour as the
+    Deterministic Priority Scheduler while distributing threads across multiple
+    processors.  Being based upon the Simple Priority Scheduler, it also
+    maintains a single sorted list of all ready threads.  Thus blocking or
+    unblocking a thread is not a constant time operation with this scheduler.
+
+    In addition, when allocating threads to processors, the algorithm is not
+    constant time. This algorithm was not designed with efficiency as a primary
+    design goal.  Its primary design goal was to provide an SMP-aware
+    scheduling algorithm that is simple to understand.
+
+    In a configuration with SMP enabled at configure time, it may be explicitly
+    selected by defining ``CONFIGURE_SCHEDULER_SIMPLE_SMP``.
+
+NOTES:
+    This scheduler is only available when RTEMS is configured with SMP support
+    enabled.
 
 .. index:: CONFIGURE_SCHEDULER_USER