diff options
Diffstat (limited to 'c-user/scheduling-concepts/directives.rst')
| -rw-r--r-- | c-user/scheduling-concepts/directives.rst | 37 |
1 files changed, 20 insertions, 17 deletions
diff --git a/c-user/scheduling-concepts/directives.rst b/c-user/scheduling-concepts/directives.rst index aa0300e..115b4fa 100644 --- a/c-user/scheduling-concepts/directives.rst +++ b/c-user/scheduling-concepts/directives.rst @@ -1,6 +1,6 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. Copyright (C) 2013, 2021 embedded brains GmbH (http://www.embedded-brains.de) +.. Copyright (C) 2013, 2021 embedded brains GmbH & Co. KG .. Copyright (C) 1988, 2017 On-Line Applications Research Corporation (OAR) .. This file is part of the RTEMS quality process and was automatically @@ -54,8 +54,8 @@ Identifies a scheduler by the object name. This parameter is the scheduler name to look up. ``id`` - This parameter is the pointer to an :c:type:`rtems_id` object. When the - directive call is successful, the identifier of the scheduler will be + This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When + the directive call is successful, the identifier of the scheduler will be stored in this object. .. rubric:: DESCRIPTION: @@ -120,8 +120,8 @@ Identifies a scheduler by the processor index. This parameter is the processor index to identify the scheduler. ``id`` - This parameter is the pointer to an :c:type:`rtems_id` object. When the - directive call is successful, the identifier of the scheduler will be + This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When + the directive call is successful, the identifier of the scheduler will be stored in this object. .. rubric:: RETURN VALUES: @@ -184,8 +184,8 @@ Identifies a scheduler by the processor set. processor set will be used to identify the scheduler. ``id`` - This parameter is the pointer to an :c:type:`rtems_id` object. When the - directive call is successful, the identifier of the scheduler will be + This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When + the directive call is successful, the identifier of the scheduler will be stored in this object. .. rubric:: DESCRIPTION: @@ -254,9 +254,9 @@ Gets the maximum task priority of the scheduler. This parameter is the scheduler identifier. ``priority`` - This parameter is the pointer to an :c:type:`rtems_task_priority` object. - When the directive the maximum priority of the scheduler will be stored in - this object. + This parameter is the pointer to an :ref:`InterfaceRtemsTaskPriority` + object. When the directive the maximum priority of the scheduler will be + stored in this object. .. rubric:: RETURN VALUES: @@ -375,10 +375,10 @@ Maps a POSIX thread priority to the corresponding Classic API task priority. This parameter is the POSIX thread priority to map. ``priority`` - This parameter is the pointer to an :c:type:`rtems_task_priority` object. - When the directive call is successful, the Classic API task priority value - corresponding to the specified POSIX thread priority value will be stored - in this object. + This parameter is the pointer to an :ref:`InterfaceRtemsTaskPriority` + object. When the directive call is successful, the Classic API task + priority value corresponding to the specified POSIX thread priority value + will be stored in this object. .. rubric:: RETURN VALUES: @@ -683,9 +683,12 @@ scheduler specified by ``scheduler_id``. The processor was not owned by the scheduler. :c:macro:`RTEMS_RESOURCE_IN_USE` - The set of processors owned by the scheduler would have been empty after - the processor removal and there was at least one non-idle task that used - this scheduler as its :term:`home scheduler`. + The processor was required by at least one non-idle task that used the + scheduler as its :term:`home scheduler`. + +:c:macro:`RTEMS_RESOURCE_IN_USE` + The processor was the last processor owned by the scheduler and there was + at least one task that used the scheduler as a :term:`helping scheduler`. .. rubric:: NOTES: |