timer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _HARDWARE_TIMER_H
#define _HARDWARE_TIMER_H
 
#include "pico.h"
#include "hardware/structs/timer.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
// PICO_CONFIG: PARAM_ASSERTIONS_ENABLED_TIMER, Enable/disable assertions in the timer module, type=bool, default=0, group=hardware_timer
#ifndef PARAM_ASSERTIONS_ENABLED_TIMER
#define PARAM_ASSERTIONS_ENABLED_TIMER 0
#endif
 
static inline void check_hardware_alarm_num_param(__unused uint alarm_num) {
    invalid_params_if(TIMER, alarm_num >= NUM_TIMERS);
}
 
static inline uint32_t time_us_32(void) {
    return timer_hw->timerawl;
}
 
uint64_t time_us_64(void);
 
void busy_wait_us_32(uint32_t delay_us);
 
void busy_wait_us(uint64_t delay_us);
 
void busy_wait_ms(uint32_t delay_ms);
 
void busy_wait_until(absolute_time_t t);
 
static inline bool time_reached(absolute_time_t t) {
    uint64_t target = to_us_since_boot(t);
    uint32_t hi_target = (uint32_t)(target >> 32u);
    uint32_t hi = timer_hw->timerawh;
    return (hi >= hi_target && (timer_hw->timerawl >= (uint32_t) target || hi != hi_target));
}
 
typedef void (*hardware_alarm_callback_t)(uint alarm_num);
 
void hardware_alarm_claim(uint alarm_num);
 
int hardware_alarm_claim_unused(bool required);
 
void hardware_alarm_unclaim(uint alarm_num);
 
bool hardware_alarm_is_claimed(uint alarm_num);
 
void hardware_alarm_set_callback(uint alarm_num, hardware_alarm_callback_t callback);
 
bool hardware_alarm_set_target(uint alarm_num, absolute_time_t t);
 
void hardware_alarm_cancel(uint alarm_num);
 
void hardware_alarm_force_irq(uint alarm_num);
#ifdef __cplusplus
}
#endif
#endif