From 12be40e22aae582cca9abbd151031edaab800cae Mon Sep 17 00:00:00 2001 From: Kimplul Date: Mon, 23 May 2022 23:00:55 +0300 Subject: start writing documentation --- include/arch/timer.h | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) (limited to 'include/arch') 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 */ -- cgit v1.3