diff options
Diffstat (limited to '')
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/ratemon.h | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h index 56c5f7d6a3..038c26e31e 100644 --- a/cpukit/rtems/include/rtems/rtems/ratemon.h +++ b/cpukit/rtems/include/rtems/rtems/ratemon.h @@ -158,7 +158,13 @@ typedef struct { Thread_Control *owner; rtems_rate_monotonic_period_statistics Statistics; } Rate_monotonic_Control; - + +/** + * @brief Rate Monotonic Period Class Management Structure + * + * This instance of Objects_Information is used to manage the + * set of rate monotonic period instances. + */ RTEMS_RATEMON_EXTERN Objects_Information _Rate_monotonic_Information; /** @@ -320,6 +326,11 @@ void _Rate_monotonic_Timeout( #define _Rate_monotonic_Reset_wall_time_statistics( _the_period ) #endif +/** + * @brief Rate_monotonic_Reset_cpu_use_statistics + * + * This helper method resets the period CPU usage statistics structure. + */ #ifdef RTEMS_ENABLE_NANOSECOND_CPU_USAGE_STATISTICS #define _Rate_monotonic_Reset_cpu_use_statistics( _the_period ) \ do { \ @@ -331,6 +342,11 @@ void _Rate_monotonic_Timeout( #define _Rate_monotonic_Reset_cpu_use_statistics( _the_period ) #endif +/** + * @brief Rate_monotonic_Reset_statistics + * + * This helper method resets the period wall time statistics structure. + */ #define _Rate_monotonic_Reset_statistics( _the_period ) \ do { \ memset( \ |