Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
capsense/cy_capsense_sensing.h
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
175 lines (147 sloc)
6.95 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /***************************************************************************//** | |
| * \file cy_capsense_sensing.h | |
| * \version 4.0 | |
| * | |
| * \brief | |
| * This file provides the common function prototypes for different supported | |
| * platforms like fourth and fifth generation platforms. | |
| * | |
| ******************************************************************************** | |
| * \copyright | |
| * Copyright 2021-2023, Cypress Semiconductor Corporation (an Infineon company) | |
| * or an affiliate of Cypress Semiconductor Corporation. All rights reserved. | |
| * You may use this file only in accordance with the license, terms, conditions, | |
| * disclaimers, and limitations in the end user license agreement accompanying | |
| * the software package with which this file was provided. | |
| *******************************************************************************/ | |
| #if !defined(CY_CAPSENSE_SENSING_H) | |
| #define CY_CAPSENSE_SENSING_H | |
| #include "cycfg_capsense_defines.h" | |
| #include "cy_capsense_common.h" | |
| #include "cy_capsense_structure.h" | |
| #if (defined(CY_IP_MXCSDV2) || defined(CY_IP_M0S8CSDV2) || defined(CY_IP_M0S8MSCV3) || defined(CY_IP_M0S8MSCV3LP)) | |
| #if defined(__cplusplus) | |
| extern "C" { | |
| #endif | |
| /******************************************************************************* | |
| * Function Prototypes | |
| *******************************************************************************/ | |
| /******************************************************************************/ | |
| /** \addtogroup group_capsense_high_level *//** \{ */ | |
| /******************************************************************************/ | |
| #if ((CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN)|| (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)) | |
| cy_capsense_status_t Cy_CapSense_ScanAllSlots( | |
| cy_stc_capsense_context_t * context); | |
| cy_capsense_status_t Cy_CapSense_ScanSlots( | |
| uint32_t startSlotId, | |
| uint32_t numberSlots, | |
| cy_stc_capsense_context_t * context); | |
| cy_capsense_mw_state_t Cy_CapSense_MwState( | |
| const cy_stc_capsense_context_t * context); | |
| #endif | |
| cy_capsense_status_t Cy_CapSense_ScanAllWidgets( | |
| cy_stc_capsense_context_t * context); | |
| cy_capsense_status_t Cy_CapSense_ScanWidget( | |
| uint32_t widgetId, | |
| cy_stc_capsense_context_t * context); | |
| uint32_t Cy_CapSense_IsBusy( | |
| const cy_stc_capsense_context_t * context); | |
| void Cy_CapSense_InterruptHandler( | |
| void * base, | |
| cy_stc_capsense_context_t * context); | |
| /** \} */ | |
| /******************************************************************************/ | |
| /** \addtogroup group_capsense_low_level *//** \{ */ | |
| /******************************************************************************/ | |
| cy_capsense_status_t Cy_CapSense_CalibrateAllWidgets( | |
| cy_stc_capsense_context_t * context); | |
| #if (((CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN) || (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)) && \ | |
| ((CY_CAPSENSE_ENABLE == CY_CAPSENSE_CSD_CALIBRATION_EN) || \ | |
| (CY_CAPSENSE_ENABLE == CY_CAPSENSE_CSX_CALIBRATION_EN) || \ | |
| (CY_CAPSENSE_ENABLE == CY_CAPSENSE_ISX_CALIBRATION_EN))) | |
| cy_capsense_status_t Cy_CapSense_CalibrateAllSlots( | |
| cy_stc_capsense_context_t * context); | |
| cy_capsense_status_t Cy_CapSense_SetCalibrationTarget( | |
| uint32_t calibrTarget, | |
| uint32_t snsMethod, | |
| cy_stc_capsense_context_t * context); | |
| #endif | |
| #if (((CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN) && (1u == CY_CAPSENSE_TOTAL_CH_NUMBER)) ||\ | |
| (CY_CAPSENSE_PLATFORM_BLOCK_FOURTH_GEN) || (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)) | |
| cy_capsense_status_t Cy_CapSense_CalibrateWidget( | |
| uint32_t widgetId, | |
| cy_stc_capsense_context_t * context); | |
| #endif | |
| cy_capsense_status_t Cy_CapSense_ScanSensor( | |
| uint32_t widgetId, | |
| uint32_t sensorId, | |
| cy_stc_capsense_context_t * context); | |
| #if (CY_CAPSENSE_PLATFORM_BLOCK_FOURTH_GEN || \ | |
| ((CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN) && (CY_CAPSENSE_SENSOR_CONNECTION_MODE == CY_CAPSENSE_AMUX_SENSOR_CONNECTION_METHOD))) | |
| cy_capsense_status_t Cy_CapSense_SetPinState( | |
| uint32_t widgetId, | |
| uint32_t sensorElement, | |
| uint32_t state, | |
| const cy_stc_capsense_context_t * context); | |
| #endif | |
| #if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP || \ | |
| ((CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN) && \ | |
| (CY_CAPSENSE_SENSOR_CONNECTION_MODE == CY_CAPSENSE_CTRLMUX_SENSOR_CONNECTION_METHOD))) | |
| cy_capsense_status_t Cy_CapSense_SlotPinState( | |
| uint32_t slotId, | |
| const cy_stc_capsense_electrode_config_t * ptrEltdCfg, | |
| uint32_t pinState, | |
| cy_stc_capsense_context_t * context); | |
| #endif | |
| cy_capsense_status_t Cy_CapSense_SetInactiveElectrodeState( | |
| uint32_t inactiveState, | |
| uint32_t sensingGroup, | |
| cy_stc_capsense_context_t * context); | |
| #if ((CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN)|| (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)) | |
| cy_capsense_status_t Cy_CapSense_ScanAbort( | |
| cy_stc_capsense_context_t * context); | |
| #endif | |
| /** \} */ | |
| /******************************************************************************/ | |
| /** \cond SECTION_CAPSENSE_INTERNAL */ | |
| /** \addtogroup group_capsense_internal *//** \{ */ | |
| /******************************************************************************/ | |
| #if (!CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP) | |
| #if (CY_CAPSENSE_ENABLE == CY_CAPSENSE_CSD_EN) | |
| void Cy_CapSense_SetCsdInactiveState( | |
| cy_stc_capsense_context_t * context); | |
| #endif | |
| #if (CY_CAPSENSE_ENABLE == CY_CAPSENSE_CSX_EN) | |
| void Cy_CapSense_SetCsxInactiveState( | |
| cy_stc_capsense_context_t * context); | |
| #endif | |
| #endif | |
| #if ((CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP) || (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN)) | |
| cy_capsense_status_t Cy_CapSense_InitializeMaxRaw( | |
| uint32_t widgetId, | |
| cy_stc_capsense_context_t * context); | |
| #endif | |
| #if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP || \ | |
| ((CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN) && \ | |
| (CY_CAPSENSE_SENSOR_CONNECTION_MODE == CY_CAPSENSE_CTRLMUX_SENSOR_CONNECTION_METHOD))) | |
| cy_capsense_status_t Cy_CapSense_ConvertPinState( | |
| uint32_t pinState, | |
| uint32_t * convertedPinState); | |
| #endif | |
| /** \} \endcond */ | |
| /******************************************************************************* | |
| * Local definition | |
| *******************************************************************************/ | |
| /* Macro to optimize division operation */ | |
| #define CY_CAPSENSE_DIV4_SHIFT (2u) | |
| /* Defines the KREF_PRS correcting shift, taking into account Sense Clock Divider | |
| * adjustment in scope of the Cy_CapSense_AdjustSnsClkDivider() | |
| * routine. | |
| */ | |
| #define CY_CAPSENSE_PRS_SNS_KREF_SHIFT (1u) | |
| #if defined(__cplusplus) | |
| } | |
| #endif | |
| #endif /* (defined(CY_IP_MXCSDV2) || defined(CY_IP_M0S8CSDV2) || defined(CY_IP_M0S8MSCV3) || defined(CY_IP_M0S8MSCV3LP)) */ | |
| #endif/* CY_CAPSENSE_SENSING_H */ | |
| /* [] END OF FILE */ |