前文参考
[1] Zephyr内核Timeout模块简介
k_timer使用内核系统时钟测量时间,通过向其注册callback可以在指定的时刻执行应用定义的行为,也可以用于周期性计数,并由应用读取其计数状态。
特性
只要内存足够,内核不限制timer的数量。
Timer有两个关键时间参数duration和period
- duration:指定timer第一次到期的时间
- period: 指定timer第一次到期后,之后的到期时间间隔
可以注册到期回调函数,duration/period到期后会在时钟中断中回调该函数.
可以注册停止回调函数,在执行stop timer的线程中回调该函数.
timer维护一个status值,用于指示上一次读取状态到现在timer到期了多少次.
下图描述了以上特性
使用
API
#define K_TIMER_DEFINE(name, expiry_fn, stop_fn)
作用:定义一个k_timer,并初始化
name: k_timer name
expiry_fn: 到期回调
stop_fn:停止回调
void k_timer_init(struct k_timer *timer, k_timer_expiry_t expiry_fn, k_timer_stop_t stop_fn)
作用:初始化k_timer
timer: k_timer
expiry_fn: 到期回调
stop_fn:停止回调
void k_timer_start(struct k_timer *timer, k_timeout_t duration, k_timeout_t period)
作用:启动k_timer
timer: k_timer
duration: 第一次到期时间,不能传入K_FOREVER,传入K_NO_WAIT时,会在最近的一个tick中断到来时立即过期。
period:后续周期的到期时间,当传入K_FOREVER或K_NO_WAIT,在duration过期后timer自动停止
void k_timer_stop(struct k_timer *timer)
作用:停止k_timer
timer: k_timer
uint32_t k_timer_status_get(struct k_timer *timer)
作用:获取从上次读取到当前k_timer到期了多少次,每次读取后status被清0
timer: k_timer
返回值:到期次数
uint32_t k_timer_status_sync(struct k_timer *timer)
作用:等待timer到期或停止
timer: k_timer
返回值:到期次数
k_ticks_t k_timer_expires_ticks(const struct k_timer *timer)
作用:获取timer即将到期的时间
timer: k_timer
返回值:tick数
k_ticks_t k_timer_remaining_ticks(const struct k_timer *timer)
作用:获取timer还有多久到期
timer: k_timer
返回值:tick数
uint32_t k_timer_remaining_get(struct k_timer *timer)
作用:获取timer还有多久到期
timer: k_timer
返回值:毫秒数
void k_timer_user_data_set(struct k_timer *timer, void *user_data)
作用:设置timer的user data,该data会被传递给回调函数
timer: k_timer
user_data: user data
void *k_timer_user_data_get(const struct k_timer *timer)
作用:获取timer的user data,该data会被传递给回调函数
timer: k_timer
返回值: user data
使用说明
初始化
先定义初始化一个timer,下面两种方式的效果是一样的
使用函数
1 | struct k_timer my_timer; |
使用宏
1 | K_TIMER_DEFINE(my_timer, my_expiry_function, NULL); |
功能使用
1 | //启动后2s会调用一次my_expiry_function,然后每200ms会调用一次my_expiry_function |
使用注意事项
- 过期回调在中断中执行,要做耗费时间的动作
- k_timer过期可以保证至少过了多久,不能保证精确的定时
- 但其精度比k_sleep/k_usleep要高
- 测量执行时间时不建议使用k_timer,建议直接读硬件时钟
实现
k_timer的代码是kernel/timer.c,k_timer是由timeout模块实现,timeout的分析参考[1]
初始化timer
一个k_timer的结构体如下
1 | struct k_timer { |
timer的初始化就是对k_timer的数据结构各字段赋值
1 | void k_timer_init(struct k_timer *timer, |
启动Timer
k_timer_start->z_impl_k_timer_start
1 | void z_impl_k_timer_start(struct k_timer *timer, k_timeout_t duration, |
timer到期
duration到期后会调用z_timer_expiration_handler, 之后在z_timer_expiration_handler内再次添加period的timeout
1 | void z_timer_expiration_handler(struct _timeout *t) |
等待timer到期
线程可以通过k_timer_status_sync等待timer到期,timer到期后会在z_timer_expiration_handler将等待的线程重新加入到ready_q
k_timer_status_sync->z_impl_k_timer_status_sync
1 | uint32_t z_impl_k_timer_status_sync(struct k_timer *timer) |
通过读取过期次数状态也能知道timer是否过期,只是不会发生等待
1 | uint32_t z_impl_k_timer_status_get(struct k_timer *timer) |
停止timer
停止timer会将status清0,并将等待该timer的线程恢复运行
1 | void z_impl_k_timer_stop(struct k_timer *timer) |
其它API
user data
user data只是简单的设置和读取k_timer结构体内的user_data字段,这里就不再列出来
k_timer_user_data_get->z_impl_k_timer_user_data_get
k_timer_user_data_set->z_impl_k_timer_user_data_set
时间的获取
时间的获取都是封装timeout的API,可参考[1].这里列出调用关系,无需再做详细分析
k_timer_expires_ticks->z_impl_k_timer_expires_ticks->z_timeout_expires
k_timer_remaining_ticks->z_impl_k_timer_remaining_ticks->z_timeout_remaining
k_timer_remaining_get->k_ticks_to_ms_floor32(k_timer_remaining_ticks)