OpenHarmony 驱动框架解读和开发实践｜HDC2021 技术分论坛

2021 年 11 月 23 日
本文字数：8492 字
阅读完需：约 28 分钟

转自：OpenAtom OpenHarmony

作者：yuanbo，华为高级工程师

在 IoT 时代下，终端设备差异较大、形态各异、尺寸各异、交互方式各异，解决设备适配问题无疑是实现万物互联的一个关键。但是，在驱动框架的开发和部署过程中，由于终端设备对硬件的计算和存储能力的需求不同、设备厂商提供的设备软硬件操作接口不同、内核提供的操作接口不同，这就使得 OEM 厂商部署系统的时候需要投入大量的精力来适配和维护驱动代码。

能否提供了一个跨芯片平台、跨内核的驱动框架，使得设备驱动软件可以在不同的设备上运行？OpenHarmony 作为一个自主研发、全新技术生态的全领域下一代开源操作系统，提供了一套驱动框架来满足此诉求。

下面我们将带着大家解读 OpenHarmony 驱动框架。

一、OpenHarmony 驱动框架解读

1.设计目标

为解决在开发和部署过程中遇到的困难，OpenHarmony 驱动框架设计目标如下：

支持百 K 级~G 级容量的设备部署，如手机、手环等。
提供统一硬件 IO 抽象，屏蔽 SoC 芯片差异，兼容不同内核，如 Linux、LiteOS 等。
屏蔽驱动和系统组件间交互。可动态拆解，满足不同容量设备的部署。
面向不同容量的设备，提供统一的配置界面。

2. 设计思路

OpenHarmony 驱动框架（下面简称为 HDF）通过提供驱动与芯片平台、内核解耦的底座，规范硬件驱动接口，实现驱动软件在不同设备中部署。

HDF 驱动框架架构如下图所示。

图 1 驱动架构

为了达成设计目标，OpenHarmony 驱动框架采用如下核心设计思路：

（1）弹性化架构

● 框架可动态伸缩：通过对象管理器，多态加载不同容量设备实现方式，实现弹性伸缩部署。

● 驱动可动态伸缩：支持统一的设备驱动插件管理，实现设备驱动任意分层，积木式组合拼接

（2）组件化设备模型

● 提供设备功能模型抽象，屏蔽设备驱动与系统交互的实现，为开发者提供统一的驱动开发接口

● 提供主流 IC 的公版驱动能力，支持配置化部署

（3）归一化平台底座

提供规范化的内核、SoC 硬件 IO 适配接口，兼容不同内核、SoC 芯片，对外开发规范化的平台驱动接口

（4）统一配置界面

构建全新的配置语言，面向不同容量的设备，提供统一配置界面，支持硬件资源配置和设备信息配置

3.构建策略

面向 Liteos 的轻量级设备，主要基于 HDF 构建主流 IC 驱动，形成公版驱动和通用设备功能模型，支撑不同硬件芯片、不同内核(LiteOS-M/LiteOS-A)部署。

图 2 轻量级设备部署模式

面向标准设备，除了支持内核态驱动，还支持用户态驱动。用户态驱动的重点在于构建设备抽象模型，为系统提供统一的设备接口，兼容 Linux 原生驱动和 HDF 驱动。内核态则使用 Linux 驱动与 HDF 驱动并存的策略，提供端到端的解决方案。

图 3 标准设备部署模式

4.现状与演进

目前 HDF 驱动框架已经支持 Liteos-m、Liteos-a、Linux 内核，以及 OpenHarmony 轻量级、标准级上部署，并且在标准系统上同时支持内核态与用户态部署。

图 4 OpenHarmony 驱动框架演进图

经过开发者的不断努力，OpenHarmony 驱动框架正在不断完善和增强，在 OpenHarmony LTS3.0 中，基础框架新增了对热插拔设备的管理以及 HDI 编译工具 hdi-gen，驱动模型部分新增了 Audio、Camera、Senso、USB DDK 等多个模块的支持。

二、OpenHarmony 驱动开发

OpenHarmony 驱动为了避免与具体内核产生依赖，实现可迁移目标，开发时需要遵循以下约定：

系统相关接口使用 HDF OSAL 接口；
总线和硬件资源相关接口使用平台驱动提供的相关接口。

基于 HDF 框架，驱动开发的通常流程包含驱动代码的实现、编译脚本、配置文件添加、以及用户态程序和驱动交互的流程。下面将详细介绍 HDF 驱动开发一般步骤。

1.实现驱动代码

在 HDF 驱动框架中，HdfDriverEntry 对象被用来描述一个驱动实现。

struct HdfDriverEntry {    int32_t moduleVersion;    <span class="hljs-keyword">const</span> char *moduleName;    int32_t (*Bind)(struct HdfDeviceObject *deviceObject);    int32_t (*Init)(struct HdfDeviceObject *deviceObject);    <span class="hljs-keyword">void</span> (*Release)(struct HdfDeviceObject *deviceObject);};

复制代码

编写一个简单的驱动，首先需要实现驱动程序(Driver Entry）入口中的三个主要接口：

Bind 接口：实现驱动接口实例化绑定，如果需要发布驱动接口，会在驱动加载过程中被调用，实例化该接口的驱动服务并和 DeviceObject 绑定。当用户态发起调用时，Bind 中绑定的服务对象的 Dispatch 方法将被回调，在该方法中处理用户态调用的消息。
Init 接口：实现驱动或者硬件的初始化，返回错误将中止驱动加载流程。
Release 接口：实现驱动的卸载，在该接口中释放驱动实例的软硬件资源。

一个基于 HDF 框架编写的简单驱动代码如下，其功能是用户态消息回环，即驱动收到用户态发送的消息后将相同内容的消息再发送给用户态：

#include <span class="hljs-string">"hdf_base.h"</span>#include <span class="hljs-string">"hdf_device_desc.h"</span>#include <span class="hljs-string">"hdf_log.h"</span>#define HDF_LOG_TAG <span class="hljs-string">"sample_driver"</span>#define SAMPLE_WRITE_READ <span class="hljs-number">0xFF00</span>static int EchoString(struct HdfDeviceObject *deviceObject, struct HdfSBuf *data, struct HdfSBuf *reply){    <span class="hljs-keyword">const</span> char *readData = HdfSbufReadString(data);    <span class="hljs-keyword">if</span> (readData == NULL) {        HDF_LOGE(<span class="hljs-string">"%s: failed to read data"</span>, __func__);        <span class="hljs-keyword">return</span> HDF_ERR_INVALID_PARAM;    }    <span class="hljs-keyword">if</span> (!HdfSbufWriteInt32(reply, INT32_MAX)) {        HDF_LOGE(<span class="hljs-string">"%s: failed to reply int32"</span>, __func__);        <span class="hljs-keyword">return</span> HDF_FAILURE;    }    <span class="hljs-keyword">return</span> HdfDeviceSendEvent(deviceObject, id, data); <span class="hljs-comment">// 发送事件到用户态</span>}int32_t HdfSampleDriverDispatch(struct HdfDeviceObject *deviceObject, int id, struct HdfSBuf *data, struct HdfSBuf *reply){    <span class="hljs-keyword">const</span> char *readData = NULL;    int ret = HDF_SUCCESS;    <span class="hljs-keyword">switch</span> (id) {        <span class="hljs-keyword">switch</span> SAMPLE_WRITE_READ:            ret = EchoString(deviceObject, data, reply);            <span class="hljs-keyword">break</span>;        <span class="hljs-keyword">default</span>:            HDF_LOGE(<span class="hljs-string">"%s: unsupported command"</span>);            ret = HDF_ERR_INVALID_PARAM;    }    <span class="hljs-keyword">return</span> ret;}<span class="hljs-keyword">void</span> HdfSampleDriverRelease(struct HdfDeviceObject *deviceObject){    <span class="hljs-comment">// 在这里释放驱动申请的软硬件资源</span>    <span class="hljs-keyword">return</span>;}int HdfSampleDriverBind(struct HdfDeviceObject *deviceObject){    <span class="hljs-keyword">if</span> (deviceObject == NULL) {        <span class="hljs-keyword">return</span> HDF_FAILURE    }    static struct IDeviceIoService testService = {        .Dispatch = HdfSampleDriverDispatch,    };    deviceObject->service = &testService;    <span class="hljs-keyword">return</span> HDF_SUCCESS;}int HdfSampleDriverInit(struct HdfDeviceObject *deviceObject){    <span class="hljs-keyword">if</span> (deviceObject == NULL) {        HDF_LOGE(<span class="hljs-string">"%s::ptr is null!"</span>, __func__);        <span class="hljs-keyword">return</span> HDF_FAILURE;    }    HDF_LOGE(<span class="hljs-string">"Sample driver Init success"</span>);    <span class="hljs-keyword">return</span> HDF_SUCCESS;}struct HdfDriverEntry g_sampleDriverEntry = {    .moduleVersion = <span class="hljs-number">1</span>,    .moduleName = <span class="hljs-string">"sample_driver"</span>,    .Bind = HdfSampleDriverBind,    .Init = HdfSampleDriverInit,    .Release = HdfSampleDriverRelease,};HDF_INIT(g_sampleDriverEntry);

复制代码

2. 配置设备信息

在 HDF 框架的配置文件（例如 vendor/hisilicon/xxx/config/device_info.hcs）中添加该驱动的配置信息，配置目录与具体开发板关联，如下所示：

root {    device_info {        match_attr = <span class="hljs-string">"hdf_manager"</span>;        template host {            hostName = <span class="hljs-string">""</span>;            priority = <span class="hljs-number">100</span>;            template device {                template deviceNode {                    policy = <span class="hljs-number">0</span>;                    priority = <span class="hljs-number">100</span>;                    preload = <span class="hljs-number">0</span>;                    permission = <span class="hljs-number">0664</span>;                    moduleName = <span class="hljs-string">""</span>;                    serviceName = <span class="hljs-string">""</span>;                    deviceMatchAttr = <span class="hljs-string">""</span>;                }            }        }       sample_host :: host{            hostName = <span class="hljs-string">"host0"</span>;    <span class="hljs-comment">// host名称，host节点是用来存放某一类驱动的容器</span>            priority = <span class="hljs-number">100</span>;        <span class="hljs-comment">// host启动优先级（0-200），值越大优先级越低，建议默认配100，优先级相同则不保证host的加载顺序</span>            device_sample :: device {        <span class="hljs-comment">// sample设备节点</span>                device0 :: deviceNode {      <span class="hljs-comment">// sample驱动的DeviceNode节点</span>                    policy = <span class="hljs-number">1</span>;              <span class="hljs-comment">// policy字段是驱动服务发布的策略，在驱动服务管理章节有详细介绍</span>                    priority = <span class="hljs-number">100</span>;          <span class="hljs-comment">// 驱动启动优先级（0-200），值越大优先级越低，建议默认配100，优先级相同则不保证device的加载顺序</span>                    preload = <span class="hljs-number">0</span>;             <span class="hljs-comment">// 驱动加载策略，参考《5.2 HDF驱动框架章节》</span>                    permission = <span class="hljs-number">0664</span>;       <span class="hljs-comment">// 驱动创建设备节点权限</span>                    moduleName = <span class="hljs-string">"sample_driver"</span>;   <span class="hljs-comment">// 驱动名称，该字段的值必须和驱动入口结构体的moduleName值一致</span>                    serviceName = <span class="hljs-string">"sample_service"</span>;    <span class="hljs-comment">// 驱动对外发布服务的名称，必须唯一</span>                    deviceMatchAttr = <span class="hljs-string">"sample_config"</span>; <span class="hljs-comment">// 驱动私有数据匹配的关键字，必须和驱动私有数据配置表中的match_attr值相等</span>                }            }        }    }}

复制代码

定义设备列表时使用了 HCS 的模板语法，template host 节点下的内容由 HDF 框架定义，新增 host 以及 host 中的 device 只需要继承该模板并填充具体内容即可。

在配置中定义的 device 将在加载过程中产生一个设备实例，配置中通过 moduleName 字段指定设备对应的驱动名称，从而将设备与驱动关联起来。其中，设备与驱动可以是一对多的关系，即可以实现一个驱动支持多个同类型设备。

3.用户态程序与驱动交互

用户态程序和驱动交互基于 HDF IoService 模型实现，该设计屏蔽了具体内核的差异，将驱动接口抽象为 IoService 对象，调用者基于名称获取该对象，并可以使用 IoService 系列接口进行接口调用和事件监听。值得一提的是消息传递时使用了 HDF Sbuf 对象进行参数的序列化和反序列化，这样可以避免不受控的内存访问，也简化了消息传递和分发过程中的内存所有权问题，有利于提升用户态和内核态数据传递的安全性和便利性。HDF Sbuf 相关接口可以参考 HarmonyOS 设备开发官网 API Reference 中头文件 hdf_sbuf.h 部分。

基于 HDF 框架编写的用户态程序和驱动交互的代码如下：

#include <span class="hljs-string">"hdf_log.h"</span>#include <span class="hljs-string">"hdf_sbuf.h"</span>#include <span class="hljs-string">"hdf_io_service_if.h"</span>#define HDF_LOG_TAG <span class="hljs-string">"sample_test"</span>#define SAMPLE_SERVICE_NAME <span class="hljs-string">"sample_service"</span>#define SAMPLE_WRITE_READ <span class="hljs-number">0xFF00</span>int g_replyFlag = <span class="hljs-number">0</span>;static int OnDevEventReceived(<span class="hljs-keyword">void</span> *priv, uint32_t id, struct HdfSBuf *data){    <span class="hljs-keyword">const</span> char *string = HdfSbufReadString(data);    int ret = HDF_SUCCESS;    <span class="hljs-keyword">if</span> (string == NULL) {        HDF_LOGE(<span class="hljs-string">"failed to read string in event data"</span>);        ret = HDF_FAILURE;    } <span class="hljs-keyword">else</span> {        HDF_LOGE(<span class="hljs-string">"%s"</span>, string);    }    g_replyFlag = <span class="hljs-number">1</span>;    <span class="hljs-keyword">return</span> ret;}static int SendEvent(struct HdfIoService *serv, char *eventData){    int ret = <span class="hljs-number">0</span>;    struct HdfSBuf *data = HdfSBufObtainDefaultSize(); <span class="hljs-comment">// 申请需要发送的序列化对象</span>    <span class="hljs-keyword">if</span> (data == NULL) {        HDF_LOGE(<span class="hljs-string">"failed to obtain sbuf data"</span>);        <span class="hljs-keyword">return</span> <span class="hljs-number">1</span>;    }    struct HdfSBuf *reply = HdfSBufObtainDefaultSize(); <span class="hljs-comment">// 申请返回数据的序列化对象</span>    <span class="hljs-keyword">if</span> (reply == NULL) {        HDF_LOGE(<span class="hljs-string">"failed to obtain sbuf reply"</span>);        ret = HDF_DEV_ERR_NO_MEMORY;        goto out;    }    <span class="hljs-keyword">if</span> (!HdfSbufWriteString(data, eventData)) { <span class="hljs-comment">// 准备消息内容</span>        HDF_LOGE(<span class="hljs-string">"failed to write sbuf"</span>);        ret = HDF_FAILURE;        goto out;    }    ret = serv->dispatcher->Dispatch(&serv->object, SAMPLE_WRITE_READ, data, reply); <span class="hljs-comment">// 发起接口调用</span>    <span class="hljs-keyword">if</span> (ret != HDF_SUCCESS) {        HDF_LOGE(<span class="hljs-string">"failed to send service call"</span>);        goto out;    }    int replyData = <span class="hljs-number">0</span>;    <span class="hljs-keyword">if</span> (!HdfSbufReadInt32(reply, &replyData)) { <span class="hljs-comment">// 反序列化返回数据</span>        HDF_LOGE(<span class="hljs-string">"failed to get service call reply"</span>);        ret = HDF_ERR_INVALID_OBJECT;        goto out;    }    HDF_LOGE(<span class="hljs-string">"Get reply is: %d"</span>, replyData);out:    HdfSBufRecycle(data);    HdfSBufRecycle(reply);    <span class="hljs-keyword">return</span> ret;}int main(){    struct HdfIoService *serv = HdfIoServiceBind(SAMPLE_SERVICE_NAME); <span class="hljs-comment">// 通过名称获取IoService对象，与驱动配置中的名称一致</span>    <span class="hljs-keyword">if</span> (serv == NULL) {        HDF_LOGE(<span class="hljs-string">"failed to get service %s"</span>, SAMPLE_SERVICE_NAME);        <span class="hljs-keyword">return</span> HDF_FAILURE;    }    static struct HdfDevEventlistener listener = { <span class="hljs-comment">// 构造驱动事件监听器对象</span>        .callBack = OnDevEventReceived, <span class="hljs-comment">// 填充事件处理方法</span>        .priv = NULL;    };    <span class="hljs-keyword">if</span> (HdfDeviceRegisterEventListener(serv, &listener) != HDF_SUCCESS) {  <span class="hljs-comment">// 注册事件监听</span>        HDF_LOGE(<span class="hljs-string">"failed to register event listener"</span>);        <span class="hljs-keyword">return</span> HDF_FAILURE;    }    <span class="hljs-keyword">if</span> (SendEvent(serv, <span class="hljs-string">"Hello World, HDF Driver!"</span>)) { <span class="hljs-comment">// 调用驱动接口，样例驱动收到事件</span>        HDF_LOGE(<span class="hljs-string">"failed to send event"</span>);        <span class="hljs-keyword">return</span> HDF_FAILURE;    }    <span class="hljs-keyword">while</span> (g_replyFlag == <span class="hljs-number">0</span>) { <span class="hljs-comment">// 等待驱动上报事件</span>        sleep(<span class="hljs-number">1</span>);    }    HdfDeviceUnregisterEventListener(serv, &listener)); <span class="hljs-comment">// 去注册事件监听器</span>    HdfIoServiceRecycle(serv); <span class="hljs-comment">// 回收IoService对象</span>    <span class="hljs-keyword">return</span> <span class="hljs-number">0</span>;}

复制代码

该示例执行后会在终端中打印出"Hello World, HDF Driver!"字符串，表明我们的用户态测试程序和驱动成功地进行了一次交互。

三、使用 DevEco Device Tool 进行驱动开发

上一小节介绍了 OpenHarmony 驱动的一般开发方法，那么有没有更简单的方法添加一款驱动呢？答案就是华为南向开发 IDE——DevEco Device Tool。DevEco Device Tool 最新版本已经集成了 HDF 驱动开发功能，下面介绍如何使用 DevEco Device Tool 进行驱动开发。

DevEco Device Tool 下载链接：https://device.harmonyos.com/cn/develop/ide#download_release。

1. 创建驱动

（1）导入工程

参考 DevEco Device Tool 手册，通过 npm 或网络下载的方式导入 OHOS 工程。