Interface for accessing the Realtime Clock. More...

Data Structures
struct	rtc_callback_args_t

struct	rtc_error_adjustment_cfg_t

struct	rtc_error_adjustment_mode_cfg_t

struct	rtc_alarm_time_t

struct	rtc_info_t

struct	rtc_cfg_t

struct	rtc_api_t

struct	rtc_instance_t

Macros
#define	RTC_API_VERSION_MAJOR (2U)

Typedefs
typedef struct tm	rtc_time_t

typedef void	rtc_ctrl_t

Enumerations
enum	rtc_event_t { RTC_EVENT_ALARM_IRQ, RTC_EVENT_PERIODIC_IRQ, RTC_EVENT_CARRY_IRQ }

enum	rtc_clock_source_t { RTC_CLOCK_SOURCE_SUBCLK = 0, RTC_CLOCK_SOURCE_LOCO = 1 }

enum	rtc_status_t { RTC_STATUS_STOPPED = 0, RTC_STATUS_RUNNING = 1 }

enum	rtc_error_adjustment_t { RTC_ERROR_ADJUSTMENT_NONE = 0, RTC_ERROR_ADJUSTMENT_ADD_PRESCALER = 1, RTC_ERROR_ADJUSTMENT_SUBTRACT_PRESCALER = 2 }

enum	rtc_error_adjustment_mode_t { RTC_ERROR_ADJUSTMENT_MODE_MANUAL = 0, RTC_ERROR_ADJUSTMENT_MODE_AUTOMATIC = 1 }

enum	rtc_error_adjustment_period_t { RTC_ERROR_ADJUSTMENT_PERIOD_1_MINUTE = 0, RTC_ERROR_ADJUSTMENT_PERIOD_10_SECOND = 1, RTC_ERROR_ADJUSTMENT_PERIOD_NONE = 2 }

enum	rtc_periodic_irq_select_t { RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_256_SECOND = 6, RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_128_SECOND, RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_64_SECOND, RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_32_SECOND, RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_16_SECOND, RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_8_SECOND, RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_4_SECOND, RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_2_SECOND, RTC_PERIODIC_IRQ_SELECT_1_SECOND, RTC_PERIODIC_IRQ_SELECT_2_SECONDS }

Detailed Description

Interface for accessing the Realtime Clock.

Macro Definition Documentation

◆ RTC_API_VERSION_MAJOR

#define RTC_API_VERSION_MAJOR (2U)

Use of time structure, tm

Typedef Documentation

◆ rtc_ctrl_t

typedef void rtc_ctrl_t

RTC control block. Allocate an instance specific control block to pass into the RTC API calls.

Implemented as

rtc_instance_ctrl_t

◆ rtc_time_t

typedef struct tm rtc_time_t

Date and time structure defined in C standard library <time.h>

Enumeration Type Documentation

◆ rtc_clock_source_t

enum rtc_clock_source_t

Clock source for the RTC block

Enumerator
RTC_CLOCK_SOURCE_SUBCLK	Sub-clock oscillator.
RTC_CLOCK_SOURCE_LOCO	Low power On Chip Oscillator.

◆ rtc_error_adjustment_mode_t

enum rtc_error_adjustment_mode_t

Time error adjustment mode settings

Enumerator
RTC_ERROR_ADJUSTMENT_MODE_MANUAL	Adjustment mode is set to manual.
RTC_ERROR_ADJUSTMENT_MODE_AUTOMATIC	Adjustment mode is set to automatic.

◆ rtc_error_adjustment_period_t

enum rtc_error_adjustment_period_t

Time error adjustment period settings

Enumerator
RTC_ERROR_ADJUSTMENT_PERIOD_1_MINUTE	Adjustment period is set to every one minute.
RTC_ERROR_ADJUSTMENT_PERIOD_10_SECOND	Adjustment period is set to every ten second.
RTC_ERROR_ADJUSTMENT_PERIOD_NONE	Adjustment period not supported in manual mode.

◆ rtc_error_adjustment_t

enum rtc_error_adjustment_t

Time error adjustment settings

Enumerator
RTC_ERROR_ADJUSTMENT_NONE	Adjustment is not performed.
RTC_ERROR_ADJUSTMENT_ADD_PRESCALER	Adjustment is performed by the addition to the prescaler.
RTC_ERROR_ADJUSTMENT_SUBTRACT_PRESCALER	Adjustment is performed by the subtraction from the prescaler.

◆ rtc_event_t

enum rtc_event_t

Events that can trigger a callback function

Enumerator
RTC_EVENT_ALARM_IRQ	Real Time Clock ALARM IRQ.
RTC_EVENT_PERIODIC_IRQ	Real Time Clock PERIODIC IRQ.
RTC_EVENT_CARRY_IRQ	Real Time Clock CARRY IRQ.

◆ rtc_periodic_irq_select_t

enum rtc_periodic_irq_select_t

Periodic Interrupt select

Enumerator
RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_256_SECOND	A periodic irq is generated every 1/256 second.
RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_128_SECOND	A periodic irq is generated every 1/128 second.
RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_64_SECOND	A periodic irq is generated every 1/64 second.
RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_32_SECOND	A periodic irq is generated every 1/32 second.
RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_16_SECOND	A periodic irq is generated every 1/16 second.
RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_8_SECOND	A periodic irq is generated every 1/8 second.
RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_4_SECOND	A periodic irq is generated every 1/4 second.
RTC_PERIODIC_IRQ_SELECT_1_DIV_BY_2_SECOND	A periodic irq is generated every 1/2 second.
RTC_PERIODIC_IRQ_SELECT_1_SECOND	A periodic irq is generated every 1 second.
RTC_PERIODIC_IRQ_SELECT_2_SECONDS	A periodic irq is generated every 2 seconds.

◆ rtc_status_t

enum rtc_status_t

RTC run state

Enumerator
RTC_STATUS_STOPPED	RTC counter is stopped.
RTC_STATUS_RUNNING	RTC counter is running.

Data Structures

Macros

Typedefs

Enumerations