diff options
Diffstat (limited to '')
-rw-r--r-- | cpukit/rtems/inline/rtems/rtems/ratemon.inl | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/cpukit/rtems/inline/rtems/rtems/ratemon.inl b/cpukit/rtems/inline/rtems/rtems/ratemon.inl index b748f919b3..0450988329 100644 --- a/cpukit/rtems/inline/rtems/rtems/ratemon.inl +++ b/cpukit/rtems/inline/rtems/rtems/ratemon.inl @@ -21,6 +21,10 @@ * * _Rate_monotonic_Allocate * + * DESCRIPTION: + * + * This function allocates a period control block from + * the inactive chain of free period control blocks. */ STATIC INLINE Rate_monotonic_Control *_Rate_monotonic_Allocate( void ) @@ -33,6 +37,10 @@ STATIC INLINE Rate_monotonic_Control *_Rate_monotonic_Allocate( void ) * * _Rate_monotonic_Free * + * DESCRIPTION: + * + * This routine allocates a period control block from + * the inactive chain of free period control blocks. */ STATIC INLINE void _Rate_monotonic_Free ( @@ -46,6 +54,13 @@ STATIC INLINE void _Rate_monotonic_Free ( * * _Rate_monotonic_Get * + * DESCRIPTION: + * + * This function maps period IDs to period control blocks. + * If ID corresponds to a local period, then it returns + * the_period control pointer which maps to ID and location + * is set to OBJECTS_LOCAL. Otherwise, location is set + * to OBJECTS_ERROR and the_period is undefined. */ STATIC INLINE Rate_monotonic_Control *_Rate_monotonic_Get ( @@ -61,6 +76,10 @@ STATIC INLINE Rate_monotonic_Control *_Rate_monotonic_Get ( * * _Rate_monotonic_Is_active * + * DESCRIPTION: + * + * This function returns TRUE if the_period is in the ACTIVE state, + * and FALSE otherwise. */ STATIC INLINE boolean _Rate_monotonic_Is_active ( @@ -74,6 +93,10 @@ STATIC INLINE boolean _Rate_monotonic_Is_active ( * * _Rate_monotonic_Is_inactive * + * DESCRIPTION: + * + * This function returns TRUE if the_period is in the ACTIVE state, + * and FALSE otherwise. */ STATIC INLINE boolean _Rate_monotonic_Is_inactive ( @@ -87,6 +110,10 @@ STATIC INLINE boolean _Rate_monotonic_Is_inactive ( * * _Rate_monotonic_Is_expired * + * DESCRIPTION: + * + * This function returns TRUE if the_period is in the EXPIRED state, + * and FALSE otherwise. */ STATIC INLINE boolean _Rate_monotonic_Is_expired ( @@ -100,6 +127,9 @@ STATIC INLINE boolean _Rate_monotonic_Is_expired ( * * _Rate_monotonic_Is_null * + * DESCRIPTION: + * + * This function returns TRUE if the_period is NULL and FALSE otherwise. */ STATIC INLINE boolean _Rate_monotonic_Is_null ( |