293 lines
7.6 KiB
C
293 lines
7.6 KiB
C
/*!
|
|
\file gd32vf103_bkp.c
|
|
\brief BKP driver
|
|
|
|
\version 2019-6-5, V1.0.0, firmware for GD32VF103
|
|
*/
|
|
|
|
/*
|
|
Copyright (c) 2019, GigaDevice Semiconductor Inc.
|
|
|
|
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 the copyright holder 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.
|
|
*/
|
|
|
|
#include "gd32vf103_bkp.h"
|
|
|
|
/* BKP register bits offset */
|
|
#define BKP_TAMPER_BITS_OFFSET ((uint32_t)8U)
|
|
|
|
/*!
|
|
\brief reset BKP registers
|
|
\param[in] none
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_deinit(void)
|
|
{
|
|
/* reset BKP domain register*/
|
|
rcu_bkp_reset_enable();
|
|
rcu_bkp_reset_disable();
|
|
}
|
|
|
|
/*!
|
|
\brief write BKP data register
|
|
\param[in] register_number: refer to bkp_data_register_enum
|
|
only one parameter can be selected which is shown as below:
|
|
\arg BKP_DATA_x(x = 0..41): bkp data register number x
|
|
\param[in] data: the data to be write in BKP data register
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_data_write(bkp_data_register_enum register_number, uint16_t data)
|
|
{
|
|
if((register_number >= BKP_DATA_10) && (register_number <= BKP_DATA_41)){
|
|
BKP_DATA10_41(register_number - 1U) = data;
|
|
}else if((register_number >= BKP_DATA_0) && (register_number <= BKP_DATA_9)){
|
|
BKP_DATA0_9(register_number - 1U) = data;
|
|
}else{
|
|
/* illegal parameters */
|
|
}
|
|
}
|
|
|
|
/*!
|
|
\brief read BKP data register
|
|
\param[in] register_number: refer to bkp_data_register_enum
|
|
only one parameter can be selected which is shown as below:
|
|
\arg BKP_DATA_x(x = 0..41): bkp data register number x
|
|
\param[out] none
|
|
\retval data of BKP data register
|
|
*/
|
|
uint16_t bkp_data_read(bkp_data_register_enum register_number)
|
|
{
|
|
uint16_t data = 0U;
|
|
|
|
/* get the data from the BKP data register */
|
|
if((register_number >= BKP_DATA_10) && (register_number <= BKP_DATA_41)){
|
|
data = BKP_DATA10_41(register_number - 1U);
|
|
}else if((register_number >= BKP_DATA_0) && (register_number <= BKP_DATA_9)){
|
|
data = BKP_DATA0_9(register_number - 1U);
|
|
}else{
|
|
/* illegal parameters */
|
|
}
|
|
return data;
|
|
}
|
|
|
|
/*!
|
|
\brief enable RTC clock calibration output
|
|
\param[in] none
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_rtc_calibration_output_enable(void)
|
|
{
|
|
BKP_OCTL |= (uint16_t)BKP_OCTL_COEN;
|
|
}
|
|
|
|
/*!
|
|
\brief disable RTC clock calibration output
|
|
\param[in] none
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_rtc_calibration_output_disable(void)
|
|
{
|
|
BKP_OCTL &= (uint16_t)~BKP_OCTL_COEN;
|
|
}
|
|
|
|
/*!
|
|
\brief enable RTC alarm or second signal output
|
|
\param[in] none
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_rtc_signal_output_enable(void)
|
|
{
|
|
BKP_OCTL |= (uint16_t)BKP_OCTL_ASOEN;
|
|
}
|
|
|
|
/*!
|
|
\brief disable RTC alarm or second signal output
|
|
\param[in] none
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_rtc_signal_output_disable(void)
|
|
{
|
|
BKP_OCTL &= (uint16_t)~BKP_OCTL_ASOEN;
|
|
}
|
|
|
|
/*!
|
|
\brief select RTC output
|
|
\param[in] outputsel: RTC output selection
|
|
only one parameter can be selected which is shown as below:
|
|
\arg RTC_OUTPUT_ALARM_PULSE: RTC alarm pulse is selected as the RTC output
|
|
\arg RTC_OUTPUT_SECOND_PULSE: RTC second pulse is selected as the RTC output
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_rtc_output_select(uint16_t outputsel)
|
|
{
|
|
uint16_t ctl = 0U;
|
|
|
|
/* configure BKP_OCTL_ROSEL with outputsel */
|
|
ctl = BKP_OCTL;
|
|
ctl &= (uint16_t)~BKP_OCTL_ROSEL;
|
|
ctl |= outputsel;
|
|
BKP_OCTL = ctl;
|
|
}
|
|
|
|
/*!
|
|
\brief set RTC clock calibration value
|
|
\param[in] value: RTC clock calibration value
|
|
\arg 0x00 - 0x7F
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_rtc_calibration_value_set(uint8_t value)
|
|
{
|
|
uint16_t ctl;
|
|
|
|
/* configure BKP_OCTL_RCCV with value */
|
|
ctl = BKP_OCTL;
|
|
ctl &= (uint16_t)~BKP_OCTL_RCCV;
|
|
ctl |= (uint16_t)OCTL_RCCV(value);
|
|
BKP_OCTL = ctl;
|
|
}
|
|
|
|
/*!
|
|
\brief enable tamper detection
|
|
\param[in] none
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_tamper_detection_enable(void)
|
|
{
|
|
BKP_TPCTL |= (uint16_t)BKP_TPCTL_TPEN;
|
|
}
|
|
|
|
/*!
|
|
\brief disable tamper detection
|
|
\param[in] none
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_tamper_detection_disable(void)
|
|
{
|
|
BKP_TPCTL &= (uint16_t)~BKP_TPCTL_TPEN;
|
|
}
|
|
|
|
/*!
|
|
\brief set tamper pin active level
|
|
\param[in] level: tamper active level
|
|
only one parameter can be selected which is shown as below:
|
|
\arg TAMPER_PIN_ACTIVE_HIGH: the tamper pin is active high
|
|
\arg TAMPER_PIN_ACTIVE_LOW: the tamper pin is active low
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_tamper_active_level_set(uint16_t level)
|
|
{
|
|
uint16_t ctl = 0U;
|
|
|
|
/* configure BKP_TPCTL_TPAL with level */
|
|
ctl = BKP_TPCTL;
|
|
ctl &= (uint16_t)~BKP_TPCTL_TPAL;
|
|
ctl |= level;
|
|
BKP_TPCTL = ctl;
|
|
}
|
|
|
|
/*!
|
|
\brief enable tamper interrupt
|
|
\param[in] none
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_interrupt_enable(void)
|
|
{
|
|
BKP_TPCS |= (uint16_t)BKP_TPCS_TPIE;
|
|
}
|
|
|
|
/*!
|
|
\brief disable tamper interrupt
|
|
\param[in] none
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_interrupt_disable(void)
|
|
{
|
|
BKP_TPCS &= (uint16_t)~BKP_TPCS_TPIE;
|
|
}
|
|
|
|
/*!
|
|
\brief get tamper flag state
|
|
\param[in] none
|
|
\param[out] none
|
|
\retval FlagStatus: SET or RESET
|
|
*/
|
|
FlagStatus bkp_flag_get(void)
|
|
{
|
|
if(RESET != (BKP_TPCS & BKP_FLAG_TAMPER)){
|
|
return SET;
|
|
}else{
|
|
return RESET;
|
|
}
|
|
}
|
|
|
|
/*!
|
|
\brief clear tamper flag state
|
|
\param[in] none
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_flag_clear(void)
|
|
{
|
|
BKP_TPCS |= (uint16_t)(BKP_FLAG_TAMPER >> BKP_TAMPER_BITS_OFFSET);
|
|
}
|
|
|
|
/*!
|
|
\brief get tamper interrupt flag state
|
|
\param[in] none
|
|
\param[out] none
|
|
\retval FlagStatus: SET or RESET
|
|
*/
|
|
FlagStatus bkp_interrupt_flag_get(void)
|
|
{
|
|
if(RESET != (BKP_TPCS & BKP_INT_FLAG_TAMPER)){
|
|
return SET;
|
|
}else{
|
|
return RESET;
|
|
}
|
|
}
|
|
|
|
/*!
|
|
\brief clear tamper interrupt flag state
|
|
\param[in] none
|
|
\param[out] none
|
|
\retval none
|
|
*/
|
|
void bkp_interrupt_flag_clear(void)
|
|
{
|
|
BKP_TPCS |= (uint16_t)(BKP_INT_FLAG_TAMPER >> BKP_TAMPER_BITS_OFFSET);
|
|
}
|