diff options
| author | Chirayu Desai <cdesai@cyanogenmod.org> | 2013-12-23 23:49:00 +0530 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2013-12-23 15:04:19 -0500 |
| commit | 52943a24710905392c7d4375b204e36bcdd514d7 (patch) | |
| tree | 6ec9e11ed419ae8240f1efed0cd568ea20890f04 /c/src/lib/libbsp/i386/shared/irq/irq.h | |
| parent | lm32: Enhance Doxygen #2 (diff) | |
| download | rtems-52943a24710905392c7d4375b204e36bcdd514d7.tar.bz2 | |
i386: shared: Add doxygen
Diffstat (limited to 'c/src/lib/libbsp/i386/shared/irq/irq.h')
| -rw-r--r-- | c/src/lib/libbsp/i386/shared/irq/irq.h | 31 |
1 files changed, 23 insertions, 8 deletions
diff --git a/c/src/lib/libbsp/i386/shared/irq/irq.h b/c/src/lib/libbsp/i386/shared/irq/irq.h index 643962786b..e176495436 100644 --- a/c/src/lib/libbsp/i386/shared/irq/irq.h +++ b/c/src/lib/libbsp/i386/shared/irq/irq.h @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup i386_irq + * @brief Interrupt handlers + */ + /* irq.h * * This include file describe the data structure and the functions implemented @@ -16,6 +22,13 @@ * http://www.rtems.com/license/LICENSE. */ +/** + * @defgroup i386_irq Interrupt handlers + * @ingroup i386_shared + * @brief Data structure and the functions to write interrupt handlers + * @{ + */ + #ifndef _IRQ_H_ #define _IRQ_H_ @@ -23,7 +36,7 @@ extern "C" { #endif -/* +/** @brief * Include some preprocessor value also used by assember code */ @@ -37,13 +50,13 @@ extern "C" { | Constants +--------------------------------------------------------------------------*/ - /* Base vector for our IRQ handlers. */ + /** @brief Base vector for our IRQ handlers. */ #define BSP_IRQ_VECTOR_BASE BSP_ASM_IRQ_VECTOR_BASE #define BSP_IRQ_LINES_NUMBER 17 #define BSP_LOWEST_OFFSET 0 #define BSP_MAX_ON_i8259S (BSP_IRQ_LINES_NUMBER - 2) #define BSP_MAX_OFFSET (BSP_IRQ_LINES_NUMBER - 1) - /* + /** @brief * Interrupt offset in comparison to BSP_ASM_IRQ_VECTOR_BASE * NB : 1) Interrupt vector number in IDT = offset + BSP_ASM_IRQ_VECTOR_BASE * 2) The same name should be defined on all architecture @@ -62,7 +75,7 @@ extern "C" { #define BSP_INTERRUPT_VECTOR_MIN BSP_LOWEST_OFFSET #define BSP_INTERRUPT_VECTOR_MAX BSP_MAX_OFFSET -/* +/** @brief * Type definition for RTEMS managed interrupts */ typedef unsigned short rtems_i8259_masks; @@ -76,19 +89,19 @@ extern rtems_i8259_masks i8259s_cache; * ------------------------ Intel 8259 (or emulation) Mngt Routines ------- */ -/* +/** @brief * function to disable a particular irq at 8259 level. After calling * this function, even if the device asserts the interrupt line it will * not be propagated further to the processor */ int BSP_irq_disable_at_i8259s (const rtems_irq_number irqLine); -/* +/** @brief * function to enable a particular irq at 8259 level. After calling * this function, if the device asserts the interrupt line it will * be propagated further to the processor */ int BSP_irq_enable_at_i8259s (const rtems_irq_number irqLine); -/* +/** @brief * function to acknoledge a particular irq at 8259 level. After calling * this function, if a device asserts an enabled interrupt line it will * be propagated further to the processor. Mainly usefull for people @@ -96,11 +109,13 @@ int BSP_irq_enable_at_i8259s (const rtems_irq_number irqLine); * handlers. */ int BSP_irq_ack_at_i8259s (const rtems_irq_number irqLine); -/* +/** @brief * function to check if a particular irq is enabled at 8259 level. After calling */ int BSP_irq_enabled_at_i8259s (const rtems_irq_number irqLine); +/** @} */ + #ifdef __cplusplus } #endif |