1 /*! 2 \file gd32vf103_bkp.h 3 \brief definitions for the BKP 4 5 \version 2019-06-05, V1.0.0, firmware for GD32VF103 6 \version 2020-08-04, V1.1.0, firmware for GD32VF103 7 */ 8 9 /* 10 Copyright (c) 2020, GigaDevice Semiconductor Inc. 11 12 Redistribution and use in source and binary forms, with or without modification, 13 are permitted provided that the following conditions are met: 14 15 1. Redistributions of source code must retain the above copyright notice, this 16 list of conditions and the following disclaimer. 17 2. Redistributions in binary form must reproduce the above copyright notice, 18 this list of conditions and the following disclaimer in the documentation 19 and/or other materials provided with the distribution. 20 3. Neither the name of the copyright holder nor the names of its contributors 21 may be used to endorse or promote products derived from this software without 22 specific prior written permission. 23 24 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 25 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 26 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 27 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 28 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 29 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 30 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 31 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 32 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 33 OF SUCH DAMAGE. 34 */ 35 36 #ifndef GD32VF103_BKP_H 37 #define GD32VF103_BKP_H 38 39 #include "gd32vf103.h" 40 41 /* BKP definitions */ 42 #define BKP BKP_BASE /*!< BKP base address */ 43 44 /* registers definitions */ 45 #define BKP_DATA0 REG16((BKP) + 0x04U) /*!< BKP data register 0 */ 46 #define BKP_DATA1 REG16((BKP) + 0x08U) /*!< BKP data register 1 */ 47 #define BKP_DATA2 REG16((BKP) + 0x0CU) /*!< BKP data register 2 */ 48 #define BKP_DATA3 REG16((BKP) + 0x10U) /*!< BKP data register 3 */ 49 #define BKP_DATA4 REG16((BKP) + 0x14U) /*!< BKP data register 4 */ 50 #define BKP_DATA5 REG16((BKP) + 0x18U) /*!< BKP data register 5 */ 51 #define BKP_DATA6 REG16((BKP) + 0x1CU) /*!< BKP data register 6 */ 52 #define BKP_DATA7 REG16((BKP) + 0x20U) /*!< BKP data register 7 */ 53 #define BKP_DATA8 REG16((BKP) + 0x24U) /*!< BKP data register 8 */ 54 #define BKP_DATA9 REG16((BKP) + 0x28U) /*!< BKP data register 9 */ 55 #define BKP_DATA10 REG16((BKP) + 0x40U) /*!< BKP data register 10 */ 56 #define BKP_DATA11 REG16((BKP) + 0x44U) /*!< BKP data register 11 */ 57 #define BKP_DATA12 REG16((BKP) + 0x48U) /*!< BKP data register 12 */ 58 #define BKP_DATA13 REG16((BKP) + 0x4CU) /*!< BKP data register 13 */ 59 #define BKP_DATA14 REG16((BKP) + 0x50U) /*!< BKP data register 14 */ 60 #define BKP_DATA15 REG16((BKP) + 0x54U) /*!< BKP data register 15 */ 61 #define BKP_DATA16 REG16((BKP) + 0x58U) /*!< BKP data register 16 */ 62 #define BKP_DATA17 REG16((BKP) + 0x5CU) /*!< BKP data register 17 */ 63 #define BKP_DATA18 REG16((BKP) + 0x60U) /*!< BKP data register 18 */ 64 #define BKP_DATA19 REG16((BKP) + 0x64U) /*!< BKP data register 19 */ 65 #define BKP_DATA20 REG16((BKP) + 0x68U) /*!< BKP data register 20 */ 66 #define BKP_DATA21 REG16((BKP) + 0x6CU) /*!< BKP data register 21 */ 67 #define BKP_DATA22 REG16((BKP) + 0x70U) /*!< BKP data register 22 */ 68 #define BKP_DATA23 REG16((BKP) + 0x74U) /*!< BKP data register 23 */ 69 #define BKP_DATA24 REG16((BKP) + 0x78U) /*!< BKP data register 24 */ 70 #define BKP_DATA25 REG16((BKP) + 0x7CU) /*!< BKP data register 25 */ 71 #define BKP_DATA26 REG16((BKP) + 0x80U) /*!< BKP data register 26 */ 72 #define BKP_DATA27 REG16((BKP) + 0x84U) /*!< BKP data register 27 */ 73 #define BKP_DATA28 REG16((BKP) + 0x88U) /*!< BKP data register 28 */ 74 #define BKP_DATA29 REG16((BKP) + 0x8CU) /*!< BKP data register 29 */ 75 #define BKP_DATA30 REG16((BKP) + 0x90U) /*!< BKP data register 30 */ 76 #define BKP_DATA31 REG16((BKP) + 0x94U) /*!< BKP data register 31 */ 77 #define BKP_DATA32 REG16((BKP) + 0x98U) /*!< BKP data register 32 */ 78 #define BKP_DATA33 REG16((BKP) + 0x9CU) /*!< BKP data register 33 */ 79 #define BKP_DATA34 REG16((BKP) + 0xA0U) /*!< BKP data register 34 */ 80 #define BKP_DATA35 REG16((BKP) + 0xA4U) /*!< BKP data register 35 */ 81 #define BKP_DATA36 REG16((BKP) + 0xA8U) /*!< BKP data register 36 */ 82 #define BKP_DATA37 REG16((BKP) + 0xACU) /*!< BKP data register 37 */ 83 #define BKP_DATA38 REG16((BKP) + 0xB0U) /*!< BKP data register 38 */ 84 #define BKP_DATA39 REG16((BKP) + 0xB4U) /*!< BKP data register 39 */ 85 #define BKP_DATA40 REG16((BKP) + 0xB8U) /*!< BKP data register 40 */ 86 #define BKP_DATA41 REG16((BKP) + 0xBCU) /*!< BKP data register 41 */ 87 #define BKP_OCTL REG16((BKP) + 0x2CU) /*!< RTC signal output control register */ 88 #define BKP_TPCTL REG16((BKP) + 0x30U) /*!< tamper pin control register */ 89 #define BKP_TPCS REG16((BKP) + 0x34U) /*!< tamper control and status register */ 90 91 /* bits definitions */ 92 /* BKP_DATA */ 93 #define BKP_DATA BITS(0,15) /*!< backup data */ 94 95 /* BKP_OCTL */ 96 #define BKP_OCTL_RCCV BITS(0,6) /*!< RTC clock calibration value */ 97 #define BKP_OCTL_COEN BIT(7) /*!< RTC clock calibration output enable */ 98 #define BKP_OCTL_ASOEN BIT(8) /*!< RTC alarm or second signal output enable */ 99 #define BKP_OCTL_ROSEL BIT(9) /*!< RTC output selection */ 100 101 /* BKP_TPCTL */ 102 #define BKP_TPCTL_TPEN BIT(0) /*!< tamper detection enable */ 103 #define BKP_TPCTL_TPAL BIT(1) /*!< tamper pin active level */ 104 105 /* BKP_TPCS */ 106 #define BKP_TPCS_TER BIT(0) /*!< tamper event reset */ 107 #define BKP_TPCS_TIR BIT(1) /*!< tamper interrupt reset */ 108 #define BKP_TPCS_TPIE BIT(2) /*!< tamper interrupt enable */ 109 #define BKP_TPCS_TEF BIT(8) /*!< tamper event flag */ 110 #define BKP_TPCS_TIF BIT(9) /*!< tamper interrupt flag */ 111 112 /* constants definitions */ 113 /* BKP data register number */ 114 typedef enum 115 { 116 BKP_DATA_0 = 1, /*!< BKP data register 0 */ 117 BKP_DATA_1, /*!< BKP data register 1 */ 118 BKP_DATA_2, /*!< BKP data register 2 */ 119 BKP_DATA_3, /*!< BKP data register 3 */ 120 BKP_DATA_4, /*!< BKP data register 4 */ 121 BKP_DATA_5, /*!< BKP data register 5 */ 122 BKP_DATA_6, /*!< BKP data register 6 */ 123 BKP_DATA_7, /*!< BKP data register 7 */ 124 BKP_DATA_8, /*!< BKP data register 8 */ 125 BKP_DATA_9, /*!< BKP data register 9 */ 126 BKP_DATA_10, /*!< BKP data register 10 */ 127 BKP_DATA_11, /*!< BKP data register 11 */ 128 BKP_DATA_12, /*!< BKP data register 12 */ 129 BKP_DATA_13, /*!< BKP data register 13 */ 130 BKP_DATA_14, /*!< BKP data register 14 */ 131 BKP_DATA_15, /*!< BKP data register 15 */ 132 BKP_DATA_16, /*!< BKP data register 16 */ 133 BKP_DATA_17, /*!< BKP data register 17 */ 134 BKP_DATA_18, /*!< BKP data register 18 */ 135 BKP_DATA_19, /*!< BKP data register 19 */ 136 BKP_DATA_20, /*!< BKP data register 20 */ 137 BKP_DATA_21, /*!< BKP data register 21 */ 138 BKP_DATA_22, /*!< BKP data register 22 */ 139 BKP_DATA_23, /*!< BKP data register 23 */ 140 BKP_DATA_24, /*!< BKP data register 24 */ 141 BKP_DATA_25, /*!< BKP data register 25 */ 142 BKP_DATA_26, /*!< BKP data register 26 */ 143 BKP_DATA_27, /*!< BKP data register 27 */ 144 BKP_DATA_28, /*!< BKP data register 28 */ 145 BKP_DATA_29, /*!< BKP data register 29 */ 146 BKP_DATA_30, /*!< BKP data register 30 */ 147 BKP_DATA_31, /*!< BKP data register 31 */ 148 BKP_DATA_32, /*!< BKP data register 32 */ 149 BKP_DATA_33, /*!< BKP data register 33 */ 150 BKP_DATA_34, /*!< BKP data register 34 */ 151 BKP_DATA_35, /*!< BKP data register 35 */ 152 BKP_DATA_36, /*!< BKP data register 36 */ 153 BKP_DATA_37, /*!< BKP data register 37 */ 154 BKP_DATA_38, /*!< BKP data register 38 */ 155 BKP_DATA_39, /*!< BKP data register 39 */ 156 BKP_DATA_40, /*!< BKP data register 40 */ 157 BKP_DATA_41, /*!< BKP data register 41 */ 158 }bkp_data_register_enum; 159 160 /* BKP register */ 161 #define BKP_DATA0_9(number) REG16((BKP) + 0x04U + (number) * 0x04U) 162 #define BKP_DATA10_41(number) REG16((BKP) + 0x40U + ((number)-10U) * 0x04U) 163 164 /* get data of BKP data register */ 165 #define BKP_DATA_GET(regval) GET_BITS((uint32_t)(regval), 0, 15) 166 167 /* RTC clock calibration value */ 168 #define OCTL_RCCV(regval) (BITS(0,6) & ((uint32_t)(regval) << 0)) 169 170 /* RTC output selection */ 171 #define RTC_OUTPUT_ALARM_PULSE ((uint16_t)0x0000U) /*!< RTC alarm pulse is selected as the RTC output */ 172 #define RTC_OUTPUT_SECOND_PULSE ((uint16_t)0x0200U) /*!< RTC second pulse is selected as the RTC output */ 173 174 /* tamper pin active level */ 175 #define TAMPER_PIN_ACTIVE_HIGH ((uint16_t)0x0000U) /*!< the tamper pin is active high */ 176 #define TAMPER_PIN_ACTIVE_LOW ((uint16_t)0x0002U) /*!< the tamper pin is active low */ 177 178 /* tamper flag */ 179 #define BKP_FLAG_TAMPER BKP_TPCS_TEF /*!< tamper event flag */ 180 181 /* tamper interrupt flag */ 182 #define BKP_INT_FLAG_TAMPER BKP_TPCS_TIF /*!< tamper interrupt flag */ 183 184 /* function declarations */ 185 /* reset BKP registers */ 186 void bkp_deinit(void); 187 /* write BKP data register */ 188 void bkp_data_write(bkp_data_register_enum register_number, uint16_t data); 189 /* read BKP data register */ 190 uint16_t bkp_data_read(bkp_data_register_enum register_number); 191 192 /* RTC related functions */ 193 /* enable RTC clock calibration output */ 194 void bkp_rtc_calibration_output_enable(void); 195 /* disable RTC clock calibration output */ 196 void bkp_rtc_calibration_output_disable(void); 197 /* enable RTC alarm or second signal output */ 198 void bkp_rtc_signal_output_enable(void); 199 /* disable RTC alarm or second signal output */ 200 void bkp_rtc_signal_output_disable(void); 201 /* select RTC output */ 202 void bkp_rtc_output_select(uint16_t outputsel); 203 /* set RTC clock calibration value */ 204 void bkp_rtc_calibration_value_set(uint8_t value); 205 206 /* tamper pin related functions */ 207 /* enable tamper pin detection */ 208 void bkp_tamper_detection_enable(void); 209 /* disable tamper pin detection */ 210 void bkp_tamper_detection_disable(void); 211 /* set tamper pin active level */ 212 void bkp_tamper_active_level_set(uint16_t level); 213 214 /* interrupt & flag functions */ 215 /* enable tamper interrupt */ 216 void bkp_interrupt_enable(void); 217 /* disable tamper interrupt */ 218 void bkp_interrupt_disable(void); 219 /* get tamper flag state */ 220 FlagStatus bkp_flag_get(void); 221 /* clear tamper flag state */ 222 void bkp_flag_clear(void); 223 /* get tamper interrupt flag state */ 224 FlagStatus bkp_interrupt_flag_get(void); 225 /* clear tamper interrupt flag state */ 226 void bkp_interrupt_flag_clear(void); 227 228 #endif /* GD32VF103_BKP_H */ 229
