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_F334R8/TARGET_STM/TARGET_STM32F3/device/stm32f3xx_hal_pwr.h@143:86740a56073b, 2017-05-26 (annotated)

Committer:
AnnaBridge
Date:
Fri May 26 12:30:20 2017 +0100
Revision:
143:86740a56073b
Parent:
135:176b8275d35d 
Release 143 of the mbed library.

Who changed what in which revision?

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