summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-02-25 07:52:19 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-02 08:15:59 +0100
commitac61465d2c0a8b7d68ff5577f25c9f173b6c8d49 (patch)
tree60f78b45518c7e60757bcda8ab4c023f10b12116
parentc-user: rtems_scheduler_map_priority_to_posix() (diff)
downloadrtems-docs-ac61465d2c0a8b7d68ff5577f25c9f173b6c8d49.tar.bz2
c-user: rtems_scheduler_map_priority_from_posix()
Close #3881.
-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 211cd25..dac39a8 100644
--- a/c-user/scheduling_concepts.rst
+++ b/c-user/scheduling_concepts.rst
@@ -40,6 +40,9 @@ The directives provided by the scheduler manager are:
- rtems_scheduler_map_priority_to_posix_ - Map task priority to POSIX thread
prority
+- rtems_scheduler_map_priority_from_posix_ - Map POSIX thread priority to task
+ prority
+
- rtems_scheduler_get_processor_ - Get current processor index
- rtems_scheduler_get_processor_maximum_ - Get processor maximum
@@ -741,6 +744,43 @@ NOTES:
\clearpage
+.. _rtems_scheduler_map_priority_from_posix:
+
+SCHEDULER_MAP_PRIORITY_FROM_POSIX - Map POSIX thread prority to task priority
+-----------------------------------------------------------------------------
+
+CALLING SEQUENCE:
+ .. code-block:: c
+
+ rtems_status_code rtems_scheduler_map_priority_from_posix(
+ rtems_id scheduler_id,
+ int posix_priority,
+ rtems_task_priority *priority
+ );
+
+DIRECTIVE STATUS CODES:
+ .. list-table::
+ :class: rtems-table
+
+ * - ``RTEMS_SUCCESSFUL``
+ - Successful operation.
+ * - ``RTEMS_INVALID_ADDRESS``
+ - The ``priority`` parameter is ``NULL``.
+ * - ``RTEMS_INVALID_ID``
+ - Invalid scheduler instance identifier.
+ * - ``RTEMS_INVALID_PRIORITY``
+ - Invalid POSIX thread priority.
+
+DESCRIPTION:
+ Maps a POSIX thread priority to the corresponding task priority.
+
+NOTES:
+ None.
+
+.. raw:: latex
+
+ \clearpage
+
.. _rtems_scheduler_get_processor:
SCHEDULER_GET_PROCESSOR - Get current processor index