rtc_api_t Struct Reference

#include <r_rtc_api.h>

Data Fields
ssp_err_t(*	open )(rtc_ctrl_t *const p_ctrl, rtc_cfg_t const *const p_cfg)
ssp_err_t(*	close )(rtc_ctrl_t *const p_ctrl)
ssp_err_t(*	configure )(rtc_ctrl_t *const p_ctrl, void *const p_extend)
ssp_err_t(*	calendarTimeSet )(rtc_ctrl_t *const p_ctrl, rtc_time_t *p_time, bool clock_start)
ssp_err_t(*	calendarTimeGet )(rtc_ctrl_t *const p_ctrl, rtc_time_t *p_time)
ssp_err_t(*	calendarAlarmSet )(rtc_ctrl_t *const p_ctrl, rtc_alarm_time_t *p_alarm, bool irq_enable_flag)
ssp_err_t(*	calendarAlarmGet )(rtc_ctrl_t *const p_ctrl, rtc_alarm_time_t *p_alarm)
ssp_err_t(*	calendarCounterStart )(rtc_ctrl_t *const p_ctrl)
ssp_err_t(*	calendarCounterStop )(rtc_ctrl_t *const p_ctrl)
ssp_err_t(*	irqEnable )(rtc_ctrl_t *const p_ctrl, rtc_event_t irq)
ssp_err_t(*	irqDisable )(rtc_ctrl_t *const p_ctrl, rtc_event_t irq)
ssp_err_t(*	periodicIrqRateSet )(rtc_ctrl_t *const p_ctrl, rtc_periodic_irq_select_t rate)
ssp_err_t(*	infoGet )(rtc_ctrl_t *p_ctrl, rtc_info_t *p_rtc_info)
ssp_err_t(*	errorAdjustmentModeSet )(rtc_ctrl_t *p_ctrl, rtc_error_adjustment_mode_cfg_t *p_error_adjustment_mode)
ssp_err_t(*	errorAdjustmentSet )(rtc_ctrl_t *p_ctrl, rtc_error_adjustment_cfg_t *p_error_adjustment_config)
ssp_err_t(*	versionGet )(ssp_version_t *version)

Detailed Description

RTC driver structure. General RTC functions implemented at the HAL layer follow this API.

Field Documentation

calendarAlarmGet

ssp_err_t(* rtc_api_t::calendarAlarmGet) (rtc_ctrl_t *const p_ctrl, rtc_alarm_time_t *p_alarm)

Get the calendar alarm time.

Implemented as

• R_RTC_CalendarAlarmGet()

Parameters

[in]	p_ctrl	Pointer to RTC device handle
[out]	p_alarm	Pointer to an alarm structure to fill up with the alarm time

calendarAlarmSet

ssp_err_t(* rtc_api_t::calendarAlarmSet) (rtc_ctrl_t *const p_ctrl, rtc_alarm_time_t *p_alarm, bool irq_enable_flag)

Set the calendar alarm time.

Implemented as

• R_RTC_CalendarAlarmSet()

Parameters

[in]	p_ctrl	Pointer to RTC device handle
[in]	p_alarm	Pointer to an alarm structure that contains the alarm time to set
[in]	irq_enable_flag	Enable the ALARM irq if set

calendarCounterStart

ssp_err_t(* rtc_api_t::calendarCounterStart) (rtc_ctrl_t *const p_ctrl)

Start the calendar counter.

Implemented as

• R_RTC_CalendarCounterStart()

Parameters

[in]

p_ctrl

Pointer to RTC device handle

calendarCounterStop

ssp_err_t(* rtc_api_t::calendarCounterStop) (rtc_ctrl_t *const p_ctrl)

Stop the calendar counter.

Implemented as

• R_RTC_CalendarCounterStop()

Parameters

[in]

p_ctrl

Pointer to RTC device handle

calendarTimeGet

ssp_err_t(* rtc_api_t::calendarTimeGet) (rtc_ctrl_t *const p_ctrl, rtc_time_t *p_time)

Get the calendar time.

Implemented as

• R_RTC_CalendarTimeGet()

Parameters

[in]	p_ctrl	Pointer to RTC device handle
[out]	p_time	Pointer to a time structure that contains the time to get

calendarTimeSet

ssp_err_t(* rtc_api_t::calendarTimeSet) (rtc_ctrl_t *const p_ctrl, rtc_time_t *p_time, bool clock_start)

Set the calendar time.

Implemented as

• R_RTC_CalendarTimeSet()

Parameters

[in]	p_ctrl	Pointer to RTC device handle
[in]	p_time	Pointer to a time structure that contains the time to set
[in]	clock_start	Flag that starts the clock right after it is set

close

ssp_err_t(* rtc_api_t::close) (rtc_ctrl_t *const p_ctrl)

Close the RTC driver.

Implemented as

• R_RTC_Close()

Parameters

[in]

p_ctrl

Pointer to RTC device handle.

configure

ssp_err_t(* rtc_api_t::configure) (rtc_ctrl_t *const p_ctrl, void *const p_extend)

Configure the RTC driver.

Implemented as

• R_RTC_Configure()

Parameters

[in]	p_ctrl	Pointer to RTC device handle.
[in]	p_extend	Currently not implemented, pass NULL.

errorAdjustmentModeSet

ssp_err_t(* rtc_api_t::errorAdjustmentModeSet) (rtc_ctrl_t *p_ctrl, rtc_error_adjustment_mode_cfg_t *p_error_adjustment_mode)

Set time error adjustment mode.

Implemented as

• R_RTC_ErrorAdjustmentModeSet()

Parameters

[in]	p_ctrl	Pointer to control handle structure
[in]	p_error_adjustment_mode	Pointer to error adjustment mode configuration structure

errorAdjustmentSet

ssp_err_t(* rtc_api_t::errorAdjustmentSet) (rtc_ctrl_t *p_ctrl, rtc_error_adjustment_cfg_t *p_error_adjustment_config)

Set time error adjustment.

Implemented as

• R_RTC_ErrorAdjustmentSet()

Parameters

[in]	p_ctrl	Pointer to control handle structure
[in]	p_error_adjustment_config	Pointer to error adjustment structure

infoGet

ssp_err_t(* rtc_api_t::infoGet) (rtc_ctrl_t *p_ctrl, rtc_info_t *p_rtc_info)

Return the currently configure clock source for the RTC

Implemented as

• R_RTC_InfoGet()

Parameters

[in]	p_ctrl	Pointer to control handle structure
[out]	p_rtc_info	Pointer to RTC information structure

irqDisable

ssp_err_t(* rtc_api_t::irqDisable) (rtc_ctrl_t *const p_ctrl, rtc_event_t irq)

Disable the alarm irq.

Implemented as

• R_RTC_IrqDisable()

Parameters

[in]

p_ctrl

Pointer to RTC device handle

irqEnable

ssp_err_t(* rtc_api_t::irqEnable) (rtc_ctrl_t *const p_ctrl, rtc_event_t irq)

Enable the alarm irq.

Implemented as

• R_RTC_IrqEnable()

Parameters

[in]

p_ctrl

Pointer to RTC device handle

open

ssp_err_t(* rtc_api_t::open) (rtc_ctrl_t *const p_ctrl, rtc_cfg_t const *const p_cfg)

Open the RTC driver.

Implemented as

• R_RTC_Open()

Parameters

[in]	p_ctrl	Pointer to RTC device handle
[in]	p_cfg	Pointer to the configuration structure

periodicIrqRateSet

ssp_err_t(* rtc_api_t::periodicIrqRateSet) (rtc_ctrl_t *const p_ctrl, rtc_periodic_irq_select_t rate)

Set the periodic irq rate

Implemented as

• R_RTC_PeriodicIrqRateSet()

Parameters

[in]	p_ctrl	Pointer to RTC device handle
[in]	rate	Rate of periodic interrupts

versionGet

ssp_err_t(* rtc_api_t::versionGet) (ssp_version_t *version)

Gets version and stores it in provided pointer p_version.

Implemented as

• R_RTC_VersionGet()

Parameters

[out]

p_version

Code and API version used

---

The documentation for this struct was generated from the following file:

• r_rtc_api.h