mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUCLEO_F303RE/TOOLCHAIN_ARM_STD/stm32f3xx_hal_pwr.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_DISCO_F303VC/TARGET_STM/TARGET_STM32F3/device/stm32f3xx_hal_pwr.h@168:b9e159c1930a 
mbed library. Release version 164

Who changed what in which revision?

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