“a5bdf942e5e15eacebda7ed0746815e685b50502”上不存在“...api-diff/monthly-202211/js-apidiff-file-management.md”
未验证 提交 149d393f 编写于 作者: O openharmony_ci 提交者: Gitee

!3967 【OpenHarmony开源贡献者计划2022】ADC&DAC相关格式及表达问题

Merge pull request !3967 from king_he/adc-1
# ADC<a name="1"></a> # ADC<a name="1"></a>
- [概述](#section1)
- [功能简介](#section2)
- [基本概念](#section3)
- [运作机制](#section4)
- [约束与限制](#section5)
- [使用指导](#section6)
- [场景介绍](#section7)
- [接口说明](#section8)
- [开发步骤](#section9)
- [使用实例](#section10)
## 概述<a name="section1"></a> ## 概述<a name="section1"></a>
### 功能简介<a name="section2"></a> ### 功能简介<a name="section2"></a>
- ADC(Analog to Digital Converter),即模拟-数字转换器,是一种将模拟信号转换成对应数字信号的设备。 ADC(Analog to Digital Converter),即模拟-数字转换器,是一种将模拟信号转换成对应数字信号的设备。
- ADC接口定义了完成ADC传输的通用方法集合,包括: ADC接口定义了完成ADC传输的通用方法集合,包括:
- ADC设备管理:打开或关闭ADC设备。 - ADC设备管理:打开或关闭ADC设备。
- ADC读取转换结果:读取AD转换结果。 - ADC读取转换结果:读取AD转换结果。
### 基本概念<a name="section3"></a> ### 基本概念<a name="section3"></a>
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
## 概述 ## 概述
ADC(Analog to Digital Converter),即模拟-数字转换器,是一种将模拟信号转换成对应数字信号的设备在HDF框架中,ADC模块接口适配模式采用统一服务模式,这需要一个设备服务来作为ADC模块的管理器,统一处理外部访问,这会在配置文件中有所体现。统一服务模式适合于同类型设备对象较多的情况,如ADC可能同时具备十几个控制器,采用独立服务模式需要配置更多的设备节点,且服务会占据内存资源。 ADC(Analog to Digital Converter),即模拟-数字转换器,是一种将模拟信号转换成对应数字信号的设备在HDF框架中,ADC模块接口适配模式采用统一服务模式,这需要一个设备服务来作为ADC模块的管理器,统一处理外部访问,这会在配置文件中有所体现。统一服务模式适合于同类型设备对象较多的情况,如ADC可能同时具备十几个控制器,采用独立服务模式需要配置更多的设备节点,且服务会占据内存资源。
**图1** ADC统一服务 **图1** ADC统一服务
...@@ -27,36 +27,36 @@ struct AdcMethod { ...@@ -27,36 +27,36 @@ struct AdcMethod {
| 函数成员 | 入参 | 出参 | 返回值 | 功能 | | 函数成员 | 入参 | 出参 | 返回值 | 功能 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| read | device:&nbsp;结构体指针,核心层ADC控制器;<br/>channel:uint32_t,传入的通道号; | val:uint32_t指针,要传出的信号数据; | HDF_STATUS相关状态 | 读取ADC采样的信号数据 | | read | device:结构体指针,核心层ADC控制器<br/>channel:uint32_t,传入的通道号 | val:uint32_t指针,要传出的信号数据 | HDF_STATUS相关状态 | 读取ADC采样的信号数据 |
| stop | device:&nbsp;结构体指针,核心层ADC控制器; | 无 | HDF_STATUS相关状态 | 关闭ADC设备 | | stop | device:结构体指针,核心层ADC控制器 | 无 | HDF_STATUS相关状态 | 关闭ADC设备 |
| start | device:&nbsp;结构体指针,核心层ADC控制器; | 无 | HDF_STATUS相关状态 | 开启ADC设备 | | start | device:结构体指针,核心层ADC控制器 | 无 | HDF_STATUS相关状态 | 开启ADC设备 |
## 开发步骤 ## 开发步骤
ADC模块适配的三个环节是配置属性文件,实例化驱动入口,以及实例化核心层接口函数。 ADC模块适配的三个环节是配置属性文件,实例化驱动入口,以及实例化核心层接口函数。
1. **实例化驱动入口:** 1. 实例化驱动入口:
- 实例化HdfDriverEntry结构体成员。 - 实例化HdfDriverEntry结构体成员。
- 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。 - 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
2. **配置属性文件:** 2. 配置属性文件:
- 在device_info.hcs文件中添加deviceNode描述。 - 在device_info.hcs文件中添加deviceNode描述。
- 【可选】添加adc_config.hcs器件属性文件。 - 【可选】添加adc_config.hcs器件属性文件。
3. **实例化ADC控制器对象:** 3. 实例化ADC控制器对象:
- 初始化AdcDevice成员。 - 初始化AdcDevice成员。
- 实例化AdcDevice成员AdcMethod。 - 实例化AdcDevice成员AdcMethod。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br>
> 实例化AdcDevice成员AdcMethod,其定义和成员说明见[接口说明](#接口说明)。 > 实例化AdcDevice成员AdcMethod,其定义和成员说明见[接口说明](#接口说明)。
4. **驱动调试:** 4. 驱动调试:
【可选】针对新增驱动程序,建议验证驱动基本功能,例如挂载后的信息反馈,信号采集的成功与否等。 【可选】针对新增驱动程序,建议验证驱动基本功能,例如挂载后的信息反馈,信号采集的成功与否等。
## 开发实例 ## 开发实例
接下来以 adc_hi35xx.c 为示例, 展示需要厂商提供哪些内容来完整实现设备功能。 接下来以adc_hi35xx.c为示例, 展示需要厂商提供哪些内容来完整实现设备功能。
1. 驱动开发首先需要实例化驱动入口,驱动入口必须为HdfDriverEntry(在 hdf_device_desc.h 中定义)类型的全局变量,且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总,形成一个类似数组的段地址空间,方便上层调用。 1. 驱动开发首先需要实例化驱动入口,驱动入口必须为HdfDriverEntry(在 hdf_device_desc.h 中定义)类型的全局变量,且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总,形成一个类似数组的段地址空间,方便上层调用。
一般在加载驱动时HDF会先调用Bind函数,再调用Init函数加载该驱动。当Init调用异常时,HDF框架会调用Release释放驱动资源并退出。 一般在加载驱动时HDF会先调用Bind函数,再调用Init函数加载该驱动。当Init调用异常时,HDF框架会调用Release释放驱动资源并退出。
...@@ -74,14 +74,14 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口, ...@@ -74,14 +74,14 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口,
.Release = Hi35xxAdcRelease, .Release = Hi35xxAdcRelease,
.moduleName = "hi35xx_adc_driver",//【必要且与HCS文件里面的名字匹配】 .moduleName = "hi35xx_adc_driver",//【必要且与HCS文件里面的名字匹配】
}; };
HDF_INIT(g_hi35xxAdcDriverEntry); //调用HDF_INIT将驱动入口注册到HDF框架中 HDF_INIT(g_hi35xxAdcDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中
//核心层adc_core.c管理器服务的驱动入口 // 核心层adc_core.c管理器服务的驱动入口
struct HdfDriverEntry g_adcManagerEntry = { struct HdfDriverEntry g_adcManagerEntry = {
.moduleVersion = 1, .moduleVersion = 1,
.Init = AdcManagerInit, .Init = AdcManagerInit,
.Release = AdcManagerRelease, .Release = AdcManagerRelease,
.moduleName = "HDF_PLATFORM_ADC_MANAGER",//这与device_info文件中device0对应 .moduleName = "HDF_PLATFORM_ADC_MANAGER",// 这与device_info文件中device0对应
}; };
HDF_INIT(g_adcManagerEntry); HDF_INIT(g_adcManagerEntry);
``` ```
...@@ -90,14 +90,14 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口, ...@@ -90,14 +90,14 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口,
统一服务模式的特点是device_info文件中第一个设备节点必须为ADC管理器,其各项参数必须如下设置: 统一服务模式的特点是device_info文件中第一个设备节点必须为ADC管理器,其各项参数必须如下设置:
| 成员名 | 值 | | 成员名 | 值 |
| -------- | -------- | | -------- | -------- |
| moduleName | 固定为&nbsp;HDF_PLATFORM_ADC_MANAGER | | moduleName | 固定为HDF_PLATFORM_ADC_MANAGER |
| serviceName | 无 | | serviceName | 无 |
| policy | 具体配置为0,不发布服务 | | policy | 具体配置为0,不发布服务 |
| deviceMatchAttr | 没有使用,可忽略 | | deviceMatchAttr | 没有使用,可忽略 |
从第二个节点开始配置具体ADC控制器信息,此节点并不表示某一路ADC控制器,而是代表一个资源性质设备,用于描述一类ADC控制器的信息。本例只有一个ADC设备,如有多个设备,则需要在device_info文件增加deviceNode信息,以及在adc_config文件中增加对应的器件属性。 从第二个节点开始配置具体ADC控制器信息,此节点并不表示某一路ADC控制器,而是代表一个资源性质设备,用于描述一类ADC控制器的信息。本例只有一个ADC设备,如有多个设备,则需要在device_info文件增加deviceNode信息,以及在adc_config文件中增加对应的器件属性。
- device_info.hcs 配置参考。 - device_info.hcs配置参考
``` ```
...@@ -125,7 +125,7 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口, ...@@ -125,7 +125,7 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口,
} }
} }
``` ```
- adc_config.hcs 配置参考。 - adc_config.hcs配置参考
``` ```
...@@ -134,13 +134,13 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口, ...@@ -134,13 +134,13 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口,
adc_config_hi35xx { adc_config_hi35xx {
match_attr = "hisilicon_hi35xx_adc"; match_attr = "hisilicon_hi35xx_adc";
template adc_device { template adc_device {
regBasePhy = 0x120e0000;//寄存器物理基地址 regBasePhy = 0x120e0000;// 寄存器物理基地址
regSize = 0x34; //寄存器位宽 regSize = 0x34; // 寄存器位宽
deviceNum = 0; //设备号 deviceNum = 0; // 设备号
validChannel = 0x1; //有效通道 validChannel = 0x1; // 有效通道
dataWidth = 10; //信号接收的数据位宽 dataWidth = 10; // 信号接收的数据位宽
scanMode = 1; //扫描模式 scanMode = 1; // 扫描模式
delta = 0; //delta参数 delta = 0; // delta参数
deglitch = 0; deglitch = 0;
glitchSample = 5000; glitchSample = 5000;
rate = 20000; rate = 20000;
...@@ -177,7 +177,7 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口, ...@@ -177,7 +177,7 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口,
uint32_t rate; //【必要】采样率 uint32_t rate; //【必要】采样率
}; };
//AdcDevice是核心层控制器结构体,其中的成员在Init函数中会被赋值 // AdcDevice是核心层控制器结构体,其中的成员在Init函数中会被赋值
struct AdcDevice { struct AdcDevice {
const struct AdcMethod *ops; const struct AdcMethod *ops;
OsalSpinlock spin; OsalSpinlock spin;
...@@ -202,18 +202,18 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口, ...@@ -202,18 +202,18 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口,
入参: 入参:
HdfDeviceObject是整个驱动对外暴露的接口参数,具备HCS配置文件的信息。 HdfDeviceObject是整个驱动对外暴露的接口参数,具备hcs配置文件的信息。
返回值: 返回值:
HDF_STATUS相关状态(下表为部分展示,如需使用其他状态,可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS 定义)。 HDF_STATUS相关状态(下表为部分展示,如需使用其他状态,可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS定义)。
| 状态(值) | 问题描述 | | 状态(值) | 问题描述 |
| -------- | -------- | | -------- | -------- |
| HDF_ERR_INVALID_OBJECT | 控制器对象非法 | | HDF_ERR_INVALID_OBJECT | 控制器对象非法 |
| HDF_ERR_INVALID_PARAM | 参数非法 | | HDF_ERR_INVALID_PARAM | 参数非法 |
| HDF_ERR_MALLOC_FAIL | 内存分配失败 | | HDF_ERR_MALLOC_FAIL | 内存分配失败 |
| HDF_ERR_IO | I/O&nbsp;错误 | | HDF_ERR_IO | I/O错误 |
| HDF_SUCCESS | 传输成功 | | HDF_SUCCESS | 传输成功 |
| HDF_FAILURE | 传输失败 | | HDF_FAILURE | 传输失败 |
...@@ -227,9 +227,9 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口, ...@@ -227,9 +227,9 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口,
int32_t ret; int32_t ret;
struct DeviceResourceNode *childNode = NULL; struct DeviceResourceNode *childNode = NULL;
... ...
//遍历、解析adc_config.hcs中的所有配置节点,并分别调用Hi35xxAdcParseInit函数来初始化device // 遍历、解析adc_config.hcs中的所有配置节点,并分别调用Hi35xxAdcParseInit函数来初始化device
DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) { DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) {
ret = Hi35xxAdcParseInit(device, childNode);//函数定义见下 ret = Hi35xxAdcParseInit(device, childNode);// 函数定义见下
... ...
} }
return ret; return ret;
...@@ -258,7 +258,7 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口, ...@@ -258,7 +258,7 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口,
return HDF_SUCCESS; return HDF_SUCCESS;
__ERR__: __ERR__:
if (hi35xx != NULL) { //不成功的话,需要反向执行初始化相关函数 if (hi35xx != NULL) { // 不成功的话,需要反向执行初始化相关函数
if (hi35xx->regBase != NULL) { if (hi35xx->regBase != NULL) {
OsalIoUnmap((void *)hi35xx->regBase); OsalIoUnmap((void *)hi35xx->regBase);
hi35xx->regBase = NULL; hi35xx->regBase = NULL;
...@@ -269,11 +269,11 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口, ...@@ -269,11 +269,11 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口,
return ret; return ret;
} }
``` ```
- Release 函数参考 - Release函数参考
入参: 入参:
HdfDeviceObject 是整个驱动对外暴露的接口参数,具备 HCS 配置文件的信息。 HdfDeviceObject是整个驱动对外暴露的接口参数,具备hcs配置文件的信息。
返回值: 返回值:
...@@ -281,7 +281,7 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口, ...@@ -281,7 +281,7 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口,
函数说明: 函数说明:
释放内存和删除控制器,该函数需要在驱动入口结构体中赋值给 Release 接口, 当HDF框架调用Init函数初始化驱动失败时,可以调用 Release 释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。 释放内存和删除控制器,该函数需要在驱动入口结构体中赋值给Release接口,当HDF框架调用Init函数初始化驱动失败时,可以调用Release释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
``` ```
...@@ -289,9 +289,9 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口, ...@@ -289,9 +289,9 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口,
{ {
const struct DeviceResourceNode *childNode = NULL; const struct DeviceResourceNode *childNode = NULL;
... ...
//遍历、解析adc_config.hcs中的所有配置节点,并分别进行release操作 // 遍历、解析adc_config.hcs中的所有配置节点,并分别进行release操作
DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) { DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) {
Hi35xxAdcRemoveByNode(childNode);//函数定义见下 Hi35xxAdcRemoveByNode(childNode);// 函数定义见下
} }
} }
...@@ -307,7 +307,7 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口, ...@@ -307,7 +307,7 @@ ADC模块适配的三个环节是配置属性文件,实例化驱动入口,
... ...
ret = drsOps->GetUint32(node, "deviceNum", (uint32_t *)&deviceNum, 0); ret = drsOps->GetUint32(node, "deviceNum", (uint32_t *)&deviceNum, 0);
... ...
//可以调用AdcDeviceGet函数通过设备的deviceNum获取AdcDevice对象, 以及调用AdcDeviceRemove函数来释放AdcDevice对象的内容 // 可以调用AdcDeviceGet函数通过设备的deviceNum获取AdcDevice对象,以及调用AdcDeviceRemove函数来释放AdcDevice对象的内容
device = AdcDeviceGet(deviceNum); device = AdcDeviceGet(deviceNum);
if (device != NULL && device->priv == node) { if (device != NULL && device->priv == node) {
AdcDevicePut(device); AdcDevicePut(device);
......
...@@ -5,11 +5,11 @@ ...@@ -5,11 +5,11 @@
### 功能简介 ### 功能简介
- DAC(Digital to Analog Converter)是一种通过电流、电压或电荷的形式将数字信号转换为模拟信号的设备 DAC(Digital to Analog Converter)是一种通过电流、电压或电荷的形式将数字信号转换为模拟信号的设备
- DAC接口定义了完成DAC传输的通用方法集合,包括: DAC接口定义了完成DAC传输的通用方法集合,包括:
- DAC设备管理:打开或关闭DAC设备。 - DAC设备管理:打开或关闭DAC设备。
- DAC设置目标值:设置DAC设备需要将数字信号转成模拟信号的目标值。 - DAC设置目标值:设置DAC设备需要将数字信号转成模拟信号的目标值。
### 基本概念 ### 基本概念
...@@ -31,7 +31,7 @@ DAC模块支持数模转换的开发,它主要用于: ...@@ -31,7 +31,7 @@ DAC模块支持数模转换的开发,它主要用于:
转换速度一般由建立时间决定。从输入由全0突变为全1时开始,到输出电压稳定在FSR±½LSB范围(或以FSR±x%FSR指明范围)内为止,这段时间称为建立时间,它是DAC的最大响应时间,所以用它衡量转换速度的快慢。 转换速度一般由建立时间决定。从输入由全0突变为全1时开始,到输出电压稳定在FSR±½LSB范围(或以FSR±x%FSR指明范围)内为止,这段时间称为建立时间,它是DAC的最大响应时间,所以用它衡量转换速度的快慢。
满量程范围FSR(Full Scale Range),是指DAC输出信号幅度的最大范围,不同的DAC有不同的满量程范围, 该范围可以用正、负电流或者正、负电压来限制 满量程范围FSR(Full Scale Range),是指DAC输出信号幅度的最大范围,不同的DAC有不同的满量程范围,该范围可以用正、负电流或者正、负电压来限制
最低有效位LSB(Least Significant Byte),指的是一个二进制数字中的第0位(即最低位)。 最低有效位LSB(Least Significant Byte),指的是一个二进制数字中的第0位(即最低位)。
...@@ -41,7 +41,7 @@ DAC模块支持数模转换的开发,它主要用于: ...@@ -41,7 +41,7 @@ DAC模块支持数模转换的开发,它主要用于:
DAC模块各分层的作用为:接口层提供打开设备,写入数据,关闭设备的接口。核心层主要提供绑定设备、初始化设备以及释放设备的能力。适配层实现其他具体的功能。 DAC模块各分层的作用为:接口层提供打开设备,写入数据,关闭设备的接口。核心层主要提供绑定设备、初始化设备以及释放设备的能力。适配层实现其他具体的功能。
![](../public_sys-resources/icon-note.gif) 说明:核心层可以调用接口层的函数,核心层通过钩子函数调用适配层函数,从而适配层间接的可以调用接口层函数,但是不可逆转接口层调用适配层函数。 ![](../public_sys-resources/icon-note.gif) 说明:<br>核心层可以调用接口层的函数,核心层通过钩子函数调用适配层函数,从而适配层间接的可以调用接口层函数,但是不可逆转接口层调用适配层函数。
**图 1** DAC统一服务模式 **图 1** DAC统一服务模式
...@@ -49,7 +49,7 @@ DAC模块各分层的作用为:接口层提供打开设备,写入数据, ...@@ -49,7 +49,7 @@ DAC模块各分层的作用为:接口层提供打开设备,写入数据,
### 约束与限制 ### 约束与限制
DAC模块当前仅支持轻量和小型系统内核(LiteOS) DAC模块当前仅支持轻量和小型系统内核(LiteOS)。
## 使用指导 ## 使用指导
...@@ -181,7 +181,7 @@ DAC设备的具体使用方式可以参考如下示例代码,示例代码步 ...@@ -181,7 +181,7 @@ DAC设备的具体使用方式可以参考如下示例代码,示例代码步
/* DAC例程总入口 */ /* DAC例程总入口 */
static int32_t TestCaseDac(void) static int32_t TestCaseDac(void)
{ {
//设置要写入的val值 // 设置要写入的val值
uint32_t val = 2; uint32_t val = 2;
int32_t ret; int32_t ret;
DevHandle dacHandle; DevHandle dacHandle;
......
...@@ -4,15 +4,15 @@ ...@@ -4,15 +4,15 @@
### 功能简介 ### 功能简介
DAC(Digital to Analog Converter)是一种通过电流、电压或电荷的形式将数字信号转换为模拟信号的设备 。 DAC(Digital to Analog Converter)是一种通过电流、电压或电荷的形式将数字信号转换为模拟信号的设备。
### 基本概念
DAC模块支持数模转换的开发。它主要用于: DAC模块支持数模转换的开发。它主要用于:
1. 作为过程控制计算机系统的输出通道,与执行器相连,实现对生产过程的自动控制。 1. 作为过程控制计算机系统的输出通道,与执行器相连,实现对生产过程的自动控制。
2. 在利用反馈技术的魔术转换器设计中,作为重要的功能模块呈现。 2. 在利用反馈技术的魔术转换器设计中,作为重要的功能模块呈现。
### 基本概念
- 分辨率 - 分辨率
分辨率指的是D/A转换器能够转换的二进制位数,位数越多分辨率越高。 分辨率指的是D/A转换器能够转换的二进制位数,位数越多分辨率越高。
...@@ -35,7 +35,7 @@ DAC模块支持数模转换的开发。它主要用于: ...@@ -35,7 +35,7 @@ DAC模块支持数模转换的开发。它主要用于:
DAC模块各分层的作用为:接口层提供打开设备,写入数据,关闭设备接口的能力。核心层主要提供绑定设备、初始化设备以及释放设备的能力。适配层实现其他具体的功能。 DAC模块各分层的作用为:接口层提供打开设备,写入数据,关闭设备接口的能力。核心层主要提供绑定设备、初始化设备以及释放设备的能力。适配层实现其他具体的功能。
![](../public_sys-resources/icon-note.gif) 说明:核心层可以调用接口层的函数,也可以通过钩子函数调用适配层函数,从而使得适配层间接的可以调用接口层函数,但是不可逆转接口层调用适配层函数。 ![](../public_sys-resources/icon-note.gif) 说明:<br>核心层可以调用接口层的函数,也可以通过钩子函数调用适配层函数,从而使得适配层间接的可以调用接口层函数,但是不可逆转接口层调用适配层函数。
**图 1** 统一服务模式 **图 1** 统一服务模式
...@@ -62,11 +62,11 @@ DacMethod定义: ...@@ -62,11 +62,11 @@ DacMethod定义:
``` ```
struct DacMethod { struct DacMethod {
//写入数据的钩子函数 // 写入数据的钩子函数
int32_t (*write)(struct DacDevice *device, uint32_t channel, uint32_t val); int32_t (*write)(struct DacDevice *device, uint32_t channel, uint32_t val);
//启动DAC设备的钩子函数 // 启动DAC设备的钩子函数
int32_t (*start)(struct DacDevice *device); int32_t (*start)(struct DacDevice *device);
//停止DAC设备的钩子函数 // 停止DAC设备的钩子函数
int32_t (*stop)(struct DacDevice *device); int32_t (*stop)(struct DacDevice *device);
}; };
``` ```
...@@ -77,9 +77,9 @@ struct DacMethod { ...@@ -77,9 +77,9 @@ struct DacMethod {
| 函数成员 | 入参 | 出参 | 返回值 | 功能 | | 函数成员 | 入参 | 出参 | 返回值 | 功能 |
| -------- | ------------------------------------------------------------ | ---- | ------------------ | -------------- | | -------- | ------------------------------------------------------------ | ---- | ------------------ | -------------- |
| write | device:结构体指针,核心层DAC控制器<br>channel:uint32_t,传入的通道号;<br>val:uint32_t,要传入的数据; | 无 | HDF_STATUS相关状态 | 写入DA的目标值 | | write | device:结构体指针,核心层DAC控制器<br>channel:uint32_t,传入的通道号<br>val:uint32_t,要传入的数据 | 无 | HDF_STATUS相关状态 | 写入DA的目标值 |
| start | device:结构体指针,核心层DAC控制器 | 无 | HDF_STATUS相关状态 | 开启DAC设备 | | start | device:结构体指针,核心层DAC控制器 | 无 | HDF_STATUS相关状态 | 开启DAC设备 |
| stop | device:结构体指针,核心层DAC控制器 | 无 | HDF_STATUS相关状态 | 关闭DAC设备 | | stop | device:结构体指针,核心层DAC控制器 | 无 | HDF_STATUS相关状态 | 关闭DAC设备 |
...@@ -92,7 +92,7 @@ DAC模块适配包含以下四个步骤: ...@@ -92,7 +92,7 @@ DAC模块适配包含以下四个步骤:
- 实例化核心层接口函数。 - 实例化核心层接口函数。
- 驱动调试。 - 驱动调试。
1. **实例化驱动入口:** 1. 实例化驱动入口:
驱动开发首先需要实例化驱动入口,驱动入口必须为HdfDriverEntry(在 hdf_device_desc.h 中定义)类型的全局变量,且moduleName要和device_info.hcs中保持一致。 HDF框架会汇总所有加载的驱动的HdfDriverEntry对象入口 ,形成一个类似数组的段地址空间,方便上层调用。 驱动开发首先需要实例化驱动入口,驱动入口必须为HdfDriverEntry(在 hdf_device_desc.h 中定义)类型的全局变量,且moduleName要和device_info.hcs中保持一致。 HDF框架会汇总所有加载的驱动的HdfDriverEntry对象入口 ,形成一个类似数组的段地址空间,方便上层调用。
...@@ -105,10 +105,10 @@ DAC模块适配包含以下四个步骤: ...@@ -105,10 +105,10 @@ DAC模块适配包含以下四个步骤:
.Release = VirtualDacRelease, .Release = VirtualDacRelease,
.moduleName = "virtual_dac_driver", //【必要且与 HCS 里面的名字匹配】 .moduleName = "virtual_dac_driver", //【必要且与 HCS 里面的名字匹配】
}; };
HDF_INIT(g_dacDriverEntry); //调用HDF_INIT将驱动入口注册到HDF框架中 HDF_INIT(g_dacDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中
``` ```
2. **配置属性文件:** 2. 配置属性文件:
- 在vendor/hisilicon/hispark_taurus/hdf_config/device_info/device_info.hcs文件中添加deviceNode描述。 - 在vendor/hisilicon/hispark_taurus/hdf_config/device_info/device_info.hcs文件中添加deviceNode描述。
...@@ -119,7 +119,7 @@ DAC模块适配包含以下四个步骤: ...@@ -119,7 +119,7 @@ DAC模块适配包含以下四个步骤:
| 成员名 | 值 | | 成员名 | 值 |
| --------------- | ------------------------------------------------------------ | | --------------- | ------------------------------------------------------------ |
| policy | 具体配置为0,不发布服务| | policy | 具体配置为0,不发布服务|
| priority | 驱动启动优先级(0-200),值越大优先级越低,,优先级相同则不保证device的加载顺序。| | priority | 驱动启动优先级(0-200),值越大优先级越低,优先级相同则不保证device的加载顺序。|
| permission | 驱动权限| | permission | 驱动权限|
| moduleName | 固定为HDF_PLATFORM_DAC_MANAGER| | moduleName | 固定为HDF_PLATFORM_DAC_MANAGER|
| serviceName | 固定为HDF_PLATFORM_DAC_MANAGER| | serviceName | 固定为HDF_PLATFORM_DAC_MANAGER|
...@@ -127,12 +127,12 @@ DAC模块适配包含以下四个步骤: ...@@ -127,12 +127,12 @@ DAC模块适配包含以下四个步骤:
从第二个节点开始配置具体DAC控制器信息,此节点并不表示某一路DAC控制器,而是代表一个资源性质设备,用于描述一类DAC控制器的信息。本例只有一个DAC设备,如有多个设备,则需要在device_info文件增加deviceNode信息,以及在dac_config文件中增加对应的器件属性。 从第二个节点开始配置具体DAC控制器信息,此节点并不表示某一路DAC控制器,而是代表一个资源性质设备,用于描述一类DAC控制器的信息。本例只有一个DAC设备,如有多个设备,则需要在device_info文件增加deviceNode信息,以及在dac_config文件中增加对应的器件属性。
device_info.hcs 配置参考。 device_info.hcs配置参考。
``` ```
root { root {
device_dac :: device { device_dac :: device {
//device0是DAC管理器 // device0是DAC管理器
device0 :: deviceNode { device0 :: deviceNode {
policy = 0; policy = 0;
priority = 52; priority = 52;
...@@ -141,7 +141,7 @@ DAC模块适配包含以下四个步骤: ...@@ -141,7 +141,7 @@ DAC模块适配包含以下四个步骤:
moduleName = "HDF_PLATFORM_DAC_MANAGER"; moduleName = "HDF_PLATFORM_DAC_MANAGER";
} }
} }
//dac_virtual是DAC控制器 // dac_virtual是DAC控制器
dac_virtual :: deviceNode { dac_virtual :: deviceNode {
policy = 0; policy = 0;
priority = 56; priority = 56;
...@@ -154,7 +154,7 @@ DAC模块适配包含以下四个步骤: ...@@ -154,7 +154,7 @@ DAC模块适配包含以下四个步骤:
``` ```
- 添加dac_test_config.hcs器件属性文件 - 添加dac_test_config.hcs器件属性文件
在vendor/vendor_hisilicon/hispark_taurus/hdf_config/hdf_test/xxx_test_config.hcs目录下新增文件用于驱动配置参数,(例如:vendor/vendor_hisilicon/hispark_taurus/hdf_config/hdf_test/dac_test_config.hcs)其中配置参数如下 在vendor/vendor_hisilicon/hispark_taurus/hdf_config/hdf_test/xxx_test_config.hcs目录下新增文件用于驱动配置参数,(例如:vendor/vendor_hisilicon/hispark_taurus/hdf_config/hdf_test/dac_test_config.hcs)其中配置参数如下
``` ```
root { root {
...@@ -162,79 +162,79 @@ DAC模块适配包含以下四个步骤: ...@@ -162,79 +162,79 @@ DAC模块适配包含以下四个步骤:
dac_config { dac_config {
match_attr = "virtual_dac"; //【必要】需要和device_info.hcs中的deviceMatchAttr值一致 match_attr = "virtual_dac"; //【必要】需要和device_info.hcs中的deviceMatchAttr值一致
template dac_device { template dac_device {
deviceNum = 0; //设备号 deviceNum = 0; // 设备号
validChannel = 0x1; //有效通道1 validChannel = 0x1; // 有效通道1
rate = 20000; //速率 rate = 20000; // 速率
} }
device_0 :: dac_device { device_0 :: dac_device {
deviceNum = 0; //设备号 deviceNum = 0; // 设备号
validChannel = 0x2; //有效通道2 validChannel = 0x2; // 有效通道2
} }
} }
} }
} }
``` ```
3. **实例化核心层接口函数:** 3. 实例化核心层接口函数:
- 初始化DacDevice成员。 - 初始化DacDevice成员。
在VirtualDacParseAndInit函数中对DacDevice成员进行初始化操作。 在VirtualDacParseAndInit函数中对DacDevice成员进行初始化操作。
``` ```
//虚拟驱动自定义结构体 // 虚拟驱动自定义结构体
struct VirtualDacDevice { struct VirtualDacDevice {
//DAC设备结构体 // DAC设备结构体
struct DacDevice device; struct DacDevice device;
//DAC设备号 // DAC设备号
uint32_t deviceNum; uint32_t deviceNum;
//有效通道 // 有效通道
uint32_t validChannel; uint32_t validChannel;
//DAC速率 // DAC速率
uint32_t rate; uint32_t rate;
}; };
//解析并且初始化核心层DacDevice对象 // 解析并且初始化核心层DacDevice对象
static int32_t VirtualDacParseAndInit(struct HdfDeviceObject *device, const struct DeviceResourceNode *node) static int32_t VirtualDacParseAndInit(struct HdfDeviceObject *device, const struct DeviceResourceNode *node)
{ {
//定义返回值 // 定义返回值
int32_t ret; int32_t ret;
//DAC设备虚拟指针 // DAC设备虚拟指针
struct VirtualDacDevice *virtual = NULL; struct VirtualDacDevice *virtual = NULL;
(void)device; (void)device;
//给virtual指针开辟空间 // 给virtual指针开辟空间
virtual = (struct VirtualDacDevice *)OsalMemCalloc(sizeof(*virtual)); virtual = (struct VirtualDacDevice *)OsalMemCalloc(sizeof(*virtual));
if (virtual == NULL) { if (virtual == NULL) {
//为空则返回错误参数 // 为空则返回错误参数
HDF_LOGE("%s: Malloc virtual fail!", __func__); HDF_LOGE("%s: Malloc virtual fail!", __func__);
return HDF_ERR_MALLOC_FAIL; return HDF_ERR_MALLOC_FAIL;
} }
//读取属性文件配置参数 // 读取属性文件配置参数
ret = VirtualDacReadDrs(virtual, node); ret = VirtualDacReadDrs(virtual, node);
if (ret != HDF_SUCCESS) { if (ret != HDF_SUCCESS) {
//读取失败 // 读取失败
HDF_LOGE("%s: Read drs fail! ret:%d", __func__, ret); HDF_LOGE("%s: Read drs fail! ret:%d", __func__, ret);
//释放virtual空间 // 释放virtual空间
OsalMemFree(virtual); OsalMemFree(virtual);
//指针置为0 // 指针置为0
virtual = NULL; virtual = NULL;
return ret; return ret;
} }
//初始化虚拟指针 // 初始化虚拟指针
VirtualDacDeviceInit(virtual); VirtualDacDeviceInit(virtual);
//对DacDevice中priv对象初始化 // 对DacDevice中priv对象初始化
virtual->device.priv = (void *)node; virtual->device.priv = (void *)node;
//对DacDevice中devNum对象初始化 // 对DacDevice中devNum对象初始化
virtual->device.devNum = virtual->deviceNum; virtual->device.devNum = virtual->deviceNum;
//对DacDevice中ops对象初始化 // 对DacDevice中ops对象初始化
virtual->device.ops = &g_method; virtual->device.ops = &g_method;
//添加DAC设备 // 添加DAC设备
ret = DacDeviceAdd(&virtual->device); ret = DacDeviceAdd(&virtual->device);
if (ret != HDF_SUCCESS) { if (ret != HDF_SUCCESS) {
//添加设备失败 // 添加设备失败
HDF_LOGE("%s: add Dac controller failed! ret = %d", __func__, ret); HDF_LOGE("%s: add Dac controller failed! ret = %d", __func__, ret);
//释放virtual空间 // 释放virtual空间
OsalMemFree(virtual); OsalMemFree(virtual);
//虚拟指针置空 // 虚拟指针置空
virtual = NULL; virtual = NULL;
return ret; return ret;
} }
...@@ -257,12 +257,12 @@ DAC模块适配包含以下四个步骤: ...@@ -257,12 +257,12 @@ DAC模块适配包含以下四个步骤:
uint32_t rate; //【必要】采样率 uint32_t rate; //【必要】采样率
}; };
//DacDevice是核心层控制器结构体,其中的成员在Init函数中会被赋值 // DacDevice是核心层控制器结构体,其中的成员在Init函数中会被赋值
struct DacDevice { struct DacDevice {
const struct DacMethod *ops; const struct DacMethod *ops;
OsalSpinlock spin; //自旋锁 OsalSpinlock spin; // 自旋锁
uint32_t devNum; //设备号 uint32_t devNum; // 设备号
uint32_t chanNum; //设备通道号 uint32_t chanNum; // 设备通道号
const struct DacLockMethod *lockOps; const struct DacLockMethod *lockOps;
void *priv; void *priv;
}; };
...@@ -275,13 +275,13 @@ DAC模块适配包含以下四个步骤: ...@@ -275,13 +275,13 @@ DAC模块适配包含以下四个步骤:
``` ```
static const struct DacMethod g_method = { static const struct DacMethod g_method = {
.write = VirtualDacWrite, //DAC设备写入值 .write = VirtualDacWrite, // DAC设备写入值
.stop = VirtualDacStop, //停止DAC设备 .stop = VirtualDacStop, // 停止DAC设备
.start = VirtualDacStart, //开始启动DAC设备 .start = VirtualDacStart, // 开始启动DAC设备
}; };
``` ```
![](../public_sys-resources/icon-note.gif) **说明:** ![](../public_sys-resources/icon-note.gif) **说明:**<br>
DacDevice成员DacMethod的定义和成员说明见[接口说明](#接口说明)。 DacDevice成员DacMethod的定义和成员说明见[接口说明](#接口说明)。
...@@ -289,7 +289,7 @@ DAC模块适配包含以下四个步骤: ...@@ -289,7 +289,7 @@ DAC模块适配包含以下四个步骤:
入参: 入参:
HdfDeviceObject这个是整个驱动对外暴露的接口参数,具备HCS配置文件的信息。 HdfDeviceObject这个是整个驱动对外暴露的接口参数,具备hcs配置文件的信息。
返回值: 返回值:
...@@ -386,11 +386,11 @@ DAC模块适配包含以下四个步骤: ...@@ -386,11 +386,11 @@ DAC模块适配包含以下四个步骤:
} }
``` ```
- Release 函数参考 - Release函数参考
入参: 入参:
HdfDeviceObject是整个驱动对外暴露的接口参数,具备HCS配置文件的信息。 HdfDeviceObject是整个驱动对外暴露的接口参数,具备hcs配置文件的信息。
返回值: 返回值:
...@@ -461,7 +461,7 @@ DAC模块适配包含以下四个步骤: ...@@ -461,7 +461,7 @@ DAC模块适配包含以下四个步骤:
} }
``` ```
4. **驱动调试:** 4. 驱动调试:
【可选】针对新增驱动程序,建议验证驱动基本功能,例如挂载后的测试用例是否成功等。 【可选】针对新增驱动程序,建议验证驱动基本功能,例如挂载后的测试用例是否成功等。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册