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_DISCO_F303VC/TARGET_STM/TARGET_STM32F3/device/stm32f3xx_hal_pwr.h@163:e59c8e839560, 2018-03-20 (annotated)

Committer:
AnnaBridge
Date:
Tue Mar 20 13:30:58 2018 +0000
Revision:
163:e59c8e839560
Child:
168:b9e159c1930a
mbed library. Release version 160

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