xuos
/
xuos-web
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

modify timer doc

This commit is contained in:
Yan_yan 2021-01-13 15:38:13 +08:00
parent 65295b860b
commit e1a79e9b0b
1 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/doc/kernel/tmr.md
View File

@ -62,19 +62,17 @@ xs_uint32 xs_CurrentTicksGain(void);
### 内核软件定时器结构定义
```c
#define TRIGGE_WAY_ONCE (1 << 0)
#define TRIGGE_WAY_PERIODIC (1 << 1)
struct xs_Timer
{
xs_uint8 id; ///< 定时器的ID
xs_uint8 trigge_mode; ///< 单次触发还是周期触发
void (*func_callback)(void *param); ///< 定时器回调函数
void *param; ///< 定时器回调函数的参数
xs_tick_x origin_timeslice; ///< 超时时间
xs_tick_x deadline_timeslice; ///< 截止时间
XS_DOUBLE_LINKLIST link; ///< 管理链表
XS_DOUBLE_LINKLIST Sortlist; ///< 查询链表
char name[XS_NAME_MAX];
xs_uint8 active_status;
xs_uint8 trigger_mode;
void (*func_callback)(void *param);
void *param;
xs_ticks_x origin_timeslice;
xs_ticks_x deadline_timeslice;
XS_DOUBLE_LINKLIST link;
XS_DOUBLE_LINKLIST sortlist;
};
typedef struct xs_Timer *xs_timer_x;
```
@ -95,10 +93,10 @@ typedef struct xs_Timer *xs_timer_x;
定时器用户操作结构体定义如下：
```c
#define TRIGGE_WAY_ONCE (1 << 0)
#define TRIGGE_WAY_PERIODIC (1 << 1)
#define TIMER_TRIGGER_ONCE (1 << 0)
#define TIMER_TRIGGER_PERIODIC (1 << 1)
xs_int32 xs_KTimerCreate(xs_uint8 trigge_way，void (*func_callback)(void *param)，void *func_param， xs_tick_x ticks);
xs_timer_t xs_KCreateTimer(const char *name, void (*timeout)(void *parameter), void *parameter, xs_ticks_x time, xs_uint8 trigger_mode);
```
该函数用于创建一个内核软件定时器，并返回创建成功的软件定时器的ID，ID默认范围0-255，可配置。