summaryrefslogtreecommitdiffstats
path: root/bsps/sparc
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2019-03-04 15:32:15 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2019-03-08 07:42:54 +0100
commitc991eeeccc21901011ddd9ecc626c4d164fe2041 (patch)
treed853f9d374984a213398d96927e76ec55ee546df /bsps/sparc
parentshell: Correct argument order of `mfill` (diff)
downloadrtems-c991eeeccc21901011ddd9ecc626c4d164fe2041.tar.bz2
bsps: Adjust bsp.h Doxygen groups
Update #3706.
Diffstat (limited to 'bsps/sparc')
-rw-r--r--bsps/sparc/erc32/include/bsp.h24
-rw-r--r--bsps/sparc/leon2/btimer/btimer.c2
-rw-r--r--bsps/sparc/leon2/clock/ckinit.c2
-rw-r--r--bsps/sparc/leon2/console/console.c2
-rw-r--r--bsps/sparc/leon2/console/debugputs.c2
-rw-r--r--bsps/sparc/leon2/gnatsupp/gnatsupp.c2
-rw-r--r--bsps/sparc/leon2/include/bsp.h13
-rw-r--r--bsps/sparc/leon2/include/bsp/irq.h2
-rw-r--r--bsps/sparc/leon2/include/leon.h7
-rw-r--r--bsps/sparc/leon2/include/tm27.h2
-rw-r--r--bsps/sparc/leon2/net/leon_open_eth.c2
-rw-r--r--bsps/sparc/leon2/net/leon_smc91111.c2
-rw-r--r--bsps/sparc/leon2/start/bspdelay.c2
-rw-r--r--bsps/sparc/leon2/start/bspidle.c2
-rw-r--r--bsps/sparc/leon2/start/bspstart.c2
-rw-r--r--bsps/sparc/leon2/start/setvec.c2
-rw-r--r--bsps/sparc/leon2/start/spurious.c2
-rw-r--r--bsps/sparc/leon3/include/amba.h19
-rw-r--r--bsps/sparc/leon3/include/bsp.h13
19 files changed, 62 insertions, 42 deletions
diff --git a/bsps/sparc/erc32/include/bsp.h b/bsps/sparc/erc32/include/bsp.h
index 2941db0be4..6347c58da3 100644
--- a/bsps/sparc/erc32/include/bsp.h
+++ b/bsps/sparc/erc32/include/bsp.h
@@ -1,9 +1,9 @@
/**
* @file
*
- * @ingroup sparc_erc32
+ * @ingroup RTEMSBSPsSPARCERC32
*
- * @brief Global BSP Definitions.
+ * @brief Global BSP definitions.
*/
/*
@@ -25,6 +25,16 @@
#ifndef LIBBSP_SPARC_ERC32_BSP_H
#define LIBBSP_SPARC_ERC32_BSP_H
+/**
+ * @defgroup RTEMSBSPsSPARCERC32 ERC32
+ *
+ * @ingroup RTEMSBSPsSPARC
+ *
+ * @brief ERC32 Board Support Package.
+ *
+ * @{
+ */
+
#include <bspopts.h>
#include <bsp/default-initial-extension.h>
@@ -36,14 +46,6 @@
extern "C" {
#endif
-/**
- * @defgroup sparc_erc32 ERC32 Support
- *
- * @ingroup RTEMSBSPsSPARC
- *
- * @brief ERC32 Support Package
- */
-
/*
* BSP provides its own Idle thread body
*/
@@ -181,4 +183,6 @@ int console_inbyte_nonblocking(int port);
}
#endif
+/** @} */
+
#endif
diff --git a/bsps/sparc/leon2/btimer/btimer.c b/bsps/sparc/leon2/btimer/btimer.c
index de115c965a..352821e05b 100644
--- a/bsps/sparc/leon2/btimer/btimer.c
+++ b/bsps/sparc/leon2/btimer/btimer.c
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
* @brief Implement a benchmark timer using timer 2
*/
diff --git a/bsps/sparc/leon2/clock/ckinit.c b/bsps/sparc/leon2/clock/ckinit.c
index 2707c7daa2..ba97894861 100644
--- a/bsps/sparc/leon2/clock/ckinit.c
+++ b/bsps/sparc/leon2/clock/ckinit.c
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
* @brief Clock Tick Device Driver
*
* This routine initializes LEON timer 1 which used for the clock tick.
diff --git a/bsps/sparc/leon2/console/console.c b/bsps/sparc/leon2/console/console.c
index 4e8a42afc5..579792a06a 100644
--- a/bsps/sparc/leon2/console/console.c
+++ b/bsps/sparc/leon2/console/console.c
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
* @brief TTY driver driver for the serial ports on the LEON console
*
* This file contains the TTY driver for the serial ports on the LEON.
diff --git a/bsps/sparc/leon2/console/debugputs.c b/bsps/sparc/leon2/console/debugputs.c
index 87567b00b5..0694be2af4 100644
--- a/bsps/sparc/leon2/console/debugputs.c
+++ b/bsps/sparc/leon2/console/debugputs.c
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
* @brief TTY driver for the serial ports on the LEON
*/
diff --git a/bsps/sparc/leon2/gnatsupp/gnatsupp.c b/bsps/sparc/leon2/gnatsupp/gnatsupp.c
index 1df950039a..d1745535ec 100644
--- a/bsps/sparc/leon2/gnatsupp/gnatsupp.c
+++ b/bsps/sparc/leon2/gnatsupp/gnatsupp.c
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
*
* @brief Support for gnat/rtems iterrupts and exception handling
*/
diff --git a/bsps/sparc/leon2/include/bsp.h b/bsps/sparc/leon2/include/bsp.h
index 82f7728ff9..5fe39d09d2 100644
--- a/bsps/sparc/leon2/include/bsp.h
+++ b/bsps/sparc/leon2/include/bsp.h
@@ -1,9 +1,9 @@
/**
* @file
*
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
*
- * @brief Global BSP Definitions.
+ * @brief Global BSP definitions.
*/
/* bsp.h
@@ -40,12 +40,13 @@ extern "C" {
#endif
/**
- * @defgroup sparc_leon2 LEON2 Support
+ * @defgroup RTEMSBSPsSPARCLEON2 LEON2
*
- * @ingroup RTEMSBSPsSPARC
+ * @ingroup RTEMSBSPsSPARC
*
- * @brief LEON2 Support Package
+ * @brief LEON2 Board Support Package.
*
+ * @{
*/
/* SPARC CPU variant: LEON2 */
@@ -221,4 +222,6 @@ int console_inbyte_nonblocking( int port );
}
#endif
+/** @} */
+
#endif
diff --git a/bsps/sparc/leon2/include/bsp/irq.h b/bsps/sparc/leon2/include/bsp/irq.h
index 086bf253c4..169f3cb598 100644
--- a/bsps/sparc/leon2/include/bsp/irq.h
+++ b/bsps/sparc/leon2/include/bsp/irq.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
* @brief Interrupts definitions
*
* Based on libbsp/shared/include/irq.h.
diff --git a/bsps/sparc/leon2/include/leon.h b/bsps/sparc/leon2/include/leon.h
index 7ec6b1dcf9..2b3379f713 100644
--- a/bsps/sparc/leon2/include/leon.h
+++ b/bsps/sparc/leon2/include/leon.h
@@ -1,10 +1,7 @@
/**
- * @defgroup leon1 Leon-1 Handler
- * @ingroup sparc_leon2
- *
* @file
- * @ingroup leon1
- * @brief Handlers Leon-1
+ *
+ * @ingroup RTEMSBSPsSPARCLEON2
*
* This include file contains information pertaining to the LEON-1.
* The LEON-1 is a custom SPARC V7 implementation.
diff --git a/bsps/sparc/leon2/include/tm27.h b/bsps/sparc/leon2/include/tm27.h
index 0d28641b9b..7b1afe96af 100644
--- a/bsps/sparc/leon2/include/tm27.h
+++ b/bsps/sparc/leon2/include/tm27.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
* @brief Implementations for interrupt mechanisms for Time Test 27
*/
diff --git a/bsps/sparc/leon2/net/leon_open_eth.c b/bsps/sparc/leon2/net/leon_open_eth.c
index 326850e248..7191e378e9 100644
--- a/bsps/sparc/leon2/net/leon_open_eth.c
+++ b/bsps/sparc/leon2/net/leon_open_eth.c
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
* @brief LEON2 Opencores Ethernet MAC Configuration Information
*/
diff --git a/bsps/sparc/leon2/net/leon_smc91111.c b/bsps/sparc/leon2/net/leon_smc91111.c
index 68c359edda..cf0f81fd01 100644
--- a/bsps/sparc/leon2/net/leon_smc91111.c
+++ b/bsps/sparc/leon2/net/leon_smc91111.c
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
* @brief SMC91111 Driver
*/
diff --git a/bsps/sparc/leon2/start/bspdelay.c b/bsps/sparc/leon2/start/bspdelay.c
index 5ee8123157..fe64929228 100644
--- a/bsps/sparc/leon2/start/bspdelay.c
+++ b/bsps/sparc/leon2/start/bspdelay.c
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
* @brief LEON2 BSP Delay Method
*/
diff --git a/bsps/sparc/leon2/start/bspidle.c b/bsps/sparc/leon2/start/bspidle.c
index 8f11f66fb1..0e44b459c9 100644
--- a/bsps/sparc/leon2/start/bspidle.c
+++ b/bsps/sparc/leon2/start/bspidle.c
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
* @brief LEON2 Idle Thread
*/
diff --git a/bsps/sparc/leon2/start/bspstart.c b/bsps/sparc/leon2/start/bspstart.c
index f2ed8ae16c..e3b9141bf5 100644
--- a/bsps/sparc/leon2/start/bspstart.c
+++ b/bsps/sparc/leon2/start/bspstart.c
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
* @brief LEON2 Cache Snooping Support
*/
diff --git a/bsps/sparc/leon2/start/setvec.c b/bsps/sparc/leon2/start/setvec.c
index e2d839c2e4..3e4120611d 100644
--- a/bsps/sparc/leon2/start/setvec.c
+++ b/bsps/sparc/leon2/start/setvec.c
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
* @brief Installs an interrupt vector on the SPARC simulator
*/
diff --git a/bsps/sparc/leon2/start/spurious.c b/bsps/sparc/leon2/start/spurious.c
index 971c3cd44b..0d5fb1631c 100644
--- a/bsps/sparc/leon2/start/spurious.c
+++ b/bsps/sparc/leon2/start/spurious.c
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_leon2
+ * @ingroup RTEMSBSPsSPARCLEON2
* @brief LEON Spurious Trap Handler
*/
diff --git a/bsps/sparc/leon3/include/amba.h b/bsps/sparc/leon3/include/amba.h
index 2d11096034..c41c70a5a7 100644
--- a/bsps/sparc/leon3/include/amba.h
+++ b/bsps/sparc/leon3/include/amba.h
@@ -1,8 +1,7 @@
/**
* @file
- * @defgroup amba AMBA Driver Handler
- * @ingroup sparc_leon3
- * @brief AMBA Plag & Play Bus Driver Macros
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3AMBA
*/
/*
@@ -21,6 +20,18 @@
#ifndef __AMBA_H__
#define __AMBA_H__
+/**
+ * @defgroup RTEMSBSPsSPARCLEON3AMBA LEON3 AMBA Driver Handler
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @ingroup RTEMSBSPsSharedGRLIB
+ *
+ * @brief AMBA Plag & Play Bus Driver Macros
+ *
+ * @{
+ */
+
#define LEON3_IO_AREA 0xfff00000
#define LEON3_CONF_AREA 0xff000
#define LEON3_AHB_SLAVE_CONF_AREA (1 << 11)
@@ -45,4 +56,6 @@ extern struct ambapp_bus ambapp_plb;
}
#endif
+/** @} */
+
#endif /* __AMBA_H__ */
diff --git a/bsps/sparc/leon3/include/bsp.h b/bsps/sparc/leon3/include/bsp.h
index c35e537d0a..100dd9624c 100644
--- a/bsps/sparc/leon3/include/bsp.h
+++ b/bsps/sparc/leon3/include/bsp.h
@@ -1,9 +1,9 @@
/**
* @file
*
- * @ingroup sparc_leon3
+ * @ingroup RTEMSBSPsSPARCLEON3
*
- * @brief Global BSP Definitions.
+ * @brief Global BSP definitions.
*/
/* bsp.h
@@ -40,12 +40,13 @@ extern "C" {
#endif
/**
- * @defgroup sparc_leon3 LEON3 Support
+ * @defgroup RTEMSBSPsSPARCLEON3 LEON3 and LEON4
*
- * @ingroup RTEMSBSPsSPARC
+ * @ingroup RTEMSBSPsSPARC
*
- * @brief LEON3 support package
+ * @brief LEON3 and LEON4 Board Support Package.
*
+ * @{
*/
/* SPARC CPU variant: LEON3 */
@@ -247,4 +248,6 @@ extern const unsigned char LEON3_irq_to_cpu[32];
}
#endif
+/** @} */
+
#endif