Mirrors_Framework/rtems
1
0
Fork 0
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2025-12-17 13:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

bsps: Adjust shared Doxygen groups

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

2
bsps/arm/include/bsp/arm-a8core-start.h
View File

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

2
bsps/arm/include/bsp/arm-a9mpcore-irq.h
View File

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

2
bsps/arm/include/bsp/arm-a9mpcore-regs.h
View File

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

2
bsps/arm/include/bsp/arm-a9mpcore-start.h
View File

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

2
bsps/arm/include/bsp/arm-errata.h
View File

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

2
bsps/arm/include/bsp/arm-gic.h
View File

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

2
bsps/arm/include/bsp/arm-pl011-regs.h
View File

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

2
bsps/arm/include/bsp/arm-pl011.h
View File

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

2
bsps/arm/include/bsp/arm-pl050-regs.h
View File

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

2
bsps/arm/include/bsp/arm-pl050.h
View File

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

2
bsps/arm/include/bsp/arm-pl111-fb.h
View File

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

2
bsps/arm/include/bsp/arm-pl111-regs.h
View File

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

2
bsps/arm/include/bsp/arm-release-id.h
View File

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

2
bsps/arm/include/bsp/armv7m-irq.h
View File

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

2
bsps/arm/include/bsp/linker-symbols.h
View File

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

2
bsps/arm/include/bsp/start.h
View File

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

2
bsps/arm/shared/cache/cache-cp15.h vendored
View File

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

2
bsps/arm/shared/cache/cache-l2c-310.c vendored
View File

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

6
bsps/arm/shared/doxygen.h
View File

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

2
bsps/epiphany/include/bsp/linker-symbols.h
View File

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

8
bsps/epiphany/shared/doxygen.h
View File

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

2
bsps/i386/include/bsp/irq.h
View File

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

2
bsps/i386/include/bsp/realmode_int.h
View File

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

2
bsps/i386/include/bsp/smp-imps.h
View File

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

2
bsps/i386/pc386/start/realmode_int.c
View File

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

10
bsps/i386/shared/doxygen.h
View File

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

2
bsps/include/bsp/console-termios.h
View File

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

2
bsps/include/bsp/default-initial-extension.h
View File

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

2
bsps/include/bsp/u-boot.h
View File

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

15
bsps/include/grlib/ambapp.h
View File

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

15
bsps/include/grlib/apbuart.h
View File

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

15
bsps/include/grlib/b1553brm.h
View File

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

5
bsps/include/grlib/debug_defs.h
View File

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

15
bsps/include/grlib/grcan.h
View File

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

8
bsps/include/grlib/grlib.h
View File

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

15
bsps/include/grlib/grspw.h
View File

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

15
bsps/include/grlib/i2cmst.h
View File

@@ -1,9 +1,6 @@
/**
* @file
* @ingroup sparc_bsp
* @defgroup i2c I2C-master
* @ingroup i2c
* @brief Driver for GRLIB port of OpenCores I2C-master
*/
/*
@@ -18,6 +15,16 @@
#ifndef _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 "ambapp.h"
@@ -62,4 +69,6 @@ void i2cmst_register_drv (void);
}
#endif
/** @} */
#endif /* _I2CMST_H */

4
bsps/lm32/include/bsp/milkymist_ac97.h
View File

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

4
bsps/lm32/include/bsp/milkymist_buttons.h
View File

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

4
bsps/lm32/include/bsp/milkymist_dmx.h
View File

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

4
bsps/lm32/include/bsp/milkymist_flash.h
View File

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

4
bsps/lm32/include/bsp/milkymist_gpio.h
View File

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

4
bsps/lm32/include/bsp/milkymist_ir.h
View File

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

4
bsps/lm32/include/bsp/milkymist_memcard.h
View File

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

4
bsps/lm32/include/bsp/milkymist_midi.h
View File

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

4
bsps/lm32/include/bsp/milkymist_pfpu.h
View File

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

4
bsps/lm32/include/bsp/milkymist_tmu.h
View File

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

4
bsps/lm32/include/bsp/milkymist_usbinput.h
View File

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

4
bsps/lm32/include/bsp/milkymist_versions.h
View File

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

4
bsps/lm32/include/bsp/milkymist_video.h
View File

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

Some files were not shown because too many files have changed in this diff Show More