Enumerated Types

group group_capsense_enums

Documents CapSense related enumerated types.

Enums

enum cy_en_capsense_bist_external_cap_id_t

cy_en_capsense_bist_external_cap_id_t: Defines IDs of the external capacitors.

Values:

enumerator CY_CAPSENSE_BIST_CMOD_ID_E

ID for Cmod external capacitor.

enumerator CY_CAPSENSE_BIST_CINTA_ID_E

ID for CintA external capacitor.

enumerator CY_CAPSENSE_BIST_CINTB_ID_E

ID for CintB external capacitor.

enumerator CY_CAPSENSE_BIST_CSH_ID_E

ID for Csh external capacitor.

enumerator RESERVED_ID_E

TBD.

enum cy_en_capsense_bist_external_cap_id_t

cy_en_capsense_bist_external_cap_id_t: Defines IDs of the external capacitors.

Values:

enumerator CY_CAPSENSE_BIST_CMOD_ID_E

ID for Cmod external capacitor.

enumerator CY_CAPSENSE_BIST_CINTA_ID_E

ID for CintA external capacitor.

enumerator CY_CAPSENSE_BIST_CINTB_ID_E

ID for CintB external capacitor.

enumerator CY_CAPSENSE_BIST_CSH_ID_E

ID for Csh external capacitor.

enumerator RESERVED_ID_E

TBD.

enum cy_en_capsense_tuner_state_t

cy_en_capsense_tuner_state_t: Defines MW Tuner module states.

Values:

enumerator CY_CAPSENSE_TU_FSM_RUNNING

Running state is a state when CapSense middleware is not blocked by the CapSense Tuner tool and application program continuously scans.

enumerator CY_CAPSENSE_TU_FSM_SUSPENDED

Scanning is suspended.

enumerator CY_CAPSENSE_TU_FSM_ONE_SCAN

Scanning is suspended after one scan cycle.

enum cy_en_capsense_tuner_cmd_t

cy_en_capsense_tuner_cmd_t: Defines the Tuner command codes.

Values:

enumerator CY_CAPSENSE_TU_CMD_NONE_E

No command.

enumerator CY_CAPSENSE_TU_CMD_SUSPEND_E

Suspend command.

enumerator CY_CAPSENSE_TU_CMD_RESUME_E

Resume command switches state from suspend to running.

enumerator CY_CAPSENSE_TU_CMD_RESTART_E

Restart command requests to perform CapSense re-initialization.

enumerator CY_CAPSENSE_TU_CMD_RUN_SNR_TEST_E

Reserved.

enumerator CY_CAPSENSE_TU_CMD_PING_E

Ping command to check whether application program calls Cy_CapSense_RunTuner()

enumerator CY_CAPSENSE_TU_CMD_ONE_SCAN_E

Execute one scan cycle and then switch to suspend state.

enumerator CY_CAPSENSE_TU_CMD_WRITE_E

Writes specified data with offset into cy_capsense_tuner.

enum cy_en_capsense_widget_type_t

cy_en_capsense_widget_type_t: Defines widget types.

Values:

enumerator CY_CAPSENSE_WD_BUTTON_E

Button widget.

enumerator CY_CAPSENSE_WD_LINEAR_SLIDER_E

Linear Slider widget.

enumerator CY_CAPSENSE_WD_RADIAL_SLIDER_E

Radial Slider widget.

enumerator CY_CAPSENSE_WD_MATRIX_BUTTON_E

Matrix Buttons widget.

enumerator CY_CAPSENSE_WD_TOUCHPAD_E

Touchpad widget.

enumerator CY_CAPSENSE_WD_PROXIMITY_E

Proximity widget.

enum cy_en_capsense_sensing_method_t

cy_en_capsense_sensing_method_t: Defines sensing methods types.

Values:

enumerator CY_CAPSENSE_UNDEFINED_E

Undefined method used at initialization or releasing the CSD HW block.

enumerator CY_CAPSENSE_SENSE_METHOD_CSD_E

CSD sensing method.

enumerator CY_CAPSENSE_SENSE_METHOD_CSX_E

CSX sensing method.

enumerator CY_CAPSENSE_SENSE_METHOD_BIST_E

BIST sensing method.

enum cy_en_capsense_return_status_t

cy_en_capsense_return_status_t: Defines CapSense return statuses types.

Values:

enumerator CY_CAPSENSE_SUCCESS_E

The success return status.

enumerator CY_CAPSENSE_BAD_PARAM_E

One or more invalid input parameters.

enumerator CY_CAPSENSE_HW_LOCKED_E

The CSD HW block is captured by another middleware.

enumerator CY_CAPSENSE_HW_BUSY_E

The CSD HW block is busy by previous operation.

enumerator CY_CAPSENSE_TIMEOUT_E

The CSD HW block operation was not finished correctly.

enum cy_en_capsense_eltd_t

cy_en_capsense_eltd_t: Defines types of electrode.

Values:

enumerator CY_CAPSENSE_ELTD_TYPE_SELF_E

Electrode used as a sensor in CSD sensing method.

enumerator CY_CAPSENSE_ELTD_TYPE_MUT_TX_E

Electrode used as a TX in CSX sensing method.

enumerator CY_CAPSENSE_ELTD_TYPE_MUT_RX_E

Electrode used as a RX in CSX sensing method.

enum cy_en_capsense_cap_connection_t

cy_en_capsense_cap_connection_t: Defines connections of sensing capacitors.

Values:

enumerator CY_CAPSENSE_CMODPAD_E

External capacitor is connected to dedicated CMOD pad.

enumerator CY_CAPSENSE_CTANKPAD_E

External capacitor is connected to dedicated CSH pad.

enumerator CY_CAPSENSE_CSHIELDPAD_E

External capacitor is connected to dedicated SHIELD pad.

enumerator CY_CAPSENSE_VREFEXTPAD_E

External capacitor is connected to dedicated VREF pad.

enum cy_en_capsense_callback_event_t

cy_en_capsense_callback_event_t: Defines CapSense middleware execution events when the CapSense callback can be executed.

Values:

enumerator CY_CAPSENSE_START_SAMPLE_E

Start Sample Callback.

The callback will be executed before each sensor scan triggering

enumerator CY_CAPSENSE_END_OF_SCAN_E

End Of Scan Callback.

The callback will be executed when sensor scan is finished and there is no other sensors in the queue to be scanned.

enum cy_en_capsense_bist_hw_config_t

cy_en_capsense_bist_hw_config_t: Defines HW configurations types for BIST operations.

Values:

enumerator CY_CAPSENSE_BIST_HW_UNDEFINED_E

Initialization or releasing the CSD HW block.

enumerator CY_CAPSENSE_BIST_HW_SHORT_E

Short tests.

enumerator CY_CAPSENSE_BIST_HW_ELTD_CAP_E

Sensor and shield electrodes capacitance measurements with disabled shield.

enumerator CY_CAPSENSE_BIST_HW_EXTERNAL_CAP_E

External capacitors capacitance measurements.

enumerator CY_CAPSENSE_BIST_HW_VDDA_E

VDDA measurement.

enumerator CY_CAPSENSE_BIST_HW_ELTD_CAP_SH_E

Sensor electrodes capacitance measurements with configured shield.

enum cy_en_capsense_bist_io_state_t

cy_en_capsense_bist_io_state_t: Defines BIST IO Configuration.

Values:

enumerator CY_CAPSENSE_BIST_IO_UNDEFINED_E

The undefined state.

Pins are disconnected from AMuxBus

enumerator CY_CAPSENSE_BIST_IO_STRONG_E

The drive mode is set to Strong in off - Low.

The HSIOM is set to GPIO

enumerator CY_CAPSENSE_BIST_IO_HIGHZA_E

The drive mode is set to High-Z.

The HSIOM is set to GPIO

enumerator CY_CAPSENSE_BIST_IO_SENSE_E

The drive mode is set to High-Z/Strong in off (depending on the device platform).

The HSIOM is set to CSD sense connection.

enumerator CY_CAPSENSE_BIST_IO_SHIELD_E

The drive mode is set to High-Z/Strong in off (depending on the device platform).

The HSIOM is set to CSD shield connection.

enumerator CY_CAPSENSE_BIST_IO_STRONG_HIGH_E

The drive mode is set to Strong in off - High.

The HSIOM is set to GPIO

enum cy_en_capsense_bist_status_t

cy_en_capsense_bist_status_t: Defines BIST result statuses.

Values:

enumerator CY_CAPSENSE_BIST_SUCCESS_E

The success test status.

enumerator CY_CAPSENSE_BIST_BAD_PARAM_E

The bad input parameters test status.

enumerator CY_CAPSENSE_BIST_HW_BUSY_E

The CSD HW block is busy by previous operation.

enumerator CY_CAPSENSE_BIST_LOW_LIMIT_E

The status for a low limit reached during the test.

enumerator CY_CAPSENSE_BIST_HIGH_LIMIT_E

The status for a high limit reached during the test.

enumerator CY_CAPSENSE_BIST_ERROR_E

The status for an error occurred during the test.

The test is not completed

enumerator CY_CAPSENSE_BIST_FEATURE_DISABLED_E

The BIST feature is disabled.

enumerator CY_CAPSENSE_BIST_TIMEOUT_E

The status for a timeout occurred during the test.

enumerator CY_CAPSENSE_BIST_FAIL_E

The failed test status.

enum cy_en_capsense_msc_raw_mode_t

cy_en_capsense_msc_raw_mode_t: Defines the raw count accumulation mode for MSC HW block.

Values:

enumerator CY_CAPSENSE_MSC_RAW_SATURATE_E

In this scenario, RAW_COUNT is clamped at 0xFFFF and RESULT_FIFO_RD.OVERFLOW is set.

enumerator CY_CAPSENSE_MSC_RAW_OVERFLOW_E

In this scenario, RAW_COUNT rolls over and RESULT_FIFO_RD.OVERFLOW is set.

This mode allows more sensitive tuning if measuring baseline capacitance