From 35fa744c8fe3ee43b979a594919967979d01ca19 Mon Sep 17 00:00:00 2001 From: z1210678430 Date: Wed, 8 Jun 2022 22:56:59 -0700 Subject: [PATCH] Modify README Signed-off-by: z1210678430 --- README_zh.md | 38 +++++++++++++++++++++----------------- 1 file changed, 21 insertions(+), 17 deletions(-) diff --git a/README_zh.md b/README_zh.md index 5dbf80ab..7786ef71 100644 --- a/README_zh.md +++ b/README_zh.md @@ -15,7 +15,7 @@ 该仓主要存放OpenHarmony驱动子系统核心源码信息（包括驱动框架、配置管理、配置解析、驱动通用框架模型、硬件通用平台能力接口等），旨在为开发者提供更精准、更高效的开发环境，力求做到一次开发，多系统部署。 -**图 1** 驱动框架的架构图 +**图 1** 驱动框架架构图 ![](figures/architecture-of-the-hdf.png) ## 目录 @@ -67,9 +67,9 @@ ### 驱动框架使用说明 -基于HDF（驱动框架）开发驱动，用户只需注册自己所需的接口和配置，然后驱动框架就会解析配置的内容，完成驱动加载和初始化动作。 +基于HDF（驱动框架）开发驱动，开发者只需注册所需接口和配置，驱动框架就会解析配置内容，完成驱动加载和初始化动作。 -开发者基于HDF驱动框架开发的驱动主要包含三大部分： +HDF驱动框架主要包含三部分： 1、驱动程序部分----完成驱动的功能逻辑。 @@ -79,7 +79,7 @@ 驱动程序主要是完成驱动功能的逻辑代码： -对于开发者首先看到的是驱动入口部分，驱动入口部分通过DriverEntry进行描述。 +对于开发者首先看到的是驱动入口部分，驱动入口通过结构体DriverEntry进行描述。 其中主要包含Bind, Init 和Release三个接口。 @@ -102,7 +102,7 @@ int32_t SampleDriverBind(struct HdfDeviceObject *deviceObject) } ``` -Init接口描述：当框架完成设备绑定动作后，就开始调用驱动初始化接口，当初始化成功后，驱动框架根据配置文件决定是否对外创建设备服务接口，还是只是对当前服务接口可见。如果Init初始化失败的话，驱动框架就会主动释放创建的设备接口等信息。 +Init接口描述：当框架完成设备绑定动作后，就开始调用驱动初始化接口，初始化成功后，驱动框架根据配置文件决定是对外创建设备服务接口，还是接口只对当前服务可见。如果Init初始化失败，驱动框架就会主动释放创建的设备接口等信息。 ``` int32_t SampleDriverInit(struct HdfDeviceObject *deviceObject) @@ -111,7 +111,7 @@ int32_t SampleDriverInit(struct HdfDeviceObject *deviceObject) } ``` -Release接口描述：当用户需要卸载驱动时，驱动框架先通过该接口通知驱动程序释放资源。然后在执行其他内部资源释放。 +Release接口描述：当用户需要卸载驱动时，驱动框架先通过该接口通知驱动程序释放资源，然后再释放其他内部资源。 ``` void SampleDriverRelease(struct HdfDeviceObject *deviceObject) @@ -125,37 +125,41 @@ HDF驱动框架详细开发请参考[驱动开发指南](https://gitee.com/openh ### Sensor框架模型说明 -基于HDF（**H**ardware **D**river **F**oundation）驱动框架开发的Sensor驱动模型，实现跨操作系统迁移，器件差异配置等功能，具体包括下面两部分： +基于HDF（**H**ardware **D**river **F**oundation）驱动框架的Sensor驱动模型，可实现跨操作系统迁移、器件差异配置等功能。 +Sensor驱动模型主要由以下两部分组成： -- Sensor驱动模型基础能力部分：依赖HDF驱动框架实现Sensor器件驱动的注册，加载，去注册，器件探测等能力，提供同一类型Sensor器件驱动归一接口, 寄存器配置解析操作接口，总线访问抽象接口，平台抽象接口。 -- 开发者实现的部分：依赖HDF驱动框架的HCS\(**H**DF **C**onfiguration **S**ource\)配置管理，根据同类型Sensor差异化配置，实现Sensor器件参数序列化配置和器件部分操作接口，简化Sensor器件驱动开发。 +- 基础能力部分：依赖HDF驱动框架实现Sensor器件驱动的注册、加载、去注册、器件探测等能力，提供同一类型Sensor器件的驱动归一接口、寄存器配置解析操作接口、总线访问抽象接口和平台抽象接口。 +- 开发者实现部分：依赖HDF驱动框架的HCS\(**H**DF **C**onfiguration **S**ource\)配置管理，根据同类型Sensor差异化配置，实现Sensor器件参数序列化配置和器件部分操作接口。 基于Sensor驱动模型开发Sensor器件驱动请参考[Sensor驱动开发指南](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/driver/driver-peripherals-sensor-des.md)。 ### Display框架模型说明 -基于OpenHarmony驱动框架的Display驱动模型，对上屏蔽了芯片平台差异，方便操作系统跨平台迁移；向下抽象外设驱动公共业务逻辑，通过配置或差异化适配接口，实现一套驱动模型可兼容不同的外设器件，使得三方厂商可以高效、便捷的切入鸿蒙驱动生态。 +基于OpenHarmony驱动框架的Display驱动模型，对下屏蔽了芯片平台差异，方便操作系统跨平台迁移；向上抽象了外设驱动公共业务逻辑，通过配置或差异化适配接口，实现了一套驱动模型兼容不同的外设器件，使得三方厂商可以高效、便捷的切入鸿蒙驱动生态。 +Display驱动模型主要由以下两部分组成： -- Display驱动模型基础能力部分：包括HDI（**H**ardware **D**river **I**nterfaces）接口的定义及其实现框架，以及芯片平台对HDI接口的适配实现；内核驱动部分抽象了Panel驱动的公共业务，提供基础的Panel初始化、器件配置信息获取、上下电、背光设置等公共流程。 -- 驱动开发者实现的部分：需要完成板级的HCS配置及Panel私有数据配置，或者实现部分器件差异化接口，保证显示屏驱动开发高效便捷。 +- 基础能力部分：包括HDI（**H**ardware **D**river **I**nterfaces）接口的定义及实现框架，以及芯片平台对HDI接口的适配实现；内核驱动部分抽象了Panel驱动的公共业务，提供了Panel初始化、器件配置信息获取、上下电、背光设置等公共流程。 +- 开发者实现部分：需要完成板级HCS配置及Panel私有数据配置，实现部分器件差异化接口。 基于Display驱动模型开发LCD器件驱动请参考[LCD驱动开发指南](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/driver/driver-peripherals-lcd-des.md)。 ### Input框架模型说明 -基于OpenHarmony驱动框架的Input驱动模型，不依赖于芯片平台，对上层输入服务提供统一的驱动接口；在具体的驱动模型实现中，针对不同类别的输入设备，抽象出几类公共的平台驱动，通过配置及差异化的适配接口，使得驱动模型可兼容不同的输入设备。 +基于OpenHarmony驱动框架的Input驱动模型，不依赖于芯片平台，对上层输入服务提供统一的驱动接口；在具体的驱动模型实现中，针对不同类别的输入设备，抽象出几类公共的平台驱动，通过配置及差异化的适配接口，使得驱动模型可兼容不同的输入设备。借由此驱动模型，可大幅缩减Input设备驱动的开发周期 +Input驱动模型主要有以下两部分组成： -- Input驱动模型基础能力部分：包括Input HDI层的接口定义及公共实现，对上层输入服务提供设备管理、业务控制、数据上报等驱动能力接口；而Input驱动模型提供不同类型Input设备的归一化驱动, 包括输入设备的注册和注销、event数据的上报通道、配置信息的解析、公共驱动的加载等能力。 -- 开发者实现的部分：根据驱动模型提供的平台驱动，需要完成设备描述配置及器件私有配置，以及实现预留的器件差异化接口，借由此驱动模型，可大幅缩减Input设备驱动的开发周期。 +- 基础能力部分：包括Input HDI层的接口定义及公共实现，对上层输入服务提供设备管理、业务控制、数据上报等驱动能力接口；而Input驱动模型提供不同类型Input设备的归一化驱动, 包括输入设备的注册和注销、event数据的上报通道、配置信息的解析、公共驱动的加载等能力。 +- 开发者实现部分：需根据驱动模型提供的平台驱动，完成设备描述配置及器件私有配置，实现预留的器件差异化接口。 基于Input驱动模型开发Touchscreen器件驱动请参考[Touchscreen驱动开发指南](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/driver/driver-peripherals-touch-des.md)。 ### WLAN框架模型说明 基于OpenHarmony驱动框架的WLAN驱动模型，可实现跨操作系统迁移，自适应器件差异，模块化拼装编译等功能。各WLAN厂商驱动开发人员可根据WLAN模块提供的向下统一接口适配各自的驱动代码，HDI层开发人员可根据WLAN模块提供的向上统一接口获取如下能力：建立/关闭WLAN热点、扫描、关联WLAN热点等。 +WLAN驱动模型主要有以下两部分组成： -- WLAN驱动模型基础能力部分：包括WLAN HDI层的接口定义及公共实现，对上层输入服务提供如设置MAC地址，获取设备的MAC地址，获取特性的类型，设置发射功率等能力；对驱动开发者提供创建/释放WifiModule，关联/取消关联，申请/释放NetBuf等能力。 -- 驱动开发者实现的部分：根据驱动模型提供的平台驱动，需要完成板级的HCS配置及WLAN芯片的私有配置，以及实现预留的初始化/注销网络设备、打开/关闭网络设备等相关接口。 +- 基础能力部分：包括WLAN HDI层的接口定义及公共实现，对上层输入服务提供如设置MAC地址，获取设备MAC地址，获取特性类型，设置发射功率等能力；对驱动开发者提供创建/释放WifiModule、关联/取消关联、申请/释放NetBuf等能力。 +- 开发者实现部分：需根据驱动模型提供的平台驱动，完成板级的HCS配置及WLAN芯片的私有配置，实现预留的初始化/注销网络设备、打开/关闭网络设备等相关接口。 基于WLAN驱动模型开发WLAN器件驱动请参考[WLAN驱动开发指南](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/driver/driver-peripherals-external-des.md)。