summaryrefslogtreecommitdiffstats
path: root/cpukit/score/cpu/i386/include
diff options
context:
space:
mode:
authorAndreas Dachsberger <andreas.dachsberger@embedded-brains.de>2019-03-26 09:02:04 +0100
committerAndreas Dachsberger <andreas.dachsberger@embedded-brains.de>2019-04-01 12:02:29 +0200
commitd670ef99c06c0806d4659a06818287ba0abd7aab (patch)
treec3e675c3733ef16e9d52cd298b21e0d9427f018e /cpukit/score/cpu/i386/include
parentdoxygen: score: Add Epiphany CPU architecture group (diff)
downloadrtems-d670ef99c06c0806d4659a06818287ba0abd7aab.tar.bz2
doxygen: score: Add i386 CPU architecture group
Update #3706.
Diffstat (limited to 'cpukit/score/cpu/i386/include')
-rw-r--r--cpukit/score/cpu/i386/include/rtems/asm.h11
-rw-r--r--cpukit/score/cpu/i386/include/rtems/score/cpu.h11
-rw-r--r--cpukit/score/cpu/i386/include/rtems/score/cpuimpl.h12
-rw-r--r--cpukit/score/cpu/i386/include/rtems/score/i386.h2
-rw-r--r--cpukit/score/cpu/i386/include/rtems/score/idtr.h2
-rw-r--r--cpukit/score/cpu/i386/include/rtems/score/interrupts.h10
-rw-r--r--cpukit/score/cpu/i386/include/rtems/score/paravirt.h9
-rw-r--r--cpukit/score/cpu/i386/include/rtems/score/registers.h2
8 files changed, 57 insertions, 2 deletions
diff --git a/cpukit/score/cpu/i386/include/rtems/asm.h b/cpukit/score/cpu/i386/include/rtems/asm.h
index 50b0fd71a0..5db402c930 100644
--- a/cpukit/score/cpu/i386/include/rtems/asm.h
+++ b/cpukit/score/cpu/i386/include/rtems/asm.h
@@ -39,6 +39,15 @@
#include <rtems/score/cpuopts.h>
#include <rtems/score/i386.h>
+/**
+ * @defgroup RTEMSScoreCPUi386ASM i386 Assembler Support
+ *
+ * @ingroup RTEMSScoreCPUi386
+ *
+ * @brief i386 Assembler Support
+ */
+/**@{**/
+
/*
* Recent versions of GNU cpp define variables which indicate the
* need for underscores and percents. If not using GNU cpp or
@@ -137,4 +146,6 @@
#define PUBLIC(sym) .globl SYM (sym)
#define EXTERN(sym) .globl SYM (sym)
+/**@}**/
+
#endif
diff --git a/cpukit/score/cpu/i386/include/rtems/score/cpu.h b/cpukit/score/cpu/i386/include/rtems/score/cpu.h
index 10614a72ee..19562e7623 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/cpu.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/cpu.h
@@ -32,6 +32,15 @@ extern "C" {
#include <rtems/score/paravirt.h>
#endif
#include <rtems/score/i386.h>
+
+/**
+ * @defgroup ScoreCPUi386 i386 Specific Support
+ *
+ * @ingroup RTEMSScoreCPUi386
+ *
+ * @brief i386 specific support.
+ */
+/**@{**/
/* conditional compilation parameters */
@@ -649,6 +658,8 @@ static inline CPU_Counter_ticks _CPU_Counter_difference(
return second - first;
}
+/**@}**/
+
/** Type that can store a 32-bit integer or a pointer. */
typedef uintptr_t CPU_Uint32ptr;
diff --git a/cpukit/score/cpu/i386/include/rtems/score/cpuimpl.h b/cpukit/score/cpu/i386/include/rtems/score/cpuimpl.h
index 78b87ef981..a89b1fedfb 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/cpuimpl.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/cpuimpl.h
@@ -17,6 +17,16 @@
#include <rtems/score/cpu.h>
+/**
+ * @defgroup RTEMSScoreCPUi386 i386
+ *
+ * @ingroup RTEMSScoreCPU
+ *
+ * @brief i386 Architecture Support
+ *
+ * @{
+ */
+
#define CPU_PER_CPU_CONTROL_SIZE 0
#ifndef ASM
@@ -53,4 +63,6 @@ RTEMS_INLINE_ROUTINE void _CPU_Instruction_no_operation( void )
#endif /* ASM */
+/** @} */
+
#endif /* _RTEMS_SCORE_CPUIMPL_H */
diff --git a/cpukit/score/cpu/i386/include/rtems/score/i386.h b/cpukit/score/cpu/i386/include/rtems/score/i386.h
index 4b94e6feeb..549011055e 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/i386.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/i386.h
@@ -2,6 +2,8 @@
* @file
*
* @brief Intel I386 CPU Dependent Source
+ *
+ * @addtogroup RTEMSScoreCPUi386
*
* This include file contains information pertaining to the Intel
* i386 processor.
diff --git a/cpukit/score/cpu/i386/include/rtems/score/idtr.h b/cpukit/score/cpu/i386/include/rtems/score/idtr.h
index a79af40792..c40fce1fba 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/idtr.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/idtr.h
@@ -3,6 +3,8 @@
*
* @brief Intel I386 Data Structures
*
+ * @addtogroup RTEMSScoreCPUi386
+ *
* This file contains definitions for data structure related
* to Intel system programming. More information can be found
* on Intel site and more precisely in the following book :
diff --git a/cpukit/score/cpu/i386/include/rtems/score/interrupts.h b/cpukit/score/cpu/i386/include/rtems/score/interrupts.h
index b682772617..cac9ba9b42 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/interrupts.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/interrupts.h
@@ -16,6 +16,15 @@
* Applications must not include this file directly.
*/
+/**
+ * @defgroup RTEMSScoreCPUi386Interrupt Processor Dependent Interrupt Management
+ *
+ * @ingroup RTEMSScoreCPUi386
+ *
+ * @brief i386 Interrupt Management
+ */
+/**@{**/
+
#ifndef _RTEMS_SCORE_INTERRUPTS_H
#define _RTEMS_SCORE_INTERRUPTS_H
@@ -81,5 +90,6 @@ uint32_t i386_get_interrupt_level( void );
/** @} */
+/**@}**/
#endif
#endif
diff --git a/cpukit/score/cpu/i386/include/rtems/score/paravirt.h b/cpukit/score/cpu/i386/include/rtems/score/paravirt.h
index 40eddb84be..1b26226ad0 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/paravirt.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/paravirt.h
@@ -25,10 +25,12 @@
#define _RTEMS_SCORE_PARAVIRT_H
/**
- * @defgroup Paravirti386 Paravirtualization i386 Support
+ * @defgroup RTEMSScoreCPUi386Paravirt i386 Paravirtualization Support
*
- * @ingroup Score
+ * @ingroup RTEMSScoreCPUi386
*
+ * @{
+ *
* This handler encapulates the functionality (primarily conditional
* feature defines) related to paravirtualization on the i386.
*
@@ -40,6 +42,7 @@
* hosting environment.
*/
+
#ifndef ASM
#ifdef __cplusplus
@@ -61,3 +64,5 @@ extern "C" {
#define I386_DISABLE_INLINE_ISR_DISABLE_ENABLE
#endif
+
+/** @} */
diff --git a/cpukit/score/cpu/i386/include/rtems/score/registers.h b/cpukit/score/cpu/i386/include/rtems/score/registers.h
index 254fef701b..79c0ec3e81 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/registers.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/registers.h
@@ -3,6 +3,8 @@
*
* @brief Intel CPU Constants and Definitions
*
+ * @addtogroup RTEMSScoreCPUi386
+ *
* This file contains definition and constants related to Intel Cpu
*/