/**************************************************************************//** * @file nu_rtc.h * @brief RTC driver header file * * SPDX-License-Identifier: Apache-2.0 * @copyright (C) 2020 Nuvoton Technology Corp. All rights reserved. *****************************************************************************/ #ifndef __NU_RTC_H__ #define __NU_RTC_H__ #ifdef __cplusplus extern "C" { #endif #include "NuMicro.h" #if defined(USE_MA35D1_SUBM) #define REG_RTC_TALM RTC->TALM_M #define REG_RTC_CALM RTC->CALM_M #define REG_RTC_INTEN RTC->INTEN_M #define REG_RTC_INTSTS RTC->INTSTS_M #define REG_RTC_TICK RTC->TICK_M #define REG_RTC_TAMSK RTC->TAMSK_M #define REG_RTC_CAMSK RTC->CAMSK_M #else #define REG_RTC_TALM RTC->TALM #define REG_RTC_CALM RTC->CALM #define REG_RTC_INTEN RTC->INTEN #define REG_RTC_INTSTS RTC->INTSTS #define REG_RTC_TICK RTC->TICK #define REG_RTC_TAMSK RTC->TAMSK #define REG_RTC_CAMSK RTC->CAMSK #endif /** @addtogroup Standard_Driver Standard Driver @{ */ /** @addtogroup RTC_Driver RTC Driver @{ */ /** @addtogroup RTC_EXPORTED_CONSTANTS RTC Exported Constants @{ */ /*---------------------------------------------------------------------------------------------------------*/ /* RTC Initial Keyword Constant Definitions */ /*---------------------------------------------------------------------------------------------------------*/ #define RTC_INIT_KEY 0xA5EB1357UL /*!< RTC Initiation Key to make RTC leaving reset state \hideinitializer */ /*---------------------------------------------------------------------------------------------------------*/ /* RTC Time Attribute Constant Definitions */ /*---------------------------------------------------------------------------------------------------------*/ #define RTC_CLOCK_12 0UL /*!< RTC as 12-hour time scale with AM and PM indication \hideinitializer */ #define RTC_CLOCK_24 1UL /*!< RTC as 24-hour time scale \hideinitializer */ #define RTC_AM 1UL /*!< RTC as AM indication \hideinitializer */ #define RTC_PM 2UL /*!< RTC as PM indication \hideinitializer */ /*---------------------------------------------------------------------------------------------------------*/ /* RTC Tick Period Constant Definitions */ /*---------------------------------------------------------------------------------------------------------*/ #define RTC_TICK_1_SEC 0x0UL /*!< RTC time tick period is 1 second \hideinitializer */ #define RTC_TICK_1_2_SEC 0x1UL /*!< RTC time tick period is 1/2 second \hideinitializer */ #define RTC_TICK_1_4_SEC 0x2UL /*!< RTC time tick period is 1/4 second \hideinitializer */ #define RTC_TICK_1_8_SEC 0x3UL /*!< RTC time tick period is 1/8 second \hideinitializer */ #define RTC_TICK_1_16_SEC 0x4UL /*!< RTC time tick period is 1/16 second \hideinitializer */ #define RTC_TICK_1_32_SEC 0x5UL /*!< RTC time tick period is 1/32 second \hideinitializer */ #define RTC_TICK_1_64_SEC 0x6UL /*!< RTC time tick period is 1/64 second \hideinitializer */ #define RTC_TICK_1_128_SEC 0x7UL /*!< RTC time tick period is 1/128 second \hideinitializer */ /*---------------------------------------------------------------------------------------------------------*/ /* RTC Day of Week Constant Definitions */ /*---------------------------------------------------------------------------------------------------------*/ #define RTC_SUNDAY 0x0UL /*!< Day of the Week is Sunday \hideinitializer */ #define RTC_MONDAY 0x1UL /*!< Day of the Week is Monday \hideinitializer */ #define RTC_TUESDAY 0x2UL /*!< Day of the Week is Tuesday \hideinitializer */ #define RTC_WEDNESDAY 0x3UL /*!< Day of the Week is Wednesday \hideinitializer */ #define RTC_THURSDAY 0x4UL /*!< Day of the Week is Thursday \hideinitializer */ #define RTC_FRIDAY 0x5UL /*!< Day of the Week is Friday \hideinitializer */ #define RTC_SATURDAY 0x6UL /*!< Day of the Week is Saturday \hideinitializer */ /*---------------------------------------------------------------------------------------------------------*/ /* RTC Miscellaneous Constant Definitions */ /*---------------------------------------------------------------------------------------------------------*/ #define RTC_WAIT_COUNT 0xFFFFFFFFUL /*!< Initial Time-out Value \hideinitializer */ #define RTC_YEAR2000 2000UL /*!< RTC Reference for compute year data \hideinitializer */ /*@}*/ /* end of group RTC_EXPORTED_CONSTANTS */ /** @addtogroup RTC_EXPORTED_STRUCTS RTC Exported Structs @{ */ /** * @details RTC define Time Data Struct */ typedef struct { uint32_t u32Year; /*!< Year value */ uint32_t u32Month; /*!< Month value */ uint32_t u32Day; /*!< Day value */ uint32_t u32DayOfWeek; /*!< Day of week value */ uint32_t u32Hour; /*!< Hour value */ uint32_t u32Minute; /*!< Minute value */ uint32_t u32Second; /*!< Second value */ uint32_t u32TimeScale; /*!< 12-Hour, 24-Hour */ uint32_t u32AmPm; /*!< Only Time Scale select 12-hr used */ } S_RTC_TIME_DATA_T; /*@}*/ /* end of group RTC_EXPORTED_STRUCTS */ /** @addtogroup RTC_EXPORTED_FUNCTIONS RTC Exported Functions @{ */ /** * @brief Indicate is Leap Year or not * * @param None * * @retval 0 This year is not a leap year * @retval 1 This year is a leap year * * @details According to current date, return this year is leap year or not. * \hideinitializer */ #define RTC_IS_LEAP_YEAR() (RTC->LEAPYEAR & RTC_LEAPYEAR_LEAPYEAR_Msk ? 1:0) /** * @brief Clear RTC Alarm Interrupt Flag * * @param None * * @return None * * @details This macro is used to clear RTC alarm interrupt flag. * \hideinitializer */ #define RTC_CLEAR_ALARM_INT_FLAG() (REG_RTC_INTSTS = RTC_INTSTS_ALMIF_Msk) /** * @brief Clear RTC Tick Interrupt Flag * * @param None * * @return None * * @details This macro is used to clear RTC tick interrupt flag. * \hideinitializer */ #define RTC_CLEAR_TICK_INT_FLAG() (REG_RTC_INTSTS = RTC_INTSTS_TICKIF_Msk) /** * @brief Get RTC Alarm Interrupt Flag * * @param None * * @retval 0 RTC alarm interrupt did not occur * @retval 1 RTC alarm interrupt occurred * * @details This macro indicates RTC alarm interrupt occurred or not. * \hideinitializer */ #define RTC_GET_ALARM_INT_FLAG() ((REG_RTC_INTSTS & RTC_INTSTS_ALMIF_Msk)? 1:0) /** * @brief Get RTC Time Tick Interrupt Flag * * @param None * * @retval 0 RTC time tick interrupt did not occur * @retval 1 RTC time tick interrupt occurred * * @details This macro indicates RTC time tick interrupt occurred or not. * \hideinitializer */ #define RTC_GET_TICK_INT_FLAG() ((REG_RTC_INTSTS & RTC_INTSTS_TICKIF_Msk)? 1:0) /** * @brief Read Spare Register * * @param[in] u32RegNum The spare register number, 0~19. * * @return Spare register content * * @details Read the specify spare register content. * @note The returned value is valid only when SPRRDY(SPRCTL[7] SPR Register Ready) bit is set. \n * And its controlled by RTC Access Enable Register. * \hideinitializer */ #define RTC_READ_SPARE_REGISTER(u32RegNum) (RTC->SPR[(u32RegNum)]) int32_t RTC_Open(S_RTC_TIME_DATA_T *sPt); void RTC_Close(void); 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); void RTC_SetAlarmDateMask(uint8_t u8IsTenYMsk, uint8_t u8IsYMsk, uint8_t u8IsTenMMsk, uint8_t u8IsMMsk, uint8_t u8IsTenDMsk, uint8_t u8IsDMsk); void RTC_SetAlarmTimeMask(uint8_t u8IsTenHMsk, uint8_t u8IsHMsk, uint8_t u8IsTenMMsk, uint8_t u8IsMMsk, uint8_t u8IsTenSMsk, uint8_t u8IsSMsk); uint32_t RTC_GetDayOfWeek(void); void RTC_SetTickPeriod(uint32_t u32TickSelection); void RTC_EnableInt(uint32_t u32IntFlagMask); void RTC_DisableInt(uint32_t u32IntFlagMask); /*@}*/ /* end of group RTC_EXPORTED_FUNCTIONS */ /*@}*/ /* end of group RTC_Driver */ /*@}*/ /* end of group Standard_Driver */ #ifdef __cplusplus } #endif #endif /* __NU_RTC_H__ */