summaryrefslogtreecommitdiffstats
path: root/c/src/lib/libbsp/arm/raspberrypi/include
diff options
context:
space:
mode:
authorDaniel Ramirez <javamonn@gmail.com>2013-11-25 18:14:28 -0600
committerGedare Bloom <gedare@rtems.org>2013-11-27 09:53:52 -0500
commit98eb7e78b6f57b2085d415038d2045f13ed9521f (patch)
treedf282123fed1b6c5e58da73d4f0ce6e6f3dffda2 /c/src/lib/libbsp/arm/raspberrypi/include
parentnios2: Typos (diff)
downloadrtems-98eb7e78b6f57b2085d415038d2045f13ed9521f.tar.bz2
raspberrypi doxygen refactoring
Diffstat (limited to 'c/src/lib/libbsp/arm/raspberrypi/include')
-rw-r--r--c/src/lib/libbsp/arm/raspberrypi/include/bsp.h9
-rw-r--r--c/src/lib/libbsp/arm/raspberrypi/include/irq.h12
-rw-r--r--c/src/lib/libbsp/arm/raspberrypi/include/mmu.h2
-rw-r--r--c/src/lib/libbsp/arm/raspberrypi/include/raspberrypi.h14
-rw-r--r--c/src/lib/libbsp/arm/raspberrypi/include/usart.h17
5 files changed, 47 insertions, 7 deletions
diff --git a/c/src/lib/libbsp/arm/raspberrypi/include/bsp.h b/c/src/lib/libbsp/arm/raspberrypi/include/bsp.h
index cb34bd3331..fa8c016674 100644
--- a/c/src/lib/libbsp/arm/raspberrypi/include/bsp.h
+++ b/c/src/lib/libbsp/arm/raspberrypi/include/bsp.h
@@ -36,3 +36,12 @@ extern "C" {
#endif /* __cplusplus */
#endif /* LIBBSP_ARM_RASPBERRYPI_BSP_H */
+
+/**
+ * @defgroup arm_raspberrypi Raspberry Pi Support
+ *
+ * @ingroup bsp_arm
+ *
+ * @brief Raspberry Pi support package
+ *
+ */
diff --git a/c/src/lib/libbsp/arm/raspberrypi/include/irq.h b/c/src/lib/libbsp/arm/raspberrypi/include/irq.h
index 0e3769c07f..32b74b26ec 100644
--- a/c/src/lib/libbsp/arm/raspberrypi/include/irq.h
+++ b/c/src/lib/libbsp/arm/raspberrypi/include/irq.h
@@ -1,12 +1,12 @@
/**
* @file
*
- * @ingroup bsp_interrupt
+ * @ingroup raspberrypi_interrupt
*
* @brief Interrupt definitions.
*/
-/*
+/**
* Copyright (c) 2013 Alan Cudmore
*
* The license and distribution terms for this file may be
@@ -25,6 +25,14 @@
#include <rtems/irq.h>
#include <rtems/irq-extension.h>
+/**
+ * @defgroup raspberrypi_interrupt Interrrupt Support
+ *
+ * @ingroup arm_raspberrypi
+ *
+ * @brief Interrupt support.
+ */
+
#define BCM2835_INTC_TOTAL_IRQ 64 + 8
diff --git a/c/src/lib/libbsp/arm/raspberrypi/include/mmu.h b/c/src/lib/libbsp/arm/raspberrypi/include/mmu.h
index 50e9180dcc..755ae25f99 100644
--- a/c/src/lib/libbsp/arm/raspberrypi/include/mmu.h
+++ b/c/src/lib/libbsp/arm/raspberrypi/include/mmu.h
@@ -35,7 +35,7 @@ extern "C" {
/**
* @defgroup raspberrypi_mmu MMU Support
*
- * @ingroup raspberrypi
+ * @ingroup arm_raspberrypi
*
* @brief MMU support.
*
diff --git a/c/src/lib/libbsp/arm/raspberrypi/include/raspberrypi.h b/c/src/lib/libbsp/arm/raspberrypi/include/raspberrypi.h
index 44a105ad4b..f806a53f07 100644
--- a/c/src/lib/libbsp/arm/raspberrypi/include/raspberrypi.h
+++ b/c/src/lib/libbsp/arm/raspberrypi/include/raspberrypi.h
@@ -1,7 +1,13 @@
-/*
- * raspberrypi.h
+/**
+ * @file
*
+ * @ingroup raspberrypi_reg
+ *
+ * @brief Register definitions.
+ */
+
+/*
* Copyright (c) 2013 Alan Cudmore.
*
* The license and distribution terms for this file may be
@@ -20,9 +26,9 @@
/**
* @defgroup raspberrypi_reg Register Definitions
*
- * @ingroup raspberrypi
+ * @ingroup arm_raspberrypi
*
- * @brief Register definitions.
+ * @brief Register Definitions
*
* @{
*/
diff --git a/c/src/lib/libbsp/arm/raspberrypi/include/usart.h b/c/src/lib/libbsp/arm/raspberrypi/include/usart.h
index 26b44161da..502320c77a 100644
--- a/c/src/lib/libbsp/arm/raspberrypi/include/usart.h
+++ b/c/src/lib/libbsp/arm/raspberrypi/include/usart.h
@@ -1,3 +1,20 @@
+/**
+ * @file
+ *
+ * @ingroup raspberrypi_usart
+ *
+ * @brief USART support.
+ */
+
+
+/**
+ * @defgroup raspberrypi_usart USART Support
+ *
+ * @ingroup arm_raspberrypi
+ *
+ * @brief Universal Synchronous/Asynchronous Receiver/Transmitter (USART) Support
+ */
+
/*
* Copyright (c) 2013 Alan Cudmore.
*