Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“ca988bdc98bf560a833e1033ccced92afb5e5aff”上不存在“python/paddle/git@gitcode.net:s920243400/PaddleDetection.git”
未验证 提交 44d901bb 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!6888 【文档体验官】UART驱动格式及表达问题 

Merge pull request !6888 from king_he/0708-a
上级 3f2e9b33 65667ce0
隐藏空白更改
内联 并排
Showing with 192 addition and 640 deletion
zh-cn/device-dev/driver/driver-platform-uart-des.md
浏览文件 @ 44d901bb
# UART<a name="ZH-CN_TOPIC_0000001160652800"></a> # UART<a name="ZH-CN_TOPIC_0000001160652800"></a>
- [概述](#section833012453535)
- [接口说明](#section1928742202715) ## 概述
- [使用指导](#section12779050105412)
- [使用流程](#section1858116395510) UART指异步收发传输器（Universal Asynchronous Receiver/Transmitter），是通用串行数据总线，用于异步通信。该总线双向通信，可以实现全双工传输。
- [获取UART设备句柄](#section124512065617)
- [UART设置波特率](#section86881004579) UART应用比较广泛，常用于输出打印信息，也可以外接各种模块，如GPS、蓝牙等。
- [UART获取波特率](#section897032965712)
- [UART设置设备属性](#section129141884588) 两个UART设备的连接示意图如下，UART与其他模块一般用2线（图1）或4线（图2）相连，它们分别是：
- [UART获取设备属性](#section18689637165812) - TX：发送数据端，和对端的RX相连。
- [设置UART传输模式](#section72713435918) - RX：接收数据端，和对端的TX相连。
- [向UART设备写入指定长度的数据](#section128001736155919) - RTS：发送请求信号，用于指示本设备是否准备好，可接受数据，和对端CTS相连。
- [从UART设备中读取指定长度的数据](#section92851601604) - CTS：允许发送信号，用于判断是否可以向对端发送数据，和对端RTS相连。
- [销毁UART设备句柄](#section1477410521406)
- [使用实例](#section35404241311)
## 概述<a name="section833012453535"></a>
- UART是通用异步收发传输器（Universal Asynchronous Receiver/Transmitter）的缩写，是通用串行数据总线，用于异步通信。该总线双向通信，可以实现全双工传输。
- UART应用比较广泛，常用于输出打印信息，也可以外接各种模块，如GPS、蓝牙等。
- 两个UART设备的连接示意图如下，UART与其他模块一般用2线（图1）或4线（图2）相连，它们分别是：
- TX：发送数据端，和对端的RX相连；
- RX：接收数据端，和对端的TX相连；
- RTS：发送请求信号，用于指示本设备是否准备好，可接受数据，和对端CTS相连；
- CTS：允许发送信号，用于判断是否可以向对端发送数据，和对端RTS相连；
**图 1** 2线UART设备连接示意图<a name="fig68294715408"></a> **图 1** 2线UART设备连接示意图<a name="fig68294715408"></a>
![](figures/2线UART设备连接示意图.png "2线UART设备连接示意图") ![](figures/2线UART设备连接示意图.png "2线UART设备连接示意图")
...@@ -40,75 +27,17 @@ ...@@ -40,75 +27,17 @@
**表 1** UART驱动API接口功能介绍 **表 1** UART驱动API接口功能介绍
<a name="table1731550155318"></a> | 接口名 | 接口描述 |
<table><thead align="left"><tr id="row1223152681611"><th class="cellrowborder" valign="top" width="26.619999999999997%" id="mcps1.2.4.1.1"><p id="p210413571619"><a name="p210413571619"></a><a name="p210413571619"></a>功能分类</p> | -------- | -------- |
</th> | UartOpen | UART获取设备句柄 |
<th class="cellrowborder" valign="top" width="31.369999999999997%" id="mcps1.2.4.1.2"><p id="p810403511614"><a name="p810403511614"></a><a name="p810403511614"></a>接口名</p> | UartClose | UART释放设备句柄 |
</th> | UartRead | 从UART设备中读取指定长度的数据 |
<th class="cellrowborder" valign="top" width="42.01%" id="mcps1.2.4.1.3"><p id="p110418354161"><a name="p110418354161"></a><a name="p110418354161"></a>描述</p> | UartWrite | 向UART设备中写入指定长度的数据 |
</th> | UartGetBaud | UART获取波特率 |
</tr> | UartSetBaud | UART设置波特率 |
</thead> | UartGetAttribute | UART获取设备属性 |
<tbody><tr id="row1638573613415"><td class="cellrowborder" rowspan="2" valign="top" width="26.619999999999997%" headers="mcps1.2.4.1.1 "><p id="p917154316414"><a name="p917154316414"></a><a name="p917154316414"></a>UART获取/释放设备句柄</p> | UartSetAttribute | UART设置设备属性 |
<p id="p9596111154212"><a name="p9596111154212"></a><a name="p9596111154212"></a></p> | UartSetTransMode | UART设置传输模式 |
</td>
<td class="cellrowborder" valign="top" width="31.369999999999997%" headers="mcps1.2.4.1.2 "><p id="p20385163614412"><a name="p20385163614412"></a><a name="p20385163614412"></a>UartOpen</p>
</td>
<td class="cellrowborder" valign="top" width="42.01%" headers="mcps1.2.4.1.3 "><p id="p12101135184213"><a name="p12101135184213"></a><a name="p12101135184213"></a>UART获取设备句柄</p>
</td>
</tr>
<tr id="row5950143316415"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p149501733134113"><a name="p149501733134113"></a><a name="p149501733134113"></a>UartClose</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p371073520422"><a name="p371073520422"></a><a name="p371073520422"></a>UART释放设备句柄</p>
</td>
</tr>
<tr id="row34145016535"><td class="cellrowborder" rowspan="2" valign="top" width="26.619999999999997%" headers="mcps1.2.4.1.1 "><p id="p229610227124"><a name="p229610227124"></a><a name="p229610227124"></a>UART读写接口</p>
<p id="p131072201215"><a name="p131072201215"></a><a name="p131072201215"></a></p>
</td>
<td class="cellrowborder" valign="top" width="31.369999999999997%" headers="mcps1.2.4.1.2 "><p id="p8296182221219"><a name="p8296182221219"></a><a name="p8296182221219"></a>UartRead</p>
</td>
<td class="cellrowborder" valign="top" width="42.01%" headers="mcps1.2.4.1.3 "><p id="p16297172213125"><a name="p16297172213125"></a><a name="p16297172213125"></a>从UART设备中读取指定长度的数据</p>
</td>
</tr>
<tr id="row11585016539"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p1095722493616"><a name="p1095722493616"></a><a name="p1095722493616"></a>UartWrite</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p15297162215122"><a name="p15297162215122"></a><a name="p15297162215122"></a>向UART设备中写入指定长度的数据</p>
</td>
</tr>
<tr id="row8687115843715"><td class="cellrowborder" rowspan="2" valign="top" width="26.619999999999997%" headers="mcps1.2.4.1.1 "><p id="p196317143813"><a name="p196317143813"></a><a name="p196317143813"></a>UART获取/设置波特率接口</p>
</td>
<td class="cellrowborder" valign="top" width="31.369999999999997%" headers="mcps1.2.4.1.2 "><p id="p166885582375"><a name="p166885582375"></a><a name="p166885582375"></a>UartGetBaud</p>
</td>
<td class="cellrowborder" valign="top" width="42.01%" headers="mcps1.2.4.1.3 "><p id="p13688358183716"><a name="p13688358183716"></a><a name="p13688358183716"></a>UART获取波特率</p>
</td>
</tr>
<tr id="row18987529382"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p698719214383"><a name="p698719214383"></a><a name="p698719214383"></a>UartSetBaud</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p1398712123810"><a name="p1398712123810"></a><a name="p1398712123810"></a>UART设置波特率</p>
</td>
</tr>
<tr id="row1551850115317"><td class="cellrowborder" rowspan="2" valign="top" width="26.619999999999997%" headers="mcps1.2.4.1.1 "><p id="p1629782201218"><a name="p1629782201218"></a><a name="p1629782201218"></a>UART获取/设置设备属性</p>
<p id="p10308192211216"><a name="p10308192211216"></a><a name="p10308192211216"></a></p>
</td>
<td class="cellrowborder" valign="top" width="31.369999999999997%" headers="mcps1.2.4.1.2 "><p id="p32972022151218"><a name="p32972022151218"></a><a name="p32972022151218"></a>UartGetAttribute</p>
</td>
<td class="cellrowborder" valign="top" width="42.01%" headers="mcps1.2.4.1.3 "><p id="p13297122216123"><a name="p13297122216123"></a><a name="p13297122216123"></a>UART获取设备属性</p>
</td>
</tr>
<tr id="row7545065311"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p102974224120"><a name="p102974224120"></a><a name="p102974224120"></a>UartSetAttribute</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p152971322111219"><a name="p152971322111219"></a><a name="p152971322111219"></a>UART设置设备属性</p>
</td>
</tr>
<tr id="row14614115403"><td class="cellrowborder" valign="top" width="26.619999999999997%" headers="mcps1.2.4.1.1 "><p id="p1746281144010"><a name="p1746281144010"></a><a name="p1746281144010"></a>UART设置传输模式</p>
</td>
<td class="cellrowborder" valign="top" width="31.369999999999997%" headers="mcps1.2.4.1.2 "><p id="p1146215112405"><a name="p1146215112405"></a><a name="p1146215112405"></a>UartSetTransMode</p>
</td>
<td class="cellrowborder" valign="top" width="42.01%" headers="mcps1.2.4.1.3 "><p id="p11303181216414"><a name="p11303181216414"></a><a name="p11303181216414"></a>UART设置传输模式</p>
</td>
</tr>
</tbody>
</table>
>![](../public_sys-resources/icon-note.gif) **说明：** >![](../public_sys-resources/icon-note.gif) **说明：**
>本文涉及的所有接口，仅限内核态使用，不支持在用户态使用。 >本文涉及的所有接口，仅限内核态使用，不支持在用户态使用。
...@@ -130,35 +59,12 @@ DevHandle UartOpen\(uint32\_t port\); ...@@ -130,35 +59,12 @@ DevHandle UartOpen\(uint32\_t port\);
**表 2** UartOpen参数和返回值描述 **表 2** UartOpen参数和返回值描述
<a name="table14222165114310"></a> | 参数 | 参数描述 |
<table><thead align="left"><tr id="row1022175133111"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p13221551153117"><a name="p13221551153117"></a><a name="p13221551153117"></a>参数</p> | -------- | -------- |
</th> | port | UART设备号 |
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p122211251103111"><a name="p122211251103111"></a><a name="p122211251103111"></a>参数描述</p> | **返回值** | **返回值描述** |
</th> | NULL | 获取UART设备句柄失败 |
</tr> | 设备句柄 | UART设备句柄 |
</thead>
<tbody><tr id="row6222451133114"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p92221518315"><a name="p92221518315"></a><a name="p92221518315"></a>port</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1322217518318"><a name="p1322217518318"></a><a name="p1322217518318"></a>UART设备号</p>
</td>
</tr>
<tr id="row1122245153112"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p102221451123118"><a name="p102221451123118"></a><a name="p102221451123118"></a><strong id="b1922235110318"><a name="b1922235110318"></a><a name="b1922235110318"></a>返回值</strong></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1122215143113"><a name="p1122215143113"></a><a name="p1122215143113"></a><strong id="b19222205193117"><a name="b19222205193117"></a><a name="b19222205193117"></a>返回值描述</strong></p>
</td>
</tr>
<tr id="row522275114317"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p422235114313"><a name="p422235114313"></a><a name="p422235114313"></a>NULL</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p5222351203112"><a name="p5222351203112"></a><a name="p5222351203112"></a>获取UART设备句柄失败</p>
</td>
</tr>
<tr id="row1222212513311"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p5222125115316"><a name="p5222125115316"></a><a name="p5222125115316"></a>设备句柄</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p192228515311"><a name="p192228515311"></a><a name="p192228515311"></a>UART设备句柄</p>
</td>
</tr>
</tbody>
</table>
假设系统中的UART端口号为3，获取该UART设备句柄的示例如下： 假设系统中的UART端口号为3，获取该UART设备句柄的示例如下：
...@@ -180,42 +86,15 @@ int32\_t UartSetBaud\(DevHandle handle, uint32\_t baudRate\); ...@@ -180,42 +86,15 @@ int32\_t UartSetBaud\(DevHandle handle, uint32\_t baudRate\);
**表 3** UartSetBaud参数和返回值描述 **表 3** UartSetBaud参数和返回值描述
<a name="table539135313325"></a> | 参数 | 参数描述 |
<table><thead align="left"><tr id="row15391205311323"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p11390453103216"><a name="p11390453103216"></a><a name="p11390453103216"></a>参数</p> | -------- | -------- |
</th> | handle | UART设备句柄 |
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p839065316328"><a name="p839065316328"></a><a name="p839065316328"></a>参数描述</p> | baudRate | 待设置的波特率值 |
</th> | **返回值** | **返回值描述** |
</tr> | 0 | UART设置波特率成功 |
</thead> | 负数 | UART设置波特率失败 |
<tbody><tr id="row2039115373216"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1639165310324"><a name="p1639165310324"></a><a name="p1639165310324"></a>handle</p>
</td> 假设需要设置的UART波特率为9600，示例代码如下：
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p539115320328"><a name="p539115320328"></a><a name="p539115320328"></a>UART设备句柄</p>
</td>
</tr>
<tr id="row163911753143214"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p13911653203215"><a name="p13911653203215"></a><a name="p13911653203215"></a>baudRate</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p163919537322"><a name="p163919537322"></a><a name="p163919537322"></a>待设置的波特率值</p>
</td>
</tr>
<tr id="row539155343218"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1039185313321"><a name="p1039185313321"></a><a name="p1039185313321"></a><strong id="b139195343217"><a name="b139195343217"></a><a name="b139195343217"></a>返回值</strong></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p123911753143213"><a name="p123911753143213"></a><a name="p123911753143213"></a><strong id="b143911353163218"><a name="b143911353163218"></a><a name="b143911353163218"></a>返回值描述</strong></p>
</td>
</tr>
<tr id="row2391853153218"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p17391185310322"><a name="p17391185310322"></a><a name="p17391185310322"></a>0</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p14391653193210"><a name="p14391653193210"></a><a name="p14391653193210"></a>UART设置波特率成功</p>
</td>
</tr>
<tr id="row23912053143211"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p7391165320321"><a name="p7391165320321"></a><a name="p7391165320321"></a>负数</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p639185318322"><a name="p639185318322"></a><a name="p639185318322"></a>UART设置波特率失败</p>
</td>
</tr>
</tbody>
</table>
假设需要设置的UART波特率为9600，设置波特率的实例如下：
``` ```
int32_t ret; int32_t ret;
...@@ -234,42 +113,15 @@ int32\_t UartGetBaud\(DevHandle handle, uint32\_t \*baudRate\); ...@@ -234,42 +113,15 @@ int32\_t UartGetBaud\(DevHandle handle, uint32\_t \*baudRate\);
**表 4** UartGetBaud参数和返回值描述 **表 4** UartGetBaud参数和返回值描述
<a name="table20393185311326"></a> | 参数 | 参数描述 |
<table><thead align="left"><tr id="row19392653123215"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p6392105315326"><a name="p6392105315326"></a><a name="p6392105315326"></a>参数</p> | -------- | -------- |
</th> | handle | UART设备句柄 |
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p53920531329"><a name="p53920531329"></a><a name="p53920531329"></a>参数描述</p> | baudRate | 接收波特率值的指针 |
</th> | **返回值** | **返回值描述** |
</tr> | 0 | UART获取波特率成功 |
</thead> | 负数 | UART获取波特率失败 |
<tbody><tr id="row103921553103211"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1539220536326"><a name="p1539220536326"></a><a name="p1539220536326"></a>handle</p>
</td> 获取波特率的示例代码如下：
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p6392553203217"><a name="p6392553203217"></a><a name="p6392553203217"></a>UART设备句柄</p>
</td>
</tr>
<tr id="row1539211532322"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p93921053123210"><a name="p93921053123210"></a><a name="p93921053123210"></a>baudRate</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p93926536328"><a name="p93926536328"></a><a name="p93926536328"></a>接收波特率值的指针</p>
</td>
</tr>
<tr id="row1239318531326"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p17392653123213"><a name="p17392653123213"></a><a name="p17392653123213"></a><strong id="b3392165383219"><a name="b3392165383219"></a><a name="b3392165383219"></a>返回值</strong></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1339365316327"><a name="p1339365316327"></a><a name="p1339365316327"></a><strong id="b63932053183218"><a name="b63932053183218"></a><a name="b63932053183218"></a>返回值描述</strong></p>
</td>
</tr>
<tr id="row143939531328"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p2393953153213"><a name="p2393953153213"></a><a name="p2393953153213"></a>0</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p8393165383218"><a name="p8393165383218"></a><a name="p8393165383218"></a>UART获取波特率成功</p>
</td>
</tr>
<tr id="row5393105363210"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p17393125363215"><a name="p17393125363215"></a><a name="p17393125363215"></a>负数</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1539325393211"><a name="p1539325393211"></a><a name="p1539325393211"></a>UART获取波特率失败</p>
</td>
</tr>
</tbody>
</table>
获取波特率的实例如下：
``` ```
int32_t ret; int32_t ret;
...@@ -289,42 +141,15 @@ int32\_t UartSetAttribute\(DevHandle handle, struct UartAttribute \*attribute\) ...@@ -289,42 +141,15 @@ int32\_t UartSetAttribute\(DevHandle handle, struct UartAttribute \*attribute\)
**表 5** UartSetAttribute参数和返回值描述 **表 5** UartSetAttribute参数和返回值描述
<a name="table1453119335341"></a> | 参数 | 参数描述 |
<table><thead align="left"><tr id="row3530433103416"><th class="cellrowborder" valign="top" width="49.980000000000004%" id="mcps1.2.3.1.1"><p id="p1853073310341"><a name="p1853073310341"></a><a name="p1853073310341"></a>参数</p> | -------- | -------- |
</th> | handle | UART设备句柄 |
<th class="cellrowborder" valign="top" width="50.019999999999996%" id="mcps1.2.3.1.2"><p id="p553083393417"><a name="p553083393417"></a><a name="p553083393417"></a>参数描述</p> | attribute | 待设置的设备属性 |
</th> | **返回值** | **返回值描述** |
</tr> | 0 | UART设置设备属性成功 |
</thead> | 负数 | UART设置设备属性失败 |
<tbody><tr id="row55303331347"><td class="cellrowborder" valign="top" width="49.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p1530113313341"><a name="p1530113313341"></a><a name="p1530113313341"></a>handle</p>
</td> 设置UART的设备属性的示例代码如下：
<td class="cellrowborder" valign="top" width="50.019999999999996%" headers="mcps1.2.3.1.2 "><p id="p3530173313346"><a name="p3530173313346"></a><a name="p3530173313346"></a>UART设备句柄</p>
</td>
</tr>
<tr id="row45309337342"><td class="cellrowborder" valign="top" width="49.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p553083319348"><a name="p553083319348"></a><a name="p553083319348"></a>attribute</p>
</td>
<td class="cellrowborder" valign="top" width="50.019999999999996%" headers="mcps1.2.3.1.2 "><p id="p5530133314343"><a name="p5530133314343"></a><a name="p5530133314343"></a>待设置的设备属性</p>
</td>
</tr>
<tr id="row12530833103415"><td class="cellrowborder" valign="top" width="49.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p185309331345"><a name="p185309331345"></a><a name="p185309331345"></a><strong id="b145302033193410"><a name="b145302033193410"></a><a name="b145302033193410"></a>返回值</strong></p>
</td>
<td class="cellrowborder" valign="top" width="50.019999999999996%" headers="mcps1.2.3.1.2 "><p id="p145309332344"><a name="p145309332344"></a><a name="p145309332344"></a><strong id="b553018331348"><a name="b553018331348"></a><a name="b553018331348"></a>返回值描述</strong></p>
</td>
</tr>
<tr id="row14530203310348"><td class="cellrowborder" valign="top" width="49.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p1653014339343"><a name="p1653014339343"></a><a name="p1653014339343"></a>0</p>
</td>
<td class="cellrowborder" valign="top" width="50.019999999999996%" headers="mcps1.2.3.1.2 "><p id="p1453023323419"><a name="p1453023323419"></a><a name="p1453023323419"></a>UART设置设备属性成功</p>
</td>
</tr>
<tr id="row6531163373412"><td class="cellrowborder" valign="top" width="49.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p16530123310345"><a name="p16530123310345"></a><a name="p16530123310345"></a>负数</p>
</td>
<td class="cellrowborder" valign="top" width="50.019999999999996%" headers="mcps1.2.3.1.2 "><p id="p1953118334347"><a name="p1953118334347"></a><a name="p1953118334347"></a>UART设置设备属性失败</p>
</td>
</tr>
</tbody>
</table>
设置UART的设备属性的实例如下：
``` ```
int32_t ret; int32_t ret;
...@@ -351,42 +176,15 @@ int32\_t UartGetAttribute\(DevHandle handle, struct UartAttribute \*attribute\); ...@@ -351,42 +176,15 @@ int32\_t UartGetAttribute\(DevHandle handle, struct UartAttribute \*attribute\);
**表 6** UartGetAttribute参数和返回值描述 **表 6** UartGetAttribute参数和返回值描述
<a name="table17532123316342"></a> | 参数 | 参数描述 |
<table><thead align="left"><tr id="row18531193383420"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p85311833143420"><a name="p85311833143420"></a><a name="p85311833143420"></a>参数</p> | -------- | -------- |
</th> | handle | UART设备句柄 |
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p17531103319348"><a name="p17531103319348"></a><a name="p17531103319348"></a>参数描述</p> | attribute | 接收UART设备属性的指针 |
</th> | **返回值** | **返回值描述** |
</tr> | 0 | UART获取设备属性成功 |
</thead> | 负数 | UART获取设备属性失败 |
<tbody><tr id="row35311533153413"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p453133333418"><a name="p453133333418"></a><a name="p453133333418"></a>handle</p>
</td> 获取UART的设备属性的示例代码如下：
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p753193323420"><a name="p753193323420"></a><a name="p753193323420"></a>UART设备句柄</p>
</td>
</tr>
<tr id="row1953103315344"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p35315333346"><a name="p35315333346"></a><a name="p35315333346"></a>attribute</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p14531633133416"><a name="p14531633133416"></a><a name="p14531633133416"></a>接收UART设备属性的指针</p>
</td>
</tr>
<tr id="row45321433143415"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p653273363417"><a name="p653273363417"></a><a name="p653273363417"></a><strong id="b19531153314349"><a name="b19531153314349"></a><a name="b19531153314349"></a>返回值</strong></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1653203312347"><a name="p1653203312347"></a><a name="p1653203312347"></a><strong id="b185321330348"><a name="b185321330348"></a><a name="b185321330348"></a>返回值描述</strong></p>
</td>
</tr>
<tr id="row175320339342"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p10532163383412"><a name="p10532163383412"></a><a name="p10532163383412"></a>0</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p5532143319341"><a name="p5532143319341"></a><a name="p5532143319341"></a>UART获取设备属性成功</p>
</td>
</tr>
<tr id="row125327337340"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p19532153317345"><a name="p19532153317345"></a><a name="p19532153317345"></a>负数</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p175321933163410"><a name="p175321933163410"></a><a name="p175321933163410"></a>UART获取设备属性失败</p>
</td>
</tr>
</tbody>
</table>
获取UART的设备属性的实例如下：
``` ```
int32_t ret; int32_t ret;
...@@ -406,42 +204,15 @@ int32\_t UartSetTransMode\(DevHandle handle, enum UartTransMode mode\)； ...@@ -406,42 +204,15 @@ int32\_t UartSetTransMode\(DevHandle handle, enum UartTransMode mode\)；
**表 7** UartSetTransMode参数和返回值描述 **表 7** UartSetTransMode参数和返回值描述
<a name="table131892266313"></a> | 参数 | 参数描述 |
<table><thead align="left"><tr id="row018922615318"><th class="cellrowborder" valign="top" width="49.980000000000004%" id="mcps1.2.3.1.1"><p id="p131891826835"><a name="p131891826835"></a><a name="p131891826835"></a>参数</p> | -------- | -------- |
</th> | handle | UART设备句柄 |
<th class="cellrowborder" valign="top" width="50.019999999999996%" id="mcps1.2.3.1.2"><p id="p101894269314"><a name="p101894269314"></a><a name="p101894269314"></a>参数描述</p> | mode | 待设置的传输模式， |
</th> | **返回值** | **返回值描述** |
</tr> | 0 | UART设置传输模式成功 |
</thead> | 负数 | UART设置传输模式失败 |
<tbody><tr id="row11893261734"><td class="cellrowborder" valign="top" width="49.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p81897261333"><a name="p81897261333"></a><a name="p81897261333"></a>handle</p>
</td> 假设需要设置的UART传输模式为UART\_MODE\_RD\_BLOCK，示例代码如下：
<td class="cellrowborder" valign="top" width="50.019999999999996%" headers="mcps1.2.3.1.2 "><p id="p5190142618310"><a name="p5190142618310"></a><a name="p5190142618310"></a>UART设备句柄</p>
</td>
</tr>
<tr id="row1119082615317"><td class="cellrowborder" valign="top" width="49.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p1519012261314"><a name="p1519012261314"></a><a name="p1519012261314"></a>mode</p>
</td>
<td class="cellrowborder" valign="top" width="50.019999999999996%" headers="mcps1.2.3.1.2 "><p id="p121901026632"><a name="p121901026632"></a><a name="p121901026632"></a>待设置的传输模式，</p>
</td>
</tr>
<tr id="row19190152612317"><td class="cellrowborder" valign="top" width="49.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p131900266316"><a name="p131900266316"></a><a name="p131900266316"></a><strong id="b61902026833"><a name="b61902026833"></a><a name="b61902026833"></a>返回值</strong></p>
</td>
<td class="cellrowborder" valign="top" width="50.019999999999996%" headers="mcps1.2.3.1.2 "><p id="p1519022616315"><a name="p1519022616315"></a><a name="p1519022616315"></a><strong id="b319014261837"><a name="b319014261837"></a><a name="b319014261837"></a>返回值描述</strong></p>
</td>
</tr>
<tr id="row919016261932"><td class="cellrowborder" valign="top" width="49.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p10190526334"><a name="p10190526334"></a><a name="p10190526334"></a>0</p>
</td>
<td class="cellrowborder" valign="top" width="50.019999999999996%" headers="mcps1.2.3.1.2 "><p id="p1219012264318"><a name="p1219012264318"></a><a name="p1219012264318"></a>UART设置传输模式成功</p>
</td>
</tr>
<tr id="row1219017262313"><td class="cellrowborder" valign="top" width="49.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p15190162616316"><a name="p15190162616316"></a><a name="p15190162616316"></a>负数</p>
</td>
<td class="cellrowborder" valign="top" width="50.019999999999996%" headers="mcps1.2.3.1.2 "><p id="p131906262311"><a name="p131906262311"></a><a name="p131906262311"></a>UART设置传输模式失败</p>
</td>
</tr>
</tbody>
</table>
假设需要设置的UART传输模式为UART\_MODE\_RD\_BLOCK，设置传输模式的实例如下：
``` ```
int32_t ret; int32_t ret;
...@@ -460,47 +231,16 @@ int32\_t UartWrite\(DevHandle handle, uint8\_t \*data, uint32\_t size\); ...@@ -460,47 +231,16 @@ int32\_t UartWrite\(DevHandle handle, uint8\_t \*data, uint32\_t size\);
**表 8** UartWrite参数和返回值描述 **表 8** UartWrite参数和返回值描述
<a name="table27825111368"></a> | 参数 | 参数描述 |
<table><thead align="left"><tr id="row1578171123619"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p078112115360"><a name="p078112115360"></a><a name="p078112115360"></a>参数</p> | -------- | -------- |
</th> | handle | UART设备句柄 |
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p37811711163612"><a name="p37811711163612"></a><a name="p37811711163612"></a>参数描述</p> | data | 待写入数据的指针 |
</th> | size | 待写入数据的长度 |
</tr> | **返回值** | **返回值描述** |
</thead> | 0 | UART写数据成功 |
<tbody><tr id="row1878291143611"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p07818112360"><a name="p07818112360"></a><a name="p07818112360"></a>handle</p> | 负数 | UART写数据失败 |
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p178281113369"><a name="p178281113369"></a><a name="p178281113369"></a>UART设备句柄</p> 写入指定长度数据的示例代码如下：
</td>
</tr>
<tr id="row7782811123614"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p8782911173610"><a name="p8782911173610"></a><a name="p8782911173610"></a>data</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p17782171120366"><a name="p17782171120366"></a><a name="p17782171120366"></a>待写入数据的指针</p>
</td>
</tr>
<tr id="row1578251112367"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p3782911183612"><a name="p3782911183612"></a><a name="p3782911183612"></a>size</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p17782161110366"><a name="p17782161110366"></a><a name="p17782161110366"></a>待写入数据的长度</p>
</td>
</tr>
<tr id="row1378281113363"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p87821411183616"><a name="p87821411183616"></a><a name="p87821411183616"></a><strong id="b157825113363"><a name="b157825113363"></a><a name="b157825113363"></a>返回值</strong></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p13782111116361"><a name="p13782111116361"></a><a name="p13782111116361"></a><strong id="b978211113366"><a name="b978211113366"></a><a name="b978211113366"></a>返回值描述</strong></p>
</td>
</tr>
<tr id="row47822112365"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p107821011103613"><a name="p107821011103613"></a><a name="p107821011103613"></a>0</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p11782191103610"><a name="p11782191103610"></a><a name="p11782191103610"></a>UART写数据成功</p>
</td>
</tr>
<tr id="row11782911113611"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1578221111367"><a name="p1578221111367"></a><a name="p1578221111367"></a>负数</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p9782151110366"><a name="p9782151110366"></a><a name="p9782151110366"></a>UART写数据失败</p>
</td>
</tr>
</tbody>
</table>
写入指定长度数据的实例如下：
``` ```
int32_t ret; int32_t ret;
...@@ -520,47 +260,16 @@ int32\_t UartRead\(DevHandle handle, uint8\_t \*data, uint32\_t size\); ...@@ -520,47 +260,16 @@ int32\_t UartRead\(DevHandle handle, uint8\_t \*data, uint32\_t size\);
**表 9** UartRead参数和返回值描述 **表 9** UartRead参数和返回值描述
<a name="table162341717123713"></a> | 参数 | 参数描述 |
<table><thead align="left"><tr id="row023313171377"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p1123331710376"><a name="p1123331710376"></a><a name="p1123331710376"></a>参数</p> | -------- | -------- |
</th> | handle | UART设备句柄 |
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p523321783715"><a name="p523321783715"></a><a name="p523321783715"></a>参数描述</p> | data | 接收读取数据的指针 |
</th> | size | 待读取数据的长度 |
</tr> | **返回值** | **返回值描述** |
</thead> | 非负数 | UART读取到的数据长度 |
<tbody><tr id="row6234417133712"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p7233121716379"><a name="p7233121716379"></a><a name="p7233121716379"></a>handle</p> | 负数 | UART读取数据失败 |
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p17234101753712"><a name="p17234101753712"></a><a name="p17234101753712"></a>UART设备句柄</p> 读取指定长度数据的示例代码如下：
</td>
</tr>
<tr id="row18234151718372"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p16234191783711"><a name="p16234191783711"></a><a name="p16234191783711"></a>data</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p923417175378"><a name="p923417175378"></a><a name="p923417175378"></a>接收读取数据的指针</p>
</td>
</tr>
<tr id="row82341017193711"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p13234917103717"><a name="p13234917103717"></a><a name="p13234917103717"></a>size</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p182341817153717"><a name="p182341817153717"></a><a name="p182341817153717"></a>待读取数据的长度</p>
</td>
</tr>
<tr id="row102341617123717"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p172341617163712"><a name="p172341617163712"></a><a name="p172341617163712"></a><strong id="b1323411179373"><a name="b1323411179373"></a><a name="b1323411179373"></a>返回值</strong></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1623431763718"><a name="p1623431763718"></a><a name="p1623431763718"></a><strong id="b1123411173377"><a name="b1123411173377"></a><a name="b1123411173377"></a>返回值描述</strong></p>
</td>
</tr>
<tr id="row4234151719372"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p3234131716375"><a name="p3234131716375"></a><a name="p3234131716375"></a>非负数</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p7234171783718"><a name="p7234171783718"></a><a name="p7234171783718"></a>UART读取到的数据长度</p>
</td>
</tr>
<tr id="row112340173378"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1423431743714"><a name="p1423431743714"></a><a name="p1423431743714"></a>负数</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p32349178378"><a name="p32349178378"></a><a name="p32349178378"></a>UART读取数据失败</p>
</td>
</tr>
</tbody>
</table>
读取指定长度数据的实例如下：
``` ```
int32_t ret; int32_t ret;
...@@ -585,22 +294,11 @@ void UartClose\(DevHandle handle\); ...@@ -585,22 +294,11 @@ void UartClose\(DevHandle handle\);
**表 10** UartClose参数和返回值描述 **表 10** UartClose参数和返回值描述
<a name="table03348317351"></a> | 参数 | 参数描述 |
<table><thead align="left"><tr id="row15334837351"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p933411316354"><a name="p933411316354"></a><a name="p933411316354"></a>参数</p> | -------- | -------- |
</th> | handle | UART设备句柄 |
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p16334103143517"><a name="p16334103143517"></a><a name="p16334103143517"></a>参数描述</p>
</th> 销毁UART设备句柄的示例代码如下：
</tr>
</thead>
<tbody><tr id="row733483103513"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p7334530358"><a name="p7334530358"></a><a name="p7334530358"></a>handle</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p133341331356"><a name="p133341331356"></a><a name="p133341331356"></a>UART设备句柄</p>
</td>
</tr>
</tbody>
</table>
销毁UART设备句柄的实例如下：
``` ```
UartClose(handle); /* 销毁UART设备句柄 * UartClose(handle); /* 销毁UART设备句柄 *
......
zh-cn/device-dev/driver/driver-platform-uart-develop.md
浏览文件 @ 44d901bb
...@@ -29,131 +29,19 @@ struct UartHostMethod { ...@@ -29,131 +29,19 @@ struct UartHostMethod {
**表 1** UartHostMethod结构体成员的回调函数功能说明 **表 1** UartHostMethod结构体成员的回调函数功能说明
<a name="table22862114719"></a> | 函数 | 入参 | 出参 | 返回值 | 功能 |
<table><thead align="left"><tr id="row5297211471"><th class="cellrowborder" valign="top" width="20%" id="mcps1.2.6.1.1"><p id="p12291121134710"><a name="p12291121134710"></a><a name="p12291121134710"></a>函数</p> | -------- | -------- | -------- | -------- | -------- |
</th> | Init | host：结构体指针，核心层UART控制器 | 无 | HDF_STATUS相关状态 | 初始化UART设备 |
<th class="cellrowborder" valign="top" width="20%" id="mcps1.2.6.1.2"><p id="p3291921164712"><a name="p3291921164712"></a><a name="p3291921164712"></a>入参</p> | Deinit | host：结构体指针，核心层UART控制器 | 无 | HDF_STATUS相关状态 | 去初始化UART设备 |
</th> | Read | host：结构体指针，核心层UART控制器<br>size：uint32_t，数据大小 | data：uint8_t指针，传出的数据 | HDF_STATUS相关状态 | 接收数据RX |
<th class="cellrowborder" valign="top" width="19.98%" id="mcps1.2.6.1.3"><p id="p15291321114718"><a name="p15291321114718"></a><a name="p15291321114718"></a>出参</p> | Write | host：结构体指针，核心层UART控制器<br>data：uint8_t指针，传入数据<br>size：uint32_t，数据大小 | 无 | HDF_STATUS相关状态 | 发送数据TX |
</th> | SetBaud | host：结构体指针，核心层UART控制器<br>baudRate：uint32_t指针，波特率传入值 | 无 | HDF_STATUS相关状态 | 设置波特率 |
<th class="cellrowborder" valign="top" width="20.02%" id="mcps1.2.6.1.4"><p id="p03092115478"><a name="p03092115478"></a><a name="p03092115478"></a>返回值</p> | GetBaud | host：结构体指针，核心层UART控制器 | baudRate：uint32_t指针，传出的波特率 | HDF_STATUS相关状态 | 获取当前设置的波特率 |
</th> | GetAttribute | host：结构体指针，核心层UART控制器 | attribute：结构体指针，传出的属性值（见uart_if.h中UartAttribute定义） | HDF_STATUS相关状态 | 获取设备UART相关属性 |
<th class="cellrowborder" valign="top" width="20%" id="mcps1.2.6.1.5"><p id="p230172113475"><a name="p230172113475"></a><a name="p230172113475"></a>功能</p> | SetAttribute | host：结构体指针，核心层UART控制器<br>attribute：结构体指针，属性传入值 | 无 | HDF_STATUS相关状态 | 设置设备UART相关属性 |
</th> | SetTransMode | host：结构体指针，核心层UART控制器<br>mode：枚举值（见uart_if.h中UartTransMode定义），传输模式 | 无 | HDF_STATUS相关状态 | 设置传输模式 |
</tr> | PollEvent | host：结构体指针，核心层UART控制器<br>filep：void指针file<br>table：void指针poll_table | 无 | HDF_STATUS相关状态 | poll机制 |
</thead>
<tbody><tr id="row13305217472"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.1 "><p id="p193012104714"><a name="p193012104714"></a><a name="p193012104714"></a>Init</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.2 "><p id="p53082134713"><a name="p53082134713"></a><a name="p53082134713"></a>host: 结构体指针,核心层uart控制器;</p>
</td>
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.2.6.1.3 "><p id="p14301121174719"><a name="p14301121174719"></a><a name="p14301121174719"></a>无</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.2.6.1.4 "><p id="p83092116473"><a name="p83092116473"></a><a name="p83092116473"></a>HDF_STATUS相关状态</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.5 "><p id="p173032124713"><a name="p173032124713"></a><a name="p173032124713"></a>初始化Uart设备</p>
</td>
</tr>
<tr id="row530121144713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.1 "><p id="p12301215474"><a name="p12301215474"></a><a name="p12301215474"></a>Deinit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.2 "><p id="p14301921174718"><a name="p14301921174718"></a><a name="p14301921174718"></a>host: 结构体指针,核心层uart控制器;</p>
</td>
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.2.6.1.3 "><p id="p143142110477"><a name="p143142110477"></a><a name="p143142110477"></a>无</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.2.6.1.4 "><p id="p1531162174719"><a name="p1531162174719"></a><a name="p1531162174719"></a>HDF_STATUS相关状态</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.5 "><p id="p203162110478"><a name="p203162110478"></a><a name="p203162110478"></a>去初始化Uart设备</p>
</td>
</tr>
<tr id="row93172118476"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.1 "><p id="p1231102194712"><a name="p1231102194712"></a><a name="p1231102194712"></a>Read</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.2 "><p id="p13318214472"><a name="p13318214472"></a><a name="p13318214472"></a>host: 结构体指针,核心层uart控制器;size：uint32_t，数据大小;</p>
</td>
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.2.6.1.3 "><p id="p1313213473"><a name="p1313213473"></a><a name="p1313213473"></a>data: uint8_t指针，传出的数据</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.2.6.1.4 "><p id="p193110216473"><a name="p193110216473"></a><a name="p193110216473"></a>HDF_STATUS相关状态</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.5 "><p id="p1331102115475"><a name="p1331102115475"></a><a name="p1331102115475"></a>接收数据 RX</p>
</td>
</tr>
<tr id="row1731102120479"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.1 "><p id="p731321204711"><a name="p731321204711"></a><a name="p731321204711"></a>Write</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.2 "><p id="p15311321204719"><a name="p15311321204719"></a><a name="p15311321204719"></a>host: 结构体指针,核心层uart控制器;data：uint8_t指针，传入数据;size：uint32_t，数据大小;</p>
</td>
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.2.6.1.3 "><p id="p143142114478"><a name="p143142114478"></a><a name="p143142114478"></a>无</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.2.6.1.4 "><p id="p143212110477"><a name="p143212110477"></a><a name="p143212110477"></a>HDF_STATUS相关状态</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.5 "><p id="p123216211477"><a name="p123216211477"></a><a name="p123216211477"></a>发送数据 TX</p>
</td>
</tr>
<tr id="row73215214478"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.1 "><p id="p1032112119475"><a name="p1032112119475"></a><a name="p1032112119475"></a>SetBaud</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.2 "><p id="p3321521134717"><a name="p3321521134717"></a><a name="p3321521134717"></a>host: 结构体指针,核心层uart控制器;baudRate: uint32_t指针，波特率传入值;</p>
</td>
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.2.6.1.3 "><p id="p18327218478"><a name="p18327218478"></a><a name="p18327218478"></a>无</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.2.6.1.4 "><p id="p23242111475"><a name="p23242111475"></a><a name="p23242111475"></a>HDF_STATUS相关状态</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.5 "><p id="p7321521114711"><a name="p7321521114711"></a><a name="p7321521114711"></a>设置波特率</p>
</td>
</tr>
<tr id="row113252104713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.1 "><p id="p9323219476"><a name="p9323219476"></a><a name="p9323219476"></a>GetBaud</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.2 "><p id="p132821184711"><a name="p132821184711"></a><a name="p132821184711"></a>host: 结构体指针,核心层uart控制器;</p>
</td>
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.2.6.1.3 "><p id="p63262112477"><a name="p63262112477"></a><a name="p63262112477"></a>baudRate: uint32_t指针，传出的波特率;</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.2.6.1.4 "><p id="p13262174719"><a name="p13262174719"></a><a name="p13262174719"></a>HDF_STATUS相关状态</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.5 "><p id="p163232154717"><a name="p163232154717"></a><a name="p163232154717"></a>获取当前设置的波特率</p>
</td>
</tr>
<tr id="row2032102118472"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.1 "><p id="p9331321154714"><a name="p9331321154714"></a><a name="p9331321154714"></a>GetAttribute</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.2 "><p id="p15331721164715"><a name="p15331721164715"></a><a name="p15331721164715"></a>host: 结构体指针,核心层uart控制器;</p>
</td>
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.2.6.1.3 "><p id="p23313219472"><a name="p23313219472"></a><a name="p23313219472"></a>attribute: 结构体指针,传出的属性值（见uart_if.h中UartAttribute定义）</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.2.6.1.4 "><p id="p833142115476"><a name="p833142115476"></a><a name="p833142115476"></a>HDF_STATUS相关状态</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.5 "><p id="p63342119476"><a name="p63342119476"></a><a name="p63342119476"></a>获取设备uart相关属性</p>
</td>
</tr>
<tr id="row1133112144717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.1 "><p id="p14331421114715"><a name="p14331421114715"></a><a name="p14331421114715"></a>SetAttribute</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.2 "><p id="p16331210473"><a name="p16331210473"></a><a name="p16331210473"></a>host: 结构体指针,核心层uart控制器;attribute: 结构体指针，属性传入值;</p>
</td>
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.2.6.1.3 "><p id="p3331721204710"><a name="p3331721204710"></a><a name="p3331721204710"></a>无</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.2.6.1.4 "><p id="p03302111471"><a name="p03302111471"></a><a name="p03302111471"></a>HDF_STATUS相关状态</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.5 "><p id="p1933152113478"><a name="p1933152113478"></a><a name="p1933152113478"></a>设置设备uart相关属性</p>
</td>
</tr>
<tr id="row834221114716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.1 "><p id="p1934821104719"><a name="p1934821104719"></a><a name="p1934821104719"></a>SetTransMode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.2 "><p id="p1034621104717"><a name="p1034621104717"></a><a name="p1034621104717"></a>host: 结构体指针,核心层uart控制器;mode: 枚举值（见uart_if.h中UartTransMode定义）,传输模式</p>
</td>
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.2.6.1.3 "><p id="p173442110475"><a name="p173442110475"></a><a name="p173442110475"></a>无</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.2.6.1.4 "><p id="p1734721194720"><a name="p1734721194720"></a><a name="p1734721194720"></a>HDF_STATUS相关状态</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.5 "><p id="p15341021194715"><a name="p15341021194715"></a><a name="p15341021194715"></a>设置传输模式</p>
</td>
</tr>
<tr id="row434192119479"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.1 "><p id="p133442184717"><a name="p133442184717"></a><a name="p133442184717"></a>PollEvent</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.2 "><p id="p634121104712"><a name="p634121104712"></a><a name="p634121104712"></a>host: 结构体指针,核心层uart控制器;filep: void 指针,file ;table: void 指针,poll_table ;</p>
</td>
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.2.6.1.3 "><p id="p1334142111479"><a name="p1334142111479"></a><a name="p1334142111479"></a>无</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.2.6.1.4 "><p id="p133472110473"><a name="p133472110473"></a><a name="p133472110473"></a>HDF_STATUS相关状态</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.2.6.1.5 "><p id="p63522174720"><a name="p63522174720"></a><a name="p63522174720"></a>poll机制</p>
</td>
</tr>
</tbody>
</table>
## 开发步骤<a name="section944397404154520"></a> ## 开发步骤<a name="section944397404154520"></a>
...@@ -193,20 +81,20 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -193,20 +81,20 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
``` ```
struct HdfDriverEntry g_hdfUartDevice = { struct HdfDriverEntry g_hdfUartDevice = {
.moduleVersion = 1, .moduleVersion = 1,
.moduleName = "HDF_PLATFORM_UART",//【必要且与 HCS 里面的名字匹配】 .moduleName = "HDF_PLATFORM_UART",// 【必要且与 HCS 里面的名字匹配】
.Bind = HdfUartDeviceBind, //见Bind参考 .Bind = HdfUartDeviceBind, // 见Bind参考
.Init = HdfUartDeviceInit, //见Init参考 .Init = HdfUartDeviceInit, // 见Init参考
.Release = HdfUartDeviceRelease, //见Release参考 .Release = HdfUartDeviceRelease, // 见Release参考
}; };
//调用HDF_INIT将驱动入口注册到HDF框架中 // 调用HDF_INIT将驱动入口注册到HDF框架中
HDF_INIT(g_hdfUartDevice); HDF_INIT(g_hdfUartDevice);
``` ```
2. 完成驱动入口注册之后，下一步请在device\_info.hcs文件中添加deviceNode信息，并在 uart\_config.hcs 中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值与核心层UartHost成员的默认值或限制范围有密切关系。 2. 完成驱动入口注册之后，下一步请在device\_info.hcs文件中添加deviceNode信息，并在 uart\_config.hcs中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值与核心层UartHost成员的默认值或限制范围有密切关系。
本例只有一个UART控制器，如有多个器件信息，则需要在device\_info文件增加deviceNode信息，以及在uart\_config文件中增加对应的器件属性。 本例只有一个UART控制器，如有多个器件信息，则需要在device\_info文件增加deviceNode信息，以及在uart\_config文件中增加对应的器件属性。
- device\_info.hcs 配置参考。 - device\_info.hcs配置参考
``` ```
root { root {
...@@ -239,24 +127,24 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -239,24 +127,24 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
} }
``` ```
- uart\_config.hcs 配置参考。 - uart\_config.hcs配置参考
``` ```
root { root {
platform { platform {
template uart_controller {//模板公共参数， 继承该模板的节点如果使用模板中的默认值， 则节点字段可以缺省 template uart_controller {//模板公共参数，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省
match_attr = ""; match_attr = "";
num = 0; //【必要】设备号 num = 0; // 【必要】设备号
baudrate = 115200; //【必要】波特率，数值可按需填写 baudrate = 115200; // 【必要】波特率，数值可按需填写
fifoRxEn = 1; //【必要】使能接收FIFO fifoRxEn = 1; // 【必要】使能接收FIFO
fifoTxEn = 1; //【必要】使能发送FIFO fifoTxEn = 1; // 【必要】使能发送FIFO
flags = 4; //【必要】标志信号 flags = 4; // 【必要】标志信号
regPbase = 0x120a0000; //【必要】地址映射需要 regPbase = 0x120a0000; // 【必要】地址映射需要
interrupt = 38; //【必要】中断号 interrupt = 38; // 【必要】中断号
iomemCount = 0x48; //【必要】地址映射需要 iomemCount = 0x48; // 【必要】地址映射需要
} }
controller_0x120a0000 :: uart_controller { controller_0x120a0000 :: uart_controller {
match_attr = "hisilicon_hi35xx_uart_0";//【必要】必须和device_info.hcs中对应的设备的deviceMatchAttr值一致 match_attr = "hisilicon_hi35xx_uart_0";// 【必要】必须和device_info.hcs中对应的设备的deviceMatchAttr值一致
} }
controller_0x120a1000 :: uart_controller { controller_0x120a1000 :: uart_controller {
num = 1; num = 1;
...@@ -266,7 +154,7 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -266,7 +154,7 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
match_attr = "hisilicon_hi35xx_uart_1"; match_attr = "hisilicon_hi35xx_uart_1";
} }
... ...
// 【可选】可新增，但需要在 device_info.hcs 添加对应的节点 // 【可选】可新增，但需要在 device_info.hcs添加对应的节点
} }
} }
``` ```
...@@ -277,37 +165,37 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -277,37 +165,37 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
从驱动的角度看，自定义结构体是参数和数据的载体，而且uart\_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如设备号等。 从驱动的角度看，自定义结构体是参数和数据的载体，而且uart\_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如设备号等。
``` ```
struct UartPl011Port { //接口相关的结构体 struct UartPl011Port { // 接口相关的结构体
int32_t enable; int32_t enable;
unsigned long physBase; //物理地址 unsigned long physBase; // 物理地址
uint32_t irqNum; //中断号 uint32_t irqNum; // 中断号
uint32_t defaultBaudrate;//默认波特率 uint32_t defaultBaudrate;// 默认波特率
uint32_t flags; //标志信号，下面三个宏与之相关 uint32_t flags; // 标志信号，下面三个宏与之相关
#define PL011_FLG_IRQ_REQUESTED (1 << 0) #define PL011_FLG_IRQ_REQUESTED (1 << 0)
#define PL011_FLG_DMA_RX_REQUESTED (1 << 1) #define PL011_FLG_DMA_RX_REQUESTED (1 << 1)
#define PL011_FLG_DMA_TX_REQUESTED (1 << 2) #define PL011_FLG_DMA_TX_REQUESTED (1 << 2)
struct UartDmaTransfer *rxUdt; //DMA传输相关 struct UartDmaTransfer *rxUdt; // DMA传输相关
struct UartDriverData *udd; //见下 struct UartDriverData *udd; // 见下
}; };
struct UartDriverData { //数据传输相关的结构体 struct UartDriverData { // 数据传输相关的结构体
uint32_t num; uint32_t num;
uint32_t baudrate; //波特率（可设置） uint32_t baudrate; // 波特率（可设置）
struct UartAttribute attr; //数据位、停止位等传输属性相关 struct UartAttribute attr; // 数据位、停止位等传输属性相关
struct UartTransfer *rxTransfer; //缓冲区相关，可理解为FIFO结构 struct UartTransfer *rxTransfer; // 缓冲区相关，可理解为FIFO结构
wait_queue_head_t wait; //条件变量相关的排队等待信号 wait_queue_head_t wait; // 条件变量相关的排队等待信号
int32_t count; //数据数量 int32_t count; // 数据数量
int32_t state; //uart控制器状态 int32_t state; // UART控制器状态
#define UART_STATE_NOT_OPENED 0 #define UART_STATE_NOT_OPENED 0
#define UART_STATE_OPENING 1 #define UART_STATE_OPENING 1
#define UART_STATE_USEABLE 2 #define UART_STATE_USEABLE 2
#define UART_STATE_SUSPENED 3 #define UART_STATE_SUSPENED 3
uint32_t flags; //状态标志 uint32_t flags; // 状态标志
#define UART_FLG_DMA_RX (1 << 0) #define UART_FLG_DMA_RX (1 << 0)
#define UART_FLG_DMA_TX (1 << 1) #define UART_FLG_DMA_TX (1 << 1)
#define UART_FLG_RD_BLOCK (1 << 2) #define UART_FLG_RD_BLOCK (1 << 2)
RecvNotify recv; //函数指针类型，指向串口数据接收函数 RecvNotify recv; // 函数指针类型，指向串口数据接收函数
struct UartOps *ops; //自定义函数指针结构体，详情见device/hisilicon/drivers/uart/uart_pl011.c struct UartOps *ops; // 自定义函数指针结构体，详情见device/hisilicon/drivers/uart/uart_pl011.c
void *private; //一般用来存储UartPl011Port首地址，方便调用 void *private; // 一般用来存储UartPl011Port首地址，方便调用
}; };
// UartHost是核心层控制器结构体，其中的成员在Init函数中会被赋值 // UartHost是核心层控制器结构体，其中的成员在Init函数中会被赋值
...@@ -316,8 +204,8 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -316,8 +204,8 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
struct HdfDeviceObject *device; struct HdfDeviceObject *device;
uint32_t num; uint32_t num;
OsalAtomic atom; OsalAtomic atom;
void *priv; //一般存储厂商自定义结构体首地址，方便后者被调用 void *priv; // 一般存储厂商自定义结构体首地址，方便后者被调用
struct UartHostMethod *method; //核心层钩子函数，厂商需要实现其成员函数功能并实例化 struct UartHostMethod *method; // 核心层钩子函数，厂商需要实现其成员函数功能并实例化
}; };
``` ```
...@@ -343,7 +231,7 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -343,7 +231,7 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
入参： 入参：
HdfDeviceObject 这个是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息。 HdfDeviceObject 这个是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
返回值： 返回值：
...@@ -351,45 +239,14 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -351,45 +239,14 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
**表 2** Bind函数入参和返回值 **表 2** Bind函数入参和返回值
<a name="table69781823185619"></a> | 状态(值) | 问题描述 |
<table><thead align="left"><tr id="row997916234569"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p99801123205616"><a name="p99801123205616"></a><a name="p99801123205616"></a>状态(值)</p> | -------- | -------- |
</th> | HDF_ERR_INVALID_OBJECT | 控制器对象非法 |
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p698092355615"><a name="p698092355615"></a><a name="p698092355615"></a>问题描述</p> | HDF_ERR_MALLOC_FAIL | 内存分配失败 |
</th> | HDF_ERR_INVALID_PARAM | 参数非法 |
</tr> | HDF_ERR_IO | I/O错误 |
</thead> | HDF_SUCCESS | 初始化成功 |
<tbody><tr id="row39803236568"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p8980123175613"><a name="p8980123175613"></a><a name="p8980123175613"></a>HDF_ERR_INVALID_OBJECT</p> | HDF_FAILURE | 初始化失败 |
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p79801423165611"><a name="p79801423165611"></a><a name="p79801423165611"></a>控制器对象非法</p>
</td>
</tr>
<tr id="row3980023165617"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p698011239568"><a name="p698011239568"></a><a name="p698011239568"></a>HDF_ERR_MALLOC_FAIL</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p798082395610"><a name="p798082395610"></a><a name="p798082395610"></a>内存分配失败</p>
</td>
</tr>
<tr id="row10980223165610"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1980172365614"><a name="p1980172365614"></a><a name="p1980172365614"></a>HDF_ERR_INVALID_PARAM</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p14980223145614"><a name="p14980223145614"></a><a name="p14980223145614"></a>参数非法</p>
</td>
</tr>
<tr id="row7980142315612"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p17980152385611"><a name="p17980152385611"></a><a name="p17980152385611"></a>HDF_ERR_IO</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p17980182385611"><a name="p17980182385611"></a><a name="p17980182385611"></a>I/O 错误</p>
</td>
</tr>
<tr id="row9980122312564"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p10981323155616"><a name="p10981323155616"></a><a name="p10981323155616"></a>HDF_SUCCESS</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p11981423175614"><a name="p11981423175614"></a><a name="p11981423175614"></a>初始化成功</p>
</td>
</tr>
<tr id="row15981122365618"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p19981122311567"><a name="p19981122311567"></a><a name="p19981122311567"></a>HDF_FAILURE</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p199811723105615"><a name="p199811723105615"></a><a name="p199811723105615"></a>初始化失败</p>
</td>
</tr>
</tbody>
</table>
函数说明： 函数说明：
...@@ -400,19 +257,19 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -400,19 +257,19 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
static int32_t HdfUartDeviceBind(struct HdfDeviceObject *device) static int32_t HdfUartDeviceBind(struct HdfDeviceObject *device)
{ {
... ...
return (UartHostCreate(device) == NULL) ? HDF_FAILURE : HDF_SUCCESS;//【必须做】调用核心层函数 UartHostCreate return (UartHostCreate(device) == NULL) ? HDF_FAILURE : HDF_SUCCESS;// 【必须做】调用核心层函数 UartHostCreate
} }
//uart_core.c 核心层 UartHostCreate 函数说明 // uart_core.c核心层UartHostCreate函数说明
struct UartHost *UartHostCreate(struct HdfDeviceObject *device) struct UartHost *UartHostCreate(struct HdfDeviceObject *device)
{ {
struct UartHost *host = NULL; //新建 UartHost struct UartHost *host = NULL; // 新建UartHost
... ...
host = (struct UartHost *)OsalMemCalloc(sizeof(*host));//分配内存 host = (struct UartHost *)OsalMemCalloc(sizeof(*host));//分 配内存
... ...
host->device = device; //【必要】使HdfDeviceObject与UartHost可以相互转化的前提 host->device = device; // 【必要】使HdfDeviceObject与UartHost可以相互转化的前提
device->service = &(host->service);//【必要】使HdfDeviceObject与UartHost可以相互转化的前提 device->service = &(host->service);// 【必要】使HdfDeviceObject与UartHost可以相互转化的前提
host->device->service->Dispatch = UartIoDispatch;//为 service 成员的 Dispatch 方法赋值 host->device->service->Dispatch = UartIoDispatch;//为 service 成员的 Dispatch 方法赋值
OsalAtomicSet(&host->atom, 0); //原子量初始化或者原子量设置 OsalAtomicSet(&host->atom, 0); // 原子量初始化或者原子量设置
host->priv = NULL; host->priv = NULL;
host->method = NULL; host->method = NULL;
return host; return host;
...@@ -423,7 +280,7 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -423,7 +280,7 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
入参： 入参：
HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息。 HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
返回值： 返回值：
...@@ -440,14 +297,14 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -440,14 +297,14 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
struct UartHost *host = NULL; struct UartHost *host = NULL;
HDF_LOGI("%s: entry", __func__); HDF_LOGI("%s: entry", __func__);
... ...
host = UartHostFromDevice(device);//通过service成员后强制转为UartHost，赋值是在Bind函数中 host = UartHostFromDevice(device);// 通过service成员后强制转为UartHost，赋值是在Bind函数中
... ...
ret = Hi35xxAttach(host, device); //完成UartHost对象的初始化，见下 ret = Hi35xxAttach(host, device); // 完成UartHost对象的初始化，见下
... ...
host->method = &g_uartHostMethod; //UartHostMethod的实例化对象的挂载 host->method = &g_uartHostMethod; // UartHostMethod的实例化对象的挂载
return ret; return ret;
} }
//完成 UartHost 对象的初始化 //完成UartHost对象的初始化
static int32_t Hi35xxAttach(struct UartHost *host, struct HdfDeviceObject *device) static int32_t Hi35xxAttach(struct UartHost *host, struct HdfDeviceObject *device)
{ {
int32_t ret; int32_t ret;
...@@ -460,18 +317,18 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -460,18 +317,18 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
... ...
port = (struct UartPl011Port *)OsalMemCalloc(sizeof(struct UartPl011Port));//【2】 port = (struct UartPl011Port *)OsalMemCalloc(sizeof(struct UartPl011Port));//【2】
... ...
udd->ops = Pl011GetOps();//【3】设备开启、关闭、属性设置、发送操作等函数挂载 udd->ops = Pl011GetOps();// 【3】设备开启、关闭、属性设置、发送操作等函数挂载
udd->recv = PL011UartRecvNotify;//【4】数据接收通知函数（条件锁机制）挂载 udd->recv = PL011UartRecvNotify;// 【4】数据接收通知函数（条件锁机制）挂载
udd->count = 0; //【5】 udd->count = 0; // 【5】
port->udd = udd; //【6】使UartPl011Port与UartDriverData可以相互转化的前提 port->udd = udd; // 【6】使UartPl011Port与UartDriverData可以相互转化的前提
ret = UartGetConfigFromHcs(port, device->property);//【必要】 此步骤是将 HdfDeviceObject 的属性传递给厂商自定义结构体 ret = UartGetConfigFromHcs(port, device->property);// 【必要】此步骤是将 HdfDeviceObject 的属性传递给厂商自定义结构体
// 用于相关操作，示例代码见下 // 用于相关操作，示例代码见下
... ...
udd->private = port; //【7】 udd->private = port; // 【7】
host->priv = udd; //【必要】使UartHost与UartDriverData可以相互转化的前提 host->priv = udd; // 【必要】使UartHost与UartDriverData可以相互转化的前提
host->num = udd->num;//【必要】uart 设备号 host->num = udd->num;// 【必要】uart 设备号
UartAddDev(host); //【必要】核心层uart_dev.c 中的函数，作用：注册了一个字符设备节点到vfs， 这样从用户态可以通过这个虚拟文件节点访问uart UartAddDev(host); // 【必要】核心层uart_dev.c 中的函数，作用：注册了一个字符设备节点到vfs，这样从用户态可以通过这个虚拟文件节点访问uart
return HDF_SUCCESS; return HDF_SUCCESS;
} }
...@@ -481,7 +338,7 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -481,7 +338,7 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
struct UartDriverData *udd = port->udd; struct UartDriverData *udd = port->udd;
struct DeviceResourceIface *iface = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE); struct DeviceResourceIface *iface = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE);
... ...
//通过请求参数提取相应的值，并赋值给厂商自定义的结构体 // 通过请求参数提取相应的值，并赋值给厂商自定义的结构体
if (iface->GetUint32(node, "num", &udd->num, 0) != HDF_SUCCESS) { if (iface->GetUint32(node, "num", &udd->num, 0) != HDF_SUCCESS) {
HDF_LOGE("%s: read busNum fail", __func__); HDF_LOGE("%s: read busNum fail", __func__);
return HDF_FAILURE; return HDF_FAILURE;
...@@ -495,7 +352,7 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -495,7 +352,7 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
入参： 入参：
HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息。 HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
返回值： 返回值：
...@@ -503,19 +360,19 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -503,19 +360,19 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
函数说明： 函数说明：
该函数需要在驱动入口结构体中赋值给 Release 接口， 当HDF框架调用Init函数初始化驱动失败时，可以调用 Release 释放驱动资源， 该函数中需包含释放内存和删除控制器等操作。所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。 该函数需要在驱动入口结构体中赋值给 Release 接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源，该函数中需包含释放内存和删除控制器等操作。所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。
``` ```
void HdfUartDeviceRelease(struct HdfDeviceObject *device) void HdfUartDeviceRelease(struct HdfDeviceObject *device)
{ {
struct UartHost *host = NULL; struct UartHost *host = NULL;
... ...
host = UartHostFromDevice(device);//这里有HdfDeviceObject到UartHost的强制转化，通过service成员，赋值见Bind函数 host = UartHostFromDevice(device);// 这里有HdfDeviceObject到UartHost的强制转化，通过service成员，赋值见Bind函数
... ...
if (host->priv != NULL) { if (host->priv != NULL) {
Hi35xxDetach(host); //厂商自定义的内存释放函数，见下 Hi35xxDetach(host); // 厂商自定义的内存释放函数，见下
} }
UartHostDestroy(host); //调用核心层函数释放host UartHostDestroy(host); // 调用核心层函数释放host
} }
static void Hi35xxDetach(struct UartHost *host) static void Hi35xxDetach(struct UartHost *host)
...@@ -523,21 +380,18 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ...@@ -523,21 +380,18 @@ UART模块适配HDF框架的三个环节是配置属性文件，实例化驱动
struct UartDriverData *udd = NULL; struct UartDriverData *udd = NULL;
struct UartPl011Port *port = NULL; struct UartPl011Port *port = NULL;
... ...
udd = host->priv; //这里有UartHost到UartDriverData的转化 udd = host->priv; // 这里有UartHost到UartDriverData的转化
... ...
UartRemoveDev(host);//VFS注销 UartRemoveDev(host);// VFS注销
port = udd->private;//这里有UartDriverData到UartPl011Port的转化 port = udd->private;// 这里有UartDriverData到UartPl011Port的转化
if (port != NULL) { if (port != NULL) {
if (port->physBase != 0) { if (port->physBase != 0) {
OsalIoUnmap((void *)port->physBase);//地址反映射 OsalIoUnmap((void *)port->physBase);// 地址反映射
} }
OsalMemFree(port); OsalMemFree(port);
udd->private = NULL; udd->private = NULL;
} }
OsalMemFree(udd);//释放UartDriverData OsalMemFree(udd);// 释放UartDriverData
host->priv = NULL; host->priv = NULL;
} }
``` ```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或