未验证 提交 0989d4e8 编写于 作者: K king_he 提交者: Gitee

update zh-cn/device-dev/driver/driver-platform-adc-develop.md.

Signed-off-by: Nking_he <6384784@qq.com>
上级 7966b04f
...@@ -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);
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册