|
38
|
1 /**
|
|
|
2 ******************************************************************************
|
|
|
3 * @file stm32f4xx_hal_pwr_ex.h
|
|
|
4 * @author MCD Application Team
|
|
|
5 * @version V1.2.0
|
|
|
6 * @date 26-December-2014
|
|
|
7 * @brief Header file of PWR HAL Extension module.
|
|
|
8 ******************************************************************************
|
|
|
9 * @attention
|
|
|
10 *
|
|
|
11 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
|
|
|
12 *
|
|
|
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.
|
|
|
23 *
|
|
|
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.
|
|
|
34 *
|
|
|
35 ******************************************************************************
|
|
|
36 */
|
|
|
37
|
|
|
38 /* Define to prevent recursive inclusion -------------------------------------*/
|
|
|
39 #ifndef __STM32F4xx_HAL_PWR_EX_H
|
|
|
40 #define __STM32F4xx_HAL_PWR_EX_H
|
|
|
41
|
|
|
42 #ifdef __cplusplus
|
|
|
43 extern "C" {
|
|
|
44 #endif
|
|
|
45
|
|
|
46 /* Includes ------------------------------------------------------------------*/
|
|
|
47 #include "stm32f4xx_hal_def.h"
|
|
|
48
|
|
|
49 /** @addtogroup STM32F4xx_HAL_Driver
|
|
|
50 * @{
|
|
|
51 */
|
|
|
52
|
|
|
53 /** @addtogroup PWREx
|
|
|
54 * @{
|
|
|
55 */
|
|
|
56
|
|
|
57 /* Exported types ------------------------------------------------------------*/
|
|
|
58 /* Exported constants --------------------------------------------------------*/
|
|
|
59 /** @defgroup PWREx_Exported_Constants PWREx Exported Constants
|
|
|
60 * @{
|
|
|
61 */
|
|
|
62
|
|
|
63 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
|
|
|
64
|
|
|
65 /** @defgroup PWREx_Regulator_state_in_UnderDrive_mode PWREx Regulator state in UnderDrive mode
|
|
|
66 * @{
|
|
|
67 */
|
|
|
68 #define PWR_MAINREGULATOR_UNDERDRIVE_ON PWR_CR_MRUDS
|
|
|
69 #define PWR_LOWPOWERREGULATOR_UNDERDRIVE_ON ((uint32_t)(PWR_CR_LPDS | PWR_CR_LPUDS))
|
|
|
70 /**
|
|
|
71 * @}
|
|
|
72 */
|
|
|
73
|
|
|
74 /** @defgroup PWREx_Over_Under_Drive_Flag PWREx Over Under Drive Flag
|
|
|
75 * @{
|
|
|
76 */
|
|
|
77 #define PWR_FLAG_ODRDY PWR_CSR_ODRDY
|
|
|
78 #define PWR_FLAG_ODSWRDY PWR_CSR_ODSWRDY
|
|
|
79 #define PWR_FLAG_UDRDY PWR_CSR_UDSWRDY
|
|
|
80 /**
|
|
|
81 * @}
|
|
|
82 */
|
|
|
83 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
|
|
|
84
|
|
|
85 /**
|
|
|
86 * @}
|
|
|
87 */
|
|
|
88
|
|
|
89 /* Exported macro ------------------------------------------------------------*/
|
|
|
90 /** @defgroup PWREx_Exported_Constants PWREx Exported Constants
|
|
|
91 * @{
|
|
|
92 */
|
|
|
93 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
|
|
|
94 /** @brief Macros to enable or disable the Over drive mode.
|
|
|
95 * @note These macros can be used only for STM32F42xx/STM3243xx devices.
|
|
|
96 */
|
|
|
97 #define __HAL_PWR_OVERDRIVE_ENABLE() (*(__IO uint32_t *) CR_ODEN_BB = ENABLE)
|
|
|
98 #define __HAL_PWR_OVERDRIVE_DISABLE() (*(__IO uint32_t *) CR_ODEN_BB = DISABLE)
|
|
|
99
|
|
|
100 /** @brief Macros to enable or disable the Over drive switching.
|
|
|
101 * @note These macros can be used only for STM32F42xx/STM3243xx devices.
|
|
|
102 */
|
|
|
103 #define __HAL_PWR_OVERDRIVESWITCHING_ENABLE() (*(__IO uint32_t *) CR_ODSWEN_BB = ENABLE)
|
|
|
104 #define __HAL_PWR_OVERDRIVESWITCHING_DISABLE() (*(__IO uint32_t *) CR_ODSWEN_BB = DISABLE)
|
|
|
105
|
|
|
106 /** @brief Macros to enable or disable the Under drive mode.
|
|
|
107 * @note This mode is enabled only with STOP low power mode.
|
|
|
108 * In this mode, the 1.2V domain is preserved in reduced leakage mode. This
|
|
|
109 * mode is only available when the main regulator or the low power regulator
|
|
|
110 * is in low voltage mode.
|
|
|
111 * @note If the Under-drive mode was enabled, it is automatically disabled after
|
|
|
112 * exiting Stop mode.
|
|
|
113 * When the voltage regulator operates in Under-drive mode, an additional
|
|
|
114 * startup delay is induced when waking up from Stop mode.
|
|
|
115 */
|
|
|
116 #define __HAL_PWR_UNDERDRIVE_ENABLE() (PWR->CR |= (uint32_t)PWR_CR_UDEN)
|
|
|
117 #define __HAL_PWR_UNDERDRIVE_DISABLE() (PWR->CR &= (uint32_t)(~PWR_CR_UDEN))
|
|
|
118
|
|
|
119 /** @brief Check PWR flag is set or not.
|
|
|
120 * @note These macros can be used only for STM32F42xx/STM3243xx devices.
|
|
|
121 * @param __FLAG__: specifies the flag to check.
|
|
|
122 * This parameter can be one of the following values:
|
|
|
123 * @arg PWR_FLAG_ODRDY: This flag indicates that the Over-drive mode
|
|
|
124 * is ready
|
|
|
125 * @arg PWR_FLAG_ODSWRDY: This flag indicates that the Over-drive mode
|
|
|
126 * switching is ready
|
|
|
127 * @arg PWR_FLAG_UDRDY: This flag indicates that the Under-drive mode
|
|
|
128 * is enabled in Stop mode
|
|
|
129 * @retval The new state of __FLAG__ (TRUE or FALSE).
|
|
|
130 */
|
|
|
131 #define __HAL_PWR_GET_ODRUDR_FLAG(__FLAG__) ((PWR->CSR & (__FLAG__)) == (__FLAG__))
|
|
|
132
|
|
|
133 /** @brief Clear the Under-Drive Ready flag.
|
|
|
134 * @note These macros can be used only for STM32F42xx/STM3243xx devices.
|
|
|
135 */
|
|
|
136 #define __HAL_PWR_CLEAR_ODRUDR_FLAG() (PWR->CSR |= PWR_FLAG_UDRDY)
|
|
|
137
|
|
|
138 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
|
|
|
139 /**
|
|
|
140 * @}
|
|
|
141 */
|
|
|
142
|
|
|
143 /* Exported functions --------------------------------------------------------*/
|
|
|
144 /** @addtogroup PWREx_Exported_Functions PWREx Exported Functions
|
|
|
145 * @{
|
|
|
146 */
|
|
|
147
|
|
|
148 /** @addtogroup PWREx_Exported_Functions_Group1
|
|
|
149 * @{
|
|
|
150 */
|
|
|
151 void HAL_PWREx_EnableFlashPowerDown(void);
|
|
|
152 void HAL_PWREx_DisableFlashPowerDown(void);
|
|
|
153 HAL_StatusTypeDef HAL_PWREx_EnableBkUpReg(void);
|
|
|
154 HAL_StatusTypeDef HAL_PWREx_DisableBkUpReg(void);
|
|
|
155
|
|
|
156 #if defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE)
|
|
|
157 void HAL_PWREx_EnableMainRegulatorLowVoltage(void);
|
|
|
158 void HAL_PWREx_DisableMainRegulatorLowVoltage(void);
|
|
|
159 void HAL_PWREx_EnableLowRegulatorLowVoltage(void);
|
|
|
160 void HAL_PWREx_DisableLowRegulatorLowVoltage(void);
|
|
|
161 #endif /* STM32F401xC || STM32F401xE || STM32F411xE */
|
|
|
162
|
|
|
163 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
|
|
|
164 HAL_StatusTypeDef HAL_PWREx_EnableOverDrive(void);
|
|
|
165 HAL_StatusTypeDef HAL_PWREx_DisableOverDrive(void);
|
|
|
166 HAL_StatusTypeDef HAL_PWREx_EnterUnderDriveSTOPMode(uint32_t Regulator, uint8_t STOPEntry);
|
|
|
167 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
|
|
|
168
|
|
|
169 /**
|
|
|
170 * @}
|
|
|
171 */
|
|
|
172
|
|
|
173 /**
|
|
|
174 * @}
|
|
|
175 */
|
|
|
176 /* Private types -------------------------------------------------------------*/
|
|
|
177 /* Private variables ---------------------------------------------------------*/
|
|
|
178 /* Private constants ---------------------------------------------------------*/
|
|
|
179 /** @defgroup PWREx_Private_Constants PWREx Private Constants
|
|
|
180 * @{
|
|
|
181 */
|
|
|
182
|
|
|
183 /** @defgroup PWREx_register_alias_address PWREx Register alias address
|
|
|
184 * @{
|
|
|
185 */
|
|
|
186 /* ------------- PWR registers bit address in the alias region ---------------*/
|
|
|
187 /* --- CR Register ---*/
|
|
|
188 /* Alias word address of FPDS bit */
|
|
|
189 #define FPDS_BIT_NUMBER POSITION_VAL(PWR_CR_FPDS)
|
|
|
190 #define CR_FPDS_BB (PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32) + (FPDS_BIT_NUMBER * 4))
|
|
|
191
|
|
|
192 /* Alias word address of ODEN bit */
|
|
|
193 #define ODEN_BIT_NUMBER POSITION_VAL(PWR_CR_ODEN)
|
|
|
194 #define CR_ODEN_BB (PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32) + (ODEN_BIT_NUMBER * 4))
|
|
|
195
|
|
|
196 /* Alias word address of ODSWEN bit */
|
|
|
197 #define ODSWEN_BIT_NUMBER POSITION_VAL(PWR_CR_ODSWEN)
|
|
|
198 #define CR_ODSWEN_BB (PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32) + (ODSWEN_BIT_NUMBER * 4))
|
|
|
199
|
|
|
200 /* Alias word address of MRLVDS bit */
|
|
|
201 #define MRLVDS_BIT_NUMBER POSITION_VAL(PWR_CR_MRLVDS)
|
|
|
202 #define CR_MRLVDS_BB (PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32) + (MRLVDS_BIT_NUMBER * 4))
|
|
|
203
|
|
|
204 /* Alias word address of LPLVDS bit */
|
|
|
205 #define LPLVDS_BIT_NUMBER POSITION_VAL(PWR_CR_LPLVDS)
|
|
|
206 #define CR_LPLVDS_BB (PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32) + (LPLVDS_BIT_NUMBER * 4))
|
|
|
207
|
|
|
208 /**
|
|
|
209 * @}
|
|
|
210 */
|
|
|
211
|
|
|
212 /** @defgroup PWREx_CSR_register_alias PWRx CSR Register alias address
|
|
|
213 * @{
|
|
|
214 */
|
|
|
215 /* --- CSR Register ---*/
|
|
|
216 /* Alias word address of BRE bit */
|
|
|
217 #define BRE_BIT_NUMBER POSITION_VAL(PWR_CSR_BRE)
|
|
|
218 #define CSR_BRE_BB (PERIPH_BB_BASE + (PWR_CSR_OFFSET_BB * 32) + (BRE_BIT_NUMBER * 4))
|
|
|
219 /**
|
|
|
220 * @}
|
|
|
221 */
|
|
|
222
|
|
|
223 /**
|
|
|
224 * @}
|
|
|
225 */
|
|
|
226
|
|
|
227 /* Private macros ------------------------------------------------------------*/
|
|
|
228 /** @defgroup PWREx_Private_Macros PWREx Private Macros
|
|
|
229 * @{
|
|
|
230 */
|
|
|
231
|
|
|
232 /** @defgroup PWREx_IS_PWR_Definitions PWREx Private macros to check input parameters
|
|
|
233 * @{
|
|
|
234 */
|
|
|
235 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
|
|
|
236 #define IS_PWR_REGULATOR_UNDERDRIVE(REGULATOR) (((REGULATOR) == PWR_MAINREGULATOR_UNDERDRIVE_ON) || \
|
|
|
237 ((REGULATOR) == PWR_LOWPOWERREGULATOR_UNDERDRIVE_ON))
|
|
|
238 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
|
|
|
239 /**
|
|
|
240 * @}
|
|
|
241 */
|
|
|
242
|
|
|
243 /**
|
|
|
244 * @}
|
|
|
245 */
|
|
|
246
|
|
|
247 /**
|
|
|
248 * @}
|
|
|
249 */
|
|
|
250
|
|
|
251 /**
|
|
|
252 * @}
|
|
|
253 */
|
|
|
254
|
|
|
255 #ifdef __cplusplus
|
|
|
256 }
|
|
|
257 #endif
|
|
|
258
|
|
|
259
|
|
|
260 #endif /* __STM32F4xx_HAL_PWR_EX_H */
|
|
|
261
|
|
|
262 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
