aboutsummaryrefslogtreecommitdiff
path: root/include/arch/timer.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/arch/timer.h')
-rw-r--r--include/arch/timer.h19
1 files changed, 16 insertions, 3 deletions
diff --git a/include/arch/timer.h b/include/arch/timer.h
index a94fda4..71f878a 100644
--- a/include/arch/timer.h
+++ b/include/arch/timer.h
@@ -15,13 +15,26 @@
#include "../../arch/riscv32/include/timer.h"
#endif
-/* return hardware timer frequency */
+/**
+ * Get hardware timer frequency.
+ *
+ * @return Hardware timer frequency, ticks/sec.
+ */
ticks_t stat_timer();
-/* set up timer interrupt for absolute ticks */
+/**
+ * Set up timer interrupt for absolute ticks.
+ *
+ * @param ticks Time point for timer to trigger.
+ * \todo Should maybe be stat_t?
+ */
void set_timer(ticks_t ticks);
-/* current ticks */
+/**
+ * Get current ticks.
+ *
+ * @return Current tick count.
+ */
ticks_t current_ticks();
#endif /* APOS_ARCH_TIMER_H */