ESP32学习笔记（42）——硬件定时器接口使用

Posted 2021-09-04 Leung_ManWah

一、简介

ESP32 芯片包含两个硬件定时器组。每组有两个通用硬件定时器。它们都是基于 16 位预分频器和 64 位递增/递减计数器的 64 位通用定时器，能够自动重新加载。

ESP-IDF 编程指南——通用定时器

二、API说明

以下硬件定时器接口位于 driver/include/driver/timer.h。

2.1 timer_init

2.2 timer_set_counter_value

2.3 timer_set_alarm_value

2.4 timer_enable_intr

2.5 timer_isr_register

2.6 timer_start

2.7 timer_get_counter_value

2.8 timer_spinlock_take

2.9 timer_spinlock_give

2.10 timer_group_get_intr_status_in_isr

2.11 timer_group_get_counter_value_in_isr

2.12 timer_group_clr_intr_status_in_isr

2.13 timer_group_set_alarm_value_in_isr

2.14 timer_group_enable_alarm_in_isr

三、编程流程

3.1 定时器初始化

首先，应该通过调用函数timer_init()并传递一个结构体timer_config_t来定义定时器应该如何操作来初始化定时器。特别是，可以设置以下定时器参数：

timer_config_t config = {
        .divider = TIMER_DIVIDER,       //分频倍数
        .counter_dir = TIMER_COUNT_UP,  //向上计数(1)/向下计数(0)
        .counter_en = TIMER_PAUSE,      //定时器运行开(1)关(0)
        .alarm_en = TIMER_ALARM_EN,     //定时器中断开(1)关(0)
        .auto_reload = TIMER_AUTORELOAD_EN,     //是(1)否(0)自动重装载
    }; // default clock source is APB

要获取计时器设置的当前值，请使用函数timer_get_config()。

3.2 定时器控制

一旦定时器被启用，它的计数器就会开始运行。要启用计时器，请timer_init()使用counter_enset调用该函数true，或调用timer_start()。

您可以通过调用指定计时器的初始计数器值timer_set_counter_value()。
要检查计时器的当前值，请调用timer_get_counter_value()或timer_get_counter_time_sec()。

要随时暂停计时器，请调用timer_pause()。
要恢复它，请调用timer_start()。
要重新配置计时器，您可以调用timer_init()。

3.3 定时器中断

3.3.1 中断设置

要设置中断报警，请调用该函数timer_set_alarm_value()，然后使用启用报警timer_set_alarm()。报警也可以在定时器初始化阶段启用，当timer_init()被调用时。

开启报警后，定时器达到报警值后，根据配置的不同，会发生以下两种动作：

• 如果先前已配置，将触发中断。有关如何配置中断，请参阅中断部分。
• 当auto_reload启用时，定时器计数器将自动重新加载开始从以前配置的值重新计数。这个值应该提前设置timer_set_counter_value()。

• 如果设置了报警值并且计时器已经达到该值，则会立即触发报警。
• 一旦触发，报警将自动禁用，需要重新启用才能再次触发。

3.3.2 中断回调

ESP32 的硬件定时器中断有两种处理方式：

• 回调配置法【推荐】：
  ESP32 硬件定时器在默认情况下有一个 ISR 程序，称作 “总 ISR 程序” 。它为我们执行我们配置的定时器的回调。换句话说，我们写的回调函数，配置后将属于这个ISR程序的一部分。因此这个回调函数又称为ISR 回调（ISR callback）
  这样做要求你的回调程序要尽可能的简短。

  ① 创建ISR Callback函数

  static bool timer_callback(void *args){
      uint64_t val;
      BaseType_t pxHigherPriorityTaskWoken = pdFALSE;
    
      // xQueueSendFromISR(queue, (void*)&val, &pxHigherPriorityTaskWoken);
  
      return pxHigherPriorityTaskWoken;//请看第 3 行
  }
  

  ② 添加、删除定时器Callback（注册中断）
  调用函数timer_isr_callback_add()添加回调
  调用函数timer_isr_callback_remove()删除回调

• 自定义ISR法：
  如果使用此函数重新注册 ISR，则需要编写完整的 ISR。例如需要清除中断标志位，配置自旋锁之类。

  一般情况下必要的事：

  1. 获取自旋锁timer_spinlock_take()
  2. 显式清除中断状态timer_group_clr_intr_status_in_isr()
  3. 再次使能中断timer_group_enable_alarm_in_isr()
  4. 释放自旋锁timer_spinlock_take()

  ① 创建ISR中断服务程序

  void IRAM_ATTR timerIsr(void *arg){
    timer_spinlock_take(0);    // 获取自旋锁
  
    /*
    	代码区一
    */
    timer_group_clr_intr_status_in_isr(0, 0);
    timer_group_enable_alarm_in_isr(0, 0);
    /*
    	代码区二
    */
    
    timer_spinlock_give(0);  // 释放自旋锁
  }
  

  注意：必须显式清除中断标志，以及重新使能中断。如上代码区一和代码区二之间的两个函数。（两个函数参数都是定时器组索引和定时器索引）

  ② 注册中断
  调用函数timer_isr_register()配置
  例如，为定时器组0中的定时器0配置一个完整的ISR程序

  timer_isr_register(0, 0, timerIsr, &config, ESP_INTR_FLAG_IRAM, NULL); 
  

四、示例代码

定义一个硬件定时器，时长为3秒，每一次中断向一个任务传递定时器计数值。

根据 examples\\peripherals\\timer_group 中的例程修改

4.1 配置回调法

#include  <stdio.h>
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "driver/timer.h"
#include "freertos/queue.h"

#define TIMER_DIVIDER         16  //  硬件定时器分频器
#define TIMER_FREQ           (TIMER_BASE_CLK / TIMER_DIVIDER)  // 定时器计数频率

static xQueueHandle queue;

static bool timer_callback(void *args){
    uint64_t val;
    BaseType_t pxHigherPriorityTaskWoken = pdFALSE;
    
    val = timer_group_get_counter_value_in_isr(0, 0);
    /*
     * 上行代码：
     * ————————————————————
     * 将定时器的值传给一个任务
     *（由于本示例使用的自动重装载模式，
     * 所以在本示例中这个val值无意义。
     * 只是为了展示在isr callback中获
     * 取定时器值函数的使用【必须
     * 调用带有_in_isr的函数】）
     * ————————————————————
     */
    
    //通过队列将 val 传给任务
    xQueueSendFromISR(queue, (void*)&val, &pxHigherPriorityTaskWoken);

    return pxHigherPriorityTaskWoken;
}


static void task(void *arg){
    uint64_t counts = 0ull;
    while(1){
        counts ++;
        uint64_t val;
        if(xQueueReceive(queue, &val, portMAX_DELAY)){
            printf("val %lld\\n", val);
            printf("定时器第 %llu 次中断\\n", counts);
        }
    }
}
void app_main(void)
{
    queue = xQueueCreate(10, sizeof(uint64_t));
    timer_config_t config = {
        .divider = TIMER_DIVIDER,
        .counter_dir = TIMER_COUNT_UP,
        .counter_en = TIMER_PAUSE,
        .alarm_en = TIMER_ALARM_EN,
        .auto_reload = TIMER_AUTORELOAD_EN,
    };
    timer_init(0, 0, &config);
    timer_set_counter_value(0, 0, 0x00ull);
    timer_set_alarm_value(0, 0, TIMER_FREQ * 3);
    timer_enable_intr(0, 0);
    
    timer_isr_callback_add(0, 0, timer_callback, NULL, ESP_INTR_FLAG_IRAM);

    xTaskCreate(task, "timer_test_task", 2048, NULL, 5, NULL);
    timer_start(0, 0);
    printf("定时器启动成功！");
}

4.2 自定义ISR法

#include <stdio.h>
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "driver/timer.h"
#include "freertos/queue.h"

#define TIMER_DIVIDER         16  //  Hardware timer clock divider
#define TIMER_FREQ           (TIMER_BASE_CLK / TIMER_DIVIDER)  // convert counter value to seconds

static xQueueHandle queue;
//回调函数
static void IRAM_ATTR timerIsr(void *arg){
    timer_spinlock_take(0);    

    uint64_t val = 0;
	val = timer_group_get_counter_value_in_isr(0, 0);
	/*
     * 上行代码：
     * ————————————————————
     * 将定时器的值传给一个任务
     *（由于本示例使用的自动重装载模式，
     * 所以在本示例中这个val值无意义。
     * 只是为了展示在isr callback中获
     * 取定时器值函数的使用【必须
     * 调用带有_in_isr的函数】）
     * ————————————————————
     */
    
    timer_group_clr_intr_status_in_isr(0, 0);
    timer_group_enable_alarm_in_isr(0, 0);
    
    xQueueSendFromISR(queue, &val, NULL);
    
    timer_spinlock_give(0);
}

static void task(void *arg){
    uint64_t counts = 0ull;
    while(1){
        counts ++;
        uint64_t val;
        if(xQueueReceive(queue, &val, portMAX_DELAY)){
            printf("val %lld\\n", val);
            printf("定时器第 %llu 次中断\\n", counts);
        }
    }
}
void app_main(void)
{
    queue = xQueueCreate(10, sizeof(uint64_t));
    timer_config_t config = {
        .divider = TIMER_DIVIDER,
        .counter_dir = TIMER_COUNT_UP,
        .counter_en = TIMER_PAUSE,
        .alarm_en = TIMER_ALARM_EN,
        .auto_reload = TIMER_AUTORELOAD_EN,
    };
    timer_init(0, 0, &config);
    timer_set_counter_value(0, 0, 0x00ull);
    timer_set_alarm_value(0, 0, TIMER_FREQ * 3);
    timer_enable_intr(0, 0);
    timer_isr_register(0, 0, timerIsr, &config, ESP_INTR_FLAG_IRAM, NULL);
    xTaskCreate(task, "timer_test_task", 2048, NULL, 5, NULL);
    timer_start(0, 0);
    printf("定时器启动成功！");
}

---

• 由 Leung 写于 2021 年 8 月 9 日

• 参考：ESP32 之 ESP-IDF 教学（三）——通用硬件定时器（Timer）