Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_NUCLEO_F091RC/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:
90:cb3d968589d8
Child:
93:e188a91d3eaa
dgdgr

Who changed what in which revision?

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