Esp32/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_attr.h>
#include <sming_attr.h>
#include <stdint.h>

#ifdef CONFIG_ESP_TIMER_IMPL_TG0_LAC
#include <soc/timer_group_reg.h>
#else
#include <hal/systimer_ll.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

#define HW_TIMER_BASE_CLK APB_CLK_FREQ

/*************************************
 *
 * Timer1
 * 
 * Used to implement HardwareTimer class.
 *
 *************************************/

// Timer group/index to use: available on all ESP32 variants
#define HW_TIMER1_GROUP TIMER_GROUP_0
#define HW_TIMER1_INDEX TIMER_0

#define MAX_HW_TIMER1_INTERVAL 0x7fffffff

#define MIN_HW_TIMER1_INTERVAL_US 50U

typedef void (*hw_timer_callback_t)(void* arg);

typedef enum {
    TIMER_CLKDIV_1 = 0,
    TIMER_CLKDIV_16 = 4,
    TIMER_CLKDIV_256 = 8,
} hw_timer_clkdiv_t;

typedef enum {
    TIMER_EDGE_INT = 0,  // edge interrupt
    TIMER_LEVEL_INT = 1, // level interrupt
} hw_timer_intr_type_t;

typedef enum {
    TIMER_FRC1_SOURCE = 0,
    TIMER_NMI_SOURCE = 1,
} hw_timer_source_type_t;

void IRAM_ATTR hw_timer1_attach_interrupt(hw_timer_source_type_t source_type, hw_timer_callback_t callback, void* arg);

void IRAM_ATTR hw_timer1_enable(hw_timer_clkdiv_t div, hw_timer_intr_type_t intr_type, bool auto_load);

void IRAM_ATTR hw_timer1_write(uint32_t ticks);

void IRAM_ATTR hw_timer1_disable(void);

void IRAM_ATTR hw_timer1_detach_interrupt(void);

uint32_t hw_timer1_read(void);

/*************************************
 *
 * Timer2 uses the idf `esp_timer` component for software-based timers (os_timer.cpp).
 *
 *************************************/

#if CONFIG_ESP_TIMER_IMPL_TG0_LAC
#define HW_TIMER2_CLK 2000000U
#define HW_TIMER2_INDEX 0
#elif defined(CONFIG_IDF_TARGET_ESP32S2)
#define HW_TIMER2_CLK 80000000U
#define HW_TIMER2_INDEX
#elif defined(CONFIG_IDF_TARGET_ESP32C3)
#define HW_TIMER2_CLK 16000000U
#define HW_TIMER2_INDEX 0
#elif defined(CONFIG_IDF_TARGET_ESP32S3)
#define HW_TIMER2_CLK 16000000U
#define HW_TIMER2_INDEX 0
#else
_Static_assert(false, "ESP32 Unsupported timer");
#endif

__forceinline static uint32_t hw_timer2_read(void)
{
#if CONFIG_ESP_TIMER_IMPL_TG0_LAC
    return REG_READ(TIMG_LACTLO_REG(HW_TIMER2_INDEX));
#else
    systimer_ll_counter_snapshot(HW_TIMER2_INDEX);
    return systimer_ll_get_counter_value_low(HW_TIMER2_INDEX);
#endif
}

#define NOW() hw_timer2_read()

void hw_timer_init(void);

#ifdef __cplusplus
}
#endif