diff options
Diffstat (limited to 'cpukit/include/rtems/rtems/ratemon.h')
| -rw-r--r-- | cpukit/include/rtems/rtems/ratemon.h | 40 |
1 files changed, 22 insertions, 18 deletions
diff --git a/cpukit/include/rtems/rtems/ratemon.h b/cpukit/include/rtems/rtems/ratemon.h index eee4a37319..4b9255e635 100644 --- a/cpukit/include/rtems/rtems/ratemon.h +++ b/cpukit/include/rtems/rtems/ratemon.h @@ -3,11 +3,13 @@ /** * @file * + * @ingroup RTEMSImplClassicRateMonotonic + * * @brief This header file defines the Rate-Monotonic Manager API. */ /* - * 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) * @@ -228,9 +230,9 @@ struct rtems_printer; * * @param name is the object name of the period. * - * @param[out] id is the pointer to an object identifier variable. When the - * directive call is successful, the identifier of the created period will be - * stored in this variable. + * @param[out] id is the pointer to an ::rtems_id object. When the directive + * call is successful, the identifier of the created period will be stored in + * this object. * * This directive creates a period which resides on the local node. The period * has the user-defined object name specified in ``name`` The assigned object @@ -243,7 +245,8 @@ struct rtems_printer; * * @retval ::RTEMS_TOO_MANY There was no inactive object available to create a * period. The number of periods available to the application is configured - * through the #CONFIGURE_MAXIMUM_PERIODS application configuration option. + * through the @ref CONFIGURE_MAXIMUM_PERIODS application configuration + * option. * * @par Notes * @parblock @@ -267,7 +270,7 @@ struct rtems_printer; * cause the calling task to be preempted. * * * The number of periods available to the application is configured through - * the #CONFIGURE_MAXIMUM_PERIODS application configuration option. + * the @ref CONFIGURE_MAXIMUM_PERIODS application configuration option. * * * Where the object class corresponding to the directive is configured to use * unlimited objects, the directive may allocate memory from the RTEMS @@ -285,9 +288,9 @@ rtems_status_code rtems_rate_monotonic_create( rtems_name name, rtems_id *id ); * * @param name is the object name to look up. * - * @param[out] id is the pointer to an object identifier variable. When the - * directive call is successful, the object identifier of an object with the - * specified name will be stored in this variable. + * @param[out] id is the pointer to an ::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 directive obtains a period identifier associated with the period name * specified in ``name``. @@ -443,6 +446,10 @@ rtems_status_code rtems_rate_monotonic_delete( rtems_id id ); * * @retval ::RTEMS_TIMEOUT The rate monotonic period has expired. * + * @par Notes + * Resetting the processor usage time of tasks has no impact on the period + * status and statistics. + * * @par Constraints * @parblock * The following constraints apply to this directive: @@ -467,9 +474,9 @@ rtems_status_code rtems_rate_monotonic_period( * * @param id is the rate monotonic period identifier. * - * @param[out] status is the pointer to a rtems_rate_monotonic_period_status - * variable. When the directive call is successful, the detailed period - * status will be stored in this variable. + * @param[out] status is the pointer to an rtems_rate_monotonic_period_status + * object. When the directive call is successful, the detailed period status + * will be stored in this object. * * This directive returns the detailed status of the rate monotonic period * specified by ``id``. The detailed status of the period will be returned in @@ -500,9 +507,6 @@ rtems_status_code rtems_rate_monotonic_period( * * @retval ::RTEMS_INVALID_ADDRESS The ``status`` parameter was NULL. * - * @retval ::RTEMS_NOT_DEFINED There was no status available due to a reset of - * the processor time usage of the owner task of the period. - * * @par Constraints * @parblock * The following constraints apply to this directive: @@ -528,9 +532,9 @@ rtems_status_code rtems_rate_monotonic_get_status( * * @param id is the rate monotonic period identifier. * - * @param[out] status is the pointer to a - * rtems_rate_monotonic_period_statistics variable. When the directive call - * is successful, the period statistics will be stored in this variable. + * @param[out] status is the pointer to an + * rtems_rate_monotonic_period_statistics object. When the directive call is + * successful, the period statistics will be stored in this object. * * This directive returns the statistics of the rate monotonic period specified * by ``id``. The statistics of the period will be returned in the members of |