2 ******************************************************************************
3 * @file stm32f4xx_hal_pwr_ex.h
4 * @author MCD Application Team
7 * @brief Header file of PWR HAL Extension module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
13 * Redistribution and use in source and binary forms, with or without modification,
14 * are permitted provided that the following conditions are met:
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 ******************************************************************************
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F4xx_HAL_PWR_EX_H
40 #define __STM32F4xx_HAL_PWR_EX_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f4xx_hal_def.h"
49 /** @addtogroup STM32F4xx_HAL_Driver
57 /* Exported types ------------------------------------------------------------*/
58 /* Exported constants --------------------------------------------------------*/
59 /* ------------- PWR registers bit address in the alias region ---------------*/
60 /* --- CR Register ---*/
61 /* Alias word address of FPDS bit */
62 #define FPDS_BitNumber 0x09
63 #define CR_FPDS_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (FPDS_BitNumber * 4))
65 /* Alias word address of ODEN bit */
66 #define ODEN_BitNumber 0x10
67 #define CR_ODEN_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (ODEN_BitNumber * 4))
69 /* Alias word address of ODSWEN bit */
70 #define ODSWEN_BitNumber 0x11
71 #define CR_ODSWEN_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (ODSWEN_BitNumber * 4))
73 /* Alias word address of MRLVDS bit */
74 #define MRLVDS_BitNumber 0x0B
75 #define CR_MRLVDS_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (MRLVDS_BitNumber * 4))
77 /* Alias word address of LPLVDS bit */
78 #define LPLVDS_BitNumber 0x0A
79 #define CR_LPLVDS_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (LPLVDS_BitNumber * 4))
81 /* --- CSR Register ---*/
82 /* Alias word address of BRE bit */
83 #define BRE_BitNumber 0x09
84 #define CSR_BRE_BB (PERIPH_BB_BASE + (CSR_OFFSET * 32) + (BRE_BitNumber * 4))
86 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
88 /** @defgroup PWREx_Regulator_state_in_UnderDrive_mode
91 #define PWR_MAINREGULATOR_UNDERDRIVE_ON PWR_CR_MRUDS
92 #define PWR_LOWPOWERREGULATOR_UNDERDRIVE_ON ((uint32_t)(PWR_CR_LPDS | PWR_CR_LPUDS))
94 #define IS_PWR_REGULATOR_UNDERDRIVE(REGULATOR) (((REGULATOR) == PWR_MAINREGULATOR_UNDERDRIVE_ON) || \
95 ((REGULATOR) == PWR_LOWPOWERREGULATOR_UNDERDRIVE_ON))
100 /** @defgroup PWREx_Over_Under_Drive_Flag
103 #define PWR_FLAG_ODRDY PWR_CSR_ODRDY
104 #define PWR_FLAG_ODSWRDY PWR_CSR_ODSWRDY
105 #define PWR_FLAG_UDRDY PWR_CSR_UDSWRDY
109 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
114 /* Exported macro ------------------------------------------------------------*/
116 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
117 /** @brief Macros to enable or disable the Over drive mode.
118 * @note These macros can be used only for STM32F42xx/STM3243xx devices.
120 #define __HAL_PWR_OVERDRIVE_ENABLE() (*(__IO uint32_t *) CR_ODEN_BB = ENABLE)
121 #define __HAL_PWR_OVERDRIVE_DISABLE() (*(__IO uint32_t *) CR_ODEN_BB = DISABLE)
123 /** @brief Macros to enable or disable the Over drive switching.
124 * @note These macros can be used only for STM32F42xx/STM3243xx devices.
126 #define __HAL_PWR_OVERDRIVESWITCHING_ENABLE() (*(__IO uint32_t *) CR_ODSWEN_BB = ENABLE)
127 #define __HAL_PWR_OVERDRIVESWITCHING_DISABLE() (*(__IO uint32_t *) CR_ODSWEN_BB = DISABLE)
129 /** @brief Macros to enable or disable the Under drive mode.
130 * @note This mode is enabled only with STOP low power mode.
131 * In this mode, the 1.2V domain is preserved in reduced leakage mode. This
132 * mode is only available when the main regulator or the low power regulator
133 * is in low voltage mode.
134 * @note If the Under-drive mode was enabled, it is automatically disabled after
136 * When the voltage regulator operates in Under-drive mode, an additional
137 * startup delay is induced when waking up from Stop mode.
139 #define __HAL_PWR_UNDERDRIVE_ENABLE() (PWR->CR |= (uint32_t)PWR_CR_UDEN)
140 #define __HAL_PWR_UNDERDRIVE_DISABLE() (PWR->CR &= (uint32_t)(~PWR_CR_UDEN))
142 /** @brief Check PWR flag is set or not.
143 * @note These macros can be used only for STM32F42xx/STM3243xx devices.
144 * @param __FLAG__: specifies the flag to check.
145 * This parameter can be one of the following values:
146 * @arg PWR_FLAG_ODRDY: This flag indicates that the Over-drive mode
148 * @arg PWR_FLAG_ODSWRDY: This flag indicates that the Over-drive mode
150 * @arg PWR_FLAG_UDRDY: This flag indicates that the Under-drive mode
151 * is enabled in Stop mode
152 * @retval The new state of __FLAG__ (TRUE or FALSE).
154 #define __HAL_PWR_GET_ODRUDR_FLAG(__FLAG__) ((PWR->CSR & (__FLAG__)) == (__FLAG__))
156 /** @brief Clear the Under-Drive Ready flag.
157 * @note These macros can be used only for STM32F42xx/STM3243xx devices.
159 #define __HAL_PWR_CLEAR_ODRUDR_FLAG() (PWR->CSR |= PWR_FLAG_UDRDY)
161 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
163 /* Exported functions --------------------------------------------------------*/
164 void HAL_PWREx_EnableFlashPowerDown(void);
165 void HAL_PWREx_DisableFlashPowerDown(void);
166 HAL_StatusTypeDef HAL_PWREx_EnableBkUpReg(void);
167 HAL_StatusTypeDef HAL_PWREx_DisableBkUpReg(void);
169 #if defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE)
170 void HAL_PWREx_EnableMainRegulatorLowVoltage(void);
171 void HAL_PWREx_DisableMainRegulatorLowVoltage(void);
172 void HAL_PWREx_EnableLowRegulatorLowVoltage(void);
173 void HAL_PWREx_DisableLowRegulatorLowVoltage(void);
174 #endif /* STM32F401xC || STM32F401xE || STM32F411xE */
176 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
177 HAL_StatusTypeDef HAL_PWREx_ActivateOverDrive(void);
178 HAL_StatusTypeDef HAL_PWREx_DeactivateOverDrive(void);
179 HAL_StatusTypeDef HAL_PWREx_EnterUnderDriveSTOPMode(uint32_t Regulator, uint8_t STOPEntry);
180 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
195 #endif /* __STM32F4xx_HAL_PWR_EX_H */
197 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/