rtc_driver_api Struct Reference

@driver_ops{RTC} More...

#include <rtc.h>

Data Fields
rtc_api_set_time	set_time
	@driver_ops_mandatory API for setting RTC time.
rtc_api_get_time	get_time
	@driver_ops_mandatory API for getting RTC time.
rtc_api_alarm_get_supported_fields	alarm_get_supported_fields
	@driver_ops_optional API for getting the supported fields of the RTC alarm time.
rtc_api_alarm_set_time	alarm_set_time
	@driver_ops_optional API for setting RTC alarm time.
rtc_api_alarm_get_time	alarm_get_time
	@driver_ops_optional API for getting RTC alarm time.
rtc_api_alarm_is_pending	alarm_is_pending
	@driver_ops_optional API for testing if RTC alarm is pending.
rtc_api_alarm_set_callback	alarm_set_callback
	@driver_ops_optional API for setting alarm callback.
rtc_api_update_set_callback	update_set_callback
	@driver_ops_optional API for setting update callback.
rtc_api_set_calibration	set_calibration
	@driver_ops_optional API for setting RTC calibration.
rtc_api_get_calibration	get_calibration
	@driver_ops_optional API for getting RTC calibration.

Detailed Description

@driver_ops{RTC}

Field Documentation

alarm_get_supported_fields

rtc_api_alarm_get_supported_fields rtc_driver_api::alarm_get_supported_fields

@driver_ops_optional API for getting the supported fields of the RTC alarm time.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_RTC_ALARM 

.

alarm_get_time

rtc_api_alarm_get_time rtc_driver_api::alarm_get_time

@driver_ops_optional API for getting RTC alarm time.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_RTC_ALARM 

.

alarm_is_pending

rtc_api_alarm_is_pending rtc_driver_api::alarm_is_pending

@driver_ops_optional API for testing if RTC alarm is pending.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_RTC_ALARM 

.

alarm_set_callback

rtc_api_alarm_set_callback rtc_driver_api::alarm_set_callback

@driver_ops_optional API for setting alarm callback.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_RTC_ALARM 

.

alarm_set_time

rtc_api_alarm_set_time rtc_driver_api::alarm_set_time

@driver_ops_optional API for setting RTC alarm time.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_RTC_ALARM 

.

get_calibration

rtc_api_get_calibration rtc_driver_api::get_calibration

@driver_ops_optional API for getting RTC calibration.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_RTC_CALIBRATION 

.

get_time

rtc_api_get_time rtc_driver_api::get_time

@driver_ops_mandatory API for getting RTC time.

set_calibration

rtc_api_set_calibration rtc_driver_api::set_calibration

@driver_ops_optional API for setting RTC calibration.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_RTC_CALIBRATION 

.

set_time

rtc_api_set_time rtc_driver_api::set_time

@driver_ops_mandatory API for setting RTC time.

update_set_callback

rtc_api_update_set_callback rtc_driver_api::update_set_callback

@driver_ops_optional API for setting update callback.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_RTC_UPDATE 

.

---

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

• include/zephyr/drivers/rtc.h