summaryrefslogtreecommitdiffstats
path: root/c/src/lib/libbsp/lm32/shared/milkymist_pfpu/milkymist_pfpu.h
diff options
context:
space:
mode:
authorChirayu Desai <cdesai@cyanogenmod.org>2013-12-23 22:14:42 +0530
committerGedare Bloom <gedare@rtems.org>2013-12-23 12:21:32 -0500
commitc541862e73534b12892b8242a72f77faaebd8ac3 (patch)
tree4c7c1ee77e1888f8eeb024de5d214bf2d21f41e2 /c/src/lib/libbsp/lm32/shared/milkymist_pfpu/milkymist_pfpu.h
parentarm_stm32f4: added new doxygen (diff)
downloadrtems-c541862e73534b12892b8242a72f77faaebd8ac3.tar.bz2
lm32: Add doxygen
Diffstat (limited to '')
-rw-r--r--c/src/lib/libbsp/lm32/shared/milkymist_pfpu/milkymist_pfpu.h21
1 files changed, 19 insertions, 2 deletions
diff --git a/c/src/lib/libbsp/lm32/shared/milkymist_pfpu/milkymist_pfpu.h b/c/src/lib/libbsp/lm32/shared/milkymist_pfpu/milkymist_pfpu.h
index dc6991ff19..dfa6c61aa7 100644
--- a/c/src/lib/libbsp/lm32/shared/milkymist_pfpu/milkymist_pfpu.h
+++ b/c/src/lib/libbsp/lm32/shared/milkymist_pfpu/milkymist_pfpu.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_pfpu lm32_milkymist_shared
+ * @brief Milkymist PFPU driver
+ */
+
/* milkymist_pfpu.h
*
* Milkymist PFPU driver for RTEMS
@@ -9,6 +15,13 @@
* COPYRIGHT (c) 2010 Sebastien Bourdeauducq
*/
+/**
+ * @defgroup lm32_milkymist_pfpu Milkymist PFPU
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist PFPU driver
+ * @{
+ */
+
#ifndef __MILKYMIST_PFPU_H_
#define __MILKYMIST_PFPU_H_
@@ -29,8 +42,10 @@ struct pfpu_td {
unsigned int *program;
unsigned int progsize;
float *registers;
- bool update; /* < shall we update the "registers" array after completion */
- bool invalidate; /* < shall we invalidate L1 data cache after completion */
+ /** @brief shall we update the "registers" array after completion */
+ bool update;
+ /** @brief shall we invalidate L1 data cache after completion */
+ bool invalidate;
};
rtems_device_driver pfpu_initialize(
@@ -48,6 +63,8 @@ rtems_device_driver pfpu_control(
#define PFPU_DRIVER_TABLE_ENTRY {pfpu_initialize, \
NULL, NULL, NULL, NULL, pfpu_control}
+/** @} */
+
#ifdef __cplusplus
}
#endif