Egor Rumjantsev / mbed

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

Fork of mbed by mbed official

TARGET_NUCLEO_F070RB/stm32f0xx_hal_pwr.h@99:7f6c6de930c0, 2015-05-03 (annotated)

Committer:
Mikchel
Date:
Sun May 03 16:04:42 2015 +0000
Revision:
99:7f6c6de930c0
Parent:
93:e188a91d3eaa 
12

Who changed what in which revision?

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