Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

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

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
86:04dd9b1680ae
Child:
99:dbbf35b96557
dgdgr

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 86:04dd9b1680ae 1 /**
bogdanm 86:04dd9b1680ae 2 ******************************************************************************
bogdanm 86:04dd9b1680ae 3 * @file stm32f4xx_hal_pwr_ex.h
bogdanm 86:04dd9b1680ae 4 * @author MCD Application Team
bogdanm 86:04dd9b1680ae 5 * @version V1.1.0
bogdanm 86:04dd9b1680ae 6 * @date 19-June-2014
bogdanm 86:04dd9b1680ae 7 * @brief Header file of PWR HAL Extension module.
bogdanm 86:04dd9b1680ae 8 ******************************************************************************
bogdanm 86:04dd9b1680ae 9 * @attention
bogdanm 86:04dd9b1680ae 10 *
bogdanm 86:04dd9b1680ae 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
bogdanm 86:04dd9b1680ae 12 *
bogdanm 86:04dd9b1680ae 13 * Redistribution and use in source and binary forms, with or without modification,
bogdanm 86:04dd9b1680ae 14 * are permitted provided that the following conditions are met:
bogdanm 86:04dd9b1680ae 15 * 1. Redistributions of source code must retain the above copyright notice,
bogdanm 86:04dd9b1680ae 16 * this list of conditions and the following disclaimer.
bogdanm 86:04dd9b1680ae 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
bogdanm 86:04dd9b1680ae 18 * this list of conditions and the following disclaimer in the documentation
bogdanm 86:04dd9b1680ae 19 * and/or other materials provided with the distribution.
bogdanm 86:04dd9b1680ae 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
bogdanm 86:04dd9b1680ae 21 * may be used to endorse or promote products derived from this software
bogdanm 86:04dd9b1680ae 22 * without specific prior written permission.
bogdanm 86:04dd9b1680ae 23 *
bogdanm 86:04dd9b1680ae 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
bogdanm 86:04dd9b1680ae 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
bogdanm 86:04dd9b1680ae 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
bogdanm 86:04dd9b1680ae 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
bogdanm 86:04dd9b1680ae 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
bogdanm 86:04dd9b1680ae 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
bogdanm 86:04dd9b1680ae 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
bogdanm 86:04dd9b1680ae 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
bogdanm 86:04dd9b1680ae 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
bogdanm 86:04dd9b1680ae 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bogdanm 86:04dd9b1680ae 34 *
bogdanm 86:04dd9b1680ae 35 ******************************************************************************
bogdanm 86:04dd9b1680ae 36 */
bogdanm 86:04dd9b1680ae 37
bogdanm 86:04dd9b1680ae 38 /* Define to prevent recursive inclusion -------------------------------------*/
bogdanm 86:04dd9b1680ae 39 #ifndef __STM32F4xx_HAL_PWR_EX_H
bogdanm 86:04dd9b1680ae 40 #define __STM32F4xx_HAL_PWR_EX_H
bogdanm 86:04dd9b1680ae 41
bogdanm 86:04dd9b1680ae 42 #ifdef __cplusplus
bogdanm 86:04dd9b1680ae 43 extern "C" {
bogdanm 86:04dd9b1680ae 44 #endif
bogdanm 86:04dd9b1680ae 45
bogdanm 86:04dd9b1680ae 46 /* Includes ------------------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 47 #include "stm32f4xx_hal_def.h"
bogdanm 86:04dd9b1680ae 48
bogdanm 86:04dd9b1680ae 49 /** @addtogroup STM32F4xx_HAL_Driver
bogdanm 86:04dd9b1680ae 50 * @{
bogdanm 86:04dd9b1680ae 51 */
bogdanm 86:04dd9b1680ae 52
bogdanm 86:04dd9b1680ae 53 /** @addtogroup PWREx
bogdanm 86:04dd9b1680ae 54 * @{
bogdanm 86:04dd9b1680ae 55 */
bogdanm 86:04dd9b1680ae 56
bogdanm 86:04dd9b1680ae 57 /* Exported types ------------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 58 /* Exported constants --------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 59 /* ------------- PWR registers bit address in the alias region ---------------*/
bogdanm 86:04dd9b1680ae 60 /* --- CR Register ---*/
bogdanm 86:04dd9b1680ae 61 /* Alias word address of FPDS bit */
bogdanm 86:04dd9b1680ae 62 #define FPDS_BitNumber 0x09
bogdanm 86:04dd9b1680ae 63 #define CR_FPDS_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (FPDS_BitNumber * 4))
bogdanm 86:04dd9b1680ae 64
bogdanm 86:04dd9b1680ae 65 /* Alias word address of ODEN bit */
bogdanm 86:04dd9b1680ae 66 #define ODEN_BitNumber 0x10
bogdanm 86:04dd9b1680ae 67 #define CR_ODEN_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (ODEN_BitNumber * 4))
bogdanm 86:04dd9b1680ae 68
bogdanm 86:04dd9b1680ae 69 /* Alias word address of ODSWEN bit */
bogdanm 86:04dd9b1680ae 70 #define ODSWEN_BitNumber 0x11
bogdanm 86:04dd9b1680ae 71 #define CR_ODSWEN_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (ODSWEN_BitNumber * 4))
bogdanm 86:04dd9b1680ae 72
bogdanm 86:04dd9b1680ae 73 /* Alias word address of MRLVDS bit */
bogdanm 86:04dd9b1680ae 74 #define MRLVDS_BitNumber 0x0B
bogdanm 86:04dd9b1680ae 75 #define CR_MRLVDS_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (MRLVDS_BitNumber * 4))
bogdanm 86:04dd9b1680ae 76
bogdanm 86:04dd9b1680ae 77 /* Alias word address of LPLVDS bit */
bogdanm 86:04dd9b1680ae 78 #define LPLVDS_BitNumber 0x0A
bogdanm 86:04dd9b1680ae 79 #define CR_LPLVDS_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (LPLVDS_BitNumber * 4))
bogdanm 86:04dd9b1680ae 80
bogdanm 86:04dd9b1680ae 81 /* --- CSR Register ---*/
bogdanm 86:04dd9b1680ae 82 /* Alias word address of BRE bit */
bogdanm 86:04dd9b1680ae 83 #define BRE_BitNumber 0x09
bogdanm 86:04dd9b1680ae 84 #define CSR_BRE_BB (PERIPH_BB_BASE + (CSR_OFFSET * 32) + (BRE_BitNumber * 4))
bogdanm 86:04dd9b1680ae 85
bogdanm 86:04dd9b1680ae 86 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
bogdanm 86:04dd9b1680ae 87
bogdanm 86:04dd9b1680ae 88 /** @defgroup PWREx_Regulator_state_in_UnderDrive_mode
bogdanm 86:04dd9b1680ae 89 * @{
bogdanm 86:04dd9b1680ae 90 */
bogdanm 86:04dd9b1680ae 91 #define PWR_MAINREGULATOR_UNDERDRIVE_ON PWR_CR_MRUDS
bogdanm 86:04dd9b1680ae 92 #define PWR_LOWPOWERREGULATOR_UNDERDRIVE_ON ((uint32_t)(PWR_CR_LPDS | PWR_CR_LPUDS))
bogdanm 86:04dd9b1680ae 93
bogdanm 86:04dd9b1680ae 94 #define IS_PWR_REGULATOR_UNDERDRIVE(REGULATOR) (((REGULATOR) == PWR_MAINREGULATOR_UNDERDRIVE_ON) || \
bogdanm 86:04dd9b1680ae 95 ((REGULATOR) == PWR_LOWPOWERREGULATOR_UNDERDRIVE_ON))
bogdanm 86:04dd9b1680ae 96 /**
bogdanm 86:04dd9b1680ae 97 * @}
bogdanm 86:04dd9b1680ae 98 */
bogdanm 86:04dd9b1680ae 99
bogdanm 86:04dd9b1680ae 100 /** @defgroup PWREx_Over_Under_Drive_Flag
bogdanm 86:04dd9b1680ae 101 * @{
bogdanm 86:04dd9b1680ae 102 */
bogdanm 86:04dd9b1680ae 103 #define PWR_FLAG_ODRDY PWR_CSR_ODRDY
bogdanm 86:04dd9b1680ae 104 #define PWR_FLAG_ODSWRDY PWR_CSR_ODSWRDY
bogdanm 86:04dd9b1680ae 105 #define PWR_FLAG_UDRDY PWR_CSR_UDSWRDY
bogdanm 86:04dd9b1680ae 106 /**
bogdanm 86:04dd9b1680ae 107 * @}
bogdanm 86:04dd9b1680ae 108 */
bogdanm 86:04dd9b1680ae 109 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
bogdanm 86:04dd9b1680ae 110 /**
bogdanm 86:04dd9b1680ae 111 * @}
bogdanm 86:04dd9b1680ae 112 */
bogdanm 86:04dd9b1680ae 113
bogdanm 86:04dd9b1680ae 114 /* Exported macro ------------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 115
bogdanm 86:04dd9b1680ae 116 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
bogdanm 86:04dd9b1680ae 117 /** @brief Macros to enable or disable the Over drive mode.
bogdanm 86:04dd9b1680ae 118 * @note These macros can be used only for STM32F42xx/STM3243xx devices.
bogdanm 86:04dd9b1680ae 119 */
bogdanm 86:04dd9b1680ae 120 #define __HAL_PWR_OVERDRIVE_ENABLE() (*(__IO uint32_t *) CR_ODEN_BB = ENABLE)
bogdanm 86:04dd9b1680ae 121 #define __HAL_PWR_OVERDRIVE_DISABLE() (*(__IO uint32_t *) CR_ODEN_BB = DISABLE)
bogdanm 86:04dd9b1680ae 122
bogdanm 86:04dd9b1680ae 123 /** @brief Macros to enable or disable the Over drive switching.
bogdanm 86:04dd9b1680ae 124 * @note These macros can be used only for STM32F42xx/STM3243xx devices.
bogdanm 86:04dd9b1680ae 125 */
bogdanm 86:04dd9b1680ae 126 #define __HAL_PWR_OVERDRIVESWITCHING_ENABLE() (*(__IO uint32_t *) CR_ODSWEN_BB = ENABLE)
bogdanm 86:04dd9b1680ae 127 #define __HAL_PWR_OVERDRIVESWITCHING_DISABLE() (*(__IO uint32_t *) CR_ODSWEN_BB = DISABLE)
bogdanm 86:04dd9b1680ae 128
bogdanm 86:04dd9b1680ae 129 /** @brief Macros to enable or disable the Under drive mode.
bogdanm 86:04dd9b1680ae 130 * @note This mode is enabled only with STOP low power mode.
bogdanm 86:04dd9b1680ae 131 * In this mode, the 1.2V domain is preserved in reduced leakage mode. This
bogdanm 86:04dd9b1680ae 132 * mode is only available when the main regulator or the low power regulator
bogdanm 86:04dd9b1680ae 133 * is in low voltage mode.
bogdanm 86:04dd9b1680ae 134 * @note If the Under-drive mode was enabled, it is automatically disabled after
bogdanm 86:04dd9b1680ae 135 * exiting Stop mode.
bogdanm 86:04dd9b1680ae 136 * When the voltage regulator operates in Under-drive mode, an additional
bogdanm 86:04dd9b1680ae 137 * startup delay is induced when waking up from Stop mode.
bogdanm 86:04dd9b1680ae 138 */
bogdanm 86:04dd9b1680ae 139 #define __HAL_PWR_UNDERDRIVE_ENABLE() (PWR->CR |= (uint32_t)PWR_CR_UDEN)
bogdanm 86:04dd9b1680ae 140 #define __HAL_PWR_UNDERDRIVE_DISABLE() (PWR->CR &= (uint32_t)(~PWR_CR_UDEN))
bogdanm 86:04dd9b1680ae 141
bogdanm 86:04dd9b1680ae 142 /** @brief Check PWR flag is set or not.
bogdanm 86:04dd9b1680ae 143 * @note These macros can be used only for STM32F42xx/STM3243xx devices.
bogdanm 86:04dd9b1680ae 144 * @param __FLAG__: specifies the flag to check.
bogdanm 86:04dd9b1680ae 145 * This parameter can be one of the following values:
bogdanm 86:04dd9b1680ae 146 * @arg PWR_FLAG_ODRDY: This flag indicates that the Over-drive mode
bogdanm 86:04dd9b1680ae 147 * is ready
bogdanm 86:04dd9b1680ae 148 * @arg PWR_FLAG_ODSWRDY: This flag indicates that the Over-drive mode
bogdanm 86:04dd9b1680ae 149 * switching is ready
bogdanm 86:04dd9b1680ae 150 * @arg PWR_FLAG_UDRDY: This flag indicates that the Under-drive mode
bogdanm 86:04dd9b1680ae 151 * is enabled in Stop mode
bogdanm 86:04dd9b1680ae 152 * @retval The new state of __FLAG__ (TRUE or FALSE).
bogdanm 86:04dd9b1680ae 153 */
bogdanm 86:04dd9b1680ae 154 #define __HAL_PWR_GET_ODRUDR_FLAG(__FLAG__) ((PWR->CSR & (__FLAG__)) == (__FLAG__))
bogdanm 86:04dd9b1680ae 155
bogdanm 86:04dd9b1680ae 156 /** @brief Clear the Under-Drive Ready flag.
bogdanm 86:04dd9b1680ae 157 * @note These macros can be used only for STM32F42xx/STM3243xx devices.
bogdanm 86:04dd9b1680ae 158 */
bogdanm 86:04dd9b1680ae 159 #define __HAL_PWR_CLEAR_ODRUDR_FLAG() (PWR->CSR |= PWR_FLAG_UDRDY)
bogdanm 86:04dd9b1680ae 160
bogdanm 86:04dd9b1680ae 161 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
bogdanm 86:04dd9b1680ae 162
bogdanm 86:04dd9b1680ae 163 /* Exported functions --------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 164 void HAL_PWREx_EnableFlashPowerDown(void);
bogdanm 86:04dd9b1680ae 165 void HAL_PWREx_DisableFlashPowerDown(void);
bogdanm 86:04dd9b1680ae 166 HAL_StatusTypeDef HAL_PWREx_EnableBkUpReg(void);
bogdanm 86:04dd9b1680ae 167 HAL_StatusTypeDef HAL_PWREx_DisableBkUpReg(void);
bogdanm 86:04dd9b1680ae 168
bogdanm 86:04dd9b1680ae 169 #if defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE)
bogdanm 86:04dd9b1680ae 170 void HAL_PWREx_EnableMainRegulatorLowVoltage(void);
bogdanm 86:04dd9b1680ae 171 void HAL_PWREx_DisableMainRegulatorLowVoltage(void);
bogdanm 86:04dd9b1680ae 172 void HAL_PWREx_EnableLowRegulatorLowVoltage(void);
bogdanm 86:04dd9b1680ae 173 void HAL_PWREx_DisableLowRegulatorLowVoltage(void);
bogdanm 86:04dd9b1680ae 174 #endif /* STM32F401xC || STM32F401xE || STM32F411xE */
bogdanm 86:04dd9b1680ae 175
bogdanm 86:04dd9b1680ae 176 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
bogdanm 86:04dd9b1680ae 177 HAL_StatusTypeDef HAL_PWREx_ActivateOverDrive(void);
bogdanm 86:04dd9b1680ae 178 HAL_StatusTypeDef HAL_PWREx_DeactivateOverDrive(void);
bogdanm 86:04dd9b1680ae 179 HAL_StatusTypeDef HAL_PWREx_EnterUnderDriveSTOPMode(uint32_t Regulator, uint8_t STOPEntry);
bogdanm 86:04dd9b1680ae 180 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
bogdanm 86:04dd9b1680ae 181
bogdanm 86:04dd9b1680ae 182 /**
bogdanm 86:04dd9b1680ae 183 * @}
bogdanm 86:04dd9b1680ae 184 */
bogdanm 86:04dd9b1680ae 185
bogdanm 86:04dd9b1680ae 186 /**
bogdanm 86:04dd9b1680ae 187 * @}
bogdanm 86:04dd9b1680ae 188 */
bogdanm 86:04dd9b1680ae 189
bogdanm 86:04dd9b1680ae 190 #ifdef __cplusplus
bogdanm 86:04dd9b1680ae 191 }
bogdanm 86:04dd9b1680ae 192 #endif
bogdanm 86:04dd9b1680ae 193
bogdanm 86:04dd9b1680ae 194
bogdanm 86:04dd9b1680ae 195 #endif /* __STM32F4xx_HAL_PWR_EX_H */
bogdanm 86:04dd9b1680ae 196
bogdanm 86:04dd9b1680ae 197 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/