stm32g4xx_hal_adc.c

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_adc.c
  * @author  MCD Application Team
  * @brief   本文件提供管理以下模数转换器 (ADC)
  *          外设功能的固件函数：
  *          外设功能：
  *           + 初始化和反初始化函数
  *           + 外设控制函数
  *           + 外设状态函数
  *          其他函数（扩展函数）可在文件
  *          "stm32g4xx_hal_adc_ex.c" 中找到。
  *
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2019 STMicroelectronics.
  * 保留所有权利。
  *
  * 本软件的许可条款可在本软件组件根目录中的 LICENSE 文件中找到。
  * 如果本软件不附带 LICENSE 文件，则按原样提供。
  *
  ******************************************************************************
  @verbatim
  ==============================================================================
                     ##### ADC 外设特性 #####
  ==============================================================================
  [..]
  (+) 12位、10位、8位或6位可配置分辨率。

  (+) 在常规转换结束以及模拟看门狗或溢出事件发生时产生中断。

  (+) 单次和连续转换模式。

  (+) 用于顺序转换多个通道的扫描模式。

  (+) 具有内置数据一致性的数据对齐。

  (+) 可编程采样时间（按通道）

  (+) 具有可配置极性的外部触发器（定时器或 EXTI）

  (+) 用于传输常规组转换数据的 DMA 请求生成。

  (+) 双重交错模式下可配置的转换间延迟。

  (+) ADC 通道可选择单端/差分输入。

  (+) ADC 偏移量在 4 个偏移实例上共享。
  (+) ADC 增益补偿

  (+) ADC 校准

  (+) 常规组的 ADC 转换。

  (+) ADC 供电要求：1.62 V 至 3.6 V。

  (+) ADC 输入范围：从 Vref-（连接到 Vssa）到 Vref+（连接到
      Vdda 或外部电压基准）。


                     ##### 如何使用此驱动程序 #####
  ==============================================================================
    [..]

     *** 配置与 ADC 相关的顶层参数 ***
     ============================================================
     [..]

    (#) 使能 ADC 接口
        (++) 前提条件：必须在 RCC 顶层配置 ADC 时钟。

        (++) 必须进行两项时钟设置：
             (+++) ADC 时钟（核心时钟，也可能是转换时钟）。

             (+++) ADC 时钟（转换时钟）。
                   两种可能的时钟源：从 AHB 时钟派生的同步时钟
                   或从系统时钟或 PLL（输出分频器 P）派生的异步时钟，
                   运行频率最高可达 75MHz。

             (+++) 示例：
                   在 HAL_ADC_MspInit()（推荐的代码位置）中或与其他
                   设备时钟参数配置一起：
               (+++) __HAL_RCC_ADC_CLK_ENABLE();                  （必需）

               RCC_ADCCLKSOURCE_PLL 使能：                       （可选：如果选择了异步时钟）
               (+++) RCC_PeriphClkInitTypeDef   RCC_PeriphClkInit;
               (+++) PeriphClkInit.PeriphClockSelection = RCC_PERIPHCLK_ADC;
               (+++) PeriphClkInit.AdcClockSelection    = RCC_ADCCLKSOURCE_PLL;
               (+++) HAL_RCCEx_PeriphCLKConfig(&PeriphClkInit);

        (++) ADC 时钟源和时钟分频器在 ADC 层面使用
             参数 "ClockPrescaler" 通过函数 HAL_ADC_Init() 进行配置。

    (#) ADC 引脚配置
         (++) 使用宏 __HAL_RCC_GPIOx_CLK_ENABLE() 使能 ADC GPIO 的时钟
         (++) 使用函数 HAL_GPIO_Init() 将这些 ADC 引脚配置为模拟模式

    (#) 可选，如果使用带中断的 ADC：
         (++) 使用函数 HAL_NVIC_EnableIRQ(ADCx_IRQn) 配置 ADC 的 NVIC
         (++) 将 ADC 中断处理函数 HAL_ADC_IRQHandler() 插入
              对应 ADC 中断向量 ADCx_IRQHandler() 的函数中。

    (#) 可选，如果使用 DMA：
         (++) 使用函数 HAL_DMA_Init() 配置 DMA（DMA 通道、普通或循环模式等）
         (++) 使用函数 HAL_NVIC_EnableIRQ(DMAx_Channelx_IRQn) 配置 DMA 的 NVIC
         (++) 将 ADC 中断处理函数 HAL_ADC_IRQHandler() 插入
              对应 DMA 中断向量 DMAx_Channelx_IRQHandler() 的函数中。

     *** 配置 ADC、常规组、通道参数 ***
     ================================================================
     [..]

    (#) 使用函数 HAL_ADC_Init() 配置 ADC 参数（分辨率、数据对齐等）
        和常规组参数（转换触发器、序列器等）。

    (#) 使用函数 HAL_ADC_ConfigChannel() 配置常规组的通道参数（通道号、
        通道在序列器中的排名等）。

    (#) 可选，使用函数 HAL_ADC_AnalogWDGConfig() 配置模拟看门狗参数（监控的通道、
        阈值等）。

     *** 执行 ADC 转换 ***
     ====================================
     [..]

    (#) 可选，执行自动 ADC 校准以提高转换精度
        使用函数 HAL_ADCEx_Calibration_Start()。

    (#) ADC 驱动程序可在三种模式下使用：轮询、中断、
        DMA 传输。

        (++) 通过轮询进行 ADC 转换：
          (+++) 使用函数 HAL_ADC_Start() 激活 ADC 外设并启动转换
          (+++) 使用函数 HAL_ADC_PollForConversion() 等待 ADC 转换完成
          (+++) 使用函数 HAL_ADC_GetValue() 获取转换结果
          (+++) 使用函数 HAL_ADC_Stop() 停止转换并禁用 ADC 外设

        (++) 通过中断进行 ADC 转换：
          (+++) 使用函数 HAL_ADC_Start_IT() 激活 ADC 外设并启动转换
          (+++) 通过调用函数 HAL_ADC_ConvCpltCallback() 等待 ADC 转换完成
                （此函数必须在用户程序中实现）
          (+++) 使用函数 HAL_ADC_GetValue() 获取转换结果
          (+++) 使用函数 HAL_ADC_Stop_IT() 停止转换并禁用 ADC 外设

        (++) 通过 DMA 传输进行 ADC 转换：
          (+++) 使用函数 HAL_ADC_Start_DMA() 激活 ADC 外设并启动转换
          (+++) 通过调用函数 HAL_ADC_ConvCpltCallback() 或 HAL_ADC_ConvHalfCpltCallback()
                等待 ADC 转换完成（这些函数必须在用户程序中实现）
          (+++) 转换结果通过 DMA 自动传输到目标变量地址。
          (+++) 使用函数 HAL_ADC_Stop_DMA() 停止转换并禁用 ADC 外设

     [..]

    (@) 回调函数必须在用户程序中实现：
      (+@) HAL_ADC_ErrorCallback()
      (+@) HAL_ADC_LevelOutOfWindowCallback()（模拟看门狗回调）
      (+@) HAL_ADC_ConvCpltCallback()
      (+@) HAL_ADC_ConvHalfCpltCallback

     *** ADC 反初始化 ***
     ============================================================
     [..]

    (#) 禁用 ADC 接口
      (++) 可以在 RCC 顶层对 ADC 时钟进行硬复位和禁用。
        (++) 使用宏 __ADCx_FORCE_RESET()、__ADCx_RELEASE_RESET() 对 ADC 外设进行硬复位。
        (++) 使用与配置步骤等效的宏/函数禁用 ADC 时钟。
             (+++) 示例：
                   在 HAL_ADC_MspDeInit()（推荐的代码位置）中或与其他
                   设备时钟参数配置一起：
               (+++) RCC_OscInitStructure.OscillatorType = RCC_OSCILLATORTYPE_HSI14;
               (+++) RCC_OscInitStructure.HSI14State = RCC_HSI14_OFF; （如果未用于系统时钟）
               (+++) HAL_RCC_OscConfig(&RCC_OscInitStructure);

    (#) ADC 引脚配置
         (++) 使用宏 __HAL_RCC_GPIOx_CLK_DISABLE() 禁用 ADC GPIO 的时钟

    (#) 可选，如果使用带中断的 ADC：
         (++) 使用函数 HAL_NVIC_EnableIRQ(ADCx_IRQn) 禁用 ADC 的 NVIC

    (#) 可选，如果使用 DMA：
         (++) 使用函数 HAL_DMA_Init() 反初始化 DMA
         (++) 使用函数 HAL_NVIC_EnableIRQ(DMAx_Channelx_IRQn) 禁用 DMA 的 NVIC

    [..]

    *** 回调注册 ***
    =============================================