• Home
  • Annotate
  • current directory
Name Date Size #Lines LOC

..29-Oct-2021-

example/29-Oct-2021-

include/29-Oct-2021-

src/29-Oct-2021-

README.md A D29-Oct-20216.1 KiB203158

package.yaml A D29-Oct-20214.2 KiB

README.md

1@page uart UART
2
3[更正文档](https://gitee.com/alios-things/uart/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6UART设备VFS驱动子系统。
7
8## 版权说明
9> Apache license v2.0
10
11## 目录结构
12```tree
13├── src
14│   └── uart_dev.c          # HAL to VFS适配
15├── include
16│   └── aos
17│       ├── hal
18│       │   └── uart.h      # HAL API
19│       └── vfsdev
20│           └── uart_dev.h  # VFS API
21├── package.yaml            # 编译配置文件
22└── example
23    └── uart_example.c      # 示例代码（默认禁用，可在package.yaml中使能）
24```
25
26## 依赖组件
27* base
28* vfs
29
30# 常用配置
31无
32
33# API说明
34
35## 打开
36```c
37int open(const char *pathname, int flags);
38```
39|args                                    |description|
40|:-----                                  |:----|
41|pathname                                |UART设备VFS路径|
42|flags                                   |目前固定为0值|
43兼容POSIX标准的open接口。其中参数*pathname*为*/dev/ttyUART*加UART序号,例如:
44```c
45fd = open("/dev/ttyUART0", 0);
46```
47
48## 关闭
49```c
50int close(int fd);
51```
52兼容POSIX标准的close接口。
53
54## 接收数据
55```c
56ssize_t read(int fd, void *buf, size_t count);
57```
58兼容POSIX标准的read接口。接收缓冲区为空时返回0。
59
60## 发送数据
61```c
62ssize_t write(int fd, const void *buf, size_t count);
63```
64兼容POSIX标准的write接口。发送缓冲区已满时返回0。
65
66## 查询IO事件
67```c
68int poll(struct pollfd *fds, nfds_t nfds, int timeout);
69int select(int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout);
70```
71兼容POSIX标准的poll/select接口。
72
73## 设置属性
74```c
75int ioctl(int fd, IOC_UART_SET_CFLAG, unsigned long flags);
76```
77参数flags包含波特率、数据位数、校验方式等属性，各属性之间是逻辑或关系。
78### 波特率
79用*B*加波特率数值表示，例如*B115200*。
80### 数据位数
81|符号                           |含义|
82|:-----                         |:----|
83|CS5                            |数据长度5位|
84|CS6                            |数据长度6位|
85|CS7                            |数据长度7位|
86|CS8                            |数据长度8位|
87
88### 校验方式
89|符号                           |含义|
90|:-----                         |:----|
91|0                              |无校验|
92|PARENB                         |偶校验|
93|PARENB \| PARODD               |奇校验|
94
95# 使用示例
96组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
97待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
98
99## 步骤1 创建或打开工程
100
101**打开已有工程**
102
103如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
104
105**创建新的工程**
106
107组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
108
109## 步骤2 添加组件
110
111案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：
112
113```yaml
114
115depends:
116  - uart: master          # helloworld_demo中引入uart组件
117
118```
119
120## 步骤3 下载组件
121
122在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
123
124```shell
125
126aos install uart
127
128```
129
130上述命令执行成功后，组件源码则被下载到了./components/drivers/peripheral/uart路径中。
131
132## 步骤4 添加示例
133uart组件的package.yaml中添加example
134```yaml
135source_file:
136  - "src/*.c"
137  - "example/uart_example.c"
138```
139
140## 步骤5 编译固件
141
142在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
143
144## 步骤6 烧录固件
145
146helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
147
148## 步骤7 打开串口
149
150固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
151
152当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
153
154## 步骤8 测试示例
155
156UART接收测试，CLI命令行输入：
157```sh
158uartr <UART ID> <测试持续时间（ms）>
159```
160UART发送测试，CLI命令行输入：
161```sh
162uartw <UART ID> <待发送字符串>
163```
164UART回显测试，CLI命令行输入：
165```sh
166uarte <UART ID> <测试持续时间（ms）>
167```
168
169**关键日志**
170UART接收测试日志显示：
171```sh
172opening device:/dev/ttyUART<UART ID>
173set baudrate to 1500000
174set baudrate done
175<显示接收到的字符串>
176closing /dev/ttyUART<UART ID>
177/dev/ttyUART<UART ID> closed
178```
179UART发送测试日志显示：
180```sh
181opening device:/dev/ttyUART<UART ID>
182set baudrate to 1500000
183set baudrate done
184writing <待发送字符串>
185write return <write接口返回值>
186closing /dev/ttyUART<UART ID>
187/dev/ttyUART<UART ID> closed
188```
189UART回显测试（发送已接收到的数据）日志显示：
190```sh
191opening device:/dev/ttyUART<UART ID>
192set baudrate to 1500000
193set baudrate done
194closing /dev/ttyUART<UART ID>
195/dev/ttyUART<UART ID> closed
196```
197
198# 注意事项
199无
200
201# FAQ
202无
203