summaryrefslogtreecommitdiffstats
path: root/c/src/lib/libbsp/lm32/shared/clock/clock.h
diff options
context:
space:
mode:
Diffstat (limited to 'c/src/lib/libbsp/lm32/shared/clock/clock.h')
-rw-r--r--c/src/lib/libbsp/lm32/shared/clock/clock.h23
1 files changed, 19 insertions, 4 deletions
diff --git a/c/src/lib/libbsp/lm32/shared/clock/clock.h b/c/src/lib/libbsp/lm32/shared/clock/clock.h
index ee1f63a7be..46f4da8952 100644
--- a/c/src/lib/libbsp/lm32/shared/clock/clock.h
+++ b/c/src/lib/libbsp/lm32/shared/clock/clock.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_clock
+ * @brief LatticeMico32 Timer (Clock) definitions
+ */
+
/*
* This file contains definitions for LatticeMico32 Timer (Clock)
*
@@ -12,16 +18,23 @@
* Micro-Research Finland Oy
*/
+/**
+ * @defgroup lm32_clock LM32 Clock
+ * @ingroup lm32_shared
+ * @brief LatticeMico32 Timer (Clock) definitions.
+ * @{
+ */
+
#ifndef _BSPCLOCK_H
#define _BSPCLOCK_H
-/* Status Register */
+/** @brief Status Register */
#define LM32_CLOCK_SR (0x0000)
#define LM32_CLOCK_SR_TO (0x0001)
#define LM32_CLOCK_SR_RUN (0x0002)
-/* Control Register */
+/** @brief Control Register */
#define LM32_CLOCK_CR (0x0004)
#define LM32_CLOCK_CR_ITO (0x0001)
@@ -29,12 +42,14 @@
#define LM32_CLOCK_CR_START (0x0004)
#define LM32_CLOCK_CR_STOP (0x0008)
-/* Period Register */
+/** @brief Period Register */
#define LM32_CLOCK_PERIOD (0x0008)
-/* Snapshot Register */
+/** @brief Snapshot Register */
#define LM32_CLOCK_SNAPSHOT (0x000C)
#endif /* _BSPCLOCK_H */
+
+/** @} */