HAL_PWR_EnterSLEEPMode() function

Enters Sleep mode.

Syntax

Show:

Summary

Declaration

Definition

from stm32f4xx_hal_pwr.h:308

void HAL_PWR_EnterSLEEPMode(uint32_t Regulator, uint8_t SLEEPEntry);

Implemented in stm32f4xx_hal_pwr.c:391

Arguments

Argument

Description

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

SLEEPEntry

Specifies if SLEEP mode in entered with WFI or WFE instruction. 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 and clear of pending events before. @arg PWR_SLEEPENTRY_WFE_NO_EVT_CLEAR : Enter SLEEP mode with WFE instruction and no clear of pending event before.

Return value

None

Notes

In Sleep mode, all I/O pins keep the same state as in Run mode. In Sleep mode, the systick is stopped to avoid exit from this mode with systick interrupt when used as time base for Timeout This parameter is not used for the STM32F4 family and is kept as parameter just to maintain compatibility with the lower power families.

Examples

HAL_PWR_EnterSLEEPMode() is referenced by 19 libraries and example projects:

References

from examples

HAL_PWR_EnterSLEEPMode() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle