[rtems-docs commit] c-user: rtems_scheduler_map_priority_to_posix()

[Sebastian Huber]

Module:    rtems-docs
Branch:    master
Commit:    e458fedc3800bd64712ed2bf7461f196104ca744
Changeset: http://git.rtems.org/rtems-docs/commit/?id=e458fedc3800bd64712ed2bf7461f196104ca744

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Tue Feb 25 07:51:38 2020 +0100

c-user: rtems_scheduler_map_priority_to_posix()

Update #3881.

---

 c-user/scheduling_concepts.rst | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

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