stm32g4xx_hal_pwr.c

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_pwr.c
  * @author  MCD Application Team
  * @brief   PWR HAL 模块驱动。
  *          该文件提供固件函数，用于管理电源控制器（PWR）外设的以下功能：
  *           + 初始化/反初始化函数
  *           + 外设控制函数
  *
  ******************************************************************************
  * @attention
  *
  * 版权所有 (c) 2019 STMicroelectronics。
  * 保留所有权利。
  *
  * 本软件根据 LICENSE 文件中的条款许可，该文件位于
  * 本软件组件的根目录中。
  * 如果本软件未附带任何 LICENSE 文件，则按“原样”提供。
  *
  ******************************************************************************
  */

/* Includes ------------------------------------------------------------------*/
#include "stm32g4xx_hal.h"

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @defgroup PWR PWR
  * @brief PWR HAL 模块驱动
  * @{
  */

#ifdef HAL_PWR_MODULE_ENABLED

/* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/

/** @defgroup PWR_Private_Defines PWR 私有定义
  * @{
  */

/** @defgroup PWR_PVD_Mode_Mask PWR PVD 模式掩码
  * @{
  */
  */
#define PVD_MODE_IT               ((uint32_t)0x00010000)  /*!< 用于 PVD 阈值跨越产生的中断掩码 */
#define PVD_MODE_EVT              ((uint32_t)0x00020000)  /*!< 用于 PVD 阈值跨越产生的事件掩码 */
#define PVD_RISING_EDGE           ((uint32_t)0x00000001)  /*!< 用于设置为 PVD 触发的上升沿掩码 */
#define PVD_FALLING_EDGE          ((uint32_t)0x00000002)  /*!< 用于设置为 PVD 触发的下降沿掩码 */
/**
  * @}
  */

/**
  * @}
  */

/* Private macro -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/* Exported functions --------------------------------------------------------*/

/** @defgroup PWR_Exported_Functions PWR 导出函数
  * @{
  */

/** @defgroup PWR_Exported_Functions_Group1 初始化和反初始化函数
  *  @brief    初始化和反初始化函数
  *
@verbatim
 ===============================================================================
              ##### 初始化和反初始化函数 #####
 ===============================================================================
    [..]

@endverbatim
  * @{
  */

/**
  * @brief  将 HAL PWR 外设寄存器反初始化为其默认复位值。
  * @retval 无
  */
void HAL_PWR_DeInit(void)
{
  __HAL_RCC_PWR_FORCE_RESET();
  __HAL_RCC_PWR_RELEASE_RESET();
}

/**
  * @brief 启用对备份域的访问
  *        （RTC 寄存器、RTC 备份数据寄存器）。
  * @note  复位后，备份域受到保护，以防止
  *        可能的意外写入访问。
  * @note  RTCSEL（设置 RTC 时钟源选择）位于 RTC 备份域中。
  *        为了设置或修改 RTC 时钟，必须禁用备份域访问。
  * @note  LSEON 位（用于开启和关闭 LSE 晶振）也属于备份域。
  * @retval 无
  */
  */
  */
void HAL_PWR_EnableBkUpAccess(void)
{
  SET_BIT(PWR->CR1, PWR_CR1_DBP);
}

/**
  * @brief 禁用对备份域的访问
  *        （RTC 寄存器、RTC 备份数据寄存器）。
  * @retval 无
  */
void HAL_PWR_DisableBkUpAccess(void)
{
  CLEAR_BIT(PWR->CR1, PWR_CR1_DBP);
}




/**
  * @}
  */



/** @defgroup PWR_Exported_Functions_Group2 外设控制函数
  *  @brief 低功耗模式配置函数
  *
@verbatim

 ===============================================================================
                 ##### 外设控制函数 #####
 ===============================================================================

     [..]
     *** PVD 配置 ***
    =========================
    [..]
      (+) PVD 用于监控 VDD 电源，通过将其与
          PVD 级别选择的阈值进行比较（PWR_CR2 寄存器中的 PLS[2:0] 位）。

      (+) PVDO 标志可用于指示 VDD/VDDA 是高于还是低于
          PVD 阈值。此事件在内部连接到 EXTI
          线 16，如果启用，可以产生中断。这是通过
          __HAL_PVD_EXTI_ENABLE_IT() 宏完成的。
      (+) PVD 在待机模式下停止。


    *** 唤醒引脚配置 ***
    ================================
    [..]
      (+) 唤醒引脚用于将系统从待机模式或停机模式唤醒。
          这些引脚的极性可以设置，以配置高电平（上升沿）或低电平（下降沿）的事件检测。



    *** 低功耗模式配置 ***
    =====================================
    [..]
      器件具有 8 种低功耗模式：
      (+) 低功耗运行模式：内核和外设运行，主调节器关闭，低功耗调节器开启。
      (+) 睡眠模式：Cortex-M4 内核停止，外设继续运行，主调节器和低功耗调节器开启。
      (+) 低功耗睡眠模式：Cortex-M4 内核停止，外设继续运行，主调节器关闭，低功耗调节器开启。
      (+) 停止 0 模式：除 LSI 和 LSE 外，所有时钟停止，主调节器和低功耗调节器开启。
      (+) 停止 1 模式：除 LSI 和 LSE 外，所有时钟停止，主调节器关闭，低功耗调节器开启。
      (+) 带 SRAM2 的待机模式：除 LSI 和 LSE 外，所有时钟停止，SRAM2 内容保留，主调节器关闭，低功耗调节器开启。
      (+) 不带 SRAM2 的待机模式：除 LSI 和 LSE 外，所有时钟停止，主调节器和低功耗调节器关闭。
      (+) 停机模式：除 LSE 外，所有时钟停止，主调节器和低功耗调节器关闭。


   *** 低功耗运行模式 ***
   ==========================
    [..]
      (+) 进入：（从主运行模式）
        (++) 在将系统时钟降低到 2 MHz 以下后，使用 HAL_PWREx_EnableLowPowerRunMode() API 设置 LPR 位。

      (+) 退出：
        (++) 清除 LPR 位，然后等待 REGLP 位复位，使用 HAL_PWREx_DisableLowPowerRunMode() API。只有
             在此时，系统时钟频率才能增加到 2 MHz 以上。


   *** 睡眠模式 / 低功耗睡眠模式 ***
   =========================================
    [..]
      (+) 进入：
          通过 HAL_PWR_EnterSLEEPMode() API 进入睡眠模式/低功耗睡眠模式，
          指定调节器是否强制进入低功耗模式，以及退出是通过中断还是事件触发。
          (++) PWR_MAINREGULATOR_ON：睡眠模式（调节器在主模式）。
          (++) PWR_LOWPOWERREGULATOR_ON：低功耗睡眠（调节器在低功耗模式）。
          在后一种情况下，系统时钟频率必须事先降低到 2 MHz 以下。
          (++) PWR_SLEEPENTRY_WFI：使用 WFI 指令进入 SLEEP 模式
          (++) PWR_SLEEPENTRY_WFE：使用 WFE 指令进入 SLEEP 模式

      (+) WFI 退出：
        (++) 嵌套向量中断控制器 (NVIC) 确认的任何外设中断或任何唤醒事件。

      (+) WFE 退出：
        (++) 任何唤醒事件，例如配置为事件模式的 EXTI 线。

         [..] 当通过发出中断或唤醒事件退出低功耗睡眠模式时，
             MCU 处于低功耗运行模式。

   *** 停止 0、停止 1 模式 ***
   ===============================
    [..]
      (+) 进入：
          停止 0、停止 1 模式通过以下 API 进入：
          (++) HAL_PWREx_EnterSTOP0Mode() 用于模式 0，或 HAL_PWREx_EnterSTOP1Mode() 用于模式 1，或出于移植原因使用 HAL_PWR_EnterSTOPMode()。
      (+) 调节器设置（仅适用于 HAL_PWR_EnterSTOPMode()）：
          (++) PWR_MAINREGULATOR_ON
          (++) PWR_LOWPOWERREGULATOR_ON
      (+) 退出（中断或事件触发，在进入 STOP 模式时指定）：
          (++) PWR_STOPENTRY_WFI：使用 WFI 指令进入停止模式
          (++) PWR_STOPENTRY_WFE：使用 WFE 指令进入停止模式

      (+) WFI 退出：
          (++) 任何配置为中断模式的 EXTI 线（内部或外部）。
          (++) 某些特定通信外设（USART、LPUART、I2C）的中断
               在编程为唤醒模式时。
      (+) WFE 退出：
          (++) 任何配置为事件模式的 EXTI 线（内部或外部）。

       [..]
          当退出停止 0 和停止 1 模式时，MCU 处于运行模式或低功耗运行模式，
          具体取决于 LPR 位的设置。

   *** 待机模式 ***
   ====================
     [..]
      待机模式提供两个选项：
      (+) 选项 a) 除 LSI 和 LSE 外，所有时钟关闭