One Shot Mode - Interrupt Mode

该示例通过使用 ADC 单次采样模式进行电压检测。

该示例通过中断的方式检测 P2_7 的输入电压。当 ADC 单次采样完成时触发中断，在中断函数内读取 ADC 采样数据 raw data 并进行电压转换计算。

该示例中可通过配置宏 ADC_MODE_DIVIDE_OR_BYPASS 选择 ADC 的电压采样范围。

该示例中可通过配置宏 ADC_DATA_HW_AVERAGE 选择是否开启 Hardware Average 功能。

该示例中可通过配置宏 ADC_DATA_OUTPUT_TO_FIFO 选择 ADC 采样数据是否存入 FIFO 内。

环境需求

该示例支持以下开发套件：

开发套件

Hardware Platforms

Board Name

RTL8752H HDK

RTL8752H EVB

更多信息请参考 快速入门。

硬件连线

连接 P2_7 至外部电压输入。

配置选项

该示例可配置的宏如下：

  1. ADC_MODE_DIVIDE_OR_BYPASS ：配置该宏可选择 ADC 的电压采样范围，可选择的值如下。

    • ADC_DIVIDE_MODE ：在 Divide Mode 下，ADC 的采样电压值范围为 0~3.3V。

    • ADC_BYPASS_MODE ：在 Bypass Mode 下，ADC 的采样电压值范围为 0~0.9V。

  2. ADC_DATA_HW_AVERAGE ：配置该宏可开启 ADC 的 Hardware Average 功能。

  3. ADC_DATA_OUTPUT_TO_FIFO ：配置该宏可选择将 ADC 的采样数据存放至 ADC FIFO 内。

备注

Hardware Average 功能仅适用于 ADC 的通道 0。Hardware Average 功能与 Data Output to FIFO 功能不能同时开启。

编译和下载

该示例的工程路径如下:

Project file: board\evb\io_sample\ADC\OneShotMode\mdk

Project file: board\evb\io_sample\ADC\OneShotMode\gcc

请按照以下步骤操作构建并运行该示例:

  1. 打开工程文件。

  2. 按照 快速入门 中 编译 APP Image 给出的步骤构建目标文件。

  3. 编译成功后，在路径 mdk\bin 或 gcc\bin 下会生成 app bin app_MP_xxx.bin 文件。

  4. 按照 快速入门 中 MP Tool 给出的步骤将 app bin 烧录至 EVB 内。

  5. 按下 reset 按键，开始运行。

测试验证

  1. ADC 初始化配置：

    1. 若配置为 ADC_DIVIDE_MODE ，则会打印如下 log。

      [ADC] ADC sample mode is divide mode !

    2. 若配置为 ADC_BYPASS_MODE ，则会打印如下 log。

      [ADC] ADC sample mode is bypass mode !

  2. ADC 采样结束后，会在 Debug Analyzer 工具内打印采集得到的 raw data 和转换后的电压值。

    [io_adc] io_adc_voltage_calculate: ADC rawdata = xxx, voltage = xxxmV
...

代码介绍

该章节分为以下几个部分：

  1. 源码路径 。

  2. 初始化函数将在 初始化 章节介绍。

  3. 初始化后的功能实现将在 功能实现 章节介绍。

源码路径

  • 工程路径: sdk\board\evb\io_sample\ADC\OneShotMode

  • 源码路径: sdk\src\sample\io_sample\ADC\OneShotMode

该工程的工程文件代码结构如下：

└── Project: adc_oneshot
    └── secure_only_app
        └── include
            ├── app_define.h
            └── rom_uuid.h
        ├── cmsis                    includes CMSIS header files and startup files
            ├── overlay_mgr.c
            ├── system_rtl876x.c
            └── startup_rtl876x.s
        ├── lib                      includes all binary symbol files that user application is built on
            ├── rtl8752h_sdk.lib
            ├── gap_utils.lib
            ├── ROM.lib
            └── adc.lib
        ├── peripheral               includes all peripheral drivers and module code used by the application
            ├── rtl876x_rcc.c
            ├── rtl876x_pinmux.c
            ├── rtl876x_nvic.c
            └── rtl876x_adc.c
        ├── profile
        └── app                      includes the ble_peripheral user application implementation
            ├── main.c
            ├── ancs.c
            ├── app.c
            ├── app_task.c
            └── io_adc.c

初始化

当 EVB 复位启动时，调用 main() 函数，将执行以下流程：

int main(void)
{
    extern uint32_t random_seed_value;
    srand(random_seed_value);
    global_data_init();
    board_init();
    le_gap_init(APP_MAX_LINKS);
    gap_lib_init();
    app_le_gap_init();
    app_le_profile_init();
    pwr_mgr_init();
    task_init();
    os_sched_start();

    return 0;
}

备注

le_gap_init() ，gap_lib_init() ，app_le_gap_init ，app_le_profile_init 等为 privacy 管理模块相关的初始化，参考 LE Peripheral Privacy 中的初始化流程介绍。

与外设相关的初始化流程具体如下：

  1. 在 global_data_init 中，执行 global_data_adc_init ，该函数为全局初始化，包含如下流程：

    1. 执行 ADC_CalibrationInit() 函数进行 ADC 校准。若返回值为 false，则 ADC 校准失败，可能是因为该 IC 未经 FT 导致，因此无法准确得到电压值。

    2. 初始化全局变量 ADC_Global_Data 。

    void global_data_adc_init(void)
{
    /* Initialize adc k value! */
    APP_PRINT_INFO0("[io_adc] global_data_adc_init");
    bool adc_k_status = false;
    adc_k_status = ADC_CalibrationInit();
    if (false == adc_k_status)
    {
        APP_PRINT_ERROR0("[io_adc] global_data_adc_init: ADC_CalibrationInit fail!");
    }
    memset(&ADC_Global_Data, 0, sizeof(ADC_Global_Data));
}

  2. 在 board_init 中，执行 board_adc_init ，该函数为 PAD/PINMUX 设置，包含如下流程：

    1. 配置 PAD：设置引脚、SW 模式、PowerOn、无内部上拉、输出失能。

  3. 在执行 os_sched_start() 开启任务调度后，在 app_main_task 主任务内，执行 driver_init 对外设驱动进行初始化配置。

  4. 在 driver_init 中执行 driver_adc_init ，该函数为 ADC 外设的初始化，包含如下流程：

    1. 使能 RCC 时钟。

    2. 配置 ADC 的采样通道，配置通道 0 为 P2_7 单端模式，设置 Bitmap 为 0x01。

    3. 若开启 Bypass Mode，执行函数 ADC_BypassCmd() 开启对应引脚的 Bypass 模式。

    4. 若开启宏 ADC_DATA_HW_AVERAGE ，使能 ADC Hardware Average 模式，配置平均次数。

    5. 若开启宏 ADC_DATA_OUTPUT_TO_FIFO ，使能 ADC 采样值存入 FIFO，配置 FIFO 阈值。

    6. 若开启宏 ADC_DATA_OUTPUT_TO_FIFO ，配置 ADC_INT_FIFO_THD 中断，否则配置 ADC_INT_ONE_SHOT_DONE 中断。

    void driver_adc_init(void)
{
    RCC_PeriphClockCmd(APBPeriph_ADC, APBPeriph_ADC_CLOCK, ENABLE);

    ADC_InitTypeDef ADC_InitStruct;
    ADC_StructInit(&ADC_InitStruct);

    /* Configure the ADC sampling schedule0 */
    ADC_InitStruct.ADC_SchIndex[0]      = EXT_SINGLE_ENDED(ADC_SAMPLE_CHANNEL_7);
    /* Set the bitmap corresponding to schedule0*/
    ADC_InitStruct.ADC_Bitmap           = 0x01;

#if (ADC_DATA_HW_AVERAGE && ADC_DATA_OUTPUT_TO_FIFO)
    APP_PRINT_ERROR0("[io_adc] driver_adc_init: ADC config error !");
#elif (ADC_DATA_HW_AVERAGE )
    ADC_InitStruct.ADC_DataAvgEn        = ADC_DATA_AVERAGE_ENABLE;
    ADC_InitStruct.ADC_DataAvgSel       = ADC_DATA_AVERAGE_OF_4;
#elif (ADC_DATA_OUTPUT_TO_FIFO)
    ADC_InitStruct.ADC_DataWriteToFifo  = ADC_DATA_WRITE_TO_FIFO_ENABLE;
    ADC_InitStruct.ADC_FifoThdLevel     = 0x0A;
#endif

    ADC_InitStruct.ADC_PowerAlwaysOnEn  = ADC_POWER_ALWAYS_ON_ENABLE;
    /* Fixed 255 in OneShot mode. */
    ADC_InitStruct.ADC_SampleTime       = 255;

    ADC_Init(ADC, &ADC_InitStruct);

#if (ADC_MODE_DIVIDE_OR_BYPASS == ADC_BYPASS_MODE)
    /* High bypass resistance mode config, please notice that the input voltage of
      adc channel using high bypass mode should not be over 0.9V */
    ADC_BypassCmd(ADC_SAMPLE_CHANNEL_0, ENABLE);
    APP_PRINT_INFO0("[io_adc] driver_adc_init: ADC sample mode is bypass mode !");
#else
    ADC_BypassCmd(ADC_SAMPLE_CHANNEL_0, DISABLE);
    APP_PRINT_INFO0("[io_adc] driver_adc_init: ADC sample mode is divide mode !");
#endif

#if (!ADC_DATA_OUTPUT_TO_FIFO)
    ADC_INTConfig(ADC, ADC_INT_ONE_SHOT_DONE, ENABLE);
#else
    ADC_INTConfig(ADC, ADC_INT_FIFO_THD, ENABLE);
#endif

    NVIC_InitTypeDef NVIC_InitStruct;
    NVIC_InitStruct.NVIC_IRQChannel = ADC_IRQn;
    NVIC_InitStruct.NVIC_IRQChannelPriority = 3;
    NVIC_InitStruct.NVIC_IRQChannelCmd = ENABLE;
    NVIC_Init(&NVIC_InitStruct);
}

功能实现

  1. 执行 os_sched_start() ，开启任务调度。当 stack 准备好时，执行 app_handle_dev_state_evt ，执行 adc_sample_start 开启 ADC 采样。

    1. 若开启宏 ADC_DATA_OUTPUT_TO_FIFO ，清空 ADC FIFO，然后连续进行十次 ADC 采样。

    2. 若未开启宏 ADC_DATA_OUTPUT_TO_FIFO ，直接执行 ADC_Cmd() ，开始 ADC 采样。

    void app_handle_dev_state_evt(T_GAP_DEV_STATE new_state, uint16_t cause)
{
    ...
    if (gap_dev_state.gap_init_state != new_state.gap_init_state)
    {
        if (new_state.gap_init_state == GAP_INIT_STATE_STACK_READY)
        {
            APP_PRINT_INFO0("GAP stack ready");
            /*stack ready*/
            adc_sample_start();
        }
    }
    ...
}

void adc_sample_start(void)
{
#if (ADC_DATA_OUTPUT_TO_FIFO)
    ADC_ClearFifo(ADC);
    for (uint16_t i = 0; i < 10; i++)
    {
        ADC_Cmd(ADC, ADC_ONE_SHOT_MODE, ENABLE);
        platform_delay_ms(10);
    }
#else
    /* Enable adc sample */
    ADC_Cmd(ADC, ADC_ONE_SHOT_MODE, ENABLE);
#endif
}

  2. 若开启宏 ADC_DATA_OUTPUT_TO_FIFO ，当 ADC FIFO 数目超过设定阈值时，触发 ADC_INT_FIFO_THD 中断，进入中断处理函数 ADC_Handler 。

    1. 判断 ADC FIFO 数目超过给定值的中断状态是否为 SET。

    2. 执行 ADC_GetFIFODataLen() 获取 ADC FIFO 内的数据量，执行 ADC_ReadFIFOData() 获取 ADC FIFO 内数据。

    3. 定义消息类型 IO_MSG_TYPE_ADC ，保存采集数据至全局变量，执行 app_send_msg_to_apptask 发送 msg 给 task。

    4. 执行 ADC_ClearFIFO() 清空 ADC FIFO 内数据，清除中断标志位。

    void ADC_Handler(void)
{
    ...
    if (ADC_GetIntFlagStatus(ADC, ADC_INT_FIFO_THD) == SET)
    {
        ADC_Global_Data.RawDataLen = ADC_GetFifoLen(ADC);
        ADC_GetFifoData(ADC, ADC_Global_Data.RawData, ADC_Global_Data.RawDataLen);

        /* Send msg to app task */
        T_IO_MSG int_adc_msg;
        int_adc_msg.type = IO_MSG_TYPE_ADC;
        int_adc_msg.u.buf = (void *)(&ADC_Global_Data);
        if (false == app_send_msg_to_apptask(&int_adc_msg))
        {
            APP_PRINT_ERROR0("[io_adc] ADC_Handler: Send int_adc_msg failed!");
            //Add user code here!
            ADC_ClearFifo(ADC);
            ADC_ClearINTPendingBit(ADC, ADC_INT_FIFO_THD);
            return;
        }
        ADC_ClearINTPendingBit(ADC, ADC_INT_FIFO_THD);
        ADC_ClearFifo(ADC);
    }
}

  3. 若未开启宏 ADC_DATA_OUTPUT_TO_FIFO ，当 ADC 完成单次采样时，触发 ADC_INT_ONE_SHOT_DONE 中断，进入中断处理函数 ADC_Handler 。

    1. 判断 ADC 单次采样中断状态是否为 SET，清除中断标志位。

    2. 执行 ADC_ReadRawData() 读取 ADC 采样值。

    3. 定义消息类型 IO_MSG_TYPE_ADC ，保存采集数据至全局变量，执行 app_send_msg_to_apptask 发送 msg 给 task。

    void ADC_Handler(void)
{
    ...
    if (ADC_GetINTStatus(ADC, ADC_INT_ONE_SHOT_DONE) == SET)
    {
        ADC_ClearINTPendingBit(ADC, ADC_INT_ONE_SHOT_DONE);

        uint16_t sample_data = 0;
        sample_data = ADC_ReadRawData(ADC, ADC_Schedule_Index_0);

        T_IO_MSG int_adc_msg;
        int_adc_msg.type = IO_MSG_TYPE_ADC;
        int_adc_msg.subtype = 0;
        ADC_Global_Data.RawDataLen = 1;
        ADC_Global_Data.RawData[0] = sample_data;
        int_adc_msg.u.buf = (void *)(&ADC_Global_Data);
        if (false == app_send_msg_to_apptask(&int_adc_msg))
        {
            APP_PRINT_ERROR0("[io_adc] ADC_Handler: Send int_adc_msg failed!");
            //Add user code here!
            ADC_ClearINTPendingBit(ADC, ADC_INT_ONE_SHOT_DONE);
            return;
        }
    }
    ...
}

  4. 在 app_main_task 中循环检测消息队列。当检测到 msg 时，执行 app_handle_io_msg 函数对 msg 进行处理。

  5. 在 app_handle_io_msg 函数中，若判断消息类型为 IO_MSG_TYPE_GDMA ，执行 io_handle_adc_msg 函数，执行 io_adc_voltage_calculate 。

    1. 从 msg 中取出采样数据。

    2. 若开启宏 ADC_DATA_HW_AVERAGE ，则需要分别计算整数部分与小数部分的采样值。

    3. 执行 ADC_GetVoltage() ，根据采样模式计算采样电压值并打印。

    备注

    ADC Hardware Average 模式得到的 raw data ，低 2 位为小数部分，高 12 位为整数部分。

    static void io_adc_voltage_calculate(T_IO_MSG *io_adc_msg)
{
    ADC_Data_TypeDef *p_buf = io_adc_msg->u.buf;
    uint8_t sample_data_len = 0;
    uint16_t sample_data = 0;

    sample_data_len = p_buf->RawDataLen;
    for (uint8_t i = 0; i < sample_data_len; i++)
    {
        sample_data = p_buf->RawData[i];
        DBG_DIRECT("io_adc_voltage_calculate: raw_data = 0x%X", sample_data);
#if (ADC_DATA_HW_AVERAGE )
        sample_data = (p_buf->RawData[i] & 0x3FFC) >> 2;
        uint16_t sample_data_decimal = (p_buf->RawData[i] & 0x3);

        float cacl_result = sample_data;
        float cacl_result_dec = 0;
        cacl_result_dec = (float)(sample_data_decimal & 0x1) / 2 + (float)((sample_data_decimal >> 1) & 0x1)
                        / 4;
        cacl_result += cacl_result_dec;
        DBG_DIRECT("io_adc_voltage_calculate: sample_data = %d, cacl_result = %d\r\n",
                sample_data, (uint32_t)cacl_result);

#endif
        float sample_voltage = 0;
        ADC_ErrorStatus error_status = NO_ERROR;
#if (ADC_MODE_DIVIDE_OR_BYPASS == ADC_BYPASS_MODE)
        sample_voltage = ADC_GetVoltage(BYPASS_SINGLE_MODE, (int32_t)sample_data, &error_status);
#else
        sample_voltage = ADC_GetVoltage(DIVIDE_SINGLE_MODE, (int32_t)sample_data, &error_status);
#endif
        if (error_status < 0)
        {
            APP_PRINT_INFO1("[io_adc] io_adc_voltage_calculate: ADC parameter or efuse data error! error_status = %d",
                            error_status);
        }
        else
        {
            APP_PRINT_INFO2("[io_adc] io_adc_voltage_calculate: ADC rawdata = %d, voltage = %dmV ",
                            sample_data, (uint32_t)sample_voltage);
        }
    }
    memset(&ADC_Global_Data, 0, sizeof(ADC_Global_Data));
}

常见问题

  1. 若拿到的 IC 未经过 FT 校验，ADC 则无法转换为正确的电压值。在 log 工具内会打印如下信息。

    [ADC]ADC_CalibrationInit fail!

  2. 若 ADC 采样值不正确，则会打印错误状态信息。

    ADC parameter or efuse data error! i = xxx, error_status = xxx