summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/intr.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/rtems/include/rtems/rtems/intr.h')
-rw-r--r--cpukit/rtems/include/rtems/rtems/intr.h21
1 files changed, 12 insertions, 9 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/intr.h b/cpukit/rtems/include/rtems/rtems/intr.h
index 8a6e3b714f..66684fe327 100644
--- a/cpukit/rtems/include/rtems/rtems/intr.h
+++ b/cpukit/rtems/include/rtems/rtems/intr.h
@@ -63,11 +63,18 @@ typedef rtems_isr ( *rtems_isr_entry )(
);
/**
- * @brief Implementation of the rtems_interrupt_catch directive.
+ * @brief RTEMS Interrupt Catch
*
* This directive installs @a new_isr_handler as the RTEMS interrupt service
* routine for the interrupt vector with number @a vector. The previous RTEMS
* interrupt service routine is returned in @a old_isr_handler.
+ *
+ * @param[in] new_isr_handler is the address of interrupt service routine
+ * @param[in] vector is the interrupt vector number
+ * @param[in] old_isr_handler address at which to store previous ISR address
+ *
+ * @return RTEMS_SUCCESSFUL and *old_isr_handler filled with previous ISR
+ * address
*/
rtems_status_code rtems_interrupt_catch(
rtems_isr_entry new_isr_handler,
@@ -77,8 +84,7 @@ rtems_status_code rtems_interrupt_catch(
#endif
/**
- * @brief Disables all maskable interrupts and returns the previous level in
- * @a _isr_cookie.
+ * @brief Disable RTEMS Interrupt
*
* @note The interrupt level shall be of type @ref rtems_interrupt_level.
*/
@@ -86,8 +92,7 @@ rtems_status_code rtems_interrupt_catch(
_ISR_Disable(_isr_cookie)
/**
- * @brief Enables maskable interrupts to the level indicated by @a
- * _isr_cookie.
+ * @brief Enable RTEMS Interrupt
*
* @note The interrupt level shall be of type @ref rtems_interrupt_level.
*/
@@ -95,8 +100,7 @@ rtems_status_code rtems_interrupt_catch(
_ISR_Enable(_isr_cookie)
/**
- * @brief Temporarily enables maskable interrupts to the level in @a
- * _isr_cookie before redisabling them.
+ * @brief Flash RTEMS Interrupt
*
* @note The interrupt level shall be of type @ref rtems_interrupt_level.
*/
@@ -104,8 +108,7 @@ rtems_status_code rtems_interrupt_catch(
_ISR_Flash(_isr_cookie)
/**
- * @brief Returns true if the processor is currently servicing an interrupt
- * and false otherwise.
+ * @brief RTEMS Interrupt Is in Progress
*
* A return value of true indicates that the caller is an interrupt service
* routine and @b not a thread. The directives available to an interrupt