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/apic.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/apic.h')
| -rw-r--r-- | c/src/lib/libbsp/i386/shared/irq/apic.h | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/c/src/lib/libbsp/i386/shared/irq/apic.h b/c/src/lib/libbsp/i386/shared/irq/apic.h index 063d27422c..9ae103b963 100644 --- a/c/src/lib/libbsp/i386/shared/irq/apic.h +++ b/c/src/lib/libbsp/i386/shared/irq/apic.h @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup i386_apic + * @brief Local and I/O APIC definitions + */ + /* * Author: Erich Boleyn <erich@uruk.org> * http://www.uruk.org/~erich/ @@ -27,6 +33,13 @@ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @defgroup i386_apci + * @ingroup i386_pci + * @brief Intel Architecture local and I/O APIC definitions + * @{ + */ + /* * Header file for Intel Architecture local and I/O APIC definitions. * @@ -58,10 +71,10 @@ /* * Shared defines for I/O and local APIC definitions */ -/* APIC version register */ +/** @brief APIC version register */ #define APIC_VERSION(x) ((x) & 0xFF) #define APIC_MAXREDIR(x) (((x) >> 16) & 0xFF) -/* APIC id register */ +/** @brief APIC id register */ #define APIC_ID(x) ((x) >> 24) #define APIC_VER_NEW 0x10 @@ -108,3 +121,5 @@ #define LAPIC_TDCR 0x3E0 #endif /* _APIC_H */ + +/** @} */ |