1# Hdf Framework<a name="ZH-CN_TOPIC_0000001078041442"></a> 2 3- [简介](#section11660541593) 4- [目录](#section161941989596) 5- [说明](#section1312121216216) 6 - [驱动框架使用说明](#section129654513264) 7 - [Sensor框架模型说明](#section188637474417) 8 - [Display框架模型说明](#section161502341317) 9 - [Input框架模型说明](#section12629164020115) 10 - [WLAN框架模型说明](#section11408103183114) 11 12- [相关仓](#section1371113476307) 13 14## 简介<a name="section11660541593"></a> 15 16该仓主要存放OpenHarmony驱动子系统核心源码信息（包括驱动框架、配置管理、配置解析、驱动通用框架模型、硬件通用平台能力接口等），旨在为开发者提供更精准、更高效的开发环境，力求做到一次开发，多系统部署。 17 18**图 1** 驱动框架的架构图<a name="fig1181155517618"></a> 19 20 21## 目录<a name="section161941989596"></a> 22 23``` 24/drivers/framework 25├── ability #提供驱动开发的能力支持，如消息模型库等 26│ ├── config #配置解析代码 27│ └── sbuf #数据序列化代码 28├── core #实现驱动框架的核心代码 29│ ├── adapter #实现对内核操作接口适配，提供抽象化的接口供开发者使用 30│ ├── common #驱动框架公共基础代码 31│ ├── host #驱动宿主环境模块 32│ ├── manager #驱动框架管理模块 33│ └── shared #host和manager共享模块代码 34├── include #驱动框架对外提供能力的头文件 35│ ├── config #提供配置解析能力的头文件 36│ ├── core #驱动框架对外提供的头文件 37│ ├── net #网络数据操作相关的头文件 38│ ├── osal #系统适配相关接口的头文件 39│ ├── platform #平台设备相关接口的头文件 40│ ├── utils #驱动框架公共能力的头文件 41│ └── wifi #WLAN对外提供能力的头文件 42├── model #提供驱动通用框架模型 43│ ├── display #显示框架模型 44│ ├── input #输入框架模型 45│ ├── network #WLAN框架模型 46│ └── sensor #Sensor驱动模型 47├── support #提系统的基础能力 48│ └── platform #平台设备驱动框架及访问接口，范围包括GPIO、I2C、SPI等 49├── tools #hdf框架工具相关的源码 50│ └── hc-gen #配置管理工具源码 51└── utils #提供基础数据结构和算法等 52``` 53 54## 说明<a name="section1312121216216"></a> 55 56### 驱动框架使用说明<a name="section129654513264"></a> 57 58基于HDF（驱动框架）开发驱动，用户只需注册自己所需的接口和配置，然后驱动框架就会解析配置的内容，完成驱动加载和初始化动作。 59 60开发者基于HDF驱动框架开发的驱动主要包含三大部分： 61 621、驱动程序部分----完成驱动的功能逻辑。 63 642、驱动配置信息----指示驱动的加载信息内容。 65 663、驱动资源配置----配置驱动的硬件配置信息。 67 68驱动程序主要是完成驱动功能的逻辑代码： 69 70对于开发者首先看到的是驱动入口部分，驱动入口部分通过DriverEntry进行描述。 71 72其中主要包含Bind, Init 和Release三个接口。 73 74``` 75struct HdfDriverEntry g_deviceSample = { 76 .moduleVersion = 1, 77 .moduleName = "sample_driver", 78 .Bind = SampleDriverBind, 79 .Init = SampleDriverInit, 80 .Release = SampleDriverRelease, 81}; 82``` 83 84Bind接口描述：该接口的作用主要是完成驱动设备和设备服务接口的bind动作。 85 86``` 87int32_t SampleDriverBind(struct HdfDeviceObject *deviceObject) 88{ 89 // TODO: Bind device service to device object. 90 // And you can also initialize device resources here. 91 return HDF_SUCCESS; 92} 93``` 94 95Init接口描述：当框架完成设备绑定动作后，就开始调用驱动初始化接口，当初始化成功后，驱动框架根据配置文件决定是否对外创建设备服务接口，还是只是对当前服务接口可见。如果Init初始化失败的话，驱动框架就会主动释放创建的设备接口等信息。 96 97``` 98int32_t SampleDriverInit(struct HdfDeviceObject *deviceObject) 99{ 100 // TODO: Init hardware or other resources here. 101 return HDF_SUCCESS; 102} 103``` 104 105Release接口描述：当用户需要卸载驱动时，驱动框架先通过该接口通知驱动程序释放资源。然后在执行其他内部资源释放。 106 107``` 108void SampleDriverRelease(struct HdfDeviceObject *deviceObject) 109{ 110 // Release all resources. 111 return; 112} 113``` 114 115HDF驱动框架详细开发请参考[驱动开发指南](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/driver/driver-hdf.md)。 116 117### Sensor框架模型说明<a name="section188637474417"></a> 118 119基于HDF（**H**ardware **D**river **F**oundation）驱动框架开发的Sensor驱动模型，实现跨操作系统迁移，器件差异配置等功能，具体包括下面两部分： 120 121- Sensor驱动模型基础能力部分：依赖HDF驱动框架实现Sensor器件驱动的注册，加载，去注册，器件探测等能力，提供同一类型Sensor器件驱动归一接口, 寄存器配置解析操作接口，总线访问抽象接口，平台抽象接口。 122- 开发者实现的部分：依赖HDF驱动框架的HCS\(**H**DF **C**onfiguration **S**ource\)配置管理，根据同类型Sensor差异化配置，实现Sensor器件参数序列化配置和器件部分操作接口，简化Sensor器件驱动开发。 123 124基于Sensor驱动模型开发Sensor器件驱动请参考[Sensor驱动开发指南](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/driver/driver-peripherals-sensor-des.md)。 125 126### Display框架模型说明<a name="section161502341317"></a> 127 128基于OpenHarmony驱动框架的Display驱动模型，对上屏蔽了芯片平台差异，方便操作系统跨平台迁移；向下抽象外设驱动公共业务逻辑，通过配置或差异化适配接口，实现一套驱动模型可兼容不同的外设器件，使得三方厂商可以高效、便捷的切入鸿蒙驱动生态。 129 130- Display驱动模型基础能力部分：包括HDI（**H**ardware **D**river **I**nterfaces）接口的定义及其实现框架，以及芯片平台对HDI接口的适配实现；内核驱动部分抽象了Panel驱动的公共业务，提供基础的Panel初始化、器件配置信息获取、上下电、背光设置等公共流程。 131- 驱动开发者实现的部分：需要完成板级的HCS配置及Panel私有数据配置，或者实现部分器件差异化接口，保证显示屏驱动开发高效便捷。 132 133基于Display驱动模型开发LCD器件驱动请参考[LCD驱动开发指南](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/driver/driver-peripherals-lcd-des.md)。 134 135### Input框架模型说明<a name="section12629164020115"></a> 136 137基于OpenHarmony驱动框架的Input驱动模型，不依赖于芯片平台，对上层输入服务提供统一的驱动接口；在具体的驱动模型实现中，针对不同类别的输入设备，抽象出几类公共的平台驱动，通过配置及差异化的适配接口，使得驱动模型可兼容不同的输入设备。 138 139- Input驱动模型基础能力部分：包括Input HDI层的接口定义及公共实现，对上层输入服务提供设备管理、业务控制、数据上报等驱动能力接口；而Input驱动模型提供不同类型Input设备的归一化驱动, 包括输入设备的注册和注销、event数据的上报通道、配置信息的解析、公共驱动的加载等能力。 140- 开发者实现的部分：根据驱动模型提供的平台驱动，需要完成设备描述配置及器件私有配置，以及实现预留的器件差异化接口，借由此驱动模型，可大幅缩减Input设备驱动的开发周期。 141 142基于Input驱动模型开发Touchscreen器件驱动请参考[Touchscreen驱动开发指南](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/driver/driver-peripherals-touch-des.md)。 143 144### WLAN框架模型说明<a name="section11408103183114"></a> 145 146基于OpenHarmony驱动框架的WLAN驱动模型，可实现跨操作系统迁移，自适应器件差异，模块化拼装编译等功能。各WLAN厂商驱动开发人员可根据WLAN模块提供的向下统一接口适配各自的驱动代码，HDI层开发人员可根据WLAN模块提供的向上统一接口获取如下能力：建立/关闭WLAN热点、扫描、关联WLAN热点等。 147 148- WLAN驱动模型基础能力部分：包括WLAN HDI层的接口定义及公共实现，对上层输入服务提供如设置MAC地址，获取设备的MAC地址，获取特性的类型，设置发射功率等能力；对驱动开发者提供创建/释放WifiModule，关联/取消关联，申请/释放NetBuf等能力。 149- 驱动开发者实现的部分：根据驱动模型提供的平台驱动，需要完成板级的HCS配置及WLAN芯片的私有配置，以及实现预留的初始化/注销网络设备、打开/关闭网络设备等相关接口。 150 151基于WLAN驱动模型开发WLAN器件驱动请参考[WLAN驱动开发指南](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/driver/driver-peripherals-external-des.md)。 152 153## 相关仓<a name="section1371113476307"></a> 154 155[驱动子系统](https://gitee.com/openharmony/docs/blob/master/zh-cn/readme/%E9%A9%B1%E5%8A%A8%E5%AD%90%E7%B3%BB%E7%BB%9F.md) 156 157drivers\_framework 158 159[drivers\_adapter](https://gitee.com/openharmony/drivers_adapter/blob/master/README_zh.md) 160 161[drivers\_adapter\_khdf\_linux](https://gitee.com/openharmony/drivers_adapter_khdf_linux/blob/master/README_zh.md) 162 163[drivers\_peripheral](https://gitee.com/openharmony/drivers_peripheral/blob/master/README_zh.md) 164 165
