diff options
| author | Kinsey Moore <kinsey.moore@oarcorp.com> | 2023-06-28 13:17:56 -0500 |
|---|---|---|
| committer | Joel Sherrill <joel@rtems.org> | 2023-07-06 13:55:37 -0500 |
| commit | 981ba2de41ade670813d401cba9abff086a5a6e0 (patch) | |
| tree | 276653c27f4bc218fa10552e6c8b03b2f5d511bb /c-user/scheduling-concepts/background.rst | |
| parent | eng: Add guidelines for validation tests (diff) | |
| download | rtems-docs-981ba2de41ade670813d401cba9abff086a5a6e0.tar.bz2 | |
c-user: Update references to rtems_task_wake_after
rtems_task_wake_after takes a parameter in terms of a count of clock
ticks and not a measure in a subunit of seconds. This updates
documentation to reflect that. This also makes obvious the caveat about
the first tick wait not being a whole tick and points the user at a
replacement for better accuracy.
Updates #4772
Diffstat (limited to 'c-user/scheduling-concepts/background.rst')
| -rw-r--r-- | c-user/scheduling-concepts/background.rst | 8 |
1 files changed, 4 insertions, 4 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. |