STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
PWREx Exported Constants
Collaboration diagram for PWREx Exported Constants:

Topics

 PWREx Regulator state in UnderDrive mode
 
 PWREx Over Under Drive Flag
 
 PWREx Regulator Voltage Scale
 
 PWREx WakeUp Pins
 

Macros

#define __HAL_PWR_VOLTAGESCALING_CONFIG(__REGULATOR__)
 macros configure the main internal regulator output voltage.
 
#define __HAL_PWR_OVERDRIVE_ENABLE()
 Macros to enable or disable the Over drive mode.
 
#define __HAL_PWR_OVERDRIVE_DISABLE()
 
#define __HAL_PWR_OVERDRIVESWITCHING_ENABLE()
 Macros to enable or disable the Over drive switching.
 
#define __HAL_PWR_OVERDRIVESWITCHING_DISABLE()
 
#define __HAL_PWR_UNDERDRIVE_ENABLE()
 Macros to enable or disable the Under drive mode.
 
#define __HAL_PWR_UNDERDRIVE_DISABLE()
 
#define __HAL_PWR_GET_ODRUDR_FLAG(__FLAG__)
 Check PWR flag is set or not.
 
#define __HAL_PWR_CLEAR_ODRUDR_FLAG()
 Clear the Under-Drive Ready flag.
 

Detailed Description

Macro Definition Documentation

◆ __HAL_PWR_VOLTAGESCALING_CONFIG

#define __HAL_PWR_VOLTAGESCALING_CONFIG ( __REGULATOR__)

#include <stm32f4xx_hal_pwr_ex.h>

Value:
do { \
__IO uint32_t tmpreg = 0x00U; \
MODIFY_REG(PWR->CR, PWR_CR_VOS, (__REGULATOR__)); \
/* Delay after an RCC peripheral clock enabling */ \
tmpreg = READ_BIT(PWR->CR, PWR_CR_VOS); \
UNUSED(tmpreg); \
} while(0U)

macros configure the main internal regulator output voltage.

Parameters
__REGULATOR__specifies the regulator output voltage to achieve a tradeoff between performance and power consumption when the device does not operate at the maximum frequency (refer to the datasheets for more details). This parameter can be one of the following values:
  • PWR_REGULATOR_VOLTAGE_SCALE1: Regulator voltage output Scale 1 mode
  • PWR_REGULATOR_VOLTAGE_SCALE2: Regulator voltage output Scale 2 mode
  • PWR_REGULATOR_VOLTAGE_SCALE3: Regulator voltage output Scale 3 mode
Return values
None

Definition at line 133 of file stm32f4xx_hal_pwr_ex.h.

Referenced by HAL_PWREx_ControlVoltageScaling().

◆ __HAL_PWR_OVERDRIVE_ENABLE

#define __HAL_PWR_OVERDRIVE_ENABLE ( )

#include <stm32f4xx_hal_pwr_ex.h>

Value:
(*(__IO uint32_t *) CR_ODEN_BB = ENABLE)
#define CR_ODEN_BB

Macros to enable or disable the Over drive mode.

Note
These macros can be used only for STM32F42xx/STM3243xx devices.

Definition at line 147 of file stm32f4xx_hal_pwr_ex.h.

Referenced by HAL_PWREx_EnableOverDrive().

◆ __HAL_PWR_OVERDRIVE_DISABLE

#define __HAL_PWR_OVERDRIVE_DISABLE ( )

#include <stm32f4xx_hal_pwr_ex.h>

Value:
(*(__IO uint32_t *) CR_ODEN_BB = DISABLE)

Definition at line 148 of file stm32f4xx_hal_pwr_ex.h.

Referenced by HAL_PWREx_DisableOverDrive().

◆ __HAL_PWR_OVERDRIVESWITCHING_ENABLE

#define __HAL_PWR_OVERDRIVESWITCHING_ENABLE ( )

#include <stm32f4xx_hal_pwr_ex.h>

Value:
(*(__IO uint32_t *) CR_ODSWEN_BB = ENABLE)
#define CR_ODSWEN_BB

Macros to enable or disable the Over drive switching.

Note
These macros can be used only for STM32F42xx/STM3243xx devices.

Definition at line 153 of file stm32f4xx_hal_pwr_ex.h.

Referenced by HAL_PWREx_EnableOverDrive().

◆ __HAL_PWR_OVERDRIVESWITCHING_DISABLE

#define __HAL_PWR_OVERDRIVESWITCHING_DISABLE ( )

#include <stm32f4xx_hal_pwr_ex.h>

Value:
(*(__IO uint32_t *) CR_ODSWEN_BB = DISABLE)

Definition at line 154 of file stm32f4xx_hal_pwr_ex.h.

Referenced by HAL_PWREx_DisableOverDrive().

◆ __HAL_PWR_UNDERDRIVE_ENABLE

#define __HAL_PWR_UNDERDRIVE_ENABLE ( )

#include <stm32f4xx_hal_pwr_ex.h>

Value:
(PWR->CR |= (uint32_t)PWR_CR_UDEN)

Macros to enable or disable the Under drive mode.

Note
This mode is enabled only with STOP low power mode. In this mode, the 1.2V domain is preserved in reduced leakage mode. This mode is only available when the main regulator or the low power regulator is in low voltage mode.
If the Under-drive mode was enabled, it is automatically disabled after exiting Stop mode. When the voltage regulator operates in Under-drive mode, an additional
startup delay is induced when waking up from Stop mode.

Definition at line 166 of file stm32f4xx_hal_pwr_ex.h.

Referenced by HAL_PWREx_EnterUnderDriveSTOPMode().

◆ __HAL_PWR_UNDERDRIVE_DISABLE

#define __HAL_PWR_UNDERDRIVE_DISABLE ( )

#include <stm32f4xx_hal_pwr_ex.h>

Value:
(PWR->CR &= (uint32_t)(~PWR_CR_UDEN))

Definition at line 167 of file stm32f4xx_hal_pwr_ex.h.

◆ __HAL_PWR_GET_ODRUDR_FLAG

#define __HAL_PWR_GET_ODRUDR_FLAG ( __FLAG__)

#include <stm32f4xx_hal_pwr_ex.h>

Value:
((PWR->CSR & (__FLAG__)) == (__FLAG__))

Check PWR flag is set or not.

Note
These macros can be used only for STM32F42xx/STM3243xx devices.
Parameters
__FLAG__specifies the flag to check. This parameter can be one of the following values:
  • PWR_FLAG_ODRDY: This flag indicates that the Over-drive mode is ready
  • PWR_FLAG_ODSWRDY: This flag indicates that the Over-drive mode switching is ready
  • PWR_FLAG_UDRDY: This flag indicates that the Under-drive mode is enabled in Stop mode
Return values
Thenew state of FLAG (TRUE or FALSE).

Definition at line 181 of file stm32f4xx_hal_pwr_ex.h.

◆ __HAL_PWR_CLEAR_ODRUDR_FLAG

#define __HAL_PWR_CLEAR_ODRUDR_FLAG ( )

#include <stm32f4xx_hal_pwr_ex.h>

Value:
(PWR->CSR |= PWR_FLAG_UDRDY)
#define PWR_FLAG_UDRDY

Clear the Under-Drive Ready flag.

Note
These macros can be used only for STM32F42xx/STM3243xx devices.

Definition at line 186 of file stm32f4xx_hal_pwr_ex.h.

Referenced by HAL_PWREx_EnterUnderDriveSTOPMode().