summaryrefslogtreecommitdiffstats
path: root/c-user/scheduling_concepts.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-02-25 07:51:38 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-02 08:15:59 +0100
commite458fedc3800bd64712ed2bf7461f196104ca744 (patch)
tree825c1436f0afd555434c8f68217fbda86e1a8cf0 /c-user/scheduling_concepts.rst
parenteng: Add glossary (diff)
downloadrtems-docs-e458fedc3800bd64712ed2bf7461f196104ca744.tar.bz2
c-user: rtems_scheduler_map_priority_to_posix()
Update #3881.
Diffstat (limited to 'c-user/scheduling_concepts.rst')
-rw-r--r--c-user/scheduling_concepts.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/c-user/scheduling_concepts.rst b/c-user/scheduling_concepts.rst
index 22d39e1..211cd25 100644
--- a/c-user/scheduling_concepts.rst
+++ b/c-user/scheduling_concepts.rst
@@ -37,6 +37,9 @@ The directives provided by the scheduler manager are:
- rtems_scheduler_get_maximum_priority_ - Get maximum task priority of a scheduler
+- rtems_scheduler_map_priority_to_posix_ - Map task priority to POSIX thread
+ prority
+
- rtems_scheduler_get_processor_ - Get current processor index
- rtems_scheduler_get_processor_maximum_ - Get processor maximum
@@ -701,6 +704,43 @@ NOTES:
\clearpage
+.. _rtems_scheduler_map_priority_to_posix:
+
+SCHEDULER_MAP_PRIORITY_TO_POSIX - Map task priority to POSIX thread prority
+---------------------------------------------------------------------------
+
+CALLING SEQUENCE:
+ .. code-block:: c
+
+ rtems_status_code rtems_scheduler_map_priority_to_posix(
+ rtems_id scheduler_id,
+ rtems_task_priority priority,
+ int *posix_priority
+ );
+
+DIRECTIVE STATUS CODES:
+ .. list-table::
+ :class: rtems-table
+
+ * - ``RTEMS_SUCCESSFUL``
+ - Successful operation.
+ * - ``RTEMS_INVALID_ADDRESS``
+ - The ``posix_priority`` parameter is ``NULL``.
+ * - ``RTEMS_INVALID_ID``
+ - Invalid scheduler instance identifier.
+ * - ``RTEMS_INVALID_PRIORITY``
+ - Invalid task priority.
+
+DESCRIPTION:
+ Maps a task priority to the corresponding POSIX thread priority.
+
+NOTES:
+ None.
+
+.. raw:: latex
+
+ \clearpage
+
.. _rtems_scheduler_get_processor:
SCHEDULER_GET_PROCESSOR - Get current processor index