Settings Macros

group group_capsense_macros_settings

Settings macros.

Defines

CY_CAPSENSE_SCAN_MODE_INT_DRIVEN

Interrupt Driven scanning mode.

CY_CAPSENSE_SCAN_MODE_DMA_DRIVEN

DMA Driven scanning mode.

CY_CAPSENSE_AMUX_SENSOR_CONNECTION_METHOD

Sensor connection method through analog mux bus.

CY_CAPSENSE_CTRLMUX_SENSOR_CONNECTION_METHOD

Sensor connection method through control mux switches.

CY_CAPSENSE_CIC_FILTER

CIC filter mode.

CY_CAPSENSE_CIC2_FILTER

CIC2 filter mode.

CY_CAPSENSE_COUNTER_MODE_SATURATE

Raw count counter mode saturate.

CY_CAPSENSE_COUNTER_MODE_OVERFLOW

Raw count counter mode overflow.

CY_CAPSENSE_SYNC_MODE_OFF

Synchronization mode is disabled.

CY_CAPSENSE_SYNC_EXTERNAL

Synchronization is external.

CY_CAPSENSE_SYNC_INTERNAL

Synchronization is internal.

CY_CAPSENSE_CSD_GROUP

CSD sensing group.

CY_CAPSENSE_CSX_GROUP

CSX sensing group.

CY_CAPSENSE_CSD_SENSING_METHOD

CSD sensing method.

CY_CAPSENSE_CSX_RM_SENSING_METHOD

CSX Ratio Metric sensing method.

CY_CAPSENSE_CSD_RM_SENSING_METHOD

CSD Ratio Metric sensing method.

CY_CAPSENSE_SENSING_METHOD_UNDEFINED

Sensing method undefined used at initialization.

CY_CAPSENSE_SENSING_METHOD_NUMBER

Total number of modes.

CY_CAPSENSE_REG_MODE_UNDEFINED

Sensing mode undefined.

CY_CAPSENSE_REG_MODE_CSD

CSD sensing mode.

CY_CAPSENSE_REG_MODE_CSX_RM

CSX Ratio Metric sensing mode.

CY_CAPSENSE_REG_MODE_CSD_RM

CSD Ratio Metric sensing mode.

CY_CAPSENSE_REG_MODE_CSD_DITHERING

CSD sensing mode with CapDAC dithering enabled.

CY_CAPSENSE_REG_MODE_CSX_RM_DITHERING

CSX Ratio Metric sensing mode with CapDAC dithering enabled.

CY_CAPSENSE_REG_MODE_CSD_RM_DITHERING

CSD Ratio Metric sensing mode with CapDAC dithering enabled.

CY_CAPSENSE_REG_MODE_BASE_NUMBER

Number of base sensing modes.

CY_CAPSENSE_REG_MODE_NUMBER

Total number of modes.

CY_CAPSENSE_CTRLMUX_STATE_RX

Control mux switch state defined as CSX Rx electrode.

CY_CAPSENSE_CTRLMUX_STATE_TX

Control mux switch state defined as CSX Tx electrode.

CY_CAPSENSE_CTRLMUX_STATE_GND

Control mux switch state is ground.

CY_CAPSENSE_CTRLMUX_STATE_SNS

Control mux switch state defined as CSD sensor.

CY_CAPSENSE_CTRLMUX_STATE_HIGH_Z

Control mux switch state is High-Z.

CY_CAPSENSE_CTRLMUX_STATE_SHIELD

Control mux switch state defined as connection to shield signal.

CY_CAPSENSE_CTRLMUX_STATE_TX_NEGATIVE

Control mux switch state defined as CSX Negative Tx electrode.

CY_CAPSENSE_PIN_STATE_FUNC_LIMIT

Number of supported pin states for smaller sensor configuration with 5 registers.

CY_CAPSENSE_PIN_STATE_NUMBER

Number of total possible pin states.

CY_CAPSENSE_CSD_SS_DIS

Manual tunning mode.

CY_CAPSENSE_CSD_SS_HW_EN

Hardware auto-tune mask.

CY_CAPSENSE_CSD_SS_TH_EN

Threshold auto-tune mask.

CY_CAPSENSE_CSD_SS_HWTH_EN

Full auto-tune is enabled.

CY_CAPSENSE_FREQ_CHANNELS_NUM

Number of multi-frequency scan channels.

CY_CAPSENSE_MFS_CH0_INDEX

Multi-frequency channel 0 constant.

CY_CAPSENSE_MFS_CH1_INDEX

Multi-frequency channel 1 constant.

CY_CAPSENSE_MFS_CH2_INDEX

Multi-frequency channel 2 constant.

CY_CAPSENSE_SNS_CONNECTION_GROUND

Inactive sensor connection to ground.

CY_CAPSENSE_SNS_CONNECTION_HIGHZ

Inactive sensor connection to High-Z.

CY_CAPSENSE_SNS_CONNECTION_SHIELD

Inactive sensor connection to shield.

CY_CAPSENSE_SNS_CONNECTION_UNDEFINED

Inactive sensor connection undefined.

CY_CAPSENSE_SH_DELAY_0NS

No shield signal delay.

CY_CAPSENSE_SH_DELAY_5NS

Shield signal delay > 5 ns.

CY_CAPSENSE_SH_DELAY_10NS

Shield signal delay > 10 ns.

CY_CAPSENSE_SH_DELAY_20NS

Shield signal delay > 20 ns.

CY_CAPSENSE_IDAC_SOURCING

Idac sourcing.

CY_CAPSENSE_IDAC_SINKING

Idac sinking.

CY_CAPSENSE_CSH_PRECHARGE_VREF

Shield tank capacitor pre-charge from Vref.

CY_CAPSENSE_CSH_PRECHARGE_IO_BUF

Shield tank capacitor pre-charge from IO buffer.

CY_CAPSENSE_CLK_SOURCE_AUTO_MASK

Auto-mode of clock source selection mask.

CY_CAPSENSE_CLK_SOURCE_MASK

Clock source selection mask.

CY_CAPSENSE_CLK_SOURCE_DIRECT

Clock source direct.

CY_CAPSENSE_CLK_SOURCE_SSC6

Clock source SSC6.

CY_CAPSENSE_CLK_SOURCE_SSC7

Clock source SSC7.

CY_CAPSENSE_CLK_SOURCE_SSC9

Clock source SSC9.

CY_CAPSENSE_CLK_SOURCE_SSC10

Clock source SSC10.

CY_CAPSENSE_CLK_SOURCE_PRS8

Clock source PRS8.

CY_CAPSENSE_CLK_SOURCE_PRS12

Clock source PRS12.

CY_CAPSENSE_CLK_SOURCE_SMARTSENSE_MASK

SmartSense Clock Source reserved bits.

CY_CAPSENSE_CLK_SOURCE_SMARTSENSE_POS

SmartSense Clock Source reserved bits position.

CY_CAPSENSE_CLK_SOURCE_SSC

Clock source SSC.

CY_CAPSENSE_CLK_SOURCE_PRS

Clock source PRS.

CY_CAPSENSE_CLK_SOURCE_SSC_AUTO_MASK

Clock source SSC auto-selection mask.

CY_CAPSENSE_CLK_SOURCE_SSC_AUTO

Clock source SSC auto-selection.

CY_CAPSENSE_CLK_SOURCE_PRS_AUTO_MASK

Clock source PRS auto-selection mask.

CY_CAPSENSE_CLK_SOURCE_PRS_AUTO

Clock source PRS auto-selection.

CY_CAPSENSE_LFSR_BITS_AUTO_MASK

LFSR range auto-selection mask.

CY_CAPSENSE_LFSR_BITS_RANGE_MASK

LFSR range mask.

CY_CAPSENSE_LFSR_BITS_AUTO

LFSR range auto-selection.

CY_CAPSENSE_LFSR_BITS_RANGE_0

LFSR range for LFSR_BITS=0.

CY_CAPSENSE_LFSR_BITS_RANGE_1

LFSR range for LFSR_BITS=1.

CY_CAPSENSE_LFSR_BITS_RANGE_2

LFSR range for LFSR_BITS=2.

CY_CAPSENSE_LFSR_BITS_RANGE_3

LFSR range for LFSR_BITS=3.

CY_CAPSENSE_SNS_CLK_SOURCE_AUTO_SEL_MODE_STRONG

This mode implements checking the following rules:

  • An LFSR value should be selected so that the max clock dither is limited with the value, specified by the LFSR Dither Limit parameter.

  • At least one full spread spectrum polynomial should pass during the scan time.

  • The value of the number of conversions should be an integer multiple of the repeat period of the polynomial, that is specified by the Sense Clock LFSR Polynomial parameter.

CY_CAPSENSE_SNS_CLK_SOURCE_AUTO_SEL_MODE_MEDIUM

This mode implements checking the following rules:

  • An LFSR value should be selected so that the max clock dither is limited with the value, specified by the LFSR Dither Limit parameter.

  • At least one full spread spectrum polynomial should pass during the scan time.

CY_CAPSENSE_SNS_CLK_SOURCE_AUTO_SEL_MODE_WEAK

This mode implements checking the following rules:

  • An LFSR value should be selected so that the max clock dither is limited with the value, specified by the LFSR Dither Limit parameter.

CY_CAPSENSE_INIT_SW_RES_LOW

Low switch resistance at initialization.

CY_CAPSENSE_INIT_SW_RES_MEDIUM

Medium switch resistance at initialization.

CY_CAPSENSE_INIT_SW_RES_HIGH

High switch resistance at initialization.

CY_CAPSENSE_SCAN_SW_RES_LOW

Low switch resistance at scanning.

CY_CAPSENSE_SCAN_SW_RES_MEDIUM

Medium switch resistance at scanning.

CY_CAPSENSE_SCAN_SW_RES_HIGH

High switch resistance at scanning.

CY_CAPSENSE_SHIELD_SW_RES_LOW

Low shield switch resistance.

CY_CAPSENSE_SHIELD_SW_RES_MEDIUM

Medium shield switch resistance.

CY_CAPSENSE_SHIELD_SW_RES_HIGH

High shield switch resistance.

CY_CAPSENSE_SHIELD_SW_RES_LOW_EMI

Low-EMI shield switch resistance.

CY_CAPSENSE_SHIELD_DISABLED

Shield disabled.

CY_CAPSENSE_SHIELD_ACTIVE

Active shield mode.

CY_CAPSENSE_SHIELD_PASSIVE

Passive shield mode.

CY_CAPSENSE_VREF_SRSS

Vref source is taken from SRSS.

CY_CAPSENSE_VREF_PASS

Vref source is taken from PASS.

CY_CAPSENSE_IREF_SRSS

Iref source is taken from SRSS.

CY_CAPSENSE_IREF_PASS

Iref source is taken from PASS.

CY_CAPSENSE_LOW_VOLTAGE_LIMIT

Voltage limit to switch to low-voltage configuration.

CY_CAPSENSE_POSITION_FILTERS_MASK

Mask of all filters enabling.

CY_CAPSENSE_POSITION_MED_MASK

Median position filter enable mask.

CY_CAPSENSE_POSITION_IIR_MASK

IIR position filter enable mask.

CY_CAPSENSE_POSITION_AIIR_MASK

Adaptive IIR position filter enable mask.

CY_CAPSENSE_POSITION_AVG_MASK

Average position filter enable mask.

CY_CAPSENSE_POSITION_JIT_MASK

Jitter position filter enable mask.

CY_CAPSENSE_POSITION_FILTERS_SIZE_MASK

Mask of position filters history size.

CY_CAPSENSE_POSITION_FILTERS_SIZE_OFFSET

Offset of position filters history size.

CY_CAPSENSE_POSITION_IIR_COEFF_MASK

Mask of IIR coefficient of position filter.

CY_CAPSENSE_POSITION_IIR_COEFF_OFFSET

Offset of IIR coefficient of position filter.

CY_CAPSENSE_RC_FILTER_SNS_HISTORY_SIZE_OFFSET

Offset of raw count filter history size.

CY_CAPSENSE_RC_FILTER_MEDIAN_EN_OFFSET

Offset of raw count median filter enable mask.

CY_CAPSENSE_RC_FILTER_MEDIAN_MODE_OFFSET

Offset of raw count median filter mode mask.

CY_CAPSENSE_RC_FILTER_IIR_EN_OFFSET

Offset of raw count IIR filter enable mask.

CY_CAPSENSE_RC_FILTER_IIR_MODE_OFFSET

Offset of raw count IIR filter mode mask.

CY_CAPSENSE_RC_FILTER_AVERAGE_EN_OFFSET

Offset of raw count average filter enable mask.

CY_CAPSENSE_RC_FILTER_AVERAGE_MODE_OFFSET

Offset of raw count average filter mode mask.

CY_CAPSENSE_RC_FILTER_SNS_HISTORY_SIZE_MASK

Mask of raw count filter history size.

CY_CAPSENSE_RC_FILTER_MEDIAN_EN_MASK

Median raw count filter enable mask.

CY_CAPSENSE_RC_FILTER_MEDIAN_MODE_MASK

Median raw count filter mode mask.

CY_CAPSENSE_RC_FILTER_IIR_EN_MASK

IIR raw count filter enable mask.

CY_CAPSENSE_RC_FILTER_IIR_MODE_MASK

IIR raw count filter mode mask.

CY_CAPSENSE_RC_FILTER_AVERAGE_EN_MASK

Average raw count filter enable mask.

CY_CAPSENSE_RC_FILTER_AVERAGE_MODE_MASK

Average raw count filter mode mask.

CY_CAPSENSE_RC_FILTER_ALL_EN_MASK

All raw count filters enable mask.

CY_CAPSENSE_IIR_FILTER_STANDARD

Raw count IIR filter mode standard.

CY_CAPSENSE_IIR_FILTER_PERFORMANCE

Raw count IIR filter mode performance.

CY_CAPSENSE_AVERAGE_FILTER_LEN_4

Raw count average filter mode.