1@page timer timer
2
3**[更正文档](https://gitee.com/alios-things/timer/edit/master/README.md)**      **[贡献说明](https://help.aliyun.com/document_detail/302301.html)**
4
5# 概述
6Timer，即通用硬件定时器。
7该组件是Timer VFS驱动子系统，给应用或组件提供通过VFS形式（open/close/ioctl）访问硬件Timer驱动对上层提供服务的接口。该组件初始化过程中，会根据hardware/chip/<chip_name>/package.yaml中定义的CONFIG_TIMER_NUM来依此创建如下名称的设备节点：
8* /dev/timer0
9* /dev/timer1
10* ...
11* /dev/timer[CONFIG_TIMER_NUM - 1]
12
13组件支持以下功能：
14- 设置定时器运行周期
15- 设置中断回调函数
16- 启动/停止定时器
17
18## 版权信息
19> Apache license v2.0
20
21## 目录结构
22```tree
23.
24├── example
25│   └── timer_example.c  #Timer示例代码
26├── include
27│   ├── aos
28│   │   └── hal
29│   │       └── timer.h   #Timer HAL API申明
30│   └── vfsdev
31│       └── timer_dev.h   #Timer设备API申明
32├── package.yaml          #编译和配置文件
33├── README.md             #使用文档
34└── src
35    └── timer_dev.c       #Timer设备实现代码
36```
37
38## 依赖组件
39* base     # 最底层核心驱动模型、驱动自动加载机制以及Device VFS core
40* vfs      # VFS API抽象库
41
42# 常用配置
43本组件可以通过CONFIG_TIMER_NUM配置对上层提供设备节点的数量，CONFIG_TIMER_NUM代表芯片内部的硬件定时器控制器的数量。
44CONFIG_TIMER_NUM默认是在hardware/chip/<chip_name>/package.yaml中的**define**节点进行配置。
45如果没有定义CONFIG_TIMER_NUM，则代码中会定义默认对外输出的设备节点数量。
46> 设备节点数量: 默认4个, 如需修改，在hardware/chip/<chip_name>/package.yaml中修改CONFIG_TIMER_NUM配置
47```yaml
48define:
49  CONFIG_TIMER_NUM: 1
50```
51
52# API说明
53## 打开设备节点
54```c
55int open(const char *pathname, int flags);
56```
57
58|args                                    |description|
59|:-----                                  |:----|
60|pathname                                |硬件定时器外设VFS路径|
61|flags                                   |目前固定为0值|
62
63兼容POSIX标准的open接口。其中参数*pathname*为*/dev/timer*加硬件定时器外设id，例如*/dev/timer0*。
64
65## 关闭设备节点
66```c
67int close(int fd);
68```
69兼容POSIX标准的close接口。
70
71## 设置定时器参数
72在需要设定硬件定时器的定时及超时处理函数的时候呼叫此API
73```c
74int ioctl(int fd, IOC_TIMER_IRQP_SET, unsigned long arg);
75// arg为指向timer_alarm_t结构体的指针
76// 如需设定周期为500ms的周期性定时器，并在硬件定时器到期后呼叫timer_handler(argument_pointer),代码如下：
77timer_alarm_t ralarm;
78alarm.arg = argument_pointer; // 呼叫定时器到期处理函数的时候传入的参数
79alarm.cb = timer_handler;     // 定时器到期处理函数指针
80alarm.period = 500000;        // 单位:ms
81alarm.auto_reload = true;     // 开启自动重新加载硬件定时器功能
82ioctl (fd, IOC_TIMER_IRQP_SET, &ralarm);
83```
84
85## 获取定时器当前设定参数
86在需要获取硬件定时器的当前的定时参数的时候呼叫此API
87```c
88int ioctl(int fd, IOC_TIMER_IRQP_GET, unsigned long arg);
89
90// 示例代码
91timer_alarm_t ralarm;
92ioctl (fd, IOC_TIMER_IRQP_GET, &alarm);
93```
94
95## 开启/停止定时器
96
97```c
98int ioctl(int fd, IOC_TIMER_CONTROL, unsigned long arg);
99
100// arg为IO_TIMER_START代表开启定时器, 示例代码：
101ioctl (fd, IOC_TIMER_CONTROL, IO_TIMER_START)
102// arg为IO_TIMER_STOP代表停止定时器
103ioctl (fd, IOC_TIMER_CONTROL, IO_TIMER_STOP)
104```
105
106## 控制定时器是否自动重新加载
107```c
108int ioctl(int fd, IOC_TIMER_RELOAD, unsigned long arg);
109
110// arg为true代表开启自动重载定时器功能, 示例代码：
111ioctl (fd, IOC_TIMER_RELOAD, true)
112// arg为false代表停止自动重载定时器功能, 示例代码：
113ioctl (fd, IOC_TIMER_RELOAD, false)
114```
115
116# 使用示例
117
118组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
119待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
120
121## 步骤1 创建或打开工程
122
123**打开已有工程**
124
125如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
126
127**创建新的工程**
128
129组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
130
131## 步骤2 添加组件
132案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：
133```yaml
134depends:
135  - timer: master # helloworld_demo中引入timer组件
136```
137
138## 步骤3 下载组件
139
140在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
141
142```shell
143
144aos install timer
145
146```
147
148上述命令执行成功后，组件源码则被下载到了./components/drivers/peripheral/timer路径中。
149
150## 步骤4 添加示例
151
152在timer组件的package.yaml中添加[example示例代码](https://gitee.com/alios-things/timer/tree/master/example)：
153```yaml
154source_file:
155  原有其他文件
156  - example/timer_example.c # add timer_example.c
157```
158## 步骤5 编译固件
159
160在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
161
162## 步骤6 烧录固件
163
164helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
165
166## 步骤7 打开串口
167
168固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
169
170当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
171
172## 步骤8 测试示例
173
174**CLI命令行输入：**
175```shell
176timer_example id
177```
178其中id取值范围：[0, CONFIG_TIMER_NUM)
179
180> 关键日志
181```shell
182vfs timer test success, ret:0
183```
184
185# 注意事项
186无
187
188# FAQ
189无
190