summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/inline
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 /cpukit/rtems/inline
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 'cpukit/rtems/inline')
-rw-r--r--cpukit/rtems/inline/rtems/rtems/asr.inl22
-rw-r--r--cpukit/rtems/inline/rtems/rtems/attr.inl34
-rw-r--r--cpukit/rtems/inline/rtems/rtems/dpmem.inl20
-rw-r--r--cpukit/rtems/inline/rtems/rtems/event.inl4
-rw-r--r--cpukit/rtems/inline/rtems/rtems/eventset.inl20
-rw-r--r--cpukit/rtems/inline/rtems/rtems/message.inl18
-rw-r--r--cpukit/rtems/inline/rtems/rtems/modes.inl41
-rw-r--r--cpukit/rtems/inline/rtems/rtems/options.inl8
-rw-r--r--cpukit/rtems/inline/rtems/rtems/part.inl42
-rw-r--r--cpukit/rtems/inline/rtems/rtems/ratemon.inl30
-rw-r--r--cpukit/rtems/inline/rtems/rtems/region.inl26
-rw-r--r--cpukit/rtems/inline/rtems/rtems/sem.inl20
-rw-r--r--cpukit/rtems/inline/rtems/rtems/status.inl8
-rw-r--r--cpukit/rtems/inline/rtems/rtems/support.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/tasks.inl16
-rw-r--r--cpukit/rtems/inline/rtems/rtems/timer.inl30
16 files changed, 334 insertions, 12 deletions
diff --git a/cpukit/rtems/inline/rtems/rtems/asr.inl b/cpukit/rtems/inline/rtems/rtems/asr.inl
index 611ac930db..fc52778875 100644
--- a/cpukit/rtems/inline/rtems/rtems/asr.inl
+++ b/cpukit/rtems/inline/rtems/rtems/asr.inl
@@ -23,6 +23,9 @@
*
* _ASR_Initialize
*
+ * DESCRIPTION:
+ *
+ * This routine initializes the given RTEMS_ASR information record.
*/
STATIC INLINE void _ASR_Initialize (
@@ -41,6 +44,11 @@ STATIC INLINE void _ASR_Initialize (
*
* _ASR_Swap_signals
*
+ * DESCRIPTION:
+ *
+ * This routine atomically swaps the pending and posted signal
+ * sets. This is done when the thread alters its mode in such a
+ * way that the RTEMS_ASR disable/enable flag changes.
*/
STATIC INLINE void _ASR_Swap_signals (
@@ -61,6 +69,10 @@ STATIC INLINE void _ASR_Swap_signals (
*
* _ASR_Is_null_handler
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the given asr_handler is NULL and
+ * FALSE otherwise.
*/
STATIC INLINE boolean _ASR_Is_null_handler (
@@ -74,6 +86,10 @@ STATIC INLINE boolean _ASR_Is_null_handler (
*
* _ASR_Are_signals_pending
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if there are signals pending in the
+ * given RTEMS_ASR information record and FALSE otherwise.
*/
STATIC INLINE boolean _ASR_Are_signals_pending (
@@ -87,6 +103,12 @@ STATIC INLINE boolean _ASR_Are_signals_pending (
*
* _ASR_Post_signals
*
+ * DESCRIPTION:
+ *
+ * This routine posts the given signals into the signal_set
+ * passed in. The result is returned to the user in signal_set.
+ *
+ * NOTE: This must be implemented as a macro.
*/
STATIC INLINE void _ASR_Post_signals(
diff --git a/cpukit/rtems/inline/rtems/rtems/attr.inl b/cpukit/rtems/inline/rtems/rtems/attr.inl
index 0f1190fe93..53c613382f 100644
--- a/cpukit/rtems/inline/rtems/rtems/attr.inl
+++ b/cpukit/rtems/inline/rtems/rtems/attr.inl
@@ -20,6 +20,11 @@
/*PAGE
*
* _Attributes_Set
+ *
+ * DESCRIPTION:
+ *
+ * This function sets the requested new_attributes in the attribute_set
+ * passed in. The result is returned to the user.
*/
STATIC INLINE rtems_attribute _Attributes_Set (
@@ -33,6 +38,11 @@ STATIC INLINE rtems_attribute _Attributes_Set (
/*PAGE
*
* _Attributes_Clear
+ *
+ * DESCRIPTION:
+ *
+ * This function clears the requested new_attributes in the attribute_set
+ * passed in. The result is returned to the user.
*/
STATIC INLINE rtems_attribute _Attributes_Clear (
@@ -47,6 +57,10 @@ STATIC INLINE rtems_attribute _Attributes_Clear (
*
* _Attributes_Is_floating_point
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the floating point attribute is
+ * enabled in the attribute_set and FALSE otherwise.
*/
STATIC INLINE boolean _Attributes_Is_floating_point(
@@ -60,6 +74,10 @@ STATIC INLINE boolean _Attributes_Is_floating_point(
*
* _Attributes_Is_global
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the global object attribute is
+ * enabled in the attribute_set and FALSE otherwise.
*/
STATIC INLINE boolean _Attributes_Is_global(
@@ -73,6 +91,10 @@ STATIC INLINE boolean _Attributes_Is_global(
*
* _Attributes_Is_priority
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the priority attribute is
+ * enabled in the attribute_set and FALSE otherwise.
*/
STATIC INLINE boolean _Attributes_Is_priority(
@@ -86,6 +108,10 @@ STATIC INLINE boolean _Attributes_Is_priority(
*
* _Attributes_Is_binary_semaphore
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the binary semaphore attribute is
+ * enabled in the attribute_set and FALSE otherwise.
*/
STATIC INLINE boolean _Attributes_Is_binary_semaphore(
@@ -99,6 +125,10 @@ STATIC INLINE boolean _Attributes_Is_binary_semaphore(
*
* _Attributes_Is_inherit_priority
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the priority inheritance attribute
+ * is enabled in the attribute_set and FALSE otherwise.
*/
STATIC INLINE boolean _Attributes_Is_inherit_priority(
@@ -112,6 +142,10 @@ STATIC INLINE boolean _Attributes_Is_inherit_priority(
*
* _Attributes_Is_priority_ceiling
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the priority ceiling attribute
+ * is enabled in the attribute_set and FALSE otherwise.
*/
STATIC INLINE boolean _Attributes_Is_priority_ceiling(
diff --git a/cpukit/rtems/inline/rtems/rtems/dpmem.inl b/cpukit/rtems/inline/rtems/rtems/dpmem.inl
index 829ec5ab07..4bd13bcd80 100644
--- a/cpukit/rtems/inline/rtems/rtems/dpmem.inl
+++ b/cpukit/rtems/inline/rtems/rtems/dpmem.inl
@@ -22,6 +22,10 @@
*
* _Dual_ported_memory_Allocate
*
+ * DESCRIPTION:
+ *
+ * This routine allocates a port control block from the inactive chain
+ * of free port control blocks.
*/
STATIC INLINE Dual_ported_memory_Control
@@ -35,6 +39,10 @@ STATIC INLINE Dual_ported_memory_Control
*
* _Dual_ported_memory_Free
*
+ * DESCRIPTION:
+ *
+ * This routine frees a port control block to the inactive chain
+ * of free port control blocks.
*/
STATIC INLINE void _Dual_ported_memory_Free (
@@ -48,6 +56,14 @@ STATIC INLINE void _Dual_ported_memory_Free (
*
* _Dual_ported_memory_Get
*
+ * DESCRIPTION:
+ *
+ * This function maps port IDs to port control blocks. If ID
+ * corresponds to a local port, then it returns the_port control
+ * pointer which maps to ID and location is set to OBJECTS_LOCAL.
+ * Global ports are not supported, thus if ID does not map to a
+ * local port, location is set to OBJECTS_ERROR and the_port is
+ * undefined.
*/
STATIC INLINE Dual_ported_memory_Control *_Dual_ported_memory_Get (
@@ -62,6 +78,10 @@ STATIC INLINE Dual_ported_memory_Control *_Dual_ported_memory_Get (
/*PAGE
*
* _Dual_ported_memory_Is_null
+ *
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the_port is NULL and FALSE otherwise.
*/
STATIC INLINE boolean _Dual_ported_memory_Is_null(
diff --git a/cpukit/rtems/inline/rtems/rtems/event.inl b/cpukit/rtems/inline/rtems/rtems/event.inl
index 0e2a1691ed..27d66c9ab0 100644
--- a/cpukit/rtems/inline/rtems/rtems/event.inl
+++ b/cpukit/rtems/inline/rtems/rtems/event.inl
@@ -19,6 +19,10 @@
/*
* Event_Manager_initialization
+ *
+ * DESCRIPTION:
+ *
+ * This routine performs the initialization necessary for this manager.
*/
STATIC INLINE void _Event_Manager_initialization( void )
diff --git a/cpukit/rtems/inline/rtems/rtems/eventset.inl b/cpukit/rtems/inline/rtems/rtems/eventset.inl
index b38c61de1a..ec0789b207 100644
--- a/cpukit/rtems/inline/rtems/rtems/eventset.inl
+++ b/cpukit/rtems/inline/rtems/rtems/eventset.inl
@@ -19,6 +19,11 @@
/*PAGE
*
* _Event_sets_Is_empty
+ *
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if on events are posted in the event_set,
+ * and FALSE otherwise.
*/
STATIC INLINE boolean _Event_sets_Is_empty(
@@ -31,6 +36,11 @@ STATIC INLINE boolean _Event_sets_Is_empty(
/*PAGE
*
* _Event_sets_Post
+ *
+ * DESCRIPTION:
+ *
+ * This routine posts the given new_events into the event_set
+ * passed in. The result is returned to the user in event_set.
*/
STATIC INLINE void _Event_sets_Post(
@@ -44,6 +54,11 @@ STATIC INLINE void _Event_sets_Post(
/*PAGE
*
* _Event_sets_Get
+ *
+ * DESCRIPTION:
+ *
+ * This function returns the events in event_condition which are
+ * set in event_set.
*/
STATIC INLINE rtems_event_set _Event_sets_Get(
@@ -57,6 +72,11 @@ STATIC INLINE rtems_event_set _Event_sets_Get(
/*PAGE
*
* _Event_sets_Clear
+ *
+ * DESCRIPTION:
+ *
+ * This function removes the events in mask from the event_set
+ * passed in. The result is returned to the user in event_set.
*/
STATIC INLINE rtems_event_set _Event_sets_Clear(
diff --git a/cpukit/rtems/inline/rtems/rtems/message.inl b/cpukit/rtems/inline/rtems/rtems/message.inl
index 673dce92a5..c34ad5082a 100644
--- a/cpukit/rtems/inline/rtems/rtems/message.inl
+++ b/cpukit/rtems/inline/rtems/rtems/message.inl
@@ -23,6 +23,10 @@
*
* _Message_queue_Is_null
*
+ * DESCRIPTION:
+ *
+ * This function places the_message at the rear of the outstanding
+ * messages on the_message_queue.
*/
STATIC INLINE boolean _Message_queue_Is_null (
@@ -37,6 +41,10 @@ STATIC INLINE boolean _Message_queue_Is_null (
*
* _Message_queue_Free
*
+ * DESCRIPTION:
+ *
+ * This routine deallocates a message queue control block into
+ * the inactive chain of free message queue control blocks.
*/
STATIC INLINE void _Message_queue_Free (
@@ -50,6 +58,16 @@ STATIC INLINE void _Message_queue_Free (
*
* _Message_queue_Get
*
+ * DESCRIPTION:
+ *
+ * This function maps message queue IDs to message queue control
+ * blocks. If ID corresponds to a local message queue, then it
+ * returns the_message_queue control pointer which maps to ID
+ * and location is set to OBJECTS_LOCAL. If the message queue ID is
+ * global and resides on a remote node, then location is set
+ * to OBJECTS_REMOTE, and the_message_queue is undefined.
+ * Otherwise, location is set to OBJECTS_ERROR and
+ * the_message_queue is undefined.
*/
STATIC INLINE Message_queue_Control *_Message_queue_Get (
diff --git a/cpukit/rtems/inline/rtems/rtems/modes.inl b/cpukit/rtems/inline/rtems/rtems/modes.inl
index 6d4b6d06d0..803febd49a 100644
--- a/cpukit/rtems/inline/rtems/rtems/modes.inl
+++ b/cpukit/rtems/inline/rtems/rtems/modes.inl
@@ -19,20 +19,12 @@
/*PAGE
*
- * RTEMS_INTERRUPT_LEVEL
- */
-
-STATIC INLINE unsigned32 RTEMS_INTERRUPT_LEVEL (
- Modes_Control mode_set
-)
-{
- return mode_set & RTEMS_INTERRUPT_MASK;
-}
-
-/*PAGE
- *
* _Modes_Mask_changed
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if any of the mode flags in mask
+ * are set in mode_set, and FALSE otherwise.
*/
STATIC INLINE boolean _Modes_Mask_changed (
@@ -47,6 +39,10 @@ STATIC INLINE boolean _Modes_Mask_changed (
*
* _Modes_Is_asr_disabled
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if mode_set indicates that Asynchronous
+ * Signal Processing is disabled, and FALSE otherwise.
*/
STATIC INLINE boolean _Modes_Is_asr_disabled (
@@ -60,6 +56,10 @@ STATIC INLINE boolean _Modes_Is_asr_disabled (
*
* _Modes_Is_preempt
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if mode_set indicates that preemption
+ * is enabled, and FALSE otherwise.
*/
STATIC INLINE boolean _Modes_Is_preempt (
@@ -73,6 +73,10 @@ STATIC INLINE boolean _Modes_Is_preempt (
*
* _Modes_Is_timeslice
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if mode_set indicates that timeslicing
+ * is enabled, and FALSE otherwise.
*/
STATIC INLINE boolean _Modes_Is_timeslice (
@@ -86,6 +90,9 @@ STATIC INLINE boolean _Modes_Is_timeslice (
*
* _Modes_Get_interrupt_level
*
+ * DESCRIPTION:
+ *
+ * This function returns the interrupt level portion of the mode_set.
*/
STATIC INLINE ISR_Level _Modes_Get_interrupt_level (
@@ -99,6 +106,10 @@ STATIC INLINE ISR_Level _Modes_Get_interrupt_level (
*
* _Modes_Set_interrupt_level
*
+ * DESCRIPTION:
+ *
+ * This routine sets the current interrupt level to that specified
+ * in the mode_set.
*/
STATIC INLINE void _Modes_Set_interrupt_level (
@@ -112,6 +123,12 @@ STATIC INLINE void _Modes_Set_interrupt_level (
*
* _Modes_Change
*
+ * DESCRIPTION:
+ *
+ * This routine changes the modes in old_mode_set indicated by
+ * mask to the requested values in new_mode_set. The resulting
+ * mode set is returned in out_mode_set and the modes that changed
+ * is returned in changed.
*/
STATIC INLINE void _Modes_Change (
diff --git a/cpukit/rtems/inline/rtems/rtems/options.inl b/cpukit/rtems/inline/rtems/rtems/options.inl
index b3c7312010..9dba30e895 100644
--- a/cpukit/rtems/inline/rtems/rtems/options.inl
+++ b/cpukit/rtems/inline/rtems/rtems/options.inl
@@ -21,6 +21,10 @@
*
* _Options_Is_no_wait
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the RTEMS_NO_WAIT option is enabled in
+ * option_set, and FALSE otherwise.
*/
STATIC INLINE boolean _Options_Is_no_wait (
@@ -34,6 +38,10 @@ STATIC INLINE boolean _Options_Is_no_wait (
*
* _Options_Is_any
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the RTEMS_EVENT_ANY option is enabled in
+ * OPTION_SET, and FALSE otherwise.
*/
STATIC INLINE boolean _Options_Is_any (
diff --git a/cpukit/rtems/inline/rtems/rtems/part.inl b/cpukit/rtems/inline/rtems/rtems/part.inl
index 78f86dcefc..9088755aa7 100644
--- a/cpukit/rtems/inline/rtems/rtems/part.inl
+++ b/cpukit/rtems/inline/rtems/rtems/part.inl
@@ -21,6 +21,11 @@
*
* _Partition_Allocate_buffer
*
+ * DESCRIPTION:
+ *
+ * This function attempts to allocate a buffer from the_partition.
+ * If successful, it returns the address of the allocated buffer.
+ * Otherwise, it returns NULL.
*/
STATIC INLINE void *_Partition_Allocate_buffer (
@@ -34,6 +39,9 @@ STATIC INLINE void *_Partition_Allocate_buffer (
*
* _Partition_Free_buffer
*
+ * DESCRIPTION:
+ *
+ * This routine frees the_buffer to the_partition.
*/
STATIC INLINE void _Partition_Free_buffer (
@@ -48,6 +56,10 @@ STATIC INLINE void _Partition_Free_buffer (
*
* _Partition_Is_buffer_on_boundary
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the_buffer is on a valid buffer
+ * boundary for the_partition, and FALSE otherwise.
*/
STATIC INLINE boolean _Partition_Is_buffer_on_boundary (
@@ -69,6 +81,10 @@ STATIC INLINE boolean _Partition_Is_buffer_on_boundary (
*
* _Partition_Is_buffer_valid
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the_buffer is a valid buffer from
+ * the_partition, otherwise FALSE is returned.
*/
STATIC INLINE boolean _Partition_Is_buffer_valid (
@@ -92,6 +108,11 @@ STATIC INLINE boolean _Partition_Is_buffer_valid (
*
* _Partition_Is_buffer_size_aligned
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the use of the specified buffer_size
+ * will result in the allocation of buffers whose first byte is
+ * properly aligned, and FALSE otherwise.
*/
STATIC INLINE boolean _Partition_Is_buffer_size_aligned (
@@ -105,6 +126,10 @@ STATIC INLINE boolean _Partition_Is_buffer_size_aligned (
*
* _Partition_Allocate
*
+ * DESCRIPTION:
+ *
+ * This function allocates a partition control block from
+ * the inactive chain of free partition control blocks.
*/
STATIC INLINE Partition_Control *_Partition_Allocate ( void )
@@ -116,6 +141,10 @@ STATIC INLINE Partition_Control *_Partition_Allocate ( void )
*
* _Partition_Free
*
+ * DESCRIPTION:
+ *
+ * This routine frees a partition control block to the
+ * inactive chain of free partition control blocks.
*/
STATIC INLINE void _Partition_Free (
@@ -129,6 +158,15 @@ STATIC INLINE void _Partition_Free (
*
* _Partition_Get
*
+ * DESCRIPTION:
+ *
+ * This function maps partition IDs to partition control blocks.
+ * If ID corresponds to a local partition, then it returns
+ * the_partition control pointer which maps to ID and location
+ * is set to OBJECTS_LOCAL. If the partition ID is global and
+ * resides on a remote node, then location is set to OBJECTS_REMOTE,
+ * and the_partition is undefined. Otherwise, location is set
+ * to OBJECTS_ERROR and the_partition is undefined.
*/
STATIC INLINE Partition_Control *_Partition_Get (
@@ -144,6 +182,10 @@ STATIC INLINE Partition_Control *_Partition_Get (
*
* _Partition_Is_null
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the_partition is NULL
+ * and FALSE otherwise.
*/
STATIC INLINE boolean _Partition_Is_null (
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 (
diff --git a/cpukit/rtems/inline/rtems/rtems/region.inl b/cpukit/rtems/inline/rtems/rtems/region.inl
index 5a0e4da1bf..aae042bed4 100644
--- a/cpukit/rtems/inline/rtems/rtems/region.inl
+++ b/cpukit/rtems/inline/rtems/rtems/region.inl
@@ -21,6 +21,10 @@
*
* _Region_Allocate
*
+ * DESCRIPTION:
+ *
+ * This function allocates a region control block from
+ * the inactive chain of free region control blocks.
*/
STATIC INLINE Region_Control *_Region_Allocate( void )
@@ -32,6 +36,10 @@ STATIC INLINE Region_Control *_Region_Allocate( void )
*
* _Region_Free
*
+ * DESCRIPTION:
+ *
+ * This routine frees a region control block to the
+ * inactive chain of free region control blocks.
*/
STATIC INLINE void _Region_Free (
@@ -45,6 +53,13 @@ STATIC INLINE void _Region_Free (
*
* _Region_Get
*
+ * DESCRIPTION:
+ *
+ * This function maps region IDs to region control blocks.
+ * If ID corresponds to a local region, then it returns
+ * the_region control pointer which maps to ID and location
+ * is set to OBJECTS_LOCAL. Otherwise, location is set
+ * to OBJECTS_ERROR and the_region is undefined.
*/
STATIC INLINE Region_Control *_Region_Get (
@@ -60,6 +75,11 @@ STATIC INLINE Region_Control *_Region_Get (
*
* _Region_Allocate_segment
*
+ * DESCRIPTION:
+ *
+ * This function attempts to allocate a segment from the_region.
+ * If successful, it returns the address of the allocated segment.
+ * Otherwise, it returns NULL.
*/
STATIC INLINE void *_Region_Allocate_segment (
@@ -74,6 +94,9 @@ STATIC INLINE void *_Region_Allocate_segment (
*
* _Region_Free_segment
*
+ * DESCRIPTION:
+ *
+ * This function frees the_segment to the_region.
*/
STATIC INLINE boolean _Region_Free_segment (
@@ -88,6 +111,9 @@ STATIC INLINE boolean _Region_Free_segment (
*
* _Region_Is_null
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the_region is NULL and FALSE otherwise.
*/
STATIC INLINE boolean _Region_Is_null (
diff --git a/cpukit/rtems/inline/rtems/rtems/sem.inl b/cpukit/rtems/inline/rtems/rtems/sem.inl
index 518684a97a..c80431f9b1 100644
--- a/cpukit/rtems/inline/rtems/rtems/sem.inl
+++ b/cpukit/rtems/inline/rtems/rtems/sem.inl
@@ -21,6 +21,10 @@
*
* _Semaphore_Allocate
*
+ * DESCRIPTION:
+ *
+ * This function allocates a semaphore control block from
+ * the inactive chain of free semaphore control blocks.
*/
STATIC INLINE Semaphore_Control *_Semaphore_Allocate( void )
@@ -32,6 +36,10 @@ STATIC INLINE Semaphore_Control *_Semaphore_Allocate( void )
*
* _Semaphore_Free
*
+ * DESCRIPTION:
+ *
+ * This routine frees a semaphore control block to the
+ * inactive chain of free semaphore control blocks.
*/
STATIC INLINE void _Semaphore_Free (
@@ -45,6 +53,15 @@ STATIC INLINE void _Semaphore_Free (
*
* _Semaphore_Get
*
+ * DESCRIPTION:
+ *
+ * This function maps semaphore IDs to semaphore control blocks.
+ * If ID corresponds to a local semaphore, then it returns
+ * the_semaphore control pointer which maps to ID and location
+ * is set to OBJECTS_LOCAL. if the semaphore ID is global and
+ * resides on a remote node, then location is set to OBJECTS_REMOTE,
+ * and the_semaphore is undefined. Otherwise, location is set
+ * to OBJECTS_ERROR and the_semaphore is undefined.
*/
STATIC INLINE Semaphore_Control *_Semaphore_Get (
@@ -60,6 +77,9 @@ STATIC INLINE Semaphore_Control *_Semaphore_Get (
*
* _Semaphore_Is_null
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the_semaphore is NULL and FALSE otherwise.
*/
STATIC INLINE boolean _Semaphore_Is_null (
diff --git a/cpukit/rtems/inline/rtems/rtems/status.inl b/cpukit/rtems/inline/rtems/rtems/status.inl
index 1db5a1e89f..f85b4c6d0b 100644
--- a/cpukit/rtems/inline/rtems/rtems/status.inl
+++ b/cpukit/rtems/inline/rtems/rtems/status.inl
@@ -21,6 +21,10 @@
*
* rtems_is_status_successful
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the status code is equal to RTEMS_SUCCESSFUL,
+ * and FALSE otherwise.
*/
STATIC INLINE boolean rtems_is_status_successful(
@@ -34,6 +38,10 @@ STATIC INLINE boolean rtems_is_status_successful(
*
* rtems_are_statuses_equal
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the status code1 is equal to code2,
+ * and FALSE otherwise.
*/
STATIC INLINE boolean rtems_are_statuses_equal(
diff --git a/cpukit/rtems/inline/rtems/rtems/support.inl b/cpukit/rtems/inline/rtems/rtems/support.inl
index 2f98a98ad0..856b24e7f9 100644
--- a/cpukit/rtems/inline/rtems/rtems/support.inl
+++ b/cpukit/rtems/inline/rtems/rtems/support.inl
@@ -21,6 +21,9 @@
*
* rtems_is_name_valid
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the name is valid, and FALSE otherwise.
*/
STATIC INLINE rtems_boolean rtems_is_name_valid (
@@ -34,6 +37,10 @@ STATIC INLINE rtems_boolean rtems_is_name_valid (
*
* rtems_name_to_characters
*
+ * DESCRIPTION:
+ *
+ * This function breaks the object name into the four component
+ * characters C1, C2, C3, and C4.
*/
STATIC INLINE void rtems_name_to_characters(
diff --git a/cpukit/rtems/inline/rtems/rtems/tasks.inl b/cpukit/rtems/inline/rtems/rtems/tasks.inl
index ccd2de2613..6caa34ea80 100644
--- a/cpukit/rtems/inline/rtems/rtems/tasks.inl
+++ b/cpukit/rtems/inline/rtems/rtems/tasks.inl
@@ -21,6 +21,10 @@
*
* _RTEMS_tasks_Allocate
*
+ * DESCRIPTION:
+ *
+ * This function allocates a task control block from
+ * the inactive chain of free task control blocks.
*/
STATIC INLINE Thread_Control *_RTEMS_tasks_Allocate( void )
@@ -32,6 +36,10 @@ STATIC INLINE Thread_Control *_RTEMS_tasks_Allocate( void )
*
* _RTEMS_tasks_Free
*
+ * DESCRIPTION:
+ *
+ * This routine frees a task control block to the
+ * inactive chain of free task control blocks.
*/
STATIC INLINE void _RTEMS_tasks_Free (
@@ -47,6 +55,10 @@ STATIC INLINE void _RTEMS_tasks_Free (
/*PAGE
*
* _RTEMS_tasks_Priority_to_Core
+ *
+ * DESCRIPTION:
+ *
+ * This function converts an RTEMS API priority into a core priority.
*/
STATIC INLINE Priority_Control _RTEMS_tasks_Priority_to_Core(
@@ -60,6 +72,10 @@ STATIC INLINE Priority_Control _RTEMS_tasks_Priority_to_Core(
*
* _RTEMS_tasks_Priority_is_valid
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the_priority is a valid user task priority
+ * and FALSE otherwise.
*/
STATIC INLINE boolean _RTEMS_tasks_Priority_is_valid (
diff --git a/cpukit/rtems/inline/rtems/rtems/timer.inl b/cpukit/rtems/inline/rtems/rtems/timer.inl
index 7af3b9fa3d..dedcdffa36 100644
--- a/cpukit/rtems/inline/rtems/rtems/timer.inl
+++ b/cpukit/rtems/inline/rtems/rtems/timer.inl
@@ -21,6 +21,10 @@
*
* _Timer_Allocate
*
+ * DESCRIPTION:
+ *
+ * This function allocates a timer control block from
+ * the inactive chain of free timer control blocks.
*/
STATIC INLINE Timer_Control *_Timer_Allocate( void )
@@ -32,6 +36,10 @@ STATIC INLINE Timer_Control *_Timer_Allocate( void )
*
* _Timer_Free
*
+ * DESCRIPTION:
+ *
+ * This routine frees a timer control block to the
+ * inactive chain of free timer control blocks.
*/
STATIC INLINE void _Timer_Free (
@@ -45,6 +53,13 @@ STATIC INLINE void _Timer_Free (
*
* _Timer_Get
*
+ * DESCRIPTION:
+ *
+ * This function maps timer IDs to timer control blocks.
+ * If ID corresponds to a local timer, then it returns
+ * the timer control pointer which maps to ID and location
+ * is set to OBJECTS_LOCAL. Otherwise, location is set
+ * to OBJECTS_ERROR and the returned value is undefined.
*/
STATIC INLINE Timer_Control *_Timer_Get (
@@ -60,6 +75,10 @@ STATIC INLINE Timer_Control *_Timer_Get (
*
* _Timer_Is_interval_class
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the class is that of an INTERVAL
+ * timer, and FALSE otherwise.
*/
STATIC INLINE boolean _Timer_Is_interval_class (
@@ -73,6 +92,10 @@ STATIC INLINE boolean _Timer_Is_interval_class (
*
* _Timer_Is_time_of_day_class
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the class is that of an INTERVAL
+ * timer, and FALSE otherwise.
*/
STATIC INLINE boolean _Timer_Is_timer_of_day_class (
@@ -86,6 +109,10 @@ STATIC INLINE boolean _Timer_Is_timer_of_day_class (
*
* _Timer_Is_dormant_class
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the class is that of a DORMANT
+ * timer, and FALSE otherwise.
*/
STATIC INLINE boolean _Timer_Is_dormant_class (
@@ -99,6 +126,9 @@ STATIC INLINE boolean _Timer_Is_dormant_class (
*
* _Timer_Is_null
*
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the_timer is NULL and FALSE otherwise.
*/
STATIC INLINE boolean _Timer_Is_null (