Control Register Enums

group group_sar_ctrl_register_enums

This set of enumerations aids in configuring the SAR CTRL register.

Enums

enum cy_en_sar_ctrl_pwr_ctrl_vref_t

cy_en_sar_ctrl_pwr_ctrl_vref_t: Reference voltage buffer power mode definitions.

Values:

enumerator CY_SAR_VREF_PWR_100

Full power (100%)

enumerator CY_SAR_VREF_PWR_80

80% power

enumerator CY_SAR_VREF_PWR_60

60% power

enumerator CY_SAR_VREF_PWR_50

50% power

enumerator CY_SAR_VREF_PWR_40

40% power

enumerator CY_SAR_VREF_PWR_30

30% power

enumerator CY_SAR_VREF_PWR_20

20% power

enumerator CY_SAR_VREF_PWR_10

10% power

enum cy_en_sar_ctrl_vref_sel_t

cy_en_sar_ctrl_vref_sel_t: Reference voltage selection definitions.

Values:

enumerator CY_SAR_VREF_SEL_BGR

System wide bandgap from AREF (Vref buffer on)

enumerator CY_SAR_VREF_SEL_EXT

External Vref direct from a pin.

enumerator CY_SAR_VREF_SEL_VDDA_DIV_2

Vdda/2 (Vref buffer on)

enumerator CY_SAR_VREF_SEL_VDDA

Vdda.

enum cy_en_sar_ctrl_bypass_cap_t

cy_en_sar_ctrl_bypass_cap_t: Vref bypass cap enable.

When enabled, a bypass capacitor should be connected to the dedicated Vref pin of the device. Refer to the device datasheet for the minimum bypass capacitor value to use.

Values:

enumerator CY_SAR_BYPASS_CAP_DISABLE

Disable Vref bypass cap.

enumerator CY_SAR_BYPASS_CAP_ENABLE

Enable Vref bypass cap.

enum cy_en_sar_ctrl_neg_sel_t

cy_en_sar_ctrl_neg_sel_t: Negative terminal (Vminus) selection definitions for single-ended channels.

The Vminus input for single ended channels can be connected to Vref, VSSA, or routed out to an external pin. The options for routing to a pin are through Pin 1, Pin 3, Pin 5, or Pin 7 of the SARMUX dedicated port or an acore wire in AROUTE, if available on the device.

CY_SAR_NEG_SEL_VSSA_KELVIN comes straight from a Vssa pad without any shared branches so as to keep quiet and avoid voltage drops.

Values:

enumerator CY_SAR_NEG_SEL_VSSA_KELVIN

Connect Vminus to VSSA_KELVIN.

enumerator CY_SAR_NEG_SEL_P1

Connect Vminus to Pin 1 of SARMUX dedicated port.

enumerator CY_SAR_NEG_SEL_P3

Connect Vminus to Pin 3 of SARMUX dedicated port.

enumerator CY_SAR_NEG_SEL_P5

Connect Vminus to Pin 5 of SARMUX dedicated port.

enumerator CY_SAR_NEG_SEL_P7

Connect Vminus to Pin 6 of SARMUX dedicated port.

enumerator CY_SAR_NEG_SEL_ACORE

Connect Vminus to an ACORE in AROUTE.

enumerator CY_SAR_NEG_SEL_VREF

Connect Vminus to VREF input of SARADC.

enum cy_en_sar_ctrl_hw_ctrl_negvref_t

cy_en_sar_ctrl_hw_ctrl_negvref_t: Enable hardware control of the switch between Vref and the Vminus input.

Values:

enumerator CY_SAR_CTRL_NEGVREF_FW_ONLY

Only firmware control of the switch.

enumerator CY_SAR_CTRL_NEGVREF_HW

Enable hardware control of the switch.

enum cy_en_sar_ctrl_comp_delay_t

cy_en_sar_ctrl_comp_delay_t: Configure the comparator latch delay.

Values:

enumerator CY_SAR_CTRL_COMP_DLY_2P5

2.5 ns delay, use for SAR conversion rate up to 2.5 Msps

enumerator CY_SAR_CTRL_COMP_DLY_4

4 ns delay, use for SAR conversion rate up to 2.0 Msps

enumerator CY_SAR_CTRL_COMP_DLY_10

10 ns delay, use for SAR conversion rate up to 1.5 Msps

enumerator CY_SAR_CTRL_COMP_DLY_12

12 ns delay, use for SAR conversion rate up to 1 Msps

enum cy_en_sar_ctrl_comp_pwr_t

cy_en_sar_ctrl_comp_pwr_t: Configure the comparator power mode.

Values:

enumerator CY_SAR_COMP_PWR_100

100% power, use this for > 2 Msps

enumerator CY_SAR_COMP_PWR_80

80% power, use this for 1.5 - 2 Msps

enumerator CY_SAR_COMP_PWR_60

60% power, use this for 1.0 - 1.5 Msps

enumerator CY_SAR_COMP_PWR_50

50% power, use this for 500 ksps - 1 Msps

enumerator CY_SAR_COMP_PWR_40

40% power, use this for 250 - 500 ksps

enumerator CY_SAR_COMP_PWR_30

30% power, use this for 100 - 250 ksps

enumerator CY_SAR_COMP_PWR_20

20% power, use this for TDB sps

enumerator CY_SAR_COMP_PWR_10

10% power, use this for < 100 ksps

enum cy_en_sar_ctrl_sarmux_deep_sleep_t

cy_en_sar_ctrl_sarmux_deep_sleep_t: Enable or disable the SARMUX during Deep Sleep power mode.

Values:

enumerator CY_SAR_DEEPSLEEP_SARMUX_OFF

Disable SARMUX operation during Deep Sleep.

enumerator CY_SAR_DEEPSLEEP_SARMUX_ON

Enable SARMUX operation during Deep Sleep.

enum cy_en_sar_ctrl_sarseq_routing_switches_t

cy_en_sar_ctrl_sarseq_routing_switches_t: Enable or disable the SARSEQ control of routing switches.

Values:

enumerator CY_SAR_SARSEQ_SWITCH_ENABLE

Enable the SARSEQ to change the routing switches defined in the channel configurations.

enumerator CY_SAR_SARSEQ_SWITCH_DISABLE

Disable the SARSEQ.

It is up to the firmware to set the routing switches