Skip to content

D
Docs

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

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 6863c51a 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!21074 fix: fix the platform documents problems 

Merge pull request !21074 from 贾子扬/master
上级 783153ac 22dbe6a9
隐藏空白更改
内联 并排
Showing with 34 addition and 40 deletion
zh-cn/device-dev/driver/driver-platform-adc-develop.md
浏览文件 @ 6863c51a
......@@ -320,7 +320,7 @@ ADC模块适配包含以下四个步骤：
返回值：
HDF_STATUS相关状态（表4为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
HDF_STATUS相关状态（表4为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。
**表 4** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-dac-develop.md
浏览文件 @ 6863c51a
......@@ -361,7 +361,7 @@ DAC模块适配包含以下四个步骤：
返回值：
HDF_STATUS相关状态（表4为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
HDF_STATUS相关状态（表4为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。
**表 4** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-gpio-develop.md
浏览文件 @ 6863c51a
......@@ -279,7 +279,7 @@ GPIO模块适配包含以下四个步骤：
返回值：
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。
**表 3** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-hdmi-develop.md
浏览文件 @ 6863c51a
......@@ -242,6 +242,8 @@ HDMI模块适配包含以下四个步骤：
}
```
需要注意的是，新增hdmi_config.hcs配置文件后，必须在对应的hdf.hcs文件中包含hdmi_config.hcs所在路径信息，否则配置文件无法生效。
3. 实例化HDMI控制器对象
最后一步，完成驱动入口注册之后，要以核心层HdmiCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化HdmiCntlr成员HdmiCntlrOps（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
......@@ -334,7 +336,7 @@ HDMI模块适配包含以下四个步骤：
**返回值：**
HDF_STATUS相关状态 （表2为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS的定义）。
HDF_STATUS相关状态 （表2为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS的定义）。
**表 2** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-i2c-develop.md
浏览文件 @ 6863c51a
......@@ -293,7 +293,7 @@ I2C模块适配包含以下四个步骤：
返回值：
HDF_STATUS相关状态（表4为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
HDF_STATUS相关状态（表4为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。
**表 4** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-i3c-develop.md
浏览文件 @ 6863c51a
......@@ -214,7 +214,7 @@ I3C模块适配包含以下五个步骤：
match_attr = "virtual_i3c"; // 【必要】需要和device_info.hcs中的deviceMatchAttr值一致
template i3c_controller { // 模板公共参数，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省。
busId = 0; // 【必要】i3c总线号
busMode = 0x0; // 总线模式，0x0：纯净；0x1：混合高速：0x2：混合受限；0x3：混合低速。
busMode = 0x0; // 总线模式，0x0：纯净；0x1：混合高速；0x2：混合受限；0x3：混合低速。
regBasePhy = 0x120b0000; // 【必要】物理基地址
regSize = 0xd1; // 【必要】寄存器位宽
IrqNum = 20; // 【必要】中断号
......@@ -232,13 +232,7 @@ I3C模块适配包含以下五个步骤：
}
```
需要注意的是，新增i3c_config.hcs配置文件后，必须在hdf.hcs文件中将其包含，否则配置文件无法生效。
例如：本例中i3c_config.hcs所在路径为device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/i3c/i3c_config.hcs，则必须在产品对应的hdf.hcs中添加如下语句：
```c
#include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/i3c/i3c_config.hcs" // 配置文件相对路径
```
需要注意的是，新增i3c_config.hcs配置文件后，必须在对应的hdf.hcs文件中包含i3c_config.hcs所在路径信息，否则配置文件无法生效。
3. 实例化I3C控制器对象
......@@ -290,7 +284,7 @@ I3C模块适配包含以下五个步骤：
**返回值：**
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。
**表 3** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-mipicsi-develop.md
浏览文件 @ 6863c51a
......@@ -288,7 +288,7 @@ MIPI CSI模块适配包含以下四个步骤：
返回值：
HDF_STATUS相关状态 （表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS的定义）。
HDF_STATUS相关状态 （表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS的定义）。
**表 3** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-mipidsi-des.md
浏览文件 @ 6863c51a
......@@ -18,7 +18,7 @@ DSI标准对应D-PHY、DSI、DCS规范，可分为四层：
- PHY Layer
定义了传输媒介，输入/输出电路和和时钟和信号机制。PHY层指定传输介质(电导体)、输入/输出电路和从串行比特流中捕获“1”和“0”的时钟机制。这一部分的规范记录了传输介质的特性、信号的电气参数以及时钟与数据通道之间的时序关系。在DSI链路的发送端，并行数据、信号事件和命令按照包组织在协议层转换为包。协议层附加包协议信息和报头，然后通过Lane Management层向PHY发送完整的字节。数据由PHY进行序列化，并通过串行链路发送。DSI链路的接收端执行与发送端相反的操作，将数据包分解为并行的数据、信号事件和命令。如果有多个Lane, Lane管理层将字节分配给单独的物理层，每个Lane一个PHY。
PHY层指定传输介质(电导体)、输入/输出电路和从串行比特流中捕获“1”和“0”的时钟机制。这一部分的规范记录了传输介质的特性、信号的电气参数以及时钟与数据通道之间的时序关系。在DSI链路的发送端，并行数据、信号事件和命令按照包组织在协议层转换为包。协议层附加包协议信息和报头，然后通过Lane Management层向PHY发送完整的字节。数据由PHY进行序列化，并通过串行链路发送。DSI链路的接收端执行与发送端相反的操作，将数据包分解为并行的数据、信号事件和命令。如果有多个Lane, Lane管理层将字节分配给单独的物理层，每个Lane一个PHY。
- Lane Management层
......
zh-cn/device-dev/driver/driver-platform-mipidsi-develop.md
浏览文件 @ 6863c51a
......@@ -18,7 +18,7 @@ DSI标准对应D-PHY、DSI、DCS规范，可分为四层：
- PHY Layer
定义了传输媒介，输入/输出电路和和时钟和信号机制。PHY层指定传输介质(电导体)、输入/输出电路和从串行比特流中捕获“1”和“0”的时钟机制。这一部分的规范记录了传输介质的特性、信号的电气参数以及时钟与数据通道之间的时序关系。在DSI链路的发送端，并行数据、信号事件和命令按照包组织在协议层转换为包。协议层附加包协议信息和报头，然后通过Lane Management层向PHY发送完整的字节。数据由PHY进行序列化，并通过串行链路发送。DSI链路的接收端执行与发送端相反的操作，将数据包分解为并行的数据、信号事件和命令。如果有多个Lane, Lane管理层将字节分配给单独的物理层，每个Lane一个PHY。
PHY层指定传输介质(电导体)、输入/输出电路和从串行比特流中捕获“1”和“0”的时钟机制。这一部分的规范记录了传输介质的特性、信号的电气参数以及时钟与数据通道之间的时序关系。在DSI链路的发送端，并行数据、信号事件和命令按照包组织在协议层转换为包。协议层附加包协议信息和报头，然后通过Lane Management层向PHY发送完整的字节。数据由PHY进行序列化，并通过串行链路发送。DSI链路的接收端执行与发送端相反的操作，将数据包分解为并行的数据、信号事件和命令。如果有多个Lane, Lane管理层将字节分配给单独的物理层，每个Lane一个PHY。
- Lane Management层
......@@ -227,7 +227,7 @@ MIPI DSI模块适配包含以下四个步骤：
返回值：
HDF_STATUS相关状态 （表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS的定义）。
HDF_STATUS相关状态 （表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS的定义）。
**表 3** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-mmc-develop.md
浏览文件 @ 6863c51a
......@@ -337,7 +337,7 @@ MMC模块适配包含以下四个步骤：
返回值：
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS的定义）。
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS的定义）。
**表 3** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-pin-develop.md
浏览文件 @ 6863c51a
......@@ -345,7 +345,7 @@ PIN模块适配HDF框架包含以下四个步骤：
返回值：
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。
**表 3** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-pwm-develop.md
浏览文件 @ 6863c51a
......@@ -240,7 +240,7 @@ PWM模块适配包含以下四个步骤：
返回值：
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。
**表 3** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-regulator-develop.md
浏览文件 @ 6863c51a
......@@ -121,7 +121,7 @@ Regulator模块适配包含以下四个步骤：
| serviceName | 驱动对外发布服务的名称，Regulator管理器固定为HDF_PLATFORM_REGULATOR_MANAGER |
| deviceMatchAttr | 驱动私有数据匹配的关键字，Regulator管理器设置为hdf_platform_regulator_manager |
从第二个节点开始配置具体Regulator控制器信息，此节点并不表示某一路Regulator控制器，而是代表一个资源性质设备，用于描述一类Regulator控制器的信息。本例只有一个Regulator设备，如有多个设备，则需要在device_info.hcs文件增加deviceNode信息，以及在regulator_config.hcs文件中增加对应的器件属性。
从第二个节点开始配置具体Regulator控制器信息，此节点并不表示某一路Regulator控制器，而是代表一个资源性质设备，用于描述一类Regulator控制器的信息。本例只有一个Regulator设备，如有多个设备，则需要在device_info.hcs文件增加deviceNode信息，以及在regulator_config_linux.hcs文件中增加对应的器件属性。
- device_info.hcs 配置参考
......@@ -153,14 +153,14 @@ Regulator模块适配包含以下四个步骤：
}
```
- regulator_config.hcs配置参考
- regulator_config_linux.hcs配置参考
```c
root {
platform {
regulator_config {
match_attr = "linux_regulator_adapter";
template regulator_controller { // 【必要】模板配置，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省。
template regulator_controller { // 【必要】模板配置，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省。
device_num = 1;
name = "";
devName = "regulator_adapter_consumer01";
......@@ -201,10 +201,10 @@ Regulator模块适配包含以下四个步骤：
需要注意的是，新增regulator_config.hcs配置文件后，必须在hdf.hcs文件中将其包含，否则配置文件无法生效。
例如：本例中regulator_config.hcs所在路径为device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/regulator/regulator_config.hcs，则必须在产品对应的hdf.hcs中添加如下语句：
例如：本例中regulator_config.hcs所在路径为//vendor/hisilicon/hispark_taurus_linux/hdf_config/device/regulator/regulator_config_linux.hcs，则必须在产品对应的hdf.hcs中添加如下语句：
```c
#include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/regulator/regulator_config.hcs" // 配置文件相对路径
#include "device/regulator/regulator_config_linux.hcs"
```
3. 实例化核心层接口函数
......@@ -272,7 +272,7 @@ Regulator模块适配包含以下四个步骤：
返回值：
HDF_STATUS相关状态（表4为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
HDF_STATUS相关状态（表4为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。
**表 3** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-rtc-develop.md
浏览文件 @ 6863c51a
......@@ -259,7 +259,7 @@ RTC模块适配HDF框架包含以下四个步骤：
返回值：
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。
**表 3** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-sdio-develop.md
浏览文件 @ 6863c51a
......@@ -40,7 +40,7 @@ SDIO的应用比较广泛，目前，有许多手机都支持SDIO功能，并且
### 接口说明
为了保证上层在调用SDIO接口时能够正确的操作硬件，核心层在//drivers/hdf_core/framework/model/storage/include/mmc//mmc_sdio.h中定义了以下钩子函数。驱动适配者需要在适配层实现这些函数的具体功能，并与这些钩子函数挂接，从而完成接口层与核心层的交互。
为了保证上层在调用SDIO接口时能够正确的操作硬件，核心层在//drivers/hdf_core/framework/model/storage/include/mmc/mmc_sdio.h中定义了以下钩子函数。驱动适配者需要在适配层实现这些函数的具体功能，并与这些钩子函数挂接，从而完成接口层与核心层的交互。
SdioDeviceOps定义：
......@@ -205,13 +205,7 @@ SDIO模块适配包含以下四个步骤：
}
```
需要注意的是，新增sdio_config.hcs配置文件后，必须在hdf.hcs文件中将其包含，否则配置文件无法生效。
例如：本例中sdio_config.hcs所在路径为device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/sdio/sdio_config.hcs，则必须在产品对应的hdf.hcs中添加如下语句：
```c
#include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/sdio/sdio_config.hcs" // 配置文件相对路径
```
需要注意的是，新增sdio_config.hcs配置文件后，必须在hdf.hcs文件中包含sdio_config.hcs所在路径信息，否则配置文件无法生效。
3. 实例化SDIO设备控制器对象
......@@ -279,7 +273,7 @@ SDIO模块适配包含以下四个步骤：
返回值：
HDF_STATUS相关状态 （表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS的定义）。
HDF_STATUS相关状态 （表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS的定义）。
**表 3** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-spi-develop.md
浏览文件 @ 6863c51a
......@@ -362,7 +362,7 @@ SPI模块适配包含以下四个步骤：
返回值：
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。
**表 3** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-uart-des.md
浏览文件 @ 6863c51a
......@@ -80,6 +80,8 @@ UART模块应用比较广泛，主要用于实现设备之间的低速串行通
### 接口说明
UART模块提供的主要接口如表1所示，具体API详见//drivers/hdf_core/framework/include/platform/uart_if.h。
**表 1** UART驱动API接口功能介绍
| 接口名 | 接口描述 |
......
zh-cn/device-dev/driver/driver-platform-uart-develop.md
浏览文件 @ 6863c51a
......@@ -222,6 +222,8 @@ UART模块适配HDF框架包含以下四个步骤：
需要注意的是，新增uart_config.hcs配置文件后，必须在产品对应的hdf.hcs文件中将其包含如下语句所示，否则配置文件无法生效。
例如：本例中uart_config.hcs所在路径为device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/uart/uart_config.hcs，则必须在产品对应的hdf.hcs中添加如下语句：
```c
#include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/uart/uart_config.hcs" // 配置文件相对路径
```
......@@ -305,7 +307,7 @@ UART模块适配HDF框架包含以下四个步骤：
返回值：
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS中HDF_STATUS定义）。
HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS中HDF_STATUS定义）。
**表 3** HDF_STATUS相关状态说明
......
zh-cn/device-dev/driver/driver-platform-watchdog-develop.md
浏览文件 @ 6863c51a
......@@ -220,7 +220,7 @@ Watchdog模块适配包含以下四个步骤：
返回值：
HDF_STATUS相关状态 （表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS的定义）。
HDF_STATUS相关状态 （表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS的定义）。
**表 3** HDF_STATUS相关状态说明
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或