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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
/* SPDX-License-Identifier: GPL-2.0
*
* Synaptics TouchCom touchscreen driver
*
* Copyright (C) 2017-2020 Synaptics Incorporated. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* INFORMATION CONTAINED IN THIS DOCUMENT IS PROVIDED "AS-IS," AND SYNAPTICS
* EXPRESSLY DISCLAIMS ALL EXPRESS AND IMPLIED WARRANTIES, INCLUDING ANY
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE,
* AND ANY WARRANTIES OF NON-INFRINGEMENT OF ANY INTELLECTUAL PROPERTY RIGHTS.
* IN NO EVENT SHALL SYNAPTICS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES ARISING OUT OF OR IN CONNECTION
* WITH THE USE OF THE INFORMATION CONTAINED IN THIS DOCUMENT, HOWEVER CAUSED
* AND BASED ON ANY THEORY OF LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* NEGLIGENCE OR OTHER TORTIOUS ACTION, AND EVEN IF SYNAPTICS WAS ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE. IF A TRIBUNAL OF COMPETENT JURISDICTION DOES
* NOT PERMIT THE DISCLAIMER OF DIRECT DAMAGES OR ANY OTHER DAMAGES, SYNAPTICS'
* TOTAL CUMULATIVE LIABILITY TO ANY PARTY SHALL NOT EXCEED ONE HUNDRED U.S.
* DOLLARS.
*/
/**
* @file synaptics_tcm2_func_touch.h
*
* This file declares related APIs and definitions for touch report handling.
*/
#ifndef _SYNAPTICS_TOUCHCOM_TOUCH_FUNCS_H_
#define _SYNAPTICS_TOUCHCOM_TOUCH_FUNCS_H_
#include "synaptics_touchcom_core_dev.h"
/**
* @section: Types of Object Reported
*
* List the object classifications
*/
enum object_classification {
LIFT = 0,
FINGER = 1,
GLOVED_OBJECT = 2,
STYLUS = 3,
ERASER = 4,
SMALL_OBJECT = 5,
PALM = 6,
EDGE_TOUCHED = 8,
HOVER_OBJECT = 9,
NOP = -1,
};
/**
* @section: Types of Gesture ID
*
* List the gesture ID assigned
*/
enum gesture_classification {
GESTURE_ID_NONE = 0,
GESTURE_ID_DOUBLE_TAP = 1,
GESTURE_ID_SWIPE = 2,
GESTURE_ID_ACTIVE_TAP_AND_HOLD = 7,
};
/**
* @section: Codes for Touch Report Configuration
*
* Define the 8-bit codes for the touch report configuration
*/
enum touch_report_code {
/* control flow codes */
TOUCH_REPORT_END = 0x00,
TOUCH_REPORT_FOREACH_ACTIVE_OBJECT = 0x01,
TOUCH_REPORT_FOREACH_OBJECT = 0x02,
TOUCH_REPORT_FOREACH_END = 0x03,
TOUCH_REPORT_PAD_TO_NEXT_BYTE = 0x04,
/* entity codes */
TOUCH_REPORT_TIMESTAMP = 0x05,
TOUCH_REPORT_OBJECT_N_INDEX = 0x06,
TOUCH_REPORT_OBJECT_N_CLASSIFICATION = 0x07,
TOUCH_REPORT_OBJECT_N_X_POSITION = 0x08,
TOUCH_REPORT_OBJECT_N_Y_POSITION = 0x09,
TOUCH_REPORT_OBJECT_N_Z = 0x0a,
TOUCH_REPORT_OBJECT_N_X_WIDTH = 0x0b,
TOUCH_REPORT_OBJECT_N_Y_WIDTH = 0x0c,
TOUCH_REPORT_OBJECT_N_TX_POSITION_TIXELS = 0x0d,
TOUCH_REPORT_OBJECT_N_RX_POSITION_TIXELS = 0x0e,
TOUCH_REPORT_0D_BUTTONS_STATE = 0x0f,
TOUCH_REPORT_GESTURE_ID = 0x10,
TOUCH_REPORT_FRAME_RATE = 0x11,
TOUCH_REPORT_POWER_IM = 0x12,
TOUCH_REPORT_CID_IM = 0x13,
TOUCH_REPORT_RAIL_IM = 0x14,
TOUCH_REPORT_CID_VARIANCE_IM = 0x15,
TOUCH_REPORT_NSM_FREQUENCY_INDEX = 0x16,
TOUCH_REPORT_NSM_STATE = 0x17,
TOUCH_REPORT_NUM_OF_ACTIVE_OBJECTS = 0x18,
TOUCH_REPORT_CPU_CYCLES_USED_SINCE_LAST_FRAME = 0x19,
TOUCH_REPORT_FACE_DETECT = 0x1a,
TOUCH_REPORT_GESTURE_DATA = 0x1b,
TOUCH_REPORT_FORCE_MEASUREMENT = 0x1c,
TOUCH_REPORT_FINGERPRINT_AREA_MEET = 0x1d,
TOUCH_REPORT_SENSING_MODE = 0x1e,
TOUCH_REPORT_KNOB_DATA = 0x24,
};
/**
* syna_tcm_parse_touch_report()
*
* Traverse through touch report configuration and parse the contents of
* report packet to get the exactly touched data entity from touch reports.
*
* At the end of function, the touched data will be parsed and stored at the
* associated position in struct touch_data_blob.
*
* @param
* [ in] tcm_dev: the device handle
* [ in] report: touch report generated by TouchComm device
* [ in] report_size: size of given report
* [out] touch_data: touch data generated
*
* @return
* on success, 0 or positive value; otherwise, negative value on error.
*/
int syna_tcm_parse_touch_report(struct tcm_dev *tcm_dev,
unsigned char *report, unsigned int report_size,
struct tcm_touch_data_blob *touch_data);
/**
* syna_tcm_set_touch_report_config()
*
* Setup the format and content of touch report if needed
*
* TouchComm allows to set how touch reports are formatted and what items get
* reported each time a touch report is generated.
*
* @param
* [ in] tcm_dev: the device handle
* [ in] config: the customized report configuration
* [ in] config_size: size of given config
*
* @return
* on success, 0 or positive value; otherwise, negative value on error.
*/
int syna_tcm_set_touch_report_config(struct tcm_dev *tcm_dev,
unsigned char *config, unsigned int config_size);
/**
* syna_tcm_preserve_touch_report_config()
*
* Retrieve and preserve the current touch report configuration.
*
* The retrieved configuration is stored in touch_config buffer defined
* in struct syna_tcm_dev for later using of touch position parsing.
*
* The touch_config buffer will be allocated internally and its size will
* be updated accordingly.
*
* @param
* [ in] tcm_dev: the device handle
*
* @return
* on success, 0 or positive value; otherwise, negative value on error.
*/
int syna_tcm_preserve_touch_report_config(struct tcm_dev *tcm_dev);
/**
* syna_tcm_get_touch_data()
*
* Get data entity from the received report according to bit offset and bit
* length defined in the touch report configuration.
*
* @param
* [ in] report: touch report generated by TouchComm device
* [ in] report_size: size of given report
* [ in] offset: bit offset in the report
* [ in] bits: number of bits representing the data
* [out] data: data parsed
*
* @return
* on success, 0 or positive value; otherwise, negative value on error.
*/
int syna_tcm_get_touch_data(const unsigned char *report,
unsigned int report_size, unsigned int offset,
unsigned int bits, unsigned int *data);
/**
* syna_tcm_set_custom_touch_data_parsing_callback()
*
* Set up callback function to handle custom touch data.
*
* Once finding the "new" custom entity in touch report, the core library will
* invoke the custom parsing method to handle this "new" code entity.
*
* @param
* [ in] tcm_dev: the device handle
* [ in] p_cb: the callback function pointer
* [ in] p_cbdata: pointer to caller data passed to callback function
*
* @return
* on success, 0 or positive value; otherwise, negative value on error.
*/
int syna_tcm_set_custom_touch_data_parsing_callback(struct tcm_dev *tcm_dev,
tcm_touch_data_parse_callback_t p_cb, void *p_cbdata);
/**
* syna_tcm_set_custom_gesture_parsing_callback()
*
* Set up callback function to handle the gesture data defined as the following
* code entities
* - TOUCH_REPORT_GESTURE_ID
* - TOUCH_REPORT_GESTURE_DATA
*
* @param
* [ in] tcm_dev: the device handle
* [ in] p_cb: the callback function pointer
* [ in] p_cbdata: pointer to caller data passed to callback function
*
* @return
* on success, 0 or positive value; otherwise, negative value on error.
*/
int syna_tcm_set_custom_gesture_parsing_callback(struct tcm_dev *tcm_dev,
tcm_gesture_parse_callback_t p_cb, void *p_cbdata);
#endif /* end of _SYNAPTICS_TOUCHCOM_TOUCH_FUNCS_H_ */
|
