xref: /OK3568_Linux_fs/kernel/drivers/input/touchscreen/gt1x/gt1x_generic.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /* drivers/input/touchscreen/gt1x_generic.h
2  *
3  * 2010 - 2014 Goodix Technology.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be a reference
11  * to you, when you are integrating the GOODiX's CTP IC into your system,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * General Public License for more details.
15  *
16  * Version: 1.4
17  * Release Date:  2015/07/10
18  */
19 
20 #ifndef _GT1X_GENERIC_H_
21 #define _GT1X_GENERIC_H_
22 
23 #include <linux/hrtimer.h>
24 #include <linux/string.h>
25 #include <linux/vmalloc.h>
26 #include <linux/version.h>
27 #include <linux/jiffies.h>
28 #include <linux/init.h>
29 #include <linux/module.h>
30 #include <linux/delay.h>
31 #include <linux/i2c.h>
32 #include <linux/input.h>
33 #include <linux/slab.h>
34 #include <linux/gpio.h>
35 #include <linux/sched.h>
36 #include <linux/kthread.h>
37 #include <linux/bitops.h>
38 #include <linux/kernel.h>
39 #include <linux/byteorder/generic.h>
40 #include <linux/interrupt.h>
41 #include <linux/time.h>
42 #include <linux/proc_fs.h>
43 #include <linux/uaccess.h>
44 #ifdef CONFIG_HAS_EARLYSUSPEND
45 #include <linux/earlysuspend.h>
46 #endif
47 
48 /********* Device Tree Support *********/
49 #ifdef CONFIG_OF
50 #define GTP_CONFIG_OF
51 #endif
52 /***************************PART1:ON/OFF define*******************************/
53 #define GTP_INCELL_PANEL      0
54 #define GTP_DRIVER_SEND_CFG   1	/* send config to TP while initializing (for no config built in TP's flash) */
55 #define GTP_CUSTOM_CFG        0	/* customize resolution & interrupt trigger mode */
56 
57 #define GTP_CHANGE_X2Y        0	/* exchange xy */
58 #define GTP_WARP_X_ON         0
59 #define GTP_WARP_Y_ON         0
60 
61 #define GTP_GESTURE_WAKEUP    0	/* gesture wakeup module */
62 /* buffer used to store ges track points coor. */
63 #define GES_BUFFER_ADDR       0xA2A0    /* GT1151 */
64 /*#define GES_BUFFER_ADDR       0x8A40    // GT9L*/
65 /*#define GES_BUFFER_ADDR       0x9734     // GT1152*/
66 /*#define GES_BUFFER_ADDR       0xBDA8    // GT9286*/
67 #ifndef GES_BUFFER_ADDR
68 #warning  [GOODIX] need define GES_BUFFER_ADDR .
69 #endif
70 #define KEY_GES_REGULAR       KEY_F2	/* regular gesture-key */
71 #define KEY_GES_CUSTOM        KEY_F3    /* customize gesture-key */
72 
73 #define GTP_HOTKNOT           0	/* hotknot module */
74 #define HOTKNOT_TYPE          0	/* 0: hotknot in flash; 1: hotknot in driver */
75 #define HOTKNOT_BLOCK_RW      0
76 
77 #define GTP_AUTO_UPDATE       0	/* auto update FW to TP FLASH while initializing */
78 #define GTP_HEADER_FW_UPDATE  0	/* firmware in gt1x_firmware.h */
79 #define GTP_FW_UPDATE_VERIFY  0 /* verify fw when updating */
80 
81 #define GTP_HAVE_TOUCH_KEY    1 /* touch key support */
82 #define GTP_WITH_STYLUS       0 /* pen support */
83 #define GTP_HAVE_STYLUS_KEY   0
84 
85 #define GTP_POWER_CTRL_SLEEP  1	/* turn off power on suspend */
86 #define GTP_CREATE_WR_NODE    0	/* create the interface to support gtp_tools */
87 #define GTP_DEBUG_NODE        0
88 
89 #define GTP_PROXIMITY         0	/* proximity module (function as the p-sensor) */
90 #define GTP_SMART_COVER       0
91 
92 #define GTP_ESD_PROTECT       0	/* esd-protection module (with a cycle of 2 seconds) */
93 #define GTP_CHARGER_SWITCH    0
94 
95 #define GTP_DEBUG_ON          0
96 #define GTP_DEBUG_ARRAY_ON    0
97 #define GTP_DEBUG_FUNC_ON     0
98 
99 /***************************PART2:TODO define**********************************/
100 /* Normal Configs
101  *  TODO: puts the config info corresponded to your TP here, the following is just
102  *         a sample config, send this config should cause the chip cannot work normally
103  */
104 #define CFG_GROUP_LEN(p_cfg_grp)  (sizeof(p_cfg_grp) / sizeof(p_cfg_grp[0]))
105 /* TODO define your config for Sensor_ID == 0 here, if needed */
106 #define GTP_CFG_GROUP0 {\
107 	0x45,0xD0,0x02,0x00,0x05,0x05,0x3D,0x04,0x08,0xC1,0x0A,0x0F,\
108 	0x5F,0x3C,0x53,0x01,0x00,0x32,0x00,0x00,0x1E,0x8C,0xA0,0xC8,\
109 	0x18,0x04,0x00,0x00,0x00,0x00,0x3C,0x00,0x00,0x22,0x00,0x00,\
110 	0x00,0x00,0x00,0x40,0x00,0x00,0x00,0x00,0x38,0x28,0x86,0x26,\
111 	0x16,0x53,0x55,0xC5,0x04,0x28,0x3C,0x28,0x3D,0x42,0x24,0x00,\
112 	0x03,0x32,0x78,0xC0,0x94,0xF2,0x00,0x00,0x53,0xCC,0x3D,0xA9,\
113 	0x49,0x91,0x54,0x80,0x60,0x71,0x6C,0x66,0x00,0x00,0x00,0x00,\
114 	0x00,0x00,0x00,0xF0,0x50,0x3C,0xAA,0xAA,0x27,0x3C,0x32,0x00,\
115 	0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x20,0x00,\
116 	0x02,0x78,0x0A,0x50,0xFF,0xE4,0x04,0x00,0x00,0x00,0x00,0x00,\
117 	0x00,0x00,0x00,0x3D,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,\
118 	0x00,0x00,0x00,0x00,0x1D,0x0D,0x50,0x1E,0x13,0x14,0x15,0x16,\
119 	0x17,0x18,0x19,0x1A,0x1B,0x1D,0x1F,0x12,0x10,0x0F,0x0E,0x0D,\
120 	0x0C,0x0B,0x0A,0x09,0x08,0x07,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,\
121 	0xFF,0xFF,0xFF,0xFF,0x06,0x08,0x0C,0x12,0x13,0x14,0x15,0x17,\
122 	0x18,0x19,0x1A,0x1B,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,\
123 	0xFF,0xFF,0x00,0x30,0x00,0x00,0x78,0x0F,0x1E,0x64,0x00,0x00,\
124 	0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,\
125 	0x00,0x11,0x00,0x00,0x32,0x03,0x14,0x50,0x0C,0x02,0x14,0x50,\
126 	0x00,0x55,0x10,0x00,0x3C,0xAD,0x06,0x3C,0x45,0x07,0x01 \
127 }
128 /* TODO define your config for Sensor_ID == 1 here,  if needed */
129 #define GTP_CFG_GROUP1 {\
130 	0x41, 0xD0, 0x02, 0x00, 0x05, 0x05, 0x04, 0x13, 0x00, 0x41, \
131 	0x00, 0x0F, 0x50, 0x37, 0x43, 0x01, 0x00, 0x00, 0x00, 0x00, \
132 	0x14, 0x17, 0x19, 0x1C, 0x0A, 0x08, 0x00, 0x00, 0x00, 0x00, \
133 	0x00, 0x11, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
134 	0x00, 0x0A, 0x0A, 0x64, 0x1E, 0x28, 0x8B, 0x2B, 0x0C, 0x50, \
135 	0x52, 0xDF, 0x07, 0x20, 0x3A, 0x60, 0x1A, 0x02, 0x24, 0x00, \
136 	0x00, 0x3B, 0x96, 0xC0, 0x14, 0x52, 0x1E, 0x00, 0x00, 0x87, \
137 	0x4A, 0x76, 0x59, 0x6B, 0x68, 0x62, 0x77, 0x5C, 0x86, 0x5C, \
138 	0x00, 0x00, 0x00, 0x10, 0x38, 0x58, 0x00, 0xF0, 0x50, 0x3C, \
139 	0xAA, 0xAA, 0x27, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
140 	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, \
141 	0x00, 0x00, 0xFF, 0xE4, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, \
142 	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
143 	0x32, 0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
144 	0x01, 0x08, 0x02, 0x09, 0x03, 0x0A, 0x04, 0x0B, 0x05, 0x0C, \
145 	0x06, 0x0D, 0xFF, 0xFF, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10, \
146 	0x11, 0x12, 0x13, 0x14, 0x15, 0x0A, 0x09, 0x08, 0x07, 0x06, \
147 	0x05, 0x04, 0x03, 0x02, 0x01, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, \
148 	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
149 	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, \
150 	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
151 	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xE4, 0x84, \
152 	0x22, 0x02, 0x00, 0x00, 0x1A, 0x01, 0x0F, 0x1E, 0x00, 0x28, \
153 	0x46, 0x28, 0x01, 0x00, 0x00, 0x05, 0x6A, 0x0D, 0x01\
154     }
155 /* TODO define your config for Sensor_ID == 2 here, if needed */
156 #define GTP_CFG_GROUP2 {\
157     }
158 /* TODO define your config for Sensor_ID == 3 here, if needed */
159 #define GTP_CFG_GROUP3 {\
160     }
161 /* TODO define your config for Sensor_ID == 4 here, if needed */
162 #define GTP_CFG_GROUP4 {\
163     }
164 /* TODO define your config for Sensor_ID == 5 here, if needed */
165 #define GTP_CFG_GROUP5 {\
166     }
167 
168 /*
169 *         Charger Configs
170 */
171 /* TODO define your config for Sensor_ID == 0 here, if needed */
172 #define GTP_CHARGER_CFG_GROUP0 {\
173     0x45, 0x1C, 0x02, 0xC0, 0x03, 0x05, 0x3D, 0x10, 0x00, 0x08, \
174     0x00, 0x05, 0x50, 0x28, 0x5E, 0x00, 0x11, 0x00, 0x00, 0x00, \
175     0x28, 0x80, 0x87, 0xFE, 0xC8, 0x00, 0x00, 0x00, 0x00, 0x00, \
176     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, \
177     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x87, 0x26, 0x17, 0x64, \
178     0x66, 0xDF, 0x07, 0x91, 0x31, 0x18, 0x0C, 0x43, 0x24, 0x00, \
179     0x06, 0x3C, 0x8C, 0x80, 0x94, 0x02, 0x05, 0x08, 0x04, 0xC2, \
180     0x49, 0xA4, 0x56, 0x8E, 0x63, 0x80, 0x71, 0x75, 0x7E, 0x6E, \
181     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
182     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x0F, 0x23, 0x04, \
183     0x0F, 0x10, 0x42, 0xD8, 0x0F, 0x00, 0x0F, 0x00, 0x00, 0x00, \
184     0x00, 0x00, 0xFF, 0xFF, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, \
185     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
186     0x00, 0x00, 0x00, 0x05, 0x1E, 0x00, 0x70, 0x17, 0x50, 0x1E, \
187     0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0F, 0x0E, 0x10, 0x0D, 0x12, \
188     0x13, 0x1F, 0x1E, 0x1D, 0x1C, 0x1B, 0x1A, 0x19, 0x18, 0x17, \
189     0x16, 0x15, 0x14, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, \
190     0xFF, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, \
191     0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0xFF, 0xFF, 0xFF, 0xFF, 0x00, \
192     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
193     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
194     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xC8, 0x00, 0x00, \
195     0x00, 0xD0, 0x24, 0x1E, 0x6D, 0x00, 0x14, 0x28, 0x00, 0x00, \
196     0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x6A, 0xC3, 0x01\
197 }
198 /* TODO define your config for Sensor_ID == 1 here, if needed */
199 #define GTP_CHARGER_CFG_GROUP1 {\
200 }
201 /* TODO define your config for Sensor_ID == 2 here, if needed */
202 #define GTP_CHARGER_CFG_GROUP2 {\
203 }
204 /* TODO define your config for Sensor_ID == 3 here, if needed */
205 #define GTP_CHARGER_CFG_GROUP3 {\
206 }
207 /* TODO define your config for Sensor_ID == 4 here, if needed */
208 #define GTP_CHARGER_CFG_GROUP4 {\
209 }
210 /* TODO define your config for Sensor_ID == 5 here, if needed */
211 #define GTP_CHARGER_CFG_GROUP5 {\
212 }
213 
214 /*
215  *         Smart Cover Configs
216  */
217 /* TODO define your config for Sendor_ID == 0 here, if needed */
218 #define GTP_SMART_COVER_CFG_GROUP0 {\
219     0x46, 0xD0, 0x02, 0x64, 0x02, 0x05, 0xBD, 0x10, 0x00, 0x08, 0x00, 0x0F, 0x50, 0x28, 0x5E, \
220     0x02, 0x11, 0x00, 0x00, 0x00, 0x28, 0x82, 0x96, 0xFC, 0xC8, 0x00, 0x00, 0x00, 0x00, 0x00, \
221     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
222     0x00, 0x87, 0x26, 0x0B, 0x64, 0x66, 0xDF, 0x07, 0x91, 0x31, 0x18, 0x0E, 0x43, 0x24, 0x00, \
223     0x04, 0x28, 0x6E, 0x80, 0x94, 0x02, 0x05, 0x08, 0x04, 0xDA, 0x33, 0xAF, 0x3F, 0x92, 0x4A, \
224     0x7F, 0x56, 0x71, 0x62, 0x66, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
225     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x0F, 0x19, 0x04, 0x0F, 0x10, 0x42, 0xD8, 0x0F, \
226     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, \
227     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x05, 0x1E, \
228     0x00, 0x70, 0x17, 0x50, 0x1E, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0F, 0x0E, 0x10, 0x0D, 0x12, \
229     0x13, 0x1F, 0x1E, 0x1D, 0x1C, 0x1B, 0x1A, 0x19, 0x18, 0x17, 0x16, 0x15, 0x14, 0xFF, 0xFF, \
230     0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, \
231     0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0xFF, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
232     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
233     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xC8, 0x00, 0x00, 0x00, 0x00, 0x24, 0x1E, 0x6D, \
234     0x00, 0x14, 0x28, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x9E, 0x29, 0x01\
235 }
236 /* TODO define your config for Sendor_ID == 0 here, if needed */
237 #define GTP_SMART_COVER_CFG_GROUP1 {\
238 }
239 /* TODO define your config for Sendor_ID == 0 here, if needed */
240 #define GTP_SMART_COVER_CFG_GROUP2 {\
241 }
242 /* TODO define your config for Sendor_ID == 0 here, if needed */
243 #define GTP_SMART_COVER_CFG_GROUP3 {\
244 }
245 /* TODO define your config for Sendor_ID == 0 here, if needed */
246 #define GTP_SMART_COVER_CFG_GROUP4 {\
247 }
248 /* TODO define your config for Sendor_ID == 0 here, if needed */
249 #define GTP_SMART_COVER_CFG_GROUP5 {\
250 }
251 
252 #if GTP_CUSTOM_CFG
253 #define GTP_MAX_HEIGHT   1280
254 #define GTP_MAX_WIDTH    720
255 #define GTP_INT_TRIGGER  1	/* 0:Rising 1:Falling */
256 #define GTP_WAKEUP_LEVEL 1
257 #else
258 #define GTP_MAX_HEIGHT   4096
259 #define GTP_MAX_WIDTH    4096
260 #define GTP_INT_TRIGGER  1
261 #define GTP_WAKEUP_LEVEL 1
262 #endif
263 
264 #define GTP_MAX_TOUCH    10
265 
266 #if GTP_WITH_STYLUS
267 #define GTP_STYLUS_KEY_TAB {BTN_STYLUS, BTN_STYLUS2}
268 #endif
269 
270 #if GTP_HAVE_TOUCH_KEY
271 #define GTP_KEY_TAB	 {KEY_BACK, KEY_HOMEPAGE, KEY_MENU, KEY_SEARCH}
272 #define GTP_MAX_KEY_NUM  4
273 #endif
274 
275 /****************************PART3:OTHER define*********************************/
276 #define GTP_DRIVER_VERSION          "V1.4<2015/07/10>"
277 #define GTP_I2C_NAME                "Goodix-TS-GT1X"
278 #define GT1X_DEBUG_PROC_FILE        "gt1x_debug"
279 #define GTP_POLL_TIME               10
280 #define GTP_ADDR_LENGTH             2
281 #define GTP_CONFIG_MIN_LENGTH       186
282 #define GTP_CONFIG_MAX_LENGTH       240
283 #define GTP_MAX_I2C_XFER_LEN        250
284 #define SWITCH_OFF                  0
285 #define SWITCH_ON                   1
286 
287 #define GTP_REG_MATRIX_DRVNUM           0x8069
288 #define GTP_REG_MATRIX_SENNUM           0x806A
289 #define GTP_REG_RQST                    0x8044
290 #define GTP_REG_BAK_REF                 0x90EC
291 #define GTP_REG_MAIN_CLK                0x8020
292 #define GTP_REG_HAVE_KEY                0x8057
293 #define GTP_REG_HN_STATE                0x8800
294 
295 #define GTP_REG_WAKEUP_GESTURE         0x814C
296 #define GTP_REG_WAKEUP_GESTURE_DETAIL  0xA2A0	/* need change */
297 
298 #define GTP_BAK_REF_PATH                "/data/gt1x_ref.bin"
299 #define GTP_MAIN_CLK_PATH               "/data/gt1x_clk.bin"
300 
301 /* request type */
302 #define GTP_RQST_CONFIG                 0x01
303 #define GTP_RQST_BAK_REF                0x02
304 #define GTP_RQST_RESET                  0x03
305 #define GTP_RQST_MAIN_CLOCK             0x04
306 #define GTP_RQST_HOTKNOT_CODE           0x20
307 #define GTP_RQST_RESPONDED              0x00
308 #define GTP_RQST_IDLE                   0xFF
309 
310 #define HN_DEVICE_PAIRED                0x80
311 #define HN_MASTER_DEPARTED              0x40
312 #define HN_SLAVE_DEPARTED               0x20
313 #define HN_MASTER_SEND                  0x10
314 #define HN_SLAVE_RECEIVED               0x08
315 
316 /*Register define */
317 #define GTP_READ_COOR_ADDR          0x814E
318 #define GTP_REG_CMD                 0x8040
319 #define GTP_REG_SENSOR_ID           0x814A
320 #define GTP_REG_CONFIG_DATA         0x8050
321 #define GTP_REG_CONFIG_RESOLUTION   0x8051
322 #define GTP_REG_CONFIG_TRIGGER      0x8056
323 #define GTP_REG_CONFIG_CHECKSUM     0x813C
324 #define GTP_REG_CONFIG_UPDATE       0x813E
325 #define GTP_REG_VERSION             0x8140
326 #define GTP_REG_HW_INFO             0x4220
327 #define GTP_REG_REFRESH_RATE	    0x8056
328 #define GTP_REG_ESD_CHECK           0x8043
329 #define GTP_REG_FLASH_PASSBY        0x8006
330 #define GTP_REG_HN_PAIRED           0x81AA
331 #define GTP_REG_HN_MODE             0x81A8
332 #define GTP_REG_MODULE_SWITCH3      0x8058
333 #define GTP_REG_FW_CHK_MAINSYS      0x41E4
334 #define GTP_REG_FW_CHK_SUBSYS       0x5095
335 
336 #define set_reg_bit(reg, pos, val)   ((reg) = ((reg) & (~(1<<(pos))))|(!!(val)<<(pos)))
337 
338 /* cmd define */
339 #define GTP_CMD_SLEEP               0x05
340 #define GTP_CMD_CHARGER_ON          0x06
341 #define GTP_CMD_CHARGER_OFF         0x07
342 #define GTP_CMD_GESTURE_WAKEUP      0x08
343 #define GTP_CMD_CLEAR_CFG           0x10
344 #define GTP_CMD_ESD                 0xAA
345 #define GTP_CMD_HN_TRANSFER         0x22
346 #define GTP_CMD_HN_EXIT_SLAVE       0x28
347 
348 /* define offset in the config*/
349 #define RESOLUTION_LOC              (GTP_REG_CONFIG_RESOLUTION - GTP_REG_CONFIG_DATA)
350 #define TRIGGER_LOC                 (GTP_REG_CONFIG_TRIGGER - GTP_REG_CONFIG_DATA)
351 #define MODULE_SWITCH3_LOC	     	(GTP_REG_MODULE_SWITCH3 - GTP_REG_CONFIG_DATA)
352 
353 #define GTP_I2C_ADDRESS       		0xBA
354 
355 #if GTP_WARP_X_ON
356 #define GTP_WARP_X(x_max, x) (x_max - 1 - x)
357 #else
358 #define GTP_WARP_X(x_max, x) x
359 #endif
360 
361 #if GTP_WARP_Y_ON
362 #define GTP_WARP_Y(y_max, y) (y_max - 1 - y)
363 #else
364 #define GTP_WARP_Y(y_max, y) y
365 #endif
366 
367 #define IS_NUM_OR_CHAR(x)    (((x) >= 'A' && (x) <= 'Z') || ((x) >= '0' && (x) <= '9'))
368 
369 /*Log define*/
370 #define GTP_INFO(fmt, arg...)           printk("<<GTP-INF>>[%s:%d] "fmt"\n", __func__, __LINE__, ##arg)
371 #define GTP_ERROR(fmt, arg...)          printk("<<GTP-ERR>>[%s:%d] "fmt"\n", __func__, __LINE__, ##arg)
372 #define GTP_DEBUG(fmt, arg...)          do {\
373 	if (GTP_DEBUG_ON)\
374 	printk("<<GTP-DBG>>[%s:%d]"fmt"\n", __func__, __LINE__, ##arg);\
375 } while (0)
376 #define GTP_DEBUG_ARRAY(array, num)    do {\
377 	s32 i;\
378 	u8 *a = array;\
379 	if (GTP_DEBUG_ARRAY_ON) {\
380 		printk("<<GTP-DBG>>");\
381 		for (i = 0; i < (num); i++) {\
382 			printk("%02x ", (a)[i]);\
383 			if ((i + 1) % 10 == 0) {\
384 				printk("\n<<GTP-DBG>>");\
385 			} \
386 		} \
387 		printk("\n");\
388 	} \
389 } while (0)
390 #define GTP_DEBUG_FUNC()               do {\
391 	if (GTP_DEBUG_FUNC_ON)\
392 	printk("<<GTP-FUNC>> Func:%s@Line:%d\n", __func__, __LINE__);\
393 } while (0)
394 
395 #define GTP_SWAP(x, y)                 do {\
396 						typeof(x) z = x;\
397 						x = y;\
398 						y = z;\
399 					} while (0)
400 
401 #pragma pack(1)
402 struct gt1x_version_info {
403 	u8 product_id[5];
404 	u32 patch_id;
405 	u32 mask_id;
406 	u8 sensor_id;
407 	u8 match_opt;
408 };
409 #pragma pack()
410 
411 typedef enum {
412 	DOZE_DISABLED = 0,
413 	DOZE_ENABLED = 1,
414 	DOZE_WAKEUP = 2,
415 } DOZE_T;
416 
417 typedef enum {
418 	CHIP_TYPE_GT1X = 0,
419 	CHIP_TYPE_GT2X = 1,
420 	CHIP_TYPE_NONE = 0xFF
421 } CHIP_TYPE_T;
422 
423 #define _ERROR(e)      ((0x01 << e) | (0x01 << (sizeof(s32) * 8 - 1)))
424 #define ERROR          _ERROR(1)	/* for common use */
425 /*system relevant*/
426 #define ERROR_IIC      _ERROR(2)	/* IIC communication error. */
427 #define ERROR_MEM      _ERROR(3)	/* memory error.*/
428 
429 /*system irrelevant*/
430 #define ERROR_HN_VER   _ERROR(10)	/* HotKnot version error. */
431 #define ERROR_CHECK    _ERROR(11)	/* Compare src and dst error. */
432 #define ERROR_RETRY    _ERROR(12)	/* Too many retries.i */
433 #define ERROR_PATH     _ERROR(13)	/* Mount path error */
434 #define ERROR_FW       _ERROR(14)
435 #define ERROR_FILE     _ERROR(15)
436 #define ERROR_VALUE    _ERROR(16)	/* Illegal value of variables */
437 
438 /* bit operation */
439 #define SET_BIT(data, flag)	((data) |= (flag))
440 #define CLR_BIT(data, flag)	((data) &= ~(flag))
441 #define CHK_BIT(data, flag)	((data) & (flag))
442 
443 /* touch states */
444 #define BIT_TOUCH			0x01
445 #define BIT_TOUCH_KEY		0x02
446 #define BIT_STYLUS			0x04
447 #define BIT_STYLUS_KEY		0x08
448 #define BIT_HOVER			0x10
449 
450 #include <linux/input.h>
451 struct i2c_msg;
452 
453 /*          Export global variables and functions          */
454 
455 /* Export from gt1x_extents.c and gt1x_firmware.h */
456 #if GTP_HOTKNOT
457 extern u8 hotknot_enabled;
458 extern u8 hotknot_transfer_mode;
459 extern u8 gt1x_patch_jump_fw[];
460 extern u8 hotknot_auth_fw[];
461 extern u8 hotknot_transfer_fw[];
462 #if HOTKNOT_BLOCK_RW
463 extern s32 hotknot_paired_flag;
464 extern s32 hotknot_event_handler(u8 *data);
465 #endif
466 #endif
467 
468 extern s32 gt1x_init_node(void);
469 extern void gt1x_deinit_node(void);
470 
471 #if GTP_GESTURE_WAKEUP
472 extern DOZE_T gesture_doze_status;
473 extern int gesture_enabled;
474 extern void gt1x_gesture_debug(int on) ;
475 extern s32 gesture_event_handler(struct input_dev *dev);
476 extern s32 gesture_enter_doze(void);
477 extern void gesture_clear_wakeup_data(void);
478 #endif
479 
480 /* Export from gt1x_tpd.c */
481 extern void gt1x_touch_down(s32 x, s32 y, s32 size, s32 id);
482 extern void gt1x_touch_up(s32 id);
483 extern int gt1x_power_switch(s32 state);
484 extern void gt1x_irq_enable(void);
485 extern void gt1x_irq_disable(void);
486 extern int gt1x_debug_proc(u8 *buf, int count);
487 
488 struct fw_update_info {
489 	int update_type;
490 	int status;
491 	int progress;
492 	int max_progress;
493     int force_update;
494 	struct fw_info *firmware;
495 	u32 fw_length;
496 	/*file update*/
497 	char *fw_name;
498 	u8 *buffer;
499 	//mm_segment_t old_fs;
500 	struct file *fw_file;
501 	/*header update*/
502 	u8 *fw_data;
503 };
504 
505 /* Export form gt1x_update.c */
506 extern struct fw_update_info update_info;
507 
508 extern u8 gt1x_default_FW[];
509 extern int gt1x_hold_ss51_dsp(void);
510 extern int gt1x_auto_update_proc(void *data);
511 extern int gt1x_update_firmware(void *filename);
512 extern void gt1x_enter_update_mode(void);
513 extern void gt1x_leave_update_mode(void);
514 extern int gt1x_hold_ss51_dsp_no_reset(void);
515 extern int gt1x_load_patch(u8 *patch, u32 patch_size, int offset, int bank_size);
516 extern int gt1x_startup_patch(void);
517 
518 /* Export from gt1x_tool.c */
519 #if GTP_CREATE_WR_NODE
520 extern int gt1x_init_tool_node(void);
521 extern void gt1x_deinit_tool_node(void);
522 #endif
523 
524 /* Export from gt1x_generic.c */
525 extern struct i2c_client *gt1x_i2c_client;
526 
527 extern CHIP_TYPE_T gt1x_chip_type;
528 extern struct gt1x_version_info gt1x_version;
529 
530 extern s32 _do_i2c_read(struct i2c_msg *msgs, u16 addr, u8 *buffer, s32 len);
531 extern s32 _do_i2c_write(struct i2c_msg *msg, u16 addr, u8 *buffer, s32 len);
532 extern s32 gt1x_i2c_write(u16 addr, u8 *buffer, s32 len);
533 extern s32 gt1x_i2c_read(u16 addr, u8 *buffer, s32 len);
534 extern s32 gt1x_i2c_read_dbl_check(u16 addr, u8 *buffer, s32 len);
535 
536 extern bool gt1x_ics_slot_report;
537 extern u8 gt1x_config[];
538 extern u32 gt1x_cfg_length;
539 extern u8 gt1x_int_type;
540 extern u8 gt1x_wakeup_level;
541 extern u32 gt1x_abs_x_max;
542 extern u32 gt1x_abs_y_max;
543 extern u8 gt1x_init_failed;
544 extern int gt1x_halt;
545 extern volatile int gt1x_rawdiff_mode;
546 
547 extern s32 gt1x_init(void);
548 extern void gt1x_deinit(void);
549 extern s32 gt1x_read_version(struct gt1x_version_info *ver_info);
550 extern s32 gt1x_init_panel(void);
551 extern s32 gt1x_get_chip_type(void);
552 extern s32 gt1x_request_event_handler(void);
553 extern int gt1x_send_cmd(u8 cmd, u8 data);
554 extern s32 gt1x_send_cfg(u8 *config, int cfg_len);
555 extern void gt1x_select_addr(void);
556 extern s32 gt1x_reset_guitar(void);
557 extern void gt1x_power_reset(void);
558 extern int gt1x_parse_config(char *filename, u8 *gt1x_config);
559 extern s32 gt1x_touch_event_handler(u8 *data, struct input_dev *dev, struct input_dev *pen_dev);
560 extern int gt1x_suspend(void);
561 extern int gt1x_resume(void);
562 
563 #if GTP_HAVE_TOUCH_KEY
564 extern const u16 gt1x_touch_key_array[];
565 #endif
566 
567 #if GTP_WITH_STYLUS
568 extern struct input_dev *pen_dev;
569 extern void gt1x_pen_up(s32 id);
570 extern void gt1x_pen_down(s32 x, s32 y, s32 size, s32 id);
571 #endif
572 
573 #if GTP_PROXIMITY
574 extern u8 gt1x_proximity_flag;
575 extern int gt1x_prox_event_handler(u8 *data);
576 #endif
577 
578 #if GTP_SMART_COVER
579 extern int gt1x_parse_sc_cfg(int sensor_id);
580 #endif
581 
582 #if GTP_ESD_PROTECT
583 extern void gt1x_init_esd_protect(void);
584 extern void gt1x_esd_switch(s32 on);
585 #endif
586 
587 #if GTP_CHARGER_SWITCH
588 extern u32 gt1x_get_charger_status(void);
589 extern void gt1x_charger_switch(s32 on);
590 extern void gt1x_charger_config(s32 dir_update);
591 extern int gt1x_parse_chr_cfg(int sensor_id);
592 #endif
593 
594 #endif
595 
596