Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_NUCLEO_F302R8/stm32f3xx_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 
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 stm32f3xx_hal_pwr.h
Kojto 90:cb3d968589d8 4 * @author MCD Application Team
Kojto 90:cb3d968589d8 5 * @version V1.1.0
Kojto 90:cb3d968589d8 6 * @date 12-Sept-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 __STM32F3xx_HAL_PWR_H
Kojto 90:cb3d968589d8 40 #define __STM32F3xx_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 "stm32f3xx_hal_def.h"
Kojto 90:cb3d968589d8 48
Kojto 90:cb3d968589d8 49 /** @addtogroup STM32F3xx_HAL_Driver
Kojto 90:cb3d968589d8 50 * @{
Kojto 90:cb3d968589d8 51 */
Kojto 90:cb3d968589d8 52
Kojto 90:cb3d968589d8 53 /** @addtogroup PWR PWR HAL Driver module
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 /** @defgroup PWR_Alias_Exported_Constants PWR Alias Exported Constants
Kojto 90:cb3d968589d8 60 * @{
Kojto 90:cb3d968589d8 61 */
Kojto 90:cb3d968589d8 62 /* ------------- PWR registers bit address in the alias region ---------------*/
Kojto 90:cb3d968589d8 63 #define PWR_OFFSET (PWR_BASE - PERIPH_BASE)
Kojto 90:cb3d968589d8 64
Kojto 90:cb3d968589d8 65 /* --- CR Register ---*/
Kojto 90:cb3d968589d8 66 #define CR_OFFSET (PWR_OFFSET + 0x00)
Kojto 90:cb3d968589d8 67 /* Alias word address of DBP bit */
Kojto 90:cb3d968589d8 68 #define DBP_BitNumber POSITION_VAL(PWR_CR_DBP)
Kojto 90:cb3d968589d8 69 #define CR_DBP_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (DBP_BitNumber * 4))
Kojto 90:cb3d968589d8 70
Kojto 90:cb3d968589d8 71 /* Alias word address of PVDE bit */
Kojto 90:cb3d968589d8 72 #define PVDE_BitNumber POSITION_VAL(PWR_CR_PVDE)
Kojto 90:cb3d968589d8 73 #define CR_PVDE_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (PVDE_BitNumber * 4))
Kojto 90:cb3d968589d8 74
Kojto 90:cb3d968589d8 75 /* --- CSR Register ---*/
Kojto 90:cb3d968589d8 76 #define CSR_OFFSET (PWR_OFFSET + 0x04)
Kojto 90:cb3d968589d8 77 /* Alias word address of EWUP1 bit */
Kojto 90:cb3d968589d8 78 #define EWUP1_BitNumber POSITION_VAL(PWR_CSR_EWUP1)
Kojto 90:cb3d968589d8 79 #define CSR_EWUP1_BB (PERIPH_BB_BASE + (CSR_OFFSET * 32) + (EWUP1_BitNumber * 4))
Kojto 90:cb3d968589d8 80
Kojto 90:cb3d968589d8 81 /* Alias word address of EWUP2 bit */
Kojto 90:cb3d968589d8 82 #define EWUP2_BitNumber POSITION_VAL(PWR_CSR_EWUP2)
Kojto 90:cb3d968589d8 83 #define CSR_EWUP2_BB (PERIPH_BB_BASE + (CSR_OFFSET * 32) + (EWUP2_BitNumber * 4))
Kojto 90:cb3d968589d8 84
Kojto 90:cb3d968589d8 85 /* Alias word address of EWUP3 bit */
Kojto 90:cb3d968589d8 86 #define EWUP3_BitNumber POSITION_VAL(PWR_CSR_EWUP3)
Kojto 90:cb3d968589d8 87 #define CSR_EWUP3_BB (PERIPH_BB_BASE + (CSR_OFFSET * 32) + (EWUP3_BitNumber * 4))
Kojto 90:cb3d968589d8 88 /**
Kojto 90:cb3d968589d8 89 * @}
Kojto 90:cb3d968589d8 90 */
Kojto 90:cb3d968589d8 91
Kojto 90:cb3d968589d8 92 /** @defgroup PWR_Exported_Constants PWR Exported Constants
Kojto 90:cb3d968589d8 93 * @{
Kojto 90:cb3d968589d8 94 */
Kojto 90:cb3d968589d8 95
Kojto 90:cb3d968589d8 96 /** @defgroup PWR_WakeUp_Pins PWR WakeUp Pins
Kojto 90:cb3d968589d8 97 * @{
Kojto 90:cb3d968589d8 98 */
Kojto 90:cb3d968589d8 99
Kojto 90:cb3d968589d8 100 #define PWR_WAKEUP_PIN1 ((uint32_t)0x00)
Kojto 90:cb3d968589d8 101 #define PWR_WAKEUP_PIN2 ((uint32_t)0x01)
Kojto 90:cb3d968589d8 102 #define PWR_WAKEUP_PIN3 ((uint32_t)0x02)
Kojto 90:cb3d968589d8 103 #define IS_PWR_WAKEUP_PIN(PIN) (((PIN) == PWR_WAKEUP_PIN1) || \
Kojto 90:cb3d968589d8 104 ((PIN) == PWR_WAKEUP_PIN2) || \
Kojto 90:cb3d968589d8 105 ((PIN) == PWR_WAKEUP_PIN3))
Kojto 90:cb3d968589d8 106 /**
Kojto 90:cb3d968589d8 107 * @}
Kojto 90:cb3d968589d8 108 */
Kojto 90:cb3d968589d8 109
Kojto 90:cb3d968589d8 110 /** @defgroup PWR_Regulator_state_in_STOP_mode PWR Regulator state in STOP mode
Kojto 90:cb3d968589d8 111 * @{
Kojto 90:cb3d968589d8 112 */
Kojto 90:cb3d968589d8 113 #define PWR_MAINREGULATOR_ON ((uint32_t)0x00000000)
Kojto 90:cb3d968589d8 114 #define PWR_LOWPOWERREGULATOR_ON PWR_CR_LPDS
Kojto 90:cb3d968589d8 115
Kojto 90:cb3d968589d8 116 #define IS_PWR_REGULATOR(REGULATOR) (((REGULATOR) == PWR_MAINREGULATOR_ON) || \
Kojto 90:cb3d968589d8 117 ((REGULATOR) == PWR_LOWPOWERREGULATOR_ON))
Kojto 90:cb3d968589d8 118 /**
Kojto 90:cb3d968589d8 119 * @}
Kojto 90:cb3d968589d8 120 */
Kojto 90:cb3d968589d8 121
Kojto 90:cb3d968589d8 122 /** @defgroup PWR_SLEEP_mode_entry PWR SLEEP mode entry
Kojto 90:cb3d968589d8 123 * @{
Kojto 90:cb3d968589d8 124 */
Kojto 90:cb3d968589d8 125 #define PWR_SLEEPENTRY_WFI ((uint8_t)0x01)
Kojto 90:cb3d968589d8 126 #define PWR_SLEEPENTRY_WFE ((uint8_t)0x02)
Kojto 90:cb3d968589d8 127 #define IS_PWR_SLEEP_ENTRY(ENTRY) (((ENTRY) == PWR_SLEEPENTRY_WFI) || ((ENTRY) == PWR_SLEEPENTRY_WFE))
Kojto 90:cb3d968589d8 128 /**
Kojto 90:cb3d968589d8 129 * @}
Kojto 90:cb3d968589d8 130 */
Kojto 90:cb3d968589d8 131
Kojto 90:cb3d968589d8 132 /** @defgroup PWR_STOP_mode_entry PWR STOP mode entry
Kojto 90:cb3d968589d8 133 * @{
Kojto 90:cb3d968589d8 134 */
Kojto 90:cb3d968589d8 135 #define PWR_STOPENTRY_WFI ((uint8_t)0x01)
Kojto 90:cb3d968589d8 136 #define PWR_STOPENTRY_WFE ((uint8_t)0x02)
Kojto 90:cb3d968589d8 137 #define IS_PWR_STOP_ENTRY(ENTRY) (((ENTRY) == PWR_STOPENTRY_WFI) || ((ENTRY) == PWR_STOPENTRY_WFE))
Kojto 90:cb3d968589d8 138 /**
Kojto 90:cb3d968589d8 139 * @}
Kojto 90:cb3d968589d8 140 */
Kojto 90:cb3d968589d8 141
Kojto 90:cb3d968589d8 142 /** @defgroup PWR_Flag PWR Flag
Kojto 90:cb3d968589d8 143 * @{
Kojto 90:cb3d968589d8 144 */
Kojto 90:cb3d968589d8 145 #define PWR_FLAG_WU PWR_CSR_WUF
Kojto 90:cb3d968589d8 146 #define PWR_FLAG_SB PWR_CSR_SBF
Kojto 90:cb3d968589d8 147 #define PWR_FLAG_PVDO PWR_CSR_PVDO
Kojto 90:cb3d968589d8 148 #define PWR_FLAG_VREFINTRDY PWR_CSR_VREFINTRDYF
Kojto 90:cb3d968589d8 149 #define IS_PWR_GET_FLAG(FLAG) (((FLAG) == PWR_FLAG_WU) || ((FLAG) == PWR_FLAG_SB) || \
Kojto 90:cb3d968589d8 150 ((FLAG) == PWR_FLAG_PVDO) || ((FLAG) == PWR_FLAG_VREFINTRDY))
Kojto 90:cb3d968589d8 151
Kojto 90:cb3d968589d8 152
Kojto 90:cb3d968589d8 153 /**
Kojto 90:cb3d968589d8 154 * @}
Kojto 90:cb3d968589d8 155 */
Kojto 90:cb3d968589d8 156
Kojto 90:cb3d968589d8 157 /**
Kojto 90:cb3d968589d8 158 * @}
Kojto 90:cb3d968589d8 159 */
Kojto 90:cb3d968589d8 160
Kojto 90:cb3d968589d8 161 /* Exported macro ------------------------------------------------------------*/
Kojto 90:cb3d968589d8 162 /** @defgroup PWR_Exported_Macro PWR Exported Macro
Kojto 90:cb3d968589d8 163 * @{
Kojto 90:cb3d968589d8 164 */
Kojto 90:cb3d968589d8 165
Kojto 90:cb3d968589d8 166 /** @brief Check PWR flag is set or not.
Kojto 90:cb3d968589d8 167 * @param __FLAG__: specifies the flag to check.
Kojto 90:cb3d968589d8 168 * This parameter can be one of the following values:
Kojto 90:cb3d968589d8 169 * @arg PWR_FLAG_WU: Wake Up flag. This flag indicates that a wakeup event
Kojto 90:cb3d968589d8 170 * was received from the WKUP pin or from the RTC alarm (Alarm A
Kojto 90:cb3d968589d8 171 * or Alarm B), RTC Tamper event, RTC TimeStamp event or RTC Wakeup.
Kojto 90:cb3d968589d8 172 * An additional wakeup event is detected if the WKUP pin is enabled
Kojto 90:cb3d968589d8 173 * (by setting the EWUP bit) when the WKUP pin level is already high.
Kojto 90:cb3d968589d8 174 * @arg PWR_FLAG_SB: StandBy flag. This flag indicates that the system was
Kojto 90:cb3d968589d8 175 * resumed from StandBy mode.
Kojto 90:cb3d968589d8 176 * @arg PWR_FLAG_PVDO: PVD Output. This flag is valid only if PVD is enabled
Kojto 90:cb3d968589d8 177 * by the HAL_PWR_EnablePVD() function. The PVD is stopped by Standby mode
Kojto 90:cb3d968589d8 178 * For this reason, this bit is equal to 0 after Standby or reset
Kojto 90:cb3d968589d8 179 * until the PVDE bit is set.
Kojto 90:cb3d968589d8 180 * @arg PWR_FLAG_VREFINTRDY: This flag indicates that the internal reference
Kojto 90:cb3d968589d8 181 * voltage VREFINT is ready.
Kojto 90:cb3d968589d8 182 * @retval The new state of __FLAG__ (TRUE or FALSE).
Kojto 90:cb3d968589d8 183 */
Kojto 90:cb3d968589d8 184 #define __HAL_PWR_GET_FLAG(__FLAG__) ((PWR->CSR & (__FLAG__)) == (__FLAG__))
Kojto 90:cb3d968589d8 185
Kojto 90:cb3d968589d8 186 /** @brief Clear the PWR's pending flags.
Kojto 90:cb3d968589d8 187 * @param __FLAG__: specifies the flag to clear.
Kojto 90:cb3d968589d8 188 * This parameter can be one of the following values:
Kojto 90:cb3d968589d8 189 * @arg PWR_FLAG_WU: Wake Up flag
Kojto 90:cb3d968589d8 190 * @arg PWR_FLAG_SB: StandBy flag
Kojto 90:cb3d968589d8 191 */
Kojto 90:cb3d968589d8 192 #define __HAL_PWR_CLEAR_FLAG(__FLAG__) (PWR->CR |= (__FLAG__) << 2)
Kojto 90:cb3d968589d8 193
Kojto 90:cb3d968589d8 194 /**
Kojto 90:cb3d968589d8 195 * @}
Kojto 90:cb3d968589d8 196 */
Kojto 90:cb3d968589d8 197
Kojto 90:cb3d968589d8 198 /* Include PWR HAL Extended module */
Kojto 90:cb3d968589d8 199 #include "stm32f3xx_hal_pwr_ex.h"
Kojto 90:cb3d968589d8 200
Kojto 90:cb3d968589d8 201 /* Exported functions --------------------------------------------------------*/
Kojto 90:cb3d968589d8 202
Kojto 90:cb3d968589d8 203 /** @addtogroup PWR_Exported_Functions PWR Exported Functions
Kojto 90:cb3d968589d8 204 * @{
Kojto 90:cb3d968589d8 205 */
Kojto 90:cb3d968589d8 206
Kojto 90:cb3d968589d8 207 /** @addtogroup PWR_Exported_Functions_Group1 Initialization and de-initialization functions
Kojto 90:cb3d968589d8 208 * @{
Kojto 90:cb3d968589d8 209 */
Kojto 90:cb3d968589d8 210
Kojto 90:cb3d968589d8 211 /* Initialization and de-initialization functions *****************************/
Kojto 90:cb3d968589d8 212 void HAL_PWR_DeInit(void);
Kojto 90:cb3d968589d8 213
Kojto 90:cb3d968589d8 214 /**
Kojto 90:cb3d968589d8 215 * @}
Kojto 90:cb3d968589d8 216 */
Kojto 90:cb3d968589d8 217
Kojto 90:cb3d968589d8 218 /** @addtogroup PWR_Exported_Functions_Group2 Peripheral Control functions
Kojto 90:cb3d968589d8 219 * @{
Kojto 90:cb3d968589d8 220 */
Kojto 90:cb3d968589d8 221
Kojto 90:cb3d968589d8 222 /* Peripheral Control functions **********************************************/
Kojto 90:cb3d968589d8 223 void HAL_PWR_EnableBkUpAccess(void);
Kojto 90:cb3d968589d8 224 void HAL_PWR_DisableBkUpAccess(void);
Kojto 90:cb3d968589d8 225
Kojto 90:cb3d968589d8 226 /* WakeUp pins configuration functions ****************************************/
Kojto 90:cb3d968589d8 227 void HAL_PWR_EnableWakeUpPin(uint32_t WakeUpPinx);
Kojto 90:cb3d968589d8 228 void HAL_PWR_DisableWakeUpPin(uint32_t WakeUpPinx);
Kojto 90:cb3d968589d8 229
Kojto 90:cb3d968589d8 230 /* Low Power modes configuration functions ************************************/
Kojto 90:cb3d968589d8 231 void HAL_PWR_EnterSTOPMode(uint32_t Regulator, uint8_t STOPEntry);
Kojto 90:cb3d968589d8 232 void HAL_PWR_EnterSLEEPMode(uint32_t Regulator, uint8_t SLEEPEntry);
Kojto 90:cb3d968589d8 233 void HAL_PWR_EnterSTANDBYMode(void);
Kojto 90:cb3d968589d8 234
Kojto 90:cb3d968589d8 235 /**
Kojto 90:cb3d968589d8 236 * @}
Kojto 90:cb3d968589d8 237 */
Kojto 90:cb3d968589d8 238
Kojto 90:cb3d968589d8 239 /**
Kojto 90:cb3d968589d8 240 * @}
Kojto 90:cb3d968589d8 241 */
Kojto 90:cb3d968589d8 242
Kojto 90:cb3d968589d8 243 /**
Kojto 90:cb3d968589d8 244 * @}
Kojto 90:cb3d968589d8 245 */
Kojto 90:cb3d968589d8 246
Kojto 90:cb3d968589d8 247 /**
Kojto 90:cb3d968589d8 248 * @}
Kojto 90:cb3d968589d8 249 */
Kojto 90:cb3d968589d8 250
Kojto 90:cb3d968589d8 251 #ifdef __cplusplus
Kojto 90:cb3d968589d8 252 }
Kojto 90:cb3d968589d8 253 #endif
Kojto 90:cb3d968589d8 254
Kojto 90:cb3d968589d8 255
Kojto 90:cb3d968589d8 256 #endif /* __STM32F3xx_HAL_PWR_H */
Kojto 90:cb3d968589d8 257
Kojto 90:cb3d968589d8 258 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/