From 88625c9bce2331e978ccabad12f6c213a56e369f Mon Sep 17 00:00:00 2001 From: jiaziyangnewer Date: Wed, 19 Jul 2023 15:47:43 +0800 Subject: [PATCH] fix: fix the platform documents problems Signed-off-by: jiaziyangnewer --- .../device-dev/driver/driver-platform-adc-develop.md | 2 +- .../device-dev/driver/driver-platform-dac-develop.md | 2 +- .../driver/driver-platform-gpio-develop.md | 2 +- .../driver/driver-platform-hdmi-develop.md | 4 +++- .../device-dev/driver/driver-platform-i2c-develop.md | 2 +- .../device-dev/driver/driver-platform-i3c-develop.md | 12 +++--------- .../driver/driver-platform-mipicsi-develop.md | 2 +- .../device-dev/driver/driver-platform-mipidsi-des.md | 2 +- .../driver/driver-platform-mipidsi-develop.md | 4 ++-- .../device-dev/driver/driver-platform-mmc-develop.md | 2 +- .../device-dev/driver/driver-platform-pin-develop.md | 2 +- .../device-dev/driver/driver-platform-pwm-develop.md | 2 +- .../driver/driver-platform-regulator-develop.md | 10 +++++----- .../device-dev/driver/driver-platform-rtc-develop.md | 2 +- .../driver/driver-platform-sdio-develop.md | 12 +++--------- .../device-dev/driver/driver-platform-spi-develop.md | 2 +- zh-cn/device-dev/driver/driver-platform-uart-des.md | 2 ++ .../driver/driver-platform-uart-develop.md | 4 +++- .../driver/driver-platform-watchdog-develop.md | 2 +- 19 files changed, 33 insertions(+), 39 deletions(-) diff --git a/zh-cn/device-dev/driver/driver-platform-adc-develop.md b/zh-cn/device-dev/driver/driver-platform-adc-develop.md index 2184363645..2bdaf71c62 100755 --- a/zh-cn/device-dev/driver/driver-platform-adc-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-adc-develop.md @@ -296,7 +296,7 @@ ADC模块适配必选的三个环节是实例化驱动入口，配置属性文 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。 | 状态(值) | 问题描述 | | -------- | -------- | diff --git a/zh-cn/device-dev/driver/driver-platform-dac-develop.md b/zh-cn/device-dev/driver/driver-platform-dac-develop.md index b2d5bfb0cb..41ec4fa42d 100644 --- a/zh-cn/device-dev/driver/driver-platform-dac-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-dac-develop.md @@ -341,7 +341,7 @@ DAC模块适配包含以下四个步骤： 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。 | 状态(值) | 问题描述 | | ---------------------- | ------------- | diff --git a/zh-cn/device-dev/driver/driver-platform-gpio-develop.md b/zh-cn/device-dev/driver/driver-platform-gpio-develop.md index 985207d9cd..86cc14cc13 100755 --- a/zh-cn/device-dev/driver/driver-platform-gpio-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-gpio-develop.md @@ -246,7 +246,7 @@ GPIO模块适配包含以下四个步骤： 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。 **表2** Init函数说明 diff --git a/zh-cn/device-dev/driver/driver-platform-hdmi-develop.md b/zh-cn/device-dev/driver/driver-platform-hdmi-develop.md index 2568e2e3cd..5bf040eeae 100755 --- a/zh-cn/device-dev/driver/driver-platform-hdmi-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-hdmi-develop.md @@ -227,6 +227,8 @@ HDMI模块适配的三个环节是实例化驱动入口、配置属性文件以 } ``` + 需要注意的是，新增hdmi_config.hcs配置文件后，必须在对应的hdf.hcs文件中包含hdmi_config.hcs所在路径信息，否则配置文件无法生效。 + 3. 实例化控制器对象 最后一步，完成驱动入口注册之后，要以核心层HdmiCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化HdmiCntlr成员HdmiCntlrOps（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。 @@ -320,7 +322,7 @@ HDMI模块适配的三个环节是实例化驱动入口、配置属性文件以 **返回值：** - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS 定义） + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS 定义） |状态(值)|状态描述| |:-|:-| diff --git a/zh-cn/device-dev/driver/driver-platform-i2c-develop.md b/zh-cn/device-dev/driver/driver-platform-i2c-develop.md index cf8fdfa72c..a4ccc9bb5b 100755 --- a/zh-cn/device-dev/driver/driver-platform-i2c-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-i2c-develop.md @@ -280,7 +280,7 @@ I2C模块适配的三个必选环节是实例化驱动入口，配置属性文 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。 **表4** Init函数入参及返回值参考 diff --git a/zh-cn/device-dev/driver/driver-platform-i3c-develop.md b/zh-cn/device-dev/driver/driver-platform-i3c-develop.md index 125f67535d..bc1cf1f9e2 100755 --- a/zh-cn/device-dev/driver/driver-platform-i3c-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-i3c-develop.md @@ -196,7 +196,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; // 【必要】中断号 @@ -214,13 +214,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控制器对象 @@ -272,7 +266,7 @@ I3C模块适配的四个环节是实例化驱动入口、配置属性文件、 **返回值：** - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS 定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS 定义）。 |状态(值)|问题描述| diff --git a/zh-cn/device-dev/driver/driver-platform-mipicsi-develop.md b/zh-cn/device-dev/driver/driver-platform-mipicsi-develop.md index fd4c6675b3..ac9df56adb 100755 --- a/zh-cn/device-dev/driver/driver-platform-mipicsi-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-mipicsi-develop.md @@ -267,7 +267,7 @@ MIPI CSI模块适配的三个必选环节是配置属性文件、实例化驱动 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。 **表2** HDF_STATUS返回值描述 diff --git a/zh-cn/device-dev/driver/driver-platform-mipidsi-des.md b/zh-cn/device-dev/driver/driver-platform-mipidsi-des.md index 73b158b58f..151f8d8d0e 100644 --- a/zh-cn/device-dev/driver/driver-platform-mipidsi-des.md +++ b/zh-cn/device-dev/driver/driver-platform-mipidsi-des.md @@ -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层 diff --git a/zh-cn/device-dev/driver/driver-platform-mipidsi-develop.md b/zh-cn/device-dev/driver/driver-platform-mipidsi-develop.md index a83b5de131..c403514e80 100755 --- a/zh-cn/device-dev/driver/driver-platform-mipidsi-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-mipidsi-develop.md @@ -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层 @@ -208,7 +208,7 @@ MIPI DSI模块适配的三个必选环节是配置属性文件，实例化驱动 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。 **表2** HDF_STATUS返回值描述 diff --git a/zh-cn/device-dev/driver/driver-platform-mmc-develop.md b/zh-cn/device-dev/driver/driver-platform-mmc-develop.md index 29ea843e82..32df2c9614 100755 --- a/zh-cn/device-dev/driver/driver-platform-mmc-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-mmc-develop.md @@ -317,7 +317,7 @@ MMC模块适配包含以下四个步骤： 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。 **表2** Bind函数说明 diff --git a/zh-cn/device-dev/driver/driver-platform-pin-develop.md b/zh-cn/device-dev/driver/driver-platform-pin-develop.md index 5d3fdaab67..6705ca2120 100755 --- a/zh-cn/device-dev/driver/driver-platform-pin-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-pin-develop.md @@ -326,7 +326,7 @@ PIN模块适配HDF框架包含以下四个步骤： 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。 | **状态(值)** | **问题描述** | | ---------------------- | -------------- | diff --git a/zh-cn/device-dev/driver/driver-platform-pwm-develop.md b/zh-cn/device-dev/driver/driver-platform-pwm-develop.md index 6c716b56ac..33da353215 100755 --- a/zh-cn/device-dev/driver/driver-platform-pwm-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-pwm-develop.md @@ -218,7 +218,7 @@ PWM模块适配包含以下四个步骤： 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。 | 状态(值) | 问题描述 | | -------- | -------- | diff --git a/zh-cn/device-dev/driver/driver-platform-regulator-develop.md b/zh-cn/device-dev/driver/driver-platform-regulator-develop.md index 4db05339c9..98632e54fb 100755 --- a/zh-cn/device-dev/driver/driver-platform-regulator-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-regulator-develop.md @@ -116,7 +116,7 @@ Regulator模块适配包含以下四个步骤： | serviceName | 固定为HDF_PLATFORM_REGULATOR_MANAGER | | deviceMatchAttr | 没有使用，可忽略 | - 从第二个节点开始配置具体Regulator控制器信息，此节点并不表示某一路Regulator控制器，而是代表一个资源性质设备，用于描述一类Regulator控制器的信息。本例只有一个Regulator设备，如有多个设备，则需要在device_info.hcs文件增加deviceNode信息，以及在regulator\_config文件中增加对应的器件属性。 + 从第二个节点开始配置具体Regulator控制器信息，此节点并不表示某一路Regulator控制器，而是代表一个资源性质设备，用于描述一类Regulator控制器的信息。本例只有一个Regulator设备，如有多个设备，则需要在device_info.hcs文件增加deviceNode信息，以及在regulator_config_linux.hcs文件中增加对应的器件属性。 - device_info.hcs 配置参考 @@ -150,7 +150,7 @@ Regulator模块适配包含以下四个步骤： } ``` - - regulator\_config.hcs配置参考 + - regulator_config_linux.hcs配置参考 ```c root { @@ -198,10 +198,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. 实例化核心层接口函数： @@ -269,7 +269,7 @@ Regulator模块适配包含以下四个步骤： 返回值： - HDF\_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf\_core/framework/include/utils/hdf\_base.h中HDF\_STATUS定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。 **表 2** HDF\_STATUS相关状态 diff --git a/zh-cn/device-dev/driver/driver-platform-rtc-develop.md b/zh-cn/device-dev/driver/driver-platform-rtc-develop.md index 16eeb076e3..876c0afe8b 100755 --- a/zh-cn/device-dev/driver/driver-platform-rtc-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-rtc-develop.md @@ -231,7 +231,7 @@ RTC模块适配HDF框架的三个必选环节是实例化驱动入口，配置 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。 **表2** HDF_STATUS返回值描述 diff --git a/zh-cn/device-dev/driver/driver-platform-sdio-develop.md b/zh-cn/device-dev/driver/driver-platform-sdio-develop.md index b5d7e6205a..5c1444bc5e 100755 --- a/zh-cn/device-dev/driver/driver-platform-sdio-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-sdio-develop.md @@ -31,7 +31,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定义： @@ -182,13 +182,7 @@ SDIO模块适配HDF框架的三个必选环节是实例化驱动入口，配置 } ``` - 需要注意的是，新增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. 完成属性文件配置之后，下一步就是以核心层SdioDevice对象的初始化为核心，包括驱动适配者自定义结构体（传递参数和数据），实例化SdioDevice成员SdioDeviceOps（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。 @@ -254,7 +248,7 @@ SDIO模块适配HDF框架的三个必选环节是实例化驱动入口，配置 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS 定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS 定义）。 **表2** Bind函数入参及返回值 diff --git a/zh-cn/device-dev/driver/driver-platform-spi-develop.md b/zh-cn/device-dev/driver/driver-platform-spi-develop.md index 906e067e5d..4cb67eab76 100755 --- a/zh-cn/device-dev/driver/driver-platform-spi-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-spi-develop.md @@ -327,7 +327,7 @@ SPI模块适配HDF框架的三个必选环节是实例化驱动入口，配置 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。 **表2** HDF_STATUS返回值描述 diff --git a/zh-cn/device-dev/driver/driver-platform-uart-des.md b/zh-cn/device-dev/driver/driver-platform-uart-des.md index 500ab657ea..ee6906c5a0 100644 --- a/zh-cn/device-dev/driver/driver-platform-uart-des.md +++ b/zh-cn/device-dev/driver/driver-platform-uart-des.md @@ -67,6 +67,8 @@ UART模块应用比较广泛，主要用于实现设备之间的低速串行通 ### 接口说明 +UART模块提供的主要接口如表1所示，具体API详见//drivers/hdf_core/framework/include/platform/uart_if.h。 + **表1** UART驱动API接口功能介绍 | 接口名 | 接口描述 | diff --git a/zh-cn/device-dev/driver/driver-platform-uart-develop.md b/zh-cn/device-dev/driver/driver-platform-uart-develop.md index 1e6d806ce2..520780be02 100755 --- a/zh-cn/device-dev/driver/driver-platform-uart-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-uart-develop.md @@ -199,6 +199,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" // 配置文件相对路径 ``` @@ -282,7 +284,7 @@ UART模块适配HDF框架包含以下四个步骤： 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可参见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS中HDF_STATUS定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可参见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS中HDF_STATUS定义）。 **表2** HDF_STATUS返回值说明 diff --git a/zh-cn/device-dev/driver/driver-platform-watchdog-develop.md b/zh-cn/device-dev/driver/driver-platform-watchdog-develop.md index b3ed75f7d5..620529ee01 100755 --- a/zh-cn/device-dev/driver/driver-platform-watchdog-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-watchdog-develop.md @@ -200,7 +200,7 @@ Watchdog模块适配包含以下四个步骤： 返回值： - HDF_STATUS相关状态 （下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS的定义）。 + HDF_STATUS相关状态 （下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS的定义）。 **表2** Init函数和Bind函数返回值和描述 -- GitLab