summaryrefslogtreecommitdiffstats
path: root/c/src/lib/libbsp/arm/gumstix/include
diff options
context:
space:
mode:
authorDaniel Ramirez <javamonn@gmail.com>2013-12-21 15:36:05 -0600
committerGedare Bloom <gedare@rtems.org>2013-12-22 11:10:01 -0500
commit3d6e1740aec7aff18257d691afd8ef9f6b51acec (patch)
tree46e6cc073b0fb5a090c7fdd84ed475371494d3f3 /c/src/lib/libbsp/arm/gumstix/include
parentrtems: classic api to/from core priority conversions (diff)
downloadrtems-3d6e1740aec7aff18257d691afd8ef9f6b51acec.tar.bz2
gumstix: added new doxygen
Diffstat (limited to 'c/src/lib/libbsp/arm/gumstix/include')
-rw-r--r--c/src/lib/libbsp/arm/gumstix/include/bsp.h21
-rw-r--r--c/src/lib/libbsp/arm/gumstix/include/tm27.h22
2 files changed, 38 insertions, 5 deletions
diff --git a/c/src/lib/libbsp/arm/gumstix/include/bsp.h b/c/src/lib/libbsp/arm/gumstix/include/bsp.h
index 6e18ad4b0f..81152caa21 100644
--- a/c/src/lib/libbsp/arm/gumstix/include/bsp.h
+++ b/c/src/lib/libbsp/arm/gumstix/include/bsp.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup arm_gumstix
+ * @brief Global BSP definitions.
+ */
+
/*
* By Yang Xi <hiyangxi@gmail.com>.
*
@@ -21,21 +27,28 @@ extern "C" {
#include <rtems/clockdrv.h>
#include <libchip/serial.h>
+/**
+ * @defgroup arm_gumstix Gumstix Support
+ * @ingroup bsp_arm
+ * @brief Gumstix support package
+ * @{
+ */
+
#define BSP_FEATURE_IRQ_EXTENSION
#define BSP_HAS_FRAME_BUFFER 1
-/* What is the input clock freq in hertz */
+/** @brief What is the input clock freq in hertz */
#define BSP_MAIN_FREQ 3686400 /* 3.6864 MHz */
#define BSP_SLCK_FREQ 32768 /* 32.768 KHz */
-/* What is the last interrupt */
+/** @brief What is the last interrupt */
#define BSP_MAX_INT AT91RM9200_MAX_INT
console_tbl *BSP_get_uart_from_minor(int minor);
static inline int32_t BSP_get_baud(void) {return 115200;}
-/* How big should the interrupt stack be? */
+/** @brief How big should the interrupt stack be? */
#define CONFIGURE_INTERRUPT_STACK_MEMORY (16 * 1024)
#define ST_PIMR_PIV 33 /* 33 ticks of the 32.768Khz clock ~= 1msec */
@@ -58,6 +71,8 @@ extern int rtems_ne_driver_attach(struct rtems_bsdnet_ifconfig *, int);
#define RTEMS_BSP_NETWORK_DRIVER_ATTACH BSP_NE2000_NETWORK_DRIVER_ATTACH
#endif
+/** @} */
+
#ifdef __cplusplus
}
#endif
diff --git a/c/src/lib/libbsp/arm/gumstix/include/tm27.h b/c/src/lib/libbsp/arm/gumstix/include/tm27.h
index a518e0e639..619db4f8bb 100644
--- a/c/src/lib/libbsp/arm/gumstix/include/tm27.h
+++ b/c/src/lib/libbsp/arm/gumstix/include/tm27.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup gumstix_tm27
+ * @brief tm27 timing test support
+ */
+
/*
* tm27.h
*
@@ -13,8 +19,16 @@
#ifndef __tm27_h
#define __tm27_h
-/*
- * Define the interrupt mechanism for Time Test 27
+/**
+ * @defgroup gumstix_tm27 tm27 Support
+ * @ingroup arm_gumstix
+ * @brief tm27 Timing Test Support
+ * @{
+ */
+
+/**
+ * @name Interrupt mechanisms for Time Test 27
+ * @{
*/
#define MUST_WAIT_FOR_INTERRUPT 0
@@ -27,4 +41,8 @@
#define Lower_tm27_intr() /* empty */
+/** @} */
+
+/** @} */
+
#endif