General Description

Enumerations
enum	cy_en_rtc_status_t { CY_RTC_SUCCESS = 0x00U, CY_RTC_BAD_PARAM = CY_RTC_ID \| CY_PDL_STATUS_ERROR \| 0x01U, CY_RTC_TIMEOUT = CY_RTC_ID \| CY_PDL_STATUS_ERROR \| 0x02U, CY_RTC_INVALID_STATE = CY_RTC_ID \| CY_PDL_STATUS_ERROR \| 0x03U, CY_RTC_UNKNOWN = CY_RTC_ID \| CY_PDL_STATUS_ERROR \| 0xFFU }
	RTC status enumeration. More...

enum	cy_en_rtc_clock_freq_t { CY_RTC_FREQ_WCO_32768_HZ, CY_RTC_FREQ_60_HZ, CY_RTC_FREQ_50_HZ }
	This enumeration is used to set frequency by changing the it pre-scaler. More...

enum	cy_en_rtc_alarm_t { CY_RTC_ALARM_1, CY_RTC_ALARM_2 }
	This enumeration is used to set/get information for alarm 1 or alarm 2. More...

enum	cy_en_rtc_hours_format_t { CY_RTC_24_HOURS, CY_RTC_12_HOURS }
	This enumeration is used to set/get hours format. More...

enum	cy_en_rtc_write_status_t { CY_RTC_WRITE_DISABLED, CY_RTC_WRITE_ENABLED }
	Enumeration to configure the RTC Write register. More...

enum	cy_en_rtc_dst_format_t { CY_RTC_DST_RELATIVE, CY_RTC_DST_FIXED }
	Enumeration used to set/get DST format. More...

enum	cy_en_rtc_am_pm_t { CY_RTC_AM, CY_RTC_PM }
	Enumeration to indicate the AM/PM period of day. More...

enum	cy_en_rtc_alarm_enable_t { CY_RTC_ALARM_DISABLE, CY_RTC_ALARM_ENABLE }
	Enumeration to enable/disable the RTC alarm on match with required value. More...

Enumeration Type Documentation

RTC status enumeration.

Enumerator
CY_RTC_SUCCESS	Successful.
CY_RTC_BAD_PARAM	One or more invalid parameters.
CY_RTC_TIMEOUT	Time-out occurs.
CY_RTC_INVALID_STATE	Operation not setup or is in an improper state.
CY_RTC_UNKNOWN	Unknown failure.

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

Enumerator
CY_RTC_FREQ_WCO_32768_HZ	prescaler value for 32.768 kHz oscillator
CY_RTC_FREQ_60_HZ	prescaler value for 60 Hz source
CY_RTC_FREQ_50_HZ	prescaler value for 50 Hz source

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

Enumerator
CY_RTC_ALARM_1	Alarm 1 enum.
CY_RTC_ALARM_2	Alarm 2 enum.

This enumeration is used to set/get hours format.

Enumerator
CY_RTC_24_HOURS	The 24 hour format.
CY_RTC_12_HOURS	The 12 hour (AM/PM) format.

Enumeration to configure the RTC Write register.

Enumerator
CY_RTC_WRITE_DISABLED	Writing the RTC is disabled.
CY_RTC_WRITE_ENABLED	Writing the RTC is enabled.

Enumeration used to set/get DST format.

Enumerator
CY_RTC_DST_RELATIVE	Relative DST format.
CY_RTC_DST_FIXED	Fixed DST format.

Enumeration to indicate the AM/PM period of day.

Enumerator
CY_RTC_AM	AM period of day.
CY_RTC_PM	PM period of day.

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

Enumerator
CY_RTC_ALARM_DISABLE	Disable alarm on match with required value.
CY_RTC_ALARM_ENABLE	Enable alarm on match with required value.