ADC Hardware Average Funcion

This sample code guide is designed to help users easily and comprehensively understand ADC sample. This sample demonstrates how ADC samples data with hardware average function. This sample uses the hardware average function of the ADC peripheral to measure voltage on P0_1. ADC hardware average function can only be used in one shot mode and only schedule table 0 can be used. For RTL87x3E and RTL87x3EP, it is recommended to use the hardware average function.

Requirements

For hardware requirements, please refer to the Requirements.

Wiring

Connect P0_1 of EVB to an external DC voltage source. Input voltage of P0_1 must range from 0 to 3.3V.

Configurations

The entry function is as follows, call this function in main() to run this sample code. For more details, please refer to the Initialization.

adc_hw_average_demo();

Building and Downloading

For building and downloading, please refer to the Building and Downloading.

Experimental Verification

Press the Reset button on the EVB board, after initialization is complete, the ADC begins sampling. Once ADC sampling is finished, the converted voltage values will be printed in Debug Analyzer.

adc_handler: result xxx

Code Overview

This section introduces the code and process description for initialization and corresponding function implementation in the sample.

Note

To use the mode, please turn off Charger auto enable and Battery detection support on the MCUConfig Tool. As shown in Turn Off Charger on the MCUConfig Tool.

../../../_images/Turn_Off_Charger_on_the_McuConfig_Tool.jpg

Turn Off Charger on the MCUConfig Tool

Source Code Directory

  • For project directory, please refer to Source Code Directory.

  • Source code directory: sdk\src\sample\io_demo\adc\adc_hw_average\adc_hw_average_demo.c.

Initialization

The initialization flow for peripherals can refer to Initialization Flow.

The initialization flow of ADC sampling in one shot mode by hardware average is shown in the following figure.

../../../_images/ADC_One_Shot_Sampling_by_Hardware_Average_Mode.png

ADC One Shot Sampling by Hardware Average

  1. Call Pad_Config() and Pinmux_Config() to initialize the pin.

    static void board_adc_init(void)
    {
       Pad_Config(ADC_1, PAD_SW_MODE, PAD_IS_PWRON, PAD_PULL_NONE, PAD_OUT_DISABLE, PAD_OUT_LOW);
       Pinmux_Config(ADC_1, IDLE_MODE);
    }
    
  2. Call RCC_PeriphClockCmd() to enable the ADC clock and function.

  3. Initialize the ADC peripheral:

    1. Define the ADC_InitTypeDef type adc_init_struct, and call ADC_StructInit() to pre-fill adc_init_struct with default values.

    2. Modify the adc_init_struct parameters as needed. The ADC initialization parameter configuration is shown in the table below.

    3. Call ADC_Init() to initialize the ADC peripheral.

    ADC Initialization Parameters

    ADC Hardware Parameters

    Setting in the adc_init_struct Variables

    ADC

    Bit Map

    ADC_InitTypeDef::bitmap

    0x01

    Schedule Index

    ADC_InitTypeDef::schIndex

    Index 0 is set to EXT_SINGLE_ENDED(1).

  4. Call ADC_HwEvgEn() to enable hardware average function.

  5. Call ADC_HwEvgSel() to set the hardware average times.

  6. Call ADC_INTConfig() to enable ADC one shot mode done interrupt.

  7. Call NVIC_Init() to enable NVIC of ADC.

  8. Call ADC_Cmd() to enable ADC one shot sampling.

Functional Implementation

Interrupt Handle

When ADC sampling is completed, ADC one shot mode end interrupt is triggered and enters the interrupt handler. ADC interrupt handle flow is shown in the following figure.

../../../_images/ADC_HW_Average_Interrupt_Handle_Flow.png

ADC Interrupt Handle Flow

  1. Call ADC_GetIntFlagStatus() to check ADC_INT_ONE_SHOT_DONE interrupt status.

  2. Call ADC_ClearINTPendingBit() to clear ADC_INT_ONE_SHOT_DONE interrupt.

  3. Call ADC_Cmd() to disable ADC.

  4. Call ADC_HwEvgRead() to read ADC raw data.

  5. Call ADC_GetRes() to get conversion result.