summaryrefslogtreecommitdiffstats
path: root/bsps/sh
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/sh
parentshell: Correct argument order of `mfill` (diff)
downloadrtems-c991eeeccc21901011ddd9ecc626c4d164fe2041.tar.bz2
bsps: Adjust bsp.h Doxygen groups
Update #3706.
Diffstat (limited to 'bsps/sh')
-rw-r--r--bsps/sh/gensh1/include/bsp.h20
-rw-r--r--bsps/sh/gensh2/include/bsp.h20
-rw-r--r--bsps/sh/gensh4/include/bsp.h20
-rw-r--r--bsps/sh/shsim/include/bsp.h21
4 files changed, 81 insertions, 0 deletions
diff --git a/bsps/sh/gensh1/include/bsp.h b/bsps/sh/gensh1/include/bsp.h
index b70e8382a5..7fe7c3c0c5 100644
--- a/bsps/sh/gensh1/include/bsp.h
+++ b/bsps/sh/gensh1/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSH1
+ *
+ * @brief Global BSP definitions.
+ */
+
/*
* generic sh1
*
@@ -25,6 +33,16 @@
#ifndef LIBBSP_SH_GENSH1_BSP_H
#define LIBBSP_SH_GENSH1_BSP_H
+/**
+ * @defgroup RTEMSBSPsSH1 SH-1
+ *
+ * @ingroup RTEMSBSPsSH
+ *
+ * @brief SH-1 Board Support Package.
+ *
+ * @{
+ */
+
#include <rtems.h>
#include <termios.h> /* for tcflag_t */
@@ -63,4 +81,6 @@ int _sci_get_brparms(
}
#endif
+/** @} */
+
#endif
diff --git a/bsps/sh/gensh2/include/bsp.h b/bsps/sh/gensh2/include/bsp.h
index 38e2c49208..082ea8169a 100644
--- a/bsps/sh/gensh2/include/bsp.h
+++ b/bsps/sh/gensh2/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSH2
+ *
+ * @brief Global BSP definitions.
+ */
+
/*
* generic sh2
*
@@ -36,6 +44,16 @@
#ifndef LIBBSP_SH_GENSH2_BSP_H
#define LIBBSP_SH_GENSH2_BSP_H
+/**
+ * @defgroup RTEMSBSPsSH2 SH-2
+ *
+ * @ingroup RTEMSBSPsSH
+ *
+ * @brief SH-2 Board Support Package.
+ *
+ * @{
+ */
+
#include <rtems.h>
#include <bspopts.h>
@@ -77,4 +95,6 @@ int _sci_get_brparms(
}
#endif
+/** @} */
+
#endif
diff --git a/bsps/sh/gensh4/include/bsp.h b/bsps/sh/gensh4/include/bsp.h
index f29957cfa5..294e8e3ea1 100644
--- a/bsps/sh/gensh4/include/bsp.h
+++ b/bsps/sh/gensh4/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSH4
+ *
+ * @brief Global BSP definitions.
+ */
+
/*
* generic sh4 BSP
*
@@ -40,6 +48,16 @@
#ifndef LIBBSP_SH_GENSH4_BSP_H
#define LIBBSP_SH_GENSH4_BSP_H
+/**
+ * @defgroup RTEMSBSPsSH4 SH-4
+ *
+ * @ingroup RTEMSBSPsSH
+ *
+ * @brief SH-4 Board Support Package.
+ *
+ * @{
+ */
+
#include <rtems.h>
#include <bspopts.h>
#include <bsp/default-initial-extension.h>
@@ -82,4 +100,6 @@ void bsp_cache_on(void);
}
#endif
+/** @} */
+
#endif
diff --git a/bsps/sh/shsim/include/bsp.h b/bsps/sh/shsim/include/bsp.h
index ff63b3849b..80e2f096ea 100644
--- a/bsps/sh/shsim/include/bsp.h
+++ b/bsps/sh/shsim/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSHSim
+ *
+ * @brief Global BSP definitions.
+ */
+
/*
* SH-gdb simulator BSP
*
@@ -24,6 +32,16 @@
#ifndef LIBBSP_SH_SHSIM_BSP_H
#define LIBBSP_SH_SHSIM_BSP_H
+/**
+ * @defgroup RTEMSBSPsSHSim Simulator
+ *
+ * @ingroup RTEMSBSPsSH
+ *
+ * @brief Simulator Board Support Package.
+ *
+ * @{
+ */
+
#ifndef ASM
#include <rtems.h>
@@ -56,4 +74,7 @@ void bsp_hw_init(void);
#endif
#endif /* !ASM */
+
+/** @} */
+
#endif