diff options
Diffstat (limited to '')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/intr.h | 86 |
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 */ |