33#ifndef PARAM_ASSERTIONS_ENABLED_PICO_TIME
34#ifdef PARAM_ASSERTIONS_ENABLED_PICO_TIME
35#define PARAM_ASSERTIONS_ENABLED_PICO_TIME PARAM_ASSERTIONS_ENABLED_TIME
37#define PARAM_ASSERTIONS_ENABLED_PICO_TIME 0
42#ifndef PICO_TIME_SLEEP_OVERHEAD_ADJUST_US
43#define PICO_TIME_SLEEP_OVERHEAD_ADJUST_US 6
72static inline uint32_t us_to_ms(uint64_t us) {
74 return (uint32_t)(us / 1000u);
76 return ((uint32_t)us) / 1000u;
99static inline absolute_time_t
delayed_by_us(
const absolute_time_t t, uint64_t us) {
102 uint64_t delayed = base + us;
103 if ((int64_t)delayed < 0) {
118static inline absolute_time_t
delayed_by_ms(
const absolute_time_t t, uint32_t ms) {
121 uint64_t delayed = base + ms * 1000ull;
122 if ((int64_t)delayed < 0) {
196extern const absolute_time_t
nil_time;
314#ifndef PICO_TIME_DEFAULT_ALARM_POOL_DISABLED
327#define PICO_TIME_DEFAULT_ALARM_POOL_DISABLED 0
331#ifndef PICO_TIME_DEFAULT_ALARM_POOL_HARDWARE_ALARM_NUM
337#define PICO_TIME_DEFAULT_ALARM_POOL_HARDWARE_ALARM_NUM 3
341#ifndef PICO_TIME_DEFAULT_ALARM_POOL_MAX_TIMERS
350#define PICO_TIME_DEFAULT_ALARM_POOL_MAX_TIMERS 16
381typedef void alarm_pool_timer_t;
388void runtime_init_default_alarm_pool(
void);
390#if !PICO_TIME_DEFAULT_ALARM_POOL_DISABLED
401alarm_pool_t *alarm_pool_create_on_timer(alarm_pool_timer_t *timer, uint timer_alarm_num, uint max_timers);
403alarm_pool_timer_t *alarm_pool_timer_for_timer_num(uint timer_num);
405alarm_pool_timer_t *alarm_pool_get_default_timer(
void);
426 return alarm_pool_create_on_timer(alarm_pool_get_default_timer(), timer_alarm_num, max_timers);
429alarm_pool_t *alarm_pool_create_on_timer_with_unused_hardware_alarm(alarm_pool_timer_t *timer, uint max_timers);
449 return alarm_pool_create_on_timer_with_unused_hardware_alarm(alarm_pool_get_default_timer(), max_timers);
460static inline uint alarm_pool_hardware_alarm_num(
alarm_pool_t *pool) {
604#if !PICO_TIME_DEFAULT_ALARM_POOL_DISABLED
786#if !PICO_TIME_DEFAULT_ALARM_POOL_DISABLED
bool alarm_pool_cancel_alarm(alarm_pool_t *pool, alarm_id_t alarm_id)
Cancel an alarm.
Definition time.c:354
static alarm_id_t alarm_pool_add_alarm_in_us(alarm_pool_t *pool, uint64_t us, alarm_callback_t callback, void *user_data, bool fire_if_past)
Add an alarm callback to be called after a delay specified in microseconds.
Definition time.h:541
static alarm_pool_t * alarm_pool_create(uint timer_alarm_num, uint max_timers)
Create an alarm pool.
Definition time.h:425
int64_t alarm_pool_remaining_alarm_time_us(alarm_pool_t *pool, alarm_id_t alarm_id)
Return the time remaining before the next trigger of an alarm.
Definition time.c:528
int32_t alarm_pool_remaining_alarm_time_ms(alarm_pool_t *pool, alarm_id_t alarm_id)
Return the time remaining before the next trigger of an alarm.
Definition time.c:556
uint alarm_pool_core_num(alarm_pool_t *pool)
Return the core number the alarm pool was initialized on (and hence callbacks are called on)
Definition time.c:380
alarm_pool_t * alarm_pool_get_default(void)
The default alarm pool used when alarms are added without specifying an alarm pool,...
Definition time.c:100
int64_t remaining_alarm_time_us(alarm_id_t alarm_id)
Return the time remaining before the next trigger of an alarm.
Definition time.c:563
int32_t remaining_alarm_time_ms(alarm_id_t alarm_id)
Return the time remaining before the next trigger of an alarm.
Definition time.c:567
static alarm_id_t add_alarm_in_us(uint64_t us, alarm_callback_t callback, void *user_data, bool fire_if_past)
Add an alarm callback to be called after a delay specified in microseconds.
Definition time.h:649
static alarm_id_t alarm_pool_add_alarm_in_ms(alarm_pool_t *pool, uint32_t ms, alarm_callback_t callback, void *user_data, bool fire_if_past)
Add an alarm callback to be called after a delay specified in milliseconds.
Definition time.h:566
static alarm_pool_t * alarm_pool_create_with_unused_hardware_alarm(uint max_timers)
Create an alarm pool, claiming an used timer_alarm to back it.
Definition time.h:448
alarm_id_t alarm_pool_add_alarm_at_force_in_context(alarm_pool_t *pool, absolute_time_t time, alarm_callback_t callback, void *user_data)
Add an alarm callback to be called at or after a specific time.
Definition time.c:321
static alarm_id_t add_alarm_in_ms(uint32_t ms, alarm_callback_t callback, void *user_data, bool fire_if_past)
Add an alarm callback to be called after a delay specified in milliseconds.
Definition time.h:673
int32_t alarm_id_t
The identifier for an alarm.
Definition time.h:367
void alarm_pool_init_default(void)
Create the default alarm pool (if not already created or disabled)
Definition time.c:95
alarm_id_t alarm_pool_add_alarm_at(alarm_pool_t *pool, absolute_time_t time, alarm_callback_t callback, void *user_data, bool fire_if_past)
Add an alarm callback to be called at a specific time.
Definition time.c:312
int64_t(* alarm_callback_t)(alarm_id_t id, void *user_data)
User alarm callback.
Definition time.h:378
void alarm_pool_destroy(alarm_pool_t *pool)
Destroy the alarm pool, cancelling all alarms and freeing up the underlying timer_alarm.
Definition time.c:298
static alarm_id_t add_alarm_at(absolute_time_t time, alarm_callback_t callback, void *user_data, bool fire_if_past)
Add an alarm callback to be called at a specific time.
Definition time.h:625
static bool cancel_alarm(alarm_id_t alarm_id)
Cancel an alarm from the default alarm pool.
Definition time.h:683
uint alarm_pool_timer_alarm_num(alarm_pool_t *pool)
Return the timer alarm used by an alarm pool.
Definition time.c:376
uint64_t time_us_64(void)
Return the current 64 bit timestamp value in microseconds for the default timer instance.
Definition timer.c:125
static bool add_repeating_timer_ms(int32_t delay_ms, repeating_timer_callback_t callback, void *user_data, repeating_timer_t *out)
Add a repeating timer that is called repeatedly at the specified interval in milliseconds.
Definition time.h:825
bool(* repeating_timer_callback_t)(repeating_timer_t *rt)
Callback for a repeating timer.
Definition time.h:729
bool alarm_pool_add_repeating_timer_us(alarm_pool_t *pool, int64_t delay_us, repeating_timer_callback_t callback, void *user_data, repeating_timer_t *out)
Add a repeating timer that is called repeatedly at the specified interval in microseconds.
Definition time.c:500
static bool add_repeating_timer_us(int64_t delay_us, repeating_timer_callback_t callback, void *user_data, repeating_timer_t *out)
Add a repeating timer that is called repeatedly at the specified interval in microseconds.
Definition time.h:804
bool cancel_repeating_timer(repeating_timer_t *timer)
Cancel a repeating timer.
Definition time.c:511
static bool alarm_pool_add_repeating_timer_ms(alarm_pool_t *pool, int32_t delay_ms, repeating_timer_callback_t callback, void *user_data, repeating_timer_t *out)
Add a repeating timer that is called repeatedly at the specified interval in milliseconds.
Definition time.h:782
void sleep_until(absolute_time_t target)
Wait until after the given timestamp to return.
Definition time.c:392
void sleep_ms(uint32_t ms)
Wait for the given number of milliseconds before returning.
Definition time.c:439
bool best_effort_wfe_or_timeout(absolute_time_t timeout_timestamp)
Helper method for blocking on a timeout.
Definition time.c:443
void sleep_us(uint64_t us)
Wait for the given number of microseconds before returning.
Definition time.c:422
static bool is_nil_time(absolute_time_t t)
Determine if the given timestamp is nil.
Definition time.h:204
static uint64_t to_us_since_boot(absolute_time_t t)
convert an absolute_time_t into a number of microseconds since boot.
Definition types.h:52
static int64_t absolute_time_diff_us(absolute_time_t from, absolute_time_t to)
Return the difference in microseconds between two timestamps.
Definition time.h:161
static bool is_at_the_end_of_time(absolute_time_t t)
Determine if the given timestamp is "at_the_end_of_time".
Definition time.h:189
static absolute_time_t absolute_time_min(absolute_time_t a, absolute_time_t b)
Return the earlier of two timestamps.
Definition time.h:172
static absolute_time_t get_absolute_time(void)
Return a representation of the current time.
Definition time.h:66
static absolute_time_t make_timeout_time_us(uint64_t us)
Convenience method to get the timestamp a number of microseconds from the current time.
Definition time.h:136
static absolute_time_t delayed_by_us(const absolute_time_t t, uint64_t us)
Return a timestamp value obtained by adding a number of microseconds to another timestamp.
Definition time.h:99
static absolute_time_t delayed_by_ms(const absolute_time_t t, uint32_t ms)
Return a timestamp value obtained by adding a number of milliseconds to another timestamp.
Definition time.h:118
const absolute_time_t nil_time
The timestamp representing a null timestamp.
static absolute_time_t make_timeout_time_ms(uint32_t ms)
Convenience method to get the timestamp a number of milliseconds from the current time.
Definition time.h:146
static uint32_t to_ms_since_boot(absolute_time_t t)
Convert a timestamp into a number of milliseconds since boot.
Definition time.h:87
const absolute_time_t at_the_end_of_time
The timestamp representing the end of time; this is actually not the maximum possible timestamp,...
static void update_us_since_boot(absolute_time_t *t, uint64_t us_since_boot)
update an absolute_time_t value to represent a given number of microseconds since boot
Definition types.h:67
Information about a repeating timer.
Definition time.h:736