timer.h

Go to the documentation of this file.

#ifndef DRV_TIMER_H
#define DRV_TIMER_H

#include <cfg/os.h>
#include <cfg/macros.h>

#include <cpu/attr.h>
#include <cpu/irq.h>


/*
 * Include platform-specific binding header if we're hosted.
 * Try the CPU specific one for bare-metal environments.
 */
#if OS_HOSTED
    //#include OS_HEADER(timer)
    #include <emul/timer_posix.h>
#else
    #include CPU_HEADER(timer)
#endif

STATIC_ASSERT(sizeof(hptime_t) == SIZEOF_HPTIME_T);

#include "cfg/cfg_timer.h"
#include <cfg/debug.h>
#include <cfg/compiler.h>

#include <struct/list.h>

/*
 * Sanity check for config parameters required by this module.
 */
#if !defined(CONFIG_TIMER_EVENTS) || ((CONFIG_TIMER_EVENTS != 0) && CONFIG_TIMER_EVENTS != 1)
    #error CONFIG_TIMER_EVENTS must be set to either 0 or 1 in cfg_timer.h
#endif
#if !defined(CONFIG_TIMER_UDELAY) || ((CONFIG_TIMER_UDELAY != 0) && CONFIG_TIMER_EVENTS != 1)
    #error CONFIG_TIMER_UDELAY must be set to either 0 or 1 in cfg_timer.h
#endif
#if defined(CONFIG_TIMER_DISABLE_UDELAY)
    #error Obosolete config option CONFIG_TIMER_DISABLE_UDELAY.  Use CONFIG_TIMER_UDELAY
#endif
#if defined(CONFIG_TIMER_DISABLE_EVENTS)
    #error Obosolete config option CONFIG_TIMER_DISABLE_EVENTS.  Use CONFIG_TIMER_EVENTS
#endif

extern volatile ticks_t _clock;

INLINE ticks_t timer_clock(void)
{
    ticks_t result;

    ATOMIC(result = _clock);

    return result;
}

INLINE ticks_t timer_clock_unlocked(void)
{
    return _clock;
}

INLINE ticks_t ms_to_ticks(mtime_t ms)
{
#if TIMER_TICKS_PER_SEC < 1000
    /* Slow timer: avoid rounding down too much. */
    return (ms * TIMER_TICKS_PER_SEC) / 1000;
#else
    /* Fast timer: don't overflow ticks_t. */
    return ms * DIV_ROUND(TIMER_TICKS_PER_SEC, 1000);
#endif
}

INLINE ticks_t us_to_ticks(utime_t us)
{
#if TIMER_TICKS_PER_SEC < 1000
    /* Slow timer: avoid rounding down too much. */
    return ((us / 1000) * TIMER_TICKS_PER_SEC) / 1000;
#else
    /* Fast timer: don't overflow ticks_t. */
    return (us * DIV_ROUND(TIMER_TICKS_PER_SEC, 1000)) / 1000;
#endif
}

INLINE mtime_t ticks_to_ms(ticks_t ticks)
{
#if TIMER_TICKS_PER_SEC < 1000
    /* Slow timer: avoid rounding down too much. */
    return (ticks * 1000) / TIMER_TICKS_PER_SEC;
#else
    /* Fast timer: avoid overflowing ticks_t. */
    return ticks / (TIMER_TICKS_PER_SEC / 1000);
#endif
}

INLINE utime_t ticks_to_us(ticks_t ticks)
{
#if TIMER_TICKS_PER_SEC < 1000
    /* Slow timer: avoid rounding down too much. */
    return ((ticks * 1000) / TIMER_TICKS_PER_SEC) * 1000;
#else
    /* Fast timer: avoid overflowing ticks_t. */
    return (ticks / (TIMER_TICKS_PER_SEC / 1000)) * 1000;
#endif
}

INLINE hptime_t us_to_hptime(utime_t us)
{
#if TIMER_HW_HPTICKS_PER_SEC > 10000000UL
    return us * DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, 1000000UL);
#else
    return (us * ((TIMER_HW_HPTICKS_PER_SEC + 500) / 1000UL) + 500) / 1000UL;
#endif
}

INLINE utime_t hptime_to_us(hptime_t hpticks)
{
#if TIMER_HW_HPTICKS_PER_SEC < 100000UL
    return hpticks * DIV_ROUND(1000000UL, TIMER_HW_HPTICKS_PER_SEC);
#else
    return (hpticks * 1000UL) / DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, 1000UL);
#endif /* TIMER_HW_HPTICKS_PER_SEC < 100000UL */
}

void timer_delayTicks(ticks_t delay);
INLINE void timer_delay(mtime_t delay)
{
    timer_delayTicks(ms_to_ticks(delay));
}

void timer_init(void);
void timer_cleanup(void);

int timer_testSetup(void);
int timer_testRun(void);
int timer_testTearDown(void);

#if CONFIG_TIMER_UDELAY
void timer_busyWait(hptime_t delay);
void timer_delayHp(hptime_t delay);
INLINE void timer_udelay(utime_t delay)
{
    timer_delayHp(us_to_hptime(delay));
}
#endif

#if CONFIG_TIMER_EVENTS

#include <mware/event.h>

typedef struct Timer
{
    Node    link;     
    ticks_t _delay;   
    ticks_t tick;     
    Event   expire;   
    DB(uint16_t magic;)
} Timer;

/* Timer is active when Timer.magic contains this value (for debugging purposes). */
#define TIMER_MAGIC_ACTIVE    0xABBA
#define TIMER_MAGIC_INACTIVE  0xBAAB

void timer_add(Timer *timer);
Timer *timer_abort(Timer *timer);

INLINE void timer_setSoftint(Timer *timer, Hook func, iptr_t user_data)
{
    event_initSoftint(&timer->expire, func, user_data);
}

INLINE void timer_setDelay(Timer *timer, ticks_t delay)
{
    timer->_delay = delay;
}

#endif /* CONFIG_TIMER_EVENTS */

#if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS

INLINE void timer_setSignal(Timer *timer, struct Process *proc, sigmask_t sigs)
{
    event_initSignal(&timer->expire, proc, sigs);
}

#define timer_set_event_signal timer_setSignal

#endif /* CONFIG_KERN_SIGNALS */

#endif /* DRV_TIMER_H */