Rp2040/Components/driver/include/driver/hw_timer.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * hw_timer.h
 *
 ****/
 
#pragma once
 
#include <esp_systemapi.h>
#include <hardware/timer.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define HW_TIMER_BASE_CLK 1000000U
 
#define HW_TIMER_NUM 0
#define HW_TIMER_INST TIMER_INSTANCE(HW_TIMER_NUM)
 
__forceinline uint32_t IRAM_ATTR hw_timer_ticks()
{
    return timer_time_us_32(HW_TIMER_INST);
}
 
/*************************************
 *
 * Timer1 (countdown alarm)
 *
 *************************************/
 
#define MAX_HW_TIMER1_INTERVAL 0x7fffffffU
 
#define MIN_HW_TIMER1_INTERVAL_US 50U
 
typedef void (*hw_timer_callback_t)(void* arg);
 
typedef enum {
    TIMER_CLKDIV_1,
    TIMER_CLKDIV_16,
    TIMER_CLKDIV_256,
} hw_timer_clkdiv_t;
 
typedef enum {
    TIMER_EDGE_INT,  // edge interrupt
    TIMER_LEVEL_INT, // level interrupt
} hw_timer_intr_type_t;
 
typedef enum {
    TIMER_FRC1_SOURCE,
    TIMER_NMI_SOURCE,
} hw_timer_source_type_t;
 
// Internal data
struct hw_timer_private_t {
    hw_timer_clkdiv_t timer1_clkdiv;
    hw_timer_callback_t timer1_callback;
    uint32_t timer1_ticks;
    bool timer1_autoload;
    void* timer1_arg;
};
 
extern struct hw_timer_private_t hw_timer_private;
 
void hw_timer1_attach_interrupt(hw_timer_source_type_t source_type, hw_timer_callback_t callback, void* arg);
 
void hw_timer1_detach_interrupt();
 
void hw_timer1_enable(hw_timer_clkdiv_t div, hw_timer_intr_type_t intr_type, bool auto_load);
 
__forceinline void IRAM_ATTR hw_timer1_write(uint32_t ticks)
{
    ticks <<= hw_timer_private.timer1_clkdiv;
    hw_timer_private.timer1_ticks = ticks;
    HW_TIMER_INST->alarm[0] = hw_timer_ticks() + ticks;
}
 
__forceinline void IRAM_ATTR hw_timer1_disable()
{
    HW_TIMER_INST->armed = BIT(0);
}
 
__forceinline uint32_t hw_timer1_read()
{
    int time = hw_timer_ticks() - HW_TIMER_INST->alarm[0];
    return (time > 0) ? (time >> hw_timer_private.timer1_clkdiv) : 0;
}
 
/*************************************
 *
 * FRC2 timer
 *
 * This is a 32-bit count-up timer.
 * Used for software timers - see os_timer.h
 *
 *************************************/
 
#define HW_TIMER2_CLK HW_TIMER_BASE_CLK
 
__forceinline uint32_t hw_timer2_read()
{
    return hw_timer_ticks();
}
 
#ifdef __cplusplus
}
#endif