#冲刺创作新星# [九] 写个简单的LED驱动 原创 精华

在《[二]第一个OpenHarmony程序》我们熟悉了如何在OpenHarmony开发终端应用，并他通过hdc工具拷贝至开发板运行。在《[六]第一个hap应用》的文章里我们学会如何用IDE工具编写hap应用并他通过IDE工具安装至开发板运行。我们学会了终端的应用，学会了交互界面的程序开发，接下来我们需要学习下如何开发一个驱动应用。

HDF框架简介

HDF（Hardware Driver Framework）是OpenHarmony的驱动子系统，包括驱动框架，配置管理，配置解析，驱动通用框架模型，硬件通用平台能力接口等。下图是一副标准系统的框架模型，但是在小型或者轻量级系统使用的时候时候没有VFS也没有这么复杂的分层。

• 标准系统
  

• 小型、轻量系统
  

详细的内容介绍在一下链接内可以看到官方的说明：

参考链接：https://gitee.com/openharmony/drivers_hdf_core

此样例参考小熊派设计，使用小熊派HM_Micro开发板进行验证

Driver开发流程

graph LR
编写driver --> 编写驱动配置 --> 编写私有配置 --> 添加驱动应用 --> 编译生成

1. 编写driver: led.c, BUILD.gn

   //实现Hdf结构体，HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量
   struct HdfDriverEntry g_ledDriverEntry = {
       .moduleVersion = 1,
       .moduleName = "HDF_LED",
       .Bind = HdfLedDriverBind,
       .Init = HdfLedDriverInit,
       .Release = HdfLedDriverRelease,
   };
   
   // 调用HDF_INIT将驱动入口注册到HDF框架中
   HDF_INIT(g_ledDriverEntry);
   

   • 实现对应的方法：初始化

   //Led设备结构体
   struct TestLed {
       uint32_t gpioNum;
   };
   static struct TestLed g_testLed;
   
   // 读取驱动私有配置
   static int32_t LedReadDrs(struct TestLed *led, const struct DeviceResourceNode *node)
   {
       int32_t ret;
       struct DeviceResourceIface *drsOps = NULL;
   
       drsOps = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE);
       if (drsOps == NULL || drsOps->GetUint32 == NULL) {
           HDF_LOGE("%s: invalid drs ops!", __func__);
           return HDF_FAILURE;
       }
       /* 读取led.hcs里面led_gpio_num的值 */
       ret = drsOps->GetUint32(node, "led_gpio_num", &led->gpioNum, 0); 
       if (ret != HDF_SUCCESS) {
           HDF_LOGE("%s: read led gpio num fail!", __func__);
           return ret;
       }
       return HDF_SUCCESS;
   }
   
   // HDF框架：驱动初始化
   int32_t HdfLedDriverInit(struct HdfDeviceObject *device)
   {
       struct TestLed *led = &g_testLed;
       int32_t ret;
   
       if (device == NULL || device->property == NULL) {
           HDF_LOGE("%s: device or property NULL!", __func__);
           return HDF_ERR_INVALID_OBJECT;
       }
       /* 读取hcs私有属性值 */
       ret = LedReadDrs(led, device->property);
       if (ret != HDF_SUCCESS) {
           HDF_LOGE("%s: get led device resource fail:%d", __func__, ret);
           return ret;
       }
       /* 将GPIO管脚配置为输出 */
       ret = GpioSetDir(led->gpioNum, GPIO_DIR_OUT);
       if (ret != 0)
       {
           HDF_LOGE("GpioSerDir: failed, ret %d\n", ret);
           return ret;
       }
       HDF_LOGD("Led driver Init success");
       return HDF_SUCCESS;
   }
   

   • 实现对应的方法：初始化

   //HDF框架：驱动绑定
   int32_t HdfLedDriverBind(struct HdfDeviceObject *deviceObject)
   {
       if (deviceObject == NULL)
       {
           HDF_LOGE("Led driver bind failed!");
           return HDF_ERR_INVALID_OBJECT;
       }
       static struct IDeviceIoService ledDriver = {
           .Dispatch = LedDriverDispatch,
       };
       deviceObject->service = (struct IDeviceIoService *)(&ledDriver);
       HDF_LOGD("Led driver bind success");
       return HDF_SUCCESS;
   }
   

   • 实现对应的方法：驱动资源释放

   // HDF框架：驱动资源释放
   void HdfLedDriverRelease(struct HdfDeviceObject *deviceObject)
   {
       if (deviceObject == NULL)
       {
           HDF_LOGE("Led driver release failed!");
           return;
       }
       HDF_LOGD("Led driver release success");
       return;
   }
   

   • 驱动编译gn脚本

   import("//drivers/adapter/khdf/liteos/hdf.gni")
   
   hdf_driver("hdf_led") {
       sources = [
       	"led.c",
       ]
   }
   

2. 驱动配置

   • 在OpenHarmony源码目录下vendor目录里是不同厂家的开发板，之下有hdf_config目录，里面有对应的device_info.hcs设备硬件配置文件，在此文件里增加以下内容

   device_led :: device {                  // led设备节点
       device0 :: deviceNode {             // led驱动的DeviceNode节点
           policy = 2;                     // policy字段是驱动服务发布的策略，在驱动服务管理章节有详细介绍
           priority = 10;                 // 驱动启动优先级（0-200），值越大优先级越低，建议默认配100，优先级相同则不保证device的加载顺序
           preload = 1;                    // 驱动按需加载字段
           permission = 0777;              // 驱动创建设备节点权限
           moduleName = "HDF_LED";        // 驱动名称，该字段的值必须和驱动入口结构的moduleName值一致
           serviceName = "hdf_led";    // 驱动对外发布服务的名称，必须唯一
           deviceMatchAttr = "st_stm32mp157_led"; // 驱动私有数据匹配的关键字，必须和驱动私有数据配置表中的match_attr值相等
       }
   }
   

   • 同时在同级目录里也需要增加led_config.hcs文件

   root {
       LedDriverConfig {
           led_gpio_num = 13;
           match_attr = "st_stm32mp157_led";   //该字段的值必须和device_info.hcs中的deviceMatchAttr值一致
       }
   }
   

   • 同时在同级目录里也需要修改hdf.hcs文件，增加以下代码：

   #include "led/led_config.hcs"
   

3. 编译生成

   ./build.sh --product-name PRODUCT_NAME
   //看到success则为编译成功，可以通过find out/[PRODUCT_NAME] -name "my_led"看到对应的应用
   

总结

1. device_info.hcs文件中的moduleName必须要和驱动文件中的moduleName字段匹配，这样驱动才会加载起来
2. device_info.hcs文件中的deviceMatchAttr的字段必须和私有配置文件中led_config.hcs的match_attr的字段匹配，这样私有配置才能生效

这样我们就有了自己的driver和配置，后面的章节我们会讲如何在hap应用里调用驱动接口

参考链接：https://gitee.com/bearpi/bearpi-hm_micro_small/blob/master/applications/BearPi/BearPi-HM_Micro/docs/device-dev/如何在开发板上安装HAP应用.md

https://gitee.com/bearpi/bearpi-hm_micro_small/blob/master/applications/BearPi/BearPi-HM_Micro/docs/device-dev/通过JS应用控制LED灯.md

https://gitee.com/bearpi/bearpi-hm_micro_app/blob/master/README.md#/bearpi/bearpi-hm_micro_app/blob/master/docs/示例应用源码获取.md

https://gitee.com/bearpi/bearpi-hm_micro_app/tree/master/code