OpenHarmony-HDF驱动框架介绍及加载过程分析

前言

HarmonyOS面向万物互联时代，而万物互联涉及到了大量的硬件设备，这些硬件的离散度很高，它们的性能差异与配置差异都很大，所以这要求使用一个更灵活、功能更强大、能耗更低的驱动框架。OpenHarmony系统HDF驱动框架采用C语言面向对象编程模型构建，通过平台解耦、内核解耦，来达到兼容不同内核，统一平台底座的目的，从而帮助开发者实现驱动一次开发，多系统部署的效果。

1、HDF 驱动框架

OpenHarmony 系统 HDF 驱动框架主要由驱动基础框架、驱动程序、驱动配置文件和驱动接口这四个部分组成。

（1）HDF 驱动基础框架提供统一的硬件资源管理，驱动加载管理以及设备节点管理等功能。驱动框架采用的是主从模式设计，由 Device Manager 和 Device Host 组成。Device Manager 提供了统一的驱动管理，Device Manager 启动时根据 Device Information 提供驱动设备信息加载相应的驱动 Device Host，并控制 Host 完成驱动的加载。Device Host 提供驱动运行的环境，同时预置 Host Framework 与 Device Manager 进行协同，完成驱动加载和调用。根据业务的需求 Device Host 可以有多个实例。

（2）驱动程序实现驱动具体的功能，每个驱动由一个或者多个驱动程序组成，每个驱动程序都对应着一个 Driver Entry。Driver Entry 主要完成驱动的初始化和驱动接口绑定功能。

（3）驱动配置文件.hcs 主要由设备信息(Device Information)和设备资源(Device Resource)组成。Device Information 完成设备信息的配置。如配置接口发布策略，驱动加载的方式等。Device Resource 完成设备资源的配置。如 GPIO 管脚、寄存器等资源信息的配置。

（4）驱动接口 HDI(Hardware Driver interface )提供标准化的接口定义和实现，驱动框架提供 IO Service和IO Dispatcher 机制，使得不同部署形态下驱动接口趋于形式一致。

HDF框架以组件化的驱动模型作为核心设计思路，为开发者提供更精细化的驱动管理，让驱动开发和部署更加规范。HDF框架将一类设备驱动放在同一个host里面，开发者也可以将驱动功能分层独立开发和部署，支持一个驱动多个node，HDF驱动模型如下图所示：

2、HDF 驱动开发

基于HDF框架进行驱动的开发主要分为两个部分，驱动实现和驱动配置，详细开发流程如下所示：

2.1 驱动实现

驱动实现包含驱动业务代码和驱动入口注册。

2.1.1 驱动业务代码

//驱动对外提供的服务能力，将相关的服务接口绑定到HDF框架。

int32_t HdfSampleDriverBind(struct HdfDeviceObject *deviceObject)  
{  
  HDF_LOGD("Sample driver bind success");  
  return 0;  
}

// 驱动自身业务初始的接口。

int32_t HdfSampleDriverInit(struct HdfDeviceObject *deviceObject)  
{     
  HDF_LOGD("Sample driver Init success");  
  return 0;  
}

// 驱动资源释放的接口。

void HdfSampleDriverRelease(struct HdfDeviceObject *deviceObject)   
{  
  HDF_LOGD("Sample driver release success");  
  return;  
}

2.1.2驱动入口注册到HDF框架

// 定义驱动入口的对象，必须为HdfDriverEntry(在hdf_device_desc.h中定义)类型的全局变量

struct HdfDriverEntry g_sampleDriverEntry =
 {  
  .moduleVersion = 1, 
  .moduleName = "sample_driver",  
  .Bind = HdfSampleDriverBind,  
  .Init = HdfSampleDriverInit, 
  .Release = HdfSampleDriverRelease,
};

HDF_INIT(g_sampleDriverEntry);

// 调用HDF_INIT将驱动入口注册到HDF框架中，在加载驱动时HDF框架会先调用Bind函数,再调用Init函数加载该驱动，当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。

2.2 驱动配置

驱动配置包含两部分，HDF框架定义的驱动设备描述和驱动的私有配置信息。HDF使用HCS作为配置描述源码，内容以 Key-Value 键值对为主要形式。它实现了配置代码与驱动代码解耦，便于开发者进行配置管理。HC-GEN (全称 HDF Configuration Generator) 是 HCS 配置转换工具，可以将 HDF 配置文件转换为软件可读取的文件格式：在弱性能环境中，转换为配置树源码，驱动可直接调用 C代码获取配置;在高性能环境中，转换为 HCB(HDF Configuration Binary)二进制文件，驱动可使用 HDF框架提供的配置解析接口获取配置。

HCS经过HC-GEN编译生成HCB文件，HDF驱动框架中的HCS Parser模块会从HCB文件中重建配置树，HDF驱动模块使用HCS Parser提供的配置读取接口获取配置内容。驱动配置过程的原理图如下所示：

2.2.1 驱动设备描述(必选)

HDF框架加载驱动所需要的信息来源于HDF框架定义的驱动设备描述，因此基于HDF框架开发的驱动必须要在HDF框架定义的device_info.hcs配置文件中添加对应的设备描述，驱动的设备描述填写如下所示：

sample_host :: host{
  hostName = "host0"; //host名称，host节点是用来存放某一类驱动的容器。
  priority = 100; //host启动优先级（0-200），值越大优先级越低，建议默认配100，优先级相同则不保证host的加载顺序。
  device_sample :: device { //sample设备节点。
    device0 :: deviceNode { //sample驱动的DeviceNode节点。
    policy = 1; //驱动服务发布的策略
    priority = 100; //驱动启动优先级（0-200），值越大优先级越低，建议默认配 100，优先级相同则不保证 device 的加载顺序
    preload = 0; //驱动按需加载字段
    permission = 0664;//驱动创建设备节点权限
    moduleName = "sample_driver"; //驱动名称，该字段的值必须和驱动入口结构的moduleName值一致
    serviceName = "sample_service"; //驱动对外发布服务的名称，必须唯一
    deviceMatchAttr = "sample_config";//驱动私有数据匹配的关键字，必须和驱动私有数据配置表中的match_attr值相等。
    }
  }
}

2.2.2驱动私有配置信息(可选)

如果驱动有私有配置，则可以添加一个驱动的配置文件，用来填写一些驱动的默认配置信息，HDF框架在加载驱动的时候，会将对应的配置信息获取并保存在HdfDeviceObject 中的property里面，通过Bind和Init传递给驱动，驱动的配置信息示例如下：

root {  
  SampleDriverConfig {
    sample_version = 1; 
    sample_bus = "I2C_0"; 
    match_attr = "sample_config";   //该字段的值必须和device_info.hcs中的deviceMatchAttr值一致
  }
}

3、HDF 驱动加载

HDF驱动加载包括按需加载和按序加载。按需加载是HDF框架支持驱动在系统启动过程中默认加载，或者在系统启动之后动态加载;按序加载是HDF框架支持驱动在系统启动的过程中按照驱动的优先级进行加载。HDF框架定义的驱动按需加载方式的策略是由配置文件中的 preload 字段来控制，preload 字段的取值范围以及含义如下：

驱动的按序加载是通过配置文件中的 priority(取值范围为整数 0 到 200)来决定的，priority 值越小，表示的优先级越高。驱动的加载顺序，优先根据 host 的 priority 决定，如果host 的 priority 相同，再根据 host 内的驱动 priority 值来决定加载顺序。

3.1 HDF_INIT宏展开

驱动入口注册到HDF框架，会调用HDF_INIT函数将驱动入口地址注册到HDF框架。

#define HDF_SECTION__attribute__((section(“.hdf.driver”)))
#define HDF_DRIVER_INIT(module) \
const size_t USED_ATTR module##HdfEntry HDF_SECTION = (size_t)(&(module))

可以看到 HDF_INIT 宏是定义了一个“驱动模块名+HdfEntry”的符号放到".hdf.driver"所在 section，该符号指向的内存地址即为驱动程序入口结构体的地址。这个特殊的 section 将用于开机启动时查找设备驱动。

3.2获取驱动列表

HDF驱动框架通过将驱动程序入口符号的地址集中存放到一个特殊的 section 来实现对驱动的索引，这个section的开头和末尾插入了_hdf_drivers_start、_hdf_drivers_end两个特殊符号，用于标记这个 section 的范围，两个特殊符号之间的数据即为驱动实现指针。

3.3获取设备列表

配置文本编译后会变成二进制格式的配置文件，其中设备相关信息被存放在一个用“hdf_manager”标记的 device_info 配置块中，host的内容以块的形式在device_info 块中依次排列，host块中记录了host名称、启动优先级和设备列表信息。设备信息中的 moduleName字段将用于和驱动程序入口中的moduleName进行匹配，从而为设备匹配到正确的驱动程序，完成设备与驱动的匹配，具体流程图如下：