c-user: Add & update ratemon get return values

Add a description of the previously missing RTEMS_NOT_DEFINED return
value for rtems_rate_monotonic_get_status().

Update the RTEMS_SUCCESSFUL return value descriptions for
rtems_rate_monotonic_get_status() and
rtems_rate_monotonic_get_statistics() which incorrectly used the same
description as rtems_rate_monotonic_period().
This commit is contained in:
Martin Erik Werner 2020-02-29 00:52:43 +01:00 committed by Sebastian Huber
parent c6c06aecbb
commit 2424590528

View File

@ -871,11 +871,14 @@ DIRECTIVE STATUS CODES:
:class: rtems-table
* - ``RTEMS_SUCCESSFUL``
- period initiated successfully
- period status retrieved successfully
* - ``RTEMS_INVALID_ID``
- invalid rate monotonic period id
* - ``RTEMS_INVALID_ADDRESS``
- invalid address of status
* - ``RTEMS_NOT_DEFINED``
- no status is available due to the cpu usage of the task having been
reset since the period initiated
*DESCRIPTION:
This directive returns status information associated with the rate
@ -938,7 +941,7 @@ DIRECTIVE STATUS CODES:
:class: rtems-table
* - ``RTEMS_SUCCESSFUL``
- period initiated successfully
- period statistics retrieved successfully
* - ``RTEMS_INVALID_ID``
- invalid rate monotonic period id
* - ``RTEMS_INVALID_ADDRESS``