summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/intr.h
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/include/rtems/rtems/intr.h
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/include/rtems/rtems/intr.h')
-rw-r--r--cpukit/rtems/include/rtems/rtems/intr.h86
1 files changed, 33 insertions, 53 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/intr.h b/cpukit/rtems/include/rtems/rtems/intr.h
index 281cf8e57b..500040693c 100644
--- a/cpukit/rtems/include/rtems/rtems/intr.h
+++ b/cpukit/rtems/include/rtems/rtems/intr.h
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/intr.h
- */
-
-/*
+ *
* This include file contains all the constants and structures associated
* with the Interrupt Manager.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -25,138 +24,119 @@ extern "C" {
#include <rtems/score/isr.h>
-/*
- * Interrupt level type
+/**
+ * @defgroup ClassicINTR Classic API Interrupt
+ *
+ * This encapsulates functionality which XXX
*/
+/**@{*/
+/**
+ * Interrupt level type
+ */
typedef ISR_Level rtems_interrupt_level;
-/*
+/**
* The following type defines the control block used to manage
* the vectors.
*/
-
typedef ISR_Vector_number rtems_vector_number;
-/*
+/**
* Return type for ISR Handler
*/
-
typedef void rtems_isr;
-/*
+/**
* Pointer to an ISR Handler
*/
-
typedef rtems_isr ( *rtems_isr_entry )(
rtems_vector_number
);
-/*
- * _Interrupt_Manager_initialization
- *
- * DESCRIPTION:
+/**
+ * @brief Interrupt_Manager_initialization
*
* This routine initializes the interrupt manager.
*
*/
-
void _Interrupt_Manager_initialization( void );
-/*
- * rtems_interrupt_catch
- *
- * DESCRIPTION:
+/**
+ * @brief rtems_interrupt_catch
*
* This routine implements the rtems_interrupt_catch directive. This
* directive installs new_isr_handler as the RTEMS interrupt service
* routine for vector. The previous RTEMS interrupt service
* routine is returned in old_isr_handler.
*/
-
rtems_status_code rtems_interrupt_catch(
rtems_isr_entry new_isr_handler,
rtems_vector_number vector,
rtems_isr_entry *old_isr_handler
);
-/*
- * rtems_interrupt_disable
- *
- * DESCRIPTION:
+/**
+ * @brief rtems_interrupt_disable
*
* This routine disables all maskable interrupts and returns the
* previous level in _isr_cookie.
*/
-
#define rtems_interrupt_disable( _isr_cookie ) \
_ISR_Disable(_isr_cookie)
-/*
- * rtems_interrupt_enable
- *
- * DESCRIPTION:
+/**
+ * @brief rtems_interrupt_enable
*
* This routine enables maskable interrupts to the level indicated
* _isr_cookie.
*/
-
#define rtems_interrupt_enable( _isr_cookie ) \
_ISR_Enable(_isr_cookie)
-/*
- * rtems_interrupt_flash
- *
- * DESCRIPTION:
+/**
+ * @brief rtems_interrupt_flash
*
* This routine temporarily enables maskable interrupts to the
* level in _isr_cookie before redisabling them.
*/
-
#define rtems_interrupt_flash( _isr_cookie ) \
_ISR_Flash(_isr_cookie)
-/*
- * rtems_interrupt_is_in_progress
- *
- * DESCRIPTION:
+/**
+ * @brief rtems_interrupt_is_in_progress
*
* This function returns TRUE if the processor is currently servicing
* an interrupt and FALSE otherwise. A return value of TRUE indicates
* that the caller is an interrupt service routine, NOT a thread. The
* directives available to an interrupt service routine are restricted.
*/
-
#define rtems_interrupt_is_in_progress() \
_ISR_Is_in_progress()
-/*
- * rtems_interrupt_cause
- *
- * DESCRIPTION:
+/**
+ * @brief rtems_interrupt_cause
*
* This routine generates an interrupt.
*
* NOTE: No implementation.
*/
-
#define rtems_interrupt_cause( _interrupt_to_cause )
-/*
- * rtems_interrupt_cause
- *
- * DESCRIPTION:
+/**
+ * @brief rtems_interrupt_clear
*
* This routine clears the specified interrupt.
*
* NOTE: No implementation.
*/
-
#define rtems_interrupt_clear( _interrupt_to_clear )
#ifdef __cplusplus
}
#endif
+/**@}*/
+
#endif
/* end of include file */