CARME-M4 BSP  V1.5
stm32f4xx_pwr.h
Go to the documentation of this file.
1 
29 /* Define to prevent recursive inclusion -------------------------------------*/
30 #ifndef __STM32F4xx_PWR_H
31 #define __STM32F4xx_PWR_H
32 
33 #ifdef __cplusplus
34  extern "C" {
35 #endif
36 
37 /* Includes ------------------------------------------------------------------*/
38 #include "stm32f4xx.h"
39 
48 /* Exported types ------------------------------------------------------------*/
49 /* Exported constants --------------------------------------------------------*/
50 
58 #define PWR_PVDLevel_0 PWR_CR_PLS_LEV0
59 #define PWR_PVDLevel_1 PWR_CR_PLS_LEV1
60 #define PWR_PVDLevel_2 PWR_CR_PLS_LEV2
61 #define PWR_PVDLevel_3 PWR_CR_PLS_LEV3
62 #define PWR_PVDLevel_4 PWR_CR_PLS_LEV4
63 #define PWR_PVDLevel_5 PWR_CR_PLS_LEV5
64 #define PWR_PVDLevel_6 PWR_CR_PLS_LEV6
65 #define PWR_PVDLevel_7 PWR_CR_PLS_LEV7
66 
67 #define IS_PWR_PVD_LEVEL(LEVEL) (((LEVEL) == PWR_PVDLevel_0) || ((LEVEL) == PWR_PVDLevel_1)|| \
68  ((LEVEL) == PWR_PVDLevel_2) || ((LEVEL) == PWR_PVDLevel_3)|| \
69  ((LEVEL) == PWR_PVDLevel_4) || ((LEVEL) == PWR_PVDLevel_5)|| \
70  ((LEVEL) == PWR_PVDLevel_6) || ((LEVEL) == PWR_PVDLevel_7))
71 
79 #define PWR_MainRegulator_ON ((uint32_t)0x00000000)
80 #define PWR_LowPowerRegulator_ON PWR_CR_LPDS
81 
82 /* --- PWR_Legacy ---*/
83 #define PWR_Regulator_ON PWR_MainRegulator_ON
84 #define PWR_Regulator_LowPower PWR_LowPowerRegulator_ON
85 
86 #define IS_PWR_REGULATOR(REGULATOR) (((REGULATOR) == PWR_MainRegulator_ON) || \
87  ((REGULATOR) == PWR_LowPowerRegulator_ON))
88 
96 #define PWR_MainRegulator_UnderDrive_ON PWR_CR_MRUDS
97 #define PWR_LowPowerRegulator_UnderDrive_ON ((uint32_t)(PWR_CR_LPDS | PWR_CR_LPUDS))
98 
99 #define IS_PWR_REGULATOR_UNDERDRIVE(REGULATOR) (((REGULATOR) == PWR_MainRegulator_UnderDrive_ON) || \
100  ((REGULATOR) == PWR_LowPowerRegulator_UnderDrive_ON))
101 
109 #define PWR_STOPEntry_WFI ((uint8_t)0x01)
110 #define PWR_STOPEntry_WFE ((uint8_t)0x02)
111 #define IS_PWR_STOP_ENTRY(ENTRY) (((ENTRY) == PWR_STOPEntry_WFI) || ((ENTRY) == PWR_STOPEntry_WFE))
112 
119 #define PWR_Regulator_Voltage_Scale1 ((uint32_t)0x0000C000)
120 #define PWR_Regulator_Voltage_Scale2 ((uint32_t)0x00008000)
121 #define PWR_Regulator_Voltage_Scale3 ((uint32_t)0x00004000)
122 #define IS_PWR_REGULATOR_VOLTAGE(VOLTAGE) (((VOLTAGE) == PWR_Regulator_Voltage_Scale1) || \
123  ((VOLTAGE) == PWR_Regulator_Voltage_Scale2) || \
124  ((VOLTAGE) == PWR_Regulator_Voltage_Scale3))
125 
132 #define PWR_FLAG_WU PWR_CSR_WUF
133 #define PWR_FLAG_SB PWR_CSR_SBF
134 #define PWR_FLAG_PVDO PWR_CSR_PVDO
135 #define PWR_FLAG_BRR PWR_CSR_BRR
136 #define PWR_FLAG_VOSRDY PWR_CSR_VOSRDY
137 #define PWR_FLAG_ODRDY PWR_CSR_ODRDY
138 #define PWR_FLAG_ODSWRDY PWR_CSR_ODSWRDY
139 #define PWR_FLAG_UDRDY PWR_CSR_UDSWRDY
140 
141 /* --- FLAG Legacy ---*/
142 #define PWR_FLAG_REGRDY PWR_FLAG_VOSRDY
143 
144 #define IS_PWR_GET_FLAG(FLAG) (((FLAG) == PWR_FLAG_WU) || ((FLAG) == PWR_FLAG_SB) || \
145  ((FLAG) == PWR_FLAG_PVDO) || ((FLAG) == PWR_FLAG_BRR) || \
146  ((FLAG) == PWR_FLAG_VOSRDY) || ((FLAG) == PWR_FLAG_ODRDY) || \
147  ((FLAG) == PWR_FLAG_ODSWRDY) || ((FLAG) == PWR_FLAG_UDRDY))
148 
149 
150 #define IS_PWR_CLEAR_FLAG(FLAG) (((FLAG) == PWR_FLAG_WU) || ((FLAG) == PWR_FLAG_SB) || \
151  ((FLAG) == PWR_FLAG_UDRDY))
152 
161 /* Exported macro ------------------------------------------------------------*/
162 /* Exported functions --------------------------------------------------------*/
163 
164 /* Function used to set the PWR configuration to the default reset state ******/
165 void PWR_DeInit(void);
166 
167 /* Backup Domain Access function **********************************************/
168 void PWR_BackupAccessCmd(FunctionalState NewState);
169 
170 /* PVD configuration functions ************************************************/
171 void PWR_PVDLevelConfig(uint32_t PWR_PVDLevel);
172 void PWR_PVDCmd(FunctionalState NewState);
173 
174 /* WakeUp pins configuration functions ****************************************/
175 void PWR_WakeUpPinCmd(FunctionalState NewState);
176 
177 /* Main and Backup Regulators configuration functions *************************/
178 void PWR_BackupRegulatorCmd(FunctionalState NewState);
179 void PWR_MainRegulatorModeConfig(uint32_t PWR_Regulator_Voltage);
180 void PWR_OverDriveCmd(FunctionalState NewState);
181 void PWR_OverDriveSWCmd(FunctionalState NewState);
182 void PWR_UnderDriveCmd(FunctionalState NewState);
183 
184 /* FLASH Power Down configuration functions ***********************************/
185 void PWR_FlashPowerDownCmd(FunctionalState NewState);
186 
187 /* Low Power modes configuration functions ************************************/
188 void PWR_EnterSTOPMode(uint32_t PWR_Regulator, uint8_t PWR_STOPEntry);
189 void PWR_EnterUnderDriveSTOPMode(uint32_t PWR_Regulator, uint8_t PWR_STOPEntry);
190 void PWR_EnterSTANDBYMode(void);
191 
192 /* Flags management functions *************************************************/
193 FlagStatus PWR_GetFlagStatus(uint32_t PWR_FLAG);
194 void PWR_ClearFlag(uint32_t PWR_FLAG);
195 
196 #ifdef __cplusplus
197 }
198 #endif
199 
200 #endif /* __STM32F4xx_PWR_H */
201 
210 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
FlagStatus PWR_GetFlagStatus(uint32_t PWR_FLAG)
Checks whether the specified PWR flag is set or not.
void PWR_EnterSTOPMode(uint32_t PWR_Regulator, uint8_t PWR_STOPEntry)
Enters STOP mode.
void PWR_BackupAccessCmd(FunctionalState NewState)
Enables or disables access to the backup domain (RTC registers, RTC backup data registers and backup ...
void PWR_MainRegulatorModeConfig(uint32_t PWR_Regulator_Voltage)
Configures the main internal regulator output voltage.
void PWR_PVDCmd(FunctionalState NewState)
Enables or disables the Power Voltage Detector(PVD).
void PWR_OverDriveCmd(FunctionalState NewState)
Enables or disables the Over-Drive.
void PWR_UnderDriveCmd(FunctionalState NewState)
Enables or disables the Under-Drive mode.
void PWR_EnterSTANDBYMode(void)
Enters STANDBY mode.
void PWR_DeInit(void)
Deinitializes the PWR peripheral registers to their default reset values.
void PWR_OverDriveSWCmd(FunctionalState NewState)
Enables or disables the Over-Drive switching.
void PWR_FlashPowerDownCmd(FunctionalState NewState)
Enables or disables the Flash Power Down in STOP mode.
void PWR_EnterUnderDriveSTOPMode(uint32_t PWR_Regulator, uint8_t PWR_STOPEntry)
Enters in Under-Drive STOP mode.
void PWR_PVDLevelConfig(uint32_t PWR_PVDLevel)
Configures the voltage threshold detected by the Power Voltage Detector(PVD).
void PWR_WakeUpPinCmd(FunctionalState NewState)
Enables or disables the WakeUp Pin functionality.
void PWR_BackupRegulatorCmd(FunctionalState NewState)
Enables or disables the Backup Regulator.
void PWR_ClearFlag(uint32_t PWR_FLAG)
Clears the PWR's pending flags.