summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/inline/rtems/rtems/asr.inl
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2008-04-18 15:02:20 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2008-04-18 15:02:20 +0000
commit067a96ad0c3b0818d71d9aaadaee4b520d940de1 (patch)
treed04eed432a0534ebfb0830d6f7e49ce78ff098a4 /cpukit/rtems/inline/rtems/rtems/asr.inl
parent2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-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/asr.inl')
-rw-r--r--cpukit/rtems/inline/rtems/rtems/asr.inl55
1 files changed, 20 insertions, 35 deletions
diff --git a/cpukit/rtems/inline/rtems/rtems/asr.inl b/cpukit/rtems/inline/rtems/rtems/asr.inl
index bd3b37e060..43bbbea5b5 100644
--- a/cpukit/rtems/inline/rtems/rtems/asr.inl
+++ b/cpukit/rtems/inline/rtems/rtems/asr.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/asr.inl
- */
-
-/*
+ *
* This include file contains the implemenation of all routines
* associated with the asynchronous signal handler which are inlined.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -21,15 +20,16 @@
#include <rtems/score/isr.h>
-/*PAGE
- *
- * _ASR_Initialize
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicASR
+ * @{
+ */
+
+/**
+ * @brief ASR_Initialize
*
* This routine initializes the given RTEMS_ASR information record.
*/
-
RTEMS_INLINE_ROUTINE void _ASR_Initialize (
ASR_Information *information
)
@@ -42,17 +42,13 @@ RTEMS_INLINE_ROUTINE void _ASR_Initialize (
information->nest_level = 0;
}
-/*PAGE
- *
- * _ASR_Swap_signals
- *
- * DESCRIPTION:
+/**
+ * @brief ASR_Swap_signals
*
* 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.
*/
-
RTEMS_INLINE_ROUTINE void _ASR_Swap_signals (
ASR_Information *information
)
@@ -67,16 +63,12 @@ RTEMS_INLINE_ROUTINE void _ASR_Swap_signals (
_ISR_Enable( _level );
}
-/*PAGE
- *
- * _ASR_Is_null_handler
- *
- * DESCRIPTION:
+/**
+ * @brief ASR_Is_null_handler
*
* This function returns TRUE if the given asr_handler is NULL and
* FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _ASR_Is_null_handler (
rtems_asr_entry asr_handler
)
@@ -84,16 +76,12 @@ RTEMS_INLINE_ROUTINE boolean _ASR_Is_null_handler (
return asr_handler == NULL;
}
-/*PAGE
- *
- * _ASR_Are_signals_pending
- *
- * DESCRIPTION:
+/**
+ * @brief ASR_Are_signals_pending
*
* This function returns TRUE if there are signals pending in the
* given RTEMS_ASR information record and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _ASR_Are_signals_pending (
ASR_Information *information
)
@@ -101,18 +89,14 @@ RTEMS_INLINE_ROUTINE boolean _ASR_Are_signals_pending (
return information->signals_posted != 0;
}
-/*PAGE
- *
- * _ASR_Post_signals
- *
- * DESCRIPTION:
+/**
+ * @brief ASR_Post_signals
*
* 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.
*/
-
RTEMS_INLINE_ROUTINE void _ASR_Post_signals(
rtems_signal_set signals,
rtems_signal_set *signal_set
@@ -125,6 +109,7 @@ RTEMS_INLINE_ROUTINE void _ASR_Post_signals(
_ISR_Enable( _level );
}
+/**@}*/
#endif
/* end of include file */