summaryrefslogtreecommitdiffstats
path: root/bsps/include
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2019-03-05 07:58:18 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2019-03-08 07:42:54 +0100
commit828276b0814e519961b30506cad83ebc0065bcbb (patch)
treee93cf668ad005c3122707a40f9a4c0aab77813ba /bsps/include
parentbsps: Adjust bsp.h Doxygen groups (diff)
downloadrtems-828276b0814e519961b30506cad83ebc0065bcbb.tar.bz2
bsps: Adjust shared Doxygen groups
Update #3706.
Diffstat (limited to 'bsps/include')
-rw-r--r--bsps/include/bsp/console-termios.h2
-rw-r--r--bsps/include/bsp/default-initial-extension.h2
-rw-r--r--bsps/include/bsp/u-boot.h2
-rw-r--r--bsps/include/grlib/ambapp.h15
-rw-r--r--bsps/include/grlib/apbuart.h15
-rw-r--r--bsps/include/grlib/b1553brm.h15
-rw-r--r--bsps/include/grlib/debug_defs.h5
-rw-r--r--bsps/include/grlib/grcan.h15
-rw-r--r--bsps/include/grlib/grlib.h8
-rw-r--r--bsps/include/grlib/grspw.h15
-rw-r--r--bsps/include/grlib/i2cmst.h15
11 files changed, 84 insertions, 25 deletions
diff --git a/bsps/include/bsp/console-termios.h b/bsps/include/bsp/console-termios.h
index 413dde4663..31132f45f3 100644
--- a/bsps/include/bsp/console-termios.h
+++ b/bsps/include/bsp/console-termios.h
@@ -24,7 +24,7 @@ extern "C" {
/**
* @defgroup ConsoleTermios Termios Console Driver
*
- * @ingroup TermiostypesSupport
+ * @ingroup RTEMSBSPsSharedConsole
*
* @brief Console driver for Termios devices.
*
diff --git a/bsps/include/bsp/default-initial-extension.h b/bsps/include/bsp/default-initial-extension.h
index 1c795b7278..cdad76edaa 100644
--- a/bsps/include/bsp/default-initial-extension.h
+++ b/bsps/include/bsp/default-initial-extension.h
@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup shared_defaultinitialextension DEFAULT_INITIAL_EXTENSION Support
*
- * @ingroup shared_include
+ * @ingroup RTEMSBSPsShared
*
* @brief DEFAULT_INITIAL_EXTENSION Support Package
*/
diff --git a/bsps/include/bsp/u-boot.h b/bsps/include/bsp/u-boot.h
index 0f567c1850..8bcb1488a4 100644
--- a/bsps/include/bsp/u-boot.h
+++ b/bsps/include/bsp/u-boot.h
@@ -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
*/
diff --git a/bsps/include/grlib/ambapp.h b/bsps/include/grlib/ambapp.h
index 5e5a649f53..6b617ada70 100644
--- a/bsps/include/grlib/ambapp.h
+++ b/bsps/include/grlib/ambapp.h
@@ -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
diff --git a/bsps/include/grlib/apbuart.h b/bsps/include/grlib/apbuart.h
index 6a89bb949a..2b68808ed5 100644
--- a/bsps/include/grlib/apbuart.h
+++ b/bsps/include/grlib/apbuart.h
@@ -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__ */
diff --git a/bsps/include/grlib/b1553brm.h b/bsps/include/grlib/b1553brm.h
index eba0716f75..bb7294de43 100644
--- a/bsps/include/grlib/b1553brm.h
+++ b/bsps/include/grlib/b1553brm.h
@@ -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__ */
diff --git a/bsps/include/grlib/debug_defs.h b/bsps/include/grlib/debug_defs.h
index 58f7460f52..6425bd6f01 100644
--- a/bsps/include/grlib/debug_defs.h
+++ b/bsps/include/grlib/debug_defs.h
@@ -1,9 +1,6 @@
/**
* @file
- * @ingroup bsp_kit
- * @defgroup sparc_bsp SPARC
- * @ingroup sparc_bsp
- * @brief Debug Definitions
+ * @ingroup RTEMSBSPsSharedGRLIB
*/
#ifndef __DEBUG_DEFS_H__
diff --git a/bsps/include/grlib/grcan.h b/bsps/include/grlib/grcan.h
index 5cdbad4b01..b1bc2ba758 100644
--- a/bsps/include/grlib/grcan.h
+++ b/bsps/include/grlib/grcan.h
@@ -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
diff --git a/bsps/include/grlib/grlib.h b/bsps/include/grlib/grlib.h
index a2d0877fb8..fb7085dfc4 100644
--- a/bsps/include/grlib/grlib.h
+++ b/bsps/include/grlib/grlib.h
@@ -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;
diff --git a/bsps/include/grlib/grspw.h b/bsps/include/grlib/grspw.h
index 70a9e0b100..50ca744bde 100644
--- a/bsps/include/grlib/grspw.h
+++ b/bsps/include/grlib/grspw.h
@@ -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__ */
diff --git a/bsps/include/grlib/i2cmst.h b/bsps/include/grlib/i2cmst.h
index a06117f0dc..01dbcf5bfb 100644
--- a/bsps/include/grlib/i2cmst.h
+++ b/bsps/include/grlib/i2cmst.h
@@ -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 */