1# ADC<a name="1"></a>
2
3## 概述<a name="section1"></a>
4
5### 功能简介<a name="section2"></a>
6
7ADC（Analog to Digital Converter），即模拟-数字转换器，可将模拟信号转换成对应的数字信号，便于存储与计算等操作。除电源线和地线之外，ADC只需要1根线与被测量的设备进行连接，其物理连线如图1所示：
8
9**图 1**  ADC物理连线示意图<a name="fig1"></a>
10![ADC物理连线示意图](figures/ADC物理连线示意图.png)
11
12ADC接口定义了完成AD转换的通用方法集合，包括：
13
14-  ADC设备管理：打开或关闭ADC设备。
15
16-  ADC读取转换结果：读取AD转换结果。
17
18### 基本概念<a name="section3"></a>
19
20- 分辨率
21
22    分辨率指的是ADC模块能够转换的二进制位数，位数越多分辨率越高。
23
24- 转换误差
25
26    转换误差通常是以输出误差的最大值形式给出。它表示A/D转换器实际输出的数字量和理论上的输出数字量之间的差别。常用最低有效位的倍数表示。
27
28- 转换时间
29
30    转换时间是指A/D转换器从转换控制信号到来开始，到输出端得到稳定的数字信号所经过的时间。
31
32### 运作机制<a name="section4"></a>
33
34在HDF框架中，同类型设备对象较多时（可能同时存在十几个同类型配置器），如果采用独立服务模式则需要配置更多的设备节点，且相关服务会占据更多的内存资源。相反，采用统一服务模式可以使用一个设备服务作为管理器，统一处理所有同类型对象的外部访问（这会在配置文件中有所体现），实现便捷管理和节约资源的目的。ADC模块接口适配模式采用统一服务模式。
35
36### 约束与限制<a name="section5"></a>
37
38ADC模块仅支持轮询方式读取数据。
39
40## 使用指导<a name="section6"></a>
41
42### 场景介绍<a name="section7"></a>
43
44ADC设备通常用于将模拟电压或电流转换为数字量，例如与NTC电阻搭配进行温度测量，或者将其他模拟传感器的输出量转换为数字量的场景。
45
46### 接口说明<a name="section8"></a>
47
48ADC模块提供的主要接口如表1所示，具体API详见//drivers/hdf_core/framework/include/platform/adc_if.h。
49
50**表 1**  ADC驱动API接口功能介绍
51
52<a name="table1"></a>
53
54| 接口名 | 接口描述 |
55| -------- | ---------------- |
56| DevHandle AdcOpen(uint32_t number)  | 打开ADC设备 |
57| void AdcClose(DevHandle handle) | 关闭ADC设备 |
58| int32_t AdcRead(DevHandle handle, uint32_t channel, uint32_t \*val) | 读取AD转换结果值 |
59
60### 开发步骤<a name="section9"></a>
61
62使用ADC设备的一般流程如图2所示。
63
64**图 2**  ADC使用流程图<a name="fig2"></a>
65![ADC使用流程图](figures/ADC使用流程图.png)
66
67
68#### 打开ADC设备
69
70在进行AD转换之前，首先要调用AdcOpen打开ADC设备。
71
72```c
73DevHandle AdcOpen(int16_t number);
74```
75
76**表 2**  AdcOpen参数和返回值描述
77
78<a name="table2"></a>
79
80| 参数 | 参数描述 |
81| ---------- | ----------------- |
82| number | int16_t类型，ADC设备号 |
83| **返回值** | **返回值描述** |
84| NULL | 打开ADC设备失败 |
85| 设备句柄 | 打开的ADC设备句柄 |
86
87假设系统中存在2个ADC设备，编号从0到1，那么我们现在打开1号设备。
88
89```c
90DevHandle adcHandle = NULL;  // ADC设备句柄
91
92// 打开ADC设备
93adcHandle = AdcOpen(1);
94if (adcHandle == NULL) {
95    HDF_LOGE("AdcOpen: fail\n");
96    return NULL;
97}
98```
99
100#### 读取AD转换结果
101
102```c
103int32_t AdcRead(DevHandle handle, uint32_t channel, uint32_t *val);
104```
105
106**表 3**  AdcRead参数和返回值描述
107
108<a name="table3"></a>
109
110| 参数 | 参数描述 |
111| ---------- | -------------- |
112| handle | DevHandle类型，ADC设备句柄 |
113| channel| uint32_t类型，ADC设备通道号 |
114| val | uint32_t类型指针，AD转换结果 |
115| **返回值** | **返回值描述** |
116| HDF_SUCCESS | 读取成功 |
117| 负数 | 读取失败 |
118
119读取转换结果示例（以通道1为例）：
120
121```c
122uint32_t value;
123int32_t ret;
124
125ret = AdcRead(adcHandle, 1, &value);
126if (ret != HDF_SUCCESS) {
127    HDF_LOGE("ADC read fail!\n");
128    return ret;
129}
130```
131
132#### 关闭ADC设备
133
134ADC通信完成之后，需要关闭ADC设备。
135```c
136void AdcClose(DevHandle handle);
137```
138**表 4**  AdcClose参数和返回值描述
139
140<a name="table4"></a>
141
142| 参数 | 参数描述 |
143| ------ | ----------- |
144| handle | DevHandle类型，ADC设备句柄 |
145| 返回值 | 返回值描述  |
146| 无 | 无 |
147
148关闭ADC设备示例：
149
150```c
151AdcClose(adcHandle); // 关闭ADC设备
152```
153
154### 使用实例<a name="section10"></a>
155
156本例拟对Hi3516DV300开发板上ADC设备进行简单的读取操作，基本硬件信息如下：
157
158-   SOC：hi3516dv300。
159
160-   硬件连接：电位器挂接在0号ADC设备1通道下。
161
162本例程对测试ADC进行连续读取操作，测试ADC功能是否正常。
163
164示例如下：
165
166```c
167#include "adc_if.h"          // ADC标准接口头文件
168#include "hdf_log.h"         // 标准日志打印头文件
169
170/// 设备号0，通道号1
171#define ADC_DEVICE_NUM  0
172#define ADC_CHANNEL_NUM 1
173#define ADC_TEST_NUM    30
174
175// ADC例程总入口
176static int32_t TestCaseAdc(void)
177{
178    int32_t i;
179    int32_t ret;
180    DevHandle adcHandle = NULL;
181    uint32_t readBuf[ADC_TEST_NUM] = {0};
182
183    // 打开ADC设备
184    adcHandle = AdcOpen(ADC_DEVICE_NUM);
185    if (adcHandle == NULL) {
186        HDF_LOGE("%s: Open ADC%u fail!", __func__, ADC_DEVICE_NUM);
187        return -1;
188    }
189
190    // 连续进行30次AD转换并读取转换结果
191    for (i = 0; i < ADC_TEST_NUM; i++) {
192        ret = AdcRead(adcHandle, ADC_CHANNEL_NUM, &readBuf[i]);
193        if (ret != HDF_SUCCESS) {
194            HDF_LOGE("%s: ADC read fail!:%d", __func__, ret);
195            AdcClose(adcHandle);
196            return -1;
197        }
198    }
199    HDF_LOGI("%s: ADC read successful!", __func__);
200
201    // 访问完毕关闭ADC设备
202    AdcClose(adcHandle);
203
204    return 0;
205}
206```
207