From 16f33fd0e269ef55c0d2a4900dd863f7ae613203 Mon Sep 17 00:00:00 2001
From: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date: Fri, 7 Dec 2018 14:56:49 +0100
Subject: c-user: rtems_scheduler_get_maximum_priority()

Close #3636.
---
 c-user/scheduling_concepts.rst | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

(limited to 'c-user')

diff --git a/c-user/scheduling_concepts.rst b/c-user/scheduling_concepts.rst
index e088c62..5a2ce05 100644
--- a/c-user/scheduling_concepts.rst
+++ b/c-user/scheduling_concepts.rst
@@ -35,6 +35,8 @@ The directives provided by the scheduler manager are:
 
 - rtems_scheduler_ident_by_processor_set_ - Get ID of a scheduler by processor set
 
+- rtems_scheduler_get_maximum_priority_ - Get maximum task priority of a scheduler
+
 - rtems_scheduler_get_processor_set_ - Get processor set of a scheduler
 
 - rtems_scheduler_add_processor_ - Add processor to a scheduler
@@ -660,6 +662,41 @@ NOTES:
 
    \clearpage
 
+.. _rtems_scheduler_get_maximum_priority:
+
+SCHEDULER_GET_MAXIMUM_PRIORITY - Get maximum task priority of a scheduler
+-------------------------------------------------------------------------
+
+CALLING SEQUENCE:
+    .. code-block:: c
+
+        rtems_status_code rtems_scheduler_get_maximum_priority(
+            rtems_id             scheduler_id,
+            rtems_task_priority *priority
+        );
+
+DIRECTIVE STATUS CODES:
+    .. list-table::
+     :class: rtems-table
+
+     * - ``RTEMS_SUCCESSFUL``
+       - Successful operation.
+     * - ``RTEMS_INVALID_ID``
+       - Invalid scheduler instance identifier.
+     * - ``RTEMS_INVALID_ADDRESS``
+       - The ``priority`` parameter is ``NULL``.
+
+DESCRIPTION:
+    Returns the maximum task priority of the specified scheduler instance in
+    ``priority``.
+
+NOTES:
+    None.
+
+.. raw:: latex
+
+   \clearpage
+
 .. _rtems_scheduler_get_processor_set:
 
 SCHEDULER_GET_PROCESSOR_SET - Get processor set of a scheduler
-- 
cgit v1.2.3