关于javascript:HDC2021技术分论坛OpenHarmony驱动框架解读和开发实践

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

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

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

上面咱们将带着大家解读 OpenHarmony 驱动框架。

一、OpenHarmony 驱动框架解读

设计指标

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

反对百 K 级~G 级容量的设施部署，如手机、手环等
提供对立硬件 IO 形象，屏蔽 SoC 芯片差别，兼容不同内核，如 Linux、LiteOS 等。
屏蔽驱动和零碎组件间交互。可动静拆解，满足不同容量设施的部署。
面向不同容量的设施，提供对立的配置界面。

设计思路

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

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

图 1 驱动架构

为了达成设计指标，OpenHarmony 驱动框架采纳如下外围设计思路：

（1）弹性化架构

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

● 驱动可动静伸缩：反对对立的设施驱动插件治理，实现设施驱动任意分层，积木式组合拼接

（2）组件化设施模型

● 提供设施性能模型形象，屏蔽设施驱动与零碎交互的实现，为开发者提供对立的驱动开发接口

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

（3）归一化平台底座

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

（4）对立配置界面

构建全新的配置语言，面向不同容量的设施，提供对立配置界面，反对硬件资源配置和设施信息配置

构建策略

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

图 2 轻量级设施部署模式

面向规范设施，除了反对内核态驱动，还反对用户态驱动。用户态驱动的重点在于构建设施形象模型，为零碎提供对立的设施接口，兼容 Linux 原生驱动和 HDF 驱动。内核态则应用 Linux 驱动与 HDF 驱动并存的策略，提供端到端的解决方案。

图 3 规范设施部署模式

现状与演进

目前 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 驱动开发个别步骤。

实现驱动代码

在 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 框架编写的简略驱动代码如下，其性能是用户态音讯回环，即驱动收到用户态发送的音讯后将雷同内容的音讯再发送给用户态：

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;

}
void 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);
复制

配置设施信息

在 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 字段指定设施对应的驱动名称，从而将设施与驱动关联起来。其中，设施与驱动能够是一对多的关系，即能够实现一个驱动反对多个同类型设施。

用户态程序与驱动交互

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

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

int g_replyFlag = 0;
static int OnDevEventReceived(void 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/…。

创立驱动

（1）导入工程

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

图 5 DevEco Device Tool 启动界面

（2）应用 HDF 页面工具创立新驱动，依照需要填写 Module 名称，工具将依据 Module 名称创立对应驱动代码与。

图 6 Device Eco Tool HDF 插件界面

DevEco Device Tool 将主动生成驱动实现代码：

图 7 Device Eco Tool 生成驱动代码

为源码文件主动生成编译脚本：

图 8 Device Eco Tool 生成驱动编译脚本

DevEco Device Tool 还会在对应单板的驱动配置中生成驱动设施配置信息：

图 9 Device Eco Tool 生成驱动配置信息

批改驱动

图 10 Device Eco Tool 驱动疾速编辑界面

DevEco Device Tool 提供了快捷方式中转源码、编译脚本、配置文件，点击链接批改相干文件，实现驱动性能。DevEco Device Tool 主动生成代码曾经提供了 DriverEntry 的根底实现，只需填充对应函数的理论性能即可。

编译版本

应用 DevEco Device Tool build 性能一键编译版本，编译输入显示在终端窗口：

图 11 Device Eco Tool 编译界面

烧录验证

DevEco Device Tool 提供了一站式的烧录、调试环境。应用 upload 性能将编译好的镜像烧录进开发板。

图 12 Device Eco Tool 烧写性能界面

烧录过程和进度显示在终端窗口

图 13 Device Eco Tool 烧写输入

四、总结
除了在此次 HDC 大会与大家分享驱动框架的设计和最新进展，凋谢原子基金会还在 OpenHarmony 公众号、gitee 社区等渠道公布了一系列技术分享、领导文档等材料，欢送大家关注并一起建设 OpenHarmony 驱动生态。

关于javascript:HDC2021技术分论坛OpenHarmony驱动框架解读和开发实践

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>

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>

Just My Socks（注册教程内含优惠码）

关于javascript:HDC2021技术分论坛OpenHarmony驱动框架解读和开发实践

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>

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>

Just My Socks（注册教程 内含优惠码）

Just My Socks（注册教程内含优惠码）