开发步骤

I2C模块适配包含以下四个步骤:

  1. 实例化驱动入口

    • 实例化HdfDriverEntry结构体成员。

    • 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。

  2. 配置属性文件

    • 在device_info.hcs文件中添加deviceNode描述。

    • 【可选】添加i2c_config.hcs器件属性文件。

  3. 实例化I2C控制器对象

    • 初始化I2cCntlr成员。

    • 实例化I2cCntlr成员I2cMethod和I2cLockMethod。

说明:
实例化I2cCntlr成员I2cMethod和I2cLockMethod,详见 接口说明 。

  1. 驱动调试

【可选】针对新增驱动程序,建议验证驱动基本功能,例如挂载后的信息反馈,消息传输的成功与否等。

开发实例

下方将以Hi3516DV300的驱动//device/soc/hisilicon/common/platform/i2c/i2c_hi35xx.c为示例,展示需要驱动适配者提供哪些内容来完整实现设备功能。

  1. 实例化驱动入口

驱动入口必须为HdfDriverEntry(在hdf_device_desc.h中定义)类型的全局变量,且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总,形成一个类似数组的段地址空间,方便上层调用。

一般在加载驱动时HDF会先调用Bind函数,再调用Init函数加载该驱动。当Init调用异常时,HDF框架会调用Release释放驱动资源并退出。

I2C驱动入口开发参考:

I2C控制器会出现很多个设备挂接的情况,因而在HDF框架中首先会为此类型的设备创建一个管理器对象,并同时对外发布一个管理器服务来统一处理外部访问。这样,用户需要打开某个设备时,会先获取到管理器服务,然后管理器服务根据用户指定参数查找到指定设备。

I2C管理器服务的驱动由核心层实现,驱动适配者不需要关注这部分内容的实现,但在实现Init函数的时候需要调用核心层的I2cCntlrAdd函数,它会实现相应功能。

    struct HdfDriverEntry g_i2cDriverEntry = {
        .moduleVersion = 1,
        .Init = Hi35xxI2cInit,
        .Release = Hi35xxI2cRelease,
        .moduleName = "hi35xx_i2c_driver",        // 【必要且与config.hcs文件里面匹配】
    };
    HDF_INIT(g_i2cDriverEntry);                   // 调用HDF_INIT将驱动入口注册到HDF框架中

    // 核心层i2c_core.c管理器服务的驱动入口
    struct HdfDriverEntry g_i2cManagerEntry = {
       .moduleVersion = 1,
       .Bind = I2cManagerBind,
       .Init = I2cManagerInit,
       .Release = I2cManagerRelease,
       .moduleName = "HDF_PLATFORM_I2C_MANAGER",  // 这与device_info.hcs文件中device0对应
    };
    HDF_INIT(g_i2cManagerEntry);
    c
 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}">
class="hide-preCode-box">
  1. 配置属性文件

完成驱动入口注册之后,下一步请在//vendor/hisilicon/hispark_taurus/hdf_config/device_info/device_info.hcs文件中添加deviceNode信息,并在i2c_config.hcs中配置器件属性。

deviceNode信息与驱动入口注册相关,器件属性值对于驱动适配者的驱动实现以及核心层I2cCntlr相关成员的默认值或限制范围有密切关系。

统一服务模式的特点是device_info.hcs文件中第一个设备节点必须为I2C管理器,其各项参数必须如表3设置:

表 3 device_info.hcs节点参数说明

class="table-box">
成员名
policy驱动服务发布的策略,I2C管理器具体配置为2,表示驱动对内核态和用户态都发布服务
priority驱动启动优先级(0-200),值越大优先级越低。I2C管理器具体配置为50
permission驱动创建设备节点权限,I2C管理器具体配置为0664
moduleName驱动名称,I2C管理器固定为HDF_PLATFORM_I2C_MANAGER
serviceName驱动对外发布服务的名称,I2C管理器服务名设置为HDF_PLATFORM_I2C_MANAGER
deviceMatchAttr驱动私有数据匹配的关键字,I2C管理器设置为hdf_platform_i2c_manager

从第二个节点开始配置具体I2C控制器信息,此节点并不表示某一路I2C控制器,而是代表一个资源性质设备,用于描述一类I2C控制器的信息。多个控制器之间相互区分的参数是busId和reg_pbase,这在i2c_config.hcs文件中有所体现。

        root {
            device_info {
                match_attr = "hdf_manager";
                device_i2c :: device {
                    device0 :: deviceNode {
                        policy = 2;
                        priority = 50;
                        permission = 0644;
                        moduleName = "HDF_PLATFORM_I2C_MANAGER";
                        serviceName = "HDF_PLATFORM_I2C_MANAGER";
                        deviceMatchAttr = "hdf_platform_i2c_manager";
                    }
                    device1 :: deviceNode {
                        policy = 0;                               // 等于0,不需要发布服务。
                        priority = 55;                            // 驱动启动优先级。
                        permission = 0644;                        // 驱动创建设备节点权限。
                        moduleName = "hi35xx_i2c_driver";         //【必要】用于指定驱动名称,需要与期望的驱动Entry中的moduleName一致。
                        serviceName = "HI35XX_I2C_DRIVER";        //【必要】驱动对外发布服务的名称,必须唯一。
                        deviceMatchAttr = "hisilicon_hi35xx_i2c"; //【必要】用于配置控制器私有数据,要与i2c_config.hcs中对应控制器保持一致,
                                                                  // 具体的控制器信息在 i2c_config.hcs中。
                    }
                }
            }
        }
        c
 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}"> class="hide-preCode-box">
       root {
           platform {
               i2c_config {
                   match_attr = "hisilicon_hi35xx_i2c";  // 【必要】需要和device_info.hcs中的deviceMatchAttr值一致
                   template i2c_controller {             // 模板公共参数,继承该模板的节点如果使用模板中的默认值,则节点字段可以缺省。
                       bus = 0;                          // 【必要】i2c识别号
                       reg_pbase = 0x120b0000;           // 【必要】物理基地址
                       reg_size = 0xd1;                  // 【必要】寄存器位宽
                       irq = 0;                          // 【可选】中断号,由控制器的中断特性决定是否需要
                       freq = 400000;                    // 【可选】频率,初始化硬件控制器的可选参数
                       clk = 50000000;                   // 【可选】控制器时钟,由控制器时钟的初始化流程决定是否需要
                   }
                   controller_0x120b0000 :: i2c_controller {
                       bus = 0;
                   }
                   controller_0x120b1000 :: i2c_controller {
                       bus = 1;
                       reg_pbase = 0x120b1000;
                   }
                   ...
               }
           }
       }
       c
 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}"> class="hide-preCode-box">

需要注意的是,新增i2c_config.hcs配置文件后,必须在hdf.hcs文件中将其包含,否则配置文件无法生效。

例如:本例中i2c_config.hcs所在路径为device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/i2c/i2c_config.hcs,则必须在产品对应的hdf.hcs中添加如下语句:

        #include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/i2c/i2c_config.hcs" // 配置文件相对路径
        c
 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}">
  1. 实例化I2C控制器对象

完成驱动入口注册之后,下一步就是以核心层I2cCntlr对象的初始化为核心,包括驱动适配者自定义结构体(传递参数和数据),实例化I2cCntlr成员I2cMethod(让用户可以通过接口来调用驱动底层函数),实现HdfDriverEntry成员函数(Bind,Init,Release)。

从驱动的角度看,自定义结构体是参数和数据的载体,而且i2c_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员,其中一些重要数值也会传递给核心层I2cCntlr对象,例如设备号、总线号等。

        // 驱动适配者自定义结构体
        struct Hi35xxI2cCntlr {
            struct I2cCntlr cntlr;            // 【必要】是核心层控制对象,具体描述见下面。
            OsalSpinlock spin;                // 【必要】驱动适配者需要基于此锁变量对各个i2c操作函数实现对应的加锁解锁。
            volatile unsigned char  *regBase; // 【必要】寄存器基地址
            uint16_t regSize;                 // 【必要】寄存器位宽
            int16_t bus;                      // 【必要】i2c_config.hcs文件中可读取具体值
            uint32_t clk;                     // 【可选】驱动适配者自定义
            uint32_t freq;                    // 【可选】驱动适配者自定义
            uint32_t irq;                     // 【可选】驱动适配者自定义
            uint32_t regBasePhy;              // 【必要】寄存器物理基地址
        };

        // I2cCntlr是核心层控制器结构体,其中的成员在Init函数中会被赋值。
        struct I2cCntlr {
            struct OsalMutex lock;
            void *owner;
            int16_t busId;
            void *priv;
            const struct I2cMethod *ops;
            const struct I2cLockMethod *lockOps;
        };
        c
 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}"> class="hide-preCode-box">
        // i2c_hi35xx.c中的示例
        static const struct I2cMethod g_method = {
            .transfer = Hi35xxI2cTransfer,
        };

        static const struct I2cLockMethod g_lockOps = {
            .lock = Hi35xxI2cLock,     // 加锁函数
            .unlock = Hi35xxI2cUnlock, // 解锁函数
        };
        c
 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}">

入参:

HdfDeviceObject是整个驱动对外提供的接口参数,具备HCS配置文件的信息。

返回值:

HDF_STATUS相关状态(表4为部分展示,如需使用其他状态,可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义)。

表 4 HDF_STATUS相关状态说明

class="table-box">
状态(值)问题描述
HDF_ERR_INVALID_OBJECT控制器对象非法
HDF_ERR_INVALID_PARAM参数非法
HDF_ERR_MALLOC_FAIL内存分配失败
HDF_ERR_IOI/O错误
HDF_SUCCESS传输成功
HDF_FAILURE传输失败

函数说明:

初始化自定义结构体对象,初始化I2cCntlr成员,调用核心层I2cCntlrAdd函数,接入VFS(可选)。

        static int32_t Hi35xxI2cInit(struct HdfDeviceObject *device)
        {
            ......
            // 遍历、解析i2c_config.hcs中的所有配置节点,并分别进行初始化,需要调用Hi35xxI2cParseAndInit函数。
            DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) {
                ret = Hi35xxI2cParseAndInit(device, childNode);//函数定义见下
            ......
            }
            ......
        }

        static int32_t Hi35xxI2cParseAndInit(struct HdfDeviceObject *device, const struct DeviceResourceNode *node)
        {
            struct Hi35xxI2cCntlr *hi35xx = NULL;
            ......                                                              // 入参判空
            hi35xx = (struct Hi35xxI2cCntlr *)OsalMemCalloc(sizeof(*hi35xx));   // 内存分配
            ......                                                              // 返回值校验
            hi35xx->regBase = OsalIoRemap(hi35xx->regBasePhy, hi35xx->regSize); // 地址映射
            ......                                                              // 返回值校验
            Hi35xxI2cCntlrInit(hi35xx);                                         // 【必要】i2c设备的初始化

            hi35xx->cntlr.priv = (void *)node;                                  // 【必要】存储设备属性
            hi35xx->cntlr.busId = hi35xx->bus;                                  // 【必要】初始化I2cCntlr成员busId
            hi35xx->cntlr.ops = &g_method;                                      // 【必要】I2cMethod的实例化对象的挂载
            hi35xx->cntlr.lockOps = &g_lockOps;                                 // 【必要】I2cLockMethod的实例化对象的挂载
            (void)OsalSpinInit(&hi35xx->spin);                                  // 【必要】锁的初始化
            ret = I2cCntlrAdd(&hi35xx->cntlr);                                  // 【必要】调用此函数将控制器对象添加至平台核心层,返回成功信号后驱动才完全接入平台核心层。
            ...... 
        #ifdef USER_VFS_SUPPORT
            (void)I2cAddVfsById(hi35xx->cntlr.busId);                           // 【可选】若支持用户级的虚拟文件系统,则接入。
        #endif
            return HDF_SUCCESS;
        __ERR__:                                                                // 若不成功,需要回滚函数内已执行的操作(如取消IO映射、释放内存等),并返回错误码
            if (hi35xx != NULL) {
                if (hi35xx->regBase != NULL) {
                    OsalIoUnmap((void *)hi35xx->regBase);
                    hi35xx->regBase = NULL;
                }
                OsalMemFree(hi35xx);
                hi35xx = NULL;
            }
            return ret;
        }
        c
 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}"> class="hide-preCode-box">

入参:

HdfDeviceObject是整个驱动对外提供的接口参数,具备HCS配置文件的信息。

返回值:

无。

函数说明:

释放内存和删除控制器,该函数需要在驱动入口结构体中赋值给Release接口,当HDF框架调用Init函数初始化驱动失败时,可以调用Release释放驱动资源。

        static void Hi35xxI2cRelease(struct HdfDeviceObject *device)
        {
            ...... 
            // 与Hi35xxI2cInit一样,需要将每个节点分别进行释放。
            DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) {
                Hi35xxI2cRemoveByNode(childNode); // 函数定义如下
            }
        }

        static void Hi35xxI2cRemoveByNode(const struct DeviceResourceNode *node)
        {
          ...... 
          // 【必要】可以调用I2cCntlrGet函数通过设备的bus号获取I2cCntlr对象的指针,以及调用I2cCntlrRemove函数将I2cCntlr对象从平台核心层移除。
          cntlr = I2cCntlrGet(bus);
          if (cntlr != NULL && cntlr->priv == node) {
              ...... 
              I2cCntlrRemove(cntlr); 
              // 【必要】解除地址映射,释放锁和内存。
              hi35xx = (struct Hi35xxI2cCntlr *)cntlr; 
              OsalIoUnmap((void *)hi35xx->regBase);
              (void)OsalSpinDestroy(&hi35xx->spin);
              OsalMemFree(hi35xx);
          }
          return;
        }
        c
 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}"> class="hide-preCode-box">
  1. 驱动调试

【可选】针对新增驱动程序,建议验证驱动基本功能,例如挂载后的信息反馈,消息传输的成功与否等。

如果大家想更加深入的学习 OpenHarmony(鸿蒙南向) 开发的全栈内容,不妨可以参考以下相关学习文档进行学习,助你快速提升自己:

OpenHarmony 开发环境搭建:https://qr18.cn/CgxrRy

《OpenHarmony源码解析》:https://qr18.cn/CgxrRy

系统架构分析:https://qr18.cn/CgxrRy

OpenHarmony 设备开发学习手册:https://qr18.cn/CgxrRy

在这里插入图片描述

OpenHarmony面试题(内含参考答案):https://qr18.cn/CgxrRy

写在最后

data-report-view="{"mod":"1585297308_001","spm":"1001.2101.3001.6548","dest":"https://blog.csdn.net/maniuT/article/details/140996334","extend1":"pc","ab":"new"}">> id="blogExtensionBox" style="width:400px;margin:auto;margin-top:12px" class="blog-extension-box"> class="blog_extension blog_extension_type2" id="blog_extension"> class="extension_official" data-report-click="{"spm":"1001.2101.3001.6471"}" data-report-view="{"spm":"1001.2101.3001.6471"}"> class="blog_extension_card_left"> class="blog_extension_card_cont"> 鸿蒙开发学习资料领取!!! class="blog_extension_card_cont_r"> 微信名片
注:本文转载自blog.csdn.net的沧海一笑-dj的文章"https://blog.csdn.net/dengjin20104042056/article/details/99334010"。版权归原作者所有,此博客不拥有其著作权,亦不承担相应法律责任。如有侵权,请联系我们删除。
复制链接

评论记录:

未查询到任何数据!