1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
/*!
* @file tsc_touchkey.h
*
* @brief This file contains external declarations of the tsc_touchkey.c file.
*
* @version V1.0.1
*
* @date 2022-09-20
*
* @attention
*
* Copyright (C) 2020-2022 Geehy Semiconductor
*
* You may not use this file except in compliance with the
* GEEHY COPYRIGHT NOTICE (GEEHY SOFTWARE PACKAGE LICENSE).
*
* The program is only for reference, which is distributed in the hope
* that it will be useful and instructional for customers to develop
* their software. Unless required by applicable law or agreed to in
* writing, the program is distributed on an "AS IS" BASIS, WITHOUT
* ANY WARRANTY OR CONDITIONS OF ANY KIND, either express or implied.
* See the GEEHY SOFTWARE PACKAGE LICENSE for the governing permissions
* and limitations under the License.
*/
/* Define to prevent recursive inclusion */
#ifndef __TOUCH_TOUCHKEY_H
#define __TOUCH_TOUCHKEY_H
#ifdef __cplusplus
extern "C" {
#endif
/* Includes */
#include "tsc_acq.h"
#include "tsc_time.h"
/** @addtogroup TSC_Driver_Library TSC Driver Library
@{
*/
/** @addtogroup TSC_TouchKey_Driver TSC TouchKey Driver
@{
*/
/** @defgroup TSC_TouchKey_Macros Macros
@{
*/
/**@} end of group TSC_TouchKey_Macros */
/** @defgroup TSC_TouchKey_Enumerations Enumerations
@{
*/
/**@} end of group TSC_TouchKey_Enumerations */
/** @defgroup TSC_TouchKey_Structures Structures
@{
*/
/**
* @brief Contains all data related to TouchKey sensor.
* Variables of this structure type must be placed in RAM only.
*/
typedef struct
{
TSC_STATEID_T StateId; /*!< Current state identifier */
TSC_tCounter_T CounterDebounce; /*!< Counter for debounce and calibration management */
unsigned int CounterDTO : 6; /*!< Counter for DTO management (TSC_tCounter_T) */
unsigned int Change : 1; /*!< The State is different from the previous one (TSC_STATE_T) */
unsigned int DxsLock : 1; /*!< The State is locked by the DxS (TSC_BOOL_T) */
} TSC_TouchKeyData_T;
/**
* @brief Contains all data related to TouchKey sensor.
* Variables of this structure type can be placed in RAM or ROM.
*/
typedef struct
{
#if TOUCH_USE_PROX > 0
TSC_tThreshold_T ProxInTh; /*!< Proximity in threshold */
TSC_tThreshold_T ProxOutTh; /*!< Proximity out threshold */
#endif
TSC_tThreshold_T DetectInTh; /*!< Detection in threshold */
TSC_tThreshold_T DetectOutTh; /*!< Detection out threshold */
TSC_tThreshold_T CalibTh; /*!< Calibration threshold */
TSC_tCounter_T CounterDebCalib; /*!< Debounce counter to enter in Calibration state */
#if TOUCH_USE_PROX > 0
TSC_tCounter_T CounterDebProx; /*!< Debounce counter to enter in Proximity state */
#endif
TSC_tCounter_T CounterDebDetect; /*!< Debounce counter to enter in Detect state */
TSC_tCounter_T CounterDebRelease; /*!< Debounce counter to enter in Release state */
TSC_tCounter_T CounterDebError; /*!< Debounce counter to enter in Error state */
} TSC_TouchKeyParam_T;
/**
* @brief Contains definition of a TouchKey sensor.
* Variables of this structure type can be placed in RAM or ROM.
*/
typedef struct
{
TSC_TouchKeyData_T* p_Data; /*!< Data (state id, counter, flag, ...) */
TSC_TouchKeyParam_T* p_Param; /*!< Parameters (thresholds, debounce, ...) */
TSC_Channel_Data_T* p_ChD; /*!< Channel Data (Meas, Refer, Delta, ...) */
CONST TSC_State_T* p_SM; /*!< State Machine */
CONST TSC_TouchKeyMethods_T* p_Methods; /*!< Methods */
} TSC_TouchKey_T;
/**
* @brief Contains definition of a Basic TouchKey sensor.
* Variables of this structure type can be placed in RAM or ROM.
* Basic sensor does not contain its own state machine and methods. It used
* default ones instead to gain memory space.
*/
typedef struct
{
TSC_TouchKeyData_T* p_Data; /*!< Data (state id, counters, flag, ...) */
TSC_TouchKeyParam_T* p_Param; /*!< Parameters (thresholds, debounce, ...) */
TSC_Channel_Data_T* p_ChD; /*!< Channel Data (Meas, Refer, Delta, ...) */
} TSC_TouchKeyB_T;
/**@} end of group TSC_TouchKey_Structures */
/** @defgroup TSC_TouchKey_Functions Functions
@{
*/
/* "Object methods" functions */
void TSC_TouchKey_Config(void);
void TSC_TouchKey_Process(void);
/* Utility functions */
void TSC_TouchKey_ConfigCalibrationState(TSC_tCounter_T delay);
void TSC_TouchKey_ConfigOffState(void);
void TSC_TouchKey_ConfigBurstOnlyState(void);
TSC_STATEID_T TSC_TouchKey_ReadStateId(void);
TSC_STATEMASK_T TSC_TouchKey_ReadStateMask(void);
TSC_tNum_T TSC_TouchKey_ReadChangeFlag(void);
/* State machine functions */
void TSC_TouchKey_ProcessCalibrationState(void);
void TSC_TouchKey_ProcessDebCalibrationState(void);
void TSC_TouchKey_ProcessReleaseState(void);
void TSC_TouchKey_ProcessDebReleaseProxState(void);
void TSC_TouchKey_ProcessDebReleaseDetectState(void);
void TSC_TouchKey_ProcessDebReleaseTouchState(void);
void TSC_TouchKey_ProcessProxState(void);
void TSC_TouchKey_ProcessDebProxState(void);
void TSC_TouchKey_ProcessDebProxDetectState(void);
void TSC_TouchKey_ProcessDebProxTouchState(void);
void TSC_TouchKey_ProcessDetectState(void);
void TSC_TouchKey_ProcessDebDetectState(void);
void TSC_TouchKey_ProcessTouchState(void);
void TSC_TouchKey_ProcessDebErrorState(void);
#ifdef __cplusplus
}
#endif
#endif /* __TSC_TOUCHKEY_H */
/**@} end of group TSC_TouchKey_Functions */
/**@} end of group TSC_TouchKey_Driver */
/**@} end of group TSC_Driver_Library */
|
