summaryrefslogtreecommitdiffstats
path: root/c/src/exec/rtems/inline/rtems/rtems/ratemon.inl
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1996-03-06 21:34:57 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1996-03-06 21:34:57 +0000
commit1a8fde6ca27afea19faf9bf6487d8aa20b4a8d41 (patch)
tree209ab42fa9bc98774d5290d670af14886390d269 /c/src/exec/rtems/inline/rtems/rtems/ratemon.inl
parentRemoved prototyes for static inline rgutines and moved the comments into (diff)
downloadrtems-1a8fde6ca27afea19faf9bf6487d8aa20b4a8d41.tar.bz2
Removed prototyes for static inline routines and moved the comments into
the inline implementation. The impetus for this was twofold. First, it is incorrect to have static inline prototypes when using the macro implementation. Second, this reduced the number of lines in the include files seen by rtems.h by about 2000 lines. Next we restricted visibility for the inline routines to inside the executive itself EXCEPT for a handful of objects. This reduced the number of include files included by rtems.h by 40 files and reduced the lines in the include files seen by rtems.h by about 6000 lines. In total, these reduced the compile time of the entire RTEMS tree by 20%. This results in about 8 minutes savings on the SparcStation 10 morgana.
Diffstat (limited to 'c/src/exec/rtems/inline/rtems/rtems/ratemon.inl')
-rw-r--r--c/src/exec/rtems/inline/rtems/rtems/ratemon.inl30
1 files changed, 30 insertions, 0 deletions
diff --git a/c/src/exec/rtems/inline/rtems/rtems/ratemon.inl b/c/src/exec/rtems/inline/rtems/rtems/ratemon.inl
index b748f919b3..0450988329 100644
--- a/c/src/exec/rtems/inline/rtems/rtems/ratemon.inl
+++ b/c/src/exec/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 (