diff options
| author | Kimplul <kimi.h.kuparinen@gmail.com> | 2022-05-23 23:00:55 +0300 |
|---|---|---|
| committer | Kimplul <kimi.h.kuparinen@gmail.com> | 2022-05-23 23:00:55 +0300 |
| commit | 12be40e22aae582cca9abbd151031edaab800cae (patch) | |
| tree | 9a672c52b26357ba4c5ce07ca93b2d203594f36a /include/arch | |
| parent | b28fd7d9121c63ae6a1737d890414ef8cce177e0 (diff) | |
| download | kmi-12be40e22aae582cca9abbd151031edaab800cae.tar.gz kmi-12be40e22aae582cca9abbd151031edaab800cae.zip | |
start writing documentation
Diffstat (limited to 'include/arch')
| -rw-r--r-- | include/arch/timer.h | 19 |
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 */ |