rtc.h

Go to the documentation of this file.

/**************************************************************************/
#ifndef __RTC_H__
#define __RTC_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
/*---------------------------------------------------------------------------------------------------------*/
/*  RTC Initial Keyword Constant Definitions                                                               */
/*---------------------------------------------------------------------------------------------------------*/
#define RTC_INIT_KEY            0xA5EB1357UL    
#define RTC_WRITE_KEY           0x0000A965UL    
/*---------------------------------------------------------------------------------------------------------*/
/*  RTC Time Attribute Constant Definitions                                                                */
/*---------------------------------------------------------------------------------------------------------*/
#define RTC_CLOCK_12            0               
#define RTC_CLOCK_24            1               
#define RTC_AM                  1               
#define RTC_PM                  2               
/*---------------------------------------------------------------------------------------------------------*/
/*  RTC Tick Period Constant Definitions                                                                   */
/*---------------------------------------------------------------------------------------------------------*/
#define RTC_TICK_1_SEC          0x0UL           
#define RTC_TICK_1_2_SEC        0x1UL           
#define RTC_TICK_1_4_SEC        0x2UL           
#define RTC_TICK_1_8_SEC        0x3UL           
#define RTC_TICK_1_16_SEC       0x4UL           
#define RTC_TICK_1_32_SEC       0x5UL           
#define RTC_TICK_1_64_SEC       0x6UL           
#define RTC_TICK_1_128_SEC      0x7UL           
/*---------------------------------------------------------------------------------------------------------*/
/*  RTC Day of Week Constant Definitions                                                                   */
/*---------------------------------------------------------------------------------------------------------*/
#define RTC_SUNDAY              0x0UL           
#define RTC_MONDAY              0x1UL           
#define RTC_TUESDAY             0x2UL           
#define RTC_WEDNESDAY           0x3UL           
#define RTC_THURSDAY            0x4UL           
#define RTC_FRIDAY              0x5UL           
#define RTC_SATURDAY            0x6UL           
/*---------------------------------------------------------------------------------------------------------*/
/*  RTC Snooper Detection Mode Constant Definitions                                                        */
/*---------------------------------------------------------------------------------------------------------*/
#define RTC_SNOOPER_LOW_LEVEL       0x0UL       
#define RTC_SNOOPER_HIGH_LEVEL      0x2UL       
#define RTC_SNOOPER_FALLING_EDGE    0x8UL       
#define RTC_SNOOPER_RISING_EDGE     0xAUL       
#define RTC_SNOOPER_DETECT_Msk      0xAUL       
/*---------------------------------------------------------------------------------------------------------*/
/*  RTC Miscellaneous Constant Definitions                                                                         */
/*---------------------------------------------------------------------------------------------------------*/
#define RTC_WAIT_COUNT          0xFFFFFFFF      
#define RTC_YEAR2000            2000            
#define RTC_FCR_REFERENCE       32761            /* end of group RTC_EXPORTED_CONSTANTS */
 
 
typedef struct
{
    uint32_t u32Year;           
    uint32_t u32Month;          
    uint32_t u32Day;            
    uint32_t u32DayOfWeek;      
    uint32_t u32Hour;           
    uint32_t u32Minute;         
    uint32_t u32Second;         
    uint32_t u32TimeScale;      
    uint32_t u32AmPm;           
} S_RTC_TIME_DATA_T;
 /* end of group RTC_EXPORTED_STRUCTS */
 
 
#define RTC_IS_LEAP_YEAR()              (RTC->LEAPYEAR & RTC_LEAPYEAR_LEAPYEAR_Msk ? 1:0)
 
#define RTC_CLEAR_ALARM_INT_FLAG()      (RTC->INTSTS = (RTC->INTSTS & ~(RTC_INTSTS_TICKIF_Msk | RTC_INTSTS_SNPDIF_Msk)) | RTC_INTSTS_ALMIF_Msk)
 
#define RTC_CLEAR_TICK_INT_FLAG()       (RTC->INTSTS = (RTC->INTSTS & ~(RTC_INTSTS_ALMIF_Msk | RTC_INTSTS_SNPDIF_Msk)) | RTC_INTSTS_TICKIF_Msk)
 
#define RTC_CLEAR_SNOOPER_INT_FLAG()    (RTC->INTSTS = (RTC->INTSTS & ~(RTC_INTSTS_ALMIF_Msk | RTC_INTSTS_TICKIF_Msk)) | RTC_INTSTS_SNPDIF_Msk)
 
#define RTC_GET_ALARM_INT_FLAG()        ((RTC->INTSTS & RTC_INTSTS_ALMIF_Msk)? 1:0)
 
#define RTC_GET_TICK_INT_FLAG()         ((RTC->INTSTS & RTC_INTSTS_TICKIF_Msk)? 1:0)
 
#define RTC_GET_SNPPOER_INT_FLAG()      ((RTC->INTSTS & RTC_INTSTS_SNPDIF_Msk)? 1:0)
 
#define RTC_READ_SPARE_REGISTER(u32RegNum)                  (RTC->SPR[(u32RegNum)])
 
#define RTC_WRITE_SPARE_REGISTER(u32RegNum, u32RegValue)    (RTC->SPR[(u32RegNum)] = (u32RegValue))
 
static __INLINE void RTC_WaitAccessEnable(void)
{
    uint32_t u32TimeOutCount = SystemCoreClock; // 1 second timeout
    uint32_t i = 0;
 
    /* To wait RWENF bit is cleared and enable RWENF bit (Access Enable bit) again */
    while((RTC->RWEN & RTC_RWEN_RWENF_Msk) == RTC_RWEN_RWENF_Msk)
    {
        i++;
        if(i > u32TimeOutCount) break;
    }
 
    RTC->RWEN = RTC_WRITE_KEY;
 
    i = 0;
    /* To wait RWENF bit is set and user can access the protected-register of RTC from now on */
    while((RTC->RWEN & RTC_RWEN_RWENF_Msk) == 0x0)
    {
        i++;
        if(i > u32TimeOutCount) break;
    }
}
 
int32_t RTC_Open(S_RTC_TIME_DATA_T *sPt);
void RTC_Close(void);
void RTC_32KCalibration(int32_t i32FrequencyX100);
void RTC_GetDateAndTime(S_RTC_TIME_DATA_T *sPt);
void RTC_GetAlarmDateAndTime(S_RTC_TIME_DATA_T *sPt);
void RTC_SetDateAndTime(S_RTC_TIME_DATA_T *sPt);
void RTC_SetAlarmDateAndTime(S_RTC_TIME_DATA_T *sPt);
void RTC_SetDate(uint32_t u32Year, uint32_t u32Month, uint32_t u32Day, uint32_t u32DayOfWeek);
void RTC_SetTime(uint32_t u32Hour, uint32_t u32Minute, uint32_t u32Second, uint32_t u32TimeMode, uint32_t u32AmPm);
void RTC_SetAlarmDate(uint32_t u32Year, uint32_t u32Month, uint32_t u32Day);
void RTC_SetAlarmTime(uint32_t u32Hour, uint32_t u32Minute, uint32_t u32Second, uint32_t u32TimeMode, uint32_t u32AmPm);
uint32_t RTC_GetDayOfWeek(void);
void RTC_SetTickPeriod(uint32_t u32TickSelection);
void RTC_EnableInt(uint32_t u32IntFlagMask);
void RTC_DisableInt(uint32_t u32IntFlagMask);
void RTC_EnableSpareAccess(void);
void RTC_DisableSpareRegister(void);
void RTC_EnableSnooperDetection(uint32_t u32PinCondition);
void RTC_DisableSnooperDetection(void);
 /* end of group RTC_EXPORTED_FUNCTIONS */
 /* end of group RTC_Driver */
 /* end of group Standard_Driver */
 
#ifdef __cplusplus
}
#endif
 
#endif //__RTC_H__