drivers/rtc/rtc.h

Go to the documentation of this file.

/*
 * Support and FAQ: visit <a href="https://www.microchip.com/support/">Microchip Support</a>
 */

#ifndef RTC_H_INCLUDED
#define RTC_H_INCLUDED

#include  "compiler.h"


#ifdef __cplusplus
extern "C" {
#endif


void rtc_set_hour_mode(Rtc *p_rtc, uint32_t ul_mode);
uint32_t rtc_get_hour_mode(Rtc *p_rtc);
void rtc_enable_interrupt(Rtc *p_rtc, uint32_t ul_sources);
void rtc_disable_interrupt(Rtc *p_rtc, uint32_t ul_sources);
uint32_t rtc_get_interrupt_mask(Rtc *p_rtc);
void rtc_get_time(Rtc *p_rtc, uint32_t *pul_hour, uint32_t *pul_minute,
                uint32_t *pul_second);
uint32_t rtc_set_time(Rtc *p_rtc, uint32_t ul_hour, uint32_t ul_minute,
                uint32_t ul_second);
uint32_t rtc_set_time_alarm(Rtc *p_rtc,
                uint32_t ul_hour_flag, uint32_t ul_hour,
                uint32_t ul_minute_flag, uint32_t ul_minute,
                uint32_t ul_second_flag, uint32_t ul_second);
void rtc_get_date(Rtc *p_rtc, uint32_t *pul_year, uint32_t *pul_month,
                uint32_t *pul_day, uint32_t *pul_week);
uint32_t rtc_set_date(Rtc *p_rtc, uint32_t ul_year, uint32_t ul_month,
                uint32_t ul_day, uint32_t ul_week);
uint32_t rtc_set_date_alarm(Rtc *p_rtc,
                uint32_t ul_month_flag, uint32_t ul_month,
                uint32_t ul_day_flag, uint32_t ul_day);
void rtc_clear_time_alarm(Rtc *p_rtc);
void rtc_clear_date_alarm(Rtc *p_rtc);
uint32_t rtc_get_status(Rtc *p_rtc);
void rtc_clear_status(Rtc *p_rtc, uint32_t ul_clear);
uint32_t rtc_get_valid_entry(Rtc *p_rtc);
void rtc_set_time_event(Rtc *p_rtc, uint32_t ul_selection);
void rtc_set_calendar_event(Rtc *p_rtc, uint32_t ul_selection);

#if ((SAM3S8) || (SAM3SD8) || (SAM4S) || (SAM4N) || (SAM4C) || (SAMG) || (SAM4CP) || (SAM4CM) || defined(__DOXYGEN__))
void rtc_set_calendar_mode(Rtc *p_rtc, uint32_t ul_mode);
uint32_t rtc_get_calendar_mode(Rtc *p_rtc);
void rtc_set_calibration(Rtc *p_rtc, uint32_t ul_direction_ppm,
                uint32_t ul_correction, uint32_t ul_range_ppm);
#endif

#if ((SAM3S8) || (SAM3SD8) || (SAM4S) || (SAM4C) || (SAMG) || (SAM4CP) || (SAM4CM) || SAMV71 || SAMV70 || SAME70 || SAMS70 || defined(__DOXYGEN__))
void rtc_set_waveform(Rtc *p_rtc, uint32_t ul_channel, uint32_t ul_value);
#if ((SAM3S8) || (SAM3SD8) || (SAM4S) || (SAM4C)|| (SAM4CP) || (SAM4CM) || SAMV71 || SAMV70 || SAME70 || SAMS70 || defined(__DOXYGEN__))
void rtc_set_pulse_parameter(Rtc *p_rtc, uint32_t ul_time_high,
                uint32_t ul_period);
#endif
#endif

#if ((SAM3N) || (SAM3U) || (SAM3XA) || defined(__DOXYGEN__))
void rtc_set_writeprotect(Rtc *p_rtc, uint32_t ul_enable);
#endif /* ((SAM3N) || (SAM3U) || (SAM3XA)) */

#if ((SAM4C) || (SAM4CP) || (SAM4CM) || defined(__DOXYGEN__))
void rtc_get_tamper_time(Rtc *p_rtc, uint32_t *pul_hour, uint32_t *pul_minute,
                uint32_t *pul_second, uint8_t reg_num);
void rtc_get_tamper_date(Rtc *p_rtc, uint32_t *pul_year, uint32_t *pul_month,
                uint32_t *pul_day, uint32_t *pul_week, uint8_t reg_num);
uint32_t rtc_get_tamper_source(Rtc *p_rtc, uint8_t reg_num);
uint32_t rtc_get_tamper_event_counter(Rtc *p_rtc);
bool rtc_is_tamper_occur_in_backup_mode(Rtc *p_rtc, uint8_t reg_num);
#endif

#if (SAMG55 || defined(__DOXYGEN__))
uint32_t rtc_get_milliseconds(Rtc *p_rtc);
#endif


#ifdef __cplusplus
}
#endif


#endif /* RTC_H_INCLUDED */