PSoC 6 Peripheral Driver Library
All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
Control Register Enums

General Description

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

Enumerations

enum  cy_en_sar_ctrl_pwr_ctrl_vref_t {
  CY_SAR_VREF_PWR_100 = 0uL << SAR_CTRL_PWR_CTRL_VREF_Pos,
  CY_SAR_VREF_PWR_80 = 1uL << SAR_CTRL_PWR_CTRL_VREF_Pos,
  CY_SAR_VREF_PWR_60 = 2uL << SAR_CTRL_PWR_CTRL_VREF_Pos,
  CY_SAR_VREF_PWR_50 = 3uL << SAR_CTRL_PWR_CTRL_VREF_Pos,
  CY_SAR_VREF_PWR_40 = 4uL << SAR_CTRL_PWR_CTRL_VREF_Pos,
  CY_SAR_VREF_PWR_30 = 5uL << SAR_CTRL_PWR_CTRL_VREF_Pos,
  CY_SAR_VREF_PWR_20 = 6uL << SAR_CTRL_PWR_CTRL_VREF_Pos,
  CY_SAR_VREF_PWR_10 = 7uL << SAR_CTRL_PWR_CTRL_VREF_Pos
}
 Reference voltage buffer power mode definitions. More...
 
enum  cy_en_sar_ctrl_vref_sel_t {
  CY_SAR_VREF_SEL_BGR = 4uL << SAR_CTRL_VREF_SEL_Pos,
  CY_SAR_VREF_SEL_EXT = 5uL << SAR_CTRL_VREF_SEL_Pos,
  CY_SAR_VREF_SEL_VDDA_DIV_2 = 6uL << SAR_CTRL_VREF_SEL_Pos,
  CY_SAR_VREF_SEL_VDDA = 7uL << SAR_CTRL_VREF_SEL_Pos
}
 Reference voltage selection definitions. More...
 
enum  cy_en_sar_ctrl_bypass_cap_t {
  CY_SAR_BYPASS_CAP_DISABLE = 0uL << SAR_CTRL_VREF_BYP_CAP_EN_Pos,
  CY_SAR_BYPASS_CAP_ENABLE = 1uL << SAR_CTRL_VREF_BYP_CAP_EN_Pos
}
 Vref bypass cap enable. More...
 
enum  cy_en_sar_ctrl_neg_sel_t {
  CY_SAR_NEG_SEL_VSSA_KELVIN = 0uL << SAR_CTRL_NEG_SEL_Pos,
  CY_SAR_NEG_SEL_P1 = 2uL << SAR_CTRL_NEG_SEL_Pos,
  CY_SAR_NEG_SEL_P3 = 3uL << SAR_CTRL_NEG_SEL_Pos,
  CY_SAR_NEG_SEL_P5 = 4uL << SAR_CTRL_NEG_SEL_Pos,
  CY_SAR_NEG_SEL_P7 = 5uL << SAR_CTRL_NEG_SEL_Pos,
  CY_SAR_NEG_SEL_ACORE = 6uL << SAR_CTRL_NEG_SEL_Pos,
  CY_SAR_NEG_SEL_VREF = 7uL << SAR_CTRL_NEG_SEL_Pos
}
 Negative terminal (Vminus) selection definitions for single-ended channels. More...
 
enum  cy_en_sar_ctrl_hw_ctrl_negvref_t {
  CY_SAR_CTRL_NEGVREF_FW_ONLY = 0uL << SAR_CTRL_SAR_HW_CTRL_NEGVREF_Pos,
  CY_SAR_CTRL_NEGVREF_HW = 1uL << SAR_CTRL_SAR_HW_CTRL_NEGVREF_Pos
}
 Enable hardware control of the switch between Vref and the Vminus input. More...
 
enum  cy_en_sar_ctrl_comp_delay_t {
  CY_SAR_CTRL_COMP_DLY_2P5 = 0uL << SAR_CTRL_COMP_DLY_Pos,
  CY_SAR_CTRL_COMP_DLY_4 = 1uL << SAR_CTRL_COMP_DLY_Pos,
  CY_SAR_CTRL_COMP_DLY_10 = 2uL << SAR_CTRL_COMP_DLY_Pos,
  CY_SAR_CTRL_COMP_DLY_12 = 3uL << SAR_CTRL_COMP_DLY_Pos
}
 Configure the comparator latch delay. More...
 
enum  cy_en_sar_ctrl_comp_pwr_t {
  CY_SAR_COMP_PWR_100 = 0uL << SAR_CTRL_COMP_PWR_Pos,
  CY_SAR_COMP_PWR_80 = 1uL << SAR_CTRL_COMP_PWR_Pos,
  CY_SAR_COMP_PWR_60 = 2uL << SAR_CTRL_COMP_PWR_Pos,
  CY_SAR_COMP_PWR_50 = 3uL << SAR_CTRL_COMP_PWR_Pos,
  CY_SAR_COMP_PWR_40 = 4uL << SAR_CTRL_COMP_PWR_Pos,
  CY_SAR_COMP_PWR_30 = 5uL << SAR_CTRL_COMP_PWR_Pos,
  CY_SAR_COMP_PWR_20 = 6uL << SAR_CTRL_COMP_PWR_Pos,
  CY_SAR_COMP_PWR_10 = 7uL << SAR_CTRL_COMP_PWR_Pos
}
 Configure the comparator power mode. More...
 
enum  cy_en_sar_ctrl_sarmux_deep_sleep_t {
  CY_SAR_DEEPSLEEP_SARMUX_OFF = 0uL << SAR_CTRL_DEEPSLEEP_ON_Pos,
  CY_SAR_DEEPSLEEP_SARMUX_ON = 1uL << SAR_CTRL_DEEPSLEEP_ON_Pos
}
 Enable or disable the SARMUX during Deep Sleep power mode. More...
 
enum  cy_en_sar_ctrl_sarseq_routing_switches_t {
  CY_SAR_SARSEQ_SWITCH_ENABLE = 0uL << SAR_CTRL_SWITCH_DISABLE_Pos,
  CY_SAR_SARSEQ_SWITCH_DISABLE = 1uL << SAR_CTRL_SWITCH_DISABLE_Pos
}
 Enable or disable the SARSEQ control of routing switches. More...
 

Enumeration Type Documentation

◆ cy_en_sar_ctrl_pwr_ctrl_vref_t

Reference voltage buffer power mode definitions.

Enumerator
CY_SAR_VREF_PWR_100 

Full power (100%)

CY_SAR_VREF_PWR_80 

80% power

CY_SAR_VREF_PWR_60 

60% power

CY_SAR_VREF_PWR_50 

50% power

CY_SAR_VREF_PWR_40 

40% power

CY_SAR_VREF_PWR_30 

30% power

CY_SAR_VREF_PWR_20 

20% power

CY_SAR_VREF_PWR_10 

10% power

◆ cy_en_sar_ctrl_vref_sel_t

Reference voltage selection definitions.

Enumerator
CY_SAR_VREF_SEL_BGR 

System wide bandgap from AREF (Vref buffer on)

CY_SAR_VREF_SEL_EXT 

External Vref direct from a pin.

CY_SAR_VREF_SEL_VDDA_DIV_2 

Vdda/2 (Vref buffer on)

CY_SAR_VREF_SEL_VDDA 

Vdda.

◆ 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.

Enumerator
CY_SAR_BYPASS_CAP_DISABLE 

Disable Vref bypass cap.

CY_SAR_BYPASS_CAP_ENABLE 

Enable Vref bypass cap.

◆ 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.

Enumerator
CY_SAR_NEG_SEL_VSSA_KELVIN 

Connect Vminus to VSSA_KELVIN.

CY_SAR_NEG_SEL_P1 

Connect Vminus to Pin 1 of SARMUX dedicated port.

CY_SAR_NEG_SEL_P3 

Connect Vminus to Pin 3 of SARMUX dedicated port.

CY_SAR_NEG_SEL_P5 

Connect Vminus to Pin 5 of SARMUX dedicated port.

CY_SAR_NEG_SEL_P7 

Connect Vminus to Pin 6 of SARMUX dedicated port.

CY_SAR_NEG_SEL_ACORE 

Connect Vminus to an ACORE in AROUTE.

CY_SAR_NEG_SEL_VREF 

Connect Vminus to VREF input of SARADC.

◆ cy_en_sar_ctrl_hw_ctrl_negvref_t

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

Enumerator
CY_SAR_CTRL_NEGVREF_FW_ONLY 

Only firmware control of the switch.

CY_SAR_CTRL_NEGVREF_HW 

Enable hardware control of the switch.

◆ cy_en_sar_ctrl_comp_delay_t

Configure the comparator latch delay.

Enumerator
CY_SAR_CTRL_COMP_DLY_2P5 

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

CY_SAR_CTRL_COMP_DLY_4 

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

CY_SAR_CTRL_COMP_DLY_10 

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

CY_SAR_CTRL_COMP_DLY_12 

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

◆ cy_en_sar_ctrl_comp_pwr_t

Configure the comparator power mode.

Enumerator
CY_SAR_COMP_PWR_100 

100% power, use this for > 2 Msps

CY_SAR_COMP_PWR_80 

80% power, use this for 1.5 - 2 Msps

CY_SAR_COMP_PWR_60 

60% power, use this for 1.0 - 1.5 Msps

CY_SAR_COMP_PWR_50 

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

CY_SAR_COMP_PWR_40 

40% power, use this for 250 - 500 ksps

CY_SAR_COMP_PWR_30 

30% power, use this for 100 - 250 ksps

CY_SAR_COMP_PWR_20 

20% power, use this for TDB sps

CY_SAR_COMP_PWR_10 

10% power, use this for < 100 ksps

◆ cy_en_sar_ctrl_sarmux_deep_sleep_t

Enable or disable the SARMUX during Deep Sleep power mode.

Enumerator
CY_SAR_DEEPSLEEP_SARMUX_OFF 

Disable SARMUX operation during Deep Sleep.

CY_SAR_DEEPSLEEP_SARMUX_ON 

Enable SARMUX operation during Deep Sleep.

◆ cy_en_sar_ctrl_sarseq_routing_switches_t

Enable or disable the SARSEQ control of routing switches.

Enumerator
CY_SAR_SARSEQ_SWITCH_ENABLE 

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

CY_SAR_SARSEQ_SWITCH_DISABLE 

Disable the SARSEQ.

It is up to the firmware to set the routing switches