Commit | Line | Data |
---|---|---|
4cf51c38 | 1 | /* |
7686b108 | 2 | * Atmel maXTouch Touchscreen driver |
4cf51c38 JS |
3 | * |
4 | * Copyright (C) 2010 Samsung Electronics Co.Ltd | |
50a77c65 | 5 | * Copyright (C) 2011-2014 Atmel Corporation |
1e0c0c5b DK |
6 | * Copyright (C) 2012 Google, Inc. |
7 | * | |
4cf51c38 JS |
8 | * Author: Joonyoung Shim <jy0922.shim@samsung.com> |
9 | * | |
10 | * This program is free software; you can redistribute it and/or modify it | |
11 | * under the terms of the GNU General Public License as published by the | |
12 | * Free Software Foundation; either version 2 of the License, or (at your | |
13 | * option) any later version. | |
14 | * | |
15 | */ | |
16 | ||
17 | #include <linux/module.h> | |
d79e7e47 BL |
18 | #include <linux/init.h> |
19 | #include <linux/completion.h> | |
4cf51c38 JS |
20 | #include <linux/delay.h> |
21 | #include <linux/firmware.h> | |
22 | #include <linux/i2c.h> | |
964de521 | 23 | #include <linux/i2c/atmel_mxt_ts.h> |
8b86c1c2 | 24 | #include <linux/input/mt.h> |
4cf51c38 | 25 | #include <linux/interrupt.h> |
78188be3 | 26 | #include <linux/of.h> |
4cf51c38 JS |
27 | #include <linux/slab.h> |
28 | ||
29 | /* Version */ | |
7686b108 IV |
30 | #define MXT_VER_20 20 |
31 | #define MXT_VER_21 21 | |
32 | #define MXT_VER_22 22 | |
4cf51c38 | 33 | |
50a77c65 | 34 | /* Firmware files */ |
7686b108 | 35 | #define MXT_FW_NAME "maxtouch.fw" |
50a77c65 ND |
36 | #define MXT_CFG_NAME "maxtouch.cfg" |
37 | #define MXT_CFG_MAGIC "OBP_RAW V1" | |
4cf51c38 JS |
38 | |
39 | /* Registers */ | |
23003a84 | 40 | #define MXT_INFO 0x00 |
7686b108 IV |
41 | #define MXT_FAMILY_ID 0x00 |
42 | #define MXT_VARIANT_ID 0x01 | |
43 | #define MXT_VERSION 0x02 | |
44 | #define MXT_BUILD 0x03 | |
45 | #define MXT_MATRIX_X_SIZE 0x04 | |
46 | #define MXT_MATRIX_Y_SIZE 0x05 | |
47 | #define MXT_OBJECT_NUM 0x06 | |
48 | #define MXT_OBJECT_START 0x07 | |
4cf51c38 | 49 | |
7686b108 | 50 | #define MXT_OBJECT_SIZE 6 |
4ce6fa01 ND |
51 | #define MXT_INFO_CHECKSUM_SIZE 3 |
52 | #define MXT_MAX_BLOCK_WRITE 256 | |
4cf51c38 JS |
53 | |
54 | /* Object types */ | |
81c88a71 IV |
55 | #define MXT_DEBUG_DIAGNOSTIC_T37 37 |
56 | #define MXT_GEN_MESSAGE_T5 5 | |
57 | #define MXT_GEN_COMMAND_T6 6 | |
58 | #define MXT_GEN_POWER_T7 7 | |
59 | #define MXT_GEN_ACQUIRE_T8 8 | |
60 | #define MXT_GEN_DATASOURCE_T53 53 | |
61 | #define MXT_TOUCH_MULTI_T9 9 | |
62 | #define MXT_TOUCH_KEYARRAY_T15 15 | |
63 | #define MXT_TOUCH_PROXIMITY_T23 23 | |
64 | #define MXT_TOUCH_PROXKEY_T52 52 | |
65 | #define MXT_PROCI_GRIPFACE_T20 20 | |
66 | #define MXT_PROCG_NOISE_T22 22 | |
67 | #define MXT_PROCI_ONETOUCH_T24 24 | |
68 | #define MXT_PROCI_TWOTOUCH_T27 27 | |
69 | #define MXT_PROCI_GRIP_T40 40 | |
70 | #define MXT_PROCI_PALM_T41 41 | |
71 | #define MXT_PROCI_TOUCHSUPPRESSION_T42 42 | |
72 | #define MXT_PROCI_STYLUS_T47 47 | |
73 | #define MXT_PROCG_NOISESUPPRESSION_T48 48 | |
74 | #define MXT_SPT_COMMSCONFIG_T18 18 | |
75 | #define MXT_SPT_GPIOPWM_T19 19 | |
76 | #define MXT_SPT_SELFTEST_T25 25 | |
77 | #define MXT_SPT_CTECONFIG_T28 28 | |
78 | #define MXT_SPT_USERDATA_T38 38 | |
79 | #define MXT_SPT_DIGITIZER_T43 43 | |
80 | #define MXT_SPT_MESSAGECOUNT_T44 44 | |
81 | #define MXT_SPT_CTECONFIG_T46 46 | |
82 | ||
83 | /* MXT_GEN_COMMAND_T6 field */ | |
7686b108 IV |
84 | #define MXT_COMMAND_RESET 0 |
85 | #define MXT_COMMAND_BACKUPNV 1 | |
86 | #define MXT_COMMAND_CALIBRATE 2 | |
87 | #define MXT_COMMAND_REPORTALL 3 | |
88 | #define MXT_COMMAND_DIAGNOSTIC 5 | |
89 | ||
a4a2ef46 IV |
90 | /* Define for T6 status byte */ |
91 | #define MXT_T6_STATUS_RESET (1 << 7) | |
92 | ||
81c88a71 | 93 | /* MXT_GEN_POWER_T7 field */ |
7686b108 IV |
94 | #define MXT_POWER_IDLEACQINT 0 |
95 | #define MXT_POWER_ACTVACQINT 1 | |
96 | #define MXT_POWER_ACTV2IDLETO 2 | |
97 | ||
81c88a71 | 98 | /* MXT_GEN_ACQUIRE_T8 field */ |
7686b108 IV |
99 | #define MXT_ACQUIRE_CHRGTIME 0 |
100 | #define MXT_ACQUIRE_TCHDRIFT 2 | |
101 | #define MXT_ACQUIRE_DRIFTST 3 | |
102 | #define MXT_ACQUIRE_TCHAUTOCAL 4 | |
103 | #define MXT_ACQUIRE_SYNC 5 | |
104 | #define MXT_ACQUIRE_ATCHCALST 6 | |
105 | #define MXT_ACQUIRE_ATCHCALSTHR 7 | |
106 | ||
81c88a71 | 107 | /* MXT_TOUCH_MULTI_T9 field */ |
7686b108 | 108 | #define MXT_TOUCH_CTRL 0 |
61dc1aba ND |
109 | #define MXT_T9_ORIENT 9 |
110 | #define MXT_T9_RANGE 18 | |
111 | ||
f3889ed1 ND |
112 | /* MXT_TOUCH_MULTI_T9 status */ |
113 | #define MXT_T9_UNGRIP (1 << 0) | |
114 | #define MXT_T9_SUPPRESS (1 << 1) | |
115 | #define MXT_T9_AMP (1 << 2) | |
116 | #define MXT_T9_VECTOR (1 << 3) | |
117 | #define MXT_T9_MOVE (1 << 4) | |
118 | #define MXT_T9_RELEASE (1 << 5) | |
119 | #define MXT_T9_PRESS (1 << 6) | |
120 | #define MXT_T9_DETECT (1 << 7) | |
121 | ||
61dc1aba ND |
122 | struct t9_range { |
123 | u16 x; | |
124 | u16 y; | |
125 | } __packed; | |
126 | ||
f3889ed1 ND |
127 | /* MXT_TOUCH_MULTI_T9 orient */ |
128 | #define MXT_T9_ORIENT_SWITCH (1 << 0) | |
7686b108 | 129 | |
81c88a71 | 130 | /* MXT_PROCI_GRIPFACE_T20 field */ |
7686b108 IV |
131 | #define MXT_GRIPFACE_CTRL 0 |
132 | #define MXT_GRIPFACE_XLOGRIP 1 | |
133 | #define MXT_GRIPFACE_XHIGRIP 2 | |
134 | #define MXT_GRIPFACE_YLOGRIP 3 | |
135 | #define MXT_GRIPFACE_YHIGRIP 4 | |
136 | #define MXT_GRIPFACE_MAXTCHS 5 | |
137 | #define MXT_GRIPFACE_SZTHR1 7 | |
138 | #define MXT_GRIPFACE_SZTHR2 8 | |
139 | #define MXT_GRIPFACE_SHPTHR1 9 | |
140 | #define MXT_GRIPFACE_SHPTHR2 10 | |
141 | #define MXT_GRIPFACE_SUPEXTTO 11 | |
142 | ||
143 | /* MXT_PROCI_NOISE field */ | |
144 | #define MXT_NOISE_CTRL 0 | |
145 | #define MXT_NOISE_OUTFLEN 1 | |
146 | #define MXT_NOISE_GCAFUL_LSB 3 | |
147 | #define MXT_NOISE_GCAFUL_MSB 4 | |
148 | #define MXT_NOISE_GCAFLL_LSB 5 | |
149 | #define MXT_NOISE_GCAFLL_MSB 6 | |
150 | #define MXT_NOISE_ACTVGCAFVALID 7 | |
151 | #define MXT_NOISE_NOISETHR 8 | |
152 | #define MXT_NOISE_FREQHOPSCALE 10 | |
153 | #define MXT_NOISE_FREQ0 11 | |
154 | #define MXT_NOISE_FREQ1 12 | |
155 | #define MXT_NOISE_FREQ2 13 | |
156 | #define MXT_NOISE_FREQ3 14 | |
157 | #define MXT_NOISE_FREQ4 15 | |
158 | #define MXT_NOISE_IDLEGCAFVALID 16 | |
159 | ||
81c88a71 | 160 | /* MXT_SPT_COMMSCONFIG_T18 */ |
7686b108 IV |
161 | #define MXT_COMMS_CTRL 0 |
162 | #define MXT_COMMS_CMD 1 | |
163 | ||
81c88a71 | 164 | /* MXT_SPT_CTECONFIG_T28 field */ |
7686b108 IV |
165 | #define MXT_CTE_CTRL 0 |
166 | #define MXT_CTE_CMD 1 | |
167 | #define MXT_CTE_MODE 2 | |
168 | #define MXT_CTE_IDLEGCAFDEPTH 3 | |
169 | #define MXT_CTE_ACTVGCAFDEPTH 4 | |
979a72da | 170 | #define MXT_CTE_VOLTAGE 5 |
7686b108 IV |
171 | |
172 | #define MXT_VOLTAGE_DEFAULT 2700000 | |
173 | #define MXT_VOLTAGE_STEP 10000 | |
174 | ||
81c88a71 | 175 | /* Define for MXT_GEN_COMMAND_T6 */ |
7686b108 | 176 | #define MXT_BOOT_VALUE 0xa5 |
a4a2ef46 | 177 | #define MXT_RESET_VALUE 0x01 |
7686b108 | 178 | #define MXT_BACKUP_VALUE 0x55 |
a4a2ef46 IV |
179 | |
180 | /* Delay times */ | |
8343bce1 LT |
181 | #define MXT_BACKUP_TIME 50 /* msec */ |
182 | #define MXT_RESET_TIME 200 /* msec */ | |
a4a2ef46 | 183 | #define MXT_RESET_TIMEOUT 3000 /* msec */ |
c3f78043 | 184 | #define MXT_CRC_TIMEOUT 1000 /* msec */ |
a0434b75 BL |
185 | #define MXT_FW_RESET_TIME 3000 /* msec */ |
186 | #define MXT_FW_CHG_TIMEOUT 300 /* msec */ | |
4cf51c38 JS |
187 | |
188 | /* Command to unlock bootloader */ | |
7686b108 IV |
189 | #define MXT_UNLOCK_CMD_MSB 0xaa |
190 | #define MXT_UNLOCK_CMD_LSB 0xdc | |
4cf51c38 JS |
191 | |
192 | /* Bootloader mode status */ | |
7686b108 IV |
193 | #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */ |
194 | #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */ | |
195 | #define MXT_FRAME_CRC_CHECK 0x02 | |
196 | #define MXT_FRAME_CRC_FAIL 0x03 | |
197 | #define MXT_FRAME_CRC_PASS 0x04 | |
198 | #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */ | |
199 | #define MXT_BOOT_STATUS_MASK 0x3f | |
e57a66aa ND |
200 | #define MXT_BOOT_EXTENDED_ID (1 << 5) |
201 | #define MXT_BOOT_ID_MASK 0x1f | |
4cf51c38 | 202 | |
4cf51c38 | 203 | /* Touchscreen absolute values */ |
7686b108 | 204 | #define MXT_MAX_AREA 0xff |
4cf51c38 | 205 | |
22dfab7f DK |
206 | #define MXT_PIXELS_PER_MM 20 |
207 | ||
7686b108 | 208 | struct mxt_info { |
4cf51c38 JS |
209 | u8 family_id; |
210 | u8 variant_id; | |
211 | u8 version; | |
212 | u8 build; | |
213 | u8 matrix_xsize; | |
214 | u8 matrix_ysize; | |
215 | u8 object_num; | |
216 | }; | |
217 | ||
7686b108 | 218 | struct mxt_object { |
4cf51c38 JS |
219 | u8 type; |
220 | u16 start_address; | |
1e0c0c5b DK |
221 | u8 size_minus_one; |
222 | u8 instances_minus_one; | |
4cf51c38 | 223 | u8 num_report_ids; |
333e5a9a | 224 | } __packed; |
4cf51c38 | 225 | |
7686b108 | 226 | struct mxt_message { |
4cf51c38 JS |
227 | u8 reportid; |
228 | u8 message[7]; | |
4cf51c38 JS |
229 | }; |
230 | ||
4cf51c38 | 231 | /* Each client has this additional data */ |
7686b108 | 232 | struct mxt_data { |
4cf51c38 JS |
233 | struct i2c_client *client; |
234 | struct input_dev *input_dev; | |
ec02ac2b | 235 | char phys[64]; /* device physical location */ |
7686b108 IV |
236 | const struct mxt_platform_data *pdata; |
237 | struct mxt_object *object_table; | |
238 | struct mxt_info info; | |
4cf51c38 | 239 | unsigned int irq; |
910d8051 JS |
240 | unsigned int max_x; |
241 | unsigned int max_y; | |
d79e7e47 | 242 | bool in_bootloader; |
4ce6fa01 | 243 | u16 mem_size; |
c3f78043 | 244 | u32 config_crc; |
4ce6fa01 | 245 | u32 info_crc; |
f28a842d | 246 | u8 bootloader_addr; |
333e5a9a DK |
247 | |
248 | /* Cached parameters from object table */ | |
fdf80421 | 249 | u8 T6_reportid; |
a4a2ef46 | 250 | u16 T6_address; |
4ce6fa01 | 251 | u16 T7_address; |
333e5a9a DK |
252 | u8 T9_reportid_min; |
253 | u8 T9_reportid_max; | |
22dfab7f | 254 | u8 T19_reportid; |
d79e7e47 BL |
255 | |
256 | /* for fw update in bootloader */ | |
257 | struct completion bl_completion; | |
a4a2ef46 IV |
258 | |
259 | /* for reset handling */ | |
260 | struct completion reset_completion; | |
c3f78043 ND |
261 | |
262 | /* for config update handling */ | |
263 | struct completion crc_completion; | |
4cf51c38 JS |
264 | }; |
265 | ||
1e0c0c5b DK |
266 | static size_t mxt_obj_size(const struct mxt_object *obj) |
267 | { | |
268 | return obj->size_minus_one + 1; | |
269 | } | |
270 | ||
271 | static size_t mxt_obj_instances(const struct mxt_object *obj) | |
272 | { | |
273 | return obj->instances_minus_one + 1; | |
274 | } | |
275 | ||
7686b108 | 276 | static bool mxt_object_readable(unsigned int type) |
4cf51c38 JS |
277 | { |
278 | switch (type) { | |
81c88a71 IV |
279 | case MXT_GEN_COMMAND_T6: |
280 | case MXT_GEN_POWER_T7: | |
281 | case MXT_GEN_ACQUIRE_T8: | |
282 | case MXT_GEN_DATASOURCE_T53: | |
283 | case MXT_TOUCH_MULTI_T9: | |
284 | case MXT_TOUCH_KEYARRAY_T15: | |
285 | case MXT_TOUCH_PROXIMITY_T23: | |
286 | case MXT_TOUCH_PROXKEY_T52: | |
287 | case MXT_PROCI_GRIPFACE_T20: | |
288 | case MXT_PROCG_NOISE_T22: | |
289 | case MXT_PROCI_ONETOUCH_T24: | |
290 | case MXT_PROCI_TWOTOUCH_T27: | |
291 | case MXT_PROCI_GRIP_T40: | |
292 | case MXT_PROCI_PALM_T41: | |
293 | case MXT_PROCI_TOUCHSUPPRESSION_T42: | |
294 | case MXT_PROCI_STYLUS_T47: | |
295 | case MXT_PROCG_NOISESUPPRESSION_T48: | |
296 | case MXT_SPT_COMMSCONFIG_T18: | |
297 | case MXT_SPT_GPIOPWM_T19: | |
298 | case MXT_SPT_SELFTEST_T25: | |
299 | case MXT_SPT_CTECONFIG_T28: | |
300 | case MXT_SPT_USERDATA_T38: | |
301 | case MXT_SPT_DIGITIZER_T43: | |
302 | case MXT_SPT_CTECONFIG_T46: | |
4cf51c38 JS |
303 | return true; |
304 | default: | |
305 | return false; | |
306 | } | |
307 | } | |
308 | ||
7686b108 | 309 | static void mxt_dump_message(struct device *dev, |
6ee3dbf9 | 310 | struct mxt_message *message) |
4cf51c38 | 311 | { |
eb007c86 AS |
312 | dev_dbg(dev, "reportid: %u\tmessage: %*ph\n", |
313 | message->reportid, 7, message->message); | |
4cf51c38 JS |
314 | } |
315 | ||
a4a2ef46 IV |
316 | static int mxt_wait_for_completion(struct mxt_data *data, |
317 | struct completion *comp, | |
318 | unsigned int timeout_ms) | |
d79e7e47 BL |
319 | { |
320 | struct device *dev = &data->client->dev; | |
d79e7e47 BL |
321 | unsigned long timeout = msecs_to_jiffies(timeout_ms); |
322 | long ret; | |
323 | ||
324 | ret = wait_for_completion_interruptible_timeout(comp, timeout); | |
325 | if (ret < 0) { | |
326 | return ret; | |
327 | } else if (ret == 0) { | |
328 | dev_err(dev, "Wait for completion timed out.\n"); | |
329 | return -ETIMEDOUT; | |
330 | } | |
331 | return 0; | |
332 | } | |
333 | ||
f28a842d ND |
334 | static int mxt_bootloader_read(struct mxt_data *data, |
335 | u8 *val, unsigned int count) | |
336 | { | |
337 | int ret; | |
338 | struct i2c_msg msg; | |
339 | ||
340 | msg.addr = data->bootloader_addr; | |
341 | msg.flags = data->client->flags & I2C_M_TEN; | |
342 | msg.flags |= I2C_M_RD; | |
343 | msg.len = count; | |
344 | msg.buf = val; | |
345 | ||
346 | ret = i2c_transfer(data->client->adapter, &msg, 1); | |
347 | ||
348 | if (ret == 1) { | |
349 | ret = 0; | |
350 | } else { | |
351 | ret = ret < 0 ? ret : -EIO; | |
352 | dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n", | |
353 | __func__, ret); | |
354 | } | |
355 | ||
356 | return ret; | |
357 | } | |
358 | ||
359 | static int mxt_bootloader_write(struct mxt_data *data, | |
360 | const u8 * const val, unsigned int count) | |
361 | { | |
362 | int ret; | |
363 | struct i2c_msg msg; | |
364 | ||
365 | msg.addr = data->bootloader_addr; | |
366 | msg.flags = data->client->flags & I2C_M_TEN; | |
367 | msg.len = count; | |
368 | msg.buf = (u8 *)val; | |
369 | ||
370 | ret = i2c_transfer(data->client->adapter, &msg, 1); | |
371 | if (ret == 1) { | |
372 | ret = 0; | |
373 | } else { | |
374 | ret = ret < 0 ? ret : -EIO; | |
375 | dev_err(&data->client->dev, "%s: i2c send failed (%d)\n", | |
376 | __func__, ret); | |
377 | } | |
378 | ||
379 | return ret; | |
380 | } | |
381 | ||
382 | static int mxt_lookup_bootloader_address(struct mxt_data *data) | |
383 | { | |
384 | u8 appmode = data->client->addr; | |
385 | u8 bootloader; | |
386 | ||
387 | switch (appmode) { | |
388 | case 0x4a: | |
389 | case 0x4b: | |
390 | case 0x4c: | |
391 | case 0x4d: | |
392 | case 0x5a: | |
393 | case 0x5b: | |
394 | bootloader = appmode - 0x26; | |
395 | break; | |
396 | default: | |
397 | dev_err(&data->client->dev, | |
398 | "Appmode i2c address 0x%02x not found\n", | |
399 | appmode); | |
400 | return -EINVAL; | |
401 | } | |
402 | ||
403 | data->bootloader_addr = bootloader; | |
404 | return 0; | |
405 | } | |
406 | ||
a9fdd1e6 ND |
407 | static int mxt_probe_bootloader(struct mxt_data *data) |
408 | { | |
409 | struct device *dev = &data->client->dev; | |
410 | int ret; | |
411 | u8 val; | |
412 | bool crc_failure; | |
413 | ||
414 | ret = mxt_lookup_bootloader_address(data); | |
415 | if (ret) | |
416 | return ret; | |
417 | ||
418 | ret = mxt_bootloader_read(data, &val, 1); | |
419 | if (ret) | |
420 | return ret; | |
421 | ||
422 | /* Check app crc fail mode */ | |
423 | crc_failure = (val & ~MXT_BOOT_STATUS_MASK) == MXT_APP_CRC_FAIL; | |
424 | ||
425 | dev_err(dev, "Detected bootloader, status:%02X%s\n", | |
426 | val, crc_failure ? ", APP_CRC_FAIL" : ""); | |
427 | ||
428 | return 0; | |
429 | } | |
430 | ||
e57a66aa ND |
431 | static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val) |
432 | { | |
433 | struct device *dev = &data->client->dev; | |
434 | u8 buf[3]; | |
435 | ||
436 | if (val & MXT_BOOT_EXTENDED_ID) { | |
437 | if (mxt_bootloader_read(data, &buf[0], 3) != 0) { | |
438 | dev_err(dev, "%s: i2c failure\n", __func__); | |
68807a0c | 439 | return val; |
e57a66aa ND |
440 | } |
441 | ||
442 | dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]); | |
443 | ||
444 | return buf[0]; | |
445 | } else { | |
446 | dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK); | |
447 | ||
448 | return val; | |
449 | } | |
450 | } | |
451 | ||
385deb96 ND |
452 | static int mxt_check_bootloader(struct mxt_data *data, unsigned int state, |
453 | bool wait) | |
4cf51c38 | 454 | { |
f28a842d | 455 | struct device *dev = &data->client->dev; |
4cf51c38 | 456 | u8 val; |
d79e7e47 | 457 | int ret; |
4cf51c38 JS |
458 | |
459 | recheck: | |
385deb96 | 460 | if (wait) { |
d79e7e47 BL |
461 | /* |
462 | * In application update mode, the interrupt | |
463 | * line signals state transitions. We must wait for the | |
464 | * CHG assertion before reading the status byte. | |
465 | * Once the status byte has been read, the line is deasserted. | |
466 | */ | |
a4a2ef46 IV |
467 | ret = mxt_wait_for_completion(data, &data->bl_completion, |
468 | MXT_FW_CHG_TIMEOUT); | |
d79e7e47 BL |
469 | if (ret) { |
470 | /* | |
471 | * TODO: handle -ERESTARTSYS better by terminating | |
472 | * fw update process before returning to userspace | |
473 | * by writing length 0x000 to device (iff we are in | |
474 | * WAITING_FRAME_DATA state). | |
475 | */ | |
f28a842d | 476 | dev_err(dev, "Update wait error %d\n", ret); |
d79e7e47 BL |
477 | return ret; |
478 | } | |
479 | } | |
480 | ||
f28a842d ND |
481 | ret = mxt_bootloader_read(data, &val, 1); |
482 | if (ret) | |
483 | return ret; | |
4cf51c38 | 484 | |
e57a66aa ND |
485 | if (state == MXT_WAITING_BOOTLOAD_CMD) |
486 | val = mxt_get_bootloader_version(data, val); | |
487 | ||
4cf51c38 | 488 | switch (state) { |
7686b108 IV |
489 | case MXT_WAITING_BOOTLOAD_CMD: |
490 | case MXT_WAITING_FRAME_DATA: | |
a9fdd1e6 | 491 | case MXT_APP_CRC_FAIL: |
7686b108 | 492 | val &= ~MXT_BOOT_STATUS_MASK; |
4cf51c38 | 493 | break; |
7686b108 | 494 | case MXT_FRAME_CRC_PASS: |
f943c74a | 495 | if (val == MXT_FRAME_CRC_CHECK) { |
4cf51c38 | 496 | goto recheck; |
f943c74a ND |
497 | } else if (val == MXT_FRAME_CRC_FAIL) { |
498 | dev_err(dev, "Bootloader CRC fail\n"); | |
499 | return -EINVAL; | |
500 | } | |
4cf51c38 JS |
501 | break; |
502 | default: | |
503 | return -EINVAL; | |
504 | } | |
505 | ||
506 | if (val != state) { | |
f28a842d | 507 | dev_err(dev, "Invalid bootloader state %02X != %02X\n", |
7bed6805 | 508 | val, state); |
4cf51c38 JS |
509 | return -EINVAL; |
510 | } | |
511 | ||
512 | return 0; | |
513 | } | |
514 | ||
f28a842d | 515 | static int mxt_unlock_bootloader(struct mxt_data *data) |
4cf51c38 | 516 | { |
f28a842d | 517 | int ret; |
4cf51c38 JS |
518 | u8 buf[2]; |
519 | ||
7686b108 IV |
520 | buf[0] = MXT_UNLOCK_CMD_LSB; |
521 | buf[1] = MXT_UNLOCK_CMD_MSB; | |
4cf51c38 | 522 | |
f28a842d ND |
523 | ret = mxt_bootloader_write(data, buf, 2); |
524 | if (ret) | |
525 | return ret; | |
4cf51c38 JS |
526 | |
527 | return 0; | |
528 | } | |
529 | ||
7686b108 | 530 | static int __mxt_read_reg(struct i2c_client *client, |
4cf51c38 JS |
531 | u16 reg, u16 len, void *val) |
532 | { | |
533 | struct i2c_msg xfer[2]; | |
534 | u8 buf[2]; | |
771733e3 | 535 | int ret; |
4cf51c38 JS |
536 | |
537 | buf[0] = reg & 0xff; | |
538 | buf[1] = (reg >> 8) & 0xff; | |
539 | ||
540 | /* Write register */ | |
541 | xfer[0].addr = client->addr; | |
542 | xfer[0].flags = 0; | |
543 | xfer[0].len = 2; | |
544 | xfer[0].buf = buf; | |
545 | ||
546 | /* Read data */ | |
547 | xfer[1].addr = client->addr; | |
548 | xfer[1].flags = I2C_M_RD; | |
549 | xfer[1].len = len; | |
550 | xfer[1].buf = val; | |
551 | ||
771733e3 DK |
552 | ret = i2c_transfer(client->adapter, xfer, 2); |
553 | if (ret == 2) { | |
554 | ret = 0; | |
555 | } else { | |
556 | if (ret >= 0) | |
557 | ret = -EIO; | |
558 | dev_err(&client->dev, "%s: i2c transfer failed (%d)\n", | |
559 | __func__, ret); | |
4cf51c38 JS |
560 | } |
561 | ||
771733e3 | 562 | return ret; |
4cf51c38 JS |
563 | } |
564 | ||
9638ab7c DK |
565 | static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len, |
566 | const void *val) | |
4cf51c38 | 567 | { |
9638ab7c DK |
568 | u8 *buf; |
569 | size_t count; | |
771733e3 | 570 | int ret; |
4cf51c38 | 571 | |
9638ab7c DK |
572 | count = len + 2; |
573 | buf = kmalloc(count, GFP_KERNEL); | |
574 | if (!buf) | |
575 | return -ENOMEM; | |
4cf51c38 JS |
576 | |
577 | buf[0] = reg & 0xff; | |
578 | buf[1] = (reg >> 8) & 0xff; | |
9638ab7c | 579 | memcpy(&buf[2], val, len); |
4cf51c38 | 580 | |
9638ab7c DK |
581 | ret = i2c_master_send(client, buf, count); |
582 | if (ret == count) { | |
771733e3 DK |
583 | ret = 0; |
584 | } else { | |
585 | if (ret >= 0) | |
586 | ret = -EIO; | |
587 | dev_err(&client->dev, "%s: i2c send failed (%d)\n", | |
588 | __func__, ret); | |
4cf51c38 JS |
589 | } |
590 | ||
9638ab7c | 591 | kfree(buf); |
771733e3 | 592 | return ret; |
4cf51c38 JS |
593 | } |
594 | ||
9638ab7c | 595 | static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val) |
4cf51c38 | 596 | { |
9638ab7c | 597 | return __mxt_write_reg(client, reg, 1, &val); |
4cf51c38 JS |
598 | } |
599 | ||
7686b108 IV |
600 | static struct mxt_object * |
601 | mxt_get_object(struct mxt_data *data, u8 type) | |
4cf51c38 | 602 | { |
7686b108 | 603 | struct mxt_object *object; |
4cf51c38 JS |
604 | int i; |
605 | ||
606 | for (i = 0; i < data->info.object_num; i++) { | |
607 | object = data->object_table + i; | |
608 | if (object->type == type) | |
609 | return object; | |
610 | } | |
611 | ||
50a77c65 | 612 | dev_warn(&data->client->dev, "Invalid object type T%u\n", type); |
4cf51c38 JS |
613 | return NULL; |
614 | } | |
615 | ||
7686b108 IV |
616 | static int mxt_read_message(struct mxt_data *data, |
617 | struct mxt_message *message) | |
4cf51c38 | 618 | { |
7686b108 | 619 | struct mxt_object *object; |
4cf51c38 JS |
620 | u16 reg; |
621 | ||
81c88a71 | 622 | object = mxt_get_object(data, MXT_GEN_MESSAGE_T5); |
4cf51c38 JS |
623 | if (!object) |
624 | return -EINVAL; | |
625 | ||
626 | reg = object->start_address; | |
7686b108 IV |
627 | return __mxt_read_reg(data->client, reg, |
628 | sizeof(struct mxt_message), message); | |
4cf51c38 JS |
629 | } |
630 | ||
7686b108 | 631 | static int mxt_write_object(struct mxt_data *data, |
4cf51c38 JS |
632 | u8 type, u8 offset, u8 val) |
633 | { | |
7686b108 | 634 | struct mxt_object *object; |
4cf51c38 JS |
635 | u16 reg; |
636 | ||
7686b108 | 637 | object = mxt_get_object(data, type); |
1e0c0c5b | 638 | if (!object || offset >= mxt_obj_size(object)) |
4cf51c38 JS |
639 | return -EINVAL; |
640 | ||
641 | reg = object->start_address; | |
7686b108 | 642 | return mxt_write_reg(data->client, reg + offset, val); |
4cf51c38 JS |
643 | } |
644 | ||
22dfab7f DK |
645 | static void mxt_input_button(struct mxt_data *data, struct mxt_message *message) |
646 | { | |
647 | struct input_dev *input = data->input_dev; | |
fb5e4c3e | 648 | const struct mxt_platform_data *pdata = data->pdata; |
22dfab7f DK |
649 | bool button; |
650 | int i; | |
651 | ||
652 | /* Active-low switch */ | |
fb5e4c3e ND |
653 | for (i = 0; i < pdata->t19_num_keys; i++) { |
654 | if (pdata->t19_keymap[i] == KEY_RESERVED) | |
22dfab7f | 655 | continue; |
fb5e4c3e ND |
656 | button = !(message->message[0] & (1 << i)); |
657 | input_report_key(input, pdata->t19_keymap[i], button); | |
22dfab7f DK |
658 | } |
659 | } | |
660 | ||
b735fbe0 | 661 | static void mxt_input_sync(struct mxt_data *data) |
eef820dc | 662 | { |
b735fbe0 BL |
663 | input_mt_report_pointer_emulation(data->input_dev, |
664 | data->pdata->t19_num_keys); | |
665 | input_sync(data->input_dev); | |
eef820dc ND |
666 | } |
667 | ||
7686b108 IV |
668 | static void mxt_input_touchevent(struct mxt_data *data, |
669 | struct mxt_message *message, int id) | |
4cf51c38 | 670 | { |
4cf51c38 JS |
671 | struct device *dev = &data->client->dev; |
672 | u8 status = message->message[0]; | |
fba5bc31 | 673 | struct input_dev *input_dev = data->input_dev; |
4cf51c38 JS |
674 | int x; |
675 | int y; | |
676 | int area; | |
fea9e467 | 677 | int amplitude; |
4cf51c38 | 678 | |
910d8051 JS |
679 | x = (message->message[1] << 4) | ((message->message[3] >> 4) & 0xf); |
680 | y = (message->message[2] << 4) | ((message->message[3] & 0xf)); | |
eef820dc ND |
681 | |
682 | /* Handle 10/12 bit switching */ | |
910d8051 | 683 | if (data->max_x < 1024) |
eef820dc | 684 | x >>= 2; |
910d8051 | 685 | if (data->max_y < 1024) |
eef820dc | 686 | y >>= 2; |
910d8051 | 687 | |
4cf51c38 | 688 | area = message->message[4]; |
fea9e467 | 689 | amplitude = message->message[5]; |
4cf51c38 | 690 | |
b2e459b8 DK |
691 | dev_dbg(dev, |
692 | "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n", | |
693 | id, | |
f3889ed1 ND |
694 | (status & MXT_T9_DETECT) ? 'D' : '.', |
695 | (status & MXT_T9_PRESS) ? 'P' : '.', | |
696 | (status & MXT_T9_RELEASE) ? 'R' : '.', | |
697 | (status & MXT_T9_MOVE) ? 'M' : '.', | |
698 | (status & MXT_T9_VECTOR) ? 'V' : '.', | |
699 | (status & MXT_T9_AMP) ? 'A' : '.', | |
700 | (status & MXT_T9_SUPPRESS) ? 'S' : '.', | |
701 | (status & MXT_T9_UNGRIP) ? 'U' : '.', | |
fea9e467 | 702 | x, y, area, amplitude); |
b2e459b8 | 703 | |
fba5bc31 | 704 | input_mt_slot(input_dev, id); |
fba5bc31 | 705 | |
f3889ed1 | 706 | if (status & MXT_T9_DETECT) { |
eef820dc ND |
707 | /* |
708 | * Multiple bits may be set if the host is slow to read | |
709 | * the status messages, indicating all the events that | |
710 | * have happened. | |
711 | */ | |
712 | if (status & MXT_T9_RELEASE) { | |
713 | input_mt_report_slot_state(input_dev, | |
714 | MT_TOOL_FINGER, 0); | |
b735fbe0 | 715 | mxt_input_sync(data); |
eef820dc ND |
716 | } |
717 | ||
718 | /* Touch active */ | |
719 | input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1); | |
fba5bc31 DK |
720 | input_report_abs(input_dev, ABS_MT_POSITION_X, x); |
721 | input_report_abs(input_dev, ABS_MT_POSITION_Y, y); | |
fea9e467 | 722 | input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude); |
fba5bc31 | 723 | input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area); |
eef820dc ND |
724 | } else { |
725 | /* Touch no longer active, close out slot */ | |
726 | input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 0); | |
fba5bc31 | 727 | } |
4cf51c38 | 728 | } |
4cf51c38 | 729 | |
c3f78043 | 730 | static u16 mxt_extract_T6_csum(const u8 *csum) |
fdf80421 DK |
731 | { |
732 | return csum[0] | (csum[1] << 8) | (csum[2] << 16); | |
733 | } | |
4cf51c38 | 734 | |
04a79181 DK |
735 | static bool mxt_is_T9_message(struct mxt_data *data, struct mxt_message *msg) |
736 | { | |
737 | u8 id = msg->reportid; | |
738 | return (id >= data->T9_reportid_min && id <= data->T9_reportid_max); | |
4cf51c38 JS |
739 | } |
740 | ||
d79e7e47 | 741 | static irqreturn_t mxt_process_messages_until_invalid(struct mxt_data *data) |
4cf51c38 | 742 | { |
7686b108 | 743 | struct mxt_message message; |
fdf80421 | 744 | const u8 *payload = &message.message[0]; |
4cf51c38 | 745 | struct device *dev = &data->client->dev; |
4cf51c38 | 746 | u8 reportid; |
64464ae8 | 747 | bool update_input = false; |
c3f78043 | 748 | u32 crc; |
4cf51c38 JS |
749 | |
750 | do { | |
7686b108 | 751 | if (mxt_read_message(data, &message)) { |
4cf51c38 | 752 | dev_err(dev, "Failed to read message\n"); |
8d4e1639 | 753 | return IRQ_NONE; |
4cf51c38 JS |
754 | } |
755 | ||
756 | reportid = message.reportid; | |
757 | ||
fdf80421 DK |
758 | if (reportid == data->T6_reportid) { |
759 | u8 status = payload[0]; | |
c3f78043 ND |
760 | |
761 | crc = mxt_extract_T6_csum(&payload[1]); | |
762 | if (crc != data->config_crc) { | |
763 | data->config_crc = crc; | |
764 | complete(&data->crc_completion); | |
765 | } | |
766 | ||
fdf80421 | 767 | dev_dbg(dev, "Status: %02x Config Checksum: %06x\n", |
c3f78043 | 768 | status, data->config_crc); |
a4a2ef46 IV |
769 | |
770 | if (status & MXT_T6_STATUS_RESET) | |
771 | complete(&data->reset_completion); | |
dd24dcf5 ND |
772 | } else if (!data->input_dev) { |
773 | /* | |
774 | * do not report events if input device | |
775 | * is not yet registered | |
776 | */ | |
777 | mxt_dump_message(dev, &message); | |
fdf80421 DK |
778 | } else if (mxt_is_T9_message(data, &message)) { |
779 | int id = reportid - data->T9_reportid_min; | |
7686b108 | 780 | mxt_input_touchevent(data, &message, id); |
64464ae8 | 781 | update_input = true; |
22dfab7f DK |
782 | } else if (message.reportid == data->T19_reportid) { |
783 | mxt_input_button(data, &message); | |
784 | update_input = true; | |
64464ae8 | 785 | } else { |
7686b108 | 786 | mxt_dump_message(dev, &message); |
64464ae8 | 787 | } |
4cf51c38 JS |
788 | } while (reportid != 0xff); |
789 | ||
eef820dc | 790 | if (update_input) |
b735fbe0 | 791 | mxt_input_sync(data); |
64464ae8 | 792 | |
4cf51c38 JS |
793 | return IRQ_HANDLED; |
794 | } | |
795 | ||
d79e7e47 BL |
796 | static irqreturn_t mxt_interrupt(int irq, void *dev_id) |
797 | { | |
798 | struct mxt_data *data = dev_id; | |
799 | ||
800 | if (data->in_bootloader) { | |
801 | /* bootloader state transition completion */ | |
802 | complete(&data->bl_completion); | |
803 | return IRQ_HANDLED; | |
804 | } | |
805 | ||
dd24dcf5 ND |
806 | if (!data->object_table) |
807 | return IRQ_HANDLED; | |
808 | ||
d79e7e47 BL |
809 | return mxt_process_messages_until_invalid(data); |
810 | } | |
811 | ||
a4a2ef46 IV |
812 | static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset, |
813 | u8 value, bool wait) | |
814 | { | |
815 | u16 reg; | |
816 | u8 command_register; | |
817 | int timeout_counter = 0; | |
818 | int ret; | |
819 | ||
820 | reg = data->T6_address + cmd_offset; | |
821 | ||
822 | ret = mxt_write_reg(data->client, reg, value); | |
823 | if (ret) | |
824 | return ret; | |
825 | ||
826 | if (!wait) | |
827 | return 0; | |
828 | ||
829 | do { | |
830 | msleep(20); | |
831 | ret = __mxt_read_reg(data->client, reg, 1, &command_register); | |
832 | if (ret) | |
833 | return ret; | |
834 | } while (command_register != 0 && timeout_counter++ <= 100); | |
835 | ||
836 | if (timeout_counter > 100) { | |
837 | dev_err(&data->client->dev, "Command failed!\n"); | |
838 | return -EIO; | |
839 | } | |
840 | ||
841 | return 0; | |
842 | } | |
843 | ||
844 | static int mxt_soft_reset(struct mxt_data *data) | |
845 | { | |
846 | struct device *dev = &data->client->dev; | |
847 | int ret = 0; | |
848 | ||
849 | dev_info(dev, "Resetting chip\n"); | |
850 | ||
851 | reinit_completion(&data->reset_completion); | |
852 | ||
853 | ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false); | |
854 | if (ret) | |
855 | return ret; | |
856 | ||
857 | ret = mxt_wait_for_completion(data, &data->reset_completion, | |
858 | MXT_RESET_TIMEOUT); | |
859 | if (ret) | |
860 | return ret; | |
861 | ||
862 | return 0; | |
863 | } | |
864 | ||
c3f78043 ND |
865 | static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value) |
866 | { | |
867 | /* | |
868 | * On failure, CRC is set to 0 and config will always be | |
869 | * downloaded. | |
870 | */ | |
871 | data->config_crc = 0; | |
872 | reinit_completion(&data->crc_completion); | |
873 | ||
874 | mxt_t6_command(data, cmd, value, true); | |
875 | ||
876 | /* | |
877 | * Wait for crc message. On failure, CRC is set to 0 and config will | |
878 | * always be downloaded. | |
879 | */ | |
880 | mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT); | |
881 | } | |
882 | ||
4ce6fa01 ND |
883 | static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte) |
884 | { | |
885 | static const unsigned int crcpoly = 0x80001B; | |
886 | u32 result; | |
887 | u32 data_word; | |
888 | ||
889 | data_word = (secondbyte << 8) | firstbyte; | |
890 | result = ((*crc << 1) ^ data_word); | |
891 | ||
892 | if (result & 0x1000000) | |
893 | result ^= crcpoly; | |
894 | ||
895 | *crc = result; | |
896 | } | |
897 | ||
898 | static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off) | |
899 | { | |
900 | u32 crc = 0; | |
901 | u8 *ptr = base + start_off; | |
902 | u8 *last_val = base + end_off - 1; | |
903 | ||
904 | if (end_off < start_off) | |
905 | return -EINVAL; | |
906 | ||
907 | while (ptr < last_val) { | |
908 | mxt_calc_crc24(&crc, *ptr, *(ptr + 1)); | |
909 | ptr += 2; | |
910 | } | |
911 | ||
912 | /* if len is odd, fill the last byte with 0 */ | |
913 | if (ptr == last_val) | |
914 | mxt_calc_crc24(&crc, *ptr, 0); | |
915 | ||
916 | /* Mask to 24-bit */ | |
917 | crc &= 0x00FFFFFF; | |
918 | ||
919 | return crc; | |
920 | } | |
921 | ||
50a77c65 ND |
922 | /* |
923 | * mxt_update_cfg - download configuration to chip | |
924 | * | |
925 | * Atmel Raw Config File Format | |
926 | * | |
927 | * The first four lines of the raw config file contain: | |
928 | * 1) Version | |
929 | * 2) Chip ID Information (first 7 bytes of device memory) | |
930 | * 3) Chip Information Block 24-bit CRC Checksum | |
931 | * 4) Chip Configuration 24-bit CRC Checksum | |
932 | * | |
933 | * The rest of the file consists of one line per object instance: | |
934 | * <TYPE> <INSTANCE> <SIZE> <CONTENTS> | |
935 | * | |
936 | * <TYPE> - 2-byte object type as hex | |
937 | * <INSTANCE> - 2-byte object instance number as hex | |
938 | * <SIZE> - 2-byte object size as hex | |
939 | * <CONTENTS> - array of <SIZE> 1-byte hex values | |
940 | */ | |
941 | static int mxt_update_cfg(struct mxt_data *data, const struct firmware *cfg) | |
4cf51c38 | 942 | { |
4cf51c38 | 943 | struct device *dev = &data->client->dev; |
50a77c65 ND |
944 | struct mxt_info cfg_info; |
945 | struct mxt_object *object; | |
cf94bc09 | 946 | int ret; |
50a77c65 | 947 | int offset; |
4ce6fa01 ND |
948 | int data_pos; |
949 | int byte_offset; | |
50a77c65 | 950 | int i; |
4ce6fa01 ND |
951 | int cfg_start_ofs; |
952 | u32 info_crc, config_crc, calculated_crc; | |
953 | u8 *config_mem; | |
954 | size_t config_mem_size; | |
50a77c65 ND |
955 | unsigned int type, instance, size; |
956 | u8 val; | |
957 | u16 reg; | |
4cf51c38 | 958 | |
50a77c65 ND |
959 | mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1); |
960 | ||
961 | if (strncmp(cfg->data, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) { | |
962 | dev_err(dev, "Unrecognised config file\n"); | |
963 | ret = -EINVAL; | |
964 | goto release; | |
4cf51c38 JS |
965 | } |
966 | ||
4ce6fa01 | 967 | data_pos = strlen(MXT_CFG_MAGIC); |
50a77c65 ND |
968 | |
969 | /* Load information block and check */ | |
970 | for (i = 0; i < sizeof(struct mxt_info); i++) { | |
4ce6fa01 | 971 | ret = sscanf(cfg->data + data_pos, "%hhx%n", |
50a77c65 ND |
972 | (unsigned char *)&cfg_info + i, |
973 | &offset); | |
974 | if (ret != 1) { | |
975 | dev_err(dev, "Bad format\n"); | |
976 | ret = -EINVAL; | |
977 | goto release; | |
978 | } | |
c3f78043 | 979 | |
4ce6fa01 | 980 | data_pos += offset; |
c3f78043 ND |
981 | } |
982 | ||
50a77c65 ND |
983 | if (cfg_info.family_id != data->info.family_id) { |
984 | dev_err(dev, "Family ID mismatch!\n"); | |
985 | ret = -EINVAL; | |
986 | goto release; | |
987 | } | |
c3f78043 | 988 | |
50a77c65 ND |
989 | if (cfg_info.variant_id != data->info.variant_id) { |
990 | dev_err(dev, "Variant ID mismatch!\n"); | |
991 | ret = -EINVAL; | |
992 | goto release; | |
993 | } | |
4cf51c38 | 994 | |
4ce6fa01 ND |
995 | /* Read CRCs */ |
996 | ret = sscanf(cfg->data + data_pos, "%x%n", &info_crc, &offset); | |
50a77c65 ND |
997 | if (ret != 1) { |
998 | dev_err(dev, "Bad format: failed to parse Info CRC\n"); | |
999 | ret = -EINVAL; | |
1000 | goto release; | |
1001 | } | |
4ce6fa01 | 1002 | data_pos += offset; |
50a77c65 | 1003 | |
4ce6fa01 | 1004 | ret = sscanf(cfg->data + data_pos, "%x%n", &config_crc, &offset); |
50a77c65 ND |
1005 | if (ret != 1) { |
1006 | dev_err(dev, "Bad format: failed to parse Config CRC\n"); | |
1007 | ret = -EINVAL; | |
1008 | goto release; | |
1009 | } | |
4ce6fa01 | 1010 | data_pos += offset; |
50a77c65 | 1011 | |
4ce6fa01 ND |
1012 | /* |
1013 | * The Info Block CRC is calculated over mxt_info and the object | |
1014 | * table. If it does not match then we are trying to load the | |
1015 | * configuration from a different chip or firmware version, so | |
1016 | * the configuration CRC is invalid anyway. | |
1017 | */ | |
1018 | if (info_crc == data->info_crc) { | |
1019 | if (config_crc == 0 || data->config_crc == 0) { | |
1020 | dev_info(dev, "CRC zero, attempting to apply config\n"); | |
1021 | } else if (config_crc == data->config_crc) { | |
1022 | dev_dbg(dev, "Config CRC 0x%06X: OK\n", | |
1023 | data->config_crc); | |
1024 | ret = 0; | |
1025 | goto release; | |
1026 | } else { | |
1027 | dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n", | |
1028 | data->config_crc, config_crc); | |
1029 | } | |
1030 | } else { | |
1031 | dev_warn(dev, | |
1032 | "Warning: Info CRC error - device=0x%06X file=0x%06X\n", | |
1033 | data->info_crc, info_crc); | |
50a77c65 ND |
1034 | } |
1035 | ||
4ce6fa01 ND |
1036 | /* Malloc memory to store configuration */ |
1037 | cfg_start_ofs = MXT_OBJECT_START + | |
1038 | data->info.object_num * sizeof(struct mxt_object) + | |
1039 | MXT_INFO_CHECKSUM_SIZE; | |
1040 | config_mem_size = data->mem_size - cfg_start_ofs; | |
1041 | config_mem = kzalloc(config_mem_size, GFP_KERNEL); | |
1042 | if (!config_mem) { | |
1043 | dev_err(dev, "Failed to allocate memory\n"); | |
1044 | ret = -ENOMEM; | |
1045 | goto release; | |
1046 | } | |
50a77c65 | 1047 | |
4ce6fa01 | 1048 | while (data_pos < cfg->size) { |
50a77c65 | 1049 | /* Read type, instance, length */ |
4ce6fa01 | 1050 | ret = sscanf(cfg->data + data_pos, "%x %x %x%n", |
50a77c65 ND |
1051 | &type, &instance, &size, &offset); |
1052 | if (ret == 0) { | |
1053 | /* EOF */ | |
4ce6fa01 | 1054 | break; |
50a77c65 ND |
1055 | } else if (ret != 3) { |
1056 | dev_err(dev, "Bad format: failed to parse object\n"); | |
1057 | ret = -EINVAL; | |
4ce6fa01 | 1058 | goto release_mem; |
50a77c65 | 1059 | } |
4ce6fa01 | 1060 | data_pos += offset; |
50a77c65 ND |
1061 | |
1062 | object = mxt_get_object(data, type); | |
1063 | if (!object) { | |
1064 | /* Skip object */ | |
1065 | for (i = 0; i < size; i++) { | |
4ce6fa01 | 1066 | ret = sscanf(cfg->data + data_pos, "%hhx%n", |
50a77c65 ND |
1067 | &val, |
1068 | &offset); | |
4ce6fa01 | 1069 | data_pos += offset; |
50a77c65 | 1070 | } |
4cf51c38 | 1071 | continue; |
50a77c65 | 1072 | } |
4cf51c38 | 1073 | |
50a77c65 | 1074 | if (size > mxt_obj_size(object)) { |
4ce6fa01 ND |
1075 | /* |
1076 | * Either we are in fallback mode due to wrong | |
1077 | * config or config from a later fw version, | |
1078 | * or the file is corrupt or hand-edited. | |
1079 | */ | |
1080 | dev_warn(dev, "Discarding %zu byte(s) in T%u\n", | |
1081 | size - mxt_obj_size(object), type); | |
1082 | } else if (mxt_obj_size(object) > size) { | |
1083 | /* | |
1084 | * If firmware is upgraded, new bytes may be added to | |
1085 | * end of objects. It is generally forward compatible | |
1086 | * to zero these bytes - previous behaviour will be | |
1087 | * retained. However this does invalidate the CRC and | |
1088 | * will force fallback mode until the configuration is | |
1089 | * updated. We warn here but do nothing else - the | |
1090 | * malloc has zeroed the entire configuration. | |
1091 | */ | |
1092 | dev_warn(dev, "Zeroing %zu byte(s) in T%d\n", | |
1093 | mxt_obj_size(object) - size, type); | |
71749f5c | 1094 | } |
cf94bc09 | 1095 | |
50a77c65 ND |
1096 | if (instance >= mxt_obj_instances(object)) { |
1097 | dev_err(dev, "Object instances exceeded!\n"); | |
1098 | ret = -EINVAL; | |
4ce6fa01 | 1099 | goto release_mem; |
50a77c65 ND |
1100 | } |
1101 | ||
1102 | reg = object->start_address + mxt_obj_size(object) * instance; | |
1103 | ||
1104 | for (i = 0; i < size; i++) { | |
4ce6fa01 | 1105 | ret = sscanf(cfg->data + data_pos, "%hhx%n", |
50a77c65 ND |
1106 | &val, |
1107 | &offset); | |
1108 | if (ret != 1) { | |
1109 | dev_err(dev, "Bad format in T%d\n", type); | |
1110 | ret = -EINVAL; | |
4ce6fa01 | 1111 | goto release_mem; |
50a77c65 | 1112 | } |
4ce6fa01 | 1113 | data_pos += offset; |
50a77c65 ND |
1114 | |
1115 | if (i > mxt_obj_size(object)) | |
1116 | continue; | |
1117 | ||
4ce6fa01 | 1118 | byte_offset = reg + i - cfg_start_ofs; |
50a77c65 | 1119 | |
4ce6fa01 ND |
1120 | if ((byte_offset >= 0) |
1121 | && (byte_offset <= config_mem_size)) { | |
1122 | *(config_mem + byte_offset) = val; | |
1123 | } else { | |
1124 | dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n", | |
1125 | reg, object->type, byte_offset); | |
1126 | ret = -EINVAL; | |
1127 | goto release_mem; | |
1128 | } | |
50a77c65 | 1129 | } |
4ce6fa01 | 1130 | } |
50a77c65 | 1131 | |
4ce6fa01 ND |
1132 | /* Calculate crc of the received configs (not the raw config file) */ |
1133 | if (data->T7_address < cfg_start_ofs) { | |
1134 | dev_err(dev, "Bad T7 address, T7addr = %x, config offset %x\n", | |
1135 | data->T7_address, cfg_start_ofs); | |
1136 | ret = 0; | |
1137 | goto release_mem; | |
1138 | } | |
50a77c65 | 1139 | |
4ce6fa01 ND |
1140 | calculated_crc = mxt_calculate_crc(config_mem, |
1141 | data->T7_address - cfg_start_ofs, | |
1142 | config_mem_size); | |
1143 | ||
1144 | if (config_crc > 0 && (config_crc != calculated_crc)) | |
1145 | dev_warn(dev, "Config CRC error, calculated=%06X, file=%06X\n", | |
1146 | calculated_crc, config_crc); | |
1147 | ||
1148 | /* Write configuration as blocks */ | |
1149 | byte_offset = 0; | |
1150 | while (byte_offset < config_mem_size) { | |
1151 | size = config_mem_size - byte_offset; | |
1152 | ||
1153 | if (size > MXT_MAX_BLOCK_WRITE) | |
1154 | size = MXT_MAX_BLOCK_WRITE; | |
1155 | ||
1156 | ret = __mxt_write_reg(data->client, | |
1157 | cfg_start_ofs + byte_offset, | |
1158 | size, config_mem + byte_offset); | |
1159 | if (ret != 0) { | |
1160 | dev_err(dev, "Config write error, ret=%d\n", ret); | |
1161 | goto release_mem; | |
50a77c65 | 1162 | } |
4ce6fa01 ND |
1163 | |
1164 | byte_offset += size; | |
4cf51c38 JS |
1165 | } |
1166 | ||
c3f78043 ND |
1167 | mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE); |
1168 | ||
1169 | ret = mxt_soft_reset(data); | |
1170 | if (ret) | |
4ce6fa01 | 1171 | goto release_mem; |
c3f78043 ND |
1172 | |
1173 | dev_info(dev, "Config successfully updated\n"); | |
1174 | ||
4ce6fa01 ND |
1175 | release_mem: |
1176 | kfree(config_mem); | |
50a77c65 ND |
1177 | release: |
1178 | release_firmware(cfg); | |
1179 | return ret; | |
4cf51c38 JS |
1180 | } |
1181 | ||
7686b108 | 1182 | static int mxt_make_highchg(struct mxt_data *data) |
4cf51c38 JS |
1183 | { |
1184 | struct device *dev = &data->client->dev; | |
26cdb1ae | 1185 | struct mxt_message message; |
4cf51c38 JS |
1186 | int count = 10; |
1187 | int error; | |
4cf51c38 JS |
1188 | |
1189 | /* Read dummy message to make high CHG pin */ | |
1190 | do { | |
26cdb1ae | 1191 | error = mxt_read_message(data, &message); |
4cf51c38 JS |
1192 | if (error) |
1193 | return error; | |
26cdb1ae | 1194 | } while (message.reportid != 0xff && --count); |
4cf51c38 JS |
1195 | |
1196 | if (!count) { | |
1197 | dev_err(dev, "CHG pin isn't cleared\n"); | |
1198 | return -EBUSY; | |
1199 | } | |
1200 | ||
1201 | return 0; | |
1202 | } | |
1203 | ||
dd24dcf5 ND |
1204 | static int mxt_acquire_irq(struct mxt_data *data) |
1205 | { | |
1206 | int error; | |
1207 | ||
1208 | enable_irq(data->irq); | |
1209 | ||
1210 | error = mxt_make_highchg(data); | |
1211 | if (error) | |
1212 | return error; | |
1213 | ||
1214 | return 0; | |
1215 | } | |
1216 | ||
7686b108 | 1217 | static int mxt_get_info(struct mxt_data *data) |
4cf51c38 JS |
1218 | { |
1219 | struct i2c_client *client = data->client; | |
7686b108 | 1220 | struct mxt_info *info = &data->info; |
4cf51c38 | 1221 | int error; |
4cf51c38 | 1222 | |
23003a84 DK |
1223 | /* Read 7-byte info block starting at address 0 */ |
1224 | error = __mxt_read_reg(client, MXT_INFO, sizeof(*info), info); | |
4cf51c38 JS |
1225 | if (error) |
1226 | return error; | |
4cf51c38 JS |
1227 | |
1228 | return 0; | |
1229 | } | |
1230 | ||
7686b108 | 1231 | static int mxt_get_object_table(struct mxt_data *data) |
4cf51c38 | 1232 | { |
333e5a9a DK |
1233 | struct i2c_client *client = data->client; |
1234 | size_t table_size; | |
dd24dcf5 | 1235 | struct mxt_object *object_table; |
4cf51c38 JS |
1236 | int error; |
1237 | int i; | |
333e5a9a | 1238 | u8 reportid; |
4ce6fa01 | 1239 | u16 end_address; |
333e5a9a DK |
1240 | |
1241 | table_size = data->info.object_num * sizeof(struct mxt_object); | |
dd24dcf5 ND |
1242 | object_table = kzalloc(table_size, GFP_KERNEL); |
1243 | if (!object_table) { | |
1244 | dev_err(&data->client->dev, "Failed to allocate memory\n"); | |
1245 | return -ENOMEM; | |
1246 | } | |
1247 | ||
333e5a9a | 1248 | error = __mxt_read_reg(client, MXT_OBJECT_START, table_size, |
dd24dcf5 ND |
1249 | object_table); |
1250 | if (error) { | |
1251 | kfree(object_table); | |
333e5a9a | 1252 | return error; |
dd24dcf5 | 1253 | } |
4cf51c38 | 1254 | |
333e5a9a DK |
1255 | /* Valid Report IDs start counting from 1 */ |
1256 | reportid = 1; | |
4ce6fa01 | 1257 | data->mem_size = 0; |
4cf51c38 | 1258 | for (i = 0; i < data->info.object_num; i++) { |
dd24dcf5 | 1259 | struct mxt_object *object = object_table + i; |
333e5a9a | 1260 | u8 min_id, max_id; |
4cf51c38 | 1261 | |
333e5a9a | 1262 | le16_to_cpus(&object->start_address); |
4cf51c38 JS |
1263 | |
1264 | if (object->num_report_ids) { | |
333e5a9a | 1265 | min_id = reportid; |
4cf51c38 | 1266 | reportid += object->num_report_ids * |
1e0c0c5b | 1267 | mxt_obj_instances(object); |
333e5a9a DK |
1268 | max_id = reportid - 1; |
1269 | } else { | |
1270 | min_id = 0; | |
1271 | max_id = 0; | |
1272 | } | |
1273 | ||
1274 | dev_dbg(&data->client->dev, | |
7bed6805 | 1275 | "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n", |
1e0c0c5b DK |
1276 | object->type, object->start_address, |
1277 | mxt_obj_size(object), mxt_obj_instances(object), | |
1278 | min_id, max_id); | |
333e5a9a DK |
1279 | |
1280 | switch (object->type) { | |
fdf80421 DK |
1281 | case MXT_GEN_COMMAND_T6: |
1282 | data->T6_reportid = min_id; | |
a4a2ef46 | 1283 | data->T6_address = object->start_address; |
fdf80421 | 1284 | break; |
4ce6fa01 ND |
1285 | case MXT_GEN_POWER_T7: |
1286 | data->T7_address = object->start_address; | |
1287 | break; | |
333e5a9a DK |
1288 | case MXT_TOUCH_MULTI_T9: |
1289 | data->T9_reportid_min = min_id; | |
1290 | data->T9_reportid_max = max_id; | |
1291 | break; | |
22dfab7f DK |
1292 | case MXT_SPT_GPIOPWM_T19: |
1293 | data->T19_reportid = min_id; | |
1294 | break; | |
4cf51c38 | 1295 | } |
4ce6fa01 ND |
1296 | |
1297 | end_address = object->start_address | |
1298 | + mxt_obj_size(object) * mxt_obj_instances(object) - 1; | |
1299 | ||
1300 | if (end_address >= data->mem_size) | |
1301 | data->mem_size = end_address + 1; | |
4cf51c38 JS |
1302 | } |
1303 | ||
dd24dcf5 ND |
1304 | data->object_table = object_table; |
1305 | ||
4cf51c38 JS |
1306 | return 0; |
1307 | } | |
1308 | ||
7d4fa100 DK |
1309 | static void mxt_free_object_table(struct mxt_data *data) |
1310 | { | |
7a53d609 ND |
1311 | input_unregister_device(data->input_dev); |
1312 | data->input_dev = NULL; | |
1313 | ||
7d4fa100 DK |
1314 | kfree(data->object_table); |
1315 | data->object_table = NULL; | |
fdf80421 | 1316 | data->T6_reportid = 0; |
333e5a9a DK |
1317 | data->T9_reportid_min = 0; |
1318 | data->T9_reportid_max = 0; | |
22dfab7f | 1319 | data->T19_reportid = 0; |
7d4fa100 DK |
1320 | } |
1321 | ||
61dc1aba ND |
1322 | static int mxt_read_t9_resolution(struct mxt_data *data) |
1323 | { | |
1324 | struct i2c_client *client = data->client; | |
1325 | int error; | |
1326 | struct t9_range range; | |
1327 | unsigned char orient; | |
1328 | struct mxt_object *object; | |
1329 | ||
1330 | object = mxt_get_object(data, MXT_TOUCH_MULTI_T9); | |
1331 | if (!object) | |
1332 | return -EINVAL; | |
1333 | ||
1334 | error = __mxt_read_reg(client, | |
1335 | object->start_address + MXT_T9_RANGE, | |
1336 | sizeof(range), &range); | |
1337 | if (error) | |
1338 | return error; | |
1339 | ||
1340 | le16_to_cpus(&range.x); | |
1341 | le16_to_cpus(&range.y); | |
1342 | ||
1343 | error = __mxt_read_reg(client, | |
1344 | object->start_address + MXT_T9_ORIENT, | |
1345 | 1, &orient); | |
1346 | if (error) | |
1347 | return error; | |
1348 | ||
1349 | /* Handle default values */ | |
1350 | if (range.x == 0) | |
1351 | range.x = 1023; | |
1352 | ||
1353 | if (range.y == 0) | |
1354 | range.y = 1023; | |
1355 | ||
f3889ed1 | 1356 | if (orient & MXT_T9_ORIENT_SWITCH) { |
61dc1aba ND |
1357 | data->max_x = range.y; |
1358 | data->max_y = range.x; | |
1359 | } else { | |
1360 | data->max_x = range.x; | |
1361 | data->max_y = range.y; | |
1362 | } | |
1363 | ||
1364 | dev_dbg(&client->dev, | |
1365 | "Touchscreen size X%uY%u\n", data->max_x, data->max_y); | |
1366 | ||
1367 | return 0; | |
1368 | } | |
1369 | ||
7a53d609 ND |
1370 | static int mxt_input_open(struct input_dev *dev); |
1371 | static void mxt_input_close(struct input_dev *dev); | |
1372 | ||
1373 | static int mxt_initialize_t9_input_device(struct mxt_data *data) | |
1374 | { | |
1375 | struct device *dev = &data->client->dev; | |
1376 | const struct mxt_platform_data *pdata = data->pdata; | |
1377 | struct input_dev *input_dev; | |
1378 | int error; | |
1379 | unsigned int num_mt_slots; | |
1380 | unsigned int mt_flags = 0; | |
1381 | int i; | |
1382 | ||
1383 | error = mxt_read_t9_resolution(data); | |
1384 | if (error) | |
1385 | dev_warn(dev, "Failed to initialize T9 resolution\n"); | |
1386 | ||
1387 | input_dev = input_allocate_device(); | |
1388 | if (!input_dev) { | |
1389 | dev_err(dev, "Failed to allocate memory\n"); | |
1390 | return -ENOMEM; | |
1391 | } | |
1392 | ||
1393 | input_dev->name = "Atmel maXTouch Touchscreen"; | |
1394 | input_dev->phys = data->phys; | |
1395 | input_dev->id.bustype = BUS_I2C; | |
1396 | input_dev->dev.parent = dev; | |
1397 | input_dev->open = mxt_input_open; | |
1398 | input_dev->close = mxt_input_close; | |
1399 | ||
1400 | __set_bit(EV_ABS, input_dev->evbit); | |
1401 | __set_bit(EV_KEY, input_dev->evbit); | |
1402 | __set_bit(BTN_TOUCH, input_dev->keybit); | |
1403 | ||
1404 | if (pdata->t19_num_keys) { | |
1405 | __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit); | |
1406 | ||
1407 | for (i = 0; i < pdata->t19_num_keys; i++) | |
1408 | if (pdata->t19_keymap[i] != KEY_RESERVED) | |
1409 | input_set_capability(input_dev, EV_KEY, | |
1410 | pdata->t19_keymap[i]); | |
1411 | ||
1412 | mt_flags |= INPUT_MT_POINTER; | |
1413 | ||
1414 | input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM); | |
1415 | input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM); | |
1416 | input_abs_set_res(input_dev, ABS_MT_POSITION_X, | |
1417 | MXT_PIXELS_PER_MM); | |
1418 | input_abs_set_res(input_dev, ABS_MT_POSITION_Y, | |
1419 | MXT_PIXELS_PER_MM); | |
1420 | ||
1421 | input_dev->name = "Atmel maXTouch Touchpad"; | |
1422 | } | |
1423 | ||
1424 | /* For single touch */ | |
1425 | input_set_abs_params(input_dev, ABS_X, | |
1426 | 0, data->max_x, 0, 0); | |
1427 | input_set_abs_params(input_dev, ABS_Y, | |
1428 | 0, data->max_y, 0, 0); | |
1429 | input_set_abs_params(input_dev, ABS_PRESSURE, | |
1430 | 0, 255, 0, 0); | |
1431 | ||
1432 | /* For multi touch */ | |
1433 | num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1; | |
1434 | error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags); | |
1435 | if (error) { | |
1436 | dev_err(dev, "Error %d initialising slots\n", error); | |
1437 | goto err_free_mem; | |
1438 | } | |
1439 | ||
1440 | input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR, | |
1441 | 0, MXT_MAX_AREA, 0, 0); | |
1442 | input_set_abs_params(input_dev, ABS_MT_POSITION_X, | |
1443 | 0, data->max_x, 0, 0); | |
1444 | input_set_abs_params(input_dev, ABS_MT_POSITION_Y, | |
1445 | 0, data->max_y, 0, 0); | |
1446 | input_set_abs_params(input_dev, ABS_MT_PRESSURE, | |
1447 | 0, 255, 0, 0); | |
1448 | ||
1449 | input_set_drvdata(input_dev, data); | |
1450 | ||
1451 | error = input_register_device(input_dev); | |
1452 | if (error) { | |
1453 | dev_err(dev, "Error %d registering input device\n", error); | |
1454 | goto err_free_mem; | |
1455 | } | |
1456 | ||
1457 | data->input_dev = input_dev; | |
1458 | ||
1459 | return 0; | |
1460 | ||
1461 | err_free_mem: | |
1462 | input_free_device(input_dev); | |
1463 | return error; | |
1464 | } | |
1465 | ||
50a77c65 ND |
1466 | static int mxt_configure_objects(struct mxt_data *data, |
1467 | const struct firmware *cfg); | |
1468 | ||
1469 | static void mxt_config_cb(const struct firmware *cfg, void *ctx) | |
1470 | { | |
1471 | mxt_configure_objects(ctx, cfg); | |
1472 | } | |
1473 | ||
7686b108 | 1474 | static int mxt_initialize(struct mxt_data *data) |
4cf51c38 JS |
1475 | { |
1476 | struct i2c_client *client = data->client; | |
4cf51c38 | 1477 | int error; |
4cf51c38 | 1478 | |
7686b108 | 1479 | error = mxt_get_info(data); |
a9fdd1e6 ND |
1480 | if (error) { |
1481 | error = mxt_probe_bootloader(data); | |
1482 | if (error) | |
1483 | return error; | |
1484 | ||
1485 | data->in_bootloader = true; | |
1486 | return 0; | |
1487 | } | |
4cf51c38 | 1488 | |
4cf51c38 | 1489 | /* Get object table information */ |
7686b108 | 1490 | error = mxt_get_object_table(data); |
7bed6805 ND |
1491 | if (error) { |
1492 | dev_err(&client->dev, "Error %d reading object table\n", error); | |
dd24dcf5 | 1493 | return error; |
7bed6805 | 1494 | } |
4cf51c38 | 1495 | |
dd24dcf5 ND |
1496 | mxt_acquire_irq(data); |
1497 | if (error) | |
1498 | goto err_free_object_table; | |
1499 | ||
50a77c65 ND |
1500 | request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME, |
1501 | &data->client->dev, GFP_KERNEL, data, | |
1502 | mxt_config_cb); | |
1503 | ||
1504 | return 0; | |
1505 | ||
1506 | err_free_object_table: | |
1507 | mxt_free_object_table(data); | |
1508 | return error; | |
1509 | } | |
1510 | ||
1511 | static int mxt_configure_objects(struct mxt_data *data, | |
1512 | const struct firmware *cfg) | |
1513 | { | |
1514 | struct device *dev = &data->client->dev; | |
1515 | struct mxt_info *info = &data->info; | |
1516 | int error; | |
1517 | ||
1518 | if (cfg) { | |
1519 | error = mxt_update_cfg(data, cfg); | |
1520 | if (error) | |
1521 | dev_warn(dev, "Error %d updating config\n", error); | |
7bed6805 | 1522 | } |
4cf51c38 | 1523 | |
7a53d609 ND |
1524 | error = mxt_initialize_t9_input_device(data); |
1525 | if (error) | |
50a77c65 | 1526 | return error; |
4cf51c38 | 1527 | |
50a77c65 | 1528 | dev_info(dev, |
61dc1aba ND |
1529 | "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n", |
1530 | info->family_id, info->variant_id, info->version >> 4, | |
1531 | info->version & 0xf, info->build, info->object_num); | |
4cf51c38 JS |
1532 | |
1533 | return 0; | |
1534 | } | |
1535 | ||
b19fc9ec DK |
1536 | /* Firmware Version is returned as Major.Minor.Build */ |
1537 | static ssize_t mxt_fw_version_show(struct device *dev, | |
1538 | struct device_attribute *attr, char *buf) | |
1539 | { | |
1540 | struct mxt_data *data = dev_get_drvdata(dev); | |
1541 | struct mxt_info *info = &data->info; | |
1542 | return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n", | |
1543 | info->version >> 4, info->version & 0xf, info->build); | |
1544 | } | |
1545 | ||
1546 | /* Hardware Version is returned as FamilyID.VariantID */ | |
1547 | static ssize_t mxt_hw_version_show(struct device *dev, | |
1548 | struct device_attribute *attr, char *buf) | |
1549 | { | |
1550 | struct mxt_data *data = dev_get_drvdata(dev); | |
1551 | struct mxt_info *info = &data->info; | |
1552 | return scnprintf(buf, PAGE_SIZE, "%u.%u\n", | |
1553 | info->family_id, info->variant_id); | |
1554 | } | |
1555 | ||
794eb67e DK |
1556 | static ssize_t mxt_show_instance(char *buf, int count, |
1557 | struct mxt_object *object, int instance, | |
1558 | const u8 *val) | |
1559 | { | |
1560 | int i; | |
1561 | ||
1e0c0c5b | 1562 | if (mxt_obj_instances(object) > 1) |
794eb67e DK |
1563 | count += scnprintf(buf + count, PAGE_SIZE - count, |
1564 | "Instance %u\n", instance); | |
1565 | ||
1e0c0c5b | 1566 | for (i = 0; i < mxt_obj_size(object); i++) |
794eb67e DK |
1567 | count += scnprintf(buf + count, PAGE_SIZE - count, |
1568 | "\t[%2u]: %02x (%d)\n", i, val[i], val[i]); | |
1569 | count += scnprintf(buf + count, PAGE_SIZE - count, "\n"); | |
1570 | ||
1571 | return count; | |
1572 | } | |
1573 | ||
7686b108 | 1574 | static ssize_t mxt_object_show(struct device *dev, |
4cf51c38 JS |
1575 | struct device_attribute *attr, char *buf) |
1576 | { | |
7686b108 IV |
1577 | struct mxt_data *data = dev_get_drvdata(dev); |
1578 | struct mxt_object *object; | |
4cf51c38 JS |
1579 | int count = 0; |
1580 | int i, j; | |
1581 | int error; | |
43a91d51 | 1582 | u8 *obuf; |
4cf51c38 | 1583 | |
43a91d51 DK |
1584 | /* Pre-allocate buffer large enough to hold max sized object. */ |
1585 | obuf = kmalloc(256, GFP_KERNEL); | |
1586 | if (!obuf) | |
1587 | return -ENOMEM; | |
4cf51c38 | 1588 | |
43a91d51 | 1589 | error = 0; |
4cf51c38 JS |
1590 | for (i = 0; i < data->info.object_num; i++) { |
1591 | object = data->object_table + i; | |
1592 | ||
91630955 | 1593 | if (!mxt_object_readable(object->type)) |
4cf51c38 | 1594 | continue; |
4cf51c38 | 1595 | |
91630955 DK |
1596 | count += scnprintf(buf + count, PAGE_SIZE - count, |
1597 | "T%u:\n", object->type); | |
4cf51c38 | 1598 | |
1e0c0c5b DK |
1599 | for (j = 0; j < mxt_obj_instances(object); j++) { |
1600 | u16 size = mxt_obj_size(object); | |
794eb67e | 1601 | u16 addr = object->start_address + j * size; |
43a91d51 | 1602 | |
794eb67e | 1603 | error = __mxt_read_reg(data->client, addr, size, obuf); |
4cf51c38 | 1604 | if (error) |
794eb67e | 1605 | goto done; |
4cf51c38 | 1606 | |
794eb67e | 1607 | count = mxt_show_instance(buf, count, object, j, obuf); |
4cf51c38 | 1608 | } |
4cf51c38 JS |
1609 | } |
1610 | ||
794eb67e | 1611 | done: |
43a91d51 DK |
1612 | kfree(obuf); |
1613 | return error ?: count; | |
4cf51c38 JS |
1614 | } |
1615 | ||
f2ac6cb9 ND |
1616 | static int mxt_check_firmware_format(struct device *dev, |
1617 | const struct firmware *fw) | |
1618 | { | |
1619 | unsigned int pos = 0; | |
1620 | char c; | |
1621 | ||
1622 | while (pos < fw->size) { | |
1623 | c = *(fw->data + pos); | |
1624 | ||
1625 | if (c < '0' || (c > '9' && c < 'A') || c > 'F') | |
1626 | return 0; | |
1627 | ||
1628 | pos++; | |
1629 | } | |
1630 | ||
1631 | /* | |
1632 | * To convert file try: | |
1633 | * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw | |
1634 | */ | |
1635 | dev_err(dev, "Aborting: firmware file must be in binary format\n"); | |
1636 | ||
1637 | return -EINVAL; | |
1638 | } | |
1639 | ||
7686b108 | 1640 | static int mxt_load_fw(struct device *dev, const char *fn) |
4cf51c38 | 1641 | { |
7686b108 | 1642 | struct mxt_data *data = dev_get_drvdata(dev); |
4cf51c38 JS |
1643 | const struct firmware *fw = NULL; |
1644 | unsigned int frame_size; | |
1645 | unsigned int pos = 0; | |
f943c74a | 1646 | unsigned int retry = 0; |
f477c758 | 1647 | unsigned int frame = 0; |
4cf51c38 JS |
1648 | int ret; |
1649 | ||
1650 | ret = request_firmware(&fw, fn, dev); | |
1651 | if (ret) { | |
1652 | dev_err(dev, "Unable to open firmware %s\n", fn); | |
1653 | return ret; | |
1654 | } | |
1655 | ||
f2ac6cb9 ND |
1656 | /* Check for incorrect enc file */ |
1657 | ret = mxt_check_firmware_format(dev, fw); | |
1658 | if (ret) | |
1659 | goto release_firmware; | |
1660 | ||
f28a842d ND |
1661 | ret = mxt_lookup_bootloader_address(data); |
1662 | if (ret) | |
1663 | goto release_firmware; | |
1664 | ||
a9fdd1e6 ND |
1665 | if (!data->in_bootloader) { |
1666 | /* Change to the bootloader mode */ | |
1667 | data->in_bootloader = true; | |
d79e7e47 | 1668 | |
a9fdd1e6 ND |
1669 | ret = mxt_t6_command(data, MXT_COMMAND_RESET, |
1670 | MXT_BOOT_VALUE, false); | |
1671 | if (ret) | |
1672 | goto release_firmware; | |
a4a2ef46 | 1673 | |
a9fdd1e6 ND |
1674 | msleep(MXT_RESET_TIME); |
1675 | } | |
4cf51c38 | 1676 | |
a9fdd1e6 | 1677 | mxt_free_object_table(data); |
d79e7e47 BL |
1678 | reinit_completion(&data->bl_completion); |
1679 | ||
385deb96 ND |
1680 | ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false); |
1681 | if (ret) { | |
1682 | /* Bootloader may still be unlocked from previous attempt */ | |
1683 | ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, false); | |
1684 | if (ret) | |
1685 | goto disable_irq; | |
1686 | } else { | |
1687 | dev_info(dev, "Unlocking bootloader\n"); | |
4cf51c38 | 1688 | |
385deb96 ND |
1689 | /* Unlock bootloader */ |
1690 | ret = mxt_unlock_bootloader(data); | |
1691 | if (ret) | |
1692 | goto disable_irq; | |
1693 | } | |
4cf51c38 JS |
1694 | |
1695 | while (pos < fw->size) { | |
385deb96 | 1696 | ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, true); |
4cf51c38 | 1697 | if (ret) |
d79e7e47 | 1698 | goto disable_irq; |
4cf51c38 JS |
1699 | |
1700 | frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1)); | |
1701 | ||
f943c74a | 1702 | /* Take account of CRC bytes */ |
4cf51c38 JS |
1703 | frame_size += 2; |
1704 | ||
1705 | /* Write one frame to device */ | |
f28a842d ND |
1706 | ret = mxt_bootloader_write(data, fw->data + pos, frame_size); |
1707 | if (ret) | |
1708 | goto disable_irq; | |
4cf51c38 | 1709 | |
385deb96 | 1710 | ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true); |
f943c74a ND |
1711 | if (ret) { |
1712 | retry++; | |
1713 | ||
1714 | /* Back off by 20ms per retry */ | |
1715 | msleep(retry * 20); | |
4cf51c38 | 1716 | |
f943c74a ND |
1717 | if (retry > 20) { |
1718 | dev_err(dev, "Retry count exceeded\n"); | |
1719 | goto disable_irq; | |
1720 | } | |
1721 | } else { | |
1722 | retry = 0; | |
1723 | pos += frame_size; | |
f477c758 | 1724 | frame++; |
f943c74a | 1725 | } |
4cf51c38 | 1726 | |
f477c758 ND |
1727 | if (frame % 50 == 0) |
1728 | dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n", | |
1729 | frame, pos, fw->size); | |
4cf51c38 JS |
1730 | } |
1731 | ||
a0434b75 | 1732 | /* Wait for flash. */ |
a4a2ef46 IV |
1733 | ret = mxt_wait_for_completion(data, &data->bl_completion, |
1734 | MXT_FW_RESET_TIME); | |
a0434b75 BL |
1735 | if (ret) |
1736 | goto disable_irq; | |
1737 | ||
f477c758 ND |
1738 | dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos); |
1739 | ||
a0434b75 BL |
1740 | /* |
1741 | * Wait for device to reset. Some bootloader versions do not assert | |
1742 | * the CHG line after bootloading has finished, so ignore potential | |
1743 | * errors. | |
1744 | */ | |
a4a2ef46 | 1745 | mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME); |
a0434b75 | 1746 | |
d79e7e47 BL |
1747 | data->in_bootloader = false; |
1748 | ||
1749 | disable_irq: | |
1750 | disable_irq(data->irq); | |
a4a2ef46 | 1751 | release_firmware: |
4cf51c38 | 1752 | release_firmware(fw); |
4cf51c38 JS |
1753 | return ret; |
1754 | } | |
1755 | ||
7686b108 | 1756 | static ssize_t mxt_update_fw_store(struct device *dev, |
4cf51c38 JS |
1757 | struct device_attribute *attr, |
1758 | const char *buf, size_t count) | |
1759 | { | |
7686b108 | 1760 | struct mxt_data *data = dev_get_drvdata(dev); |
4cf51c38 JS |
1761 | int error; |
1762 | ||
7686b108 | 1763 | error = mxt_load_fw(dev, MXT_FW_NAME); |
4cf51c38 JS |
1764 | if (error) { |
1765 | dev_err(dev, "The firmware update failed(%d)\n", error); | |
1766 | count = error; | |
1767 | } else { | |
7bed6805 ND |
1768 | dev_info(dev, "The firmware update succeeded\n"); |
1769 | ||
dd24dcf5 | 1770 | error = mxt_initialize(data); |
d79e7e47 BL |
1771 | if (error) |
1772 | return error; | |
1773 | } | |
08960a07 | 1774 | |
4cf51c38 JS |
1775 | return count; |
1776 | } | |
1777 | ||
b19fc9ec DK |
1778 | static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL); |
1779 | static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL); | |
71b3e938 DK |
1780 | static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL); |
1781 | static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store); | |
4cf51c38 | 1782 | |
7686b108 | 1783 | static struct attribute *mxt_attrs[] = { |
b19fc9ec DK |
1784 | &dev_attr_fw_version.attr, |
1785 | &dev_attr_hw_version.attr, | |
4cf51c38 JS |
1786 | &dev_attr_object.attr, |
1787 | &dev_attr_update_fw.attr, | |
1788 | NULL | |
1789 | }; | |
1790 | ||
7686b108 IV |
1791 | static const struct attribute_group mxt_attr_group = { |
1792 | .attrs = mxt_attrs, | |
4cf51c38 JS |
1793 | }; |
1794 | ||
7686b108 | 1795 | static void mxt_start(struct mxt_data *data) |
4cf51c38 JS |
1796 | { |
1797 | /* Touch enable */ | |
7686b108 | 1798 | mxt_write_object(data, |
81c88a71 | 1799 | MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0x83); |
4cf51c38 JS |
1800 | } |
1801 | ||
7686b108 | 1802 | static void mxt_stop(struct mxt_data *data) |
4cf51c38 JS |
1803 | { |
1804 | /* Touch disable */ | |
7686b108 | 1805 | mxt_write_object(data, |
81c88a71 | 1806 | MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0); |
4cf51c38 JS |
1807 | } |
1808 | ||
7686b108 | 1809 | static int mxt_input_open(struct input_dev *dev) |
4cf51c38 | 1810 | { |
7686b108 | 1811 | struct mxt_data *data = input_get_drvdata(dev); |
4cf51c38 | 1812 | |
7686b108 | 1813 | mxt_start(data); |
4cf51c38 JS |
1814 | |
1815 | return 0; | |
1816 | } | |
1817 | ||
7686b108 | 1818 | static void mxt_input_close(struct input_dev *dev) |
4cf51c38 | 1819 | { |
7686b108 | 1820 | struct mxt_data *data = input_get_drvdata(dev); |
4cf51c38 | 1821 | |
7686b108 | 1822 | mxt_stop(data); |
4cf51c38 JS |
1823 | } |
1824 | ||
78188be3 SW |
1825 | #ifdef CONFIG_OF |
1826 | static struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client) | |
1827 | { | |
1828 | struct mxt_platform_data *pdata; | |
1829 | u32 *keymap; | |
1830 | u32 keycode; | |
1831 | int proplen, i, ret; | |
1832 | ||
1833 | if (!client->dev.of_node) | |
1834 | return ERR_PTR(-ENODEV); | |
1835 | ||
1836 | pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL); | |
1837 | if (!pdata) | |
1838 | return ERR_PTR(-ENOMEM); | |
1839 | ||
1840 | if (of_find_property(client->dev.of_node, "linux,gpio-keymap", | |
1841 | &proplen)) { | |
1842 | pdata->t19_num_keys = proplen / sizeof(u32); | |
1843 | ||
1844 | keymap = devm_kzalloc(&client->dev, | |
1845 | pdata->t19_num_keys * sizeof(keymap[0]), | |
1846 | GFP_KERNEL); | |
1847 | if (!keymap) | |
1848 | return ERR_PTR(-ENOMEM); | |
1849 | ||
1850 | for (i = 0; i < pdata->t19_num_keys; i++) { | |
1851 | ret = of_property_read_u32_index(client->dev.of_node, | |
1852 | "linux,gpio-keymap", i, &keycode); | |
1853 | if (ret) | |
1854 | keycode = KEY_RESERVED; | |
1855 | ||
1856 | keymap[i] = keycode; | |
1857 | } | |
1858 | ||
1859 | pdata->t19_keymap = keymap; | |
1860 | } | |
1861 | ||
1862 | return pdata; | |
1863 | } | |
1864 | #else | |
1865 | static struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client) | |
1866 | { | |
1867 | dev_dbg(&client->dev, "No platform data specified\n"); | |
1868 | return ERR_PTR(-EINVAL); | |
1869 | } | |
1870 | #endif | |
1871 | ||
1872 | static int mxt_probe(struct i2c_client *client, const struct i2c_device_id *id) | |
4cf51c38 | 1873 | { |
7686b108 | 1874 | struct mxt_data *data; |
78188be3 | 1875 | const struct mxt_platform_data *pdata; |
4cf51c38 JS |
1876 | int error; |
1877 | ||
78188be3 SW |
1878 | pdata = dev_get_platdata(&client->dev); |
1879 | if (!pdata) { | |
1880 | pdata = mxt_parse_dt(client); | |
1881 | if (IS_ERR(pdata)) | |
1882 | return PTR_ERR(pdata); | |
1883 | } | |
4cf51c38 | 1884 | |
7686b108 | 1885 | data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL); |
7a53d609 | 1886 | if (!data) { |
4cf51c38 | 1887 | dev_err(&client->dev, "Failed to allocate memory\n"); |
7a53d609 | 1888 | return -ENOMEM; |
4cf51c38 JS |
1889 | } |
1890 | ||
ec02ac2b DK |
1891 | snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0", |
1892 | client->adapter->nr, client->addr); | |
22dfab7f | 1893 | |
910d8051 | 1894 | data->client = client; |
910d8051 JS |
1895 | data->pdata = pdata; |
1896 | data->irq = client->irq; | |
7a53d609 | 1897 | i2c_set_clientdata(client, data); |
910d8051 | 1898 | |
d79e7e47 | 1899 | init_completion(&data->bl_completion); |
a4a2ef46 | 1900 | init_completion(&data->reset_completion); |
c3f78043 | 1901 | init_completion(&data->crc_completion); |
d79e7e47 | 1902 | |
dd24dcf5 ND |
1903 | error = request_threaded_irq(client->irq, NULL, mxt_interrupt, |
1904 | pdata->irqflags | IRQF_ONESHOT, | |
1905 | client->name, data); | |
1906 | if (error) { | |
1907 | dev_err(&client->dev, "Failed to register interrupt\n"); | |
1908 | goto err_free_mem; | |
1909 | } | |
1910 | ||
1911 | disable_irq(client->irq); | |
1912 | ||
cb159115 DK |
1913 | error = mxt_initialize(data); |
1914 | if (error) | |
7a53d609 | 1915 | goto err_free_irq; |
4cf51c38 | 1916 | |
7686b108 | 1917 | error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group); |
7bed6805 ND |
1918 | if (error) { |
1919 | dev_err(&client->dev, "Failure %d creating sysfs group\n", | |
1920 | error); | |
7a53d609 | 1921 | goto err_free_object; |
7bed6805 | 1922 | } |
4cf51c38 JS |
1923 | |
1924 | return 0; | |
1925 | ||
4cf51c38 JS |
1926 | err_free_object: |
1927 | kfree(data->object_table); | |
dd24dcf5 ND |
1928 | err_free_irq: |
1929 | free_irq(client->irq, data); | |
4cf51c38 | 1930 | err_free_mem: |
4cf51c38 JS |
1931 | kfree(data); |
1932 | return error; | |
1933 | } | |
1934 | ||
e2619cf7 | 1935 | static int mxt_remove(struct i2c_client *client) |
4cf51c38 | 1936 | { |
7686b108 | 1937 | struct mxt_data *data = i2c_get_clientdata(client); |
4cf51c38 | 1938 | |
7686b108 | 1939 | sysfs_remove_group(&client->dev.kobj, &mxt_attr_group); |
4cf51c38 JS |
1940 | free_irq(data->irq, data); |
1941 | input_unregister_device(data->input_dev); | |
1942 | kfree(data->object_table); | |
1943 | kfree(data); | |
1944 | ||
1945 | return 0; | |
1946 | } | |
1947 | ||
3a73c816 | 1948 | #ifdef CONFIG_PM_SLEEP |
7686b108 | 1949 | static int mxt_suspend(struct device *dev) |
4cf51c38 | 1950 | { |
8b5fce06 | 1951 | struct i2c_client *client = to_i2c_client(dev); |
7686b108 | 1952 | struct mxt_data *data = i2c_get_clientdata(client); |
4cf51c38 JS |
1953 | struct input_dev *input_dev = data->input_dev; |
1954 | ||
1955 | mutex_lock(&input_dev->mutex); | |
1956 | ||
1957 | if (input_dev->users) | |
7686b108 | 1958 | mxt_stop(data); |
4cf51c38 JS |
1959 | |
1960 | mutex_unlock(&input_dev->mutex); | |
1961 | ||
1962 | return 0; | |
1963 | } | |
1964 | ||
7686b108 | 1965 | static int mxt_resume(struct device *dev) |
4cf51c38 | 1966 | { |
8b5fce06 | 1967 | struct i2c_client *client = to_i2c_client(dev); |
7686b108 | 1968 | struct mxt_data *data = i2c_get_clientdata(client); |
4cf51c38 JS |
1969 | struct input_dev *input_dev = data->input_dev; |
1970 | ||
a4a2ef46 | 1971 | mxt_soft_reset(data); |
4cf51c38 JS |
1972 | |
1973 | mutex_lock(&input_dev->mutex); | |
1974 | ||
1975 | if (input_dev->users) | |
7686b108 | 1976 | mxt_start(data); |
4cf51c38 JS |
1977 | |
1978 | mutex_unlock(&input_dev->mutex); | |
1979 | ||
1980 | return 0; | |
1981 | } | |
4cf51c38 JS |
1982 | #endif |
1983 | ||
3a73c816 DK |
1984 | static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume); |
1985 | ||
78188be3 SW |
1986 | static const struct of_device_id mxt_of_match[] = { |
1987 | { .compatible = "atmel,maxtouch", }, | |
1988 | {}, | |
1989 | }; | |
1990 | MODULE_DEVICE_TABLE(of, mxt_of_match); | |
1991 | ||
7686b108 | 1992 | static const struct i2c_device_id mxt_id[] = { |
4cf51c38 | 1993 | { "qt602240_ts", 0 }, |
7686b108 | 1994 | { "atmel_mxt_ts", 0 }, |
22dfab7f | 1995 | { "atmel_mxt_tp", 0 }, |
46ee2a05 | 1996 | { "mXT224", 0 }, |
4cf51c38 JS |
1997 | { } |
1998 | }; | |
7686b108 | 1999 | MODULE_DEVICE_TABLE(i2c, mxt_id); |
4cf51c38 | 2000 | |
7686b108 | 2001 | static struct i2c_driver mxt_driver = { |
4cf51c38 | 2002 | .driver = { |
7686b108 | 2003 | .name = "atmel_mxt_ts", |
4cf51c38 | 2004 | .owner = THIS_MODULE, |
78188be3 | 2005 | .of_match_table = of_match_ptr(mxt_of_match), |
7686b108 | 2006 | .pm = &mxt_pm_ops, |
4cf51c38 | 2007 | }, |
7686b108 | 2008 | .probe = mxt_probe, |
1cb0aa88 | 2009 | .remove = mxt_remove, |
7686b108 | 2010 | .id_table = mxt_id, |
4cf51c38 JS |
2011 | }; |
2012 | ||
1b92c1cf | 2013 | module_i2c_driver(mxt_driver); |
4cf51c38 JS |
2014 | |
2015 | /* Module information */ | |
2016 | MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>"); | |
7686b108 | 2017 | MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver"); |
4cf51c38 | 2018 | MODULE_LICENSE("GPL"); |