M471M/R1/S BSP V3.01.000
The Board Support Package for M4521
rtc.h
Go to the documentation of this file.
1/**************************************************************************/
8#ifndef __RTC_H__
9#define __RTC_H__
10
11#ifdef __cplusplus
12extern "C"
13{
14#endif
15
16
28/*---------------------------------------------------------------------------------------------------------*/
29/* RTC Initial Keyword Constant Definitions */
30/*---------------------------------------------------------------------------------------------------------*/
31#define RTC_INIT_KEY 0xA5EB1357UL
32#define RTC_WRITE_KEY 0x0000A965UL
34/*---------------------------------------------------------------------------------------------------------*/
35/* RTC Time Attribute Constant Definitions */
36/*---------------------------------------------------------------------------------------------------------*/
37#define RTC_CLOCK_12 0
38#define RTC_CLOCK_24 1
39#define RTC_AM 1
40#define RTC_PM 2
42/*---------------------------------------------------------------------------------------------------------*/
43/* RTC Tick Period Constant Definitions */
44/*---------------------------------------------------------------------------------------------------------*/
45#define RTC_TICK_1_SEC 0x0UL
46#define RTC_TICK_1_2_SEC 0x1UL
47#define RTC_TICK_1_4_SEC 0x2UL
48#define RTC_TICK_1_8_SEC 0x3UL
49#define RTC_TICK_1_16_SEC 0x4UL
50#define RTC_TICK_1_32_SEC 0x5UL
51#define RTC_TICK_1_64_SEC 0x6UL
52#define RTC_TICK_1_128_SEC 0x7UL
54/*---------------------------------------------------------------------------------------------------------*/
55/* RTC Day of Week Constant Definitions */
56/*---------------------------------------------------------------------------------------------------------*/
57#define RTC_SUNDAY 0x0UL
58#define RTC_MONDAY 0x1UL
59#define RTC_TUESDAY 0x2UL
60#define RTC_WEDNESDAY 0x3UL
61#define RTC_THURSDAY 0x4UL
62#define RTC_FRIDAY 0x5UL
63#define RTC_SATURDAY 0x6UL
65/*---------------------------------------------------------------------------------------------------------*/
66/* RTC Snooper Detection Mode Constant Definitions */
67/*---------------------------------------------------------------------------------------------------------*/
68#define RTC_SNOOPER_LOW_LEVEL 0x0UL
69#define RTC_SNOOPER_HIGH_LEVEL 0x2UL
70#define RTC_SNOOPER_FALLING_EDGE 0x8UL
71#define RTC_SNOOPER_RISING_EDGE 0xAUL
72#define RTC_SNOOPER_DETECT_Msk 0xAUL
74/*---------------------------------------------------------------------------------------------------------*/
75/* RTC Miscellaneous Constant Definitions */
76/*---------------------------------------------------------------------------------------------------------*/
77#define RTC_WAIT_COUNT 0xFFFFFFFF
78#define RTC_YEAR2000 2000
79#define RTC_FCR_REFERENCE 32761 /* end of group RTC_EXPORTED_CONSTANTS */
82
83
90typedef struct
91{
92 uint32_t u32Year;
93 uint32_t u32Month;
94 uint32_t u32Day;
95 uint32_t u32DayOfWeek;
96 uint32_t u32Hour;
97 uint32_t u32Minute;
98 uint32_t u32Second;
99 uint32_t u32TimeScale;
100 uint32_t u32AmPm;
102 /* end of group RTC_EXPORTED_STRUCTS */
104
105
120#define RTC_IS_LEAP_YEAR() (RTC->LEAPYEAR & RTC_LEAPYEAR_LEAPYEAR_Msk ? 1:0)
121
131#define RTC_CLEAR_ALARM_INT_FLAG() (RTC->INTSTS = (RTC->INTSTS & ~(RTC_INTSTS_TICKIF_Msk | RTC_INTSTS_SNPDIF_Msk)) | RTC_INTSTS_ALMIF_Msk)
132
142#define RTC_CLEAR_TICK_INT_FLAG() (RTC->INTSTS = (RTC->INTSTS & ~(RTC_INTSTS_ALMIF_Msk | RTC_INTSTS_SNPDIF_Msk)) | RTC_INTSTS_TICKIF_Msk)
143
153#define RTC_CLEAR_SNOOPER_INT_FLAG() (RTC->INTSTS = (RTC->INTSTS & ~(RTC_INTSTS_ALMIF_Msk | RTC_INTSTS_TICKIF_Msk)) | RTC_INTSTS_SNPDIF_Msk)
154
165#define RTC_GET_ALARM_INT_FLAG() ((RTC->INTSTS & RTC_INTSTS_ALMIF_Msk)? 1:0)
166
177#define RTC_GET_TICK_INT_FLAG() ((RTC->INTSTS & RTC_INTSTS_TICKIF_Msk)? 1:0)
178
189#define RTC_GET_SNPPOER_INT_FLAG() ((RTC->INTSTS & RTC_INTSTS_SNPDIF_Msk)? 1:0)
190
202#define RTC_READ_SPARE_REGISTER(u32RegNum) (RTC->SPR[(u32RegNum)])
203
216#define RTC_WRITE_SPARE_REGISTER(u32RegNum, u32RegValue) (RTC->SPR[(u32RegNum)] = (u32RegValue))
217
228static __INLINE int32_t RTC_WaitAccessEnable(void)
229{
230 int32_t i32TimeoutCnt = SystemCoreClock; // total 1 second timeout
231 /* To wait RWENF bit is cleared and enable RWENF bit (Access Enable bit) again */
232 while(((RTC->RWEN & RTC_RWEN_RWENF_Msk) == RTC_RWEN_RWENF_Msk) && (i32TimeoutCnt-- > 0));
233 RTC->RWEN = RTC_WRITE_KEY;
234
235 /* To wait RWENF bit is set and user can access the protected-register of RTC from now on */
236 while(((RTC->RWEN & RTC_RWEN_RWENF_Msk) == 0x0) && (i32TimeoutCnt-- > 0));
237
238 if(i32TimeoutCnt == 0)
239 return 0;
240 else
241 return 1;
242}
243
244int32_t RTC_Open(S_RTC_TIME_DATA_T *sPt);
245void RTC_Close(void);
246void RTC_32KCalibration(int32_t i32FrequencyX100);
251void RTC_SetDate(uint32_t u32Year, uint32_t u32Month, uint32_t u32Day, uint32_t u32DayOfWeek);
252void RTC_SetTime(uint32_t u32Hour, uint32_t u32Minute, uint32_t u32Second, uint32_t u32TimeMode, uint32_t u32AmPm);
253void RTC_SetAlarmDate(uint32_t u32Year, uint32_t u32Month, uint32_t u32Day);
254void RTC_SetAlarmTime(uint32_t u32Hour, uint32_t u32Minute, uint32_t u32Second, uint32_t u32TimeMode, uint32_t u32AmPm);
255uint32_t RTC_GetDayOfWeek(void);
256void RTC_SetTickPeriod(uint32_t u32TickSelection);
257void RTC_EnableInt(uint32_t u32IntFlagMask);
258void RTC_DisableInt(uint32_t u32IntFlagMask);
259void RTC_EnableSpareAccess(void);
260void RTC_DisableSpareRegister(void);
261void RTC_EnableSnooperDetection(uint32_t u32PinCondition);
263 /* end of group RTC_EXPORTED_FUNCTIONS */
265 /* end of group RTC_Driver */
267 /* end of group Standard_Driver */
269
270#ifdef __cplusplus
271}
272#endif
273
274#endif //__RTC_H__
275
#define RTC_RWEN_RWENF_Msk
Definition: M471M_R1_S.h:7679
#define RTC
Definition: M471M_R1_S.h:13834
#define RTC_WRITE_KEY
Definition: rtc.h:32
void RTC_EnableInt(uint32_t u32IntFlagMask)
Enable RTC Interrupt.
Definition: rtc.c:685
void RTC_DisableSnooperDetection(void)
Disable Snooper Pin Detect.
Definition: rtc.c:786
uint32_t RTC_GetDayOfWeek(void)
Get Day of the Week.
Definition: rtc.c:643
void RTC_SetDateAndTime(S_RTC_TIME_DATA_T *sPt)
Update Current RTC Date and Time.
Definition: rtc.c:352
uint32_t u32Month
Definition: rtc.h:93
uint32_t u32AmPm
Definition: rtc.h:100
void RTC_GetAlarmDateAndTime(S_RTC_TIME_DATA_T *sPt)
Get RTC Alarm Date and Time.
Definition: rtc.c:252
void RTC_SetAlarmDateAndTime(S_RTC_TIME_DATA_T *sPt)
Update RTC Alarm Date and Time.
Definition: rtc.c:426
uint32_t u32Hour
Definition: rtc.h:96
void RTC_EnableSpareAccess(void)
Enable Spare Registers Access.
Definition: rtc.c:732
int32_t RTC_Open(S_RTC_TIME_DATA_T *sPt)
Initialize RTC module and start counting.
Definition: rtc.c:66
static __INLINE int32_t RTC_WaitAccessEnable(void)
Wait RTC Access Enable.
Definition: rtc.h:228
void RTC_SetDate(uint32_t u32Year, uint32_t u32Month, uint32_t u32Day, uint32_t u32DayOfWeek)
Update RTC Current Date.
Definition: rtc.c:491
void RTC_Close(void)
Disable RTC Clock.
Definition: rtc.c:107
void RTC_32KCalibration(int32_t i32FrequencyX100)
Set 32k Frequency Compensation Data.
Definition: rtc.c:121
uint32_t u32Minute
Definition: rtc.h:97
void RTC_SetTime(uint32_t u32Hour, uint32_t u32Minute, uint32_t u32Second, uint32_t u32TimeMode, uint32_t u32AmPm)
Update RTC Current Time.
Definition: rtc.c:524
uint32_t u32Day
Definition: rtc.h:94
uint32_t u32DayOfWeek
Definition: rtc.h:95
void RTC_SetAlarmTime(uint32_t u32Hour, uint32_t u32Minute, uint32_t u32Second, uint32_t u32TimeMode, uint32_t u32AmPm)
Update RTC Alarm Time.
Definition: rtc.c:596
void RTC_DisableInt(uint32_t u32IntFlagMask)
Disable RTC Interrupt.
Definition: rtc.c:702
uint32_t u32Year
Definition: rtc.h:92
void RTC_DisableSpareRegister(void)
Disable Spare Register.
Definition: rtc.c:750
void RTC_SetTickPeriod(uint32_t u32TickSelection)
Set RTC Tick Period Time.
Definition: rtc.c:666
void RTC_EnableSnooperDetection(uint32_t u32PinCondition)
Enable Snooper Pin Detect.
Definition: rtc.c:770
void RTC_SetAlarmDate(uint32_t u32Year, uint32_t u32Month, uint32_t u32Day)
Update RTC Alarm Date.
Definition: rtc.c:566
uint32_t u32Second
Definition: rtc.h:98
uint32_t u32TimeScale
Definition: rtc.h:99
void RTC_GetDateAndTime(S_RTC_TIME_DATA_T *sPt)
Get Current RTC Date and Time.
Definition: rtc.c:157
uint32_t SystemCoreClock