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