stm32f4xx_hal_pwr.h File Reference

Header file of PWR HAL module. More...

#include "stm32f4xx_hal_def.h"
#include "stm32f4xx_hal_pwr_ex.h"

Go to the source code of this file.

Data Structures
struct	PWR_PVDTypeDef
	PWR PVD configuration structure definition. More...
Defines
#define	PWR_WAKEUP_PIN1   0x00000100U
#define	PWR_PVDLEVEL_0   PWR_CR_PLS_LEV0
#define	PWR_PVDLEVEL_1   PWR_CR_PLS_LEV1
#define	PWR_PVDLEVEL_2   PWR_CR_PLS_LEV2
#define	PWR_PVDLEVEL_3   PWR_CR_PLS_LEV3
#define	PWR_PVDLEVEL_4   PWR_CR_PLS_LEV4
#define	PWR_PVDLEVEL_5   PWR_CR_PLS_LEV5
#define	PWR_PVDLEVEL_6   PWR_CR_PLS_LEV6
#define	PWR_PVDLEVEL_7
#define	PWR_PVD_MODE_NORMAL   0x00000000U
#define	PWR_PVD_MODE_IT_RISING   0x00010001U
#define	PWR_PVD_MODE_IT_FALLING   0x00010002U
#define	PWR_PVD_MODE_IT_RISING_FALLING   0x00010003U
#define	PWR_PVD_MODE_EVENT_RISING   0x00020001U
#define	PWR_PVD_MODE_EVENT_FALLING   0x00020002U
#define	PWR_PVD_MODE_EVENT_RISING_FALLING   0x00020003U
#define	PWR_MAINREGULATOR_ON   0x00000000U
#define	PWR_LOWPOWERREGULATOR_ON   PWR_CR_LPDS
#define	PWR_SLEEPENTRY_WFI   ((uint8_t)0x01)
#define	PWR_SLEEPENTRY_WFE   ((uint8_t)0x02)
#define	PWR_STOPENTRY_WFI   ((uint8_t)0x01)
#define	PWR_STOPENTRY_WFE   ((uint8_t)0x02)
#define	PWR_FLAG_WU   PWR_CSR_WUF
#define	PWR_FLAG_SB   PWR_CSR_SBF
#define	PWR_FLAG_PVDO   PWR_CSR_PVDO
#define	PWR_FLAG_BRR   PWR_CSR_BRR
#define	PWR_FLAG_VOSRDY   PWR_CSR_VOSRDY
#define	__HAL_PWR_GET_FLAG(__FLAG__)   ((PWR->CSR & (__FLAG__)) == (__FLAG__))
	Check PWR flag is set or not.
#define	__HAL_PWR_CLEAR_FLAG(__FLAG__)   (PWR->CR |= (__FLAG__) << 2U)
	Clear the PWR's pending flags.
#define	__HAL_PWR_PVD_EXTI_ENABLE_IT()   (EXTI->IMR |= (PWR_EXTI_LINE_PVD))
	Enable the PVD Exti Line 16.
#define	__HAL_PWR_PVD_EXTI_DISABLE_IT()   (EXTI->IMR &= ~(PWR_EXTI_LINE_PVD))
	Disable the PVD EXTI Line 16.
#define	__HAL_PWR_PVD_EXTI_ENABLE_EVENT()   (EXTI->EMR |= (PWR_EXTI_LINE_PVD))
	Enable event on PVD Exti Line 16.
#define	__HAL_PWR_PVD_EXTI_DISABLE_EVENT()   (EXTI->EMR &= ~(PWR_EXTI_LINE_PVD))
	Disable event on PVD Exti Line 16.
#define	__HAL_PWR_PVD_EXTI_ENABLE_RISING_EDGE()   SET_BIT(EXTI->RTSR, PWR_EXTI_LINE_PVD)
	Enable the PVD Extended Interrupt Rising Trigger.
#define	__HAL_PWR_PVD_EXTI_DISABLE_RISING_EDGE()   CLEAR_BIT(EXTI->RTSR, PWR_EXTI_LINE_PVD)
	Disable the PVD Extended Interrupt Rising Trigger.
#define	__HAL_PWR_PVD_EXTI_ENABLE_FALLING_EDGE()   SET_BIT(EXTI->FTSR, PWR_EXTI_LINE_PVD)
	Enable the PVD Extended Interrupt Falling Trigger.
#define	__HAL_PWR_PVD_EXTI_DISABLE_FALLING_EDGE()   CLEAR_BIT(EXTI->FTSR, PWR_EXTI_LINE_PVD)
	Disable the PVD Extended Interrupt Falling Trigger.
#define	__HAL_PWR_PVD_EXTI_ENABLE_RISING_FALLING_EDGE()
	PVD EXTI line configuration: set rising & falling edge trigger.
#define	__HAL_PWR_PVD_EXTI_DISABLE_RISING_FALLING_EDGE()
	Disable the PVD Extended Interrupt Rising & Falling Trigger.
#define	__HAL_PWR_PVD_EXTI_GET_FLAG()   (EXTI->PR & (PWR_EXTI_LINE_PVD))
	checks whether the specified PVD Exti interrupt flag is set or not.
#define	__HAL_PWR_PVD_EXTI_CLEAR_FLAG()   (EXTI->PR = (PWR_EXTI_LINE_PVD))
	Clear the PVD Exti flag.
#define	__HAL_PWR_PVD_EXTI_GENERATE_SWIT()   (EXTI->SWIER |= (PWR_EXTI_LINE_PVD))
	Generates a Software interrupt on PVD EXTI line.
#define	PWR_EXTI_LINE_PVD   ((uint32_t)EXTI_IMR_MR16)
#define	PWR_OFFSET   (PWR_BASE - PERIPH_BASE)
#define	PWR_CR_OFFSET   0x00U
#define	PWR_CSR_OFFSET   0x04U
#define	PWR_CR_OFFSET_BB   (PWR_OFFSET + PWR_CR_OFFSET)
#define	PWR_CSR_OFFSET_BB   (PWR_OFFSET + PWR_CSR_OFFSET)
#define	DBP_BIT_NUMBER   PWR_CR_DBP_Pos
#define	CR_DBP_BB   (uint32_t)(PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32U) + (DBP_BIT_NUMBER * 4U))
#define	PVDE_BIT_NUMBER   PWR_CR_PVDE_Pos
#define	CR_PVDE_BB   (uint32_t)(PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32U) + (PVDE_BIT_NUMBER * 4U))
#define	VOS_BIT_NUMBER   PWR_CR_VOS_Pos
#define	CR_VOS_BB   (uint32_t)(PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32U) + (VOS_BIT_NUMBER * 4U))
#define	EWUP_BIT_NUMBER   PWR_CSR_EWUP_Pos
#define	CSR_EWUP_BB   (PERIPH_BB_BASE + (PWR_CSR_OFFSET_BB * 32U) + (EWUP_BIT_NUMBER * 4U))
#define	IS_PWR_PVD_LEVEL(LEVEL)
#define	IS_PWR_PVD_MODE(MODE)
#define	IS_PWR_REGULATOR(REGULATOR)
#define	IS_PWR_SLEEP_ENTRY(ENTRY)   (((ENTRY) == PWR_SLEEPENTRY_WFI) || ((ENTRY) == PWR_SLEEPENTRY_WFE))
#define	IS_PWR_STOP_ENTRY(ENTRY)   (((ENTRY) == PWR_STOPENTRY_WFI) || ((ENTRY) == PWR_STOPENTRY_WFE))
Functions
void	HAL_PWR_DeInit (void)
	Deinitializes the HAL PWR peripheral registers to their default reset values.
void	HAL_PWR_EnableBkUpAccess (void)
	Enables access to the backup domain (RTC registers, RTC backup data registers and backup SRAM).
void	HAL_PWR_DisableBkUpAccess (void)
	Disables access to the backup domain (RTC registers, RTC backup data registers and backup SRAM).
void	HAL_PWR_ConfigPVD (PWR_PVDTypeDef *sConfigPVD)
	Configures the voltage threshold detected by the Power Voltage Detector(PVD).
void	HAL_PWR_EnablePVD (void)
	Enables the Power Voltage Detector(PVD).
void	HAL_PWR_DisablePVD (void)
	Disables the Power Voltage Detector(PVD).
void	HAL_PWR_EnableWakeUpPin (uint32_t WakeUpPinx)
	Enables the Wake-up PINx functionality.
void	HAL_PWR_DisableWakeUpPin (uint32_t WakeUpPinx)
	Disables the Wake-up PINx functionality.
void	HAL_PWR_EnterSTOPMode (uint32_t Regulator, uint8_t STOPEntry)
	Enters Stop mode.
void	HAL_PWR_EnterSLEEPMode (uint32_t Regulator, uint8_t SLEEPEntry)
	Enters Sleep mode.
void	HAL_PWR_EnterSTANDBYMode (void)
	Enters Standby mode.
void	HAL_PWR_PVD_IRQHandler (void)
	This function handles the PWR PVD interrupt request.
__weak void	HAL_PWR_PVDCallback (void)
	PWR PVD interrupt callback.
void	HAL_PWR_EnableSleepOnExit (void)
	Indicates Sleep-On-Exit when returning from Handler mode to Thread mode.
void	HAL_PWR_DisableSleepOnExit (void)
	Disables Sleep-On-Exit feature when returning from Handler mode to Thread mode.
void	HAL_PWR_EnableSEVOnPend (void)
	Enables CORTEX M4 SEVONPEND bit.
void	HAL_PWR_DisableSEVOnPend (void)
	Disables CORTEX M4 SEVONPEND bit.

---

Detailed Description

Header file of PWR HAL module.

Author:

MCD Application Team

Attention:

© COPYRIGHT(c) 2017 STMicroelectronics

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32f4xx_hal_pwr.h.