diff --git a/zh-cn/device-dev/driver/Readme-CN.md b/zh-cn/device-dev/driver/Readme-CN.md index 1db6007a4f7910b431d957c70cecc76c883c36b4..efa92f02d96ef47c44b0fdf94f4b933b5a829a79 100755 --- a/zh-cn/device-dev/driver/Readme-CN.md +++ b/zh-cn/device-dev/driver/Readme-CN.md @@ -9,6 +9,7 @@ - [HDF开发实例](driver-hdf-sample.md) - [平台驱动开发](driver-develop.md) - [ADC](driver-platform-adc-develop.md) + - [DAC](driver-platform-dac-develop.md) - [GPIO](driver-platform-gpio-develop.md) - [HDMI](driver-platform-hdmi-develop.md) - [I2C](driver-platform-i2c-develop.md) @@ -24,6 +25,7 @@ - [WatchDog](driver-platform-watchdog-develop.md) - [平台驱动使用](driver-platform.md) - [ADC](driver-platform-adc-des.md) + - [DAC](driver-platform-dac-des.md) - [GPIO](driver-platform-gpio-des.md) - [HDMI](driver-platform-hdmi-des.md) - [I2C](driver-platform-i2c-des.md) diff --git a/zh-cn/device-dev/driver/driver-develop.md b/zh-cn/device-dev/driver/driver-develop.md index e4cee0c88383f41bd46628a0b0dfd079876f805c..bb2cff55133ce0f076a67d747ce13db2c2c2ee3b 100644 --- a/zh-cn/device-dev/driver/driver-develop.md +++ b/zh-cn/device-dev/driver/driver-develop.md @@ -2,6 +2,8 @@ - **[ADC](driver-platform-adc-develop.md)** +- **[DAC](driver-platform-dac-develop.md)** + - **[GPIO](driver-platform-gpio-develop.md)** - **[HDMI](driver-platform-hdmi-develop.md)** diff --git a/zh-cn/device-dev/driver/driver-platform-dac-des.md b/zh-cn/device-dev/driver/driver-platform-dac-des.md new file mode 100644 index 0000000000000000000000000000000000000000..475edc9e6f285b0bce699cf6471fdee96a6afcde --- /dev/null +++ b/zh-cn/device-dev/driver/driver-platform-dac-des.md @@ -0,0 +1,200 @@ +# DAC + +- [概述](#section1) +- [接口说明](#section2) +- [使用指导](#section3) + - [使用流程](#section4) + - [打开DAC设备](#section5) + - [设置DA目标值](#section6) + - [关闭DAC设备](#section7) + +- [使用实例](#section8) + +## 概述 + +- DAC(Digital to analog converter)是一种通过电流、电压或电荷的形式将数字信号转换为模拟信号的设备 + +- DAC接口定义了完成DAC传输的通用方法集合,包括: + - DAC设备管理: 打开或关闭DAC设备。 + - DAC设置目标值:写入DA目标值。 + + **图 1** DAC物理连线示意图 + ![](figures/DAC物理连线示意图.png "DAC物理连线示意图") + +## 接口说明 + +**表 1** DAC驱动API接口功能介绍 + + + +| 功能分类 | 接口名 | 描述 | +| ------------------- | -------- | ------------ | +| DAC设备管理打开接口 | DacOpen | 打开DAC设备 | +| DAC设备管理关闭接口 | DacClose | 关闭DAC设备 | +| DAC写入目标值接口 | DacWrite | 设置DA目标值 | + +## 使用指导 + +### 使用流程 + +使用DAC设备的一般流程如[图2](#fig2)所示。 + + **图 2** DAC使用流程图 +![](figures/DAC使用流程图.png "DAC使用流程图") + +### 打开DAC设备 + +在进行DA转换之前,首先要调用DacOpen打开DAC设备,打开函数如下所示: + +``` +DevHandle DacOpen(uint32_t number); +``` + +**表 2** DacOpen参数和返回值描述 + + + +| 参数 | 参数描述 | +| ---------- | ----------------- | +| number | DAC设备号 | +| **返回值** | **返回值描述** | +| NULL | 打开DAC设备失败 | +| 设备句柄 | 打开的DAC设备句柄 | + + + +假设系统中存在2个DAC设备,编号从0到1,现在打开1号设备。 + +``` +DevHandle dacHandle = NULL; /* DAC设备句柄 / + +/* 打开DAC设备 */ +dacHandle = DacOpen(1); +if (dacHandle == NULL) { + HDF_LOGE("DacOpen: failed\n"); + return; +} +``` + +### 设置DA目标值 + +``` +int32_t DacWrite(DevHandle handle, uint32_t channel, uint32_t val); +``` + +**表 3** DacWrite参数和返回值描述 + + + + + + + + + + + + + + + + + + + + + + + + + + +

参数

+

参数描述

+

handle

+

DAC设备句柄

+

channel

+

DAC设备通道号

+

val

+

设置DA的值

+

返回值

+

返回值描述

+

0

+

写入成功

+

负数

+

写入失败

+
+ +### 关闭DAC设备 + +DAC通信完成之后,需要关闭DAC设备,关闭函数如下所示: +``` +void DacClose(DevHandle handle); +``` +**表 4** DacClose参数和返回值描述 + + + +| 参数 | 参数描述 | +| ---------- | -------------- | +| handle | DAC设备句柄 | +| **返回值** | **返回值描述** | +| void | 无 | + + + +关闭DAC设备示例: + +``` +DacClose(dacHandle); /* 关闭DAC设备 */ +``` + +## 使用实例 + +本例程以操作开发板上的DAC设备为例,详细展示DAC接口的完整使用流程。 + +由于Hi3516DV300系列SOC没有DAC控制器,本例拟在Hi3516DV300某开发板上对虚拟驱动进行简单的传输操作,基本硬件信息如下: + +- SOC:hi3516dv300。 +- 原理图信息: 电位器挂接在0号DAC设备1通道下。 + +本例程对测试DAC进行连续写入操作,测试DAC功能是否正常。 + +示例如下: + +``` +#include "dac_if.h" /* DAC标准接口头文件 */ +#include "hdf_log.h" /* 标准日志打印头文件 */ + +/* 设备号0,通道号1 */ +#define DAC_DEVICE_NUM 0 +#define DAC_CHANNEL_NUM 1 + +/* DAC例程总入口 */ +static int32_t TestCaseDac(void) +{ + uint32_t val = 2; + int32_t ret; + DevHandle dacHandle; + + /* 打开DAC设备 */ + dacHandle = DacOpen(DAC_DEVICE_NUM); + if (dacHandle == NULL) { + HDF_LOGE("%s: Open DAC%u fail!", __func__, DAC_DEVICE_NUM); + return -1; + } + + /* 写入数据 */ + ret = DacWrite(dacHandle, DAC_CHANNEL_NUM, val); + if (ret != HDF_SUCCESS) { + HDF_LOGE("%s: tp DAC write reg fail!:%d", __func__, ret); + DacClose(dacHandle); + return -1; + } + + /* 访问完毕关闭DAC设备 */ + DacClose(dacHandle); + + return 0; +} +``` diff --git a/zh-cn/device-dev/driver/driver-platform-dac-develop.md b/zh-cn/device-dev/driver/driver-platform-dac-develop.md new file mode 100644 index 0000000000000000000000000000000000000000..49b7c1176cc9306ed5e8efa560868bc104e93383 --- /dev/null +++ b/zh-cn/device-dev/driver/driver-platform-dac-develop.md @@ -0,0 +1,330 @@ +# DAC + +- [概述](#1) +- [接口说明](#2) +- [开发步骤](#3) +- [开发实例](#4) + +## 概述 + +DAC(Digital to analog converter)是一种通过电流、电压或电荷的形式将数字信号转换为模拟信号的设备 ,在HDF框架中,DAC模块接口适配模式采用统一服务模式,这需要一个设备服务来作为DAC模块的管理器,统一处理外部访问,这会在配置文件中有所体现。统一服务模式适合于同类型设备对象较多的情况,如DAC可能同时具备十几个控制器,采用独立服务模式需要配置更多的设备节点,且服务会占据内存资源。 + +**图 1** DAC统一服务模式 +![](figures/DAC统一服务模式结构图.png "DAC统一服务模式") + +## 接口说明 +DacMethod定义: + +``` +struct DacMethod { + int32_t (*write)(struct DacDevice *device, uint32_t channel, uint32_t val); + int32_t (*start)(struct DacDevice *device); + int32_t (*stop)(struct DacDevice *device); +}; +``` + +**表 1** DacMethod结构体成员的回调函数功能说明 + + + +| 函数成员 | 入参 | 出参 | 返回值 | 功能 | +| -------- | ------------------------------------------------------------ | ------------------------------ | ------------------ | --------------- | +| write | device: 结构体指针,核心层DAC控制器;channel:uint32_t,传入的通道号; | val:uint32_t,要传出去的数据; | HDF_STATUS相关状态 | 写入DAC的目标值 | +| start | device: 结构体指针,核心层DAC控制器; | 无 | HDF_STATUS相关状态 | 开启DAC设备 | +| stop | device: 结构体指针,核心层DAC控制器; | 无 | HDF_STATUS相关状态 | 关闭DAC设备 | + + + +## 开发步骤 + +DAC模块适配的三个环节是配置属性文件,实例化驱动入口,以及实例化核心层接口函数。 + +1. **实例化驱动入口:** + - 实例化HdfDriverEntry结构体成员。 + - 调用HDF\_INIT将HdfDriverEntry实例化对象注册到HDF框架中。 + +2. **配置属性文件:** + - 在device\_info.hcs文件中添加deviceNode描述。 + - 【可选】添加dac\_config.hcs器件属性文件。 + +3. **实例化DAC控制器对象:** + - 初始化DacDevice成员。 +- 实例化DacDevice成员DacMethod。 + + >![](../public_sys-resources/icon-note.gif) **说明:** + >实例化DacDevice成员DacMethod,其定义和成员说明见[接口说明](#section752964871810)。 + + +4. **驱动调试:** + + 【可选】针对新增驱动程序,建议验证驱动基本功能,例如挂载后的信息反馈,的成功与否等。 + + +## 开发实例 + +1. 驱动开发首先需要实例化驱动入口,驱动入口必须为HdfDriverEntry(在 hdf\_device\_desc.h 中定义)类型的全局变量,且moduleName要和device\_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总,形成一个类似数组的段地址空间,方便上层调用。 + + 一般在加载驱动时HDF会先调用Bind函数,再调用Init函数加载该驱动。当Init调用异常时,HDF框架会调用Release释放驱动资源并退出。 + + DAC驱动入口参考: + + DAC模块这种类型的控制器会出现很多个设备挂接的情况,因而在HDF框架中首先会为这类型的设备创建一个管理器对象。这样,需要打开某个设备时,管理器对象会根据指定参数查找到指定设备。 + + DAC管理器的驱动由核心层实现,厂商不需要关注这部分内容的实现,这个但在实现Init函数的时候需要调用核心层的DacDeviceAdd函数,它会实现相应功能。 + + ``` + static struct HdfDriverEntry g_dacDriverEntry = { + .moduleVersion = 1, + .Init = VirtualDacInit, + .Release = VirtualDacRelease, + .moduleName = "virtual_dac_driver", //【必要且与 HCS 里面的名字匹配】 + }; + HDF_INIT(g_dacDriverEntry); //调用HDF_INIT将驱动入口注册到HDF框架中 + + //核心层dac_core.c管理器服务的驱动入口 + struct HdfDriverEntry g_dacManagerEntry = { + .moduleVersion = 1, + .Init = DacManagerInit, + .Release = DacManagerRelease, + .moduleName = "HDF_PLATFORM_DAC_MANAGER", //这与device_info文件中device0对应 + }; + HDF_INIT(g_dacManagerEntry); + ``` + +2. 完成驱动入口注册之后,下一步请在device\_info.hcs文件中添加deviceNode信息,并在dac\_config.hcs中配置器件属性。deviceNode信息与驱动入口注册相关,器件属性值对于厂商驱动的实现以及核心层DacDevice相关成员的默认值或限制范围有密切关系。 + + 统一服务模式的特点是device\_info文件中第一个设备节点必须为DAC管理器,其各项参数必须如下设置: + + + + | 成员名 | 值 | + | --------------- | ------------------------------- | + | moduleName | 固定为 HDF_PLATFORM_DAC_MANAGER | + | serviceName | 无 | + | policy | 具体配置为0,不发布服务 | + | deviceMatchAttr | 没有使用,可忽略 | + + 从第二个节点开始配置具体DAC控制器信息,此节点并不表示某一路DAC控制器,而是代表一个资源性质设备,用于描述一类DAC控制器的信息。本例只有一个DAC设备,如有多个设备,则需要在device\_info文件增加deviceNode信息,以及在dac\_config文件中增加对应的器件属性。 + + - device\_info.hcs 配置参考。 + + ``` + root { + device_dac :: device { + device0 :: deviceNode { + policy = 0; + priority = 52; + permission = 0644; + serviceName = "HDF_PLATFORM_DAC_MANAGER"; + moduleName = "HDF_PLATFORM_DAC_MANAGER"; + } + } + dac_virtual :: deviceNode { + policy = 0; + priority = 56; + permission = 0644; + moduleName = "virtual_dac_driver"; //【必要】用于指定驱动名称,需要与期望的驱动Entry中的moduleName一致; + serviceName = "VIRTUAL_DAC_DRIVER"; //【必要】驱动对外发布服务的名称,必须唯一 + deviceMatchAttr = "virtual_dac"; //【必要】用于配置控制器私有数据,要与dac_config.hcs中对应控制器保持一致 + } // 具体的控制器信息在 dac_config.hcs 中 + } + ``` + + - dac\_config.hcs 配置参考。 + + ``` + root { + platform { + dac_config { + match_attr = "virtual_dac"; //【必要】需要和device_info.hcs中的deviceMatchAttr值一致 + template dac_device { + deviceNum = 0; //设备号 + validChannel = 0x1; //有效通道 + rate = 20000; + } + device_0 :: dac_device { + deviceNum = 0; + validChannel = 0x2; + } + } + } + } + ``` + +3. 完成驱动入口注册之后,最后一步就是以核心层DacDevice对象的初始化为核心,包括初始化厂商自定义结构体(传递参数和数据),实例化DacDevice成员DacMethod(让用户可以通过接口来调用驱动底层函数),实现HdfDriverEntry成员函数(Bind,Init,Release)。 + - 自定义结构体参考。 + + 从驱动的角度看,自定义结构体是参数和数据的载体,而且dac\_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员,其中一些重要数值也会传递给核心层DacDevice对象,例如设备号、总线号等。 + + ``` + struct VirtualDacDevice { + struct DacDevice device; //【必要】是核心层控制对象,具体描述见下面 + uint32_t deviceNum; //【必要】设备号 + uint32_t validChannel; //【必要】有效通道 + uint32_t rate; //【必要】采样率 + }; + + //DacDevice是核心层控制器结构体,其中的成员在Init函数中会被赋值 + struct DacDevice { + const struct DacMethod *ops; + OsalSpinlock spin; + uint32_t devNum; + uint32_t chanNum; + const struct DacLockMethod *lockOps; + void *priv; + }; + ``` + + - DacDevice成员回调函数结构体DacMethod的实例化,DacLockMethod回调函数结构体本例未实现,若要实例化,可参考I2C驱动开发,其他成员在Init函数中初始化。 + + ``` + static const struct DacMethod g_method = { + .write = VirtualDacWrite, + .stop = VirtualDacStop, + .start = VirtualDacStart, + }; + ``` +- init函数参考 + + 入参: + + HdfDeviceObject这个是整个驱动对外暴露的接口参数,具备HCS配置文件的信息。 + + 返回值: + + HDF\_STATUS相关状态 (下表为部分展示,如需使用其他状态,可见//drivers/framework/include/utils/hdf\_base.h中HDF\_STATUS 定义)。 + + | 状态(值) | 问题描述 | + | ---------------------- | -------------- | + | HDF_ERR_INVALID_OBJECT | 控制器对象非法 | + | HDF_ERR_INVALID_PARAM | 参数非法 | + | HDF_ERR_MALLOC_FAIL | 内存分配失败 | + | HDF_ERR_IO | I/O 错误 | + | HDF_SUCCESS | 传输成功 | + | HDF_FAILURE | 传输失败 | + + 函数说明: + + 初始化自定义结构体对象,初始化DacDevice成员,并调用核心层DacDeviceAdd函数。 + + ``` + static int32_t VirtualDacParseAndInit(struct HdfDeviceObject *device, const struct DeviceResourceNode *node) + { + int32_t ret; + struct VirtualDacDevice *virtual = NULL; + (void)device; + + virtual = (struct VirtualDacDevice *)OsalMemCalloc(sizeof(*virtual)); + if (virtual == NULL) { + HDF_LOGE("%s: Malloc virtual fail!", __func__); + return HDF_ERR_MALLOC_FAIL; + } + + ret = VirtualDacReadDrs(virtual, node); + if (ret != HDF_SUCCESS) { + HDF_LOGE("%s: Read drs fail! ret:%d", __func__, ret); + goto __ERR__; + } + + VirtualDacDeviceInit(virtual); + virtual->device.priv = (void *)node; + virtual->device.devNum = virtual->deviceNum; + virtual->device.ops = &g_method; + ret = DacDeviceAdd(&virtual->device); + if (ret != HDF_SUCCESS) { + HDF_LOGE("%s: add Dac controller failed! ret = %d", __func__, ret); + goto __ERR__; + } + + return HDF_SUCCESS; + __ERR__: + if (virtual != NULL) { + OsalMemFree(virtual); + virtual = NULL; + } + + return ret; + } + + static int32_t VirtualDacInit(struct HdfDeviceObject *device) + { + int32_t ret; + const struct DeviceResourceNode *childNode = NULL; + + if (device == NULL || device->property == NULL) { + HDF_LOGE("%s: device or property is NULL", __func__); + return HDF_ERR_INVALID_OBJECT; + } + + ret = HDF_SUCCESS; + DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) { + ret = VirtualDacParseAndInit(device, childNode); + if (ret != HDF_SUCCESS) { + break; + } + } + return ret; + ``` + } + + - Release 函数参考 + + 入参: + + HdfDeviceObject 是整个驱动对外暴露的接口参数,具备 HCS 配置文件的信息。 + + 返回值: + + 无。 + + 函数说明: + + 释放内存和删除控制器,该函数需要在驱动入口结构体中赋值给 Release 接口, 当HDF框架调用Init函数初始化驱动失败时,可以调用 Release 释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。 + + ``` + static void VirtualDacRemoveByNode(const struct DeviceResourceNode *node) + { + int32_t ret; + int16_t devNum; + struct DacDevice *device = NULL; + struct VirtualDacDevice *virtual = NULL; + struct DeviceResourceIface *drsOps = NULL; + + drsOps = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE); + if (drsOps == NULL || drsOps->GetUint32 == NULL) { + HDF_LOGE("%s: invalid drs ops fail!", __func__); + return; + } + + ret = drsOps->GetUint16(node, "devNum", (uint16_t *)&devNum, 0); + if (ret != HDF_SUCCESS) { + HDF_LOGE("%s: read devNum fail!", __func__); + return; + } + + device = DacDeviceGet(devNum); + if (device != NULL && device->priv == node) { + DacDevicePut(device); + DacDeviceRemove(device); + virtual = (struct VirtualDacDevice *)device; + OsalMemFree(virtual); + } + return; + } + + static void VirtualDacRelease(struct HdfDeviceObject *device) + { + const struct DeviceResourceNode *childNode = NULL; + + if (device == NULL || device->property == NULL) { + HDF_LOGE("%s: device or property is NULL", __func__); + return; + } + + DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) { + VirtualDacRemoveByNode(childNode); + } + } + ``` + + \ No newline at end of file diff --git a/zh-cn/device-dev/driver/driver-platform.md b/zh-cn/device-dev/driver/driver-platform.md index 01fc51f6cd1717787c769e2c1f1f79bc7b67d2d3..b47f953c31b845a3bf447fa1e816c971d7db892e 100644 --- a/zh-cn/device-dev/driver/driver-platform.md +++ b/zh-cn/device-dev/driver/driver-platform.md @@ -2,6 +2,8 @@ - **[ADC](driver-platform-adc-des.md)** +- **[DAC](driver-platform-dac-des.md)** + - **[GPIO](driver-platform-gpio-des.md)** - **[HDMI](driver-platform-hdmi-des.md)** diff --git "a/zh-cn/device-dev/driver/figures/DAC\344\275\277\347\224\250\346\265\201\347\250\213\345\233\276.png" "b/zh-cn/device-dev/driver/figures/DAC\344\275\277\347\224\250\346\265\201\347\250\213\345\233\276.png" new file mode 100644 index 0000000000000000000000000000000000000000..cc6b37dfb15c5c6130d4b25380fbf5cacc990f3c Binary files /dev/null and "b/zh-cn/device-dev/driver/figures/DAC\344\275\277\347\224\250\346\265\201\347\250\213\345\233\276.png" differ diff --git "a/zh-cn/device-dev/driver/figures/DAC\347\211\251\347\220\206\350\277\236\347\272\277\347\244\272\346\204\217\345\233\276.png" "b/zh-cn/device-dev/driver/figures/DAC\347\211\251\347\220\206\350\277\236\347\272\277\347\244\272\346\204\217\345\233\276.png" new file mode 100644 index 0000000000000000000000000000000000000000..3f81bf5d2eba9164531e786ebb4a81541515e5db Binary files /dev/null and "b/zh-cn/device-dev/driver/figures/DAC\347\211\251\347\220\206\350\277\236\347\272\277\347\244\272\346\204\217\345\233\276.png" differ diff --git "a/zh-cn/device-dev/driver/figures/DAC\347\273\237\344\270\200\346\234\215\345\212\241\346\250\241\345\274\217\347\273\223\346\236\204\345\233\276.png" "b/zh-cn/device-dev/driver/figures/DAC\347\273\237\344\270\200\346\234\215\345\212\241\346\250\241\345\274\217\347\273\223\346\236\204\345\233\276.png" new file mode 100644 index 0000000000000000000000000000000000000000..838f9a4416d901eb29b5d203b559b3dcfe29fed9 Binary files /dev/null and "b/zh-cn/device-dev/driver/figures/DAC\347\273\237\344\270\200\346\234\215\345\212\241\346\250\241\345\274\217\347\273\223\346\236\204\345\233\276.png" differ