bsps: Adjust shared Doxygen groups

Update #3706.
This commit is contained in:
Sebastian Huber
2019-03-05 07:58:18 +01:00
parent c991eeeccc
commit 828276b081
88 changed files with 263 additions and 172 deletions

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief A8CORE_START Support * @brief A8CORE_START Support
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief ARM_A9MPCORE_IRQ Support * @brief ARM_A9MPCORE_IRQ Support
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief ARM_A9MPCORE_REGS Support * @brief ARM_A9MPCORE_REGS Support
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief A9MPCORE_START Support * @brief A9MPCORE_START Support
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief Create #defines which state which erratas shall get applied * @brief Create #defines which state which erratas shall get applied
*/ */

View File

@@ -34,7 +34,7 @@ extern "C" {
/** /**
* @defgroup arm_gic ARM GIC * @defgroup arm_gic ARM GIC
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief ARM_GIC Support Package * @brief ARM_GIC Support Package
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief ARM PL011 Register definitions * @brief ARM PL011 Register definitions
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief ARM PL011 Support Package * @brief ARM PL011 Support Package
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief ARM PL050 Register Definitions * @brief ARM PL050 Register Definitions
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief ARM PL050 Support * @brief ARM PL050 Support
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief ARM PL111 FB Support * @brief ARM PL111 FB Support
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief ARM PL111 Register definitions * @brief ARM PL111 Register definitions
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief Create #defines for release IDs * @brief Create #defines for release IDs
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief ARMV7M Support * @brief ARMV7M Support
*/ */

View File

@@ -30,7 +30,7 @@ extern "C" {
/** /**
* @defgroup arm_linker Linker Support * @defgroup arm_linker Linker Support
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief Linker support. * @brief Linker support.
* *

View File

@@ -34,7 +34,7 @@ extern "C" {
/** /**
* @defgroup arm_start System Start * @defgroup arm_start System Start
* *
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief ARM system low level start. * @brief ARM system low level start.
* *

View File

@@ -1,5 +1,5 @@
/** /**
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* *
* @brief Level 1 Cache definitions and functions. * @brief Level 1 Cache definitions and functions.
* *

View File

@@ -97,7 +97,7 @@
/** /**
* @defgroup L2C-310_cache Cache Support * @defgroup L2C-310_cache Cache Support
* @ingroup arm_shared * @ingroup RTEMSBSPsARMShared
* @brief Cache Functions and Defitions * @brief Cache Functions and Defitions
* @{ * @{
*/ */

View File

@@ -6,10 +6,10 @@
* @brief ARM Board Support Packages. * @brief ARM Board Support Packages.
*/ */
/** /**
* @defgroup arm_shared ARM Shared Modules * @defgroup RTEMSBSPsARMShared Shared
* *
* @ingroup RTEMSBSPsARM * @ingroup RTEMSBSPsARM
* *
* @brief ARM Shared Modules * @brief Shared Support for ARM Board Support Packages.
*/ */

View File

@@ -8,7 +8,7 @@ extern "C" {
/** /**
* @defgroup epiphany_linker Linker Support * @defgroup epiphany_linker Linker Support
* *
* @ingroup epiphany_shared * @ingroup RTEMSBSPsEpiphanyShared
* *
* @brief Linker support. * @brief Linker support.
* *

View File

@@ -5,3 +5,11 @@
* *
* @brief Epiphany Board Support Packages. * @brief Epiphany Board Support Packages.
*/ */
/**
* @defgroup RTEMSBSPsEpiphanyShared Shared
*
* @ingroup RTEMSBSPsEpiphany
*
* @brief Shared Support for Epiphany Board Support Packages.
*/

View File

@@ -24,7 +24,7 @@
/** /**
* @defgroup i386_irq Interrupt handlers * @defgroup i386_irq Interrupt handlers
* @ingroup i386_shared * @ingroup RTEMSBSPsI386
* @brief Data structure and the functions to write interrupt handlers * @brief Data structure and the functions to write interrupt handlers
* @{ * @{
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup i386_shared * @ingroup RTEMSBSPsI386
* *
* @brief Definitioins supporting real mode interrupt calls. * @brief Definitioins supporting real mode interrupt calls.
* *

View File

@@ -60,7 +60,7 @@
/** /**
* @defgroup i386_smp SMP * @defgroup i386_smp SMP
* @ingroup i386_shared * @ingroup RTEMSBSPsI386
* @brief * @brief
* Header file implementing Intel MultiProcessor Specification (MPS) * Header file implementing Intel MultiProcessor Specification (MPS)
* version 1.1 and 1.4 SMP hardware control for Intel Architecture CPUs, * version 1.1 and 1.4 SMP hardware control for Intel Architecture CPUs,

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup i386_shared * @ingroup RTEMSBSPsI386
* *
* @brief Real mode interrupt call implementation * @brief Real mode interrupt call implementation
*/ */

View File

@@ -6,20 +6,14 @@
* @brief i386 Board Support Package. * @brief i386 Board Support Package.
*/ */
/**
* @defgroup i386_shared i386 Shared Modules
* @ingroup bsp_i386
* @brief i386 Shared Modules
*/
/** /**
* @defgroup i386_comm Comm * @defgroup i386_comm Comm
* @ingroup i386_shared * @ingroup RTEMSBSPsI386
* @brief Comm * @brief Comm
*/ */
/** /**
* @defgroup i386_pci PCI * @defgroup i386_pci PCI
* @ingroup i386_shared * @ingroup RTEMSBSPsI386
* @brief PCI * @brief PCI
*/ */

View File

@@ -24,7 +24,7 @@ extern "C" {
/** /**
* @defgroup ConsoleTermios Termios Console Driver * @defgroup ConsoleTermios Termios Console Driver
* *
* @ingroup TermiostypesSupport * @ingroup RTEMSBSPsSharedConsole
* *
* @brief Console driver for Termios devices. * @brief Console driver for Termios devices.
* *

View File

@@ -32,7 +32,7 @@ extern "C" {
/** /**
* @defgroup shared_defaultinitialextension DEFAULT_INITIAL_EXTENSION Support * @defgroup shared_defaultinitialextension DEFAULT_INITIAL_EXTENSION Support
* *
* @ingroup shared_include * @ingroup RTEMSBSPsShared
* *
* @brief DEFAULT_INITIAL_EXTENSION Support Package * @brief DEFAULT_INITIAL_EXTENSION Support Package
*/ */

View File

@@ -45,7 +45,7 @@ extern bd_t bsp_uboot_board_info;
/** /**
* @defgroup shared_uboot U_BOOT Support * @defgroup shared_uboot U_BOOT Support
* *
* @ingroup shared_include * @ingroup RTEMSBSPsShared
* *
* @brief U_BOOT Support Package * @brief U_BOOT Support Package
*/ */

View File

@@ -1,9 +1,6 @@
/** /**
* @file * @file
* @ingroup sparc_bsp
* @defgroup amba AMBA
* @ingroup amba * @ingroup amba
* @brief AMBA Plug &Play routines
*/ */
/* /*
@@ -18,6 +15,16 @@
#ifndef __AMBAPP_H__ #ifndef __AMBAPP_H__
#define __AMBAPP_H__ #define __AMBAPP_H__
/**
* @defgroup amba AMBA
*
* @ingroup RTEMSBSPsSharedGRLIB
*
* @brief AMBA Plug & Play routines
*
* @{
*/
/* Include VENDOR and DEVICE definitions */ /* Include VENDOR and DEVICE definitions */
#include "ambapp_ids.h" #include "ambapp_ids.h"
@@ -373,4 +380,6 @@ extern int ambapp_get_number_apbslv_devices(
} }
#endif #endif
/** @} */
#endif #endif

View File

@@ -1,9 +1,6 @@
/** /**
* @file * @file
* @ingroup sparc_bsp
* @defgroup uart UART
* @ingroup uart * @ingroup uart
* @brief Driver interface for APBUART
*/ */
/* /*
@@ -19,6 +16,16 @@
#ifndef __APBUART_H__ #ifndef __APBUART_H__
#define __APBUART_H__ #define __APBUART_H__
/**
* @defgroup uart UART
*
* @ingroup RTEMSBSPsSharedGRLIB
*
* @brief Driver interface for APBUART
*
* @{
*/
#include "ambapp.h" #include "ambapp.h"
#include "grlib.h" #include "grlib.h"
@@ -68,4 +75,6 @@ int apbuart_inbyte_nonblocking(struct apbuart_regs *regs);
} }
#endif #endif
/** @} */
#endif /* __APBUART_H__ */ #endif /* __APBUART_H__ */

View File

@@ -1,9 +1,6 @@
/** /**
* @file * @file
* @ingroup sparc_bsp
* @defgroup 1553 B1553BRM
* @ingroup 1553 * @ingroup 1553
* @brief B1553BRM device driver
*/ */
/* /*
@@ -18,6 +15,16 @@
#ifndef __B1553BRM_H__ #ifndef __B1553BRM_H__
#define __B1553BRM_H__ #define __B1553BRM_H__
/**
* @defgroup 1553 B1553BRM
*
* @ingroup RTEMSBSPsSharedGRLIB
*
* @brief B1553BRM device driver
*
* @{
*/
#include <drvmgr/drvmgr.h> #include <drvmgr/drvmgr.h>
#ifdef __cplusplus #ifdef __cplusplus
@@ -174,5 +181,7 @@ void b1553brm_print_dev(struct drvmgr_dev *dev, int options);
} }
#endif #endif
/** @} */
#endif /* __BRM_H__ */ #endif /* __BRM_H__ */

View File

@@ -1,9 +1,6 @@
/** /**
* @file * @file
* @ingroup bsp_kit * @ingroup RTEMSBSPsSharedGRLIB
* @defgroup sparc_bsp SPARC
* @ingroup sparc_bsp
* @brief Debug Definitions
*/ */
#ifndef __DEBUG_DEFS_H__ #ifndef __DEBUG_DEFS_H__

View File

@@ -1,9 +1,6 @@
/** /**
* @file * @file
* @ingroup sparc_bsp
* @defgroup can GRCAN
* @ingroup can * @ingroup can
* @brief Macros used for grcan controller
*/ */
/* /*
@@ -18,6 +15,16 @@
#ifndef __GRCAN_H__ #ifndef __GRCAN_H__
#define __GRCAN_H__ #define __GRCAN_H__
/**
* @defgroup can GRCAN
*
* @ingroup RTEMSBSPsSharedGRLIB
*
* @brief Macros used for grcan controller
*
* @{
*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif
@@ -339,4 +346,6 @@ void grcan_register_drv(void);
} }
#endif #endif
/** @} */
#endif #endif

View File

@@ -20,6 +20,14 @@
extern "C" { extern "C" {
#endif #endif
/**
* @defgroup RTEMSBSPsSharedGRLIB GRLIB
*
* @ingroup RTEMSBSPsShared
*
* @brief Driver support for GRLIB IP Library.
*/
/* ESA MEMORY CONTROLLER */ /* ESA MEMORY CONTROLLER */
struct mctrl_regs { struct mctrl_regs {
unsigned int mcfg1; unsigned int mcfg1;

View File

@@ -1,9 +1,6 @@
/** /**
* @file * @file
* @ingroup sparc_bsp
* @defgroup spw SpaceWire
* @ingroup spw * @ingroup spw
* @brief GRSPW Device Driver
*/ */
/* /*
@@ -18,6 +15,16 @@
#ifndef __GRSPW_H__ #ifndef __GRSPW_H__
#define __GRSPW_H__ #define __GRSPW_H__
/**
* @defgroup spw SpaceWire
*
* @ingroup RTEMSBSPsSharedGRLIB
*
* @brief GRSPW Device Driver
*
* @{
*/
#include <grlib/ambapp.h> #include <grlib/ambapp.h>
#ifdef __cplusplus #ifdef __cplusplus
@@ -165,4 +172,6 @@ extern void (*grspw_timecode_callback)
} }
#endif #endif
/** @} */
#endif /* __GRSPW_H__ */ #endif /* __GRSPW_H__ */

View File

@@ -1,9 +1,6 @@
/** /**
* @file * @file
* @ingroup sparc_bsp
* @defgroup i2c I2C-master
* @ingroup i2c * @ingroup i2c
* @brief Driver for GRLIB port of OpenCores I2C-master
*/ */
/* /*
@@ -18,6 +15,16 @@
#ifndef _I2CMST_H #ifndef _I2CMST_H
#define _I2CMST_H #define _I2CMST_H
/**
* @defgroup i2c I2C-master
*
* @ingroup RTEMSBSPsSharedGRLIB
*
* @brief Driver for GRLIB port of OpenCores I2C-master
*
* @{
*/
#include <rtems/libi2c.h> #include <rtems/libi2c.h>
#include "ambapp.h" #include "ambapp.h"
@@ -62,4 +69,6 @@ void i2cmst_register_drv (void);
} }
#endif #endif
/** @} */
#endif /* _I2CMST_H */ #endif /* _I2CMST_H */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_ac97 lm32_milkymist_shared * @ingroup lm32_milkymist_ac97 RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist AC97 driver * @brief Milkymist AC97 driver
*/ */
@@ -17,7 +17,7 @@
/** /**
* @defgroup lm32_milkymist_ac97 Milkymist AC97 * @defgroup lm32_milkymist_ac97 Milkymist AC97
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist AC97 driver * @brief Milkymist AC97 driver
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_buttons lm32_milkymist_shared * @ingroup lm32_milkymist_buttons RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist buttons driver * @brief Milkymist buttons driver
*/ */
@@ -17,7 +17,7 @@
/** /**
* @defgroup lm32_milkymist_buttons Milkymist buttons * @defgroup lm32_milkymist_buttons Milkymist buttons
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist buttons driver * @brief Milkymist buttons driver
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_dmx lm32_milkymist_shared * @ingroup lm32_milkymist_dmx RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist DMX512 driver * @brief Milkymist DMX512 driver
*/ */
@@ -17,7 +17,7 @@
/** /**
* @defgroup lm32_milkymist_dmx Milkymist DMX512 * @defgroup lm32_milkymist_dmx Milkymist DMX512
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist DMX512 driver * @brief Milkymist DMX512 driver
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_flash lm32_milkymist_shared * @ingroup lm32_milkymist_flash RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist Flash * @brief Milkymist Flash
*/ */
@@ -16,7 +16,7 @@
/** /**
* @defgroup lm32_milkymist_flash Milkymist Flash * @defgroup lm32_milkymist_flash Milkymist Flash
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist Flash * @brief Milkymist Flash
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_gpio lm32_milkymist_shared * @ingroup lm32_milkymist_gpio RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist GPIO driver * @brief Milkymist GPIO driver
*/ */
@@ -17,7 +17,7 @@
/** /**
* @defgroup lm32_milkymist_gpio Milkymist GPIO * @defgroup lm32_milkymist_gpio Milkymist GPIO
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist GPIO driver * @brief Milkymist GPIO driver
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_ir lm32_milkymist_shared * @ingroup lm32_milkymist_ir RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist RC5 IR driver * @brief Milkymist RC5 IR driver
*/ */
@@ -17,7 +17,7 @@
/** /**
* @defgroup lm32_milkymist_ir Milkymist IR * @defgroup lm32_milkymist_ir Milkymist IR
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist RC5 IR driver * @brief Milkymist RC5 IR driver
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_memcard lm32_milkymist_shared * @ingroup lm32_milkymist_memcard RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist memory card driver * @brief Milkymist memory card driver
*/ */
@@ -17,7 +17,7 @@
/** /**
* @defgroup lm32_milkymist_memcard Milkymist memory card * @defgroup lm32_milkymist_memcard Milkymist memory card
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist memory card driver * @brief Milkymist memory card driver
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_midi lm32_milkymist_shared * @ingroup lm32_milkymist_midi RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist MIDI driver * @brief Milkymist MIDI driver
*/ */
@@ -17,7 +17,7 @@
/** /**
* @defgroup lm32_milkymist_midi Milkymist MIDI * @defgroup lm32_milkymist_midi Milkymist MIDI
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist MIDI driver * @brief Milkymist MIDI driver
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_pfpu lm32_milkymist_shared * @ingroup lm32_milkymist_pfpu RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist PFPU driver * @brief Milkymist PFPU driver
*/ */
@@ -17,7 +17,7 @@
/** /**
* @defgroup lm32_milkymist_pfpu Milkymist PFPU * @defgroup lm32_milkymist_pfpu Milkymist PFPU
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist PFPU driver * @brief Milkymist PFPU driver
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_tmu lm32_milkymist_shared * @ingroup lm32_milkymist_tmu RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist TMU driver * @brief Milkymist TMU driver
*/ */
@@ -17,7 +17,7 @@
/** /**
* @defgroup lm32_milkymist_tmu Milkymist TMU * @defgroup lm32_milkymist_tmu Milkymist TMU
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist TMU driver * @brief Milkymist TMU driver
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_usbinput lm32_milkymist_shared * @ingroup lm32_milkymist_usbinput RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist USB input devices driver * @brief Milkymist USB input devices driver
*/ */
@@ -17,7 +17,7 @@
/** /**
* @defgroup lm32_milkymist_usbinput Milkymist USB input devices * @defgroup lm32_milkymist_usbinput Milkymist USB input devices
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist USB input devices driver * @brief Milkymist USB input devices driver
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_versions lm32_milkymist_shared * @ingroup lm32_milkymist_versions RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist versioning driver * @brief Milkymist versioning driver
*/ */
@@ -17,7 +17,7 @@
/** /**
* @defgroup lm32_milkymist_versions Milkymist versioning * @defgroup lm32_milkymist_versions Milkymist versioning
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist versioning driver * @brief Milkymist versioning driver
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_video lm32_milkymist_shared * @ingroup lm32_milkymist_video RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist video input driver * @brief Milkymist video input driver
*/ */
@@ -17,7 +17,7 @@
/** /**
* @defgroup lm32_milkymist_video Milkymist Video * @defgroup lm32_milkymist_video Milkymist Video
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist video input driver * @brief Milkymist video input driver
* @{ * @{
*/ */

View File

@@ -20,7 +20,7 @@
/** /**
* @defgroup lm32_clock LM32 Clock * @defgroup lm32_clock LM32 Clock
* @ingroup lm32_shared * @ingroup RTEMSBSPsLM32Shared
* @brief LatticeMico32 Timer (Clock) definitions. * @brief LatticeMico32 Timer (Clock) definitions.
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_shared lm32_uart * @ingroup RTEMSBSPsLM32Shared lm32_uart
* @brief LatticeMico32 UART definitions * @brief LatticeMico32 UART definitions
*/ */
@@ -20,7 +20,7 @@
/** /**
* @defgroup lm32_uart LM32 UART * @defgroup lm32_uart LM32 UART
* @ingroup lm32_shared * @ingroup RTEMSBSPsLM32Shared
* @brief LatticeMico32 UART definitions * @brief LatticeMico32 UART definitions
* @{ * @{
*/ */

View File

@@ -6,18 +6,18 @@
* @brief LatticeMicro32 Board Support Packages. * @brief LatticeMicro32 Board Support Packages.
*/ */
/** /**
* @defgroup lm32_shared Lattice Mico32 Shared Modules * @defgroup RTEMSBSPsLM32Shared Shared
* *
* @ingroup RTEMSBSPsLM32 * @ingroup RTEMSBSPsLM32
* *
* @brief Lattice Mico32 Shared Modules * @brief Shared Support for LatticeMicro32 Board Support Packages.
*/ */
/** /**
* @defgroup lm32_milkymist_shared LM32 Milkymist One * @defgroup RTEMSBSPsLM32SharedMilkymistOne Milkymist One
* *
* @ingroup lm32_shared * @ingroup RTEMSBSPsLM32Shared
* *
* @brief Lattice Mico32 Milkymist One * @brief Shared Support for Milkymist One Board Support Packages.
*/ */

View File

@@ -20,7 +20,7 @@
/** /**
* @defgroup lm32_gdb LM32 GDB Interface * @defgroup lm32_gdb LM32 GDB Interface
* @ingroup lm32_shared * @ingroup RTEMSBSPsLM32Shared
* @brief Definition of the interface between the stub and gdb, * @brief Definition of the interface between the stub and gdb,
* @{ * @{
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_clock lm32_milkymist_shared * @ingroup lm32_clock RTEMSBSPsLM32SharedMilkymistOne
* @brief LatticeMico32 Timer (Clock) definitions * @brief LatticeMico32 Timer (Clock) definitions
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_uart lm32_milkymist_shared * @ingroup lm32_uart RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist UART definitions * @brief Milkymist UART definitions
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_usbinput lm32_milkymist_shared * @ingroup lm32_milkymist_usbinput RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist USB input devices driver * @brief Milkymist USB input devices driver
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup lm32_milkymist_network lm32_milkymist_shared * @ingroup lm32_milkymist_network RTEMSBSPsLM32SharedMilkymistOne
* @brief Driver for Minimac ethernet * @brief Driver for Minimac ethernet
*/ */
@@ -18,7 +18,7 @@
/** /**
* @defgroup lm32_milkymist_network Minimac ethernet driver * @defgroup lm32_milkymist_network Minimac ethernet driver
* @ingroup lm32_milkymist_shared * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Driver for Minimac ethernet IP-core of Milkymist SoC * @brief Driver for Minimac ethernet IP-core of Milkymist SoC
* @{ * @{
*/ */

View File

@@ -20,7 +20,7 @@
/** /**
* @defgroup lm32_tsmac LM32 TSMAC * @defgroup lm32_tsmac LM32 TSMAC
* @ingroup lm32_shared * @ingroup RTEMSBSPsLM32Shared
* @brief LatticeMico32 TSMAC (Tri-Speed MAC) definitions. * @brief LatticeMico32 TSMAC (Tri-Speed MAC) definitions.
* @{ * @{
*/ */

View File

@@ -28,9 +28,9 @@ extern "C" {
#endif /* __cplusplus */ #endif /* __cplusplus */
/** /**
* @defgroup bsp_linker Linker Support * @defgroup RTEMSBSPsM68kSharedLinker Linker Support
* *
* @ingroup bsp_kit * @ingroup RTEMSBSPsM68kShared
* *
* @brief Linker support. * @brief Linker support.
* *

View File

@@ -32,7 +32,7 @@ extern "C" {
/** /**
* @defgroup m68k_mvme MVME16X IO Support * @defgroup m68k_mvme MVME16X IO Support
* *
* @ingroup m68k_shared * @ingroup RTEMSBSPsM68kShared
* *
* @brief IO Support Package * @brief IO Support Package
*/ */

View File

@@ -3,13 +3,13 @@
* *
* @ingroup RTEMSBSPs * @ingroup RTEMSBSPs
* *
* @brief Motorola 68000 and NXP ColdFire Board Support Packagess. * @brief Motorola 68000 and NXP ColdFire Board Support Packages.
*/ */
/** /**
* @defgroup m68k_shared M68K Shared Modules * @defgroup RTEMSBSPsM68kShared Shared
* *
* @ingroup RTEMSBSPsM68k * @ingroup RTEMSBSPsM68k
* *
* @brief M68K Shared Modules * @brief Shared Support for Motorola 68000 and NXP ColdFire Board Support Packages.
*/ */

View File

@@ -24,7 +24,7 @@
/** /**
* @defgroup m68k_gdbstub GDB Stub * @defgroup m68k_gdbstub GDB Stub
* *
* @ingroup m68k_shared * @ingroup RTEMSBSPsM68kShared
* *
* @brief GDB Stub interface support * @brief GDB Stub interface support
*/ */

View File

@@ -27,7 +27,7 @@
/** /**
* @defgroup mips_i8259_irq i8259 Chip Support * @defgroup mips_i8259_irq i8259 Chip Support
* @ingroup mips_shared * @ingroup RTEMSBSPsMIPSShared
* @brief i8259 Chip Support * @brief i8259 Chip Support
* @{ * @{
*/ */

View File

@@ -22,7 +22,7 @@
/** /**
* @defgroup mips_regs MIPS Registers * @defgroup mips_regs MIPS Registers
* @ingroup mips_shared * @ingroup RTEMSBSPsMIPSShared
* @brief MIPS Registers * @brief MIPS Registers
* @{ * @{
*/ */

View File

@@ -6,8 +6,10 @@
* @brief MIPS Board Support Packages. * @brief MIPS Board Support Packages.
*/ */
/** /**
* @defgroup mips_shared MIPS Shared Modules * @defgroup RTEMSBSPsMIPSShared Shared
*
* @ingroup RTEMSBSPsMIPS * @ingroup RTEMSBSPsMIPS
* @brief mips Shared Modules *
* @brief Shared Support for MIPS Board Support Packages.
*/ */

View File

@@ -20,7 +20,7 @@
/** /**
* @defgroup mips_gdb GDB Interface * @defgroup mips_gdb GDB Interface
* @ingroup mips_shared * @ingroup RTEMSBSPsMIPSShared
* @brief GDB Interface * @brief GDB Interface
* @{ * @{
*/ */

View File

@@ -53,7 +53,7 @@
/** /**
* @defgroup mips_limits Address Limits * @defgroup mips_limits Address Limits
* @ingroup mips_shared * @ingroup RTEMSBSPsMIPSShared
* @brief Address Limits * @brief Address Limits
*/ */

View File

@@ -53,7 +53,7 @@
/** /**
* @defgroup mips_ops MIPS Opcodes * @defgroup mips_ops MIPS Opcodes
* @ingroup mips_shared * @ingroup RTEMSBSPsMIPSShared
* @brief MIPS Instruction Formats and Opcode Values * @brief MIPS Instruction Formats and Opcode Values
* @{ * @{
*/ */

View File

@@ -6,9 +6,9 @@ extern "C" {
#endif /* __cplusplus */ #endif /* __cplusplus */
/** /**
* @defgroup or1k_linker Linker Support * @defgroup RTEMSBSPsOR1KSharedLinker Linker Support
* *
* @ingroup or1k_shared * @ingroup RTEMSBSPsOR1K
* *
* @brief Linker support. * @brief Linker support.
* *

View File

@@ -30,9 +30,9 @@ extern "C" {
#endif /* __cplusplus */ #endif /* __cplusplus */
/** /**
* @defgroup powerpc_linker Linker Support * @defgroup RTEMSBSPsPowerPCSharedLinker Linker Support
* *
* @ingroup powerpc_shared * @ingroup RTEMSBSPsPowerPCShared
* *
* @brief Linker support. * @brief Linker support.
* *

View File

@@ -30,9 +30,9 @@ extern "C" {
#endif /* __cplusplus */ #endif /* __cplusplus */
/** /**
* @defgroup powerpc_start PowerPC System Start * @defgroup RTEMSBSPsPowerPCSharedStart PowerPC System Start
* *
* @ingroup powerpc_shared * @ingroup RTEMSBSPsPowerPCShared
* *
* @brief PowerPC low level start. * @brief PowerPC low level start.
* *

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup powerpc_shared * @ingroup RTEMSBSPsPowerPCShared
* *
* @brief Header file for tic-tac code. * @brief Header file for tic-tac code.
*/ */

View File

@@ -46,7 +46,7 @@ extern "C" {
/** /**
* @defgroup ppc_exc PowerPC Exceptions * @defgroup ppc_exc PowerPC Exceptions
* *
* @brief XXX * @ingroup RTEMSBSPsPowerPCShared
* *
* @{ * @{
*/ */
@@ -146,7 +146,7 @@ extern "C" {
/** /**
* @defgroup ppc_exc_frame PowerPC Exception Frame * @defgroup ppc_exc_frame PowerPC Exception Frame
* *
* @brief XXX * @ingroup ppc_exc
* *
* @{ * @{
*/ */
@@ -188,7 +188,7 @@ extern "C" {
#ifndef ASM #ifndef ASM
/** /**
* @ingroup ppc_exc_frame * @addtogroup ppc_exc_frame
* *
* @{ * @{
*/ */
@@ -198,7 +198,7 @@ typedef CPU_Exception_frame BSP_Exception_frame;
/** @} */ /** @} */
/** /**
* @ingroup ppc_exc * @addtogroup ppc_exc
* *
* @{ * @{
*/ */

View File

@@ -55,7 +55,9 @@
*/ */
/** /**
* @defgroup shared_vmeuniverse Register definitions * @defgroup shared_vmeuniverse_reg Register definitions
*
* @ingroup shared_vmeuniverse
* *
* @brief all registers contents in PCI space are LITTLE ENDIAN * @brief all registers contents in PCI space are LITTLE ENDIAN
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup powerpc_shared * @ingroup RTEMSBSPsPowerPCShared
* *
* @brief General purpose assembler macros, linker command file support and * @brief General purpose assembler macros, linker command file support and
* some inline functions for direct register access. * some inline functions for direct register access.
@@ -25,7 +25,13 @@
*/ */
/** /**
* @defgroup powerpc_shared Shared PowerPC Code * @defgroup RTEMSBSPsPowerPCSharedUtility PowerPC Utility Module
*
* @ingroup RTEMSBSPsPowerPCShared
*
* @brief PowerPC Utility Module.
*
* @{
*/ */
#ifndef __LIBCPU_POWERPC_UTILITY_H #ifndef __LIBCPU_POWERPC_UTILITY_H
@@ -1006,4 +1012,6 @@ void ShowBATS(void);
} }
#endif #endif
/** @} */
#endif /* __LIBCPU_POWERPC_UTILITY_H */ #endif /* __LIBCPU_POWERPC_UTILITY_H */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* #ingroup powerpc_shared * #ingroup RTEMSBSPsPowerPCShared
* *
* @brief Header file for the Cache Manager PowerPC support. * @brief Header file for the Cache Manager PowerPC support.
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup powerpc_shared * @ingroup RTEMSBSPsPowerPCShared
* *
* @brief Source file for a clock driver. * @brief Source file for a clock driver.
*/ */

View File

@@ -6,10 +6,10 @@
* @brief PowerPC Board Support Packages. * @brief PowerPC Board Support Packages.
*/ */
/** /**
* @defgroup powerpc_shared PowerPC Shared Modules * @defgroup RTEMSBSPsPowerPCShared Shared
* *
* @ingroup bsp_powerpc * @ingroup RTEMSBSPsPowerPC
* *
* @brief PowerPc Shared Modules * @brief Shared Support for PowerPC Board Support Packages.
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup powerpc_shared * @ingroup RTEMSBSPsPowerPCShared
* *
* @brief Code copy implementation. * @brief Code copy implementation.
*/ */

View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup powerpc_shared * @ingroup RTEMSBSPsPowerPCShared
* *
* @brief Source file for tic-tac code. * @brief Source file for tic-tac code.
*/ */

View File

@@ -1,5 +1,7 @@
/** /**
* @defgroup shared_vmeuniverse SHARED VMEUNIVERSE Modules * @defgroup shared_vmeuniverse VME Universe Modules
* *
* @brief SHARED VMEUNIVERSE Modules * @brief VME Universe Modules
*
* @ingroup RTEMSBSPsPowerPCShared
*/ */

View File

@@ -6,9 +6,9 @@ extern "C" {
#endif /* __cplusplus */ #endif /* __cplusplus */
/** /**
* @defgroup riscv_linker Linker Support * @defgroup RTEMSBSPsRISCVSharedLinker Linker Support
* *
* @ingroup riscv_shared * @ingroup RTEMSBSPsRISCVShared
* *
* @brief Linker support. * @brief Linker support.
* *

View File

@@ -5,3 +5,11 @@
* *
* @brief RISC-V Board Support Packages. * @brief RISC-V Board Support Packages.
*/ */
/**
* @defgroup RTEMSBSPsRISCVShared Shared
*
* @ingroup RTEMSBSPsRISCV
*
* @brief Shared Support for RISC-V Board Support Packages.
*/

View File

@@ -12,3 +12,11 @@
* *
* @brief Shared Support for Board Support Packages * @brief Shared Support for Board Support Packages
*/ */
/**
* @defgroup RTEMSBSPsSharedConsole Console Driver Support
*
* @ingroup RTEMSBSPsShared
*
* @brief Console Driver Support for Board Support Packages.
*/

View File

@@ -6,10 +6,10 @@
* @brief SPARC Board Support Packages. * @brief SPARC Board Support Packages.
*/ */
/** /**
* @defgroup sparc_shared SPARC Shared Modules * @defgroup RTEMSBSPsSPARCShared Shared
* *
* @ingroup RTEMSBSPsSPARC * @ingroup RTEMSBSPsSPARC
* *
* @brief SPARC Shared Modules * @brief Shared Support for SPARC Board Support Packages.
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup sparc_bsp * @ingroup RTEMSBSPsSPARCShared
* @brief ERC32/LEON2/LEON3 BSP specific exit handler. * @brief ERC32/LEON2/LEON3 BSP specific exit handler.
*/ */

View File

@@ -1,6 +1,6 @@
/** /**
* @file * @file
* @ingroup sparc_bsp * @ingroup RTEMSBSPsSPARCShared
* @brief ERC32/LEON2 BSP Fatal_halt handler. * @brief ERC32/LEON2 BSP Fatal_halt handler.
* *
* COPYRIGHT (c) 2014. * COPYRIGHT (c) 2014.