Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_NUCLEO_F072RB/stm32f0xx_hal_pwr.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
92:4fc01daae5a5
Child:
93:e188a91d3eaa
dgdgr

Who changed what in which revision?

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