介绍关于TIMER初始化、启动、停止、修改、关闭等功能所调用的一些抽象函数。

API列表

函数名称 功能描述
hal_timer_init 初始化指定TIMER
hal_timer_start 启动指定的TIMER
hal_timer_stop 停止指定的TIMER
hal_timer_para_chg 改变指定TIMER的参数
hal_timer_finalize 关闭指定TIMER

hal_timer_init

定义描述
定义 描述
函数原型 int32_t hal_timer_init(timer_dev_t *tim)
描述 初始化指定TIMER
参数 tim:TIMER设备描述,定义需要初始化的TIMER参数
返回值 返回成功或失败,返回0表示TIMER初始化成功,非0表示失败

调用示例

具体请参见使用示例

hal_timer_start

定义描述
定义 描述
函数原型 int32_t hal_timer_start(timer_dev_t *tim)
描述 启动指定的TIMER
参数 tim:TIMER设备描述
返回值 返回成功或失败,返回0表示TIMER启动成功,非0表示失败

调用示例

具体请参见使用示例

hal_timer_stop

定义描述
定义 描述
函数原型 int32_t hal_timer_stop(timer_dev_t *tim)
描述 停止指定的TIMER
参数 tim:TIMER设备描述
返回值 返回成功或失败,返回0表示TIMER停止成功,非0表示失败

调用示例

具体请参见使用示例

hal_timer_para_chg

定义描述
定义 描述
函数原型 int32_t hal_timer_para_chg(timer_dev_t *tim, timer_config_tpara)
描述 改变指定TIMER的参数
参数
  • tim:TIMER设备描述
  • para:TIMER配置信息
返回值 返回成功或失败,返回0表示TIMER参数改变成功,非0表示失败

调用示例

具体请参见使用示例

hal_timer_finalize

定义描述
定义 描述
函数原型 int32_t hal_timer_finalize(timer_dev_t *tim)
描述 关闭指定TIMER
参数 tim:TIMER设备描述
返回值 返回成功或失败,返回0表示TIMER关闭成功,非0表示失败

调用示例

具体请参见使用示例

相关宏定义

#define TIMER_RELOAD_AUTO  1 /* timer reload automatic */
#define TIMER_RELOAD_MANU  2 /* timer reload manual */

timer_dev_t数据结构

typedef struct {
    int8_t         port;   /* timer port */
    timer_config_t config; /* timer config */
    void          *priv;   /* priv data */
} timer_dev_t;

timer_config_t数据结构

typedef struct {
    uint32_t       period; /* us */
    uint8_t        reload_mode;
    hal_timer_cb_t cb;
    void          *arg;
} timer_config_t;

hal_timer_cb_t数据结构

typedef void (*hal_timer_cb_t)(void *arg);

使用示例

#include <aos/hal/timer.h>

#define TIMER1_PORT_NUM 1

/* define dev */
timer_dev_t timer1;

void timer_handler(void *arg)
{
    static int timer_cnt = 0;

    printf("timer_handler: %d times !\n", timer_cnt++);
}

int application_start(int argc, char *argv[])
{
    int ret = -1;
    timer_config_t timer_cfg;
    static int count = 0;

    /* timer port set */
    timer1.port = TIMER1_PORT_NUM;

    /* timer attr config */
    timer1.config.period         = 1000000; /* 1s */
    timer1.config.reload_mode    = TIMER_RELOAD_AUTO;
    timer1.config.cb             = timer_handler;

    /* init timer1 with the given settings */
    ret = hal_timer_init(&timer1);
    if (ret != 0) {
        printf("timer1 init error !\n");
        return -1;
    }

    /* start timer1 */
    ret = hal_timer_start(&timer1);
    if (ret != 0) {
        printf("timer1 start error !\n");
        hal_timer_finalize(&timer1);
        return -1;
    }

    while(1) {

        /* change the period to 2s */
        if (count == 5) {
            memset(&timer_cfg, 0, sizeof(timer_config_t));
            timer_cfg.period = 2000000;
            timer_cfg.reload_mode = timer1.config.reload_mode;
            timer_config.cb = timer1.config.cb;
            ret = hal_timer_para_chg(&timer1, timer_cfg);
            if (ret != 0) {
                printf("timer1 para change error !\n");
            }
        }

        /* stop and finalize timer1 */
        if (count == 20) {
            break;
        }

        /* sleep 1000ms */
        aos_msleep(1000);
        count++;
    };
hal_timer_stop(&timer1);
    hal_timer_finalize(&timer1);
}
说明
  • port为逻辑端口号,其与物理端口号的对应关系见具体的对接实现。
  • 移植前,请新建hal_timer_xxmcu.chal_timer_xxmcu.h的文件,并将这两个文件放到platform/mcu/xxmcu/hal目录下。在hal_timer_xxmcu.c中实现所需要的hal函数,hal_timer_xxmcu.h中放置相关宏定义。具体请参见platform/mcu/stm32l4xx_cube/hal/hal_timer_stm32l4.c