aon_timer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Raspberry Pi (Trading) Ltd.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _PICO_AON_TIMER_H
#define _PICO_AON_TIMER_H
 
#include "pico.h"
#include <time.h>
#include "pico/time.h"
#include "pico/util/datetime.h"
#include "hardware/regs/intctrl.h"

 
#ifdef __cplusplus
extern "C" {
#endif

#ifndef AON_TIMER_IRQ_NUM
#if HAS_RP2040_RTC
#define AON_TIMER_IRQ_NUM() RTC_IRQ
#elif HAS_POWMAN_TIMER
#define AON_TIMER_IRQ_NUM() POWMAN_IRQ_TIMER
#endif
#endif
 
typedef void (*aon_timer_alarm_handler_t)(void);

void aon_timer_start_with_timeofday(void);

bool aon_timer_start(const struct timespec *ts);

bool aon_timer_start_calendar(const struct tm *tm);

void aon_timer_stop(void);

bool aon_timer_set_time(const struct timespec *ts);

bool aon_timer_set_time_calendar(const struct tm *tm);

bool aon_timer_get_time(struct timespec *ts);

bool aon_timer_get_time_calendar(struct tm *tm);

absolute_time_t aon_timer_get_absolute_time(void);

 static inline absolute_time_t aon_timer_make_timeout_time_ms(uint32_t ms) {
    return delayed_by_ms(aon_timer_get_absolute_time(), ms);
}

void aon_timer_get_resolution(struct timespec *ts);

aon_timer_alarm_handler_t aon_timer_enable_alarm(const struct timespec *ts, aon_timer_alarm_handler_t handler, bool wakeup_from_low_power);

aon_timer_alarm_handler_t aon_timer_enable_alarm_calendar(const struct tm *tm, aon_timer_alarm_handler_t handler, bool wakeup_from_low_power);

void aon_timer_disable_alarm(void);

bool aon_timer_is_running(void);
 
static inline uint aon_timer_get_irq_num(void) {
    return AON_TIMER_IRQ_NUM();
}
 
#ifdef __cplusplus
}
#endif
 
#endif