diff options
Diffstat (limited to 'c-user/rate-monotonic/directives.rst')
| -rw-r--r-- | c-user/rate-monotonic/directives.rst | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/c-user/rate-monotonic/directives.rst b/c-user/rate-monotonic/directives.rst index 2e48aac..f0467d1 100644 --- a/c-user/rate-monotonic/directives.rst +++ b/c-user/rate-monotonic/directives.rst @@ -1,6 +1,6 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de) +.. Copyright (C) 2020, 2021 embedded brains GmbH & Co. KG .. Copyright (C) 2017 Kuan-Hsun Chen .. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) @@ -56,9 +56,9 @@ Creates a period. This parameter is the object name of the period. ``id`` - This parameter is the pointer to an :c:type:`rtems_id` object. When the - directive call is successful, the identifier of the created period will be - stored in this object. + This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When + the directive call is successful, the identifier of the created period will + be stored in this object. .. rubric:: DESCRIPTION: @@ -133,9 +133,9 @@ Identifies a period by the object name. This parameter is the object name to look up. ``id`` - This parameter is the pointer to an :c:type:`rtems_id` object. When the - directive call is successful, the object identifier of an object with the - specified name will be stored in this object. + This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When + the directive call is successful, the object identifier of an object with + the specified name will be stored in this object. .. rubric:: DESCRIPTION: @@ -366,6 +366,11 @@ length of the period. :c:macro:`RTEMS_TIMEOUT` The rate monotonic period has expired. +.. rubric:: NOTES: + +Resetting the processor usage time of tasks has no impact on the period status +and statistics. + .. rubric:: CONSTRAINTS: The following constraints apply to this directive: @@ -408,7 +413,7 @@ Gets the detailed status of the period. ``status`` This parameter is the pointer to an - :c:type:`rtems_rate_monotonic_period_status` object. When the directive + :ref:`InterfaceRtemsRateMonotonicPeriodStatus` object. When the directive call is successful, the detailed period status will be stored in this object. @@ -448,10 +453,6 @@ members of the period status object referenced by ``status``: The ``status`` parameter was `NULL <https://en.cppreference.com/w/c/types/NULL>`_. -:c:macro:`RTEMS_NOT_DEFINED` - There was no status available due to a reset of the processor time usage of - the owner task of the period. - .. rubric:: CONSTRAINTS: The following constraints apply to this directive: @@ -495,7 +496,7 @@ Gets the statistics of the period. ``status`` This parameter is the pointer to an - :c:type:`rtems_rate_monotonic_period_statistics` object. When the + :ref:`InterfaceRtemsRateMonotonicPeriodStatistics` object. When the directive call is successful, the period statistics will be stored in this object. |