Merge branch 'signal-dev'

[lunaix-os.git] / lunaix-os / includes / lunaix / timer.h

diff --git a/lunaix-os/includes/lunaix/timer.h b/lunaix-os/includes/lunaix/timer.h
index 5c406967a150cb1c4950e606be24f96a6e781632..c02d7f6bb49a55b003a8c38a3fdc7d4ed7dd3faf 100644 (file)
--- a/lunaix-os/includes/lunaix/timer.h
+++ b/lunaix-os/includes/lunaix/timer.h
@@ -4,39 +4,66 @@
 #include <lunaix/ds/llist.h>
 #include <stdint.h>
 
-#define SYS_TIMER_FREQUENCY_HZ      2048UL
+#define SYS_TIMER_FREQUENCY_HZ 2048
 
-#define TIMER_MODE_PERIODIC   0x1
+#define TIMER_MODE_PERIODIC 0x1
 
-struct lx_timer_context {
-    struct lx_timer *active_timers;
-    uint32_t base_frequency;
+typedef uint32_t ticks_t;
+
+struct lx_timer_context
+{
+    struct lx_timer* active_timers;
+    /**
+     * @brief APIC timer base frequency (ticks per seconds)
+     *
+     */
+    ticks_t base_frequency;
+    /**
+     * @brief Desired system running frequency
+     *
+     */
     uint32_t running_frequency;
-    uint32_t tick_interval;
+    /**
+     * @brief Ticks per hertz
+     *
+     */
+    ticks_t tphz;
 };
 
-struct lx_timer {
+struct lx_timer
+{
     struct llist_header link;
-    uint32_t deadline;
-    uint32_t counter;
+    ticks_t deadline;
+    ticks_t counter;
     void* payload;
     void (*callback)(void*);
     uint8_t flags;
 };
 
-
 /**
  * @brief Initialize the system timer that runs at specified frequency
- * 
+ *
  * @param frequency The frequency that timer should run in Hz.
  */
 void
 timer_init(uint32_t frequency);
 
-int
-timer_run_second(uint32_t second, void (*callback)(void*), void* payload, uint8_t flags);
+struct lx_timer*
+timer_run_second(uint32_t second,
+                 void (*callback)(void*),
+                 void* payload,
+                 uint8_t flags);
+
+struct lx_timer*
+timer_run_ms(uint32_t millisecond,
+             void (*callback)(void*),
+             void* payload,
+             uint8_t flags);
+
+struct lx_timer*
+timer_run(ticks_t ticks, void (*callback)(void*), void* payload, uint8_t flags);
 
-int
-timer_run(uint32_t ticks, void (*callback)(void*), void* payload, uint8_t flags);
+struct lx_timer_context*
+timer_context();
 
 #endif /* __LUNAIX_TIMER_H */