XTINY HAL 硬件定时器模块接口更多...

宏定义
#define	XT_HAL_TIMER_INVALID_ID (0xFFFF)
#define	XT_HAL_TIMER_ACTIVE_BITS_S (0)
#define	XT_HAL_TIMER_ACTIVE_BITS_W (1)
#define	XT_HAL_TIMER_AUTO_RELOAD_BITS_S (1)
#define	XT_HAL_TIMER_AUTO_RELOAD_BITS_W (1)
#define	XT_HAL_TIMER_DIR_BITS_S (2)
#define	XT_HAL_TIMER_DIR_BITS_W (2)
#define	XT_HAL_TIMER_START (0x00 << XT_HAL_TIMER_ACTIVE_BITS_S)
#define	XT_HAL_TIMER_STOP (0x01 << XT_HAL_TIMER_ACTIVE_BITS_S)
#define	XT_HAL_TIMER_ONE_SHOT (0x00 << XT_HAL_TIMER_AUTO_RELOAD_BITS_S)
#define	XT_HAL_TIMER_PERIODIC (0x01 << XT_HAL_TIMER_AUTO_RELOAD_BITS_S)
#define	XT_HAL_TIMER_DIR_UP (0x00 << XT_HAL_TIMER_DIR_BITS_S)
#define	XT_HAL_TIMER_DIR_DOWN (0x01 << XT_HAL_TIMER_DIR_BITS_S)
#define	XT_HAL_TIMER_DEFAULT_MODE (XT_HAL_TIMER_PERIODIC \| XT_HAL_TIMER_DIR_UP \| XT_HAL_TIMER_START)

类型定义
typedef void(*	xt_hal_timer_cb_t) (uint8_t timer_id, uint32_t event_id)
	定时器回调函数类型定义

枚举
enum	xt_hal_timer_event_id { XT_HAL_TIMER_EVENT_TIMEOUT = 0x00 }
	定时器事件 ID 枚举更多...

函数
xt_err_t	xt_hal_timer_setup (uint8_t timer_id, uint32_t mode, uint32_t tick_freq_hz, uint32_t tick_num, xt_hal_timer_cb_t cb)
	初始化定时器
xt_err_t	xt_hal_timer_close (uint8_t timer_id)
	关闭定时器
xt_err_t	xt_hal_timer_start (uint8_t timer_id)
	启动定时器
xt_err_t	xt_hal_timer_stop (uint8_t timer_id)
	停止定时器
uint32_t	xt_hal_timer_get_clk_src_freq (uint8_t timer_id)
	获取定时器时钟源频率
uint32_t	xt_hal_timer_get_prescaler (uint8_t timer_id)
	获取定时器实际分频值
uint32_t	xt_hal_timer_get_count (uint8_t timer_id)
	获取定时器当前计数值

详细描述

XTINY HAL 硬件定时器模块接口

宏定义说明

◆ XT_HAL_TIMER_ACTIVE_BITS_S

#define XT_HAL_TIMER_ACTIVE_BITS_S (0)

在文件 xt_hal_timer.h 第 35 行定义.

◆ XT_HAL_TIMER_ACTIVE_BITS_W

#define XT_HAL_TIMER_ACTIVE_BITS_W (1)

在文件 xt_hal_timer.h 第 36 行定义.

◆ XT_HAL_TIMER_AUTO_RELOAD_BITS_S

#define XT_HAL_TIMER_AUTO_RELOAD_BITS_S (1)

在文件 xt_hal_timer.h 第 37 行定义.

◆ XT_HAL_TIMER_AUTO_RELOAD_BITS_W

#define XT_HAL_TIMER_AUTO_RELOAD_BITS_W (1)

在文件 xt_hal_timer.h 第 38 行定义.

◆ XT_HAL_TIMER_DEFAULT_MODE

#define XT_HAL_TIMER_DEFAULT_MODE (XT_HAL_TIMER_PERIODIC | XT_HAL_TIMER_DIR_UP | XT_HAL_TIMER_START)

默认模式：周期+向上+立即启动

在文件 xt_hal_timer.h 第 48 行定义.

◆ XT_HAL_TIMER_DIR_BITS_S

#define XT_HAL_TIMER_DIR_BITS_S (2)

在文件 xt_hal_timer.h 第 39 行定义.

◆ XT_HAL_TIMER_DIR_BITS_W

#define XT_HAL_TIMER_DIR_BITS_W (2)

在文件 xt_hal_timer.h 第 40 行定义.

◆ XT_HAL_TIMER_DIR_DOWN

#define XT_HAL_TIMER_DIR_DOWN (0x01 << XT_HAL_TIMER_DIR_BITS_S)

向下计数

在文件 xt_hal_timer.h 第 47 行定义.

◆ XT_HAL_TIMER_DIR_UP

#define XT_HAL_TIMER_DIR_UP (0x00 << XT_HAL_TIMER_DIR_BITS_S)

向上计数

在文件 xt_hal_timer.h 第 46 行定义.

◆ XT_HAL_TIMER_INVALID_ID

#define XT_HAL_TIMER_INVALID_ID (0xFFFF)

在文件 xt_hal_timer.h 第 33 行定义.

◆ XT_HAL_TIMER_ONE_SHOT

#define XT_HAL_TIMER_ONE_SHOT (0x00 << XT_HAL_TIMER_AUTO_RELOAD_BITS_S)

单次触发模式

在文件 xt_hal_timer.h 第 44 行定义.

◆ XT_HAL_TIMER_PERIODIC

#define XT_HAL_TIMER_PERIODIC (0x01 << XT_HAL_TIMER_AUTO_RELOAD_BITS_S)

周期触发模式

在文件 xt_hal_timer.h 第 45 行定义.

◆ XT_HAL_TIMER_START

#define XT_HAL_TIMER_START (0x00 << XT_HAL_TIMER_ACTIVE_BITS_S)

初始化后立即启动

在文件 xt_hal_timer.h 第 42 行定义.

◆ XT_HAL_TIMER_STOP

#define XT_HAL_TIMER_STOP (0x01 << XT_HAL_TIMER_ACTIVE_BITS_S)

初始化后不启动

在文件 xt_hal_timer.h 第 43 行定义.

类型定义说明

◆ xt_hal_timer_cb_t

typedef void(* xt_hal_timer_cb_t) (uint8_t timer_id, uint32_t event_id)

定时器回调函数类型定义

参数

timer_id	定时器索引
event_id	事件 ID，见 xt_hal_timer_event_id

在文件 xt_hal_timer.h 第 65 行定义.

枚举类型说明

◆ xt_hal_timer_event_id

enum xt_hal_timer_event_id

定时器事件 ID 枚举

枚举值
XT_HAL_TIMER_EVENT_TIMEOUT	定时器超时

在文件 xt_hal_timer.h 第 55 行定义.

函数说明

◆ xt_hal_timer_close()

xt_err_t xt_hal_timer_close ( uint8_t timer_id )

关闭定时器

参数

timer_id 定时器索引

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_hal_timer_get_clk_src_freq()

uint32_t xt_hal_timer_get_clk_src_freq ( uint8_t timer_id )

获取定时器时钟源频率

定时器实际频率 = xt_hal_timer_get_clk_src_freq(timer_id) / xt_hal_timer_get_prescaler(timer_id)

参数

timer_id 定时器索引

返回: uint32_t 时钟源频率（单位：Hz）

注解: 此为时钟源频率，非定时器输出频率。定时器输出频率由时钟源频率和预分频值共同决定。

◆ xt_hal_timer_get_count()

uint32_t xt_hal_timer_get_count ( uint8_t timer_id )

获取定时器当前计数值

参数

timer_id 定时器索引

返回: uint32_t 当前计数值

◆ xt_hal_timer_get_prescaler()

uint32_t xt_hal_timer_get_prescaler ( uint8_t timer_id )

获取定时器实际分频值

返回结果 = psc + 1，参数错误时返回 0。

参数

timer_id 定时器索引

返回: uint32_t 分频值（psc + 1），参数错误时返回 0

◆ xt_hal_timer_setup()

xt_err_t xt_hal_timer_setup	(	uint8_t	timer_id,
		uint32_t	mode,
		uint32_t	tick_freq_hz,
		uint32_t	tick_num,
		xt_hal_timer_cb_t	cb )

初始化定时器

注解: 调用回调的时间（定时器超时时间） = tick_num / tick_freq_hz

参数

timer_id	定时器索引
mode	定时器模式，见 XT_HAL_TIMER_ONE_SHOT, XT_HAL_TIMER_PERIODIC 等
tick_freq_hz	定时器频率，单位 Hz, 内部从时钟源分频到最接近参数的频率。 tick_freq_hz 传入 0 时，内部最大分频 tick_freq_hz 传入 0xFFFFFFFFUL 时，内部不分频。 tick_freq_hz 用于计算预分频值: psc = (timer_clk_src_freq / tick_freq_hz) - 1;
tick_num	回调触发前定时器经历的 tick 数量最小值不一定为 1，取决平台实现
cb	定时器回调函数，见 xt_hal_timer_cb_t

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_hal_timer_start()

xt_err_t xt_hal_timer_start ( uint8_t timer_id )

启动定时器

参数

timer_id 定时器索引

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_hal_timer_stop()

xt_err_t xt_hal_timer_stop ( uint8_t timer_id )

停止定时器

参数

timer_id 定时器索引

返回: xt_err_t XT_EOK 成功，其他失败