diff options
| author | Joel Sherrill <joel.sherrill@OARcorp.com> | 1996-03-06 21:34:57 +0000 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 1996-03-06 21:34:57 +0000 |
| commit | 1a8fde6ca27afea19faf9bf6487d8aa20b4a8d41 (patch) | |
| tree | 209ab42fa9bc98774d5290d670af14886390d269 /cpukit/rtems | |
| parent | Removed prototyes for static inline rgutines and moved the comments into (diff) | |
| download | rtems-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 '')
34 files changed, 380 insertions, 1051 deletions
diff --git a/cpukit/rtems/include/rtems.h b/cpukit/rtems/include/rtems.h index 97eec4b772..e8826079b9 100644 --- a/cpukit/rtems/include/rtems.h +++ b/cpukit/rtems/include/rtems.h @@ -23,6 +23,18 @@ extern "C" { #endif +/* + * Unless told otherwise, the RTEMS include files will hide some stuff + * from normal application code. Defining this crosses a boundary which + * is undesirable since it means your application is using RTEMS features + * which are not included in the formally defined and supported API. + * Define this at your own risk. + */ + +#ifndef __RTEMS_VIOLATE_KERNEL_VISIBILITY__ +#define __RTEMS_APPLICATION__ +#endif + #include <rtems/system.h> #include <rtems/rtems/status.h> #include <rtems/rtems/types.h> diff --git a/cpukit/rtems/include/rtems/rtems/asr.h b/cpukit/rtems/include/rtems/rtems/asr.h index 55eed78ec2..31758fc06b 100644 --- a/cpukit/rtems/include/rtems/rtems/asr.h +++ b/cpukit/rtems/include/rtems/rtems/asr.h @@ -100,75 +100,9 @@ typedef struct { #define RTEMS_SIGNAL_30 0x40000000 #define RTEMS_SIGNAL_31 0x80000000 -/* - * _ASR_Initialize - * - * DESCRIPTION: - * - * This routine initializes the given RTEMS_ASR information record. - */ - -STATIC INLINE void _ASR_Initialize ( - ASR_Information *information -); - -/* - * _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 ( - ASR_Information *information -); - -/* - * _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 ( - rtems_asr_entry asr_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 ( - ASR_Information *information -); - -/* - * _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( - rtems_signal_set signals, - rtems_signal_set *signal_set -); - +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/asr.inl> +#endif #ifdef __cplusplus } diff --git a/cpukit/rtems/include/rtems/rtems/attr.h b/cpukit/rtems/include/rtems/rtems/attr.h index 2d34dfe380..8262a3a381 100644 --- a/cpukit/rtems/include/rtems/rtems/attr.h +++ b/cpukit/rtems/include/rtems/rtems/attr.h @@ -72,129 +72,9 @@ typedef unsigned32 rtems_attribute; #define _Attributes_Handler_initialization() -/* - * _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 ( - rtems_attribute new_attributes, - rtems_attribute attribute_set -); - -/* - * _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 ( - rtems_attribute attribute_set, - rtems_attribute mask -); - -/* - * _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( - rtems_attribute attribute_set -); - -/* - * _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( - rtems_attribute attribute_set -); - -/* - * _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( - rtems_attribute attribute_set -); - -#if 0 -/* - * _Attributes_Is_limit - * - * DESCRIPTION: - * - * This function returns TRUE if the limited attribute is - * enabled in the attribute_set and FALSE otherwise. - */ - -STATIC INLINE boolean _Attributes_Is_limit( - rtems_attribute attribute_set -); -#endif - -/* - * _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( - rtems_attribute attribute_set -); - -/* - * _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( - rtems_attribute attribute_set -); - -/* - * _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( - rtems_attribute attribute_set -); - - +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/attr.inl> +#endif #ifdef __cplusplus } diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h index 576a338187..fc580c1a8a 100644 --- a/cpukit/rtems/include/rtems/rtems/dpmem.h +++ b/cpukit/rtems/include/rtems/rtems/dpmem.h @@ -145,62 +145,9 @@ rtems_status_code rtems_port_internal_to_external( void **external ); -/* - * _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 - *_Dual_ported_memory_Allocate ( void ); - -/* - * _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 ( - Dual_ported_memory_Control *the_port -); - -/* - * _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 ( - Objects_Id id, - Objects_Locations *location -); - -/* - * _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( - Dual_ported_memory_Control *the_port -); - +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/dpmem.inl> +#endif #ifdef __cplusplus } diff --git a/cpukit/rtems/include/rtems/rtems/event.h b/cpukit/rtems/include/rtems/rtems/event.h index 6ae6bcee5c..0add026e5c 100644 --- a/cpukit/rtems/include/rtems/rtems/event.h +++ b/cpukit/rtems/include/rtems/rtems/event.h @@ -55,16 +55,6 @@ typedef enum { } Event_Sync_states; /* - * _Event_Manager_initialization - * - * DESCRIPTION: - * - * This routine performs the initialization necessary for this manager. - */ - -STATIC INLINE void _Event_Manager_initialization( void ); - -/* * rtems_event_send * * DESCRIPTION: @@ -162,7 +152,9 @@ void _Event_Timeout ( EXTERN volatile Event_Sync_states _Event_Sync_state; #include <rtems/rtems/eventmp.h> +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/event.inl> +#endif #ifdef __cplusplus } diff --git a/cpukit/rtems/include/rtems/rtems/eventset.h b/cpukit/rtems/include/rtems/rtems/eventset.h index 770f607075..0f3e122e5f 100644 --- a/cpukit/rtems/include/rtems/rtems/eventset.h +++ b/cpukit/rtems/include/rtems/rtems/eventset.h @@ -77,62 +77,9 @@ typedef unsigned32 rtems_event_set; #define EVENT_SETS_NONE_PENDING 0 -/* - * _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( - rtems_event_set the_event_set -); - -/* - * _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( - rtems_event_set the_new_events, - rtems_event_set *the_event_set -); - -/* - * _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( - rtems_event_set the_event_set, - rtems_event_set the_event_condition -); - -/* - * _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( - rtems_event_set the_event_set, - rtems_event_set the_mask -); - +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/eventset.inl> +#endif #ifdef __cplusplus } diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h index 40b04ed21c..0469f8ddbf 100644 --- a/cpukit/rtems/include/rtems/rtems/message.h +++ b/cpukit/rtems/include/rtems/rtems/message.h @@ -262,19 +262,6 @@ rtems_status_code _Message_queue_Submit( ); /* - * _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 ( - Message_queue_Control *the_message_queue -); - -/* * _Message_queue_Allocate * * DESCRIPTION: @@ -289,39 +276,6 @@ Message_queue_Control *_Message_queue_Allocate ( ); /* - * _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 ( - Message_queue_Control *the_message_queue -); - -/* - * _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 ( - Objects_Id id, - Objects_Locations *location -); - -/* * _Message_queue_Translate_core_message_queue_return_code * * DESCRIPTION: @@ -350,7 +304,9 @@ void _Message_queue_Core_message_queue_mp_support ( Objects_Id id ); +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/message.inl> +#endif #include <rtems/rtems/msgmp.h> #ifdef __cplusplus diff --git a/cpukit/rtems/include/rtems/rtems/modes.h b/cpukit/rtems/include/rtems/rtems/modes.h index bf60aacf1f..34a23c7b20 100644 --- a/cpukit/rtems/include/rtems/rtems/modes.h +++ b/cpukit/rtems/include/rtems/rtems/modes.h @@ -59,7 +59,8 @@ typedef unsigned32 Modes_Control; * RTEMS supports 0 to 256 levels in bits 0-7 of the mode. */ -/* +/*PAGE + * * RTEMS_INTERRUPT_LEVEL * * DESCRIPTION: @@ -72,108 +73,13 @@ typedef unsigned32 Modes_Control; * particular CPU, fewer than 256 levels may be supported. */ -STATIC INLINE unsigned32 RTEMS_INTERRUPT_LEVEL ( - Modes_Control mode_set -); - -/* - * _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 ( - Modes_Control mode_set, - Modes_Control masks -); - -/* - * _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 ( - Modes_Control mode_set -); - -/* - * _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 ( - Modes_Control mode_set -); - -/* - * _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 ( - Modes_Control mode_set -); - -/* - * _Modes_Get_interrupt_level - * - * DESCRIPTION: - * - * This function returns the interrupt level portion of the mode_set. - */ - -STATIC INLINE ISR_Level _Modes_Get_interrupt_level ( - Modes_Control mode_set -); - -/* - * _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 ( - Modes_Control mode_set -); - -/* - * _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 ( - Modes_Control old_mode_set, - Modes_Control new_mode_set, - Modes_Control mask, - Modes_Control *out_mode_set, - Modes_Control *changed -); +#define RTEMS_INTERRUPT_LEVEL( _mode_set ) \ + ( (_mode_set) & RTEMS_INTERRUPT_MASK ) + +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/modes.inl> +#endif #ifdef __cplusplus } diff --git a/cpukit/rtems/include/rtems/rtems/options.h b/cpukit/rtems/include/rtems/rtems/options.h index d8da2f9e86..069d7721b3 100644 --- a/cpukit/rtems/include/rtems/rtems/options.h +++ b/cpukit/rtems/include/rtems/rtems/options.h @@ -41,35 +41,9 @@ typedef unsigned32 rtems_option; #define RTEMS_EVENT_ALL 0x00000000 /* wait for all events */ #define RTEMS_EVENT_ANY 0x00000002 /* wait on any event */ -/* - * _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 ( - rtems_option option_set -); - -/* - * _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 ( - rtems_option option_set -); - +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/options.inl> +#endif #ifdef __cplusplus } diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h index 95a7ce692e..e06a2e4b86 100644 --- a/cpukit/rtems/include/rtems/rtems/part.h +++ b/cpukit/rtems/include/rtems/rtems/part.h @@ -155,132 +155,9 @@ rtems_status_code rtems_partition_return_buffer( void *buffer ); -/* - * _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 ( - Partition_Control *the_partition -); - -/* - * _Partition_Free_buffer - * - * DESCRIPTION: - * - * This routine frees the_buffer to the_partition. - */ - -STATIC INLINE void _Partition_Free_buffer ( - Partition_Control *the_partition, - Chain_Node *the_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 ( - void *the_buffer, - Partition_Control *the_partition -); - -/* - * _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 ( - Chain_Node *the_buffer, - Partition_Control *the_partition -); - -/* - * _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 ( - unsigned32 buffer_size -); - -/* - * _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 ); - -/* - * _Partition_Free - * - * DESCRIPTION: - * - * This routine frees a partition control block to the - * inactive chain of free partition control blocks. - */ - -STATIC INLINE void _Partition_Free ( - Partition_Control *the_partition -); - -/* - * _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 ( - Objects_Id id, - Objects_Locations *location -); - -/* - * _Partition_Is_null - * - * DESCRIPTION: - * - * This function returns TRUE if the_partition is NULL - * and FALSE otherwise. - */ - -STATIC INLINE boolean _Partition_Is_null ( - Partition_Control *the_partition -); - +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/part.inl> +#endif #include <rtems/rtems/partmp.h> #ifdef __cplusplus diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h index 3c6c6695ca..a85bbcdc09 100644 --- a/cpukit/rtems/include/rtems/rtems/ratemon.h +++ b/cpukit/rtems/include/rtems/rtems/ratemon.h @@ -156,47 +156,6 @@ rtems_status_code rtems_rate_monotonic_period( ); /* - * _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 ); - -/* - * _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 ( - Rate_monotonic_Control *the_period -); - -/* - * _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 ( - Objects_Id id, - Objects_Locations *location -); - -/* * _Rate_monotonic_Timeout * * DESCRIPTION: @@ -214,58 +173,9 @@ void _Rate_monotonic_Timeout ( void *ignored ); -/* - * _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 ( - Rate_monotonic_Control *the_period -); - -/* - * _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 ( - Rate_monotonic_Control *the_period -); - -/* - * _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 ( - Rate_monotonic_Control *the_period -); - -/* - * _Rate_monotonic_Is_null - * - * DESCRIPTION: - * - * This function returns TRUE if the_period is NULL and FALSE otherwise. - */ - -STATIC INLINE boolean _Rate_monotonic_Is_null ( - Rate_monotonic_Control *the_period -); - +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/ratemon.inl> +#endif #ifdef __cplusplus } diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h index 054698caa3..7ee2658cd2 100644 --- a/cpukit/rtems/include/rtems/rtems/region.h +++ b/cpukit/rtems/include/rtems/rtems/region.h @@ -198,88 +198,9 @@ rtems_status_code rtems_region_return_segment( void *segment ); -/* - * _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 ); - -/* - * _Region_Free - * - * DESCRIPTION: - * - * This routine frees a region control block to the - * inactive chain of free region control blocks. - */ - -STATIC INLINE void _Region_Free ( - Region_Control *the_region -); - -/* - * _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 ( - Objects_Id id, - Objects_Locations *location -); - -/* - * _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 ( - Region_Control *the_region, - unsigned32 size -); - -/* - * _Region_Free_segment - * - * DESCRIPTION: - * - * This function frees the_segment to the_region. - */ - -STATIC INLINE boolean _Region_Free_segment ( - Region_Control *the_region, - void *the_segment -); - -/* - * _Region_Is_null - * - * DESCRIPTION: - * - * This function returns TRUE if the_region is NULL and FALSE otherwise. - */ - -STATIC INLINE boolean _Region_Is_null ( - Region_Control *the_region -); - +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/region.inl> +#endif #include <rtems/rtems/regionmp.h> /* diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h index e9760ac4e1..c4f8574b17 100644 --- a/cpukit/rtems/include/rtems/rtems/sem.h +++ b/cpukit/rtems/include/rtems/rtems/sem.h @@ -178,61 +178,6 @@ boolean _Semaphore_Seize( ); /* - * _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 ); - -/* - * _Semaphore_Free - * - * DESCRIPTION: - * - * This routine frees a semaphore control block to the - * inactive chain of free semaphore control blocks. - */ - -STATIC INLINE void _Semaphore_Free ( - Semaphore_Control *the_semaphore -); - -/* - * _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 ( - rtems_id id, - Objects_Locations *location -); - -/* - * _Semaphore_Is_null - * - * DESCRIPTION: - * - * This function returns TRUE if the_semaphore is NULL and FALSE otherwise. - */ - -STATIC INLINE boolean _Semaphore_Is_null ( - Semaphore_Control *the_semaphore -); - -/* * _Semaphore_Translate_core_mutex_return_code * * DESCRIPTION: @@ -290,7 +235,9 @@ void _Semaphore_Core_semaphore_mp_support ( rtems_id id ); +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/sem.inl> +#endif #include <rtems/rtems/semmp.h> #ifdef __cplusplus diff --git a/cpukit/rtems/include/rtems/rtems/status.h b/cpukit/rtems/include/rtems/rtems/status.h index 1c00d47bbf..23c1c830c6 100644 --- a/cpukit/rtems/include/rtems/rtems/status.h +++ b/cpukit/rtems/include/rtems/rtems/status.h @@ -69,32 +69,9 @@ rtems_status_code _Status_Object_name_errors_to_status[] = { #endif /* - * rtems_is_status_successful - * - * DESCRIPTION: - * - * This function returns TRUE if the status code is equal to RTEMS_SUCCESSFUL, - * and FALSE otherwise. + * Applications are allowed to use the macros to compare status codes. */ -STATIC INLINE boolean rtems_is_status_successful ( - rtems_status_code code -); - -/* - * 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 ( - rtems_status_code code1, - rtems_status_code code2 -); - #include <rtems/rtems/status.inl> #ifdef __cplusplus diff --git a/cpukit/rtems/include/rtems/rtems/support.h b/cpukit/rtems/include/rtems/rtems/support.h index 3cf7eb6840..f4b26d6a61 100644 --- a/cpukit/rtems/include/rtems/rtems/support.h +++ b/cpukit/rtems/include/rtems/rtems/support.h @@ -24,18 +24,6 @@ extern "C" { #include <rtems/rtems/types.h> /* - * 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 ( - rtems_name name -); - -/* * rtems_build_name * * DESCRIPTION: @@ -53,24 +41,6 @@ STATIC INLINE rtems_boolean rtems_is_name_valid ( ( (_C1) << 24 | (_C2) << 16 | (_C3) << 8 | (_C4) ) /* - * 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( - rtems_name name, - char *c1, - char *c2, - char *c3, - char *c4 -); - -/* * rtems_get_class * * DESCRIPTION: diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h index 2c75cb3824..b86d85a562 100644 --- a/cpukit/rtems/include/rtems/rtems/tasks.h +++ b/cpukit/rtems/include/rtems/rtems/tasks.h @@ -392,43 +392,6 @@ rtems_status_code rtems_task_wake_after( rtems_interval ticks ); -/* - * _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 ); - -/* - * _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 ( - Thread_Control *the_task -); - -/* - * _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( - rtems_task_priority priority -); - /*PAGE * * _RTEMS_tasks_Initialize_user_tasks @@ -443,17 +406,9 @@ STATIC INLINE Priority_Control _RTEMS_tasks_Priority_to_Core( void _RTEMS_tasks_Initialize_user_tasks( void ); -/*PAGE - * - * _RTEMS_tasks_Priority_is_valid - * - */ - -STATIC INLINE boolean _RTEMS_tasks_Priority_is_valid ( - rtems_task_priority the_priority -); - +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/tasks.inl> +#endif #include <rtems/rtems/taskmp.h> #ifdef __cplusplus diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h index d55d43df10..d09b80d5ff 100644 --- a/cpukit/rtems/include/rtems/rtems/timer.h +++ b/cpukit/rtems/include/rtems/rtems/timer.h @@ -195,99 +195,9 @@ rtems_status_code rtems_timer_reset( Objects_Id id ); -/* - * _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 ); - -/* - * _Timer_Free - * - * DESCRIPTION: - * - * This routine frees a timer control block to the - * inactive chain of free timer control blocks. - */ - -STATIC INLINE void _Timer_Free ( - Timer_Control *the_timer -); - -/* - * _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 ( - Objects_Id id, - Objects_Locations *location -); - -/* - * _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 ( - Timer_Classes the_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 ( - Timer_Classes the_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 ( - Timer_Classes the_class -); - -/* - * _Timer_Is_null - * - * DESCRIPTION: - * - * This function returns TRUE if the_timer is NULL and FALSE otherwise. - */ - -STATIC INLINE boolean _Timer_Is_null ( - Timer_Control *the_timer -); - +#ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/timer.inl> +#endif #ifdef __cplusplus } 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 ( diff --git a/cpukit/rtems/macros/rtems/rtems/modes.inl b/cpukit/rtems/macros/rtems/rtems/modes.inl index 5f71796c07..a7dea6516d 100644 --- a/cpukit/rtems/macros/rtems/rtems/modes.inl +++ b/cpukit/rtems/macros/rtems/rtems/modes.inl @@ -19,14 +19,6 @@ /*PAGE * - * RTEMS_INTERRUPT_LEVEL - */ - -#define RTEMS_INTERRUPT_LEVEL( _mode_set ) \ - ( (_mode_set) & RTEMS_INTERRUPT_MASK ) - -/*PAGE - * * _Modes_Mask_changed * */ |