1 /**
2 ******************************************************************************
3 * @file    HAL_bkp.h
4 * @author  AE Team
5 * @version V1.1.0
6 * @date    28/08/2019
7 * @brief   This file contains all the functions prototypes for the BKP firmware
8 *          library.
9 ******************************************************************************
10 * @copy
11 *
12 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
13 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
14 * TIME. AS A RESULT, MindMotion SHALL NOT BE HELD LIABLE FOR ANY
15 * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
16 * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
17 * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
18 *
19 * <h2><center>&copy; COPYRIGHT 2019 MindMotion</center></h2>
20 */
21 
22 /* Define to prevent recursive inclusion -------------------------------------*/
23 #ifndef __HAL_BKP_H
24 #define __HAL_BKP_H
25 
26 /* Includes ------------------------------------------------------------------*/
27 #include "HAL_device.h"
28 
29 /** @addtogroup StdPeriph_Driver
30 * @{
31 */
32 
33 /** @addtogroup BKP
34 * @{
35 */
36 
37 /** @defgroup BKP_Exported_Types
38 * @{
39 */
40 
41 /**
42 * @}
43 */
44 
45 /** @defgroup BKP_Exported_Constants
46 * @{
47 */
48 
49 /** @defgroup Tamper_Pin_active_level
50 * @{
51 */
52 
53 #define BKP_TamperPinLevel_High           ((uint16_t)0x0000)
54 #define BKP_TamperPinLevel_Low            ((uint16_t)0x0001)
55 #define IS_BKP_TAMPER_PIN_LEVEL(LEVEL) (((LEVEL) == BKP_TamperPinLevel_High) || \
56                                         ((LEVEL) == BKP_TamperPinLevel_Low))
57 /**
58 * @}
59 */
60 
61 /** @defgroup RTC_output_source_to_output_on_the_Tamper_pin
62 * @{
63 */
64 
65 #define BKP_RTCOutputSource_None          ((uint16_t)0x0000)
66 #define BKP_RTCOutputSource_CalibClock    ((uint16_t)0x0080)
67 #define BKP_RTCOutputSource_Alarm         ((uint16_t)0x0100)
68 #define BKP_RTCOutputSource_Second        ((uint16_t)0x0300)
69 #define IS_BKP_RTC_OUTPUT_SOURCE(SOURCE) (((SOURCE) == BKP_RTCOutputSource_None) || \
70         ((SOURCE) == BKP_RTCOutputSource_CalibClock) || \
71         ((SOURCE) == BKP_RTCOutputSource_Alarm) || \
72         ((SOURCE) == BKP_RTCOutputSource_Second))
73 /**
74 * @}
75 */
76 
77 /** @defgroup Data_Backup_Register
78 * @{
79 */
80 
81 #define BKP_DR1                           ((uint16_t)0x0004)
82 #define BKP_DR2                           ((uint16_t)0x0008)
83 #define BKP_DR3                           ((uint16_t)0x000C)
84 #define BKP_DR4                           ((uint16_t)0x0010)
85 #define BKP_DR5                           ((uint16_t)0x0014)
86 #define BKP_DR6                           ((uint16_t)0x0018)
87 #define BKP_DR7                           ((uint16_t)0x001C)
88 #define BKP_DR8                           ((uint16_t)0x0020)
89 #define BKP_DR9                           ((uint16_t)0x0024)
90 #define BKP_DR10                          ((uint16_t)0x0028)
91 #define BKP_DR11                          ((uint16_t)0x0040)
92 #define BKP_DR12                          ((uint16_t)0x0044)
93 #define BKP_DR13                          ((uint16_t)0x0048)
94 #define BKP_DR14                          ((uint16_t)0x004C)
95 #define BKP_DR15                          ((uint16_t)0x0050)
96 #define BKP_DR16                          ((uint16_t)0x0054)
97 #define BKP_DR17                          ((uint16_t)0x0058)
98 #define BKP_DR18                          ((uint16_t)0x005C)
99 #define BKP_DR19                          ((uint16_t)0x0060)
100 #define BKP_DR20                          ((uint16_t)0x0064)
101 #define BKP_DR21                          ((uint16_t)0x0068)
102 #define BKP_DR22                          ((uint16_t)0x006C)
103 #define BKP_DR23                          ((uint16_t)0x0070)
104 #define BKP_DR24                          ((uint16_t)0x0074)
105 #define BKP_DR25                          ((uint16_t)0x0078)
106 #define BKP_DR26                          ((uint16_t)0x007C)
107 #define BKP_DR27                          ((uint16_t)0x0080)
108 #define BKP_DR28                          ((uint16_t)0x0084)
109 #define BKP_DR29                          ((uint16_t)0x0088)
110 #define BKP_DR30                          ((uint16_t)0x008C)
111 #define BKP_DR31                          ((uint16_t)0x0090)
112 #define BKP_DR32                          ((uint16_t)0x0094)
113 #define BKP_DR33                          ((uint16_t)0x0098)
114 #define BKP_DR34                          ((uint16_t)0x009C)
115 #define BKP_DR35                          ((uint16_t)0x00A0)
116 #define BKP_DR36                          ((uint16_t)0x00A4)
117 #define BKP_DR37                          ((uint16_t)0x00A8)
118 #define BKP_DR38                          ((uint16_t)0x00AC)
119 #define BKP_DR39                          ((uint16_t)0x00B0)
120 #define BKP_DR40                          ((uint16_t)0x00B4)
121 #define BKP_DR41                          ((uint16_t)0x00B8)
122 #define BKP_DR42                          ((uint16_t)0x00BC)
123 
124 #define IS_BKP_DR(DR) (((DR) == BKP_DR1)  || ((DR) == BKP_DR2)  || ((DR) == BKP_DR3)  || \
125                        ((DR) == BKP_DR4)  || ((DR) == BKP_DR5)  || ((DR) == BKP_DR6)  || \
126                        ((DR) == BKP_DR7)  || ((DR) == BKP_DR8)  || ((DR) == BKP_DR9)  || \
127                        ((DR) == BKP_DR10) || ((DR) == BKP_DR11) || ((DR) == BKP_DR12) || \
128                        ((DR) == BKP_DR13) || ((DR) == BKP_DR14) || ((DR) == BKP_DR15) || \
129                        ((DR) == BKP_DR16) || ((DR) == BKP_DR17) || ((DR) == BKP_DR18) || \
130                        ((DR) == BKP_DR19) || ((DR) == BKP_DR20) || ((DR) == BKP_DR21) || \
131                        ((DR) == BKP_DR22) || ((DR) == BKP_DR23) || ((DR) == BKP_DR24) || \
132                        ((DR) == BKP_DR25) || ((DR) == BKP_DR26) || ((DR) == BKP_DR27) || \
133                        ((DR) == BKP_DR28) || ((DR) == BKP_DR29) || ((DR) == BKP_DR30) || \
134                        ((DR) == BKP_DR31) || ((DR) == BKP_DR32) || ((DR) == BKP_DR33) || \
135                        ((DR) == BKP_DR34) || ((DR) == BKP_DR35) || ((DR) == BKP_DR36) || \
136                        ((DR) == BKP_DR37) || ((DR) == BKP_DR38) || ((DR) == BKP_DR39) || \
137                        ((DR) == BKP_DR40) || ((DR) == BKP_DR41) || ((DR) == BKP_DR42))
138 
139 #define IS_BKP_CALIBRATION_VALUE(VALUE) ((VALUE) <= 0x7F)
140 /**
141 * @}
142 */
143 
144 /**
145 * @}
146 */
147 
148 /** @defgroup BKP_Exported_Macros
149 * @{
150 */
151 
152 /**
153 * @}
154 */
155 
156 /** @defgroup BKP_Exported_Functions
157 * @{
158 */
159 
160 void BKP_DeInit(void);
161 void BKP_TamperPinLevelConfig(uint16_t BKP_TamperPinLevel);
162 void BKP_TamperPinCmd(FunctionalState NewState);
163 void BKP_ITConfig(FunctionalState NewState);
164 void BKP_RTCOutputConfig(uint16_t BKP_RTCOutputSource);
165 void BKP_SetRTCCalibrationValue(uint8_t CalibrationValue);
166 void BKP_WriteBackupRegister(uint16_t BKP_DR, uint16_t Data);
167 uint16_t BKP_ReadBackupRegister(uint16_t BKP_DR);
168 FlagStatus BKP_GetFlagStatus(void);
169 void BKP_ClearFlag(void);
170 ITStatus BKP_GetITStatus(void);
171 void BKP_ClearITPendingBit(void);
172 
173 #endif /* __HAL_BKP_H */
174 /**
175 * @}
176 */
177 
178 /**
179 * @}
180 */
181 
182 /**
183 * @}
184 */
185 
186 /*-------------------------(C) COPYRIGHT 2019 MindMotion ----------------------*/
187