text: /**
    ******************************************************************************
    * @file    stm32f4xx_hal_pwr_ex.h
    * @author  MCD Application Team
    * @version V1.7.0
    * @date    17-February-2017
    * @brief   Header file of PWR HAL Extension module.
    ******************************************************************************
    * @attention
    *
    * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
    *
    * Redistribution and use in source and binary forms, with or without modification,
    * are permitted provided that the following conditions are met:
    *   1. Redistributions of source code must retain the above copyright notice,
    *      this list of conditions and the following disclaimer.
    *   2. Redistributions in binary form must reproduce the above copyright notice,
    *      this list of conditions and the following disclaimer in the documentation
    *      and/or other materials provided with the distribution.
    *   3. Neither the name of STMicroelectronics nor the names of its contributors
    *      may be used to endorse or promote products derived from this software
    *      without specific prior written permission.
    *
    * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
    * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    *
    ******************************************************************************
    */ 
  
  /* Define to prevent recursive inclusion -------------------------------------*/
  #ifndef __STM32F4xx_HAL_PWR_EX_H
  #define __STM32F4xx_HAL_PWR_EX_H
  
  #ifdef __cplusplus
   extern "C" {
  #endif
  
  /* Includes ------------------------------------------------------------------*/
  #include "stm32f4xx_hal_def.h"
  
  /** @addtogroup STM32F4xx_HAL_Driver
    * @{
    */
  
  /** @addtogroup PWREx
    * @{
    */ 
  
  /* Exported types ------------------------------------------------------------*/ 
  /* Exported constants --------------------------------------------------------*/
  /** @defgroup PWREx_Exported_Constants PWREx Exported Constants
    * @{
    */
  #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
      defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
     
  /** @defgroup PWREx_Regulator_state_in_UnderDrive_mode PWREx Regulator state in UnderDrive mode
    * @{
    */
  #define PWR_MAINREGULATOR_UNDERDRIVE_ON                       PWR_CR_MRUDS
  #define PWR_LOWPOWERREGULATOR_UNDERDRIVE_ON                   ((uint32_t)(PWR_CR_LPDS | PWR_CR_LPUDS))
  /**
    * @}
    */ 
    
  /** @defgroup PWREx_Over_Under_Drive_Flag PWREx Over Under Drive Flag
    * @{
    */
  #define PWR_FLAG_ODRDY                  PWR_CSR_ODRDY
  #define PWR_FLAG_ODSWRDY                PWR_CSR_ODSWRDY
  #define PWR_FLAG_UDRDY                  PWR_CSR_UDSWRDY
  /**
    * @}
    */
  #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx */
  
  /** @defgroup PWREx_Regulator_Voltage_Scale PWREx Regulator Voltage Scale
    * @{
    */
  #if defined(STM32F405xx) || defined(STM32F407xx) || defined(STM32F415xx) || defined(STM32F417xx)   
  #define PWR_REGULATOR_VOLTAGE_SCALE1         PWR_CR_VOS             /* Scale 1 mode(default value at reset): the maximum value of fHCLK = 168 MHz. */
  #define PWR_REGULATOR_VOLTAGE_SCALE2         0x00000000U            /* Scale 2 mode: the maximum value of fHCLK = 144 MHz. */
  #else
  #define PWR_REGULATOR_VOLTAGE_SCALE1         PWR_CR_VOS             /* Scale 1 mode(default value at reset): the maximum value of fHCLK is 168 MHz. It can be extended to
                                                                         180 MHz by activating the over-drive mode. */
  #define PWR_REGULATOR_VOLTAGE_SCALE2         PWR_CR_VOS_1           /* Scale 2 mode: the maximum value of fHCLK is 144 MHz. It can be extended to
                                                                         168 MHz by activating the over-drive mode. */
  #define PWR_REGULATOR_VOLTAGE_SCALE3         PWR_CR_VOS_0           /* Scale 3 mode: the maximum value of fHCLK is 120 MHz. */
  #endif /* STM32F405xx || STM32F407xx || STM32F415xx || STM32F417xx */ 
  /**
    * @}
    */
  #if defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx) || defined(STM32F446xx) || defined(STM32F412Zx) || defined(STM32F412Vx) || \
      defined(STM32F412Rx) || defined(STM32F412Cx) || defined(STM32F413xx) || defined(STM32F423xx)
  /** @defgroup PWREx_WakeUp_Pins PWREx WakeUp Pins
    * @{
    */
  #define PWR_WAKEUP_PIN2                 0x00000080U
  #if defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx) || defined(STM32F412Zx) || defined(STM32F412Vx) || \
      defined(STM32F412Rx) || defined(STM32F412Cx) || defined(STM32F413xx) || defined(STM32F423xx) 
  #define PWR_WAKEUP_PIN3                 0x00000040U
  #endif /* STM32F410xx || STM32F412Zx || STM32F412Vx || STM32F412Rx || STM32F412Zx || STM32F412Vx || \
            STM32F412Rx || STM32F412Cx || STM32F413xx || STM32F423xx */
  /**
    * @}
    */   
  #endif /* STM32F410xx || STM32F446xx || STM32F412Zx || STM32F412Vx || STM32F412Rx || STM32F412Cx ||
            STM32F413xx || STM32F423xx */
  
  /**
    * @}
    */ 
    
  /* Exported macro ------------------------------------------------------------*/
  /** @defgroup PWREx_Exported_Constants PWREx Exported Constants
    *  @{
    */
  
  #if defined(STM32F405xx) || defined(STM32F407xx) || defined(STM32F415xx) || defined(STM32F417xx)
  /** @brief  macros configure the main internal regulator output voltage.
    * @param  __REGULATOR__: specifies the regulator output voltage to achieve
    *         a tradeoff between performance and power consumption when the device does
    *         not operate at the maximum frequency (refer to the datasheets for more details).
    *          This parameter can be one of the following values:
    *            @arg PWR_REGULATOR_VOLTAGE_SCALE1: Regulator voltage output Scale 1 mode
    *            @arg PWR_REGULATOR_VOLTAGE_SCALE2: Regulator voltage output Scale 2 mode
    * @retval None
    */
  #define __HAL_PWR_VOLTAGESCALING_CONFIG(__REGULATOR__) do {                                                     \
                                                              __IO uint32_t tmpreg = 0x00U;                        \
                                                              MODIFY_REG(PWR->CR, PWR_CR_VOS, (__REGULATOR__));   \
                                                              /* Delay after an RCC peripheral clock enabling */  \
                                                              tmpreg = READ_BIT(PWR->CR, PWR_CR_VOS);             \
                                                              UNUSED(tmpreg);                                     \
                                                            } while(0U)
  #else
  /** @brief  macros configure the main internal regulator output voltage.
    * @param  __REGULATOR__: specifies the regulator output voltage to achieve
    *         a tradeoff between performance and power consumption when the device does
    *         not operate at the maximum frequency (refer to the datasheets for more details).
    *          This parameter can be one of the following values:
    *            @arg PWR_REGULATOR_VOLTAGE_SCALE1: Regulator voltage output Scale 1 mode
    *            @arg PWR_REGULATOR_VOLTAGE_SCALE2: Regulator voltage output Scale 2 mode
    *            @arg PWR_REGULATOR_VOLTAGE_SCALE3: Regulator voltage output Scale 3 mode
    * @retval None
    */
  #define __HAL_PWR_VOLTAGESCALING_CONFIG(__REGULATOR__) do {                                                     \
                                                              __IO uint32_t tmpreg = 0x00U;                        \
                                                              MODIFY_REG(PWR->CR, PWR_CR_VOS, (__REGULATOR__));   \
                                                              /* Delay after an RCC peripheral clock enabling */  \
                                                              tmpreg = READ_BIT(PWR->CR, PWR_CR_VOS);             \
                                                              UNUSED(tmpreg);                                     \
                                                            } while(0U)
  #endif /* STM32F405xx || STM32F407xx || STM32F415xx || STM32F417xx */ 
  
  #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
      defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
  /** @brief Macros to enable or disable the Over drive mode.
    * @note  These macros can be used only for STM32F42xx/STM3243xx devices.
    */
  #define __HAL_PWR_OVERDRIVE_ENABLE() (*(__IO uint32_t *) CR_ODEN_BB = ENABLE)
  #define __HAL_PWR_OVERDRIVE_DISABLE() (*(__IO uint32_t *) CR_ODEN_BB = DISABLE)
  
  /** @brief Macros to enable or disable the Over drive switching.
    * @note  These macros can be used only for STM32F42xx/STM3243xx devices. 
    */
  #define __HAL_PWR_OVERDRIVESWITCHING_ENABLE() (*(__IO uint32_t *) CR_ODSWEN_BB = ENABLE)
  #define __HAL_PWR_OVERDRIVESWITCHING_DISABLE() (*(__IO uint32_t *) CR_ODSWEN_BB = DISABLE)
  
  /** @brief Macros to enable or disable the Under drive mode.
    * @note  This mode is enabled only with STOP low power mode.
    *        In this mode, the 1.2V domain is preserved in reduced leakage mode. This 
    *        mode is only available when the main regulator or the low power regulator 
    *        is in low voltage mode.      
    * @note  If the Under-drive mode was enabled, it is automatically disabled after 
    *        exiting Stop mode. 
    *        When the voltage regulator operates in Under-drive mode, an additional  
    *        startup delay is induced when waking up from Stop mode.
    */
  #define __HAL_PWR_UNDERDRIVE_ENABLE() (PWR->CR |= (uint32_t)PWR_CR_UDEN)
  #define __HAL_PWR_UNDERDRIVE_DISABLE() (PWR->CR &= (uint32_t)(~PWR_CR_UDEN))
  
  /** @brief  Check PWR flag is set or not.
    * @note   These macros can be used only for STM32F42xx/STM3243xx devices.
    * @param  __FLAG__: specifies the flag to check.
    *         This parameter can be one of the following values:
    *            @arg PWR_FLAG_ODRDY: This flag indicates that the Over-drive mode
    *                                 is ready 
    *            @arg PWR_FLAG_ODSWRDY: This flag indicates that the Over-drive mode
    *                                   switching is ready  
    *            @arg PWR_FLAG_UDRDY: This flag indicates that the Under-drive mode
    *                                 is enabled in Stop mode
    * @retval The new state of __FLAG__ (TRUE or FALSE).
    */
  #define __HAL_PWR_GET_ODRUDR_FLAG(__FLAG__) ((PWR->CSR & (__FLAG__)) == (__FLAG__))
  
  /** @brief Clear the Under-Drive Ready flag.
    * @note  These macros can be used only for STM32F42xx/STM3243xx devices.
    */
  #define __HAL_PWR_CLEAR_ODRUDR_FLAG() (PWR->CSR |= PWR_FLAG_UDRDY)
  
  #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx */
  /**
    * @}
    */
  
  /* Exported functions --------------------------------------------------------*/
  /** @addtogroup PWREx_Exported_Functions PWREx Exported Functions
    *  @{
    */
   
  /** @addtogroup PWREx_Exported_Functions_Group1
    * @{
    */
  void HAL_PWREx_EnableFlashPowerDown(void);
  void HAL_PWREx_DisableFlashPowerDown(void); 
  HAL_StatusTypeDef HAL_PWREx_EnableBkUpReg(void);
  HAL_StatusTypeDef HAL_PWREx_DisableBkUpReg(void); 
  uint32_t HAL_PWREx_GetVoltageRange(void);
  HAL_StatusTypeDef HAL_PWREx_ControlVoltageScaling(uint32_t VoltageScaling);
  
  #if defined(STM32F469xx) || defined(STM32F479xx)
  void HAL_PWREx_EnableWakeUpPinPolarityRisingEdge(void);
  void HAL_PWREx_EnableWakeUpPinPolarityFallingEdge(void);
  #endif /* STM32F469xx || STM32F479xx */
  
  #if defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx) || defined(STM32F401xC) ||\
      defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F412Zx) || defined(STM32F412Vx) ||\
      defined(STM32F412Rx) || defined(STM32F412Cx) || defined(STM32F413xx) || defined(STM32F423xx)
  void HAL_PWREx_EnableMainRegulatorLowVoltage(void);
  void HAL_PWREx_DisableMainRegulatorLowVoltage(void);
  void HAL_PWREx_EnableLowRegulatorLowVoltage(void);
  void HAL_PWREx_DisableLowRegulatorLowVoltage(void);
  #endif /* STM32F410xx || STM32F401xC || STM32F401xE || STM32F411xE || STM32F412Zx || STM32F412Vx ||\
            STM32F412Rx || STM32F412Cx || STM32F413xx || STM32F423xx */
  
  #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || defined(STM32F446xx) ||\
      defined(STM32F469xx) || defined(STM32F479xx)
  HAL_StatusTypeDef HAL_PWREx_EnableOverDrive(void);
  HAL_StatusTypeDef HAL_PWREx_DisableOverDrive(void);
  HAL_StatusTypeDef HAL_PWREx_EnterUnderDriveSTOPMode(uint32_t Regulator, uint8_t STOPEntry);
  #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx */
  
  /**
    * @}
    */
  
  /**
    * @}
    */
  /* Private types -------------------------------------------------------------*/
  /* Private variables ---------------------------------------------------------*/
  /* Private constants ---------------------------------------------------------*/
  /** @defgroup PWREx_Private_Constants PWREx Private Constants
    * @{
    */
  
  /** @defgroup PWREx_register_alias_address PWREx Register alias address
    * @{
    */
  /* ------------- PWR registers bit address in the alias region ---------------*/
  /* --- CR Register ---*/
  /* Alias word address of FPDS bit */
  #define FPDS_BIT_NUMBER          POSITION_VAL(PWR_CR_FPDS)
  #define CR_FPDS_BB               (uint32_t)(PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32U) + (FPDS_BIT_NUMBER * 4U))
  
  /* Alias word address of ODEN bit   */
  #define ODEN_BIT_NUMBER          POSITION_VAL(PWR_CR_ODEN)
  #define CR_ODEN_BB               (uint32_t)(PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32U) + (ODEN_BIT_NUMBER * 4U))
  
  /* Alias word address of ODSWEN bit */
  #define ODSWEN_BIT_NUMBER        POSITION_VAL(PWR_CR_ODSWEN)
  #define CR_ODSWEN_BB             (uint32_t)(PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32U) + (ODSWEN_BIT_NUMBER * 4U))
      
  /* Alias word address of MRLVDS bit */
  #define MRLVDS_BIT_NUMBER        POSITION_VAL(PWR_CR_MRLVDS)
  #define CR_MRLVDS_BB             (uint32_t)(PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32U) + (MRLVDS_BIT_NUMBER * 4U))
  
  /* Alias word address of LPLVDS bit */
  #define LPLVDS_BIT_NUMBER        POSITION_VAL(PWR_CR_LPLVDS)
  #define CR_LPLVDS_BB             (uint32_t)(PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32U) + (LPLVDS_BIT_NUMBER * 4U))
  
   /**
    * @}
    */
  
  /** @defgroup PWREx_CSR_register_alias PWRx CSR Register alias address
    * @{
    */  
  /* --- CSR Register ---*/
  /* Alias word address of BRE bit */
  #define BRE_BIT_NUMBER   POSITION_VAL(PWR_CSR_BRE)
  #define CSR_BRE_BB      (uint32_t)(PERIPH_BB_BASE + (PWR_CSR_OFFSET_BB * 32U) + (BRE_BIT_NUMBER * 4U))
  
  #if defined(STM32F469xx) || defined(STM32F479xx)
  /* Alias word address of WUPP bit */
  #define WUPP_BIT_NUMBER   POSITION_VAL(PWR_CSR_WUPP)
  #define CSR_WUPP_BB      (PERIPH_BB_BASE + (PWR_CSR_OFFSET_BB * 32U) + (WUPP_BIT_NUMBER * 4U))
  #endif /* STM32F469xx || STM32F479xx */
  /**
    * @}
    */
  
  /**
    * @}
    */
  
  /* Private macros ------------------------------------------------------------*/
  /** @defgroup PWREx_Private_Macros PWREx Private Macros
    * @{
    */
  
  /** @defgroup PWREx_IS_PWR_Definitions PWREx Private macros to check input parameters
    * @{
    */
  #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
      defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
  #define IS_PWR_REGULATOR_UNDERDRIVE(REGULATOR) (((REGULATOR) == PWR_MAINREGULATOR_UNDERDRIVE_ON) || \
                                                  ((REGULATOR) == PWR_LOWPOWERREGULATOR_UNDERDRIVE_ON))
  #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx */
  
  #if defined(STM32F405xx) || defined(STM32F407xx) || defined(STM32F415xx) || defined(STM32F417xx)
  #define IS_PWR_VOLTAGE_SCALING_RANGE(VOLTAGE) (((VOLTAGE) == PWR_REGULATOR_VOLTAGE_SCALE1) || \
                                                 ((VOLTAGE) == PWR_REGULATOR_VOLTAGE_SCALE2))
  #else
  #define IS_PWR_VOLTAGE_SCALING_RANGE(VOLTAGE) (((VOLTAGE) == PWR_REGULATOR_VOLTAGE_SCALE1) || \
                                                 ((VOLTAGE) == PWR_REGULATOR_VOLTAGE_SCALE2) || \
                                                 ((VOLTAGE) == PWR_REGULATOR_VOLTAGE_SCALE3))
  #endif /* STM32F405xx || STM32F407xx || STM32F415xx || STM32F417xx */ 
  
  #if defined(STM32F446xx)
  #define IS_PWR_WAKEUP_PIN(PIN) (((PIN) == PWR_WAKEUP_PIN1) || ((PIN) == PWR_WAKEUP_PIN2))
  #elif defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx) || defined(STM32F412Zx) ||\
        defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F412Cx) || defined(STM32F413xx) ||\
        defined(STM32F423xx)
  #define IS_PWR_WAKEUP_PIN(PIN) (((PIN) == PWR_WAKEUP_PIN1) || ((PIN) == PWR_WAKEUP_PIN2) || \
                                  ((PIN) == PWR_WAKEUP_PIN3))
  #else
  #define IS_PWR_WAKEUP_PIN(PIN) ((PIN) == PWR_WAKEUP_PIN1)
  #endif /* STM32F446xx */
  /**
    * @}
    */
  
  /**
    * @}
    */
  
  /**
    * @}
    */ 
  
  /**
    * @}
    */
    
  #ifdef __cplusplus
  }
  #endif
  
  
  #endif /* __STM32F4xx_HAL_PWR_EX_H */
  
  /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
  