/**
 ******************************************************************************
 * @file    stm32f1xx_ll_pwr.h
 * @author  MCD Application Team
 * @brief   Header file of PWR LL module.
 ******************************************************************************
 * @attention
 *
 * Copyright (c) 2016 STMicroelectronics.
 * All rights reserved.
 *
 * This software is licensed under terms that can be found in the LICENSE file
 * in the root directory of this software component.
 * If no LICENSE file comes with this software, it is provided AS-IS.
 *
 ******************************************************************************
 */

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __STM32F1xx_LL_PWR_H
#define __STM32F1xx_LL_PWR_H

#ifdef __cplusplus
extern "C" {
#endif

    /* Includes ------------------------------------------------------------------*/
#include "stm32f1xx.h"

    /** @addtogroup STM32F1xx_LL_Driver
     * @{
     */

#if defined(PWR)

    /** @defgroup PWR_LL PWR
     * @{
     */

    /* Private types -------------------------------------------------------------*/
    /* Private variables ---------------------------------------------------------*/
    /* Private constants ---------------------------------------------------------*/
    /* Private macros ------------------------------------------------------------*/
    /* Exported types ------------------------------------------------------------*/
    /* Exported constants --------------------------------------------------------*/
    /** @defgroup PWR_LL_Exported_Constants PWR Exported Constants
     * @{
     */

    /** @defgroup PWR_LL_EC_CLEAR_FLAG Clear Flags Defines
     * @brief    Flags defines which can be used with LL_PWR_WriteReg function
     * @{
     */
#define LL_PWR_CR_CSBF                     PWR_CR_CSBF            /*!< Clear standby flag */
#define LL_PWR_CR_CWUF                     PWR_CR_CWUF            /*!< Clear wakeup flag */
    /**
     * @}
     */

    /** @defgroup PWR_LL_EC_GET_FLAG Get Flags Defines
     * @brief    Flags defines which can be used with LL_PWR_ReadReg function
     * @{
     */
#define LL_PWR_CSR_WUF                     PWR_CSR_WUF            /*!< Wakeup flag */
#define LL_PWR_CSR_SBF                     PWR_CSR_SBF            /*!< Standby flag */
#define LL_PWR_CSR_PVDO                    PWR_CSR_PVDO           /*!< Power voltage detector output flag */
#define LL_PWR_CSR_EWUP1                   PWR_CSR_EWUP           /*!< Enable WKUP pin 1 */
    /**
     * @}
     */

    /** @defgroup PWR_LL_EC_MODE_PWR Mode Power
     * @{
     */
#define LL_PWR_MODE_STOP_MAINREGU             0x00000000U                    /*!< Enter Stop mode when the CPU enters deepsleep */
#define LL_PWR_MODE_STOP_LPREGU               (PWR_CR_LPDS)                  /*!< Enter Stop mode (with low power Regulator ON) when the CPU enters deepsleep */
#define LL_PWR_MODE_STANDBY                   (PWR_CR_PDDS)                  /*!< Enter Standby mode when the CPU enters deepsleep */
    /**
     * @}
     */

    /** @defgroup PWR_LL_EC_REGU_MODE_DS_MODE  Regulator Mode In Deep Sleep Mode
     * @{
     */
#define LL_PWR_REGU_DSMODE_MAIN        0x00000000U           /*!< Voltage Regulator in main mode during deepsleep mode */
#define LL_PWR_REGU_DSMODE_LOW_POWER   (PWR_CR_LPDS)         /*!< Voltage Regulator in low-power mode during deepsleep mode */
    /**
     * @}
     */

    /** @defgroup PWR_LL_EC_PVDLEVEL Power Voltage Detector Level
     * @{
     */
#define LL_PWR_PVDLEVEL_0                  (PWR_CR_PLS_LEV0)      /*!< Voltage threshold detected by PVD 2.2 V */
#define LL_PWR_PVDLEVEL_1                  (PWR_CR_PLS_LEV1)      /*!< Voltage threshold detected by PVD 2.3 V */
#define LL_PWR_PVDLEVEL_2                  (PWR_CR_PLS_LEV2)      /*!< Voltage threshold detected by PVD 2.4 V */
#define LL_PWR_PVDLEVEL_3                  (PWR_CR_PLS_LEV3)      /*!< Voltage threshold detected by PVD 2.5 V */
#define LL_PWR_PVDLEVEL_4                  (PWR_CR_PLS_LEV4)      /*!< Voltage threshold detected by PVD 2.6 V */
#define LL_PWR_PVDLEVEL_5                  (PWR_CR_PLS_LEV5)      /*!< Voltage threshold detected by PVD 2.7 V */
#define LL_PWR_PVDLEVEL_6                  (PWR_CR_PLS_LEV6)      /*!< Voltage threshold detected by PVD 2.8 V */
#define LL_PWR_PVDLEVEL_7                  (PWR_CR_PLS_LEV7)      /*!< Voltage threshold detected by PVD 2.9 V */
    /**
     * @}
     */
    /** @defgroup PWR_LL_EC_WAKEUP_PIN  Wakeup Pins
     * @{
     */
#define LL_PWR_WAKEUP_PIN1                 (PWR_CSR_EWUP)         /*!< WKUP pin 1 : PA0 */
    /**
     * @}
     */

    /**
     * @}
     */

    /* Exported macro ------------------------------------------------------------*/
    /** @defgroup PWR_LL_Exported_Macros PWR Exported Macros
     * @{
     */

    /** @defgroup PWR_LL_EM_WRITE_READ Common write and read registers Macros
     * @{
     */

    /**
     * @brief  Write a value in PWR register
     * @param  __REG__ Register to be written
     * @param  __VALUE__ Value to be written in the register
     * @retval None
     */
#define LL_PWR_WriteReg(__REG__, __VALUE__) WRITE_REG(PWR->__REG__, (__VALUE__))

    /**
     * @brief  Read a value in PWR register
     * @param  __REG__ Register to be read
     * @retval Register value
     */
#define LL_PWR_ReadReg(__REG__) READ_REG(PWR->__REG__)
    /**
     * @}
     */

    /**
     * @}
     */

    /* Exported functions --------------------------------------------------------*/
    /** @defgroup PWR_LL_Exported_Functions PWR Exported Functions
     * @{
     */

    /** @defgroup PWR_LL_EF_Configuration Configuration
     * @{
     */

    /**
     * @brief  Enable access to the backup domain
     * @rmtoll CR    DBP       LL_PWR_EnableBkUpAccess
     * @retval None
     */
    __STATIC_INLINE void LL_PWR_EnableBkUpAccess(void)
    {
        SET_BIT(PWR->CR, PWR_CR_DBP);
    }

    /**
     * @brief  Disable access to the backup domain
     * @rmtoll CR    DBP       LL_PWR_DisableBkUpAccess
     * @retval None
     */
    __STATIC_INLINE void LL_PWR_DisableBkUpAccess(void)
    {
        CLEAR_BIT(PWR->CR, PWR_CR_DBP);
    }

    /**
     * @brief  Check if the backup domain is enabled
     * @rmtoll CR    DBP       LL_PWR_IsEnabledBkUpAccess
     * @retval State of bit (1 or 0).
     */
    __STATIC_INLINE uint32_t LL_PWR_IsEnabledBkUpAccess(void)
    {
        return (READ_BIT(PWR->CR, PWR_CR_DBP) == (PWR_CR_DBP));
    }

    /**
     * @brief  Set voltage Regulator mode during deep sleep mode
     * @rmtoll CR    LPDS         LL_PWR_SetRegulModeDS
     * @param  RegulMode This parameter can be one of the following values:
     *         @arg @ref LL_PWR_REGU_DSMODE_MAIN
     *         @arg @ref LL_PWR_REGU_DSMODE_LOW_POWER
     * @retval None
     */
    __STATIC_INLINE void LL_PWR_SetRegulModeDS(uint32_t RegulMode)
    {
        MODIFY_REG(PWR->CR, PWR_CR_LPDS, RegulMode);
    }

    /**
     * @brief  Get voltage Regulator mode during deep sleep mode
     * @rmtoll CR    LPDS         LL_PWR_GetRegulModeDS
     * @retval Returned value can be one of the following values:
     *         @arg @ref LL_PWR_REGU_DSMODE_MAIN
     *         @arg @ref LL_PWR_REGU_DSMODE_LOW_POWER
     */
    __STATIC_INLINE uint32_t LL_PWR_GetRegulModeDS(void)
    {
        return (uint32_t) (READ_BIT(PWR->CR, PWR_CR_LPDS));
    }

    /**
     * @brief  Set Power Down mode when CPU enters deepsleep
     * @rmtoll CR    PDDS         LL_PWR_SetPowerMode\n
     * @rmtoll CR    LPDS         LL_PWR_SetPowerMode
     * @param  PDMode This parameter can be one of the following values:
     *         @arg @ref LL_PWR_MODE_STOP_MAINREGU
     *         @arg @ref LL_PWR_MODE_STOP_LPREGU
     *         @arg @ref LL_PWR_MODE_STANDBY
     * @retval None
     */
    __STATIC_INLINE void LL_PWR_SetPowerMode(uint32_t PDMode)
    {
        MODIFY_REG(PWR->CR, (PWR_CR_PDDS| PWR_CR_LPDS), PDMode);
    }

    /**
     * @brief  Get Power Down mode when CPU enters deepsleep
     * @rmtoll CR    PDDS         LL_PWR_GetPowerMode\n
     * @rmtoll CR    LPDS         LL_PWR_GetPowerMode
     * @retval Returned value can be one of the following values:
     *         @arg @ref LL_PWR_MODE_STOP_MAINREGU
     *         @arg @ref LL_PWR_MODE_STOP_LPREGU
     *         @arg @ref LL_PWR_MODE_STANDBY
     */
    __STATIC_INLINE uint32_t LL_PWR_GetPowerMode(void)
    {
        return (uint32_t) (READ_BIT(PWR->CR, (PWR_CR_PDDS| PWR_CR_LPDS)));
    }

    /**
     * @brief  Configure the voltage threshold detected by the Power Voltage Detector
     * @rmtoll CR    PLS       LL_PWR_SetPVDLevel
     * @param  PVDLevel This parameter can be one of the following values:
     *         @arg @ref LL_PWR_PVDLEVEL_0
     *         @arg @ref LL_PWR_PVDLEVEL_1
     *         @arg @ref LL_PWR_PVDLEVEL_2
     *         @arg @ref LL_PWR_PVDLEVEL_3
     *         @arg @ref LL_PWR_PVDLEVEL_4
     *         @arg @ref LL_PWR_PVDLEVEL_5
     *         @arg @ref LL_PWR_PVDLEVEL_6
     *         @arg @ref LL_PWR_PVDLEVEL_7
     * @retval None
     */
    __STATIC_INLINE void LL_PWR_SetPVDLevel(uint32_t PVDLevel)
    {
        MODIFY_REG(PWR->CR, PWR_CR_PLS, PVDLevel);
    }

    /**
     * @brief  Get the voltage threshold detection
     * @rmtoll CR    PLS       LL_PWR_GetPVDLevel
     * @retval Returned value can be one of the following values:
     *         @arg @ref LL_PWR_PVDLEVEL_0
     *         @arg @ref LL_PWR_PVDLEVEL_1
     *         @arg @ref LL_PWR_PVDLEVEL_2
     *         @arg @ref LL_PWR_PVDLEVEL_3
     *         @arg @ref LL_PWR_PVDLEVEL_4
     *         @arg @ref LL_PWR_PVDLEVEL_5
     *         @arg @ref LL_PWR_PVDLEVEL_6
     *         @arg @ref LL_PWR_PVDLEVEL_7
     */
    __STATIC_INLINE uint32_t LL_PWR_GetPVDLevel(void)
    {
        return (uint32_t) (READ_BIT(PWR->CR, PWR_CR_PLS));
    }

    /**
     * @brief  Enable Power Voltage Detector
     * @rmtoll CR    PVDE       LL_PWR_EnablePVD
     * @retval None
     */
    __STATIC_INLINE void LL_PWR_EnablePVD(void)
    {
        SET_BIT(PWR->CR, PWR_CR_PVDE);
    }

    /**
     * @brief  Disable Power Voltage Detector
     * @rmtoll CR    PVDE       LL_PWR_DisablePVD
     * @retval None
     */
    __STATIC_INLINE void LL_PWR_DisablePVD(void)
    {
        CLEAR_BIT(PWR->CR, PWR_CR_PVDE);
    }

    /**
     * @brief  Check if Power Voltage Detector is enabled
     * @rmtoll CR    PVDE       LL_PWR_IsEnabledPVD
     * @retval State of bit (1 or 0).
     */
    __STATIC_INLINE uint32_t LL_PWR_IsEnabledPVD(void)
    {
        return (READ_BIT(PWR->CR, PWR_CR_PVDE) == (PWR_CR_PVDE));
    }

    /**
     * @brief  Enable the WakeUp PINx functionality
     * @rmtoll CSR   EWUP       LL_PWR_EnableWakeUpPin
     * @param  WakeUpPin This parameter can be one of the following values:
     *         @arg @ref LL_PWR_WAKEUP_PIN1
     * @retval None
     */
    __STATIC_INLINE void LL_PWR_EnableWakeUpPin(uint32_t WakeUpPin)
    {
        SET_BIT(PWR->CSR, WakeUpPin);
    }

    /**
     * @brief  Disable the WakeUp PINx functionality
     * @rmtoll CSR   EWUP       LL_PWR_DisableWakeUpPin
     * @param  WakeUpPin This parameter can be one of the following values:
     *         @arg @ref LL_PWR_WAKEUP_PIN1
     * @retval None
     */
    __STATIC_INLINE void LL_PWR_DisableWakeUpPin(uint32_t WakeUpPin)
    {
        CLEAR_BIT(PWR->CSR, WakeUpPin);
    }

    /**
     * @brief  Check if the WakeUp PINx functionality is enabled
     * @rmtoll CSR   EWUP       LL_PWR_IsEnabledWakeUpPin
     * @param  WakeUpPin This parameter can be one of the following values:
     *         @arg @ref LL_PWR_WAKEUP_PIN1
     * @retval State of bit (1 or 0).
     */
    __STATIC_INLINE uint32_t LL_PWR_IsEnabledWakeUpPin(uint32_t WakeUpPin)
    {
        return (READ_BIT(PWR->CSR, WakeUpPin) == (WakeUpPin));
    }

    /**
     * @}
     */

    /** @defgroup PWR_LL_EF_FLAG_Management FLAG_Management
     * @{
     */

    /**
     * @brief  Get Wake-up Flag
     * @rmtoll CSR   WUF       LL_PWR_IsActiveFlag_WU
     * @retval State of bit (1 or 0).
     */
    __STATIC_INLINE uint32_t LL_PWR_IsActiveFlag_WU(void)
    {
        return (READ_BIT(PWR->CSR, PWR_CSR_WUF) == (PWR_CSR_WUF));
    }

    /**
     * @brief  Get Standby Flag
     * @rmtoll CSR   SBF       LL_PWR_IsActiveFlag_SB
     * @retval State of bit (1 or 0).
     */
    __STATIC_INLINE uint32_t LL_PWR_IsActiveFlag_SB(void)
    {
        return (READ_BIT(PWR->CSR, PWR_CSR_SBF) == (PWR_CSR_SBF));
    }

    /**
     * @brief  Indicate whether VDD voltage is below the selected PVD threshold
     * @rmtoll CSR   PVDO       LL_PWR_IsActiveFlag_PVDO
     * @retval State of bit (1 or 0).
     */
    __STATIC_INLINE uint32_t LL_PWR_IsActiveFlag_PVDO(void)
    {
        return (READ_BIT(PWR->CSR, PWR_CSR_PVDO) == (PWR_CSR_PVDO));
    }

    /**
     * @brief  Clear Standby Flag
     * @rmtoll CR   CSBF       LL_PWR_ClearFlag_SB
     * @retval None
     */
    __STATIC_INLINE void LL_PWR_ClearFlag_SB(void)
    {
        SET_BIT(PWR->CR, PWR_CR_CSBF);
    }

    /**
     * @brief  Clear Wake-up Flags
     * @rmtoll CR   CWUF       LL_PWR_ClearFlag_WU
     * @retval None
     */
    __STATIC_INLINE void LL_PWR_ClearFlag_WU(void)
    {
        SET_BIT(PWR->CR, PWR_CR_CWUF);
    }

    /**
     * @}
     */

#if defined(USE_FULL_LL_DRIVER)
/** @defgroup PWR_LL_EF_Init De-initialization function
  * @{
  */
ErrorStatus LL_PWR_DeInit(void);
/**
  * @}
  */
#endif /* USE_FULL_LL_DRIVER */

    /**
     * @}
     */

    /**
     * @}
     */

#endif /* defined(PWR) */

    /**
     * @}
     */

#ifdef __cplusplus
}
#endif

#endif /* __STM32F1xx_LL_PWR_H */
