CAPT_Touch.h

Go to the documentation of this file.

//*****************************************************************************
// CAPT_Touch.h
//
//
//
//
//*****************************************************************************
//*****************************************************************************
//*****************************************************************************
#ifndef __CAPT_TOUCH__
#define __CAPT_TOUCH__

#include "CAPT_HAL.h"

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void CAPT_blockOnFlag(volatile bool *pFlag, uint8_t ui8LPM);


//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void CAPT_loadCycle(tSensor *pSensor, uint8_t ui8Cycle,
                uint8_t ui8Freq, bool bFSM);


//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void CAPT_unloadCycle(tSensor *pSensor, uint8_t ui8Cycle,
                uint8_t ui8Index, bool bFSM);


//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void CAPT_startConversion(volatile bool *pbEndOfConversionFlag);


//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void CAPT_cleanupAfterConversion(void);


//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void CAPT_startConversionAndWaitUntilDone(
        volatile bool *pbEndOfConversionFlag, uint8_t ui8LPM);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_initSensor(tSensor *pSensor);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_updateSensor(tSensor *pSensor,  uint8_t ui8LPM);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_updateSensorRawCount(tSensor* pSensor,
                tRawConversionStyle conversion, tOversamplingStyle oversampling,
                uint8_t ui8LPM);


//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void CAPT_startWakeOnProxMode(tSensor* pSensor, uint8_t ui8Cycle,
                uint16_t ui16WakeupInterval);

                
//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void CAPT_stopWakeOnProxMode(tSensor* pSensor, uint8_t ui8Cycle);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_processFSMCycle(tSensor *pSensor, tCycle *pCycle);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_processSensor(tSensor *pSensor);


//*****************************************************************************
//
//
//*****************************************************************************
extern bool CAPT_testForRecalibration(tSensor *pSensor);

//*****************************************************************************
//
//
//*****************************************************************************
extern bool CAPT_testForMaxCountRecalibration(tSensor *pSensor);

//*****************************************************************************
//
//
//*****************************************************************************
extern bool CAPT_testForNegativeTouchRecalibration(tSensor *pSensor);

//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_flagAllElementsForReseed(tSensor* pSensor);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_updateSensorTimeout(tSensor *pSensor);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_updateSensorNoise(tSensor *pSensor);


//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint8_t CAPT_convertAbsToRel(uint16_t ui16Ref, uint16_t ui16Abs);


//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint16_t CAPT_convertRelToAbs(uint16_t ui16Ref, uint8_t ui8Rel);


//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint64_t CAPT_getElementStateBitField(tSensor *pSensor, 
        tElementStatusType status);
                
                
//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_registerCallback(tSensor *pSensor,
                void (* user_callback)(tSensor *pSensor));


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_registerTrackPadSensorProcessing(tSensor *pSensor, void (* user_function)(tSensor*));


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_registerTrackPadGestureProcessing(tSensor *pSensor, void (* user_function)(tSensor*));


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_clearSensorProxTouch(tSensor *pSensor);


//*****************************************************************************
//
//
//*****************************************************************************
extern IQ16_t CAPT_computeIIRFilter(IQ16_t *pRaw, IQ16_t *pFiltered,
                uint8_t ui8Beta);


//*****************************************************************************
//
//
//*****************************************************************************
extern IQ16_t CAPT_computeIIRFilterFast(IQ16_t *pRaw, IQ16_t *pFiltered,
                uint8_t ui8Beta);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_reseedFilterAll(tSensor *pSensor, tFilterOption WhatToFilter);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_reseedFilter(IQ16_t *pFilter, uint16_t ui16ReseedValue);


//*****************************************************************************
//
//
//*****************************************************************************
extern bool CAPT_updateProx(tSensor *pSensor, tElement *pElement);


//*****************************************************************************
//
//
//*****************************************************************************
extern bool CAPT_updateTouch(tSensor *pSensor, tElement *pElement);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_updateLTA(tSensor *pSensor, tElement *pElement);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_updateFilterCount(tSensor *pSensor, tElement *pElement);


//*****************************************************************************
//*****************************************************************************
extern void CAPT_updateFilterCounts(tCycle *pCycle, uint8_t ui8Beta);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_updateFSMProx(tSensor *pSensor, tElement *pElement);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_updateFSMTouch(tSensor *pSensor, tElement *pElement);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_updateSensorProxTouch(tSensor *pSensor);

                
//*****************************************************************************
//
//
//
// THE FOLLOWING FUNCTIONS ARE SPECIFIC TO SENSORS WITH NOISE IMMUNUITY
// (EMC) ENABLED.
//
//
//
//*****************************************************************************


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_updateSensorWithEMC(tSensor *pSensor, uint8_t ui8LPM);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_processCycleWithEMC(tSensor *pSensor, const tCycle *pCycle);


//*****************************************************************************
//
//
//*****************************************************************************
extern void CAPT_updateElementFilteredValuesWithEMC(tSensor *pSensor,
                tElement *pElement);


//*****************************************************************************
//
//
//*****************************************************************************
extern bool CAPT_updateSelfElementProxTouchWithEMC(tSensor *pSensor,
                tElement *pElement);

                
//*****************************************************************************
//
//
//*****************************************************************************
extern bool CAPT_updateProjElementProxTouchWithEMC(tSensor *pSensor,
                tElement *pElement);

#endif
//*****************************************************************************
//*****************************************************************************