summaryrefslogtreecommitdiffstats
path: root/c-user/scheduling-concepts
diff options
context:
space:
mode:
Diffstat (limited to 'c-user/scheduling-concepts')
-rw-r--r--c-user/scheduling-concepts/background.rst8
-rw-r--r--c-user/scheduling-concepts/directives.rst37
-rw-r--r--c-user/scheduling-concepts/index.rst2
-rw-r--r--c-user/scheduling-concepts/introduction.rst2
4 files changed, 26 insertions, 23 deletions
diff --git a/c-user/scheduling-concepts/background.rst b/c-user/scheduling-concepts/background.rst
index 1fe7089..38b77ee 100644
--- a/c-user/scheduling-concepts/background.rst
+++ b/c-user/scheduling-concepts/background.rst
@@ -160,7 +160,7 @@ Manual Round-Robin
The final mechanism for altering the RTEMS scheduling algorithm is called
manual round-robin. Manual round-robin is invoked by using
-the ``rtems_task_wake_after`` directive with a time interval of
+the ``rtems_task_wake_after`` directive with a ``ticks`` parameter of
``RTEMS_YIELD_PROCESSOR``. This allows a task to give up the processor and be
immediately returned to the ready chain at the end of its priority group. If
no other tasks of the same priority are ready to run, then the task does not
@@ -243,7 +243,7 @@ of the following conditions:
option and the requested semaphore is unavailable.
- The running task issues a ``rtems_task_wake_after`` directive which blocks
- the task for the given time interval. If the time interval specified is
+ the task for the given count of ticks. If the count of ticks specified is
zero, the task yields the processor and remains in the ready state.
- The running task issues a ``rtems_task_wake_when`` directive which blocks the
@@ -280,8 +280,8 @@ conditions:
- A running task issues a ``rtems_semaphore_release`` directive which releases
the semaphore on which the blocked task is waiting.
-- A timeout interval expires for a task which was blocked by a call to the
- ``rtems_task_wake_after`` directive.
+- The requested count of ticks has elapsed for a task which was blocked by a
+ call to the ``rtems_task_wake_after`` directive.
- A timeout period expires for a task which blocked by a call to the
``rtems_task_wake_when`` directive.
diff --git a/c-user/scheduling-concepts/directives.rst b/c-user/scheduling-concepts/directives.rst
index aa0300e..115b4fa 100644
--- a/c-user/scheduling-concepts/directives.rst
+++ b/c-user/scheduling-concepts/directives.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2013, 2021 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2013, 2021 embedded brains GmbH & Co. KG
.. Copyright (C) 1988, 2017 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -54,8 +54,8 @@ Identifies a scheduler by the object name.
This parameter is the scheduler name to look up.
``id``
- This parameter is the pointer to an :c:type:`rtems_id` object. When the
- directive call is successful, the identifier of the scheduler will be
+ This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
+ the directive call is successful, the identifier of the scheduler will be
stored in this object.
.. rubric:: DESCRIPTION:
@@ -120,8 +120,8 @@ Identifies a scheduler by the processor index.
This parameter is the processor index to identify the scheduler.
``id``
- This parameter is the pointer to an :c:type:`rtems_id` object. When the
- directive call is successful, the identifier of the scheduler will be
+ This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
+ the directive call is successful, the identifier of the scheduler will be
stored in this object.
.. rubric:: RETURN VALUES:
@@ -184,8 +184,8 @@ Identifies a scheduler by the processor set.
processor set will be used to identify the scheduler.
``id``
- This parameter is the pointer to an :c:type:`rtems_id` object. When the
- directive call is successful, the identifier of the scheduler will be
+ This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
+ the directive call is successful, the identifier of the scheduler will be
stored in this object.
.. rubric:: DESCRIPTION:
@@ -254,9 +254,9 @@ Gets the maximum task priority of the scheduler.
This parameter is the scheduler identifier.
``priority``
- This parameter is the pointer to an :c:type:`rtems_task_priority` object.
- When the directive the maximum priority of the scheduler will be stored in
- this object.
+ This parameter is the pointer to an :ref:`InterfaceRtemsTaskPriority`
+ object. When the directive the maximum priority of the scheduler will be
+ stored in this object.
.. rubric:: RETURN VALUES:
@@ -375,10 +375,10 @@ Maps a POSIX thread priority to the corresponding Classic API task priority.
This parameter is the POSIX thread priority to map.
``priority``
- This parameter is the pointer to an :c:type:`rtems_task_priority` object.
- When the directive call is successful, the Classic API task priority value
- corresponding to the specified POSIX thread priority value will be stored
- in this object.
+ This parameter is the pointer to an :ref:`InterfaceRtemsTaskPriority`
+ object. When the directive call is successful, the Classic API task
+ priority value corresponding to the specified POSIX thread priority value
+ will be stored in this object.
.. rubric:: RETURN VALUES:
@@ -683,9 +683,12 @@ scheduler specified by ``scheduler_id``.
The processor was not owned by the scheduler.
:c:macro:`RTEMS_RESOURCE_IN_USE`
- The set of processors owned by the scheduler would have been empty after
- the processor removal and there was at least one non-idle task that used
- this scheduler as its :term:`home scheduler`.
+ The processor was required by at least one non-idle task that used the
+ scheduler as its :term:`home scheduler`.
+
+:c:macro:`RTEMS_RESOURCE_IN_USE`
+ The processor was the last processor owned by the scheduler and there was
+ at least one task that used the scheduler as a :term:`helping scheduler`.
.. rubric:: NOTES:
diff --git a/c-user/scheduling-concepts/index.rst b/c-user/scheduling-concepts/index.rst
index 6b16f1b..ee9aa26 100644
--- a/c-user/scheduling-concepts/index.rst
+++ b/c-user/scheduling-concepts/index.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020 embedded brains GmbH & Co. KG
.. index:: scheduling
.. index:: task scheduling
diff --git a/c-user/scheduling-concepts/introduction.rst b/c-user/scheduling-concepts/introduction.rst
index 31de1c1..527d103 100644
--- a/c-user/scheduling-concepts/introduction.rst
+++ b/c-user/scheduling-concepts/introduction.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2013, 2021 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2013, 2021 embedded brains GmbH & Co. KG
.. Copyright (C) 1988, 2017 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically