timer.h

 
#pragma once
 
#include <stdint.h>
#include <stdbool.h>
#include "runtime.h"
 
/* List of various timer types supported by this framework.
 * For most part, the most important characteristic is if
 * the timer is periodic or not.
 *
 * This is decided by if the timer type is *above* or *below*
 * the TIMER_PERIODIC type.
 */
enum eSleepType {
    TIMER_SLEEP = 0,
    TIMER_TIMEOUT,
    TIMER_PERIODIC,                     // Marks the first periodic timer type
    TIMER_INTERVAL = TIMER_PERIODIC,
};
 
#define SLEEPER_KEY_TYPE_SHIFT 24
 
#define SLEEPER_KEY(_type, _thread)     (((_type) << SLEEPER_KEY_TYPE_SHIFT) | (_thread))
 
struct TimerEntry_t {
    uint32_t key;             
    uint32_t sleep_from;      
    uint32_t interval;        
    uint8_t thread_id;        
    uint8_t timer_type;       
};
 
struct TimerQueueEntry_t {
    uint32_t resume_time;
    uint8_t entry_id;
};
 
#define TIMER_INVALID_ID 0xFF
 
_Static_assert(TIMER_INVALID_ID > SLEEPERS_MAX, "Timer invalid value must lie outside of timer ID range!");
 
 
int os_usleep(unsigned microseconds);
 
int os_setitimer(unsigned microseconds);
 
void os_timer_init(void);
 
int os_set_timed_event(unsigned microseconds, enum eSleepType type);
 
int os_find_timer(Thread_t owner, enum eSleepType type);
 
int os_cancel_timed_event(Thread_t owner, enum eSleepType type);
 
int os_cancel_sleeper(unsigned sleeper_queue_id);
 
bool os_schedule_timer(unsigned * delay);
 
void os_run_timer(uint32_t start_microtime, uint32_t interval);
 
uint32_t os_cpu_freq_get(void);