class="hide-preCode-box">

在//device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/uart/uart_config.hcs文件配置器件属性,其中配置参数如下:

        root {
            platform {
                template uart_controller {                   // 配置模板,如果下面节点使用时继承该模板,则节点中未声明的字段会使用该模板中的默认值
                    match_attr = "";
                    num = 0;                                 // 【必要】端口号
                    baudrate = 115200;                       // 【必要】波特率,数值可按需填写
                    fifoRxEn = 1;                            // 【必要】使能接收FIFO
                    fifoTxEn = 1;                            // 【必要】使能发送FIFO
                    flags = 4;                               // 【必要】标志信号
                    regPbase = 0x120a0000;                   // 【必要】地址映射需要
                    interrupt = 38;                          // 【必要】中断号
                    iomemCount = 0x48;                       // 【必要】地址映射需要
                }
                controller_0x120a0000 :: uart_controller {
                    match_attr = "hisilicon_hi35xx_uart_0";  // 【必要】必须和device_info.hcs中对应的设备的deviceMatchAttr值一致
                }
                controller_0x120a1000 :: uart_controller {
                    num = 1;
                    baudrate = 9600;
                    regPbase = 0x120a1000;
                    interrupt = 39;
                    match_attr = "hisilicon_hi35xx_uart_1";
                }
                ......                                       // 如果存在多个UART设备时【必须】添加节点,否则不用
            }
        }
        c
 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}"> class="hide-preCode-box">

需要注意的是,新增uart_config.hcs配置文件后,必须在产品对应的hdf.hcs文件中将其包含如下语句所示,否则配置文件无法生效。

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

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

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

从驱动的角度看,驱动适配者自定义结构体是参数和数据的载体,而且uart_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员,一些重要数值也会传递给核心层对象,例如端口号。

        struct UartPl011Port {                       // 驱动适配者自定义管脚描述结构体
            int32_t enable;
            unsigned long physBase;                  // 物理地址
            uint32_t irqNum;                         // 中断号
            uint32_t defaultBaudrate;                // 默认波特率
            uint32_t flags;                          // 标志信号,下面三个宏与之相关
        #define PL011_FLG_IRQ_REQUESTED    (1 << 0)
        #define PL011_FLG_DMA_RX_REQUESTED (1 << 1)
        #define PL011_FLG_DMA_TX_REQUESTED (1 << 2)
            struct UartDmaTransfer *rxUdt;           // DMA传输相关
            struct UartDriverData *udd;
        };
        struct UartDriverData {                      // 数据传输相关的结构体
            uint32_t num;                            // 端口号
            uint32_t baudrate;                       // 波特率(可设置)
            struct UartAttribute attr;               // 数据位、停止位等传输属性相关
            struct UartTransfer *rxTransfer;         // 缓冲区相关,可理解为FIFO结构
            wait_queue_head_t wait;                  // 条件变量相关的排队等待信号
            int32_t count;                           // 数据数量
            int32_t state;                           // UART控制器状态
        #define UART_STATE_NOT_OPENED 0
        #define UART_STATE_OPENING    1
        #define UART_STATE_USEABLE    2
        #define UART_STATE_SUSPENDED  3
            uint32_t flags;                          // 状态标志
        #define UART_FLG_DMA_RX       (1 << 0)
        #define UART_FLG_DMA_TX       (1 << 1)
        #define UART_FLG_RD_BLOCK     (1 << 2)
            RecvNotify recv;                         // 函数指针类型,指向串口数据接收函数
            struct UartOps *ops;                     // 自定义函数指针结构体
            void *private;                           // 私有数据
        };

        // UartHost是核心层控制器结构体,其中的成员在Init函数中会被赋值。
        struct UartHost {
            struct IDeviceIoService service;         // 驱动服务
            struct HdfDeviceObject *device;          // 驱动设备对象
            uint32_t num;                            // 端口号
            OsalAtomic atom;                         // 原子量
            void *priv;                              // 私有数据
            struct UartHostMethod *method;           // 回调函数
        };
        c
 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}"> class="hide-preCode-box">
        // uart_hi35xx.c 中的示例:钩子函数的实例化
        struct UartHostMethod g_uartHostMethod = {
            .Init = Hi35xxInit,                     // 初始化
            .Deinit = Hi35xxDeinit,                 // 去初始化
            .Read = Hi35xxRead,                     // 接收数据
            .Write = Hi35xxWrite,                   // 发送数据
            .SetBaud = Hi35xxSetBaud,               // 设置波特率
            .GetBaud = Hi35xxGetBaud,               // 获取波特率
            .SetAttribute = Hi35xxSetAttribute,     // 设置设备属性
            .GetAttribute = Hi35xxGetAttribute,     // 获取设备属性
            .SetTransMode = Hi35xxSetTransMode,     // 设置传输模式
            .pollEvent = Hi35xxPollEvent,           // 轮询
        };
        c
 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}">

入参:

HdfDeviceObject:HDF框架给每一个驱动创建的设备对象,用来保存设备相关的私有数据和服务接口。

返回值:

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

表 3 HDF_STATUS相关状态说明

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

函数说明:

初始化自定义结构体对象,初始化UartHost成员。

        //uart_hi35xx.c
        static int32_t HdfUartDeviceBind(struct HdfDeviceObject *device)
        {
            ......
            return (UartHostCreate(device) == NULL) ? HDF_FAILURE : HDF_SUCCESS; // 【必须】调用核心层函数UartHostCreate
        }

        // uart_core.c核心层UartHostCreate函数说明
        struct UartHost *UartHostCreate(struct HdfDeviceObject *device)
        {
            struct UartHost *host = NULL;                                        // 新建UartHost
            ......                                                                  
            host = (struct UartHost *)OsalMemCalloc(sizeof(*host));              // 分配内存
            ......
            host->device = device;                                               // 【必要】使HdfDeviceObject与UartHost可以相互转化的前提
            device->service = &(host->service);                                  // 【必要】使HdfDeviceObject与UartHost可以相互转化的前提
            host->device->service->Dispatch = UartIoDispatch;                    // 为service成员的Dispatch方法赋值
            OsalAtomicSet(&host->atom, 0);                                       // 原子量初始化或者原子量设置
            host->priv = NULL;
            host->method = NULL;
            return host;
        }
        c
 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}"> class="hide-preCode-box">

入参:

HdfDeviceObject:HDF框架给每一个驱动创建的设备对象,用来保存设备相关的私有数据和服务接口。

返回值:

HDF_STATUS相关状态。

函数说明:

初始化自定义结构体对象,初始化UartHost成员,调用核心层UartAddDev函数,完成UART控制器的添加,接入VFS。

        int32_t HdfUartDeviceInit(struct HdfDeviceObject *device)
        {
            int32_t ret;
            struct UartHost *host = NULL;
            HDF_LOGI("%s: entry", __func__);
            ......
            host = UartHostFromDevice(device);                                           // 通过service成员后强制转为UartHost,赋值是在Bind函数中
            ......                                    
            ret = Hi35xxAttach(host, device);                                            // 完成UartHost对象的初始化,见下
            ......                                   
            host->method = &g_uartHostMethod;                                            // UartHostMethod的实例化对象的挂载
            return ret;
        }
        // 完成UartHost对象的初始化。
        static int32_t Hi35xxAttach(struct UartHost *host, struct HdfDeviceObject *device)
        {
            int32_t ret;
            struct UartDriverData *udd = NULL;                                           // udd和port对象是驱动适配者自定义的结构体对象,可根据需要实现相关功能
            struct UartPl011Port *port = NULL;
            ......
            // 【必要】步骤【1】~【7】主要实现对udd对象的实例化赋值,然后赋值给核心层UartHost对象。
            udd = (struct UartDriverData *)OsalMemCalloc(sizeof(*udd));                  // 【1】
            ......
            port = (struct UartPl011Port *)OsalMemCalloc(sizeof(struct UartPl011Port));  // 【2】
            ......
            udd->ops = Pl011GetOps();                                                    // 【3】设备开启、关闭、属性设置、发送操作等函数挂载。
            udd->recv = PL011UartRecvNotify;                                             // 【4】数据接收通知函数(条件锁机制)挂载
            udd->count = 0;                                                              // 【5】
            port->udd = udd;                                                             // 【6】使UartPl011Port与UartDriverData可以相互转化的前提
            ret = UartGetConfigFromHcs(port, device->property);                          // 将HdfDeviceObject的属性传递给驱动适配者自定义结构体,用于相关操作,示例代码见下
            ......
            udd->private = port;                                                         // 【7】
            host->priv = udd;                                                            // 【必要】使UartHost与UartDriverData可以相互转化的前提
            host->num = udd->num;                                                        // 【必要】UART设备号
            UartAddDev(host);                                                            // 【必要】核心层uart_dev.c中的函数,作用:注册一个字符设备节点到vfs,这样从用户态可以通过这个虚拟文件节点访问UART  
            return HDF_SUCCESS;
        }

        static int32_t UartGetConfigFromHcs(struct UartPl011Port *port, const struct DeviceResourceNode *node)
        {
            uint32_t tmp, regPbase, iomemCount;
            struct UartDriverData *udd = port->udd;
            struct DeviceResourceIface *iface = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE); 
            ......
            // 通过请求参数提取相应的值,并赋值给驱动适配者自定义的结构体。
            if (iface->GetUint32(node, "num", &udd->num, 0) != HDF_SUCCESS) {
                HDF_LOGE("%s: read busNum fail", __func__);
                return HDF_FAILURE;
            }
            ......
            return 0;
        }
        c
 class="hljs-button signin active" data-title="登录复制" data-report-click="{"spm":"1001.2101.3001.4334"}"> class="hide-preCode-box">

入参:

HdfDeviceObject:HDF框架给每一个驱动创建的设备对象,用来保存设备相关的私有数据和服务接口。

返回值:

无。

函数说明:

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

说明:
所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。

        void HdfUartDeviceRelease(struct HdfDeviceObject *device)
        {
            struct UartHost *host = NULL;
            ...
            host = UartHostFromDevice(device);           // 这里有HdfDeviceObject到UartHost的强制转化,通过service成员,赋值见Bind函数。
            ...                                          
            if (host->priv != NULL) {                    
                Hi35xxDetach(host);                      // 驱动适配自定义的内存释放函数,见下。
            }                                            
            UartHostDestroy(host);                       // 调用核心层函数释放host
        }

        static void Hi35xxDetach(struct UartHost *host)
        {
            struct UartDriverData *udd = NULL;
            struct UartPl011Port *port = NULL;
            ...
            udd = host->priv;                            // 这里有UartHost到UartDriverData的转化
            ...                                          
            UartRemoveDev(host);                         // VFS注销
            port = udd->private;                         // 这里有UartDriverData到UartPl011Port的转化
            if (port != NULL) {                          
                if (port->physBase != 0) {               
                    OsalIoUnmap((void *)port->physBase); // 地址反映射
                }
                OsalMemFree(port);
                udd->private = NULL;
            }
            OsalMemFree(udd);                            // 释放UartDriverData
            host->priv = NULL;
        }
        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/141064333","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/99686141"。版权归原作者所有,此博客不拥有其著作权,亦不承担相应法律责任。如有侵权,请联系我们删除。
复制链接

评论记录:

未查询到任何数据!