一个嵌入式操作系统或驱动框架中的 ADC（模拟数字转换器）驱动模块，用于管理 ADC 通道的配置、读取、启停等功能。以下是对各部分的详细解读：
一、基本结构和宏控制
#ifdef MR_USING_ADC- 条件编译宏，只有定义了 MR_USING_ADC 的情况下，ADC 驱动代码才会被编译进工程。
二、ADC 通道配置相关函数
1. adc_channel_set_configure
MR_INLINE int adc_channel_set_configure(struct mr_adc *adc, int channel, struct mr_adc_config config)功能： 设置某个 ADC 通道是否启用。
关键点：
- 检查通道索引是否越界（通过 adc->channels 位图大小计算最大通道数）。
- 调用驱动提供的 channel_configure 接口来使能或禁用通道。
- 用 adc->channels 位图记录通道的启用状态：
if (config.state == MR_ENABLE) MR_BIT_SET(adc->channels, (1 << channel)); // 置位对应通道
else MR_BIT_CLR(adc->channels, (1 << channel)); // 清除对应通道2. adc_channel_get_configure
MR_INLINE int adc_channel_get_configure(struct mr_adc *adc, int channel, struct mr_adc_config *config)功能： 获取指定通道的配置状态。
实现：
- 根据 adc->channels 位图判断该通道是否启用。
三、设备操作函数（open / close / read / ioctl）
1. mr_adc_open
static int mr_adc_open(struct mr_dev *dev)功能： 打开 ADC 设备，调用底层驱动的 configure 接口使能 ADC 模块。
2. mr_adc_close
static int mr_adc_close(struct mr_dev *dev)功能： 关闭 ADC 设备。
可选特性：
#ifdef MR_USING_ADC_AUTO_DISABLE- 若启用此宏，会在关闭设备时自动禁用所有开启的通道，并更新通道状态位图。
3. mr_adc_read
static ssize_t mr_adc_read(struct mr_dev *dev, void *buf, size_t count)功能： 读取当前设备位置（即某个 ADC 通道）的数据，存入 buf 中。
细节解析：
- 判断设备当前位置（即通道号）是否合法，且该通道是否启用（如果启用了 MR_USING_ADC_CHANNEL_CHECK 宏）。
- 循环调用底层驱动的 read 函数读取多个 uint32_t 数据。
- 读取失败时返回已成功读取的字节数，或第一个错误码。
4. mr_adc_ioctl
static int mr_adc_ioctl(struct mr_dev *dev, int cmd, void *args)功能： 控制接口，处理 IO 控制命令。
支持的命令：
- MR_IOC_ADC_SET_CHANNEL_CONFIG: 设置通道配置
- MR_IOC_ADC_GET_CHANNEL_CONFIG: 获取通道配置
- 其他命令返回不支持错误 MR_ENOTSUP
四、ADC 驱动注册函数
int mr_adc_register(struct mr_adc *adc, const char *path, struct mr_drv *drv)功能： 注册一个 ADC 设备到系统设备管理中。
步骤如下：
- 初始化通道位图（adc->channels = 0）。
- 填充设备操作函数表（mr_dev_ops）。
- 调用通用设备注册函数 mr_dev_register，绑定驱动、路径、设备类型等信息。
五、结构关系梳理
struct mr_adc
└── struct mr_dev dev // 基类设备对象
└── uint32_t channels // 通道启用状态位图
struct mr_adc_ops
└── int (*configure)(...) // 总体配置
└── int (*channel_configure)(...) // 通道配置
└── int (*read)(...) // 通道读取通过设备抽象层和函数指针封装，不同平台/芯片的 ADC 驱动只需实现 mr_adc_ops 接口即可完成适配。
六、总结亮点与特性
特性 | 描述 |
抽象封装 | 通过设备结构体和操作表实现面向对象风格的驱动 |
通道管理 | 使用 channels 位图精确控制每一路 ADC 启停状态 |
条件编译 | 可裁剪功能（如自动关闭通道/检查通道使能状态） |
统一接口 | 提供 open/read/ioctl 等标准设备操作接口 |
高可移植性 | 底层 ADC 驱动由 mr_adc_ops 接口抽象，平台无关 |
开源代码：
#include "include/device/mr_adc.h"
#ifdef MR_USING_ADC
MR_INLINE int adc_channel_set_configure(struct mr_adc *adc,
int channel,
struct mr_adc_config config)
{
struct mr_adc_ops *ops = (struct mr_adc_ops *)adc->dev.drv->ops;
if ((channel < 0) || (channel >= (sizeof(adc->channels) * 8))) {
return MR_EINVAL;
}
int ret = ops->channel_configure(adc, channel, config.state);
if (ret < 0) {
return ret;
}
/* Enable or disable the channel */
if (config.state == MR_ENABLE) {
MR_BIT_SET(adc->channels, (1 << channel));
} else {
MR_BIT_CLR(adc->channels, (1 << channel));
}
return MR_EOK;
}
MR_INLINE int adc_channel_get_configure(struct mr_adc *adc,
int channel,
struct mr_adc_config *config)
{
if ((channel < 0) || (channel >= (sizeof(adc->channels) * 8))) {
return MR_EINVAL;
}
/* Get configure */
config->state = MR_BIT_IS_SET(adc->channels, (1 << channel));
return MR_EOK;
}
static int mr_adc_open(struct mr_dev *dev)
{
struct mr_adc *adc = (struct mr_adc *)dev;
struct mr_adc_ops *ops = (struct mr_adc_ops *)dev->drv->ops;
return ops->configure(adc, MR_ENABLE);
}
static int mr_adc_close(struct mr_dev *dev)
{
struct mr_adc *adc = (struct mr_adc *)dev;
struct mr_adc_ops *ops = (struct mr_adc_ops *)dev->drv->ops;
#ifdef MR_USING_ADC_AUTO_DISABLE
/* Disable all channels */
for (size_t i = 0; i < (sizeof(adc->channels) * 8); i++) {
if (MR_BIT_IS_SET(adc->channels, (1 << i)) == MR_ENABLE) {
ops->channel_configure(adc, (int)i, MR_DISABLE);
MR_BIT_CLR(adc->channels, (1 << i));
}
}
#endif /* MR_USING_ADC_AUTO_DISABLE */
return ops->configure(adc, MR_DISABLE);
}
static ssize_t mr_adc_read(struct mr_dev *dev, void *buf, size_t count)
{
struct mr_adc *adc = (struct mr_adc *)dev;
struct mr_adc_ops *ops = (struct mr_adc_ops *)dev->drv->ops;
uint32_t *rd_buf = (uint32_t *)buf;
ssize_t rd_size;
#ifdef MR_USING_ADC_CHANNEL_CHECK
/* Check if the channel is enabled */
if ((dev->position < 0) || (MR_BIT_IS_SET(adc->channels, (1 << dev->position)) == MR_DISABLE)) {
return MR_EINVAL;
}
#endif /* MR_USING_ADC_CHANNEL_CHECK */
for (rd_size = 0; rd_size < MR_ALIGN_DOWN(count, sizeof(*rd_buf)); rd_size += sizeof(*rd_buf)) {
int ret = ops->read(adc, dev->position, rd_buf);
if (ret < 0) {
return (rd_size == 0) ? ret : rd_size;
}
rd_buf++;
}
return rd_size;
}
static int mr_adc_ioctl(struct mr_dev *dev, int cmd, void *args)
{
struct mr_adc *adc = (struct mr_adc *)dev;
switch (cmd) {
case MR_IOC_ADC_SET_CHANNEL_CONFIG: {
if (args != MR_NULL) {
struct mr_adc_config config = *((struct mr_adc_config *)args);
int ret = adc_channel_set_configure(adc, dev->position, config);
if (ret < 0) {
return ret;
}
return sizeof(config);
}
return MR_EINVAL;
}
case MR_IOC_ADC_GET_CHANNEL_CONFIG: {
if (args != MR_NULL) {
struct mr_adc_config *config = (struct mr_adc_config *)args;
int ret = adc_channel_get_configure(adc, dev->position, config);
if (ret < 0) {
return ret;
}
return sizeof(*config);
}
return MR_EINVAL;
}
default: {
return MR_ENOTSUP;
}
}
}
/**
* @brief This function registers an adc.
*
* @param adc The adc.
* @param path The path of the adc.
* @param drv The driver of the adc.
*
* @return 0 on success, otherwise an error code.
*/
int mr_adc_register(struct mr_adc *adc, const char *path, struct mr_drv *drv)
{
static struct mr_dev_ops ops = {mr_adc_open,
mr_adc_close,
mr_adc_read,
MR_NULL,
mr_adc_ioctl,
MR_NULL};
MR_ASSERT(adc != MR_NULL);
MR_ASSERT(path != MR_NULL);
MR_ASSERT(drv != MR_NULL);
MR_ASSERT(drv->ops != MR_NULL);
/* Initialize the fields */
adc->channels = 0;
/* Register the adc */
return mr_dev_register(&adc->dev, path, MR_DEV_TYPE_ADC, MR_O_RDONLY, &ops, drv);
}
#endif /* MR_USING_ADC */