diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2008-04-18 15:02:20 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2008-04-18 15:02:20 +0000 |
commit | 067a96ad0c3b0818d71d9aaadaee4b520d940de1 (patch) | |
tree | d04eed432a0534ebfb0830d6f7e49ce78ff098a4 /cpukit/rtems/inline/rtems/rtems/modes.inl | |
parent | 2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com> (diff) | |
download | rtems-067a96ad0c3b0818d71d9aaadaee4b520d940de1.tar.bz2 |
2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com>
* rtems/include/rtems.h, rtems/include/rtems/rtems/asr.h,
rtems/include/rtems/rtems/attr.h,
rtems/include/rtems/rtems/barrier.h,
rtems/include/rtems/rtems/barriermp.h,
rtems/include/rtems/rtems/cache.h, rtems/include/rtems/rtems/clock.h,
rtems/include/rtems/rtems/config.h,
rtems/include/rtems/rtems/dpmem.h, rtems/include/rtems/rtems/event.h,
rtems/include/rtems/rtems/eventmp.h,
rtems/include/rtems/rtems/eventset.h,
rtems/include/rtems/rtems/intr.h,
rtems/include/rtems/rtems/message.h,
rtems/include/rtems/rtems/modes.h, rtems/include/rtems/rtems/mp.h,
rtems/include/rtems/rtems/msgmp.h,
rtems/include/rtems/rtems/object.h,
rtems/include/rtems/rtems/options.h,
rtems/include/rtems/rtems/part.h, rtems/include/rtems/rtems/partmp.h,
rtems/include/rtems/rtems/ratemon.h,
rtems/include/rtems/rtems/region.h,
rtems/include/rtems/rtems/regionmp.h,
rtems/include/rtems/rtems/rtemsapi.h,
rtems/include/rtems/rtems/sem.h, rtems/include/rtems/rtems/semmp.h,
rtems/include/rtems/rtems/signal.h,
rtems/include/rtems/rtems/signalmp.h,
rtems/include/rtems/rtems/status.h,
rtems/include/rtems/rtems/support.h,
rtems/include/rtems/rtems/taskmp.h,
rtems/include/rtems/rtems/tasks.h, rtems/include/rtems/rtems/timer.h,
rtems/include/rtems/rtems/types.h, rtems/inline/rtems/rtems/asr.inl,
rtems/inline/rtems/rtems/attr.inl,
rtems/inline/rtems/rtems/barrier.inl,
rtems/inline/rtems/rtems/dpmem.inl,
rtems/inline/rtems/rtems/event.inl,
rtems/inline/rtems/rtems/eventset.inl,
rtems/inline/rtems/rtems/message.inl,
rtems/inline/rtems/rtems/modes.inl,
rtems/inline/rtems/rtems/options.inl,
rtems/inline/rtems/rtems/part.inl,
rtems/inline/rtems/rtems/ratemon.inl,
rtems/inline/rtems/rtems/region.inl,
rtems/inline/rtems/rtems/sem.inl,
rtems/inline/rtems/rtems/status.inl,
rtems/inline/rtems/rtems/support.inl,
rtems/inline/rtems/rtems/tasks.inl,
rtems/inline/rtems/rtems/timer.inl: Initial conversion of Classic API
header files to Doxygen.
* rtems/Doxyfile: New file.
Diffstat (limited to 'cpukit/rtems/inline/rtems/rtems/modes.inl')
-rw-r--r-- | cpukit/rtems/inline/rtems/rtems/modes.inl | 72 |
1 files changed, 25 insertions, 47 deletions
diff --git a/cpukit/rtems/inline/rtems/rtems/modes.inl b/cpukit/rtems/inline/rtems/rtems/modes.inl index eef7a3d9f3..9656de2dab 100644 --- a/cpukit/rtems/inline/rtems/rtems/modes.inl +++ b/cpukit/rtems/inline/rtems/rtems/modes.inl @@ -1,12 +1,11 @@ /** * @file rtems/rtems/modes.inl - */ - -/* + * * This include file contains the static inline implementation of the * inlined routines in the Mode Handler - * - * COPYRIGHT (c) 1989-1999. + */ + +/* COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -19,16 +18,17 @@ #ifndef _RTEMS_RTEMS_MODES_INL #define _RTEMS_RTEMS_MODES_INL -/*PAGE - * - * _Modes_Mask_changed - * - * DESCRIPTION: +/** + * @addtogroup ClassicModes + * @{ + */ + +/** + * @brief Modes_Mask_changed * * This function returns TRUE if any of the mode flags in mask * are set in mode_set, and FALSE otherwise. */ - RTEMS_INLINE_ROUTINE boolean _Modes_Mask_changed ( Modes_Control mode_set, Modes_Control masks @@ -37,16 +37,12 @@ RTEMS_INLINE_ROUTINE boolean _Modes_Mask_changed ( return ( mode_set & masks ); } -/*PAGE - * - * _Modes_Is_asr_disabled - * - * DESCRIPTION: +/** + * @brief Modes_Is_asr_disabled * * This function returns TRUE if mode_set indicates that Asynchronous * Signal Processing is disabled, and FALSE otherwise. */ - RTEMS_INLINE_ROUTINE boolean _Modes_Is_asr_disabled ( Modes_Control mode_set ) @@ -54,16 +50,12 @@ RTEMS_INLINE_ROUTINE boolean _Modes_Is_asr_disabled ( return (mode_set & RTEMS_ASR_MASK) == RTEMS_NO_ASR; } -/*PAGE - * - * _Modes_Is_preempt - * - * DESCRIPTION: +/** + * @brief Modes_Is_preempt * * This function returns TRUE if mode_set indicates that preemption * is enabled, and FALSE otherwise. */ - RTEMS_INLINE_ROUTINE boolean _Modes_Is_preempt ( Modes_Control mode_set ) @@ -71,16 +63,12 @@ RTEMS_INLINE_ROUTINE boolean _Modes_Is_preempt ( return (mode_set & RTEMS_PREEMPT_MASK) == RTEMS_PREEMPT; } -/*PAGE - * - * _Modes_Is_timeslice - * - * DESCRIPTION: +/** + * @brief Modes_Is_timeslice * * This function returns TRUE if mode_set indicates that timeslicing * is enabled, and FALSE otherwise. */ - RTEMS_INLINE_ROUTINE boolean _Modes_Is_timeslice ( Modes_Control mode_set ) @@ -88,15 +76,11 @@ RTEMS_INLINE_ROUTINE boolean _Modes_Is_timeslice ( return (mode_set & RTEMS_TIMESLICE_MASK) == RTEMS_TIMESLICE; } -/*PAGE - * - * _Modes_Get_interrupt_level - * - * DESCRIPTION: +/** + * @brief Modes_Get_interrupt_level * * This function returns the interrupt level portion of the mode_set. */ - RTEMS_INLINE_ROUTINE ISR_Level _Modes_Get_interrupt_level ( Modes_Control mode_set ) @@ -104,16 +88,12 @@ RTEMS_INLINE_ROUTINE ISR_Level _Modes_Get_interrupt_level ( return ( mode_set & RTEMS_INTERRUPT_MASK ); } -/*PAGE - * - * _Modes_Set_interrupt_level - * - * DESCRIPTION: +/** + * @brief Modes_Set_interrupt_level * * This routine sets the current interrupt level to that specified * in the mode_set. */ - RTEMS_INLINE_ROUTINE void _Modes_Set_interrupt_level ( Modes_Control mode_set ) @@ -121,18 +101,14 @@ RTEMS_INLINE_ROUTINE void _Modes_Set_interrupt_level ( _ISR_Set_level( _Modes_Get_interrupt_level( mode_set ) ); } -/*PAGE - * - * _Modes_Change - * - * DESCRIPTION: +/** + * @brief Modes_Change * * 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. */ - RTEMS_INLINE_ROUTINE void _Modes_Change ( Modes_Control old_mode_set, Modes_Control new_mode_set, @@ -150,5 +126,7 @@ RTEMS_INLINE_ROUTINE void _Modes_Change ( *out_mode_set = _out_mode; } +/**@}*/ + #endif /* end of include file */ |