Enumerated Types

General Description

Enumerations
enum	cy_en_sysanalog_status_t {   CY_SYSANALOG_SUCCESS = 0x00uL,   CY_SYSANALOG_BAD_PARAM = CY_SYSANALOG_ID | CY_PDL_STATUS_ERROR | 0x01uL }
	The AREF status/error code definitions. More...
enum	cy_en_sysanalog_startup_t {   CY_SYSANALOG_STARTUP_NORMAL = 0uL,   CY_SYSANALOG_STARTUP_FAST = 1uL << PASS_AREF_AREF_CTRL_AREF_MODE_Pos }
	Aref startup mode from power on reset and from Deep Sleep wakeup. More...
enum	cy_en_sysanalog_vref_source_t {   CY_SYSANALOG_VREF_SOURCE_SRSS = 0uL,   CY_SYSANALOG_VREF_SOURCE_LOCAL_1_2V = 1uL << PASS_AREF_AREF_CTRL_VREF_SEL_Pos,   CY_SYSANALOG_VREF_SOURCE_EXTERNAL = 2uL << PASS_AREF_AREF_CTRL_VREF_SEL_Pos }
	AREF voltage reference sources. More...
enum	cy_en_sysanalog_iztat_source_t {   CY_SYSANALOG_IZTAT_SOURCE_SRSS = 0uL,   CY_SYSANALOG_IZTAT_SOURCE_LOCAL = 1uL << PASS_AREF_AREF_CTRL_IZTAT_SEL_Pos }
	AREF IZTAT sources. More...
enum	cy_en_sysanalog_deep_sleep_t {   CY_SYSANALOG_DEEPSLEEP_DISABLE = 0uL,   CY_SYSANALOG_DEEPSLEEP_IPTAT_1,   CY_SYSANALOG_DEEPSLEEP_IPTAT_2,   CY_SYSANALOG_DEEPSLEEP_IPTAT_IZTAT_VREF }
	AREF Deep Sleep mode. More...
enum	cy_en_sysanalog_intr_cause_t {   CY_SYSANALOG_INTR_CAUSE_CTB0 = PASS_INTR_CAUSE_CTB0_INT_Msk,   CY_SYSANALOG_INTR_CAUSE_CTB1 = PASS_INTR_CAUSE_CTB1_INT_Msk,   CY_SYSANALOG_INTR_CAUSE_CTB2 = PASS_INTR_CAUSE_CTB2_INT_Msk,   CY_SYSANALOG_INTR_CAUSE_CTB3 = PASS_INTR_CAUSE_CTB3_INT_Msk,   CY_SYSANALOG_INTR_CAUSE_CTDAC0 = PASS_INTR_CAUSE_CTDAC0_INT_Msk,   CY_SYSANALOG_INTR_CAUSE_CTDAC1 = PASS_INTR_CAUSE_CTDAC1_INT_Msk,   CY_SYSANALOG_INTR_CAUSE_CTDAC2 = PASS_INTR_CAUSE_CTDAC2_INT_Msk,   CY_SYSANALOG_INTR_CAUSE_CTDAC3 = PASS_INTR_CAUSE_CTDAC3_INT_Msk }
	Interrupt cause sources. More...

Enumeration Type Documentation

cy_en_sysanalog_status_t

enum cy_en_sysanalog_status_t

The AREF status/error code definitions.

Enumerator
CY_SYSANALOG_SUCCESS	Successful.
CY_SYSANALOG_BAD_PARAM	Invalid input parameters.

cy_en_sysanalog_startup_t

enum cy_en_sysanalog_startup_t

Aref startup mode from power on reset and from Deep Sleep wakeup.

To achieve the fast startup time (10 us) from Deep Sleep wakeup, the IPTAT generators must be enabled in Deep Sleep mode (see cy_en_sysanalog_deep_sleep_t).

The fast startup is the recommended mode.

Enumerator
CY_SYSANALOG_STARTUP_NORMAL	Normal startup.
CY_SYSANALOG_STARTUP_FAST	Fast startup (10 us) - recommended.

cy_en_sysanalog_vref_source_t

enum cy_en_sysanalog_vref_source_t

AREF voltage reference sources.

The voltage reference can come from three sources:

• the locally generated 1.2 V reference
• the SRSS which provides a 0.8 V reference (not available in Deep Sleep mode)
• an external device pin

Enumerator
CY_SYSANALOG_VREF_SOURCE_SRSS	Use 0.8 V Vref from SRSS. Low accuracy high noise source that is not intended for analog subsystems.
CY_SYSANALOG_VREF_SOURCE_LOCAL_1_2V	Use locally generated 1.2 V Vref.
CY_SYSANALOG_VREF_SOURCE_EXTERNAL	Use externally supplied Vref.

cy_en_sysanalog_iztat_source_t

enum cy_en_sysanalog_iztat_source_t

AREF IZTAT sources.

The AREF generates a 1 uA "Zero dependency To Absolute Temperature" (IZTAT) current reference that is independent of temperature variations. It can come from one of two sources:

• Local reference (1 uA)
• Reference from the SRSS (250 nA that is gained by 4. Not available in Deep Sleep mode)

Enumerator
CY_SYSANALOG_IZTAT_SOURCE_SRSS	Use 250 nA IZTAT from SRSS and gain by 4 to output 1 uA.
CY_SYSANALOG_IZTAT_SOURCE_LOCAL	Use locally generated 1 uA IZTAT.

cy_en_sysanalog_deep_sleep_t

enum cy_en_sysanalog_deep_sleep_t

AREF Deep Sleep mode.

Configure what part of the AREF block is enabled in Deep Sleep mode.

• Disable AREF IP block
• Enable IPTAT generator for fast wakeup from Deep Sleep mode. IPTAT outputs for CTBs are disabled.
• Enable IPTAT generator and IPTAT outputs for CTB
• Enable all generators and outputs: IPTAT, IZTAT, and VREF

Enumerator
CY_SYSANALOG_DEEPSLEEP_DISABLE	Disable AREF IP block.
CY_SYSANALOG_DEEPSLEEP_IPTAT_1	Enable IPTAT generator for fast wakeup from Deep Sleep mode IPTAT outputs for CTBs are disabled.
CY_SYSANALOG_DEEPSLEEP_IPTAT_2	Enable IPTAT generator and IPTAT outputs for CTB.
CY_SYSANALOG_DEEPSLEEP_IPTAT_IZTAT_VREF	Enable all generators and outputs: IPTAT, IZTAT, and VREF.

cy_en_sysanalog_intr_cause_t

enum cy_en_sysanalog_intr_cause_t

Interrupt cause sources.

There are two interrupts in the PASS:

1. one global interrupt for all CTBs
2. one global interrupt for all CTDACs

A device could potentially have more than one instance of each IP block, CTB or CTDAC. To find out which instance caused the interrupt, call Cy_SysAnalog_GetIntrCause and compare the returned result with one of these enum values.

Enumerator
CY_SYSANALOG_INTR_CAUSE_CTB0	Interrupt cause mask for CTB0.
CY_SYSANALOG_INTR_CAUSE_CTB1	Interrupt cause mask for CTB1.
CY_SYSANALOG_INTR_CAUSE_CTB2	Interrupt cause mask for CTB2.
CY_SYSANALOG_INTR_CAUSE_CTB3	Interrupt cause mask for CTB3.
CY_SYSANALOG_INTR_CAUSE_CTDAC0	Interrupt cause mask for CTDAC0.
CY_SYSANALOG_INTR_CAUSE_CTDAC1	Interrupt cause mask for CTDAC1.
CY_SYSANALOG_INTR_CAUSE_CTDAC2	Interrupt cause mask for CTDAC2.
CY_SYSANALOG_INTR_CAUSE_CTDAC3	Interrupt cause mask for CTDAC3.