diff options
author | Chirayu Desai <cdesai@cyanogenmod.org> | 2013-12-09 21:26:25 +0530 |
---|---|---|
committer | Gedare Bloom <gedare@rtems.org> | 2013-12-09 11:21:45 -0500 |
commit | 583ef3a5b2a5dfc6543ba6bf8e7ca27e7799a535 (patch) | |
tree | 47958884475ddb1287d11cfd386f6f07c420c97d | |
parent | cpukit/rtems: Remove XXX in comments (diff) | |
download | rtems-583ef3a5b2a5dfc6543ba6bf8e7ca27e7799a535.tar.bz2 |
arm: csb337: Add doxygen
Diffstat (limited to '')
-rw-r--r-- | c/src/lib/libbsp/arm/csb337/console/font8x16.h | 8 | ||||
-rw-r--r-- | c/src/lib/libbsp/arm/csb337/console/sed1356_16bit.h | 9 | ||||
-rw-r--r-- | c/src/lib/libbsp/arm/csb337/include/bsp.h | 24 | ||||
-rw-r--r-- | 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 55e280e23c..12a60e2836 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 87eebbcfe7..8914fcc2a6 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 712f1d0b5c..a82e309878 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 b53c0ce5d5..0b8ee699b7 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 * |