Enumerated Types

group group_rtc_enums

Enums

enum cy_en_rtc_status_t

cy_en_rtc_status_t: RTC status enumeration.

Values:

enumerator CY_RTC_SUCCESS

Successful.

enumerator CY_RTC_BAD_PARAM

One or more invalid parameters.

enumerator CY_RTC_TIMEOUT

Time-out occurs.

enumerator CY_RTC_INVALID_STATE

Operation not setup or is in an improper state.

enumerator CY_RTC_UNKNOWN

Unknown failure.

enum cy_en_rtc_clock_freq_t

cy_en_rtc_clock_freq_t: This enumeration is used to set frequency by changing the it pre-scaler.

Values:

enumerator CY_RTC_FREQ_WCO_32768_HZ

prescaler value for 32.768 kHz oscillator

enumerator CY_RTC_FREQ_60_HZ

prescaler value for 60 Hz source

enumerator CY_RTC_FREQ_50_HZ

prescaler value for 50 Hz source

enum cy_en_rtc_alarm_t

cy_en_rtc_alarm_t: This enumeration is used to set/get information for alarm 1 or alarm 2.

Values:

enumerator CY_RTC_ALARM_1

Alarm 1 enum.

enumerator CY_RTC_ALARM_2

Alarm 2 enum.

enum cy_en_rtc_hours_format_t

cy_en_rtc_hours_format_t: This enumeration is used to set/get hours format.

Values:

enumerator CY_RTC_24_HOURS

The 24 hour format.

enumerator CY_RTC_12_HOURS

The 12 hour (AM/PM) format.

enum cy_en_rtc_write_status_t

cy_en_rtc_write_status_t: Enumeration to configure the RTC Write register.

Values:

enumerator CY_RTC_WRITE_DISABLED

Writing the RTC is disabled.

enumerator CY_RTC_WRITE_ENABLED

Writing the RTC is enabled.

enum cy_en_rtc_dst_format_t

cy_en_rtc_dst_format_t: Enumeration used to set/get DST format.

Values:

enumerator CY_RTC_DST_RELATIVE

Relative DST format.

enumerator CY_RTC_DST_FIXED

Fixed DST format.

enum cy_en_rtc_am_pm_t

cy_en_rtc_am_pm_t: Enumeration to indicate the AM/PM period of day.

Values:

enumerator CY_RTC_AM

AM period of day.

enumerator CY_RTC_PM

PM period of day.

enum cy_en_rtc_alarm_enable_t

cy_en_rtc_alarm_enable_t: Enumeration to enable/disable the RTC alarm on match with required value.

Values:

enumerator CY_RTC_ALARM_DISABLE

Disable alarm on match with required value.

enumerator CY_RTC_ALARM_ENABLE

Enable alarm on match with required value.

enum cy_rtc_clk_select_sources_t

cy_rtc_clk_select_sources_t: Enumeration to list all the clock sources for RTC.

Values:

enumerator CY_RTC_CLK_SELECT_WCO

Select WCO as input to RTC.

enumerator CY_RTC_CLK_SELECT_ALTBAK

Select ALTBAK as input to RTC.

enumerator CY_RTC_CLK_SELECT_ILO

Select ILO as input to RTC.

enumerator CY_RTC_CLK_SELECT_LPECO_PRESCALER

Select LPECO_PRESCALER as input to RTC.

enumerator CY_RTC_CLK_SELECT_PILO

Select PILO as input to RTC.