Jhon Plantikow / Dataloger

Dataloger

TARGET_NUCLEO_F072RB/stm32f0xx_hal_pwr.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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