Enumerated Types

group group_sysanalog_enums

Enums

enum cy_en_sysanalog_status_t

cy_en_sysanalog_status_t: The AREF status/error code definitions.

Values:

enumerator CY_SYSANALOG_SUCCESS

Successful.

enumerator CY_SYSANALOG_BAD_PARAM

Invalid input parameters.

enumerator CY_SYSANALOG_UNSUPPORTED

Unsupported feature.

enum cy_en_sysanalog_startup_t

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.

Values:

enumerator CY_SYSANALOG_STARTUP_NORMAL

Normal startup.

enumerator CY_SYSANALOG_STARTUP_FAST

Fast startup (10 us) - recommended.

enum cy_en_sysanalog_vref_source_t

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

Values:

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.

enumerator CY_SYSANALOG_VREF_SOURCE_LOCAL_1_2V

Use locally generated 1.2 V Vref.

enumerator CY_SYSANALOG_VREF_SOURCE_EXTERNAL

Use externally supplied Vref.

enum cy_en_sysanalog_iztat_source_t

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)

Values:

enumerator CY_SYSANALOG_IZTAT_SOURCE_SRSS

Use 250 nA IZTAT from SRSS and gain by 4 to output 1 uA.

enumerator CY_SYSANALOG_IZTAT_SOURCE_LOCAL

Use locally generated 1 uA IZTAT.

enum cy_en_sysanalog_deep_sleep_t

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

Values:

enumerator CY_SYSANALOG_DEEPSLEEP_DISABLE

Disable AREF IP block.

enumerator CY_SYSANALOG_DEEPSLEEP_IPTAT_1

Enable IPTAT generator for fast wakeup from Deep Sleep mode IPTAT outputs for CTBs are disabled.

enumerator CY_SYSANALOG_DEEPSLEEP_IPTAT_2

Enable IPTAT generator and IPTAT outputs for CTB.

enumerator CY_SYSANALOG_DEEPSLEEP_IPTAT_IZTAT_VREF

Enable all generators and outputs: IPTAT, IZTAT, and VREF.

enum cy_en_sysanalog_intr_cause_t

cy_en_sysanalog_intr_cause_t: Interrupt cause sources.

Depending on the device, there may be interrupts from these PASS blocks:

  1. CTDAC (up to 4 instances)

  2. CTB(m) (up to 4 instances)

  3. SAR (up to 4 instances)

  4. FIFO (up to 4 instances)

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

Values:

enumerator CY_SYSANALOG_INTR_CAUSE_CTB0

Interrupt cause mask for CTB0.

enumerator CY_SYSANALOG_INTR_CAUSE_CTB1

Interrupt cause mask for CTB1.

enumerator CY_SYSANALOG_INTR_CAUSE_CTB2

Interrupt cause mask for CTB2.

enumerator CY_SYSANALOG_INTR_CAUSE_CTB3

Interrupt cause mask for CTB3.

enumerator CY_SYSANALOG_INTR_CAUSE_CTDAC0

Interrupt cause mask for CTDAC0.

enumerator CY_SYSANALOG_INTR_CAUSE_CTDAC1

Interrupt cause mask for CTDAC1.

enumerator CY_SYSANALOG_INTR_CAUSE_CTDAC2

Interrupt cause mask for CTDAC2.

enumerator CY_SYSANALOG_INTR_CAUSE_CTDAC3

Interrupt cause mask for CTDAC3.

enumerator CY_SYSANALOG_INTR_CAUSE_SAR0

Interrupt cause mask for SAR0.

Available only for PASS_ver2.

enumerator CY_SYSANALOG_INTR_CAUSE_SAR1

Interrupt cause mask for SAR1.

Available only for PASS_ver2.

enumerator CY_SYSANALOG_INTR_CAUSE_SAR2

Interrupt cause mask for SAR2.

Available only for PASS_ver2.

enumerator CY_SYSANALOG_INTR_CAUSE_SAR3

Interrupt cause mask for SAR3.

Available only for PASS_ver2.

enumerator CY_SYSANALOG_INTR_CAUSE_FIFO0

Interrupt cause mask for FIFO0.

Available only for PASS_ver2.

enumerator CY_SYSANALOG_INTR_CAUSE_FIFO1

Interrupt cause mask for FIFO1.

Available only for PASS_ver2.

enumerator CY_SYSANALOG_INTR_CAUSE_FIFO2

Interrupt cause mask for FIFO2.

Available only for PASS_ver2.

enumerator CY_SYSANALOG_INTR_CAUSE_FIFO3

Interrupt cause mask for FIFO3.

Available only for PASS_ver2.

enum cy_en_sysanalog_deep_sleep_clock_sel_t

cy_en_sysanalog_deep_sleep_clock_sel_t: Deep Sleep Clock selection.

Specifies Deep Sleep Clock source:

  • DSCLK is set to LPOSC

  • DSCLK is set to CLK_MF

Values:

enumerator CY_SYSANALOG_DEEPSLEEP_SRC_LPOSC

DSCLK is set to LPOSC.

enumerator CY_SYSANALOG_DEEPSLEEP_SRC_CLK_MF

DSCLK is set to CLK_MF.

enum cy_en_sysanalog_deep_sleep_clock_div_t

cy_en_sysanalog_deep_sleep_clock_div_t: Deep Sleep clock divider.

Specifies Deep Sleep Clock divider.

  • Transparent mode, feed through selected clock source w/o dividing

  • Divide selected clock source by 2

  • Divide selected clock source by 4

  • Divide selected clock source by 8

  • Divide selected clock source by 16

Values:

enumerator CY_SYSANALOG_DEEPSLEEP_CLK_NO_DIV

Transparent mode, feed through selected clock source w/o dividing.

enumerator CY_SYSANALOG_DEEPSLEEP_CLK_DIV_BY_2

Divide selected clock source by 2.

enumerator CY_SYSANALOG_DEEPSLEEP_CLK_DIV_BY_4

Divide selected clock source by 4.

enumerator CY_SYSANALOG_DEEPSLEEP_CLK_DIV_BY_8

Divide selected clock source by 8.

enumerator CY_SYSANALOG_DEEPSLEEP_CLK_DIV_BY_16

Divide selected clock source by 16.

enum cy_en_sysanalog_lposc_deep_sleep_mode_t

cy_en_sysanalog_lposc_deep_sleep_mode_t: Low Power Oscillator (LPOSC) modes.

Configures Low Power Oscillator mode in Deep Sleep.

  • LPOSC enabled by TIMER trigger

  • LPOSC always on in Deep Sleep

Values:

enumerator CY_SYSANALOG_LPOSC_DUTY_CYCLED

LPOSC enabled by TIMER trigger.

enumerator CY_SYSANALOG_LPOSC_ALWAYS_ON

LPOSC always on in Deep Sleep.

enum cy_en_sysanalog_timer_clock_t

cy_en_sysanalog_timer_clock_t: Timer clock.

Values:

enumerator CY_SYSANALOG_TIMER_CLK_PERI

Timer clocked from CLK_PERI.

enumerator CY_SYSANALOG_TIMER_CLK_DEEPSLEEP

Timer clocked from CLK_DPSLP.

enumerator CY_SYSANALOG_TIMER_CLK_LF

Timer clocked from CLK_LF.