timer.h

Go to the documentation of this file.

 
#ifndef KERNEL_DEVICES_TIMER_H
#define KERNEL_DEVICES_TIMER_H
 
#include <kernel/time.h>
#include <kernel/types.h>
 
#define HZ CLOCK_PER_SECOND
 
#define SEC_TO_TICKS(_time) SEC((_time) * HZ)
#define MS_TO_TICKS(_time) MS_TO_SEC(SEC_TO_TICKS(_time))
#define US_TO_TICKS(_time) US_TO_SEC(SEC_TO_TICKS(_time))
#define NS_TO_TICKS(_time) NS_TO_SEC(SEC_TO_TICKS(_time))
#define TICKS_TO_SEC(_ticks) SEC((_ticks) / HZ)
#define TICKS_TO_MS(_ticks) MS(TICKS_TO_SEC(_ticks))
#define TICKS_TO_US(_ticks) US(TICKS_TO_SEC(_ticks))
#define TICKS_TO_NS(_ticks) NS(TICKS_TO_SEC(_ticks))
extern volatile clock_t timer_ticks_counter;
 
extern volatile u32 timer_kernel_frequency;
 
void timer_start(u32 frequency);
 
static inline clock_t timer_gettick(void)
{
    return timer_ticks_counter;
}
 
static inline bool timer_tick(void)
{
    clock_t old_ticks = timer_ticks_counter;
    timer_ticks_counter += 1;
    return old_ticks > timer_ticks_counter;
}
 
static inline time_t timer_get_ms(void)
{
    return TICKS_TO_MS(timer_gettick());
}
 
static inline time_t timer_get_us(void)
{
    return TICKS_TO_US(timer_gettick());
}
 
static inline time_t timer_get_ns(void)
{
    return TICKS_TO_NS(timer_gettick());
}
 
static inline void clock_get_time(struct timespec *time)
{
    time_t ns = timer_get_ns();
 
    time->tv_sec = NS_TO_SEC(ns);
    time->tv_nsec = ns % NS(1);
}
 
void timer_wait_ms(time_t);
 
/*
 * Wait for a certain amount of time.
 * Can be used in a non-preemptible context.
 *
 * TODO: Make it safe to call in an un-interruptible
 *       context by computing the timing of a for loop
 *       and using this instead.
 */
void timer_delay_ms(time_t);
 
#endif /* KERNEL_DEVICES_TIMER_H */