Skip to content
charmOS docs

Timer

include/time/timer.h View source View on GitHub

Structs

Section titled “Structs”

timer

Section titled “timer”
struct timer {
    struct hlist_node  hlist_node;
    time_us_t          expiration_us;
    void               (*func)(struct timer *timer);
    enum timer_flags   flags;
    void               *data;
};

Enums

Section titled “Enums”

timer_flags

Section titled “timer_flags”
enum timer_flags {
    TIMER_FLAG_NONE = 0,
    TIMER_FLAG_DEFERRABLE = 1 << 18,
    TIMER_FLAG_IRQ = 1 << 19,
    TIMER_FLAG_MIGRATING = 1 << 20,
    TIMER_FLAG_PINNED = 1 << 21,
};

Functions

Section titled “Functions”

timer_bucket_set

Section titled “timer_bucket_set”
void timer_bucket_set(struct timer *timer, uint32_t bucket);

timer_bucket_get

Section titled “timer_bucket_get”
uint32_t timer_bucket_get(struct timer *timer);

timer_cpu_set

Section titled “timer_cpu_set”
void timer_cpu_set(struct timer *timer, cpu_id_t cpu);

timer_cpu_get

Section titled “timer_cpu_get”
cpu_id_t timer_cpu_get(struct timer *timer);

timer_init

Section titled “timer_init”
void timer_init(struct timer *timer, void (*func)(struct timer *), void *data);

timer_add

Section titled “timer_add”
void timer_add(struct timer *timer);

timer_add_on

Section titled “timer_add_on”
void timer_add_on(struct timer *timer, cpu_id_t cpu);

timer_add_local

Section titled “timer_add_local”
void timer_add_local(struct timer *timer);

timer_add_global

Section titled “timer_add_global”
void timer_add_global(struct timer *timer);

timer_modify

Section titled “timer_modify”
bool timer_modify(struct timer *timer, time_us_t new);

timer_modify_pending

Section titled “timer_modify_pending”
bool timer_modify_pending(struct timer *timer, time_us_t new);

timer_modify_reduce

Section titled “timer_modify_reduce”
bool timer_modify_reduce(struct timer *timer, time_us_t new);

timer_delete

Section titled “timer_delete”
bool timer_delete(struct timer *timer);

timer_delete_sync

Section titled “timer_delete_sync”
bool timer_delete_sync(struct timer *timer);

timer_shutdown

Section titled “timer_shutdown”
bool timer_shutdown(struct timer *timer);

timer_shutdown_sync

Section titled “timer_shutdown_sync”
bool timer_shutdown_sync(struct timer *timer);

timer_isr

Section titled “timer_isr”
enum irq_result timer_isr(void *ctx, irq_t vec, struct irq_context * *);

timers_init

Section titled “timers_init”
void timers_init(void);

timer_delta_us

Section titled “timer_delta_us”
time_us_t timer_delta_us(time_us_t delta_us);

Macros

Section titled “Macros”

TIMER_FLAG_CPU_MASK

Section titled “TIMER_FLAG_CPU_MASK”
#define TIMER_FLAG_CPU_MASK 0x0003FFFF

TIMER_FLAG_CPU

Section titled “TIMER_FLAG_CPU”
#define TIMER_FLAG_CPU(c) ((c) & TIMER_FLAG_CPU_MASK)

TIMER_FLAG_BUCKET_MASK

Section titled “TIMER_FLAG_BUCKET_MASK”
#define TIMER_FLAG_BUCKET_MASK 0x3FF

TIMER_FLAG_BUCKET_SHIFT

Section titled “TIMER_FLAG_BUCKET_SHIFT”
#define TIMER_FLAG_BUCKET_SHIFT 22

TIMER_FLAG_BUCKET

Section titled “TIMER_FLAG_BUCKET”
#define TIMER_FLAG_BUCKET(b) \
    (((b) & TIMER_FLAG_BUCKET_MASK) << TIMER_FLAG_BUCKET_SHIFT)

TIMER_DECLARE

Section titled “TIMER_DECLARE”
#define TIMER_DECLARE(n, fn, ...) \
    struct timer n = (struct timer) { \
        .func = fn \
    }