[rtems commit] arm: csb337: Add doxygen
Gedare Bloom
gedare at rtems.org
Mon Dec 9 16:14:43 UTC 2013
Module: rtems
Branch: master
Commit: 583ef3a5b2a5dfc6543ba6bf8e7ca27e7799a535
Changeset: http://git.rtems.org/rtems/commit/?id=583ef3a5b2a5dfc6543ba6bf8e7ca27e7799a535
Author: Chirayu Desai <cdesai at cyanogenmod.org>
Date: Mon Dec 9 21:44:25 2013 +0530
arm: csb337: Add doxygen
---
c/src/lib/libbsp/arm/csb337/console/font8x16.h | 8 ++++++
.../lib/libbsp/arm/csb337/console/sed1356_16bit.h | 9 +++++++
c/src/lib/libbsp/arm/csb337/include/bsp.h | 24 ++++++++++++++++++-
c/src/lib/libbsp/arm/csb337/include/sed1356.h | 8 ++++++
4 files changed, 47 insertions(+), 2 deletions(-)
diff --git a/c/src/lib/libbsp/arm/csb337/console/font8x16.h b/c/src/lib/libbsp/arm/csb337/console/font8x16.h
index 55e280e..12a60e2 100644
--- a/c/src/lib/libbsp/arm/csb337/console/font8x16.h
+++ b/c/src/lib/libbsp/arm/csb337/console/font8x16.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup arm_csb337
+ *
+ * @brief Simple 8 x 16 font, printable characters only.
+ */
+
/*
* font8x16.h
*
diff --git a/c/src/lib/libbsp/arm/csb337/console/sed1356_16bit.h b/c/src/lib/libbsp/arm/csb337/console/sed1356_16bit.h
index 87eebbc..8914fcc 100644
--- a/c/src/lib/libbsp/arm/csb337/console/sed1356_16bit.h
+++ b/c/src/lib/libbsp/arm/csb337/console/sed1356_16bit.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup arm_csb337
+ *
+ * @brief SED1356 LCD/CRT Controllers for KIT637_V6 (CSB637)
+ * 16-Bit access mode
+ */
+
/*
* sed1356.h: SED1356 LCD/CRT Controllers for KIT637_V6 (CSB637)
* 16-Bit access mode
diff --git a/c/src/lib/libbsp/arm/csb337/include/bsp.h b/c/src/lib/libbsp/arm/csb337/include/bsp.h
index 712f1d0..a82e309 100644
--- a/c/src/lib/libbsp/arm/csb337/include/bsp.h
+++ b/c/src/lib/libbsp/arm/csb337/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup arm_csb337
+ *
+ * @brief Global BSP definitions.
+ */
+
/*
* CSB337 BSP header file
*
@@ -23,6 +31,16 @@ extern "C" {
#include <rtems/clockdrv.h>
#include <libchip/serial.h>
+/**
+ * @defgroup arm_csb337 CSB337 Support
+ *
+ * @ingroup bsp_arm
+ *
+ * @brief CSB337 support package.
+ *
+ * @{
+ */
+
#define BSP_FEATURE_IRQ_EXTENSION
/* What is the input clock freq in hertz? */
@@ -37,8 +55,8 @@ static inline int32_t BSP_get_baud(void) {return 38400;}
#define ST_PIMR_PIV 33 /* 33 ticks of the 32.768Khz clock ~= 1msec */
-/*
- * Network driver configuration
+/**
+ * @brief Network driver configuration
*/
extern struct rtems_bsdnet_ifconfig *config;
@@ -47,6 +65,8 @@ int rtems_at91rm9200_emac_attach(struct rtems_bsdnet_ifconfig *config, int attac
#define RTEMS_BSP_NETWORK_DRIVER_NAME "eth0"
#define RTEMS_BSP_NETWORK_DRIVER_ATTACH rtems_at91rm9200_emac_attach
+/** @} */
+
#ifdef __cplusplus
}
#endif
diff --git a/c/src/lib/libbsp/arm/csb337/include/sed1356.h b/c/src/lib/libbsp/arm/csb337/include/sed1356.h
index b53c0ce..0b8ee69 100644
--- a/c/src/lib/libbsp/arm/csb337/include/sed1356.h
+++ b/c/src/lib/libbsp/arm/csb337/include/sed1356.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup arm_csb337
+ *
+ * @brief Public Interface for SED Video Controller Operations.
+ */
+
/*
* Public Interface for SED Video Controller Operations
*
More information about the vc
mailing list