lib/main/AT32F43x/Drivers/AT32F43x_StdPeriph_Driver/src/at32f435_437_pwc.c

   1 /**
   2   **************************************************************************
   3   * @file     at32f435_437_pwc.c
   4   * @version  v2.1.0
   5   * @date     2022-08-16
   6   * @brief    contains all the functions for the pwc firmware library
   7   **************************************************************************
   8   *                       Copyright notice & Disclaimer
   9   *
  10   * The software Board Support Package (BSP) that is made available to
  11   * download from Artery official website is the copyrighted work of Artery.
  12   * Artery authorizes customers to use, copy, and distribute the BSP
  13   * software and its related documentation for the purpose of design and
  14   * development in conjunction with Artery microcontrollers. Use of the
  15   * software is governed by this copyright notice and the following disclaimer.
  16   *
  17   * THIS SOFTWARE IS PROVIDED ON "AS IS" BASIS WITHOUT WARRANTIES,
  18   * GUARANTEES OR REPRESENTATIONS OF ANY KIND. ARTERY EXPRESSLY DISCLAIMS,
  19   * TO THE FULLEST EXTENT PERMITTED BY LAW, ALL EXPRESS, IMPLIED OR
  20   * STATUTORY OR OTHER WARRANTIES, GUARANTEES OR REPRESENTATIONS,
  21   * INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
  22   * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  23   *
  24   **************************************************************************
  25   */
  26
  27 #include "at32f435_437_conf.h"
  28
  29 /** @addtogroup AT32F435_437_periph_driver
  30   * @{
  31   */
  32
  33 /** @defgroup PWC
  34   * @brief PWC driver modules
  35   * @{
  36   */
  37
  38 #ifdef PWC_MODULE_ENABLED
  39
  40 /** @defgroup PWC_private_functions
  41   * @{
  42   */
  43
  44 /**
  45   * @brief  deinitialize the pwc peripheral registers to their default reset values.
  46   * @param  none
  47   * @retval none
  48   */
  49 void pwc_reset(void)
  50 {
  51   crm_periph_reset(CRM_PWC_PERIPH_RESET, TRUE);
  52   crm_periph_reset(CRM_PWC_PERIPH_RESET, FALSE);
  53 }
  54
  55 /**
  56   * @brief  enable or disable access to the battery powered domain.
  57   * @param  new_state: new state of battery powered domain access.
  58   *         this parameter can be: TRUE or FALSE.
  59   * @retval none
  60   */
  61 void pwc_battery_powered_domain_access(confirm_state new_state)
  62 {
  63   PWC->ctrl_bit.bpwen= new_state;
  64 }
  65
  66 /**
  67   * @brief  select the voltage threshold detected by the power voltage detector.
  68   * @param  pvm_voltage: select pwc pvm voltage
  69   *         this parameter can be one of the following values:
  70   *         - PWC_PVM_VOLTAGE_2V3
  71   *         - PWC_PVM_VOLTAGE_2V4
  72   *         - PWC_PVM_VOLTAGE_2V5
  73   *         - PWC_PVM_VOLTAGE_2V6
  74   *         - PWC_PVM_VOLTAGE_2V7
  75   *         - PWC_PVM_VOLTAGE_2V8
  76   *         - PWC_PVM_VOLTAGE_2V9
  77   * @retval none
  78   */
  79 void pwc_pvm_level_select(pwc_pvm_voltage_type pvm_voltage)
  80 {
  81   PWC->ctrl_bit.pvmsel= pvm_voltage;
  82 }
  83
  84 /**
  85   * @brief  enable or disable pwc power voltage monitor (pvm)
  86   * @param  new_state: new state of pvm.
  87   *         this parameter can be: TRUE or FALSE.
  88   * @retval none
  89   */
  90 void pwc_power_voltage_monitor_enable(confirm_state new_state)
  91 {
  92   PWC->ctrl_bit.pvmen= new_state;
  93 }
  94
  95 /**
  96   * @brief  enable or disable pwc standby wakeup pin
  97   * @param  pin_num: choose the wakeup pin.
  98   *         this parameter can be be any combination of the following values:
  99   *         - PWC_WAKEUP_PIN_1
 100   *         - PWC_WAKEUP_PIN_2
 101   * @param  new_state: new state of the standby wakeup pin.
 102   *         this parameter can be one of the following values:
 103   *         - TRUE <wakeup pin is used for wake up cpu from standby mode>
 104   *         - FALSE <wakeup pin is used for general purpose I/O>
 105   * @retval none
 106   */
 107 void pwc_wakeup_pin_enable(uint32_t pin_num, confirm_state new_state)
 108 {
 109   if(new_state == TRUE)
 110   {
 111     PWC->ctrlsts |= pin_num;
 112   }
 113   else
 114   {
 115     PWC->ctrlsts &= ~pin_num;
 116   }
 117 }
 118
 119 /**
 120   * @brief  clear flag of pwc
 121   * @param  pwc_flag: select the pwc flag.
 122   *         this parameter can be any combination of the following values:
 123   *         - PWC_WAKEUP_FLAG
 124   *         - PWC_STANDBY_FLAG
 125   *         - note:"PWC_PVM_OUTPUT_FLAG" cannot be choose!this bit is readonly bit,it means the voltage monitoring output state
 126   * @retval none
 127   */
 128 void pwc_flag_clear(uint32_t pwc_flag)
 129 {
 130   if(pwc_flag & PWC_STANDBY_FLAG)
 131     PWC->ctrl_bit.clsef = TRUE;
 132   if(pwc_flag & PWC_WAKEUP_FLAG)
 133     PWC->ctrl_bit.clswef = TRUE;
 134 }
 135
 136 /**
 137   * @brief  get flag of pwc
 138   * @param  pwc_flag: select the pwc flag.
 139   *         this parameter can be one of the following values:
 140   *         - PWC_WAKEUP_FLAG
 141   *         - PWC_STANDBY_FLAG
 142   *         - PWC_PVM_OUTPUT_FLAG
 143   * @retval state of select flag(SET or RESET).
 144   */
 145 flag_status pwc_flag_get(uint32_t pwc_flag)
 146 {
 147   flag_status status = RESET;
 148   if ((PWC->ctrlsts & pwc_flag) == RESET)
 149   {
 150     status = RESET;
 151   }
 152   else
 153   {
 154     status = SET;
 155   }
 156   return status;
 157 }
 158
 159 /**
 160   * @brief  enter pwc sleep mode
 161   * @param  sleep_mode_enter: choose the instruction to enter sleep mode.
 162   *         this parameter can be one of the following values:
 163   *         - PWC_SLEEP_ENTER_WFI
 164   *         - PWC_SLEEP_ENTER_WFE
 165   * @retval none
 166   */
 167 void pwc_sleep_mode_enter(pwc_sleep_enter_type pwc_sleep_enter)
 168 {
 169   SCB->SCR &= (uint32_t)~0x4;
 170   if(pwc_sleep_enter == PWC_SLEEP_ENTER_WFE)
 171   {
 172     __SEV();
 173     __WFE();
 174     __WFE();
 175   }
 176   else if(pwc_sleep_enter == PWC_SLEEP_ENTER_WFI)
 177   {
 178     __WFI();
 179   }
 180 }
 181
 182 /**
 183   * @brief  enter pwc deep-sleep mode
 184   * @param  pwc_deep_sleep_enter: choose the instruction to enter deep sleep mode.
 185   *         this parameter can be one of the following values:
 186   *         - PWC_DEEP_SLEEP_ENTER_WFI
 187   *         - PWC_DEEP_SLEEP_ENTER_WFE
 188   * @retval none
 189   */
 190 void pwc_deep_sleep_mode_enter(pwc_deep_sleep_enter_type pwc_deep_sleep_enter)
 191 {
 192   SCB->SCR |= 0x04;
 193   if(pwc_deep_sleep_enter == PWC_DEEP_SLEEP_ENTER_WFE)
 194   {
 195     __SEV();
 196     __WFE();
 197     __WFE();
 198   }
 199   else if(pwc_deep_sleep_enter == PWC_DEEP_SLEEP_ENTER_WFI)
 200   {
 201     __WFI();
 202   }
 203   SCB->SCR &= (uint32_t)~0x4;
 204 }
 205
 206 /**
 207   * @brief  regulate low power consumption in the deep sleep mode
 208   * @param  pwc_regulator: set the regulator state.
 209   *         this parameter can be one of the following values:
 210   *         - PWC_REGULATOR_ON
 211   *         - PWC_REGULATOR_LOW_POWER
 212   * @retval none
 213   */
 214 void pwc_voltage_regulate_set(pwc_regulator_type pwc_regulator)
 215 {
 216   PWC->ctrl_bit.vrsel = pwc_regulator;
 217 }
 218
 219 /**
 220   * @brief  enter pwc standby mode
 221   * @param  none
 222   * @retval none
 223   */
 224 void pwc_standby_mode_enter(void)
 225 {
 226   PWC->ctrl_bit.clswef = TRUE;
 227   PWC->ctrl_bit.lpsel = TRUE;
 228   SCB->SCR |= 0x04;
 229 #if defined (__CC_ARM)
 230   __force_stores();
 231 #endif
 232   while(1)
 233   {
 234     __WFI();
 235   }
 236 }
 237
 238 /**
 239   * @}
 240   */
 241
 242 #endif
 243
 244 /**
 245   * @}
 246   */
 247
 248 /**
 249   * @}
 250   */