1# ADC 2 3## 概述 4 5### 功能简介<a name="section2"></a> 6 7ADC（Analog to Digital Converter），即模拟-数字转换器，是一种将模拟信号转换成对应数字信号的设备。 8 9### 基本概念<a name="section3"></a> 10 11- 分辨率 12 13 分辨率指的是ADC模块能够转换的二进制位数，位数越多分辨率越高。 14 15- 转换误差 16 17 转换误差通常是以输出误差的最大值形式给出。它表示A/D转换器实际输出的数字量和理论上的输出数字量之间的差别。常用最低有效位的倍数表示。 18 19- 转换时间 20 21 转换时间是指A/D转换器从转换控制信号到来开始，到输出端得到稳定的数字信号所经过的时间。 22 23 24### 运作机制 25 26在HDF框架中，同类型设备对象较多时（可能同时存在十几个同类型配置器），若采用独立服务模式，则需要配置更多的设备节点，且相关服务会占据更多的内存资源。相反，采用统一服务模式可以使用一个设备服务作为管理器，统一处理所有同类型对象的外部访问（这会在配置文件中有所体现），实现便捷管理和节约资源的目的。ADC模块即采用统一服务模式（如图1）。 27 28ADC模块各分层的作用为： 29 30- 接口层：提供打开设备，写入数据，关闭设备的能力。 31- 核心层：主要负责服务绑定、初始化以及释放管理器，并提供添加、删除以及获取控制器的能力。 32- 适配层：由驱动适配者实现与硬件相关的具体功能，如控制器的初始化等。 33 34在统一模式下，所有的控制器都被核心层统一管理，并由核心层统一发布一个服务供接口层，因此这种模式下驱动无需再为每个控制器发布服务。 35 36**图1** ADC统一服务模式结构图<a name="fig1"></a> 37 38 39## 使用指导 40 41### 场景介绍 42 43ADC设备通常用于将模拟电压转换为数字量，例如与NTC电阻搭配进行温度测量，或者将其他模拟传感器的输出量转换为数字量的场景。当驱动开发者需要将ADC设备适配到OpenHarmony时，需要进行ADC驱动适配，下文将介绍如何进行ADC驱动适配。 44 45### 接口说明 46 47为了保证上层在调用ADC接口时能够正确的操作硬件，核心层在//drivers/hdf_core/framework/support/platform/include/adc/adc_core.h中定义了以下钩子函数。驱动适配者需要在适配层实现这些函数的具体功能，并与这些钩子函数挂接，从而完成接口层与核心层的交互。 48 49AdcMethod和AdcLockMethod定义： 50 51```c 52struct AdcMethod { 53 int32_t (*read)(struct AdcDevice *device, uint32_t channel, uint32_t *val); 54 int32_t (*start)(struct AdcDevice *device); 55 int32_t (*stop)(struct AdcDevice *device); 56}; 57 58struct AdcLockMethod { 59 int32_t (*lock)(struct AdcDevice *device); 60 void (*unlock)(struct AdcDevice *device); 61}; 62 63``` 64 65在适配层中，AdcMethod必须被实现，AdcLockMethod可根据实际情况考虑是否实现。核心层提供了默认的AdcLockMethod，其中使用Spinlock作为保护临界区的锁： 66 67```c 68static int32_t AdcDeviceLockDefault(struct AdcDevice *device) 69{ 70 if (device == NULL) { 71 return HDF_ERR_INVALID_OBJECT; 72 } 73 return OsalSpinLock(&device->spin); 74} 75 76static void AdcDeviceUnlockDefault(struct AdcDevice *device) 77{ 78 if (device == NULL) { 79 return; 80 } 81 (void)OsalSpinUnlock(&device->spin); 82} 83 84static const struct AdcLockMethod g_adcLockOpsDefault = { 85 .lock = AdcDeviceLockDefault, 86 .unlock = AdcDeviceUnlockDefault, 87}; 88 89``` 90 91若实际情况不允许使用Spinlock，驱动适配者可以考虑使用其他类型的锁来实现一个自定义的AdcLockMethod。一旦实现了自定义的AdcLockMethod，默认的AdcLockMethod将被覆盖。 92 93 **表1** AdcMethod结构体成员的钩子函数功能说明 94 95| 函数成员 | 入参 | 出参 | 返回值 | 功能 | 96| -------- | -------- | -------- | -------- | -------- | 97| read | device：结构体指针，核心层ADC控制器<br/>channel：uint32_t，传入的通道号 | val：uint32_t指针，要传出的信号数据 | HDF_STATUS相关状态 | 读取ADC采样的信号数据 | 98| stop | device：结构体指针，核心层ADC控制器 | 无 | HDF_STATUS相关状态 | 关闭ADC设备 | 99| start | device：结构体指针，核心层ADC控制器 | 无 | HDF_STATUS相关状态 | 开启ADC设备 | 100 101**表2** AdcLockMethod结构体成员函数功能说明 102 103| 函数成员 | 入参 | 出参 | 返回值 | 功能 | 104| -------- | -------- | -------- | -------- | -------- | 105| lock | device：结构体指针，核心层ADC设备对象。 | 无 | HDF_STATUS相关状态 | 获取临界区锁 | 106| unlock | devicie：结构体指针，核心层ADC设备对象。 | 无 | HDF_STATUS相关状态 | 释放临界区锁 | 107 108### 开发步骤 109 110ADC模块适配必选的三个环节是实例化驱动入口，配置属性文件，以及实例化核心层接口函数。 111 1121. 实例化驱动入口 113 - 实例化HdfDriverEntry结构体成员。 114 - 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。 115 1162. 配置属性文件 117 - 在device_info.hcs文件中添加deviceNode描述。 118 - 【可选】添加adc_config.hcs器件属性文件。 119 1203. 实例化核心层接口函数 121 - 初始化AdcDevice成员。 122 - 实例化AdcDevice成员AdcMethod。 123 >  **说明：**<br> 124 > 实例化AdcDevice成员AdcMethod，其定义和成员说明见[接口说明](#接口说明)。 125 126### 开发实例 127 128 接下来以Hi3516DV300的驱动//device/soc/hisilicon/common/platform/adc/adc_hi35xx.c为例， 展示需要驱动适配者提供哪些内容来完整实现设备功能。 129 1301. 驱动开发首先需要实例化驱动入口。 131 132 驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。 133 134 一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。 135 136 ADC驱动入口参考： 137 138 ADC控制器会出现多个设备挂接的情况，因而在HDF框架中首先会为此类型的设备创建一个管理器对象。这样，需要打开某个设备时，管理器对象会根据指定参数查找到指定设备。 139 140 ADC管理器的驱动由核心层实现，驱动适配者不需要关注这部分内容的实现，但在实现Init函数的时候需要调用核心层的AdcDeviceAdd函数，它会实现相应功能。 141 142 ```c 143 static struct HdfDriverEntry g_hi35xxAdcDriverEntry = { 144 .moduleVersion = 1, 145 .Init = Hi35xxAdcInit, 146 .Release = Hi35xxAdcRelease, 147 .moduleName = "hi35xx_adc_driver", //【必要且与device_info.hcs文件内的模块名匹配】 148 }; 149 HDF_INIT(g_hi35xxAdcDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中 150 151 /* 核心层adc_core.c管理器服务的驱动入口 */ 152 struct HdfDriverEntry g_adcManagerEntry = { 153 .moduleVersion = 1, 154 .Init = AdcManagerInit, 155 .Release = AdcManagerRelease, 156 .moduleName = "HDF_PLATFORM_ADC_MANAGER", // 这与device_info.hcs文件中device0对应 157 }; 158 HDF_INIT(g_adcManagerEntry); 159 ``` 160 1612. 完成驱动入口注册之后，下一步请在//vendor/hisilicon/hispark_taurus/hdf_config/device_info/device_info.hcs文件中添加deviceNode信息，并在adc_config.hcs中配置器件属性。 162 163 deviceNode信息与驱动入口注册相关，器件属性值对于驱动适配者的驱动实现以及核心层AdcDevice相关成员的默认值或限制范围有密切关系。 164 165 统一服务模式的特点是device_info.hcs文件中第一个设备节点必须为ADC管理器，其各项参数必须如下设置： 166 167 | 成员名 | 值 | 168 | -------- | -------- | 169 | moduleName | 固定为HDF_PLATFORM_ADC_MANAGER | 170 | serviceName | 无 | 171 | policy | 具体配置为0，不发布服务 | 172 | deviceMatchAttr | 没有使用，可忽略 | 173 174 从第二个节点开始配置具体ADC控制器信息，第一个节点并不表示某一路ADC控制器，而是代表一个资源性质设备，用于描述一类ADC控制器的信息。本例只有一个ADC设备，如有多个设备，则需要在device_info.hcs文件增加deviceNode信息，以及在adc_config文件中增加对应的器件属性。 175 176 - device_info.hcs配置参考 177 178 ```c 179 root { 180 device_info { 181 platform :: host { 182 device_adc :: device { 183 device0 :: deviceNode { 184 policy = 0; 185 priority = 50; 186 permission = 0644; 187 moduleName = "HDF_PLATFORM_ADC_MANAGER"; 188 serviceName = "HDF_PLATFORM_ADC_MANAGER"; 189 } 190 device1 :: deviceNode { 191 policy = 0; // 等于0，不需要发布服务。 192 priority = 55; // 驱动启动优先级。 193 permission = 0644; // 驱动创建设备节点权限。 194 moduleName = "hi35xx_adc_driver"; //【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致。 195 serviceName = "HI35XX_ADC_DRIVER"; //【必要】驱动对外发布服务的名称，必须唯一。 196 deviceMatchAttr = "hisilicon_hi35xx_adc"; //【必要】用于配置控制器私有数据，要与adc_config.hcs中对应控制器保持一致， 197 // 具体的控制器信息在adc_config.hcs中。 198 } 199 } 200 } 201 } 202 } 203 ``` 204 205 - adc_config.hcs配置参考 206 207 此处以Hi3516DV300为例，给出HCS配置参考。其中部分字段为Hi3516DV300特有功能，驱动适配者可根据需要进行删除或添加字段。 208 209 ```c 210 root { 211 platform { 212 adc_config_hi35xx { 213 match_attr = "hisilicon_hi35xx_adc"; 214 template adc_device { 215 regBasePhy = 0x120e0000; // 寄存器物理基地址 216 regSize = 0x34; // 寄存器位宽 217 deviceNum = 0; // 设备号 218 validChannel = 0x1; // 有效通道 219 dataWidth = 10; // AD转换后的数据位宽，即分辨率 220 scanMode = 1; // 扫描模式 221 delta = 0; // 转换结果误差范围 222 deglitch = 0; // 滤毛刺开关 223 glitchSample = 5000; // 滤毛刺时间窗口 224 rate = 20000; // 转换速率 225 } 226 device_0 :: adc_device { 227 deviceNum = 0; 228 validChannel = 0x2; 229 } 230 } 231 } 232 } 233 ``` 234 235 需要注意的是，新增adc_config.hcs配置文件后，必须在hdf.hcs文件中将其包含，否则配置文件无法生效。 236 237 例如：本例中adc_config.hcs所在路径为//device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/adc/adc_config.hcs，则必须在产品对应的hdf.hcs中添加如下语句： 238 239 ```c 240 #include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/adc/adc_config.hcs" // 配置文件相对路径 241 ``` 242 243 本例基于Hi3516DV300开发板的小型系统LiteOS内核运行，对应的hdf.hcs文件路径为vendor/hisilicon/hispark_taurus/hdf_config/hdf.hcs以及//device/hisilicon/hispark_taurus/sdk_liteos/hdf_config/hdf.hcs。驱动适配者需根据实际情况选择对应路径下的文件进行修改。 244 2453. 完成驱动入口注册之后，下一步就是以核心层AdcDevice对象的初始化为核心，包括初始化驱动适配者自定义结构体（传递参数和数据），实例化AdcDevice成员AdcMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。 246 247 - 自定义结构体参考。 248 249 从驱动的角度看，自定义结构体是参数和数据的载体，而且adc_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，其中一些重要数值（例如设备号、总线号等）也会传递给核心层AdcDevice对象。 250 251 ```c 252 struct Hi35xxAdcDevice { 253 struct AdcDevice device; //【必要】是核心层控制对象，必须作为自定义结构体的首个成员，其具体描述见下方。 254 volatile unsigned char *regBase; //【必要】寄存器基地址 255 volatile unsigned char *pinCtrlBase; 256 uint32_t regBasePhy; //【必要】寄存器物理基地址 257 uint32_t regSize; //【必要】寄存器位宽 258 uint32_t deviceNum; //【必要】设备号 259 uint32_t dataWidth; //【必要】信号接收的数据位宽 260 uint32_t validChannel; //【必要】有效通道 261 uint32_t scanMode; //【必要】扫描模式 262 uint32_t delta; 263 uint32_t deglitch; 264 uint32_t glitchSample; 265 uint32_t rate; //【必要】采样率 266 }; 267 268 /* AdcDevice是核心层控制器结构体，其中的成员在Init函数中会被赋值。*/ 269 struct AdcDevice { 270 const struct AdcMethod *ops; 271 OsalSpinlock spin; 272 uint32_t devNum; 273 uint32_t chanNum; 274 const struct AdcLockMethod *lockOps; 275 void *priv; 276 }; 277 ``` 278 279 - AdcDevice成员钩子函数结构体AdcMethod的实例化。 280 281 AdcLockMethod钩子函数结构体本例未实现，若要实例化，可参考I2C驱动开发，其他成员在Init函数中初始化。 282 283 ```c 284 static const struct AdcMethod g_method = { 285 .read = Hi35xxAdcRead, 286 .stop = Hi35xxAdcStop, 287 .start = Hi35xxAdcStart, 288 }; 289 ``` 290 291 - Init函数开发参考 292 293 入参： 294 295 HdfDeviceObject是整个驱动对外提供的接口参数，具备HCS配置文件的信息。 296 297 返回值： 298 299 HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 300 301 | 状态(值) | 问题描述 | 302 | -------- | -------- | 303 | HDF_ERR_INVALID_OBJECT | 控制器对象非法 | 304 | HDF_ERR_INVALID_PARAM | 参数非法 | 305 | HDF_ERR_MALLOC_FAIL | 内存分配失败 | 306 | HDF_ERR_IO | I/O错误 | 307 | HDF_SUCCESS | 传输成功 | 308 | HDF_FAILURE | 传输失败 | 309 310 函数说明： 311 312 初始化自定义结构体对象，初始化AdcDevice成员，并调用核心层AdcDeviceAdd函数。 313 314 ```c 315 static int32_t Hi35xxAdcInit(struct HdfDeviceObject *device) 316 { 317 int32_t ret; 318 struct DeviceResourceNode *childNode = NULL; 319 ... 320 /* 遍历、解析adc_config.hcs中的所有配置节点，并分别调用Hi35xxAdcParseInit函数来初始化device。*/ 321 DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) { 322 ret = Hi35xxAdcParseInit(device, childNode); // 函数定义见下方 323 ... 324 } 325 return ret; 326 } 327 328 static int32_t Hi35xxAdcParseInit(struct HdfDeviceObject *device, struct DeviceResourceNode *node) 329 { 330 int32_t ret; 331 struct Hi35xxAdcDevice *hi35xx = NULL; //【必要】自定义结构体对象 332 (void)device; 333 334 hi35xx = (struct Hi35xxAdcDevice *)OsalMemCalloc(sizeof(*hi35xx)); //【必要】内存分配 335 ... 336 ret = Hi35xxAdcReadDrs(hi35xx, node); //【必要】将adc_config文件的默认值填充到结构体中，函数定义见下方 337 ... 338 hi35xx->regBase = OsalIoRemap(hi35xx->regBasePhy, hi35xx->regSize); //【必要】地址映射 339 ... 340 hi35xx->pinCtrlBase = OsalIoRemap(HI35XX_ADC_IO_CONFIG_BASE, HI35XX_ADC_IO_CONFIG_SIZE); 341 ... 342 Hi35xxAdcDeviceInit(hi35xx); //【必要】ADC设备的初始化 343 hi35xx->device.priv = (void *)node; //【必要】存储设备属性 344 hi35xx->device.devNum = hi35xx->deviceNum; //【必要】初始化AdcDevice成员 345 hi35xx->device.ops = &g_method; //【必要】AdcMethod的实例化对象的挂载 346 ret = AdcDeviceAdd(&hi35xx->device); //【必要且重要】调用此函数填充核心层结构体，返回成功信号后驱动才完全接入平台核心层。 347 ... 348 return HDF_SUCCESS; 349 350 __ERR__: 351 if (hi35xx != NULL) { // 若不成功，需要执行去初始化相关函数。 352 if (hi35xx->regBase != NULL) { 353 OsalIoUnmap((void *)hi35xx->regBase); 354 hi35xx->regBase = NULL; 355 } 356 AdcDeviceRemove(&hi35xx->device); 357 OsalMemFree(hi35xx); 358 } 359 return ret; 360 } 361 362 static int32_t Hi35xxAdcReadDrs(struct Hi35xxAdcDevice *hi35xx, const struct DeviceResourceNode *node) 363 { 364 int32_t ret; 365 struct DeviceResourceIface *drsOps = NULL; 366 367 /* 获取drsOps方法 */ 368 drsOps = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE); 369 if (drsOps == NULL || drsOps->GetUint32 == NULL) { 370 HDF_LOGE("%s: invalid drs ops", __func__); 371 return HDF_ERR_NOT_SUPPORT; 372 } 373 /* 将配置参数依次读出，并填充至结构体中 */ 374 ret = drsOps->GetUint32(node, "regBasePhy", &hi35xx->regBasePhy, 0); 375 if (ret != HDF_SUCCESS) { 376 HDF_LOGE("%s: read regBasePhy failed", __func__); 377 return ret; 378 } 379 ret = drsOps->GetUint32(node, "regSize", &hi35xx->regSize, 0); 380 if (ret != HDF_SUCCESS) { 381 HDF_LOGE("%s: read regSize failed", __func__); 382 return ret; 383 } 384 ··· 385 return HDF_SUCCESS; 386 } 387 ``` 388 389 - Release函数开发参考 390 391 入参： 392 393 HdfDeviceObject是整个驱动对外提供的接口参数，具备HCS配置文件的信息。 394 395 返回值： 396 397 无。 398 399 函数说明： 400 401 释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。 402 403 ```c 404 static void Hi35xxAdcRelease(struct HdfDeviceObject *device) 405 { 406 const struct DeviceResourceNode *childNode = NULL; 407 ... 408 /* 遍历、解析adc_config.hcs中的所有配置节点，并分别进行Release操作。*/ 409 DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) { 410 Hi35xxAdcRemoveByNode(childNode);// 函数定义见下 411 } 412 } 413 414 static void Hi35xxAdcRemoveByNode(const struct DeviceResourceNode *node) 415 { 416 int32_t ret; 417 int32_t deviceNum; 418 struct AdcDevice *device = NULL; 419 struct Hi35xxAdcDevice *hi35xx = NULL; 420 struct DeviceResourceIface *drsOps = NULL; 421 422 drsOps = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE); 423 ... 424 ret = drsOps->GetUint32(node, "deviceNum", (uint32_t *)&deviceNum, 0); 425 ... 426 /* 可以调用AdcDeviceGet函数通过设备的deviceNum获取AdcDevice对象，以及调用AdcDeviceRemove函数来释放AdcDevice对象的内容。*/ 427 device = AdcDeviceGet(deviceNum); 428 if (device != NULL && device->priv == node) { 429 AdcDevicePut(device); 430 AdcDeviceRemove(device); //【必要】主要是从管理器驱动那边移除AdcDevice对象。 431 hi35xx = (struct Hi35xxAdcDevice *)device; //【必要】通过强制转换获取自定义的对象并进行Release操作。这一步的前提是device必须作为自定义结构体的首个成员。 432 OsalIoUnmap((void *)hi35xx->regBase); 433 OsalMemFree(hi35xx); 434 } 435 return; 436 } 437 ``` 438
