summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/rtems/ratemon.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-10-25 08:15:37 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-10-25 08:16:09 +0200
commit24922d0f54eb6cff02428dc9176fc7b67e6ac9bc (patch)
treebc9849aaef9b2a70768f72c8173b6994dc734840 /cpukit/include/rtems/rtems/ratemon.h
parentrtems: Regenerate for IDLE task allocator option (diff)
downloadrtems-24922d0f54eb6cff02428dc9176fc7b67e6ac9bc.tar.bz2
rtems: rtems_rate_monotonic_get_status()
Mention that resetting the processor usage time of tasks has no impact on the period status and statistics. Remove no longer relevant RTEMS_NOT_DEFINED error status. Update #4528.
Diffstat (limited to '')
-rw-r--r--cpukit/include/rtems/rtems/ratemon.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/cpukit/include/rtems/rtems/ratemon.h b/cpukit/include/rtems/rtems/ratemon.h
index 8823d72c55..7c789a204b 100644
--- a/cpukit/include/rtems/rtems/ratemon.h
+++ b/cpukit/include/rtems/rtems/ratemon.h
@@ -445,6 +445,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 +506,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: