RTC Driver

RTC Driver API Reference. More...

Functions list
void	rtc_init ()
	Initialize the RTC module. More...
err_t	rtc_start ()
	Start the RTC module. More...
err_t	rtc_stop ()
	Stop the RTC module. More...
err_t	rtc_reset ()
	Reset the RTC module. More...
err_t	rtc_set_time (rtc_time_t *time)
	Configure time of RTC module. More...
err_t	rtc_get_time (rtc_time_t *time)
	Get time from RTC module. More...
void	rtc_system_reset ()
	Preforms system reset. More...

Detailed Description

The RTC driver provides standard RTC functionality including start, reset and stop of RTC counter, it also allows setting custom values.

Function Documentation

rtc_init()

void rtc_init

(

)

Initialize the RTC module.

Parameters

None.

Example // Initialize RTC. rtc_init();

rtc_start()

err_t rtc_start

(

)

Continue the RTC module count from the stored value in the counter register.

Parameters

None.

Returns

The function can return one of the values defined by rtc_err_t structure, which is size dependant on the architecture.

Note

It is recommended to configure RTC module using rtc_set_time( rtc_time_t *time ) before the first start and to check return value for error.

Example

// RTC time structure.
static rtc_time_t time;
 
// Initalize the RTC module.
rtc_init();
 
// Start the RTC module.
if ( RTC_ERROR == rtc_start() ) {
 // Error handling strategy.
}

rtc_stop()

err_t rtc_stop

(

)

Stop the RTC module count.

Parameters

None.

Returns

The function can return one of the values defined by rtc_err_t structure, which is size dependant on the architecture.

Note

It is recommended to check return value for error.

Example

// RTC time structure.
static rtc_time_t time;
 
// Initalize the RTC module.
rtc_init();
 
// Stop the RTC module.
if ( RTC_ERROR == rtc_stop() ) {
 // Error handling strategy.
}

rtc_reset()

err_t rtc_reset

(

)

Reset the RTC counter to the default values of 0h:0m:0s.

Parameters

None.

Returns

The function can return one of the values defined by rtc_err_t structure, which is size dependant on the architecture.

Note

It is recommended to check return value for error.

Example

// RTC time structure.
static rtc_time_t time;
 
// Initalize the RTC module.
rtc_init();
 
// Reset the RTC module.
if ( RTC_ERROR == rtc_reset() ) {
 // Error handling strategy.
}

rtc_set_time()

err_t rtc_set_time

(

rtc_time_t *

time

)

Configure time registers with the values from rtc_time_t structure.

Parameters

time	rtc_time_t structure.

Returns

The function can return one of the values defined by rtc_err_t structure, which is size dependant on the architecture.

Note

It is recommended to check return value for error.

Example

// Time structure.
static rtc_time_t time;
 
// Initialize RTC.
rtc_init();
 
// Modify time.
time.second = 0;
time.minute = 5;
time.hour = 3;
 
// Set time.
if ( RTC_SUCCESS != rtc_set_time( &time ) ) {
 // Error handling strategy.
}

rtc_get_time()

err_t rtc_get_time

(

rtc_time_t *

time

)

Configure rtc_time_t structure with the values from time registers.

Parameters

time	rtc_time_t structure.

Returns

The function can return one of the values defined by rtc_err_t structure, which is size dependant on the architecture.

Note

It is recommended to check return value for error.

Example

// Time structure.
static rtc_time_t time;
 
// Initialize RTC.
rtc_init();
 
if ( RTC_SUCCESS != rtc_get_time( &time ) ) {
 // Error handling strategy.
}

rtc_system_reset()

void rtc_system_reset

(

)

Resets the core and all on-chip peripherals except the Debug interface.

Parameters

None.

Warning

System reset affects core and periferals, depending on the architecture you will need to reconfigure opened modules.

Example

// Time structure.
static rtc_time_t time;
 
// Initialize RTC.
rtc_init();
 
// Reset.
rtc_system_reset();