summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/rtems/ratemon.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/include/rtems/rtems/ratemon.h')
-rw-r--r--cpukit/include/rtems/rtems/ratemon.h14
1 files changed, 8 insertions, 6 deletions
diff --git a/cpukit/include/rtems/rtems/ratemon.h b/cpukit/include/rtems/rtems/ratemon.h
index 8823d72c55..4b9255e635 100644
--- a/cpukit/include/rtems/rtems/ratemon.h
+++ b/cpukit/include/rtems/rtems/ratemon.h
@@ -9,7 +9,7 @@
*/
/*
- * 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)
*
@@ -245,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
@@ -269,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
@@ -445,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:
@@ -502,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: