Enumerated Types

group group_sar_enums

Enums

enum cy_en_sar_status_t

cy_en_sar_status_t: The SAR status/error code definitions.

Values:

enumerator CY_SAR_SUCCESS

Success.

enumerator CY_SAR_BAD_PARAM

Invalid input parameters.

enumerator CY_SAR_TIMEOUT

A timeout occurred.

enumerator CY_SAR_CONVERSION_NOT_COMPLETE

SAR conversion is not complete.

enum cy_en_sar_start_convert_sel_t

cy_en_sar_start_convert_sel_t: Definitions for starting a conversion used in Cy_SAR_StartConvert.

Values:

enumerator CY_SAR_START_CONVERT_SINGLE_SHOT

Start a single scan (one shot) from firmware.

enumerator CY_SAR_START_CONVERT_CONTINUOUS

Continuously scan enabled channels and ignores all triggers, firmware or hardware.

enum cy_en_sar_return_mode_t

cy_en_sar_return_mode_t: Definitions for the return mode used in Cy_SAR_IsEndConversion.

Values:

enumerator CY_SAR_RETURN_STATUS

Immediately returns the conversion status.

enumerator CY_SAR_WAIT_FOR_RESULT

Does not return a result until the conversion of all sequential channels is complete.

This mode is blocking.

enumerator CY_SAR_RETURN_STATUS_INJ

Immediately returns the conversion status of the injection channel.

enumerator CY_SAR_WAIT_FOR_RESULT_INJ

Does not return a result until the conversion of injection channels is complete.

This mode is blocking.

enum cy_en_sar_switch_state_t

cy_en_sar_switch_state_t: Switch state definitions.

Values:

enumerator CY_SAR_SWITCH_OPEN

Open the switch.

enumerator CY_SAR_SWITCH_CLOSE

Close the switch.

enum cy_en_sar_switch_sar_seq_ctrl_t

cy_en_sar_switch_sar_seq_ctrl_t: Definitions for sequencer control of switches.

Values:

enumerator CY_SAR_SWITCH_SEQ_CTRL_DISABLE

Disable sequencer control of switch.

enumerator CY_SAR_SWITCH_SEQ_CTRL_ENABLE

Enable sequencer control of switch.

enum cy_en_sar_switch_register_sel_t

cy_en_sar_switch_register_sel_t: Switch register selection for Cy_SAR_SetAnalogSwitch and Cy_SAR_GetAnalogSwitch.

Values:

enumerator CY_SAR_MUX_SWITCH0

SARMUX switch control register.

enum cy_en_sar_clock_source_t

cy_en_sar_clock_source_t: For PASS_V2 the SAR clock can come from:

  • one of the CLK_PERI dividers

  • PASS Deep Sleep Clock (CLK_DPSLP)

Values:

enumerator CY_SAR_CLK_PERI

SAR clock source is one of PERI dividers (SAR is only operational in chip ACTIVE mode)

enumerator CY_SAR_CLK_DEEPSLEEP

SAR clock source is CLK_DPSLP (SAR can be operational in both chip ACTIVE and DEEPSLEEP modes)

enum cy_en_sar_simult_trig_event_sel_t

cy_en_sar_simult_trig_event_sel_t: Definitions for simultaneous scan trigger signal event selection.

Values:

enumerator CY_SAR_SIMULT_TRIG_EVENT_EDGE

Positive edge detected on the trigger signal triggers a new scan.

enumerator CY_SAR_SIMULT_TRIG_EVENT_LEVEL

SAR will do continuous scans as long as the trigger signal remains high.

enum cy_en_sar_simult_trig_sync_sel_t

cy_en_sar_simult_trig_sync_sel_t: Definitions for simultaneous scan trigger synchronization.

Values:

enumerator CY_SAR_SIMULT_TRIG_SYNC_NONE

Bypass clock domain synchronization of the simultaneous trigger signal.

enumerator CY_SAR_SIMULT_TRIG_SYNC_SAR_CLOCK

Synchronize the simultaneous trigger signal to the SAR clock domain.

enum cy_en_sar_simult_trig_sample_sel_t

cy_en_sar_simult_trig_sample_sel_t: Definitions for simultaneous scan sampling mode.

Values:

enumerator CY_SAR_SIMULT_TRIG_SAMPLE_SINGLE

Perform single scan on the trigger event.

enumerator CY_SAR_SIMULT_TRIG_SAMPLE_SCAN_CNT

On the trigger event perform number of scans, specified by scanCount.

enum cy_en_sar_simult_trig_intr_sel_t

cy_en_sar_simult_trig_intr_sel_t: Definitions for simultaneous scan interrupt generation.

Values:

enumerator CY_SAR_SIMULT_TRIG_INTR_EOS

Generate interrupt on each End of Sample event.

enumerator CY_SAR_SIMULT_TRIG_INTR_SCAN_CNT

Generate interrupt on End of Sample event only when sample number = scanCount.