CAPSENSE™ Middleware Library 3.0
Enumerated Types

General Description

Documents the CAPSENSE™ middleware related enumerated types.

Enumerations

enum  cy_en_capsense_bist_external_cap_id_t {
  CY_CAPSENSE_BIST_CMOD_ID_E = 0x00u,
  CY_CAPSENSE_BIST_CINTA_ID_E = 0x01u,
  CY_CAPSENSE_BIST_CINTB_ID_E = 0x02u,
  CY_CAPSENSE_BIST_CSH_ID_E = 0x03u
}
 Defines IDs of the external capacitors. More...
 
enum  cy_en_capsense_tuner_state_t {
  CY_CAPSENSE_TU_FSM_RUNNING = 0x00u,
  CY_CAPSENSE_TU_FSM_SUSPENDED = 0x01u,
  CY_CAPSENSE_TU_FSM_ONE_SCAN = 0x03u
}
 Defines MW Tuner module states. More...
 
enum  cy_en_capsense_tuner_cmd_t {
  CY_CAPSENSE_TU_CMD_NONE_E = 0u,
  CY_CAPSENSE_TU_CMD_SUSPEND_E = 1u,
  CY_CAPSENSE_TU_CMD_RESUME_E = 2u,
  CY_CAPSENSE_TU_CMD_RESTART_E = 3u,
  CY_CAPSENSE_TU_CMD_RUN_SNR_TEST_E = 4u,
  CY_CAPSENSE_TU_CMD_PING_E = 5u,
  CY_CAPSENSE_TU_CMD_ONE_SCAN_E = 6u,
  CY_CAPSENSE_TU_CMD_WRITE_E = 7u
}
 Defines the Tuner command codes. More...
 
enum  cy_en_capsense_widget_type_t {
  CY_CAPSENSE_WD_BUTTON_E = 0x01u,
  CY_CAPSENSE_WD_LINEAR_SLIDER_E = 0x02u,
  CY_CAPSENSE_WD_RADIAL_SLIDER_E = 0x03u,
  CY_CAPSENSE_WD_MATRIX_BUTTON_E = 0x04u,
  CY_CAPSENSE_WD_TOUCHPAD_E = 0x05u,
  CY_CAPSENSE_WD_PROXIMITY_E = 0x06u
}
 Defines widget types. More...
 
enum  cy_en_capsense_return_status_t {
  CY_CAPSENSE_SUCCESS_E = 0x00u,
  CY_CAPSENSE_BAD_PARAM_E = 0x01u,
  CY_CAPSENSE_HW_LOCKED_E = 0x02u,
  CY_CAPSENSE_HW_BUSY_E = 0x03u,
  CY_CAPSENSE_TIMEOUT_E = 0x04u
}
 Defines CAPSENSE™ return statuses types. More...
 
enum  cy_en_capsense_eltd_t {
  CY_CAPSENSE_ELTD_TYPE_SELF_E = 0x01u,
  CY_CAPSENSE_ELTD_TYPE_MUT_TX_E = 0x02u,
  CY_CAPSENSE_ELTD_TYPE_MUT_RX_E = 0x03u
}
 Defines types of electrode. More...
 
enum  cy_en_capsense_cap_connection_t {
  CY_CAPSENSE_CMODPAD_E = 0x01u,
  CY_CAPSENSE_CTANKPAD_E = 0x02u,
  CY_CAPSENSE_CSHIELDPAD_E = 0x03u,
  CY_CAPSENSE_VREFEXTPAD_E = 0x04u
}
 Defines connections of sensing capacitors. More...
 
enum  cy_en_capsense_callback_event_t {
  CY_CAPSENSE_START_SAMPLE_E = 0x01u,
  CY_CAPSENSE_END_OF_SCAN_E = 0x02u
}
 Defines CAPSENSE™ middleware execution events when the CAPSENSE™ callback can be executed. More...
 
enum  cy_en_capsense_bist_hw_config_t {
  CY_CAPSENSE_BIST_HW_UNDEFINED_E = 0x00u,
  CY_CAPSENSE_BIST_HW_SHORT_E = 0x01u,
  CY_CAPSENSE_BIST_HW_ELTD_CAP_E = 0x02u,
  CY_CAPSENSE_BIST_HW_EXTERNAL_CAP_E = 0x03u,
  CY_CAPSENSE_BIST_HW_VDDA_E = 0x04u,
  CY_CAPSENSE_BIST_HW_ELTD_CAP_SH_E = 0x05u
}
 Defines HW configurations types for BIST operations. More...
 
enum  cy_en_capsense_bist_io_state_t {
  CY_CAPSENSE_BIST_IO_UNDEFINED_E = 0x00u,
  CY_CAPSENSE_BIST_IO_STRONG_E = 0x01u,
  CY_CAPSENSE_BIST_IO_HIGHZA_E = 0x02u,
  CY_CAPSENSE_BIST_IO_SENSE_E = 0x03u,
  CY_CAPSENSE_BIST_IO_SHIELD_E = 0x04u,
  CY_CAPSENSE_BIST_IO_STRONG_HIGH_E = 0x05u
}
 Defines BIST IO Configuration. More...
 
enum  cy_en_capsense_bist_status_t {
  CY_CAPSENSE_BIST_SUCCESS_E = 0x00u,
  CY_CAPSENSE_BIST_BAD_PARAM_E = 0x01u,
  CY_CAPSENSE_BIST_HW_BUSY_E = 0x02u,
  CY_CAPSENSE_BIST_LOW_LIMIT_E = 0x03u,
  CY_CAPSENSE_BIST_HIGH_LIMIT_E = 0x04u,
  CY_CAPSENSE_BIST_ERROR_E = 0x05u,
  CY_CAPSENSE_BIST_FEATURE_DISABLED_E = 0x06u,
  CY_CAPSENSE_BIST_TIMEOUT_E = 0x07u,
  CY_CAPSENSE_BIST_BAD_CONFIG_E = 0x08u,
  CY_CAPSENSE_BIST_FAIL_E = 0x0Fu
}
 Defines BIST result statuses. More...
 
enum  cy_en_capsense_msc_raw_mode_t {
  CY_CAPSENSE_MSC_RAW_SATURATE_E = 0x00u,
  CY_CAPSENSE_MSC_RAW_OVERFLOW_E = 0x01u
}
 Defines the raw count accumulation mode for MSC HW block. More...
 

Enumeration Type Documentation

◆ cy_en_capsense_bist_external_cap_id_t

Defines IDs of the external capacitors.

Enumerator
CY_CAPSENSE_BIST_CMOD_ID_E 

ID for Cmod external capacitor.

CY_CAPSENSE_BIST_CINTA_ID_E 

ID for CintA external capacitor.

CY_CAPSENSE_BIST_CINTB_ID_E 

ID for CintB external capacitor.

CY_CAPSENSE_BIST_CSH_ID_E 

ID for Csh external capacitor.

◆ cy_en_capsense_tuner_state_t

Defines MW Tuner module states.

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.

CY_CAPSENSE_TU_FSM_SUSPENDED 

Scanning is suspended.

CY_CAPSENSE_TU_FSM_ONE_SCAN 

Scanning is suspended after one scan cycle.

◆ cy_en_capsense_tuner_cmd_t

Defines the Tuner command codes.

Enumerator
CY_CAPSENSE_TU_CMD_NONE_E 

No command.

CY_CAPSENSE_TU_CMD_SUSPEND_E 

Suspend command.

CY_CAPSENSE_TU_CMD_RESUME_E 

Resume command switches state from suspend to running.

CY_CAPSENSE_TU_CMD_RESTART_E 

Restart command requests to perform CAPSENSE™ re-initialization.

CY_CAPSENSE_TU_CMD_RUN_SNR_TEST_E 

Reserved.

CY_CAPSENSE_TU_CMD_PING_E 

Ping command to check whether application program calls Cy_CapSense_RunTuner()

CY_CAPSENSE_TU_CMD_ONE_SCAN_E 

Execute one scan cycle and then switch to suspend state.

CY_CAPSENSE_TU_CMD_WRITE_E 

Writes specified data with offset into cy_capsense_tuner.

◆ cy_en_capsense_widget_type_t

Defines widget types.

Enumerator
CY_CAPSENSE_WD_BUTTON_E 

Button widget.

CY_CAPSENSE_WD_LINEAR_SLIDER_E 

Linear Slider widget.

CY_CAPSENSE_WD_RADIAL_SLIDER_E 

Radial Slider widget.

CY_CAPSENSE_WD_MATRIX_BUTTON_E 

Matrix Buttons widget.

CY_CAPSENSE_WD_TOUCHPAD_E 

Touchpad widget.

CY_CAPSENSE_WD_PROXIMITY_E 

Proximity widget.

◆ cy_en_capsense_return_status_t

Defines CAPSENSE™ return statuses types.

Enumerator
CY_CAPSENSE_SUCCESS_E 

The success return status.

CY_CAPSENSE_BAD_PARAM_E 

One or more invalid input parameters.

CY_CAPSENSE_HW_LOCKED_E 

The CSD HW block is captured by another middleware.

CY_CAPSENSE_HW_BUSY_E 

The CSD HW block is busy by previous operation.

CY_CAPSENSE_TIMEOUT_E 

The CSD HW block operation was not finished correctly.

◆ cy_en_capsense_eltd_t

Defines types of electrode.

Enumerator
CY_CAPSENSE_ELTD_TYPE_SELF_E 

Electrode used as a sensor in CSD sensing method.

CY_CAPSENSE_ELTD_TYPE_MUT_TX_E 

Electrode used as a TX in CSX sensing method.

CY_CAPSENSE_ELTD_TYPE_MUT_RX_E 

Electrode used as a RX in CSX sensing method.

◆ cy_en_capsense_cap_connection_t

Defines connections of sensing capacitors.

Enumerator
CY_CAPSENSE_CMODPAD_E 

External capacitor is connected to dedicated CMOD pad.

CY_CAPSENSE_CTANKPAD_E 

External capacitor is connected to dedicated CSH pad.

CY_CAPSENSE_CSHIELDPAD_E 

External capacitor is connected to dedicated SHIELD pad.

CY_CAPSENSE_VREFEXTPAD_E 

External capacitor is connected to dedicated VREF pad.

◆ cy_en_capsense_callback_event_t

Defines CAPSENSE™ middleware execution events when the CAPSENSE™ callback can be executed.

Enumerator
CY_CAPSENSE_START_SAMPLE_E 

Start Sample Callback.

The callback will be executed before each sensor scan triggering

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.

◆ cy_en_capsense_bist_hw_config_t

Defines HW configurations types for BIST operations.

Enumerator
CY_CAPSENSE_BIST_HW_UNDEFINED_E 

Initialization or releasing the CSD HW block.

CY_CAPSENSE_BIST_HW_SHORT_E 

Short tests.

CY_CAPSENSE_BIST_HW_ELTD_CAP_E 

Sensor and shield electrodes capacitance measurements with disabled shield.

CY_CAPSENSE_BIST_HW_EXTERNAL_CAP_E 

External capacitors capacitance measurements.

CY_CAPSENSE_BIST_HW_VDDA_E 

VDDA measurement.

CY_CAPSENSE_BIST_HW_ELTD_CAP_SH_E 

Sensor electrodes capacitance measurements with configured shield.

◆ cy_en_capsense_bist_io_state_t

Defines BIST IO Configuration.

Enumerator
CY_CAPSENSE_BIST_IO_UNDEFINED_E 

The undefined state.

Pins are disconnected from AMuxBus

CY_CAPSENSE_BIST_IO_STRONG_E 

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

The HSIOM is set to GPIO

CY_CAPSENSE_BIST_IO_HIGHZA_E 

The drive mode is set to High-Z.

The HSIOM is set to GPIO

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.

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.

CY_CAPSENSE_BIST_IO_STRONG_HIGH_E 

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

The HSIOM is set to GPIO

◆ cy_en_capsense_bist_status_t

Defines BIST result statuses.

Enumerator
CY_CAPSENSE_BIST_SUCCESS_E 

The success test status.

CY_CAPSENSE_BIST_BAD_PARAM_E 

The bad input parameters test status.

CY_CAPSENSE_BIST_HW_BUSY_E 

The CSD HW block is busy by previous operation.

CY_CAPSENSE_BIST_LOW_LIMIT_E 

The status for a low limit reached during the test.

CY_CAPSENSE_BIST_HIGH_LIMIT_E 

The status for a high limit reached during the test.

CY_CAPSENSE_BIST_ERROR_E 

The status for an error occurred during the test.

The test is not completed

CY_CAPSENSE_BIST_FEATURE_DISABLED_E 

The BIST feature is disabled.

CY_CAPSENSE_BIST_TIMEOUT_E 

The status for a timeout occurred during the test.

CY_CAPSENSE_BIST_BAD_CONFIG_E 

The bad configuration parameters test status.

CY_CAPSENSE_BIST_FAIL_E 

The failed test status.

◆ cy_en_capsense_msc_raw_mode_t

Defines the raw count accumulation mode for MSC HW block.

Enumerator
CY_CAPSENSE_MSC_RAW_SATURATE_E 

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

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