462 lines
17 KiB
C
462 lines
17 KiB
C
/**
|
|
******************************************************************************
|
|
* @file stm32f3xx_hal_pwr.c
|
|
* @author MCD Application Team
|
|
* @brief PWR HAL module driver.
|
|
* This file provides firmware functions to manage the following
|
|
* functionalities of the Power Controller (PWR) peripheral:
|
|
* + Initialization/de-initialization functions
|
|
* + Peripheral Control functions
|
|
*
|
|
@verbatim
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* <h2><center>© Copyright (c) 2016 STMicroelectronics.
|
|
* All rights reserved.</center></h2>
|
|
*
|
|
* This software component is licensed by ST under BSD 3-Clause license,
|
|
* the "License"; You may not use this file except in compliance with the
|
|
* License. You may obtain a copy of the License at:
|
|
* opensource.org/licenses/BSD-3-Clause
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
/* Includes ------------------------------------------------------------------*/
|
|
#include "stm32f3xx_hal.h"
|
|
|
|
/** @addtogroup STM32F3xx_HAL_Driver
|
|
* @{
|
|
*/
|
|
|
|
/** @defgroup PWR PWR
|
|
* @brief PWR HAL module driver
|
|
* @{
|
|
*/
|
|
|
|
#ifdef HAL_PWR_MODULE_ENABLED
|
|
|
|
/* Private typedef -----------------------------------------------------------*/
|
|
/* Private define ------------------------------------------------------------*/
|
|
/* Private macro -------------------------------------------------------------*/
|
|
/* Private variables ---------------------------------------------------------*/
|
|
/* Private function prototypes -----------------------------------------------*/
|
|
/* Private functions ---------------------------------------------------------*/
|
|
|
|
/** @defgroup PWR_Exported_Functions PWR Exported Functions
|
|
* @{
|
|
*/
|
|
|
|
/** @defgroup PWR_Exported_Functions_Group1 Initialization and de-initialization functions
|
|
* @brief Initialization and de-initialization functions
|
|
*
|
|
@verbatim
|
|
===============================================================================
|
|
##### Initialization and de-initialization functions #####
|
|
===============================================================================
|
|
[..]
|
|
After reset, the backup domain (RTC registers, RTC backup data
|
|
registers and backup SRAM) is protected against possible unwanted
|
|
write accesses.
|
|
To enable access to the RTC Domain and RTC registers, proceed as follows:
|
|
(+) Enable the Power Controller (PWR) APB1 interface clock using the
|
|
__HAL_RCC_PWR_CLK_ENABLE() macro.
|
|
(+) Enable access to RTC domain using the HAL_PWR_EnableBkUpAccess() function.
|
|
|
|
@endverbatim
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Deinitializes the PWR peripheral registers to their default reset values.
|
|
* @retval None
|
|
*/
|
|
void HAL_PWR_DeInit(void)
|
|
{
|
|
__HAL_RCC_PWR_FORCE_RESET();
|
|
__HAL_RCC_PWR_RELEASE_RESET();
|
|
}
|
|
|
|
/**
|
|
* @brief Enables access to the backup domain (RTC registers, RTC
|
|
* backup data registers and backup SRAM).
|
|
* @note If the HSE divided by 32 is used as the RTC clock, the
|
|
* Backup Domain Access should be kept enabled.
|
|
* @retval None
|
|
*/
|
|
void HAL_PWR_EnableBkUpAccess(void)
|
|
{
|
|
SET_BIT(PWR->CR, PWR_CR_DBP);
|
|
}
|
|
|
|
/**
|
|
* @brief Disables access to the backup domain (RTC registers, RTC
|
|
* backup data registers and backup SRAM).
|
|
* @note If the HSE divided by 32 is used as the RTC clock, the
|
|
* Backup Domain Access should be kept enabled.
|
|
* @retval None
|
|
*/
|
|
void HAL_PWR_DisableBkUpAccess(void)
|
|
{
|
|
CLEAR_BIT(PWR->CR, PWR_CR_DBP);
|
|
}
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/** @defgroup PWR_Exported_Functions_Group2 Peripheral Control functions
|
|
* @brief Low Power modes configuration functions
|
|
*
|
|
@verbatim
|
|
|
|
===============================================================================
|
|
##### Peripheral Control functions #####
|
|
===============================================================================
|
|
|
|
*** WakeUp pin configuration ***
|
|
================================
|
|
[..]
|
|
(+) WakeUp pin is used to wakeup the system from Standby mode. This pin is
|
|
forced in input pull down configuration and is active on rising edges.
|
|
(+) There are up to three WakeUp pins:
|
|
(++)WakeUp Pin 1 on PA.00.
|
|
(++)WakeUp Pin 2 on PC.13 (STM32F303xC, STM32F303xE only).
|
|
(++)WakeUp Pin 3 on PE.06.
|
|
|
|
*** Main and Backup Regulators configuration ***
|
|
================================================
|
|
[..]
|
|
(+) When the backup domain is supplied by VDD (analog switch connected to VDD)
|
|
the backup SRAM is powered from VDD which replaces the VBAT power supply to
|
|
save battery life.
|
|
|
|
(+) The backup SRAM is not mass erased by a tamper event. It is read
|
|
protected to prevent confidential data, such as cryptographic private
|
|
key, from being accessed. The backup SRAM can be erased only through
|
|
the Flash interface when a protection level change from level 1 to
|
|
level 0 is requested.
|
|
-@- Refer to the description of Read protection (RDP) in the Flash
|
|
programming manual.
|
|
|
|
Refer to the datasheets for more details.
|
|
|
|
*** Low Power modes configuration ***
|
|
=====================================
|
|
[..]
|
|
The devices feature 3 low-power modes:
|
|
(+) Sleep mode: Cortex-M4 core stopped, peripherals kept running.
|
|
(+) Stop mode: all clocks are stopped, regulator running, regulator
|
|
in low power mode
|
|
(+) Standby mode: 1.2V domain powered off (mode not available on STM32F3x8 devices).
|
|
|
|
*** Sleep mode ***
|
|
==================
|
|
[..]
|
|
(+) Entry:
|
|
The Sleep mode is entered by using the HAL_PWR_EnterSLEEPMode(PWR_MAINREGULATOR_ON, PWR_SLEEPENTRY_WFx)
|
|
functions with
|
|
(++) PWR_SLEEPENTRY_WFI: enter SLEEP mode with WFI instruction
|
|
(++) PWR_SLEEPENTRY_WFE: enter SLEEP mode with WFE instruction
|
|
|
|
(+) Exit:
|
|
(++) Any peripheral interrupt acknowledged by the nested vectored interrupt
|
|
controller (NVIC) can wake up the device from Sleep mode.
|
|
|
|
*** Stop mode ***
|
|
=================
|
|
[..]
|
|
In Stop mode, all clocks in the 1.8V domain are stopped, the PLL, the HSI,
|
|
and the HSE RC oscillators are disabled. Internal SRAM and register contents
|
|
are preserved.
|
|
The voltage regulator can be configured either in normal or low-power mode to minimize the consumption.
|
|
|
|
(+) Entry:
|
|
The Stop mode is entered using the HAL_PWR_EnterSTOPMode(PWR_MAINREGULATOR_ON, PWR_STOPENTRY_WFI )
|
|
function with:
|
|
(++) Main regulator ON or
|
|
(++) Low Power regulator ON.
|
|
(++) PWR_STOPENTRY_WFI: enter STOP mode with WFI instruction or
|
|
(++) PWR_STOPENTRY_WFE: enter STOP mode with WFE instruction
|
|
(+) Exit:
|
|
(++) Any EXTI Line (Internal or External) configured in Interrupt/Event mode.
|
|
(++) Some specific communication peripherals (CEC, USART, I2C) interrupts,
|
|
when programmed in wakeup mode (the peripheral must be
|
|
programmed in wakeup mode and the corresponding interrupt vector
|
|
must be enabled in the NVIC).
|
|
|
|
*** Standby mode ***
|
|
====================
|
|
[..]
|
|
The Standby mode allows to achieve the lowest power consumption. It is based
|
|
on the Cortex-M4 deep sleep mode, with the voltage regulator disabled.
|
|
The 1.8V domain is consequently powered off. The PLL, the HSI oscillator and
|
|
the HSE oscillator are also switched off. SRAM and register contents are lost
|
|
except for the RTC registers, RTC backup registers, backup SRAM and Standby
|
|
circuitry.
|
|
The voltage regulator is OFF.
|
|
|
|
(+) Entry:
|
|
(++) The Standby mode is entered using the HAL_PWR_EnterSTANDBYMode() function.
|
|
(+) Exit:
|
|
(++) WKUP pin rising edge, RTC alarm (Alarm A and Alarm B), RTC wakeup,
|
|
tamper event, time-stamp event, external reset in NRST pin, IWDG reset.
|
|
|
|
*** Auto-wakeup (AWU) from low-power mode ***
|
|
=============================================
|
|
[..]
|
|
The MCU can be woken up from low-power mode by an RTC Alarm event, an RTC
|
|
Wakeup event, a tamper event, a time-stamp event, or a comparator event,
|
|
without depending on an external interrupt (Auto-wakeup mode).
|
|
|
|
(+) RTC auto-wakeup (AWU) from the Stop and Standby modes
|
|
|
|
(++) To wake up from the Stop mode with an RTC alarm event, it is necessary to
|
|
configure the RTC to generate the RTC alarm using the HAL_RTC_SetAlarm_IT() function.
|
|
|
|
(++) To wake up from the Stop mode with an RTC Tamper or time stamp event, it
|
|
is necessary to configure the RTC to detect the tamper or time stamp event using the
|
|
HAL_RTC_SetTimeStamp_IT() or HAL_RTC_SetTamper_IT() functions.
|
|
|
|
(++) To wake up from the Stop mode with an RTC WakeUp event, it is necessary to
|
|
configure the RTC to generate the RTC WakeUp event using the HAL_RTC_SetWakeUpTimer_IT() function.
|
|
|
|
(+) Comparator auto-wakeup (AWU) from the Stop mode
|
|
|
|
(++) To wake up from the Stop mode with a comparator wakeup event, it is necessary to:
|
|
(+++) Configure the EXTI Line associated with the comparator (example EXTI Line 22 for comparator 2U)
|
|
to be sensitive to to the selected edges (falling, rising or falling
|
|
and rising) (Interrupt or Event modes) using the EXTI_Init() function.
|
|
(+++) Configure the comparator to generate the event.
|
|
@endverbatim
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Enables the WakeUp PINx functionality.
|
|
* @param WakeUpPinx Specifies the Power Wake-Up pin to enable.
|
|
* This parameter can be value of :
|
|
* @ref PWR_WakeUp_Pins
|
|
* @retval None
|
|
*/
|
|
void HAL_PWR_EnableWakeUpPin(uint32_t WakeUpPinx)
|
|
{
|
|
/* Check the parameters */
|
|
assert_param(IS_PWR_WAKEUP_PIN(WakeUpPinx));
|
|
/* Enable the EWUPx pin */
|
|
SET_BIT(PWR->CSR, WakeUpPinx);
|
|
}
|
|
|
|
/**
|
|
* @brief Disables the WakeUp PINx functionality.
|
|
* @param WakeUpPinx Specifies the Power Wake-Up pin to disable.
|
|
* This parameter can be values of :
|
|
* @ref PWR_WakeUp_Pins
|
|
* @retval None
|
|
*/
|
|
void HAL_PWR_DisableWakeUpPin(uint32_t WakeUpPinx)
|
|
{
|
|
/* Check the parameters */
|
|
assert_param(IS_PWR_WAKEUP_PIN(WakeUpPinx));
|
|
/* Disable the EWUPx pin */
|
|
CLEAR_BIT(PWR->CSR, WakeUpPinx);
|
|
}
|
|
|
|
/**
|
|
* @brief Enters Sleep mode.
|
|
* @note In Sleep mode, all I/O pins keep the same state as in Run mode.
|
|
* @param Regulator Specifies the regulator state in SLEEP mode.
|
|
* This parameter can be one of the following values:
|
|
* @arg PWR_MAINREGULATOR_ON: SLEEP mode with regulator ON
|
|
* @arg PWR_LOWPOWERREGULATOR_ON: SLEEP mode with low power regulator ON
|
|
* @note This parameter has no effect in F3 family and is just maintained to
|
|
* offer full portability of other STM32 families softwares.
|
|
* @param SLEEPEntry Specifies if SLEEP mode is entered with WFI or WFE instruction.
|
|
* When WFI entry is used, tick interrupt have to be disabled if not desired as
|
|
* the interrupt wake up source.
|
|
* This parameter can be one of the following values:
|
|
* @arg PWR_SLEEPENTRY_WFI: enter SLEEP mode with WFI instruction
|
|
* @arg PWR_SLEEPENTRY_WFE: enter SLEEP mode with WFE instruction
|
|
* @retval None
|
|
*/
|
|
void HAL_PWR_EnterSLEEPMode(uint32_t Regulator, uint8_t SLEEPEntry)
|
|
{
|
|
/* Check the parameters */
|
|
assert_param(IS_PWR_SLEEP_ENTRY(SLEEPEntry));
|
|
|
|
/* Clear SLEEPDEEP bit of Cortex System Control Register */
|
|
SCB->SCR &= (uint32_t)~((uint32_t)SCB_SCR_SLEEPDEEP_Msk);
|
|
|
|
/* Select SLEEP mode entry -------------------------------------------------*/
|
|
if(SLEEPEntry == PWR_SLEEPENTRY_WFI)
|
|
{
|
|
/* Request Wait For Interrupt */
|
|
__WFI();
|
|
}
|
|
else
|
|
{
|
|
/* Request Wait For Event */
|
|
__SEV();
|
|
__WFE();
|
|
__WFE();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @brief Enters STOP mode.
|
|
* @note In Stop mode, all I/O pins keep the same state as in Run mode.
|
|
* @note When exiting Stop mode by issuing an interrupt or a wakeup event,
|
|
* the HSI RC oscillator is selected as system clock.
|
|
* @note When the voltage regulator operates in low power mode, an additional
|
|
* startup delay is incurred when waking up from Stop mode.
|
|
* By keeping the internal regulator ON during Stop mode, the consumption
|
|
* is higher although the startup time is reduced.
|
|
* @param Regulator Specifies the regulator state in STOP mode.
|
|
* This parameter can be one of the following values:
|
|
* @arg PWR_MAINREGULATOR_ON: STOP mode with regulator ON
|
|
* @arg PWR_LOWPOWERREGULATOR_ON: STOP mode with low power regulator ON
|
|
* @param STOPEntry specifies if STOP mode in entered with WFI or WFE instruction.
|
|
* This parameter can be one of the following values:
|
|
* @arg PWR_STOPENTRY_WFI:Enter STOP mode with WFI instruction
|
|
* @arg PWR_STOPENTRY_WFE: Enter STOP mode with WFE instruction
|
|
* @retval None
|
|
*/
|
|
void HAL_PWR_EnterSTOPMode(uint32_t Regulator, uint8_t STOPEntry)
|
|
{
|
|
uint32_t tmpreg = 0U;
|
|
|
|
/* Check the parameters */
|
|
assert_param(IS_PWR_REGULATOR(Regulator));
|
|
assert_param(IS_PWR_STOP_ENTRY(STOPEntry));
|
|
|
|
/* Select the regulator state in STOP mode ---------------------------------*/
|
|
tmpreg = PWR->CR;
|
|
|
|
/* Clear PDDS and LPDS bits */
|
|
tmpreg &= (uint32_t)~(PWR_CR_PDDS | PWR_CR_LPDS);
|
|
|
|
/* Set LPDS bit according to Regulator value */
|
|
tmpreg |= Regulator;
|
|
|
|
/* Store the new value */
|
|
PWR->CR = tmpreg;
|
|
|
|
/* Set SLEEPDEEP bit of Cortex System Control Register */
|
|
SCB->SCR |= SCB_SCR_SLEEPDEEP_Msk;
|
|
|
|
/* Select STOP mode entry --------------------------------------------------*/
|
|
if(STOPEntry == PWR_STOPENTRY_WFI)
|
|
{
|
|
/* Request Wait For Interrupt */
|
|
__WFI();
|
|
}
|
|
else
|
|
{
|
|
/* Request Wait For Event */
|
|
__SEV();
|
|
__WFE();
|
|
__WFE();
|
|
}
|
|
|
|
/* Reset SLEEPDEEP bit of Cortex System Control Register */
|
|
SCB->SCR &= (uint32_t)~((uint32_t)SCB_SCR_SLEEPDEEP_Msk);
|
|
}
|
|
|
|
/**
|
|
* @brief Enters STANDBY mode.
|
|
* @note In Standby mode, all I/O pins are high impedance except for:
|
|
* - Reset pad (still available),
|
|
* - RTC alternate function pins if configured for tamper, time-stamp, RTC
|
|
* Alarm out, or RTC clock calibration out,
|
|
* - WKUP pins if enabled.
|
|
* @retval None
|
|
*/
|
|
void HAL_PWR_EnterSTANDBYMode(void)
|
|
{
|
|
/* Select STANDBY mode */
|
|
PWR->CR |= PWR_CR_PDDS;
|
|
|
|
/* Set SLEEPDEEP bit of Cortex System Control Register */
|
|
SCB->SCR |= SCB_SCR_SLEEPDEEP_Msk;
|
|
|
|
/* This option is used to ensure that store operations are completed */
|
|
#if defined ( __CC_ARM)
|
|
__force_stores();
|
|
#endif
|
|
/* Request Wait For Interrupt */
|
|
__WFI();
|
|
}
|
|
|
|
/**
|
|
* @brief Indicates Sleep-On-Exit when returning from Handler mode to Thread mode.
|
|
* @note Set SLEEPONEXIT bit of SCR register. When this bit is set, the processor
|
|
* re-enters SLEEP mode when an interruption handling is over.
|
|
* Setting this bit is useful when the processor is expected to run only on
|
|
* interruptions handling.
|
|
* @retval None
|
|
*/
|
|
void HAL_PWR_EnableSleepOnExit(void)
|
|
{
|
|
/* Set SLEEPONEXIT bit of Cortex System Control Register */
|
|
SET_BIT(SCB->SCR, ((uint32_t)SCB_SCR_SLEEPONEXIT_Msk));
|
|
}
|
|
|
|
|
|
/**
|
|
* @brief Disables Sleep-On-Exit feature when returning from Handler mode to Thread mode.
|
|
* @note Clears SLEEPONEXIT bit of SCR register. When this bit is set, the processor
|
|
* re-enters SLEEP mode when an interruption handling is over.
|
|
* @retval None
|
|
*/
|
|
void HAL_PWR_DisableSleepOnExit(void)
|
|
{
|
|
/* Clear SLEEPONEXIT bit of Cortex System Control Register */
|
|
CLEAR_BIT(SCB->SCR, ((uint32_t)SCB_SCR_SLEEPONEXIT_Msk));
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* @brief Enables CORTEX M4 SEVONPEND bit.
|
|
* @note Sets SEVONPEND bit of SCR register. When this bit is set, this causes
|
|
* WFE to wake up when an interrupt moves from inactive to pended.
|
|
* @retval None
|
|
*/
|
|
void HAL_PWR_EnableSEVOnPend(void)
|
|
{
|
|
/* Set SEVONPEND bit of Cortex System Control Register */
|
|
SET_BIT(SCB->SCR, ((uint32_t)SCB_SCR_SEVONPEND_Msk));
|
|
}
|
|
|
|
|
|
/**
|
|
* @brief Disables CORTEX M4 SEVONPEND bit.
|
|
* @note Clears SEVONPEND bit of SCR register. When this bit is set, this causes
|
|
* WFE to wake up when an interrupt moves from inactive to pended.
|
|
* @retval None
|
|
*/
|
|
void HAL_PWR_DisableSEVOnPend(void)
|
|
{
|
|
/* Clear SEVONPEND bit of Cortex System Control Register */
|
|
CLEAR_BIT(SCB->SCR, ((uint32_t)SCB_SCR_SEVONPEND_Msk));
|
|
}
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /* HAL_PWR_MODULE_ENABLED */
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|