mbed official / mbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

TARGET_NUCLEO_F302R8/TARGET_STM/TARGET_STM32F3/device/stm32f3xx_hal_pwr.h@156:ff21514d8981, 2017-11-08 (annotated)

Committer:
AnnaBridge
Date:
Wed Nov 08 17:18:06 2017 +0000
Revision:
156:ff21514d8981
Child:
168:b9e159c1930a
Reverting back to release 154 of the mbed library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /**
AnnaBridge 156:ff21514d8981 2 ******************************************************************************
AnnaBridge 156:ff21514d8981 3 * @file stm32f3xx_hal_pwr.h
AnnaBridge 156:ff21514d8981 4 * @author MCD Application Team
AnnaBridge 156:ff21514d8981 5 * @version V1.4.0
AnnaBridge 156:ff21514d8981 6 * @date 16-December-2016
AnnaBridge 156:ff21514d8981 7 * @brief Header file of PWR HAL module.
AnnaBridge 156:ff21514d8981 8 ******************************************************************************
AnnaBridge 156:ff21514d8981 9 * @attention
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
AnnaBridge 156:ff21514d8981 12 *
AnnaBridge 156:ff21514d8981 13 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 156:ff21514d8981 14 * are permitted provided that the following conditions are met:
AnnaBridge 156:ff21514d8981 15 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 156:ff21514d8981 16 * this list of conditions and the following disclaimer.
AnnaBridge 156:ff21514d8981 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 156:ff21514d8981 18 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 156:ff21514d8981 19 * and/or other materials provided with the distribution.
AnnaBridge 156:ff21514d8981 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 156:ff21514d8981 21 * may be used to endorse or promote products derived from this software
AnnaBridge 156:ff21514d8981 22 * without specific prior written permission.
AnnaBridge 156:ff21514d8981 23 *
AnnaBridge 156:ff21514d8981 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 156:ff21514d8981 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 156:ff21514d8981 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 156:ff21514d8981 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 156:ff21514d8981 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 156:ff21514d8981 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 156:ff21514d8981 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 156:ff21514d8981 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 156:ff21514d8981 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 156:ff21514d8981 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 156:ff21514d8981 34 *
AnnaBridge 156:ff21514d8981 35 ******************************************************************************
AnnaBridge 156:ff21514d8981 36 */
AnnaBridge 156:ff21514d8981 37
AnnaBridge 156:ff21514d8981 38 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 156:ff21514d8981 39 #ifndef __STM32F3xx_HAL_PWR_H
AnnaBridge 156:ff21514d8981 40 #define __STM32F3xx_HAL_PWR_H
AnnaBridge 156:ff21514d8981 41
AnnaBridge 156:ff21514d8981 42 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 43 extern "C" {
AnnaBridge 156:ff21514d8981 44 #endif
AnnaBridge 156:ff21514d8981 45
AnnaBridge 156:ff21514d8981 46 /* Includes ------------------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 47 #include "stm32f3xx_hal_def.h"
AnnaBridge 156:ff21514d8981 48
AnnaBridge 156:ff21514d8981 49 /** @addtogroup STM32F3xx_HAL_Driver
AnnaBridge 156:ff21514d8981 50 * @{
AnnaBridge 156:ff21514d8981 51 */
AnnaBridge 156:ff21514d8981 52
AnnaBridge 156:ff21514d8981 53 /** @addtogroup PWR PWR
AnnaBridge 156:ff21514d8981 54 * @{
AnnaBridge 156:ff21514d8981 55 */
AnnaBridge 156:ff21514d8981 56
AnnaBridge 156:ff21514d8981 57 /* Exported types ------------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 58 /* Exported constants --------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 59 /** @defgroup PWR_Exported_Constants PWR Exported Constants
AnnaBridge 156:ff21514d8981 60 * @{
AnnaBridge 156:ff21514d8981 61 */
AnnaBridge 156:ff21514d8981 62
AnnaBridge 156:ff21514d8981 63 /** @defgroup PWR_WakeUp_Pins PWR WakeUp Pins
AnnaBridge 156:ff21514d8981 64 * @{
AnnaBridge 156:ff21514d8981 65 */
AnnaBridge 156:ff21514d8981 66
AnnaBridge 156:ff21514d8981 67 #define PWR_WAKEUP_PIN1 ((uint32_t)PWR_CSR_EWUP1) /*!< Wakeup pin 1U */
AnnaBridge 156:ff21514d8981 68 #define PWR_WAKEUP_PIN2 ((uint32_t)PWR_CSR_EWUP2) /*!< Wakeup pin 2U */
AnnaBridge 156:ff21514d8981 69 #define PWR_WAKEUP_PIN3 ((uint32_t)PWR_CSR_EWUP3) /*!< Wakeup pin 3U */
AnnaBridge 156:ff21514d8981 70 /**
AnnaBridge 156:ff21514d8981 71 * @}
AnnaBridge 156:ff21514d8981 72 */
AnnaBridge 156:ff21514d8981 73
AnnaBridge 156:ff21514d8981 74 /** @defgroup PWR_Regulator_state_in_STOP_mode PWR Regulator state in STOP mode
AnnaBridge 156:ff21514d8981 75 * @{
AnnaBridge 156:ff21514d8981 76 */
AnnaBridge 156:ff21514d8981 77 #define PWR_MAINREGULATOR_ON (0x00000000U) /*!< Voltage regulator on during STOP mode */
AnnaBridge 156:ff21514d8981 78 #define PWR_LOWPOWERREGULATOR_ON PWR_CR_LPDS /*!< Voltage regulator in low-power mode during STOP mode */
AnnaBridge 156:ff21514d8981 79 /**
AnnaBridge 156:ff21514d8981 80 * @}
AnnaBridge 156:ff21514d8981 81 */
AnnaBridge 156:ff21514d8981 82
AnnaBridge 156:ff21514d8981 83 /** @defgroup PWR_SLEEP_mode_entry PWR SLEEP mode entry
AnnaBridge 156:ff21514d8981 84 * @{
AnnaBridge 156:ff21514d8981 85 */
AnnaBridge 156:ff21514d8981 86 #define PWR_SLEEPENTRY_WFI ((uint8_t)0x01U) /*!< Wait For Interruption instruction to enter SLEEP mode */
AnnaBridge 156:ff21514d8981 87 #define PWR_SLEEPENTRY_WFE ((uint8_t)0x02U) /*!< Wait For Event instruction to enter SLEEP mode */
AnnaBridge 156:ff21514d8981 88 /**
AnnaBridge 156:ff21514d8981 89 * @}
AnnaBridge 156:ff21514d8981 90 */
AnnaBridge 156:ff21514d8981 91
AnnaBridge 156:ff21514d8981 92 /** @defgroup PWR_STOP_mode_entry PWR STOP mode entry
AnnaBridge 156:ff21514d8981 93 * @{
AnnaBridge 156:ff21514d8981 94 */
AnnaBridge 156:ff21514d8981 95 #define PWR_STOPENTRY_WFI ((uint8_t)0x01U) /*!< Wait For Interruption instruction to enter STOP mode */
AnnaBridge 156:ff21514d8981 96 #define PWR_STOPENTRY_WFE ((uint8_t)0x02U) /*!< Wait For Event instruction to enter STOP mode */
AnnaBridge 156:ff21514d8981 97 /**
AnnaBridge 156:ff21514d8981 98 * @}
AnnaBridge 156:ff21514d8981 99 */
AnnaBridge 156:ff21514d8981 100
AnnaBridge 156:ff21514d8981 101 /** @defgroup PWR_Flag PWR Flag
AnnaBridge 156:ff21514d8981 102 * @{
AnnaBridge 156:ff21514d8981 103 */
AnnaBridge 156:ff21514d8981 104 #define PWR_FLAG_WU PWR_CSR_WUF /*!< Wakeup event from wakeup pin or RTC alarm */
AnnaBridge 156:ff21514d8981 105 #define PWR_FLAG_SB PWR_CSR_SBF /*!< Standby flag */
AnnaBridge 156:ff21514d8981 106 #define PWR_FLAG_PVDO PWR_CSR_PVDO /*!< Power Voltage Detector output flag */
AnnaBridge 156:ff21514d8981 107 #define PWR_FLAG_VREFINTRDY PWR_CSR_VREFINTRDYF /*!< VREFINT reference voltage ready */
AnnaBridge 156:ff21514d8981 108 /**
AnnaBridge 156:ff21514d8981 109 * @}
AnnaBridge 156:ff21514d8981 110 */
AnnaBridge 156:ff21514d8981 111
AnnaBridge 156:ff21514d8981 112 /**
AnnaBridge 156:ff21514d8981 113 * @}
AnnaBridge 156:ff21514d8981 114 */
AnnaBridge 156:ff21514d8981 115
AnnaBridge 156:ff21514d8981 116 /* Exported macro ------------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 117 /** @defgroup PWR_Exported_Macro PWR Exported Macro
AnnaBridge 156:ff21514d8981 118 * @{
AnnaBridge 156:ff21514d8981 119 */
AnnaBridge 156:ff21514d8981 120
AnnaBridge 156:ff21514d8981 121 /** @brief Check PWR flag is set or not.
AnnaBridge 156:ff21514d8981 122 * @param __FLAG__: specifies the flag to check.
AnnaBridge 156:ff21514d8981 123 * This parameter can be one of the following values:
AnnaBridge 156:ff21514d8981 124 * @arg PWR_FLAG_WU: Wake Up flag. This flag indicates that a wakeup event
AnnaBridge 156:ff21514d8981 125 * was received from the WKUP pin or from the RTC alarm (Alarm A
AnnaBridge 156:ff21514d8981 126 * or Alarm B), RTC Tamper event, RTC TimeStamp event or RTC Wakeup.
AnnaBridge 156:ff21514d8981 127 * An additional wakeup event is detected if the WKUP pin is enabled
AnnaBridge 156:ff21514d8981 128 * (by setting the EWUP bit) when the WKUP pin level is already high.
AnnaBridge 156:ff21514d8981 129 * @arg PWR_FLAG_SB: StandBy flag. This flag indicates that the system was
AnnaBridge 156:ff21514d8981 130 * resumed from StandBy mode.
AnnaBridge 156:ff21514d8981 131 * @arg PWR_FLAG_PVDO: PVD Output. This flag is valid only if PVD is enabled
AnnaBridge 156:ff21514d8981 132 * by the HAL_PWR_EnablePVD() function. The PVD is stopped by Standby mode
AnnaBridge 156:ff21514d8981 133 * For this reason, this bit is equal to 0 after Standby or reset
AnnaBridge 156:ff21514d8981 134 * until the PVDE bit is set.
AnnaBridge 156:ff21514d8981 135 * @arg PWR_FLAG_VREFINTRDY: This flag indicates that the internal reference
AnnaBridge 156:ff21514d8981 136 * voltage VREFINT is ready.
AnnaBridge 156:ff21514d8981 137 * @retval The new state of __FLAG__ (TRUE or FALSE).
AnnaBridge 156:ff21514d8981 138 */
AnnaBridge 156:ff21514d8981 139 #define __HAL_PWR_GET_FLAG(__FLAG__) ((PWR->CSR & (__FLAG__)) == (__FLAG__))
AnnaBridge 156:ff21514d8981 140
AnnaBridge 156:ff21514d8981 141 /** @brief Clear the PWR's pending flags.
AnnaBridge 156:ff21514d8981 142 * @param __FLAG__: specifies the flag to clear.
AnnaBridge 156:ff21514d8981 143 * This parameter can be one of the following values:
AnnaBridge 156:ff21514d8981 144 * @arg PWR_FLAG_WU: Wake Up flag
AnnaBridge 156:ff21514d8981 145 * @arg PWR_FLAG_SB: StandBy flag
AnnaBridge 156:ff21514d8981 146 */
AnnaBridge 156:ff21514d8981 147 #define __HAL_PWR_CLEAR_FLAG(__FLAG__) (PWR->CR |= (__FLAG__) << 2U)
AnnaBridge 156:ff21514d8981 148
AnnaBridge 156:ff21514d8981 149 /**
AnnaBridge 156:ff21514d8981 150 * @}
AnnaBridge 156:ff21514d8981 151 */
AnnaBridge 156:ff21514d8981 152
AnnaBridge 156:ff21514d8981 153 /* Private macros --------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 154 /** @addtogroup PWR_Private_Macros PWR Private Macros
AnnaBridge 156:ff21514d8981 155 * @{
AnnaBridge 156:ff21514d8981 156 */
AnnaBridge 156:ff21514d8981 157
AnnaBridge 156:ff21514d8981 158 #define IS_PWR_WAKEUP_PIN(PIN) (((PIN) == PWR_WAKEUP_PIN1) || \
AnnaBridge 156:ff21514d8981 159 ((PIN) == PWR_WAKEUP_PIN2) || \
AnnaBridge 156:ff21514d8981 160 ((PIN) == PWR_WAKEUP_PIN3))
AnnaBridge 156:ff21514d8981 161
AnnaBridge 156:ff21514d8981 162 #define IS_PWR_REGULATOR(REGULATOR) (((REGULATOR) == PWR_MAINREGULATOR_ON) || \
AnnaBridge 156:ff21514d8981 163 ((REGULATOR) == PWR_LOWPOWERREGULATOR_ON))
AnnaBridge 156:ff21514d8981 164
AnnaBridge 156:ff21514d8981 165 #define IS_PWR_SLEEP_ENTRY(ENTRY) (((ENTRY) == PWR_SLEEPENTRY_WFI) || ((ENTRY) == PWR_SLEEPENTRY_WFE))
AnnaBridge 156:ff21514d8981 166
AnnaBridge 156:ff21514d8981 167 #define IS_PWR_STOP_ENTRY(ENTRY) (((ENTRY) == PWR_STOPENTRY_WFI) || ((ENTRY) == PWR_STOPENTRY_WFE))
AnnaBridge 156:ff21514d8981 168
AnnaBridge 156:ff21514d8981 169 /**
AnnaBridge 156:ff21514d8981 170 * @}
AnnaBridge 156:ff21514d8981 171 */
AnnaBridge 156:ff21514d8981 172
AnnaBridge 156:ff21514d8981 173 /* Include PWR HAL Extended module */
AnnaBridge 156:ff21514d8981 174 #include "stm32f3xx_hal_pwr_ex.h"
AnnaBridge 156:ff21514d8981 175
AnnaBridge 156:ff21514d8981 176 /* Exported functions --------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 177
AnnaBridge 156:ff21514d8981 178 /** @addtogroup PWR_Exported_Functions PWR Exported Functions
AnnaBridge 156:ff21514d8981 179 * @{
AnnaBridge 156:ff21514d8981 180 */
AnnaBridge 156:ff21514d8981 181
AnnaBridge 156:ff21514d8981 182 /** @addtogroup PWR_Exported_Functions_Group1 Initialization and de-initialization functions
AnnaBridge 156:ff21514d8981 183 * @{
AnnaBridge 156:ff21514d8981 184 */
AnnaBridge 156:ff21514d8981 185
AnnaBridge 156:ff21514d8981 186 /* Initialization and de-initialization functions *****************************/
AnnaBridge 156:ff21514d8981 187 void HAL_PWR_DeInit(void);
AnnaBridge 156:ff21514d8981 188
AnnaBridge 156:ff21514d8981 189 /**
AnnaBridge 156:ff21514d8981 190 * @}
AnnaBridge 156:ff21514d8981 191 */
AnnaBridge 156:ff21514d8981 192
AnnaBridge 156:ff21514d8981 193 /** @addtogroup PWR_Exported_Functions_Group2 Peripheral Control functions
AnnaBridge 156:ff21514d8981 194 * @{
AnnaBridge 156:ff21514d8981 195 */
AnnaBridge 156:ff21514d8981 196
AnnaBridge 156:ff21514d8981 197 /* Peripheral Control functions **********************************************/
AnnaBridge 156:ff21514d8981 198 void HAL_PWR_EnableBkUpAccess(void);
AnnaBridge 156:ff21514d8981 199 void HAL_PWR_DisableBkUpAccess(void);
AnnaBridge 156:ff21514d8981 200
AnnaBridge 156:ff21514d8981 201 /* WakeUp pins configuration functions ****************************************/
AnnaBridge 156:ff21514d8981 202 void HAL_PWR_EnableWakeUpPin(uint32_t WakeUpPinx);
AnnaBridge 156:ff21514d8981 203 void HAL_PWR_DisableWakeUpPin(uint32_t WakeUpPinx);
AnnaBridge 156:ff21514d8981 204
AnnaBridge 156:ff21514d8981 205 /* Low Power modes configuration functions ************************************/
AnnaBridge 156:ff21514d8981 206 void HAL_PWR_EnterSTOPMode(uint32_t Regulator, uint8_t STOPEntry);
AnnaBridge 156:ff21514d8981 207 void HAL_PWR_EnterSLEEPMode(uint32_t Regulator, uint8_t SLEEPEntry);
AnnaBridge 156:ff21514d8981 208 void HAL_PWR_EnterSTANDBYMode(void);
AnnaBridge 156:ff21514d8981 209
AnnaBridge 156:ff21514d8981 210 void HAL_PWR_EnableSleepOnExit(void);
AnnaBridge 156:ff21514d8981 211 void HAL_PWR_DisableSleepOnExit(void);
AnnaBridge 156:ff21514d8981 212 void HAL_PWR_EnableSEVOnPend(void);
AnnaBridge 156:ff21514d8981 213 void HAL_PWR_DisableSEVOnPend(void);
AnnaBridge 156:ff21514d8981 214 /**
AnnaBridge 156:ff21514d8981 215 * @}
AnnaBridge 156:ff21514d8981 216 */
AnnaBridge 156:ff21514d8981 217
AnnaBridge 156:ff21514d8981 218 /**
AnnaBridge 156:ff21514d8981 219 * @}
AnnaBridge 156:ff21514d8981 220 */
AnnaBridge 156:ff21514d8981 221
AnnaBridge 156:ff21514d8981 222 /**
AnnaBridge 156:ff21514d8981 223 * @}
AnnaBridge 156:ff21514d8981 224 */
AnnaBridge 156:ff21514d8981 225
AnnaBridge 156:ff21514d8981 226 /**
AnnaBridge 156:ff21514d8981 227 * @}
AnnaBridge 156:ff21514d8981 228 */
AnnaBridge 156:ff21514d8981 229
AnnaBridge 156:ff21514d8981 230 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 231 }
AnnaBridge 156:ff21514d8981 232 #endif
AnnaBridge 156:ff21514d8981 233
AnnaBridge 156:ff21514d8981 234
AnnaBridge 156:ff21514d8981 235 #endif /* __STM32F3xx_HAL_PWR_H */
AnnaBridge 156:ff21514d8981 236
AnnaBridge 156:ff21514d8981 237 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/