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_F031K6/TARGET_STM/TARGET_STM32F0/device/stm32f0xx_hal_pwr.h@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
160:5571c4ff569f
Release 155 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 stm32f0xx_hal_pwr.h
AnnaBridge 156:ff21514d8981 4 * @author MCD Application Team
AnnaBridge 156:ff21514d8981 5 * @version V1.5.0
AnnaBridge 156:ff21514d8981 6 * @date 04-November-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 __STM32F0xx_HAL_PWR_H
AnnaBridge 156:ff21514d8981 40 #define __STM32F0xx_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 "stm32f0xx_hal_def.h"
AnnaBridge 156:ff21514d8981 48
AnnaBridge 156:ff21514d8981 49 /** @addtogroup STM32F0xx_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
AnnaBridge 156:ff21514d8981 60 /** @defgroup PWR_Exported_Constants PWR Exported Constants
AnnaBridge 156:ff21514d8981 61 * @{
AnnaBridge 156:ff21514d8981 62 */
AnnaBridge 156:ff21514d8981 63
AnnaBridge 156:ff21514d8981 64 /** @defgroup PWR_Regulator_state_in_STOP_mode PWR Regulator state in STOP mode
AnnaBridge 156:ff21514d8981 65 * @{
AnnaBridge 156:ff21514d8981 66 */
AnnaBridge 156:ff21514d8981 67 #define PWR_MAINREGULATOR_ON (0x00000000U)
AnnaBridge 156:ff21514d8981 68 #define PWR_LOWPOWERREGULATOR_ON PWR_CR_LPDS
AnnaBridge 156:ff21514d8981 69
AnnaBridge 156:ff21514d8981 70 #define IS_PWR_REGULATOR(REGULATOR) (((REGULATOR) == PWR_MAINREGULATOR_ON) || \
AnnaBridge 156:ff21514d8981 71 ((REGULATOR) == PWR_LOWPOWERREGULATOR_ON))
AnnaBridge 156:ff21514d8981 72 /**
AnnaBridge 156:ff21514d8981 73 * @}
AnnaBridge 156:ff21514d8981 74 */
AnnaBridge 156:ff21514d8981 75
AnnaBridge 156:ff21514d8981 76 /** @defgroup PWR_SLEEP_mode_entry PWR SLEEP mode entry
AnnaBridge 156:ff21514d8981 77 * @{
AnnaBridge 156:ff21514d8981 78 */
AnnaBridge 156:ff21514d8981 79 #define PWR_SLEEPENTRY_WFI ((uint8_t)0x01U)
AnnaBridge 156:ff21514d8981 80 #define PWR_SLEEPENTRY_WFE ((uint8_t)0x02U)
AnnaBridge 156:ff21514d8981 81 #define IS_PWR_SLEEP_ENTRY(ENTRY) (((ENTRY) == PWR_SLEEPENTRY_WFI) || ((ENTRY) == PWR_SLEEPENTRY_WFE))
AnnaBridge 156:ff21514d8981 82 /**
AnnaBridge 156:ff21514d8981 83 * @}
AnnaBridge 156:ff21514d8981 84 */
AnnaBridge 156:ff21514d8981 85
AnnaBridge 156:ff21514d8981 86 /** @defgroup PWR_STOP_mode_entry PWR STOP mode entry
AnnaBridge 156:ff21514d8981 87 * @{
AnnaBridge 156:ff21514d8981 88 */
AnnaBridge 156:ff21514d8981 89 #define PWR_STOPENTRY_WFI ((uint8_t)0x01U)
AnnaBridge 156:ff21514d8981 90 #define PWR_STOPENTRY_WFE ((uint8_t)0x02U)
AnnaBridge 156:ff21514d8981 91 #define IS_PWR_STOP_ENTRY(ENTRY) (((ENTRY) == PWR_STOPENTRY_WFI) || ((ENTRY) == PWR_STOPENTRY_WFE))
AnnaBridge 156:ff21514d8981 92 /**
AnnaBridge 156:ff21514d8981 93 * @}
AnnaBridge 156:ff21514d8981 94 */
AnnaBridge 156:ff21514d8981 95
AnnaBridge 156:ff21514d8981 96
AnnaBridge 156:ff21514d8981 97 /**
AnnaBridge 156:ff21514d8981 98 * @}
AnnaBridge 156:ff21514d8981 99 */
AnnaBridge 156:ff21514d8981 100
AnnaBridge 156:ff21514d8981 101 /* Exported macro ------------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 102 /** @defgroup PWR_Exported_Macro PWR Exported Macro
AnnaBridge 156:ff21514d8981 103 * @{
AnnaBridge 156:ff21514d8981 104 */
AnnaBridge 156:ff21514d8981 105
AnnaBridge 156:ff21514d8981 106 /** @brief Check PWR flag is set or not.
AnnaBridge 156:ff21514d8981 107 * @param __FLAG__: specifies the flag to check.
AnnaBridge 156:ff21514d8981 108 * This parameter can be one of the following values:
AnnaBridge 156:ff21514d8981 109 * @arg PWR_FLAG_WU: Wake Up flag. This flag indicates that a wakeup event
AnnaBridge 156:ff21514d8981 110 * was received from the WKUP pin or from the RTC alarm (Alarm A),
AnnaBridge 156:ff21514d8981 111 * RTC Tamper event, RTC TimeStamp event or RTC Wakeup.
AnnaBridge 156:ff21514d8981 112 * An additional wakeup event is detected if the WKUP pin is enabled
AnnaBridge 156:ff21514d8981 113 * (by setting the EWUP bit) when the WKUP pin level is already high.
AnnaBridge 156:ff21514d8981 114 * @arg PWR_FLAG_SB: StandBy flag. This flag indicates that the system was
AnnaBridge 156:ff21514d8981 115 * resumed from StandBy mode.
AnnaBridge 156:ff21514d8981 116 * @arg PWR_FLAG_PVDO: PVD Output. This flag is valid only if PVD is enabled
AnnaBridge 156:ff21514d8981 117 * by the HAL_PWR_EnablePVD() function. The PVD is stopped by Standby mode
AnnaBridge 156:ff21514d8981 118 * For this reason, this bit is equal to 0 after Standby or reset
AnnaBridge 156:ff21514d8981 119 * until the PVDE bit is set.
AnnaBridge 156:ff21514d8981 120 * Warning: this Flag is not available on STM32F030x8 products
AnnaBridge 156:ff21514d8981 121 * @arg PWR_FLAG_VREFINTRDY: This flag indicates that the internal reference
AnnaBridge 156:ff21514d8981 122 * voltage VREFINT is ready.
AnnaBridge 156:ff21514d8981 123 * Warning: this Flag is not available on STM32F030x8 products
AnnaBridge 156:ff21514d8981 124 * @retval The new state of __FLAG__ (TRUE or FALSE).
AnnaBridge 156:ff21514d8981 125 */
AnnaBridge 156:ff21514d8981 126 #define __HAL_PWR_GET_FLAG(__FLAG__) ((PWR->CSR & (__FLAG__)) == (__FLAG__))
AnnaBridge 156:ff21514d8981 127
AnnaBridge 156:ff21514d8981 128 /** @brief Clear the PWR's pending flags.
AnnaBridge 156:ff21514d8981 129 * @param __FLAG__: specifies the flag to clear.
AnnaBridge 156:ff21514d8981 130 * This parameter can be one of the following values:
AnnaBridge 156:ff21514d8981 131 * @arg PWR_FLAG_WU: Wake Up flag
AnnaBridge 156:ff21514d8981 132 * @arg PWR_FLAG_SB: StandBy flag
AnnaBridge 156:ff21514d8981 133 */
AnnaBridge 156:ff21514d8981 134 #define __HAL_PWR_CLEAR_FLAG(__FLAG__) (PWR->CR |= (__FLAG__) << 2U)
AnnaBridge 156:ff21514d8981 135
AnnaBridge 156:ff21514d8981 136
AnnaBridge 156:ff21514d8981 137 /**
AnnaBridge 156:ff21514d8981 138 * @}
AnnaBridge 156:ff21514d8981 139 */
AnnaBridge 156:ff21514d8981 140
AnnaBridge 156:ff21514d8981 141 /* Include PWR HAL Extension module */
AnnaBridge 156:ff21514d8981 142 #include "stm32f0xx_hal_pwr_ex.h"
AnnaBridge 156:ff21514d8981 143
AnnaBridge 156:ff21514d8981 144 /* Exported functions --------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 145
AnnaBridge 156:ff21514d8981 146 /** @addtogroup PWR_Exported_Functions PWR Exported Functions
AnnaBridge 156:ff21514d8981 147 * @{
AnnaBridge 156:ff21514d8981 148 */
AnnaBridge 156:ff21514d8981 149
AnnaBridge 156:ff21514d8981 150 /** @addtogroup PWR_Exported_Functions_Group1 Initialization and de-initialization functions
AnnaBridge 156:ff21514d8981 151 * @{
AnnaBridge 156:ff21514d8981 152 */
AnnaBridge 156:ff21514d8981 153
AnnaBridge 156:ff21514d8981 154 /* Initialization and de-initialization functions *****************************/
AnnaBridge 156:ff21514d8981 155 void HAL_PWR_DeInit(void);
AnnaBridge 156:ff21514d8981 156
AnnaBridge 156:ff21514d8981 157 /**
AnnaBridge 156:ff21514d8981 158 * @}
AnnaBridge 156:ff21514d8981 159 */
AnnaBridge 156:ff21514d8981 160
AnnaBridge 156:ff21514d8981 161 /** @addtogroup PWR_Exported_Functions_Group2 Peripheral Control functions
AnnaBridge 156:ff21514d8981 162 * @{
AnnaBridge 156:ff21514d8981 163 */
AnnaBridge 156:ff21514d8981 164
AnnaBridge 156:ff21514d8981 165 /* Peripheral Control functions **********************************************/
AnnaBridge 156:ff21514d8981 166 void HAL_PWR_EnableBkUpAccess(void);
AnnaBridge 156:ff21514d8981 167 void HAL_PWR_DisableBkUpAccess(void);
AnnaBridge 156:ff21514d8981 168
AnnaBridge 156:ff21514d8981 169 /* WakeUp pins configuration functions ****************************************/
AnnaBridge 156:ff21514d8981 170 void HAL_PWR_EnableWakeUpPin(uint32_t WakeUpPinx);
AnnaBridge 156:ff21514d8981 171 void HAL_PWR_DisableWakeUpPin(uint32_t WakeUpPinx);
AnnaBridge 156:ff21514d8981 172
AnnaBridge 156:ff21514d8981 173 /* Low Power modes configuration functions ************************************/
AnnaBridge 156:ff21514d8981 174 void HAL_PWR_EnterSTOPMode(uint32_t Regulator, uint8_t STOPEntry);
AnnaBridge 156:ff21514d8981 175 void HAL_PWR_EnterSLEEPMode(uint32_t Regulator, uint8_t SLEEPEntry);
AnnaBridge 156:ff21514d8981 176 void HAL_PWR_EnterSTANDBYMode(void);
AnnaBridge 156:ff21514d8981 177
AnnaBridge 156:ff21514d8981 178 void HAL_PWR_EnableSleepOnExit(void);
AnnaBridge 156:ff21514d8981 179 void HAL_PWR_DisableSleepOnExit(void);
AnnaBridge 156:ff21514d8981 180 void HAL_PWR_EnableSEVOnPend(void);
AnnaBridge 156:ff21514d8981 181 void HAL_PWR_DisableSEVOnPend(void);
AnnaBridge 156:ff21514d8981 182
AnnaBridge 156:ff21514d8981 183 /**
AnnaBridge 156:ff21514d8981 184 * @}
AnnaBridge 156:ff21514d8981 185 */
AnnaBridge 156:ff21514d8981 186
AnnaBridge 156:ff21514d8981 187 /**
AnnaBridge 156:ff21514d8981 188 * @}
AnnaBridge 156:ff21514d8981 189 */
AnnaBridge 156:ff21514d8981 190
AnnaBridge 156:ff21514d8981 191 /**
AnnaBridge 156:ff21514d8981 192 * @}
AnnaBridge 156:ff21514d8981 193 */
AnnaBridge 156:ff21514d8981 194
AnnaBridge 156:ff21514d8981 195 /**
AnnaBridge 156:ff21514d8981 196 * @}
AnnaBridge 156:ff21514d8981 197 */
AnnaBridge 156:ff21514d8981 198
AnnaBridge 156:ff21514d8981 199 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 200 }
AnnaBridge 156:ff21514d8981 201 #endif
AnnaBridge 156:ff21514d8981 202
AnnaBridge 156:ff21514d8981 203
AnnaBridge 156:ff21514d8981 204 #endif /* __STM32F0xx_HAL_PWR_H */
AnnaBridge 156:ff21514d8981 205
AnnaBridge 156:ff21514d8981 206 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
AnnaBridge 156:ff21514d8981 207