Cypress CapSense Middleware Library
Settings Macros

General Description

Settings macros.

Macros

#define CY_CAPSENSE_CSD_SENSING_METHOD   (0u)
 CSD Sensing method.
 
#define CY_CAPSENSE_CSX_SENSING_METHOD   (1u)
 CSX Sensing method.
 
#define CY_CAPSENSE_CSD_SS_DIS   (0x00uL)
 Manual tunning mode.
 
#define CY_CAPSENSE_CSD_SS_HW_EN   (0x01uL)
 Hardware auto-tune mask.
 
#define CY_CAPSENSE_CSD_SS_TH_EN   (0x02uL)
 Threshold auto-tune mask.
 
#define CY_CAPSENSE_CSD_SS_HWTH_EN   (CY_CAPSENSE_CSD_SS_HW_EN | CY_CAPSENSE_CSD_SS_TH_EN)
 Full auto-tune is enabled.
 
#define CY_CAPSENSE_FREQ_CHANNELS_NUM   (3u)
 Number of multi-frequency scan channels.
 
#define CY_CAPSENSE_MFS_CH0_INDEX   (0u)
 Multi-frequency channel 0 constant.
 
#define CY_CAPSENSE_MFS_CH1_INDEX   (1u)
 Multi-frequency channel 1 constant.
 
#define CY_CAPSENSE_MFS_CH2_INDEX   (2u)
 Multi-frequency channel 2 constant.
 
#define CY_CAPSENSE_SNS_CONNECTION_GROUND   (1u)
 Inactive sensor connection to ground.
 
#define CY_CAPSENSE_SNS_CONNECTION_HIGHZ   (2u)
 Inactive sensor connection to high-z.
 
#define CY_CAPSENSE_SNS_CONNECTION_SHIELD   (3u)
 Inactive sensor connection to shield.
 
#define CY_CAPSENSE_SH_DELAY_0NS   (0u)
 No shield signal delay.
 
#define CY_CAPSENSE_SH_DELAY_5NS   (1u)
 Shield signal delay > 5 ns.
 
#define CY_CAPSENSE_SH_DELAY_10NS   (2u)
 Shield signal delay > 10 ns.
 
#define CY_CAPSENSE_SH_DELAY_20NS   (3u)
 Shield signal delay > 20 ns.
 
#define CY_CAPSENSE_IDAC_SOURCING   (0u)
 Idac sourcing.
 
#define CY_CAPSENSE_IDAC_SINKING   (1u)
 Idac sinking.
 
#define CY_CAPSENSE_CSH_PRECHARGE_VREF   (0u)
 Shield tank capacitor pre-charge from Vref.
 
#define CY_CAPSENSE_CSH_PRECHARGE_IO_BUF   (1u)
 Shield tank capacitor pre-charge from IO buffer.
 
#define CY_CAPSENSE_CLK_SOURCE_AUTO_MASK   (0x80u)
 Auto-mode of clock source selection mask.
 
#define CY_CAPSENSE_CLK_SOURCE_DIRECT   (0x00u)
 Clock source direct.
 
#define CY_CAPSENSE_CLK_SOURCE_SSC6   (0x01u)
 Clock source SSC6.
 
#define CY_CAPSENSE_CLK_SOURCE_SSC7   (0x02u)
 Clock source SSC7.
 
#define CY_CAPSENSE_CLK_SOURCE_SSC9   (0x03u)
 Clock source SSC9.
 
#define CY_CAPSENSE_CLK_SOURCE_SSC10   (0x04u)
 Clock source SSC10.
 
#define CY_CAPSENSE_CLK_SOURCE_PRS8   (0x05u)
 Clock source PRS8.
 
#define CY_CAPSENSE_CLK_SOURCE_PRS12   (0x06u)
 Clock source PRS12.
 
#define CY_CAPSENSE_INIT_SW_RES_LOW   (0x00000000uL)
 Low switch resistance at initialization.
 
#define CY_CAPSENSE_INIT_SW_RES_MEDIUM   (0x00000001uL)
 Medium switch resistance at initialization.
 
#define CY_CAPSENSE_INIT_SW_RES_HIGH   (0x00000002uL)
 High switch resistance at initialization.
 
#define CY_CAPSENSE_SCAN_SW_RES_LOW   (0x00000000uL)
 Low switch resistance at scanning.
 
#define CY_CAPSENSE_SCAN_SW_RES_MEDIUM   (0x00000001uL)
 Medium switch resistance at scanning.
 
#define CY_CAPSENSE_SCAN_SW_RES_HIGH   (0x00000002uL)
 High switch resistance at scanning.
 
#define CY_CAPSENSE_SHIELD_SW_RES_LOW   (0x00000000uL)
 Low shield switch resistance.
 
#define CY_CAPSENSE_SHIELD_SW_RES_MEDIUM   (0x00000001uL)
 Medium shield switch resistance.
 
#define CY_CAPSENSE_SHIELD_SW_RES_HIGH   (0x00000002uL)
 High shield switch resistance.
 
#define CY_CAPSENSE_SHIELD_SW_RES_LOW_EMI   (0x00000003uL)
 Low-EMI shield switch resistance.
 
#define CY_CAPSENSE_VREF_SRSS   (0x00000000uL)
 Vref source is taken from SRSS.
 
#define CY_CAPSENSE_VREF_PASS   (0x00000001uL)
 Vref source is taken from PASS.
 
#define CY_CAPSENSE_IREF_SRSS   (0x00000000uL)
 Iref source is taken from SRSS.
 
#define CY_CAPSENSE_IREF_PASS   (0x00000001uL)
 Iref source is taken from PASS.
 
#define CY_CAPSENSE_POSITION_FILTERS_MASK   (0x000000FFu)
 Mask of all filters enabling.
 
#define CY_CAPSENSE_POSITION_MED_MASK   (0x00000001u)
 Median position filter enable mask.
 
#define CY_CAPSENSE_POSITION_IIR_MASK   (0x00000002u)
 IIR position filter enable mask.
 
#define CY_CAPSENSE_POSITION_AIIR_MASK   (0x00000004u)
 Adaptive IIR position filter enable mask.
 
#define CY_CAPSENSE_POSITION_AVG_MASK   (0x00000008u)
 Average position filter enable mask.
 
#define CY_CAPSENSE_POSITION_JIT_MASK   (0x00000010u)
 Jitter position filter enable mask.
 
#define CY_CAPSENSE_POSITION_FILTERS_SIZE_MASK   (0x0000FF00u)
 Mask of position filters history size.
 
#define CY_CAPSENSE_POSITION_FILTERS_SIZE_OFFSET   (8u)
 Offset of position filters history size.
 
#define CY_CAPSENSE_POSITION_IIR_COEFF_MASK   (0x00FF0000u)
 Mask of IIR coefficient of position filter.
 
#define CY_CAPSENSE_POSITION_IIR_COEFF_OFFSET   (16u)
 Offset of IIR coefficient of position filter.
 
#define CY_CAPSENSE_RC_FILTER_SNS_HISTORY_SIZE_OFFSET   (0u)
 Offset of raw count filter history size.
 
#define CY_CAPSENSE_RC_FILTER_MEDIAN_EN_OFFSET   (4u)
 Offset of raw count median filter enable mask.
 
#define CY_CAPSENSE_RC_FILTER_MEDIAN_MODE_OFFSET   (5u)
 Offset of raw count median filter mode mask.
 
#define CY_CAPSENSE_RC_FILTER_IIR_EN_OFFSET   (7u)
 Offset of raw count IIR filter enable mask.
 
#define CY_CAPSENSE_RC_FILTER_IIR_MODE_OFFSET   (8u)
 Offset of raw count IIR filter mode mask.
 
#define CY_CAPSENSE_RC_FILTER_AVERAGE_EN_OFFSET   (10u)
 Offset of raw count average filter enable mask.
 
#define CY_CAPSENSE_RC_FILTER_AVERAGE_MODE_OFFSET   (11u)
 Offset of raw count average filter mode mask.
 
#define CY_CAPSENSE_RC_FILTER_SNS_HISTORY_SIZE_MASK   ((uint16_t)((uint16_t)0x000Fu << CY_CAPSENSE_RC_FILTER_SNS_HISTORY_SIZE_OFFSET))
 Mask of raw count filter history size.
 
#define CY_CAPSENSE_RC_FILTER_MEDIAN_EN_MASK   ((uint16_t)((uint16_t)0x0001u << CY_CAPSENSE_RC_FILTER_MEDIAN_EN_OFFSET))
 Median raw count filter enable mask.
 
#define CY_CAPSENSE_RC_FILTER_MEDIAN_MODE_MASK   ((uint16_t)((uint16_t)0x0003u << CY_CAPSENSE_RC_FILTER_MEDIAN_MODE_OFFSET))
 Median raw count filter mode mask.
 
#define CY_CAPSENSE_RC_FILTER_IIR_EN_MASK   ((uint16_t)((uint16_t)0x0001u << CY_CAPSENSE_RC_FILTER_IIR_EN_OFFSET))
 IIR raw count filter enable mask.
 
#define CY_CAPSENSE_RC_FILTER_IIR_MODE_MASK   ((uint16_t)((uint16_t)0x0003u << CY_CAPSENSE_RC_FILTER_IIR_MODE_OFFSET))
 IIR raw count filter mode mask.
 
#define CY_CAPSENSE_RC_FILTER_AVERAGE_EN_MASK   ((uint16_t)((uint16_t)0x0001u << CY_CAPSENSE_RC_FILTER_AVERAGE_EN_OFFSET))
 Average raw count filter enable mask.
 
#define CY_CAPSENSE_RC_FILTER_AVERAGE_MODE_MASK   ((uint16_t)((uint16_t)0x0003u << CY_CAPSENSE_RC_FILTER_AVERAGE_MODE_OFFSET))
 Average raw count filter mode mask.
 
#define CY_CAPSENSE_RC_FILTER_ALL_EN_MASK
 All raw count filters enable mask. More...
 
#define CY_CAPSENSE_IIR_FILTER_STANDARD   ((uint16_t)((uint16_t)1u << CY_CAPSENSE_RC_FILTER_IIR_MODE_OFFSET))
 Raw count IIR filter mode standard.
 
#define CY_CAPSENSE_IIR_FILTER_PERFORMANCE   ((uint16_t)((uint16_t)2u << CY_CAPSENSE_RC_FILTER_IIR_MODE_OFFSET))
 Raw count IIR filter mode performance.
 
#define CY_CAPSENSE_AVERAGE_FILTER_LEN_4   ((uint16_t)((uint16_t)2u << CY_CAPSENSE_RC_FILTER_AVERAGE_MODE_OFFSET))
 Raw count average filter mode.
 

Macro Definition Documentation

◆ CY_CAPSENSE_RC_FILTER_ALL_EN_MASK

#define CY_CAPSENSE_RC_FILTER_ALL_EN_MASK
Value:
CY_CAPSENSE_RC_FILTER_IIR_EN_MASK |\
CY_CAPSENSE_RC_FILTER_AVERAGE_EN_OFFSET)
#define CY_CAPSENSE_RC_FILTER_MEDIAN_EN_MASK
Median raw count filter enable mask.
Definition: cy_capsense_common.h:225

All raw count filters enable mask.