diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2018-12-07 14:56:49 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2018-12-10 09:19:55 +0100 |
commit | 16f33fd0e269ef55c0d2a4900dd863f7ae613203 (patch) | |
tree | f81833549447bd62e000e2469d25842ef84aaa9e /c-user | |
parent | posix-compliance: Change utimes() from sys/times.h to sys/time.h (diff) | |
download | rtems-docs-16f33fd0e269ef55c0d2a4900dd863f7ae613203.tar.bz2 |
c-user: rtems_scheduler_get_maximum_priority()
Close #3636.
Diffstat (limited to 'c-user')
-rw-r--r-- | c-user/scheduling_concepts.rst | 37 |
1 files changed, 37 insertions, 0 deletions
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 |