Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_DISCO_F334C8/stm32f3xx_hal_pwr.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
100:cbbeb26dbd92 
.

Who changed what in which revision?

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