Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Elan Microelectronics touch panels with I2C interface
4 *
5 * Copyright (C) 2014 Elan Microelectronics Corporation.
6 * Scott Liu <scott.liu@emc.com.tw>
7 *
8 * This code is partly based on hid-multitouch.c:
9 *
10 * Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
11 * Copyright (c) 2010-2012 Benjamin Tissoires <benjamin.tissoires@gmail.com>
12 * Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
13 *
14 * This code is partly based on i2c-hid.c:
15 *
16 * Copyright (c) 2012 Benjamin Tissoires <benjamin.tissoires@gmail.com>
17 * Copyright (c) 2012 Ecole Nationale de l'Aviation Civile, France
18 * Copyright (c) 2012 Red Hat, Inc
19 */
20
21
22#include <linux/bits.h>
23#include <linux/module.h>
24#include <linux/input.h>
25#include <linux/interrupt.h>
26#include <linux/irq.h>
27#include <linux/platform_device.h>
28#include <linux/async.h>
29#include <linux/i2c.h>
30#include <linux/delay.h>
31#include <linux/uaccess.h>
32#include <linux/buffer_head.h>
33#include <linux/slab.h>
34#include <linux/firmware.h>
35#include <linux/input/mt.h>
36#include <linux/input/touchscreen.h>
37#include <linux/acpi.h>
38#include <linux/of.h>
39#include <linux/pm_wakeirq.h>
40#include <linux/gpio/consumer.h>
41#include <linux/regulator/consumer.h>
42#include <linux/uuid.h>
43#include <asm/unaligned.h>
44
45/* Device, Driver information */
46#define DEVICE_NAME "elants_i2c"
47
48/* Convert from rows or columns into resolution */
49#define ELAN_TS_RESOLUTION(n, m) (((n) - 1) * (m))
50
51/* FW header data */
52#define HEADER_SIZE 4
53#define FW_HDR_TYPE 0
54#define FW_HDR_COUNT 1
55#define FW_HDR_LENGTH 2
56
57/* Buffer mode Queue Header information */
58#define QUEUE_HEADER_SINGLE 0x62
59#define QUEUE_HEADER_NORMAL 0X63
60#define QUEUE_HEADER_WAIT 0x64
61#define QUEUE_HEADER_NORMAL2 0x66
62
63/* Command header definition */
64#define CMD_HEADER_WRITE 0x54
65#define CMD_HEADER_READ 0x53
66#define CMD_HEADER_6B_READ 0x5B
67#define CMD_HEADER_ROM_READ 0x96
68#define CMD_HEADER_RESP 0x52
69#define CMD_HEADER_6B_RESP 0x9B
70#define CMD_HEADER_ROM_RESP 0x95
71#define CMD_HEADER_HELLO 0x55
72#define CMD_HEADER_REK 0x66
73
74/* FW position data */
75#define PACKET_SIZE_OLD 40
76#define PACKET_SIZE 55
77#define MAX_CONTACT_NUM 10
78#define FW_POS_HEADER 0
79#define FW_POS_STATE 1
80#define FW_POS_TOTAL 2
81#define FW_POS_XY 3
82#define FW_POS_TOOL_TYPE 33
83#define FW_POS_CHECKSUM 34
84#define FW_POS_WIDTH 35
85#define FW_POS_PRESSURE 45
86
87#define HEADER_REPORT_10_FINGER 0x62
88
89/* Header (4 bytes) plus 3 full 10-finger packets */
90#define MAX_PACKET_SIZE 169
91
92#define BOOT_TIME_DELAY_MS 50
93
94/* FW read command, 0x53 0x?? 0x0, 0x01 */
95#define E_ELAN_INFO_FW_VER 0x00
96#define E_ELAN_INFO_BC_VER 0x10
97#define E_ELAN_INFO_X_RES 0x60
98#define E_ELAN_INFO_Y_RES 0x63
99#define E_ELAN_INFO_REK 0xD0
100#define E_ELAN_INFO_TEST_VER 0xE0
101#define E_ELAN_INFO_FW_ID 0xF0
102#define E_INFO_OSR 0xD6
103#define E_INFO_PHY_SCAN 0xD7
104#define E_INFO_PHY_DRIVER 0xD8
105
106/* FW write command, 0x54 0x?? 0x0, 0x01 */
107#define E_POWER_STATE_SLEEP 0x50
108#define E_POWER_STATE_RESUME 0x58
109
110#define MAX_RETRIES 3
111#define MAX_FW_UPDATE_RETRIES 30
112
113#define ELAN_FW_PAGESIZE 132
114
115/* calibration timeout definition */
116#define ELAN_CALI_TIMEOUT_MSEC 12000
117
118#define ELAN_POWERON_DELAY_USEC 5000
119#define ELAN_RESET_DELAY_MSEC 20
120
121/* FW boot code version */
122#define BC_VER_H_BYTE_FOR_EKTH3900x1_I2C 0x72
123#define BC_VER_H_BYTE_FOR_EKTH3900x2_I2C 0x82
124#define BC_VER_H_BYTE_FOR_EKTH3900x3_I2C 0x92
125#define BC_VER_H_BYTE_FOR_EKTH5312x1_I2C 0x6D
126#define BC_VER_H_BYTE_FOR_EKTH5312x2_I2C 0x6E
127#define BC_VER_H_BYTE_FOR_EKTH5312cx1_I2C 0x77
128#define BC_VER_H_BYTE_FOR_EKTH5312cx2_I2C 0x78
129#define BC_VER_H_BYTE_FOR_EKTH5312x1_I2C_USB 0x67
130#define BC_VER_H_BYTE_FOR_EKTH5312x2_I2C_USB 0x68
131#define BC_VER_H_BYTE_FOR_EKTH5312cx1_I2C_USB 0x74
132#define BC_VER_H_BYTE_FOR_EKTH5312cx2_I2C_USB 0x75
133
134enum elants_chip_id {
135 EKTH3500,
136 EKTF3624,
137};
138
139enum elants_state {
140 ELAN_STATE_NORMAL,
141 ELAN_WAIT_QUEUE_HEADER,
142 ELAN_WAIT_RECALIBRATION,
143};
144
145enum elants_iap_mode {
146 ELAN_IAP_OPERATIONAL,
147 ELAN_IAP_RECOVERY,
148};
149
150/* struct elants_data - represents state of Elan touchscreen device */
151struct elants_data {
152 struct i2c_client *client;
153 struct input_dev *input;
154
155 struct regulator *vcc33;
156 struct regulator *vccio;
157 struct gpio_desc *reset_gpio;
158
159 u16 fw_version;
160 u8 test_version;
161 u8 solution_version;
162 u8 bc_version;
163 u8 iap_version;
164 u16 hw_version;
165 u8 major_res;
166 unsigned int x_res; /* resolution in units/mm */
167 unsigned int y_res;
168 unsigned int x_max;
169 unsigned int y_max;
170 unsigned int phy_x;
171 unsigned int phy_y;
172 struct touchscreen_properties prop;
173
174 enum elants_state state;
175 enum elants_chip_id chip_id;
176 enum elants_iap_mode iap_mode;
177
178 /* Guards against concurrent access to the device via sysfs */
179 struct mutex sysfs_mutex;
180
181 u8 cmd_resp[HEADER_SIZE];
182 struct completion cmd_done;
183
184 bool keep_power_in_suspend;
185
186 /* Must be last to be used for DMA operations */
187 u8 buf[MAX_PACKET_SIZE] ____cacheline_aligned;
188};
189
190static int elants_i2c_send(struct i2c_client *client,
191 const void *data, size_t size)
192{
193 int ret;
194
195 ret = i2c_master_send(client, data, size);
196 if (ret == size)
197 return 0;
198
199 if (ret >= 0)
200 ret = -EIO;
201
202 dev_err(&client->dev, "%s failed (%*ph): %d\n",
203 __func__, (int)size, data, ret);
204
205 return ret;
206}
207
208static int elants_i2c_read(struct i2c_client *client, void *data, size_t size)
209{
210 int ret;
211
212 ret = i2c_master_recv(client, data, size);
213 if (ret == size)
214 return 0;
215
216 if (ret >= 0)
217 ret = -EIO;
218
219 dev_err(&client->dev, "%s failed: %d\n", __func__, ret);
220
221 return ret;
222}
223
224static int elants_i2c_execute_command(struct i2c_client *client,
225 const u8 *cmd, size_t cmd_size,
226 u8 *resp, size_t resp_size,
227 int retries, const char *cmd_name)
228{
229 struct i2c_msg msgs[2];
230 int ret;
231 u8 expected_response;
232
233 switch (cmd[0]) {
234 case CMD_HEADER_READ:
235 expected_response = CMD_HEADER_RESP;
236 break;
237
238 case CMD_HEADER_6B_READ:
239 expected_response = CMD_HEADER_6B_RESP;
240 break;
241
242 case CMD_HEADER_ROM_READ:
243 expected_response = CMD_HEADER_ROM_RESP;
244 break;
245
246 default:
247 dev_err(&client->dev, "(%s): invalid command: %*ph\n",
248 cmd_name, (int)cmd_size, cmd);
249 return -EINVAL;
250 }
251
252 for (;;) {
253 msgs[0].addr = client->addr;
254 msgs[0].flags = client->flags & I2C_M_TEN;
255 msgs[0].len = cmd_size;
256 msgs[0].buf = (u8 *)cmd;
257
258 msgs[1].addr = client->addr;
259 msgs[1].flags = (client->flags & I2C_M_TEN) | I2C_M_RD;
260 msgs[1].flags |= I2C_M_RD;
261 msgs[1].len = resp_size;
262 msgs[1].buf = resp;
263
264 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
265 if (ret < 0) {
266 if (--retries > 0) {
267 dev_dbg(&client->dev,
268 "(%s) I2C transfer failed: %pe (retrying)\n",
269 cmd_name, ERR_PTR(ret));
270 continue;
271 }
272
273 dev_err(&client->dev,
274 "(%s) I2C transfer failed: %pe\n",
275 cmd_name, ERR_PTR(ret));
276 return ret;
277 }
278
279 if (ret != ARRAY_SIZE(msgs) ||
280 resp[FW_HDR_TYPE] != expected_response) {
281 if (--retries > 0) {
282 dev_dbg(&client->dev,
283 "(%s) unexpected response: %*ph (retrying)\n",
284 cmd_name, ret, resp);
285 continue;
286 }
287
288 dev_err(&client->dev,
289 "(%s) unexpected response: %*ph\n",
290 cmd_name, ret, resp);
291 return -EIO;
292 }
293
294 return 0;
295 }
296}
297
298static int elants_i2c_calibrate(struct elants_data *ts)
299{
300 struct i2c_client *client = ts->client;
301 int ret, error;
302 static const u8 w_flashkey[] = { CMD_HEADER_WRITE, 0xC0, 0xE1, 0x5A };
303 static const u8 rek[] = { CMD_HEADER_WRITE, 0x29, 0x00, 0x01 };
304 static const u8 rek_resp[] = { CMD_HEADER_REK, 0x66, 0x66, 0x66 };
305
306 disable_irq(client->irq);
307
308 ts->state = ELAN_WAIT_RECALIBRATION;
309 reinit_completion(&ts->cmd_done);
310
311 elants_i2c_send(client, w_flashkey, sizeof(w_flashkey));
312 elants_i2c_send(client, rek, sizeof(rek));
313
314 enable_irq(client->irq);
315
316 ret = wait_for_completion_interruptible_timeout(&ts->cmd_done,
317 msecs_to_jiffies(ELAN_CALI_TIMEOUT_MSEC));
318
319 ts->state = ELAN_STATE_NORMAL;
320
321 if (ret <= 0) {
322 error = ret < 0 ? ret : -ETIMEDOUT;
323 dev_err(&client->dev,
324 "error while waiting for calibration to complete: %d\n",
325 error);
326 return error;
327 }
328
329 if (memcmp(rek_resp, ts->cmd_resp, sizeof(rek_resp))) {
330 dev_err(&client->dev,
331 "unexpected calibration response: %*ph\n",
332 (int)sizeof(ts->cmd_resp), ts->cmd_resp);
333 return -EINVAL;
334 }
335
336 return 0;
337}
338
339static int elants_i2c_sw_reset(struct i2c_client *client)
340{
341 const u8 soft_rst_cmd[] = { 0x77, 0x77, 0x77, 0x77 };
342 int error;
343
344 error = elants_i2c_send(client, soft_rst_cmd,
345 sizeof(soft_rst_cmd));
346 if (error) {
347 dev_err(&client->dev, "software reset failed: %d\n", error);
348 return error;
349 }
350
351 /*
352 * We should wait at least 10 msec (but no more than 40) before
353 * sending fastboot or IAP command to the device.
354 */
355 msleep(30);
356
357 return 0;
358}
359
360static u16 elants_i2c_parse_version(u8 *buf)
361{
362 return get_unaligned_be32(buf) >> 4;
363}
364
365static int elants_i2c_query_hw_version(struct elants_data *ts)
366{
367 struct i2c_client *client = ts->client;
368 int retry_cnt = MAX_RETRIES;
369 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_FW_ID, 0x00, 0x01 };
370 u8 resp[HEADER_SIZE];
371 int error;
372
373 while (retry_cnt--) {
374 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
375 resp, sizeof(resp), 1,
376 "read fw id");
377 if (error)
378 return error;
379
380 ts->hw_version = elants_i2c_parse_version(resp);
381 if (ts->hw_version != 0xffff)
382 return 0;
383 }
384
385 dev_err(&client->dev, "Invalid fw id: %#04x\n", ts->hw_version);
386
387 return -EINVAL;
388}
389
390static int elants_i2c_query_fw_version(struct elants_data *ts)
391{
392 struct i2c_client *client = ts->client;
393 int retry_cnt = MAX_RETRIES;
394 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_FW_VER, 0x00, 0x01 };
395 u8 resp[HEADER_SIZE];
396 int error;
397
398 while (retry_cnt--) {
399 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
400 resp, sizeof(resp), 1,
401 "read fw version");
402 if (error)
403 return error;
404
405 ts->fw_version = elants_i2c_parse_version(resp);
406 if (ts->fw_version != 0x0000 && ts->fw_version != 0xffff)
407 return 0;
408
409 dev_dbg(&client->dev, "(read fw version) resp %*phC\n",
410 (int)sizeof(resp), resp);
411 }
412
413 dev_err(&client->dev, "Invalid fw ver: %#04x\n", ts->fw_version);
414
415 return -EINVAL;
416}
417
418static int elants_i2c_query_test_version(struct elants_data *ts)
419{
420 struct i2c_client *client = ts->client;
421 int error;
422 u16 version;
423 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_TEST_VER, 0x00, 0x01 };
424 u8 resp[HEADER_SIZE];
425
426 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
427 resp, sizeof(resp), MAX_RETRIES,
428 "read test version");
429 if (error) {
430 dev_err(&client->dev, "Failed to read test version\n");
431 return error;
432 }
433
434 version = elants_i2c_parse_version(resp);
435 ts->test_version = version >> 8;
436 ts->solution_version = version & 0xff;
437
438 return 0;
439}
440
441static int elants_i2c_query_bc_version(struct elants_data *ts)
442{
443 struct i2c_client *client = ts->client;
444 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_BC_VER, 0x00, 0x01 };
445 u8 resp[HEADER_SIZE];
446 u16 version;
447 int error;
448
449 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
450 resp, sizeof(resp), 1,
451 "read BC version");
452 if (error)
453 return error;
454
455 version = elants_i2c_parse_version(resp);
456 ts->bc_version = version >> 8;
457 ts->iap_version = version & 0xff;
458
459 return 0;
460}
461
462static int elants_i2c_query_ts_info_ektf(struct elants_data *ts)
463{
464 struct i2c_client *client = ts->client;
465 int error;
466 u8 resp[4];
467 u16 phy_x, phy_y;
468 const u8 get_xres_cmd[] = {
469 CMD_HEADER_READ, E_ELAN_INFO_X_RES, 0x00, 0x00
470 };
471 const u8 get_yres_cmd[] = {
472 CMD_HEADER_READ, E_ELAN_INFO_Y_RES, 0x00, 0x00
473 };
474
475 /* Get X/Y size in mm */
476 error = elants_i2c_execute_command(client, get_xres_cmd,
477 sizeof(get_xres_cmd),
478 resp, sizeof(resp), 1,
479 "get X size");
480 if (error)
481 return error;
482
483 phy_x = resp[2] | ((resp[3] & 0xF0) << 4);
484
485 error = elants_i2c_execute_command(client, get_yres_cmd,
486 sizeof(get_yres_cmd),
487 resp, sizeof(resp), 1,
488 "get Y size");
489 if (error)
490 return error;
491
492 phy_y = resp[2] | ((resp[3] & 0xF0) << 4);
493
494 dev_dbg(&client->dev, "phy_x=%d, phy_y=%d\n", phy_x, phy_y);
495
496 ts->phy_x = phy_x;
497 ts->phy_y = phy_y;
498
499 /* eKTF doesn't report max size, set it to default values */
500 ts->x_max = 2240 - 1;
501 ts->y_max = 1408 - 1;
502
503 return 0;
504}
505
506static int elants_i2c_query_ts_info_ekth(struct elants_data *ts)
507{
508 struct i2c_client *client = ts->client;
509 int error;
510 u8 resp[17];
511 u16 phy_x, phy_y, rows, cols, osr;
512 const u8 get_resolution_cmd[] = {
513 CMD_HEADER_6B_READ, 0x00, 0x00, 0x00, 0x00, 0x00
514 };
515 const u8 get_osr_cmd[] = {
516 CMD_HEADER_READ, E_INFO_OSR, 0x00, 0x01
517 };
518 const u8 get_physical_scan_cmd[] = {
519 CMD_HEADER_READ, E_INFO_PHY_SCAN, 0x00, 0x01
520 };
521 const u8 get_physical_drive_cmd[] = {
522 CMD_HEADER_READ, E_INFO_PHY_DRIVER, 0x00, 0x01
523 };
524
525 /* Get trace number */
526 error = elants_i2c_execute_command(client,
527 get_resolution_cmd,
528 sizeof(get_resolution_cmd),
529 resp, sizeof(resp), 1,
530 "get resolution");
531 if (error)
532 return error;
533
534 rows = resp[2] + resp[6] + resp[10];
535 cols = resp[3] + resp[7] + resp[11];
536
537 /* Get report resolution value of ABS_MT_TOUCH_MAJOR */
538 ts->major_res = resp[16];
539
540 /* Process mm_to_pixel information */
541 error = elants_i2c_execute_command(client,
542 get_osr_cmd, sizeof(get_osr_cmd),
543 resp, sizeof(resp), 1, "get osr");
544 if (error)
545 return error;
546
547 osr = resp[3];
548
549 error = elants_i2c_execute_command(client,
550 get_physical_scan_cmd,
551 sizeof(get_physical_scan_cmd),
552 resp, sizeof(resp), 1,
553 "get physical scan");
554 if (error)
555 return error;
556
557 phy_x = get_unaligned_be16(&resp[2]);
558
559 error = elants_i2c_execute_command(client,
560 get_physical_drive_cmd,
561 sizeof(get_physical_drive_cmd),
562 resp, sizeof(resp), 1,
563 "get physical drive");
564 if (error)
565 return error;
566
567 phy_y = get_unaligned_be16(&resp[2]);
568
569 dev_dbg(&client->dev, "phy_x=%d, phy_y=%d\n", phy_x, phy_y);
570
571 if (rows == 0 || cols == 0 || osr == 0) {
572 dev_warn(&client->dev,
573 "invalid trace number data: %d, %d, %d\n",
574 rows, cols, osr);
575 } else {
576 /* translate trace number to TS resolution */
577 ts->x_max = ELAN_TS_RESOLUTION(rows, osr);
578 ts->x_res = DIV_ROUND_CLOSEST(ts->x_max, phy_x);
579 ts->y_max = ELAN_TS_RESOLUTION(cols, osr);
580 ts->y_res = DIV_ROUND_CLOSEST(ts->y_max, phy_y);
581 ts->phy_x = phy_x;
582 ts->phy_y = phy_y;
583 }
584
585 return 0;
586}
587
588static int elants_i2c_fastboot(struct i2c_client *client)
589{
590 const u8 boot_cmd[] = { 0x4D, 0x61, 0x69, 0x6E };
591 int error;
592
593 error = elants_i2c_send(client, boot_cmd, sizeof(boot_cmd));
594 if (error) {
595 dev_err(&client->dev, "boot failed: %d\n", error);
596 return error;
597 }
598
599 dev_dbg(&client->dev, "boot success -- 0x%x\n", client->addr);
600 return 0;
601}
602
603static int elants_i2c_initialize(struct elants_data *ts)
604{
605 struct i2c_client *client = ts->client;
606 int error, error2, retry_cnt;
607 const u8 hello_packet[] = { 0x55, 0x55, 0x55, 0x55 };
608 const u8 recov_packet[] = { 0x55, 0x55, 0x80, 0x80 };
609 u8 buf[HEADER_SIZE];
610
611 for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
612 error = elants_i2c_sw_reset(client);
613 if (error) {
614 /* Continue initializing if it's the last try */
615 if (retry_cnt < MAX_RETRIES - 1)
616 continue;
617 }
618
619 error = elants_i2c_fastboot(client);
620 if (error) {
621 /* Continue initializing if it's the last try */
622 if (retry_cnt < MAX_RETRIES - 1)
623 continue;
624 }
625
626 /* Wait for Hello packet */
627 msleep(BOOT_TIME_DELAY_MS);
628
629 error = elants_i2c_read(client, buf, sizeof(buf));
630 if (error) {
631 dev_err(&client->dev,
632 "failed to read 'hello' packet: %d\n", error);
633 } else if (!memcmp(buf, hello_packet, sizeof(hello_packet))) {
634 ts->iap_mode = ELAN_IAP_OPERATIONAL;
635 break;
636 } else if (!memcmp(buf, recov_packet, sizeof(recov_packet))) {
637 /*
638 * Setting error code will mark device
639 * in recovery mode below.
640 */
641 error = -EIO;
642 break;
643 } else {
644 error = -EINVAL;
645 dev_err(&client->dev,
646 "invalid 'hello' packet: %*ph\n",
647 (int)sizeof(buf), buf);
648 }
649 }
650
651 /* hw version is available even if device in recovery state */
652 error2 = elants_i2c_query_hw_version(ts);
653 if (!error2)
654 error2 = elants_i2c_query_bc_version(ts);
655 if (!error)
656 error = error2;
657
658 if (!error)
659 error = elants_i2c_query_fw_version(ts);
660 if (!error)
661 error = elants_i2c_query_test_version(ts);
662
663 switch (ts->chip_id) {
664 case EKTH3500:
665 if (!error)
666 error = elants_i2c_query_ts_info_ekth(ts);
667 break;
668 case EKTF3624:
669 if (!error)
670 error = elants_i2c_query_ts_info_ektf(ts);
671 break;
672 default:
673 BUG();
674 }
675
676 if (error)
677 ts->iap_mode = ELAN_IAP_RECOVERY;
678
679 return 0;
680}
681
682/*
683 * Firmware update interface.
684 */
685
686static int elants_i2c_fw_write_page(struct i2c_client *client,
687 const void *page)
688{
689 const u8 ack_ok[] = { 0xaa, 0xaa };
690 u8 buf[2];
691 int retry;
692 int error;
693
694 for (retry = 0; retry < MAX_FW_UPDATE_RETRIES; retry++) {
695 error = elants_i2c_send(client, page, ELAN_FW_PAGESIZE);
696 if (error) {
697 dev_err(&client->dev,
698 "IAP Write Page failed: %d\n", error);
699 continue;
700 }
701
702 error = elants_i2c_read(client, buf, 2);
703 if (error) {
704 dev_err(&client->dev,
705 "IAP Ack read failed: %d\n", error);
706 return error;
707 }
708
709 if (!memcmp(buf, ack_ok, sizeof(ack_ok)))
710 return 0;
711
712 error = -EIO;
713 dev_err(&client->dev,
714 "IAP Get Ack Error [%02x:%02x]\n",
715 buf[0], buf[1]);
716 }
717
718 return error;
719}
720
721static int elants_i2c_validate_remark_id(struct elants_data *ts,
722 const struct firmware *fw)
723{
724 struct i2c_client *client = ts->client;
725 int error;
726 const u8 cmd[] = { CMD_HEADER_ROM_READ, 0x80, 0x1F, 0x00, 0x00, 0x21 };
727 u8 resp[6] = { 0 };
728 u16 ts_remark_id = 0;
729 u16 fw_remark_id = 0;
730
731 /* Compare TS Remark ID and FW Remark ID */
732 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
733 resp, sizeof(resp),
734 1, "read Remark ID");
735 if (error)
736 return error;
737
738 ts_remark_id = get_unaligned_be16(&resp[3]);
739
740 fw_remark_id = get_unaligned_le16(&fw->data[fw->size - 4]);
741
742 if (fw_remark_id != ts_remark_id) {
743 dev_err(&client->dev,
744 "Remark ID Mismatched: ts_remark_id=0x%04x, fw_remark_id=0x%04x.\n",
745 ts_remark_id, fw_remark_id);
746 return -EINVAL;
747 }
748
749 return 0;
750}
751
752static bool elants_i2c_should_check_remark_id(struct elants_data *ts)
753{
754 struct i2c_client *client = ts->client;
755 const u8 bootcode_version = ts->iap_version;
756 bool check;
757
758 /* I2C eKTH3900 and eKTH5312 are NOT support Remark ID */
759 if ((bootcode_version == BC_VER_H_BYTE_FOR_EKTH3900x1_I2C) ||
760 (bootcode_version == BC_VER_H_BYTE_FOR_EKTH3900x2_I2C) ||
761 (bootcode_version == BC_VER_H_BYTE_FOR_EKTH3900x3_I2C) ||
762 (bootcode_version == BC_VER_H_BYTE_FOR_EKTH5312x1_I2C) ||
763 (bootcode_version == BC_VER_H_BYTE_FOR_EKTH5312x2_I2C) ||
764 (bootcode_version == BC_VER_H_BYTE_FOR_EKTH5312cx1_I2C) ||
765 (bootcode_version == BC_VER_H_BYTE_FOR_EKTH5312cx2_I2C) ||
766 (bootcode_version == BC_VER_H_BYTE_FOR_EKTH5312x1_I2C_USB) ||
767 (bootcode_version == BC_VER_H_BYTE_FOR_EKTH5312x2_I2C_USB) ||
768 (bootcode_version == BC_VER_H_BYTE_FOR_EKTH5312cx1_I2C_USB) ||
769 (bootcode_version == BC_VER_H_BYTE_FOR_EKTH5312cx2_I2C_USB)) {
770 dev_dbg(&client->dev,
771 "eKTH3900/eKTH5312(0x%02x) are not support remark id\n",
772 bootcode_version);
773 check = false;
774 } else if (bootcode_version >= 0x60) {
775 check = true;
776 } else {
777 check = false;
778 }
779
780 return check;
781}
782
783static int elants_i2c_do_update_firmware(struct i2c_client *client,
784 const struct firmware *fw,
785 bool force)
786{
787 struct elants_data *ts = i2c_get_clientdata(client);
788 const u8 enter_iap[] = { 0x45, 0x49, 0x41, 0x50 };
789 const u8 enter_iap2[] = { 0x54, 0x00, 0x12, 0x34 };
790 const u8 iap_ack[] = { 0x55, 0xaa, 0x33, 0xcc };
791 const u8 close_idle[] = { 0x54, 0x2c, 0x01, 0x01 };
792 u8 buf[HEADER_SIZE];
793 u16 send_id;
794 int page, n_fw_pages;
795 int error;
796 bool check_remark_id = elants_i2c_should_check_remark_id(ts);
797
798 /* Recovery mode detection! */
799 if (force) {
800 dev_dbg(&client->dev, "Recovery mode procedure\n");
801
802 if (check_remark_id) {
803 error = elants_i2c_validate_remark_id(ts, fw);
804 if (error)
805 return error;
806 }
807
808 error = elants_i2c_send(client, enter_iap2, sizeof(enter_iap2));
809 if (error) {
810 dev_err(&client->dev, "failed to enter IAP mode: %d\n",
811 error);
812 return error;
813 }
814 } else {
815 /* Start IAP Procedure */
816 dev_dbg(&client->dev, "Normal IAP procedure\n");
817
818 /* Close idle mode */
819 error = elants_i2c_send(client, close_idle, sizeof(close_idle));
820 if (error)
821 dev_err(&client->dev, "Failed close idle: %d\n", error);
822 msleep(60);
823
824 elants_i2c_sw_reset(client);
825 msleep(20);
826
827 if (check_remark_id) {
828 error = elants_i2c_validate_remark_id(ts, fw);
829 if (error)
830 return error;
831 }
832
833 error = elants_i2c_send(client, enter_iap, sizeof(enter_iap));
834 if (error) {
835 dev_err(&client->dev, "failed to enter IAP mode: %d\n",
836 error);
837 return error;
838 }
839 }
840
841 msleep(20);
842
843 /* check IAP state */
844 error = elants_i2c_read(client, buf, 4);
845 if (error) {
846 dev_err(&client->dev,
847 "failed to read IAP acknowledgement: %d\n",
848 error);
849 return error;
850 }
851
852 if (memcmp(buf, iap_ack, sizeof(iap_ack))) {
853 dev_err(&client->dev,
854 "failed to enter IAP: %*ph (expected %*ph)\n",
855 (int)sizeof(buf), buf, (int)sizeof(iap_ack), iap_ack);
856 return -EIO;
857 }
858
859 dev_info(&client->dev, "successfully entered IAP mode");
860
861 send_id = client->addr;
862 error = elants_i2c_send(client, &send_id, 1);
863 if (error) {
864 dev_err(&client->dev, "sending dummy byte failed: %d\n",
865 error);
866 return error;
867 }
868
869 /* Clear the last page of Master */
870 error = elants_i2c_send(client, fw->data, ELAN_FW_PAGESIZE);
871 if (error) {
872 dev_err(&client->dev, "clearing of the last page failed: %d\n",
873 error);
874 return error;
875 }
876
877 error = elants_i2c_read(client, buf, 2);
878 if (error) {
879 dev_err(&client->dev,
880 "failed to read ACK for clearing the last page: %d\n",
881 error);
882 return error;
883 }
884
885 n_fw_pages = fw->size / ELAN_FW_PAGESIZE;
886 dev_dbg(&client->dev, "IAP Pages = %d\n", n_fw_pages);
887
888 for (page = 0; page < n_fw_pages; page++) {
889 error = elants_i2c_fw_write_page(client,
890 fw->data + page * ELAN_FW_PAGESIZE);
891 if (error) {
892 dev_err(&client->dev,
893 "failed to write FW page %d: %d\n",
894 page, error);
895 return error;
896 }
897 }
898
899 /* Old iap needs to wait 200ms for WDT and rest is for hello packets */
900 msleep(300);
901
902 dev_info(&client->dev, "firmware update completed\n");
903 return 0;
904}
905
906static int elants_i2c_fw_update(struct elants_data *ts)
907{
908 struct i2c_client *client = ts->client;
909 const struct firmware *fw;
910 char *fw_name;
911 int error;
912
913 fw_name = kasprintf(GFP_KERNEL, "elants_i2c_%04x.bin", ts->hw_version);
914 if (!fw_name)
915 return -ENOMEM;
916
917 dev_info(&client->dev, "requesting fw name = %s\n", fw_name);
918 error = request_firmware(&fw, fw_name, &client->dev);
919 kfree(fw_name);
920 if (error) {
921 dev_err(&client->dev, "failed to request firmware: %d\n",
922 error);
923 return error;
924 }
925
926 if (fw->size % ELAN_FW_PAGESIZE) {
927 dev_err(&client->dev, "invalid firmware length: %zu\n",
928 fw->size);
929 error = -EINVAL;
930 goto out;
931 }
932
933 disable_irq(client->irq);
934
935 error = elants_i2c_do_update_firmware(client, fw,
936 ts->iap_mode == ELAN_IAP_RECOVERY);
937 if (error) {
938 dev_err(&client->dev, "firmware update failed: %d\n", error);
939 ts->iap_mode = ELAN_IAP_RECOVERY;
940 goto out_enable_irq;
941 }
942
943 error = elants_i2c_initialize(ts);
944 if (error) {
945 dev_err(&client->dev,
946 "failed to initialize device after firmware update: %d\n",
947 error);
948 ts->iap_mode = ELAN_IAP_RECOVERY;
949 goto out_enable_irq;
950 }
951
952 ts->iap_mode = ELAN_IAP_OPERATIONAL;
953
954out_enable_irq:
955 ts->state = ELAN_STATE_NORMAL;
956 enable_irq(client->irq);
957 msleep(100);
958
959 if (!error)
960 elants_i2c_calibrate(ts);
961out:
962 release_firmware(fw);
963 return error;
964}
965
966/*
967 * Event reporting.
968 */
969
970static void elants_i2c_mt_event(struct elants_data *ts, u8 *buf,
971 size_t packet_size)
972{
973 struct input_dev *input = ts->input;
974 unsigned int n_fingers;
975 unsigned int tool_type;
976 u16 finger_state;
977 int i;
978
979 n_fingers = buf[FW_POS_STATE + 1] & 0x0f;
980 finger_state = ((buf[FW_POS_STATE + 1] & 0x30) << 4) |
981 buf[FW_POS_STATE];
982
983 dev_dbg(&ts->client->dev,
984 "n_fingers: %u, state: %04x\n", n_fingers, finger_state);
985
986 /* Note: all fingers have the same tool type */
987 tool_type = buf[FW_POS_TOOL_TYPE] & BIT(0) ?
988 MT_TOOL_FINGER : MT_TOOL_PALM;
989
990 for (i = 0; i < MAX_CONTACT_NUM && n_fingers; i++) {
991 if (finger_state & 1) {
992 unsigned int x, y, p, w;
993 u8 *pos;
994
995 pos = &buf[FW_POS_XY + i * 3];
996 x = (((u16)pos[0] & 0xf0) << 4) | pos[1];
997 y = (((u16)pos[0] & 0x0f) << 8) | pos[2];
998
999 /*
1000 * eKTF3624 may have use "old" touch-report format,
1001 * depending on a device and TS firmware version.
1002 * For example, ASUS Transformer devices use the "old"
1003 * format, while ASUS Nexus 7 uses the "new" formant.
1004 */
1005 if (packet_size == PACKET_SIZE_OLD &&
1006 ts->chip_id == EKTF3624) {
1007 w = buf[FW_POS_WIDTH + i / 2];
1008 w >>= 4 * (~i & 1);
1009 w |= w << 4;
1010 w |= !w;
1011 p = w;
1012 } else {
1013 p = buf[FW_POS_PRESSURE + i];
1014 w = buf[FW_POS_WIDTH + i];
1015 }
1016
1017 dev_dbg(&ts->client->dev, "i=%d x=%d y=%d p=%d w=%d\n",
1018 i, x, y, p, w);
1019
1020 input_mt_slot(input, i);
1021 input_mt_report_slot_state(input, tool_type, true);
1022 touchscreen_report_pos(input, &ts->prop, x, y, true);
1023 input_event(input, EV_ABS, ABS_MT_PRESSURE, p);
1024 input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, w);
1025
1026 n_fingers--;
1027 }
1028
1029 finger_state >>= 1;
1030 }
1031
1032 input_mt_sync_frame(input);
1033 input_sync(input);
1034}
1035
1036static u8 elants_i2c_calculate_checksum(u8 *buf)
1037{
1038 u8 checksum = 0;
1039 u8 i;
1040
1041 for (i = 0; i < FW_POS_CHECKSUM; i++)
1042 checksum += buf[i];
1043
1044 return checksum;
1045}
1046
1047static void elants_i2c_event(struct elants_data *ts, u8 *buf,
1048 size_t packet_size)
1049{
1050 u8 checksum = elants_i2c_calculate_checksum(buf);
1051
1052 if (unlikely(buf[FW_POS_CHECKSUM] != checksum))
1053 dev_warn(&ts->client->dev,
1054 "%s: invalid checksum for packet %02x: %02x vs. %02x\n",
1055 __func__, buf[FW_POS_HEADER],
1056 checksum, buf[FW_POS_CHECKSUM]);
1057 else if (unlikely(buf[FW_POS_HEADER] != HEADER_REPORT_10_FINGER))
1058 dev_warn(&ts->client->dev,
1059 "%s: unknown packet type: %02x\n",
1060 __func__, buf[FW_POS_HEADER]);
1061 else
1062 elants_i2c_mt_event(ts, buf, packet_size);
1063}
1064
1065static irqreturn_t elants_i2c_irq(int irq, void *_dev)
1066{
1067 const u8 wait_packet[] = { 0x64, 0x64, 0x64, 0x64 };
1068 struct elants_data *ts = _dev;
1069 struct i2c_client *client = ts->client;
1070 int report_count, report_len;
1071 int i;
1072 int len;
1073
1074 len = i2c_master_recv_dmasafe(client, ts->buf, sizeof(ts->buf));
1075 if (len < 0) {
1076 dev_err(&client->dev, "%s: failed to read data: %d\n",
1077 __func__, len);
1078 goto out;
1079 }
1080
1081 dev_dbg(&client->dev, "%s: packet %*ph\n",
1082 __func__, HEADER_SIZE, ts->buf);
1083
1084 switch (ts->state) {
1085 case ELAN_WAIT_RECALIBRATION:
1086 if (ts->buf[FW_HDR_TYPE] == CMD_HEADER_REK) {
1087 memcpy(ts->cmd_resp, ts->buf, sizeof(ts->cmd_resp));
1088 complete(&ts->cmd_done);
1089 ts->state = ELAN_STATE_NORMAL;
1090 }
1091 break;
1092
1093 case ELAN_WAIT_QUEUE_HEADER:
1094 if (ts->buf[FW_HDR_TYPE] != QUEUE_HEADER_NORMAL)
1095 break;
1096
1097 ts->state = ELAN_STATE_NORMAL;
1098 fallthrough;
1099
1100 case ELAN_STATE_NORMAL:
1101
1102 switch (ts->buf[FW_HDR_TYPE]) {
1103 case CMD_HEADER_HELLO:
1104 case CMD_HEADER_RESP:
1105 break;
1106
1107 case QUEUE_HEADER_WAIT:
1108 if (memcmp(ts->buf, wait_packet, sizeof(wait_packet))) {
1109 dev_err(&client->dev,
1110 "invalid wait packet %*ph\n",
1111 HEADER_SIZE, ts->buf);
1112 } else {
1113 ts->state = ELAN_WAIT_QUEUE_HEADER;
1114 udelay(30);
1115 }
1116 break;
1117
1118 case QUEUE_HEADER_SINGLE:
1119 elants_i2c_event(ts, &ts->buf[HEADER_SIZE],
1120 ts->buf[FW_HDR_LENGTH]);
1121 break;
1122
1123 case QUEUE_HEADER_NORMAL2: /* CMD_HEADER_REK */
1124 /*
1125 * Depending on firmware version, eKTF3624 touchscreens
1126 * may utilize one of these opcodes for the touch events:
1127 * 0x63 (NORMAL) and 0x66 (NORMAL2). The 0x63 is used by
1128 * older firmware version and differs from 0x66 such that
1129 * touch pressure value needs to be adjusted. The 0x66
1130 * opcode of newer firmware is equal to 0x63 of eKTH3500.
1131 */
1132 if (ts->chip_id != EKTF3624)
1133 break;
1134
1135 fallthrough;
1136
1137 case QUEUE_HEADER_NORMAL:
1138 report_count = ts->buf[FW_HDR_COUNT];
1139 if (report_count == 0 || report_count > 3) {
1140 dev_err(&client->dev,
1141 "bad report count: %*ph\n",
1142 HEADER_SIZE, ts->buf);
1143 break;
1144 }
1145
1146 report_len = ts->buf[FW_HDR_LENGTH] / report_count;
1147
1148 if (report_len == PACKET_SIZE_OLD &&
1149 ts->chip_id == EKTF3624) {
1150 dev_dbg_once(&client->dev,
1151 "using old report format\n");
1152 } else if (report_len != PACKET_SIZE) {
1153 dev_err(&client->dev,
1154 "mismatching report length: %*ph\n",
1155 HEADER_SIZE, ts->buf);
1156 break;
1157 }
1158
1159 for (i = 0; i < report_count; i++) {
1160 u8 *buf = ts->buf + HEADER_SIZE +
1161 i * report_len;
1162 elants_i2c_event(ts, buf, report_len);
1163 }
1164 break;
1165
1166 default:
1167 dev_err(&client->dev, "unknown packet %*ph\n",
1168 HEADER_SIZE, ts->buf);
1169 break;
1170 }
1171 break;
1172 }
1173
1174out:
1175 return IRQ_HANDLED;
1176}
1177
1178/*
1179 * sysfs interface
1180 */
1181static ssize_t calibrate_store(struct device *dev,
1182 struct device_attribute *attr,
1183 const char *buf, size_t count)
1184{
1185 struct i2c_client *client = to_i2c_client(dev);
1186 struct elants_data *ts = i2c_get_clientdata(client);
1187 int error;
1188
1189 error = mutex_lock_interruptible(&ts->sysfs_mutex);
1190 if (error)
1191 return error;
1192
1193 error = elants_i2c_calibrate(ts);
1194
1195 mutex_unlock(&ts->sysfs_mutex);
1196 return error ?: count;
1197}
1198
1199static ssize_t write_update_fw(struct device *dev,
1200 struct device_attribute *attr,
1201 const char *buf, size_t count)
1202{
1203 struct i2c_client *client = to_i2c_client(dev);
1204 struct elants_data *ts = i2c_get_clientdata(client);
1205 int error;
1206
1207 error = mutex_lock_interruptible(&ts->sysfs_mutex);
1208 if (error)
1209 return error;
1210
1211 error = elants_i2c_fw_update(ts);
1212 dev_dbg(dev, "firmware update result: %d\n", error);
1213
1214 mutex_unlock(&ts->sysfs_mutex);
1215 return error ?: count;
1216}
1217
1218static ssize_t show_iap_mode(struct device *dev,
1219 struct device_attribute *attr, char *buf)
1220{
1221 struct i2c_client *client = to_i2c_client(dev);
1222 struct elants_data *ts = i2c_get_clientdata(client);
1223
1224 return sprintf(buf, "%s\n",
1225 ts->iap_mode == ELAN_IAP_OPERATIONAL ?
1226 "Normal" : "Recovery");
1227}
1228
1229static ssize_t show_calibration_count(struct device *dev,
1230 struct device_attribute *attr, char *buf)
1231{
1232 struct i2c_client *client = to_i2c_client(dev);
1233 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_REK, 0x00, 0x01 };
1234 u8 resp[HEADER_SIZE];
1235 u16 rek_count;
1236 int error;
1237
1238 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
1239 resp, sizeof(resp), 1,
1240 "read ReK status");
1241 if (error)
1242 return sprintf(buf, "%d\n", error);
1243
1244 rek_count = get_unaligned_be16(&resp[2]);
1245 return sprintf(buf, "0x%04x\n", rek_count);
1246}
1247
1248static DEVICE_ATTR_WO(calibrate);
1249static DEVICE_ATTR(iap_mode, S_IRUGO, show_iap_mode, NULL);
1250static DEVICE_ATTR(calibration_count, S_IRUGO, show_calibration_count, NULL);
1251static DEVICE_ATTR(update_fw, S_IWUSR, NULL, write_update_fw);
1252
1253struct elants_version_attribute {
1254 struct device_attribute dattr;
1255 size_t field_offset;
1256 size_t field_size;
1257};
1258
1259#define __ELANTS_FIELD_SIZE(_field) \
1260 sizeof(((struct elants_data *)NULL)->_field)
1261#define __ELANTS_VERIFY_SIZE(_field) \
1262 (BUILD_BUG_ON_ZERO(__ELANTS_FIELD_SIZE(_field) > 2) + \
1263 __ELANTS_FIELD_SIZE(_field))
1264#define ELANTS_VERSION_ATTR(_field) \
1265 struct elants_version_attribute elants_ver_attr_##_field = { \
1266 .dattr = __ATTR(_field, S_IRUGO, \
1267 elants_version_attribute_show, NULL), \
1268 .field_offset = offsetof(struct elants_data, _field), \
1269 .field_size = __ELANTS_VERIFY_SIZE(_field), \
1270 }
1271
1272static ssize_t elants_version_attribute_show(struct device *dev,
1273 struct device_attribute *dattr,
1274 char *buf)
1275{
1276 struct i2c_client *client = to_i2c_client(dev);
1277 struct elants_data *ts = i2c_get_clientdata(client);
1278 struct elants_version_attribute *attr =
1279 container_of(dattr, struct elants_version_attribute, dattr);
1280 u8 *field = (u8 *)((char *)ts + attr->field_offset);
1281 unsigned int fmt_size;
1282 unsigned int val;
1283
1284 if (attr->field_size == 1) {
1285 val = *field;
1286 fmt_size = 2; /* 2 HEX digits */
1287 } else {
1288 val = *(u16 *)field;
1289 fmt_size = 4; /* 4 HEX digits */
1290 }
1291
1292 return sprintf(buf, "%0*x\n", fmt_size, val);
1293}
1294
1295static ELANTS_VERSION_ATTR(fw_version);
1296static ELANTS_VERSION_ATTR(hw_version);
1297static ELANTS_VERSION_ATTR(test_version);
1298static ELANTS_VERSION_ATTR(solution_version);
1299static ELANTS_VERSION_ATTR(bc_version);
1300static ELANTS_VERSION_ATTR(iap_version);
1301
1302static struct attribute *elants_attributes[] = {
1303 &dev_attr_calibrate.attr,
1304 &dev_attr_update_fw.attr,
1305 &dev_attr_iap_mode.attr,
1306 &dev_attr_calibration_count.attr,
1307
1308 &elants_ver_attr_fw_version.dattr.attr,
1309 &elants_ver_attr_hw_version.dattr.attr,
1310 &elants_ver_attr_test_version.dattr.attr,
1311 &elants_ver_attr_solution_version.dattr.attr,
1312 &elants_ver_attr_bc_version.dattr.attr,
1313 &elants_ver_attr_iap_version.dattr.attr,
1314 NULL
1315};
1316
1317static const struct attribute_group elants_attribute_group = {
1318 .attrs = elants_attributes,
1319};
1320
1321static int elants_i2c_power_on(struct elants_data *ts)
1322{
1323 int error;
1324
1325 /*
1326 * If we do not have reset gpio assume platform firmware
1327 * controls regulators and does power them on for us.
1328 */
1329 if (IS_ERR_OR_NULL(ts->reset_gpio))
1330 return 0;
1331
1332 error = regulator_enable(ts->vcc33);
1333 if (error) {
1334 dev_err(&ts->client->dev,
1335 "failed to enable vcc33 regulator: %d\n",
1336 error);
1337 return error;
1338 }
1339
1340 error = regulator_enable(ts->vccio);
1341 if (error) {
1342 dev_err(&ts->client->dev,
1343 "failed to enable vccio regulator: %d\n",
1344 error);
1345 regulator_disable(ts->vcc33);
1346 return error;
1347 }
1348
1349 /*
1350 * We need to wait a bit after powering on controller before
1351 * we are allowed to release reset GPIO.
1352 */
1353 usleep_range(ELAN_POWERON_DELAY_USEC, ELAN_POWERON_DELAY_USEC + 100);
1354
1355 gpiod_set_value_cansleep(ts->reset_gpio, 0);
1356
1357 msleep(ELAN_RESET_DELAY_MSEC);
1358
1359 return 0;
1360}
1361
1362static void elants_i2c_power_off(void *_data)
1363{
1364 struct elants_data *ts = _data;
1365
1366 if (!IS_ERR_OR_NULL(ts->reset_gpio)) {
1367 /*
1368 * Activate reset gpio to prevent leakage through the
1369 * pin once we shut off power to the controller.
1370 */
1371 gpiod_set_value_cansleep(ts->reset_gpio, 1);
1372 regulator_disable(ts->vccio);
1373 regulator_disable(ts->vcc33);
1374 }
1375}
1376
1377#ifdef CONFIG_ACPI
1378static const struct acpi_device_id i2c_hid_ids[] = {
1379 {"ACPI0C50", 0 },
1380 {"PNP0C50", 0 },
1381 { },
1382};
1383
1384static const guid_t i2c_hid_guid =
1385 GUID_INIT(0x3CDFF6F7, 0x4267, 0x4555,
1386 0xAD, 0x05, 0xB3, 0x0A, 0x3D, 0x89, 0x38, 0xDE);
1387
1388static bool elants_acpi_is_hid_device(struct device *dev)
1389{
1390 acpi_handle handle = ACPI_HANDLE(dev);
1391 union acpi_object *obj;
1392
1393 if (acpi_match_device_ids(ACPI_COMPANION(dev), i2c_hid_ids))
1394 return false;
1395
1396 obj = acpi_evaluate_dsm_typed(handle, &i2c_hid_guid, 1, 1, NULL, ACPI_TYPE_INTEGER);
1397 if (obj) {
1398 ACPI_FREE(obj);
1399 return true;
1400 }
1401
1402 return false;
1403}
1404#else
1405static bool elants_acpi_is_hid_device(struct device *dev)
1406{
1407 return false;
1408}
1409#endif
1410
1411static int elants_i2c_probe(struct i2c_client *client)
1412{
1413 union i2c_smbus_data dummy;
1414 struct elants_data *ts;
1415 unsigned long irqflags;
1416 int error;
1417
1418 /* Don't bind to i2c-hid compatible devices, these are handled by the i2c-hid drv. */
1419 if (elants_acpi_is_hid_device(&client->dev)) {
1420 dev_warn(&client->dev, "This device appears to be an I2C-HID device, not binding\n");
1421 return -ENODEV;
1422 }
1423
1424 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
1425 dev_err(&client->dev, "I2C check functionality error\n");
1426 return -ENXIO;
1427 }
1428
1429 ts = devm_kzalloc(&client->dev, sizeof(struct elants_data), GFP_KERNEL);
1430 if (!ts)
1431 return -ENOMEM;
1432
1433 mutex_init(&ts->sysfs_mutex);
1434 init_completion(&ts->cmd_done);
1435
1436 ts->client = client;
1437 ts->chip_id = (enum elants_chip_id)(uintptr_t)device_get_match_data(&client->dev);
1438 i2c_set_clientdata(client, ts);
1439
1440 ts->vcc33 = devm_regulator_get(&client->dev, "vcc33");
1441 if (IS_ERR(ts->vcc33)) {
1442 error = PTR_ERR(ts->vcc33);
1443 if (error != -EPROBE_DEFER)
1444 dev_err(&client->dev,
1445 "Failed to get 'vcc33' regulator: %d\n",
1446 error);
1447 return error;
1448 }
1449
1450 ts->vccio = devm_regulator_get(&client->dev, "vccio");
1451 if (IS_ERR(ts->vccio)) {
1452 error = PTR_ERR(ts->vccio);
1453 if (error != -EPROBE_DEFER)
1454 dev_err(&client->dev,
1455 "Failed to get 'vccio' regulator: %d\n",
1456 error);
1457 return error;
1458 }
1459
1460 ts->reset_gpio = devm_gpiod_get(&client->dev, "reset", GPIOD_OUT_HIGH);
1461 if (IS_ERR(ts->reset_gpio)) {
1462 error = PTR_ERR(ts->reset_gpio);
1463
1464 if (error == -EPROBE_DEFER)
1465 return error;
1466
1467 if (error != -ENOENT && error != -ENOSYS) {
1468 dev_err(&client->dev,
1469 "failed to get reset gpio: %d\n",
1470 error);
1471 return error;
1472 }
1473
1474 ts->keep_power_in_suspend = true;
1475 }
1476
1477 error = elants_i2c_power_on(ts);
1478 if (error)
1479 return error;
1480
1481 error = devm_add_action_or_reset(&client->dev,
1482 elants_i2c_power_off, ts);
1483 if (error) {
1484 dev_err(&client->dev,
1485 "failed to install power off action: %d\n", error);
1486 return error;
1487 }
1488
1489 /* Make sure there is something at this address */
1490 if (i2c_smbus_xfer(client->adapter, client->addr, 0,
1491 I2C_SMBUS_READ, 0, I2C_SMBUS_BYTE, &dummy) < 0) {
1492 dev_err(&client->dev, "nothing at this address\n");
1493 return -ENXIO;
1494 }
1495
1496 error = elants_i2c_initialize(ts);
1497 if (error) {
1498 dev_err(&client->dev, "failed to initialize: %d\n", error);
1499 return error;
1500 }
1501
1502 ts->input = devm_input_allocate_device(&client->dev);
1503 if (!ts->input) {
1504 dev_err(&client->dev, "Failed to allocate input device\n");
1505 return -ENOMEM;
1506 }
1507
1508 ts->input->name = "Elan Touchscreen";
1509 ts->input->id.bustype = BUS_I2C;
1510
1511 /* Multitouch input params setup */
1512
1513 input_set_abs_params(ts->input, ABS_MT_POSITION_X, 0, ts->x_max, 0, 0);
1514 input_set_abs_params(ts->input, ABS_MT_POSITION_Y, 0, ts->y_max, 0, 0);
1515 input_set_abs_params(ts->input, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0);
1516 input_set_abs_params(ts->input, ABS_MT_PRESSURE, 0, 255, 0, 0);
1517 input_set_abs_params(ts->input, ABS_MT_TOOL_TYPE,
1518 0, MT_TOOL_PALM, 0, 0);
1519
1520 touchscreen_parse_properties(ts->input, true, &ts->prop);
1521
1522 if (ts->chip_id == EKTF3624 && ts->phy_x && ts->phy_y) {
1523 /* calculate resolution from size */
1524 ts->x_res = DIV_ROUND_CLOSEST(ts->prop.max_x, ts->phy_x);
1525 ts->y_res = DIV_ROUND_CLOSEST(ts->prop.max_y, ts->phy_y);
1526 }
1527
1528 input_abs_set_res(ts->input, ABS_MT_POSITION_X, ts->x_res);
1529 input_abs_set_res(ts->input, ABS_MT_POSITION_Y, ts->y_res);
1530 input_abs_set_res(ts->input, ABS_MT_TOUCH_MAJOR, ts->major_res);
1531
1532 error = input_mt_init_slots(ts->input, MAX_CONTACT_NUM,
1533 INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED);
1534 if (error) {
1535 dev_err(&client->dev,
1536 "failed to initialize MT slots: %d\n", error);
1537 return error;
1538 }
1539
1540 error = input_register_device(ts->input);
1541 if (error) {
1542 dev_err(&client->dev,
1543 "unable to register input device: %d\n", error);
1544 return error;
1545 }
1546
1547 /*
1548 * Platform code (ACPI, DTS) should normally set up interrupt
1549 * for us, but in case it did not let's fall back to using falling
1550 * edge to be compatible with older Chromebooks.
1551 */
1552 irqflags = irq_get_trigger_type(client->irq);
1553 if (!irqflags)
1554 irqflags = IRQF_TRIGGER_FALLING;
1555
1556 error = devm_request_threaded_irq(&client->dev, client->irq,
1557 NULL, elants_i2c_irq,
1558 irqflags | IRQF_ONESHOT,
1559 client->name, ts);
1560 if (error) {
1561 dev_err(&client->dev, "Failed to register interrupt\n");
1562 return error;
1563 }
1564
1565 error = devm_device_add_group(&client->dev, &elants_attribute_group);
1566 if (error) {
1567 dev_err(&client->dev, "failed to create sysfs attributes: %d\n",
1568 error);
1569 return error;
1570 }
1571
1572 return 0;
1573}
1574
1575static int __maybe_unused elants_i2c_suspend(struct device *dev)
1576{
1577 struct i2c_client *client = to_i2c_client(dev);
1578 struct elants_data *ts = i2c_get_clientdata(client);
1579 const u8 set_sleep_cmd[] = {
1580 CMD_HEADER_WRITE, E_POWER_STATE_SLEEP, 0x00, 0x01
1581 };
1582 int retry_cnt;
1583 int error;
1584
1585 /* Command not support in IAP recovery mode */
1586 if (ts->iap_mode != ELAN_IAP_OPERATIONAL)
1587 return -EBUSY;
1588
1589 disable_irq(client->irq);
1590
1591 if (device_may_wakeup(dev)) {
1592 /*
1593 * The device will automatically enter idle mode
1594 * that has reduced power consumption.
1595 */
1596 return 0;
1597 } else if (ts->keep_power_in_suspend) {
1598 for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
1599 error = elants_i2c_send(client, set_sleep_cmd,
1600 sizeof(set_sleep_cmd));
1601 if (!error)
1602 break;
1603
1604 dev_err(&client->dev,
1605 "suspend command failed: %d\n", error);
1606 }
1607 } else {
1608 elants_i2c_power_off(ts);
1609 }
1610
1611 return 0;
1612}
1613
1614static int __maybe_unused elants_i2c_resume(struct device *dev)
1615{
1616 struct i2c_client *client = to_i2c_client(dev);
1617 struct elants_data *ts = i2c_get_clientdata(client);
1618 const u8 set_active_cmd[] = {
1619 CMD_HEADER_WRITE, E_POWER_STATE_RESUME, 0x00, 0x01
1620 };
1621 int retry_cnt;
1622 int error;
1623
1624 if (device_may_wakeup(dev)) {
1625 elants_i2c_sw_reset(client);
1626 } else if (ts->keep_power_in_suspend) {
1627 for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
1628 error = elants_i2c_send(client, set_active_cmd,
1629 sizeof(set_active_cmd));
1630 if (!error)
1631 break;
1632
1633 dev_err(&client->dev,
1634 "resume command failed: %d\n", error);
1635 }
1636 } else {
1637 elants_i2c_power_on(ts);
1638 elants_i2c_initialize(ts);
1639 }
1640
1641 ts->state = ELAN_STATE_NORMAL;
1642 enable_irq(client->irq);
1643
1644 return 0;
1645}
1646
1647static SIMPLE_DEV_PM_OPS(elants_i2c_pm_ops,
1648 elants_i2c_suspend, elants_i2c_resume);
1649
1650static const struct i2c_device_id elants_i2c_id[] = {
1651 { DEVICE_NAME, EKTH3500 },
1652 { "ekth3500", EKTH3500 },
1653 { "ektf3624", EKTF3624 },
1654 { }
1655};
1656MODULE_DEVICE_TABLE(i2c, elants_i2c_id);
1657
1658#ifdef CONFIG_ACPI
1659static const struct acpi_device_id elants_acpi_id[] = {
1660 { "ELAN0001", EKTH3500 },
1661 { }
1662};
1663MODULE_DEVICE_TABLE(acpi, elants_acpi_id);
1664#endif
1665
1666#ifdef CONFIG_OF
1667static const struct of_device_id elants_of_match[] = {
1668 { .compatible = "elan,ekth3500", .data = (void *)EKTH3500 },
1669 { .compatible = "elan,ektf3624", .data = (void *)EKTF3624 },
1670 { /* sentinel */ }
1671};
1672MODULE_DEVICE_TABLE(of, elants_of_match);
1673#endif
1674
1675static struct i2c_driver elants_i2c_driver = {
1676 .probe_new = elants_i2c_probe,
1677 .id_table = elants_i2c_id,
1678 .driver = {
1679 .name = DEVICE_NAME,
1680 .pm = &elants_i2c_pm_ops,
1681 .acpi_match_table = ACPI_PTR(elants_acpi_id),
1682 .of_match_table = of_match_ptr(elants_of_match),
1683 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1684 },
1685};
1686module_i2c_driver(elants_i2c_driver);
1687
1688MODULE_AUTHOR("Scott Liu <scott.liu@emc.com.tw>");
1689MODULE_DESCRIPTION("Elan I2c Touchscreen driver");
1690MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Elan Microelectronics touch panels with I2C interface
4 *
5 * Copyright (C) 2014 Elan Microelectronics Corporation.
6 * Scott Liu <scott.liu@emc.com.tw>
7 *
8 * This code is partly based on hid-multitouch.c:
9 *
10 * Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
11 * Copyright (c) 2010-2012 Benjamin Tissoires <benjamin.tissoires@gmail.com>
12 * Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
13 *
14 * This code is partly based on i2c-hid.c:
15 *
16 * Copyright (c) 2012 Benjamin Tissoires <benjamin.tissoires@gmail.com>
17 * Copyright (c) 2012 Ecole Nationale de l'Aviation Civile, France
18 * Copyright (c) 2012 Red Hat, Inc
19 */
20
21
22#include <linux/bits.h>
23#include <linux/module.h>
24#include <linux/input.h>
25#include <linux/interrupt.h>
26#include <linux/irq.h>
27#include <linux/platform_device.h>
28#include <linux/async.h>
29#include <linux/i2c.h>
30#include <linux/delay.h>
31#include <linux/uaccess.h>
32#include <linux/buffer_head.h>
33#include <linux/slab.h>
34#include <linux/firmware.h>
35#include <linux/input/mt.h>
36#include <linux/input/touchscreen.h>
37#include <linux/acpi.h>
38#include <linux/of.h>
39#include <linux/gpio/consumer.h>
40#include <linux/regulator/consumer.h>
41#include <linux/uuid.h>
42#include <asm/unaligned.h>
43
44/* Device, Driver information */
45#define DEVICE_NAME "elants_i2c"
46
47/* Convert from rows or columns into resolution */
48#define ELAN_TS_RESOLUTION(n, m) (((n) - 1) * (m))
49
50/* FW header data */
51#define HEADER_SIZE 4
52#define FW_HDR_TYPE 0
53#define FW_HDR_COUNT 1
54#define FW_HDR_LENGTH 2
55
56/* Buffer mode Queue Header information */
57#define QUEUE_HEADER_SINGLE 0x62
58#define QUEUE_HEADER_NORMAL 0X63
59#define QUEUE_HEADER_WAIT 0x64
60#define QUEUE_HEADER_NORMAL2 0x66
61
62/* Command header definition */
63#define CMD_HEADER_WRITE 0x54
64#define CMD_HEADER_READ 0x53
65#define CMD_HEADER_6B_READ 0x5B
66#define CMD_HEADER_ROM_READ 0x96
67#define CMD_HEADER_RESP 0x52
68#define CMD_HEADER_6B_RESP 0x9B
69#define CMD_HEADER_ROM_RESP 0x95
70#define CMD_HEADER_HELLO 0x55
71#define CMD_HEADER_REK 0x66
72
73/* FW position data */
74#define PACKET_SIZE_OLD 40
75#define PACKET_SIZE 55
76#define MAX_CONTACT_NUM 10
77#define FW_POS_HEADER 0
78#define FW_POS_STATE 1
79#define FW_POS_TOTAL 2
80#define FW_POS_XY 3
81#define FW_POS_TOOL_TYPE 33
82#define FW_POS_CHECKSUM 34
83#define FW_POS_WIDTH 35
84#define FW_POS_PRESSURE 45
85
86#define HEADER_REPORT_10_FINGER 0x62
87
88/* Header (4 bytes) plus 3 full 10-finger packets */
89#define MAX_PACKET_SIZE 169
90
91#define BOOT_TIME_DELAY_MS 50
92
93/* FW read command, 0x53 0x?? 0x0, 0x01 */
94#define E_ELAN_INFO_FW_VER 0x00
95#define E_ELAN_INFO_BC_VER 0x10
96#define E_ELAN_INFO_X_RES 0x60
97#define E_ELAN_INFO_Y_RES 0x63
98#define E_ELAN_INFO_REK 0xD0
99#define E_ELAN_INFO_TEST_VER 0xE0
100#define E_ELAN_INFO_FW_ID 0xF0
101#define E_INFO_OSR 0xD6
102#define E_INFO_PHY_SCAN 0xD7
103#define E_INFO_PHY_DRIVER 0xD8
104
105/* FW write command, 0x54 0x?? 0x0, 0x01 */
106#define E_POWER_STATE_SLEEP 0x50
107#define E_POWER_STATE_RESUME 0x58
108
109#define MAX_RETRIES 3
110#define MAX_FW_UPDATE_RETRIES 30
111
112#define ELAN_FW_PAGESIZE 132
113
114/* calibration timeout definition */
115#define ELAN_CALI_TIMEOUT_MSEC 12000
116
117#define ELAN_POWERON_DELAY_USEC 500
118#define ELAN_RESET_DELAY_MSEC 20
119
120enum elants_chip_id {
121 EKTH3500,
122 EKTF3624,
123};
124
125enum elants_state {
126 ELAN_STATE_NORMAL,
127 ELAN_WAIT_QUEUE_HEADER,
128 ELAN_WAIT_RECALIBRATION,
129};
130
131enum elants_iap_mode {
132 ELAN_IAP_OPERATIONAL,
133 ELAN_IAP_RECOVERY,
134};
135
136/* struct elants_data - represents state of Elan touchscreen device */
137struct elants_data {
138 struct i2c_client *client;
139 struct input_dev *input;
140
141 struct regulator *vcc33;
142 struct regulator *vccio;
143 struct gpio_desc *reset_gpio;
144
145 u16 fw_version;
146 u8 test_version;
147 u8 solution_version;
148 u8 bc_version;
149 u8 iap_version;
150 u16 hw_version;
151 u8 major_res;
152 unsigned int x_res; /* resolution in units/mm */
153 unsigned int y_res;
154 unsigned int x_max;
155 unsigned int y_max;
156 unsigned int phy_x;
157 unsigned int phy_y;
158 struct touchscreen_properties prop;
159
160 enum elants_state state;
161 enum elants_chip_id chip_id;
162 enum elants_iap_mode iap_mode;
163
164 /* Guards against concurrent access to the device via sysfs */
165 struct mutex sysfs_mutex;
166
167 u8 cmd_resp[HEADER_SIZE];
168 struct completion cmd_done;
169
170 bool wake_irq_enabled;
171 bool keep_power_in_suspend;
172
173 /* Must be last to be used for DMA operations */
174 u8 buf[MAX_PACKET_SIZE] ____cacheline_aligned;
175};
176
177static int elants_i2c_send(struct i2c_client *client,
178 const void *data, size_t size)
179{
180 int ret;
181
182 ret = i2c_master_send(client, data, size);
183 if (ret == size)
184 return 0;
185
186 if (ret >= 0)
187 ret = -EIO;
188
189 dev_err(&client->dev, "%s failed (%*ph): %d\n",
190 __func__, (int)size, data, ret);
191
192 return ret;
193}
194
195static int elants_i2c_read(struct i2c_client *client, void *data, size_t size)
196{
197 int ret;
198
199 ret = i2c_master_recv(client, data, size);
200 if (ret == size)
201 return 0;
202
203 if (ret >= 0)
204 ret = -EIO;
205
206 dev_err(&client->dev, "%s failed: %d\n", __func__, ret);
207
208 return ret;
209}
210
211static int elants_i2c_execute_command(struct i2c_client *client,
212 const u8 *cmd, size_t cmd_size,
213 u8 *resp, size_t resp_size,
214 int retries, const char *cmd_name)
215{
216 struct i2c_msg msgs[2];
217 int ret;
218 u8 expected_response;
219
220 switch (cmd[0]) {
221 case CMD_HEADER_READ:
222 expected_response = CMD_HEADER_RESP;
223 break;
224
225 case CMD_HEADER_6B_READ:
226 expected_response = CMD_HEADER_6B_RESP;
227 break;
228
229 case CMD_HEADER_ROM_READ:
230 expected_response = CMD_HEADER_ROM_RESP;
231 break;
232
233 default:
234 dev_err(&client->dev, "(%s): invalid command: %*ph\n",
235 cmd_name, (int)cmd_size, cmd);
236 return -EINVAL;
237 }
238
239 for (;;) {
240 msgs[0].addr = client->addr;
241 msgs[0].flags = client->flags & I2C_M_TEN;
242 msgs[0].len = cmd_size;
243 msgs[0].buf = (u8 *)cmd;
244
245 msgs[1].addr = client->addr;
246 msgs[1].flags = (client->flags & I2C_M_TEN) | I2C_M_RD;
247 msgs[1].flags |= I2C_M_RD;
248 msgs[1].len = resp_size;
249 msgs[1].buf = resp;
250
251 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
252 if (ret < 0) {
253 if (--retries > 0) {
254 dev_dbg(&client->dev,
255 "(%s) I2C transfer failed: %pe (retrying)\n",
256 cmd_name, ERR_PTR(ret));
257 continue;
258 }
259
260 dev_err(&client->dev,
261 "(%s) I2C transfer failed: %pe\n",
262 cmd_name, ERR_PTR(ret));
263 return ret;
264 }
265
266 if (ret != ARRAY_SIZE(msgs) ||
267 resp[FW_HDR_TYPE] != expected_response) {
268 if (--retries > 0) {
269 dev_dbg(&client->dev,
270 "(%s) unexpected response: %*ph (retrying)\n",
271 cmd_name, ret, resp);
272 continue;
273 }
274
275 dev_err(&client->dev,
276 "(%s) unexpected response: %*ph\n",
277 cmd_name, ret, resp);
278 return -EIO;
279 }
280
281 return 0;
282 }
283}
284
285static int elants_i2c_calibrate(struct elants_data *ts)
286{
287 struct i2c_client *client = ts->client;
288 int ret, error;
289 static const u8 w_flashkey[] = { CMD_HEADER_WRITE, 0xC0, 0xE1, 0x5A };
290 static const u8 rek[] = { CMD_HEADER_WRITE, 0x29, 0x00, 0x01 };
291 static const u8 rek_resp[] = { CMD_HEADER_REK, 0x66, 0x66, 0x66 };
292
293 disable_irq(client->irq);
294
295 ts->state = ELAN_WAIT_RECALIBRATION;
296 reinit_completion(&ts->cmd_done);
297
298 elants_i2c_send(client, w_flashkey, sizeof(w_flashkey));
299 elants_i2c_send(client, rek, sizeof(rek));
300
301 enable_irq(client->irq);
302
303 ret = wait_for_completion_interruptible_timeout(&ts->cmd_done,
304 msecs_to_jiffies(ELAN_CALI_TIMEOUT_MSEC));
305
306 ts->state = ELAN_STATE_NORMAL;
307
308 if (ret <= 0) {
309 error = ret < 0 ? ret : -ETIMEDOUT;
310 dev_err(&client->dev,
311 "error while waiting for calibration to complete: %d\n",
312 error);
313 return error;
314 }
315
316 if (memcmp(rek_resp, ts->cmd_resp, sizeof(rek_resp))) {
317 dev_err(&client->dev,
318 "unexpected calibration response: %*ph\n",
319 (int)sizeof(ts->cmd_resp), ts->cmd_resp);
320 return -EINVAL;
321 }
322
323 return 0;
324}
325
326static int elants_i2c_sw_reset(struct i2c_client *client)
327{
328 const u8 soft_rst_cmd[] = { 0x77, 0x77, 0x77, 0x77 };
329 int error;
330
331 error = elants_i2c_send(client, soft_rst_cmd,
332 sizeof(soft_rst_cmd));
333 if (error) {
334 dev_err(&client->dev, "software reset failed: %d\n", error);
335 return error;
336 }
337
338 /*
339 * We should wait at least 10 msec (but no more than 40) before
340 * sending fastboot or IAP command to the device.
341 */
342 msleep(30);
343
344 return 0;
345}
346
347static u16 elants_i2c_parse_version(u8 *buf)
348{
349 return get_unaligned_be32(buf) >> 4;
350}
351
352static int elants_i2c_query_hw_version(struct elants_data *ts)
353{
354 struct i2c_client *client = ts->client;
355 int retry_cnt = MAX_RETRIES;
356 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_FW_ID, 0x00, 0x01 };
357 u8 resp[HEADER_SIZE];
358 int error;
359
360 while (retry_cnt--) {
361 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
362 resp, sizeof(resp), 1,
363 "read fw id");
364 if (error)
365 return error;
366
367 ts->hw_version = elants_i2c_parse_version(resp);
368 if (ts->hw_version != 0xffff)
369 return 0;
370 }
371
372 dev_err(&client->dev, "Invalid fw id: %#04x\n", ts->hw_version);
373
374 return -EINVAL;
375}
376
377static int elants_i2c_query_fw_version(struct elants_data *ts)
378{
379 struct i2c_client *client = ts->client;
380 int retry_cnt = MAX_RETRIES;
381 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_FW_VER, 0x00, 0x01 };
382 u8 resp[HEADER_SIZE];
383 int error;
384
385 while (retry_cnt--) {
386 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
387 resp, sizeof(resp), 1,
388 "read fw version");
389 if (error)
390 return error;
391
392 ts->fw_version = elants_i2c_parse_version(resp);
393 if (ts->fw_version != 0x0000 && ts->fw_version != 0xffff)
394 return 0;
395
396 dev_dbg(&client->dev, "(read fw version) resp %*phC\n",
397 (int)sizeof(resp), resp);
398 }
399
400 dev_err(&client->dev, "Invalid fw ver: %#04x\n", ts->fw_version);
401
402 return -EINVAL;
403}
404
405static int elants_i2c_query_test_version(struct elants_data *ts)
406{
407 struct i2c_client *client = ts->client;
408 int error;
409 u16 version;
410 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_TEST_VER, 0x00, 0x01 };
411 u8 resp[HEADER_SIZE];
412
413 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
414 resp, sizeof(resp), MAX_RETRIES,
415 "read test version");
416 if (error) {
417 dev_err(&client->dev, "Failed to read test version\n");
418 return error;
419 }
420
421 version = elants_i2c_parse_version(resp);
422 ts->test_version = version >> 8;
423 ts->solution_version = version & 0xff;
424
425 return 0;
426}
427
428static int elants_i2c_query_bc_version(struct elants_data *ts)
429{
430 struct i2c_client *client = ts->client;
431 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_BC_VER, 0x00, 0x01 };
432 u8 resp[HEADER_SIZE];
433 u16 version;
434 int error;
435
436 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
437 resp, sizeof(resp), 1,
438 "read BC version");
439 if (error)
440 return error;
441
442 version = elants_i2c_parse_version(resp);
443 ts->bc_version = version >> 8;
444 ts->iap_version = version & 0xff;
445
446 return 0;
447}
448
449static int elants_i2c_query_ts_info_ektf(struct elants_data *ts)
450{
451 struct i2c_client *client = ts->client;
452 int error;
453 u8 resp[4];
454 u16 phy_x, phy_y;
455 const u8 get_xres_cmd[] = {
456 CMD_HEADER_READ, E_ELAN_INFO_X_RES, 0x00, 0x00
457 };
458 const u8 get_yres_cmd[] = {
459 CMD_HEADER_READ, E_ELAN_INFO_Y_RES, 0x00, 0x00
460 };
461
462 /* Get X/Y size in mm */
463 error = elants_i2c_execute_command(client, get_xres_cmd,
464 sizeof(get_xres_cmd),
465 resp, sizeof(resp), 1,
466 "get X size");
467 if (error)
468 return error;
469
470 phy_x = resp[2] | ((resp[3] & 0xF0) << 4);
471
472 error = elants_i2c_execute_command(client, get_yres_cmd,
473 sizeof(get_yres_cmd),
474 resp, sizeof(resp), 1,
475 "get Y size");
476 if (error)
477 return error;
478
479 phy_y = resp[2] | ((resp[3] & 0xF0) << 4);
480
481 dev_dbg(&client->dev, "phy_x=%d, phy_y=%d\n", phy_x, phy_y);
482
483 ts->phy_x = phy_x;
484 ts->phy_y = phy_y;
485
486 /* eKTF doesn't report max size, set it to default values */
487 ts->x_max = 2240 - 1;
488 ts->y_max = 1408 - 1;
489
490 return 0;
491}
492
493static int elants_i2c_query_ts_info_ekth(struct elants_data *ts)
494{
495 struct i2c_client *client = ts->client;
496 int error;
497 u8 resp[17];
498 u16 phy_x, phy_y, rows, cols, osr;
499 const u8 get_resolution_cmd[] = {
500 CMD_HEADER_6B_READ, 0x00, 0x00, 0x00, 0x00, 0x00
501 };
502 const u8 get_osr_cmd[] = {
503 CMD_HEADER_READ, E_INFO_OSR, 0x00, 0x01
504 };
505 const u8 get_physical_scan_cmd[] = {
506 CMD_HEADER_READ, E_INFO_PHY_SCAN, 0x00, 0x01
507 };
508 const u8 get_physical_drive_cmd[] = {
509 CMD_HEADER_READ, E_INFO_PHY_DRIVER, 0x00, 0x01
510 };
511
512 /* Get trace number */
513 error = elants_i2c_execute_command(client,
514 get_resolution_cmd,
515 sizeof(get_resolution_cmd),
516 resp, sizeof(resp), 1,
517 "get resolution");
518 if (error)
519 return error;
520
521 rows = resp[2] + resp[6] + resp[10];
522 cols = resp[3] + resp[7] + resp[11];
523
524 /* Get report resolution value of ABS_MT_TOUCH_MAJOR */
525 ts->major_res = resp[16];
526
527 /* Process mm_to_pixel information */
528 error = elants_i2c_execute_command(client,
529 get_osr_cmd, sizeof(get_osr_cmd),
530 resp, sizeof(resp), 1, "get osr");
531 if (error)
532 return error;
533
534 osr = resp[3];
535
536 error = elants_i2c_execute_command(client,
537 get_physical_scan_cmd,
538 sizeof(get_physical_scan_cmd),
539 resp, sizeof(resp), 1,
540 "get physical scan");
541 if (error)
542 return error;
543
544 phy_x = get_unaligned_be16(&resp[2]);
545
546 error = elants_i2c_execute_command(client,
547 get_physical_drive_cmd,
548 sizeof(get_physical_drive_cmd),
549 resp, sizeof(resp), 1,
550 "get physical drive");
551 if (error)
552 return error;
553
554 phy_y = get_unaligned_be16(&resp[2]);
555
556 dev_dbg(&client->dev, "phy_x=%d, phy_y=%d\n", phy_x, phy_y);
557
558 if (rows == 0 || cols == 0 || osr == 0) {
559 dev_warn(&client->dev,
560 "invalid trace number data: %d, %d, %d\n",
561 rows, cols, osr);
562 } else {
563 /* translate trace number to TS resolution */
564 ts->x_max = ELAN_TS_RESOLUTION(rows, osr);
565 ts->x_res = DIV_ROUND_CLOSEST(ts->x_max, phy_x);
566 ts->y_max = ELAN_TS_RESOLUTION(cols, osr);
567 ts->y_res = DIV_ROUND_CLOSEST(ts->y_max, phy_y);
568 ts->phy_x = phy_x;
569 ts->phy_y = phy_y;
570 }
571
572 return 0;
573}
574
575static int elants_i2c_fastboot(struct i2c_client *client)
576{
577 const u8 boot_cmd[] = { 0x4D, 0x61, 0x69, 0x6E };
578 int error;
579
580 error = elants_i2c_send(client, boot_cmd, sizeof(boot_cmd));
581 if (error) {
582 dev_err(&client->dev, "boot failed: %d\n", error);
583 return error;
584 }
585
586 dev_dbg(&client->dev, "boot success -- 0x%x\n", client->addr);
587 return 0;
588}
589
590static int elants_i2c_initialize(struct elants_data *ts)
591{
592 struct i2c_client *client = ts->client;
593 int error, error2, retry_cnt;
594 const u8 hello_packet[] = { 0x55, 0x55, 0x55, 0x55 };
595 const u8 recov_packet[] = { 0x55, 0x55, 0x80, 0x80 };
596 u8 buf[HEADER_SIZE];
597
598 for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
599 error = elants_i2c_sw_reset(client);
600 if (error) {
601 /* Continue initializing if it's the last try */
602 if (retry_cnt < MAX_RETRIES - 1)
603 continue;
604 }
605
606 error = elants_i2c_fastboot(client);
607 if (error) {
608 /* Continue initializing if it's the last try */
609 if (retry_cnt < MAX_RETRIES - 1)
610 continue;
611 }
612
613 /* Wait for Hello packet */
614 msleep(BOOT_TIME_DELAY_MS);
615
616 error = elants_i2c_read(client, buf, sizeof(buf));
617 if (error) {
618 dev_err(&client->dev,
619 "failed to read 'hello' packet: %d\n", error);
620 } else if (!memcmp(buf, hello_packet, sizeof(hello_packet))) {
621 ts->iap_mode = ELAN_IAP_OPERATIONAL;
622 break;
623 } else if (!memcmp(buf, recov_packet, sizeof(recov_packet))) {
624 /*
625 * Setting error code will mark device
626 * in recovery mode below.
627 */
628 error = -EIO;
629 break;
630 } else {
631 error = -EINVAL;
632 dev_err(&client->dev,
633 "invalid 'hello' packet: %*ph\n",
634 (int)sizeof(buf), buf);
635 }
636 }
637
638 /* hw version is available even if device in recovery state */
639 error2 = elants_i2c_query_hw_version(ts);
640 if (!error2)
641 error2 = elants_i2c_query_bc_version(ts);
642 if (!error)
643 error = error2;
644
645 if (!error)
646 error = elants_i2c_query_fw_version(ts);
647 if (!error)
648 error = elants_i2c_query_test_version(ts);
649
650 switch (ts->chip_id) {
651 case EKTH3500:
652 if (!error)
653 error = elants_i2c_query_ts_info_ekth(ts);
654 break;
655 case EKTF3624:
656 if (!error)
657 error = elants_i2c_query_ts_info_ektf(ts);
658 break;
659 default:
660 BUG();
661 }
662
663 if (error)
664 ts->iap_mode = ELAN_IAP_RECOVERY;
665
666 return 0;
667}
668
669/*
670 * Firmware update interface.
671 */
672
673static int elants_i2c_fw_write_page(struct i2c_client *client,
674 const void *page)
675{
676 const u8 ack_ok[] = { 0xaa, 0xaa };
677 u8 buf[2];
678 int retry;
679 int error;
680
681 for (retry = 0; retry < MAX_FW_UPDATE_RETRIES; retry++) {
682 error = elants_i2c_send(client, page, ELAN_FW_PAGESIZE);
683 if (error) {
684 dev_err(&client->dev,
685 "IAP Write Page failed: %d\n", error);
686 continue;
687 }
688
689 error = elants_i2c_read(client, buf, 2);
690 if (error) {
691 dev_err(&client->dev,
692 "IAP Ack read failed: %d\n", error);
693 return error;
694 }
695
696 if (!memcmp(buf, ack_ok, sizeof(ack_ok)))
697 return 0;
698
699 error = -EIO;
700 dev_err(&client->dev,
701 "IAP Get Ack Error [%02x:%02x]\n",
702 buf[0], buf[1]);
703 }
704
705 return error;
706}
707
708static int elants_i2c_validate_remark_id(struct elants_data *ts,
709 const struct firmware *fw)
710{
711 struct i2c_client *client = ts->client;
712 int error;
713 const u8 cmd[] = { CMD_HEADER_ROM_READ, 0x80, 0x1F, 0x00, 0x00, 0x21 };
714 u8 resp[6] = { 0 };
715 u16 ts_remark_id = 0;
716 u16 fw_remark_id = 0;
717
718 /* Compare TS Remark ID and FW Remark ID */
719 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
720 resp, sizeof(resp),
721 1, "read Remark ID");
722 if (error)
723 return error;
724
725 ts_remark_id = get_unaligned_be16(&resp[3]);
726
727 fw_remark_id = get_unaligned_le16(&fw->data[fw->size - 4]);
728
729 if (fw_remark_id != ts_remark_id) {
730 dev_err(&client->dev,
731 "Remark ID Mismatched: ts_remark_id=0x%04x, fw_remark_id=0x%04x.\n",
732 ts_remark_id, fw_remark_id);
733 return -EINVAL;
734 }
735
736 return 0;
737}
738
739static int elants_i2c_do_update_firmware(struct i2c_client *client,
740 const struct firmware *fw,
741 bool force)
742{
743 struct elants_data *ts = i2c_get_clientdata(client);
744 const u8 enter_iap[] = { 0x45, 0x49, 0x41, 0x50 };
745 const u8 enter_iap2[] = { 0x54, 0x00, 0x12, 0x34 };
746 const u8 iap_ack[] = { 0x55, 0xaa, 0x33, 0xcc };
747 const u8 close_idle[] = { 0x54, 0x2c, 0x01, 0x01 };
748 u8 buf[HEADER_SIZE];
749 u16 send_id;
750 int page, n_fw_pages;
751 int error;
752 bool check_remark_id = ts->iap_version >= 0x60;
753
754 /* Recovery mode detection! */
755 if (force) {
756 dev_dbg(&client->dev, "Recovery mode procedure\n");
757
758 if (check_remark_id) {
759 error = elants_i2c_validate_remark_id(ts, fw);
760 if (error)
761 return error;
762 }
763
764 error = elants_i2c_send(client, enter_iap2, sizeof(enter_iap2));
765 if (error) {
766 dev_err(&client->dev, "failed to enter IAP mode: %d\n",
767 error);
768 return error;
769 }
770 } else {
771 /* Start IAP Procedure */
772 dev_dbg(&client->dev, "Normal IAP procedure\n");
773
774 /* Close idle mode */
775 error = elants_i2c_send(client, close_idle, sizeof(close_idle));
776 if (error)
777 dev_err(&client->dev, "Failed close idle: %d\n", error);
778 msleep(60);
779
780 elants_i2c_sw_reset(client);
781 msleep(20);
782
783 if (check_remark_id) {
784 error = elants_i2c_validate_remark_id(ts, fw);
785 if (error)
786 return error;
787 }
788
789 error = elants_i2c_send(client, enter_iap, sizeof(enter_iap));
790 if (error) {
791 dev_err(&client->dev, "failed to enter IAP mode: %d\n",
792 error);
793 return error;
794 }
795 }
796
797 msleep(20);
798
799 /* check IAP state */
800 error = elants_i2c_read(client, buf, 4);
801 if (error) {
802 dev_err(&client->dev,
803 "failed to read IAP acknowledgement: %d\n",
804 error);
805 return error;
806 }
807
808 if (memcmp(buf, iap_ack, sizeof(iap_ack))) {
809 dev_err(&client->dev,
810 "failed to enter IAP: %*ph (expected %*ph)\n",
811 (int)sizeof(buf), buf, (int)sizeof(iap_ack), iap_ack);
812 return -EIO;
813 }
814
815 dev_info(&client->dev, "successfully entered IAP mode");
816
817 send_id = client->addr;
818 error = elants_i2c_send(client, &send_id, 1);
819 if (error) {
820 dev_err(&client->dev, "sending dummy byte failed: %d\n",
821 error);
822 return error;
823 }
824
825 /* Clear the last page of Master */
826 error = elants_i2c_send(client, fw->data, ELAN_FW_PAGESIZE);
827 if (error) {
828 dev_err(&client->dev, "clearing of the last page failed: %d\n",
829 error);
830 return error;
831 }
832
833 error = elants_i2c_read(client, buf, 2);
834 if (error) {
835 dev_err(&client->dev,
836 "failed to read ACK for clearing the last page: %d\n",
837 error);
838 return error;
839 }
840
841 n_fw_pages = fw->size / ELAN_FW_PAGESIZE;
842 dev_dbg(&client->dev, "IAP Pages = %d\n", n_fw_pages);
843
844 for (page = 0; page < n_fw_pages; page++) {
845 error = elants_i2c_fw_write_page(client,
846 fw->data + page * ELAN_FW_PAGESIZE);
847 if (error) {
848 dev_err(&client->dev,
849 "failed to write FW page %d: %d\n",
850 page, error);
851 return error;
852 }
853 }
854
855 /* Old iap needs to wait 200ms for WDT and rest is for hello packets */
856 msleep(300);
857
858 dev_info(&client->dev, "firmware update completed\n");
859 return 0;
860}
861
862static int elants_i2c_fw_update(struct elants_data *ts)
863{
864 struct i2c_client *client = ts->client;
865 const struct firmware *fw;
866 char *fw_name;
867 int error;
868
869 fw_name = kasprintf(GFP_KERNEL, "elants_i2c_%04x.bin", ts->hw_version);
870 if (!fw_name)
871 return -ENOMEM;
872
873 dev_info(&client->dev, "requesting fw name = %s\n", fw_name);
874 error = request_firmware(&fw, fw_name, &client->dev);
875 kfree(fw_name);
876 if (error) {
877 dev_err(&client->dev, "failed to request firmware: %d\n",
878 error);
879 return error;
880 }
881
882 if (fw->size % ELAN_FW_PAGESIZE) {
883 dev_err(&client->dev, "invalid firmware length: %zu\n",
884 fw->size);
885 error = -EINVAL;
886 goto out;
887 }
888
889 disable_irq(client->irq);
890
891 error = elants_i2c_do_update_firmware(client, fw,
892 ts->iap_mode == ELAN_IAP_RECOVERY);
893 if (error) {
894 dev_err(&client->dev, "firmware update failed: %d\n", error);
895 ts->iap_mode = ELAN_IAP_RECOVERY;
896 goto out_enable_irq;
897 }
898
899 error = elants_i2c_initialize(ts);
900 if (error) {
901 dev_err(&client->dev,
902 "failed to initialize device after firmware update: %d\n",
903 error);
904 ts->iap_mode = ELAN_IAP_RECOVERY;
905 goto out_enable_irq;
906 }
907
908 ts->iap_mode = ELAN_IAP_OPERATIONAL;
909
910out_enable_irq:
911 ts->state = ELAN_STATE_NORMAL;
912 enable_irq(client->irq);
913 msleep(100);
914
915 if (!error)
916 elants_i2c_calibrate(ts);
917out:
918 release_firmware(fw);
919 return error;
920}
921
922/*
923 * Event reporting.
924 */
925
926static void elants_i2c_mt_event(struct elants_data *ts, u8 *buf,
927 size_t packet_size)
928{
929 struct input_dev *input = ts->input;
930 unsigned int n_fingers;
931 unsigned int tool_type;
932 u16 finger_state;
933 int i;
934
935 n_fingers = buf[FW_POS_STATE + 1] & 0x0f;
936 finger_state = ((buf[FW_POS_STATE + 1] & 0x30) << 4) |
937 buf[FW_POS_STATE];
938
939 dev_dbg(&ts->client->dev,
940 "n_fingers: %u, state: %04x\n", n_fingers, finger_state);
941
942 /* Note: all fingers have the same tool type */
943 tool_type = buf[FW_POS_TOOL_TYPE] & BIT(0) ?
944 MT_TOOL_FINGER : MT_TOOL_PALM;
945
946 for (i = 0; i < MAX_CONTACT_NUM && n_fingers; i++) {
947 if (finger_state & 1) {
948 unsigned int x, y, p, w;
949 u8 *pos;
950
951 pos = &buf[FW_POS_XY + i * 3];
952 x = (((u16)pos[0] & 0xf0) << 4) | pos[1];
953 y = (((u16)pos[0] & 0x0f) << 8) | pos[2];
954
955 /*
956 * eKTF3624 may have use "old" touch-report format,
957 * depending on a device and TS firmware version.
958 * For example, ASUS Transformer devices use the "old"
959 * format, while ASUS Nexus 7 uses the "new" formant.
960 */
961 if (packet_size == PACKET_SIZE_OLD &&
962 ts->chip_id == EKTF3624) {
963 w = buf[FW_POS_WIDTH + i / 2];
964 w >>= 4 * (~i & 1);
965 w |= w << 4;
966 w |= !w;
967 p = w;
968 } else {
969 p = buf[FW_POS_PRESSURE + i];
970 w = buf[FW_POS_WIDTH + i];
971 }
972
973 dev_dbg(&ts->client->dev, "i=%d x=%d y=%d p=%d w=%d\n",
974 i, x, y, p, w);
975
976 input_mt_slot(input, i);
977 input_mt_report_slot_state(input, tool_type, true);
978 touchscreen_report_pos(input, &ts->prop, x, y, true);
979 input_event(input, EV_ABS, ABS_MT_PRESSURE, p);
980 input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, w);
981
982 n_fingers--;
983 }
984
985 finger_state >>= 1;
986 }
987
988 input_mt_sync_frame(input);
989 input_sync(input);
990}
991
992static u8 elants_i2c_calculate_checksum(u8 *buf)
993{
994 u8 checksum = 0;
995 u8 i;
996
997 for (i = 0; i < FW_POS_CHECKSUM; i++)
998 checksum += buf[i];
999
1000 return checksum;
1001}
1002
1003static void elants_i2c_event(struct elants_data *ts, u8 *buf,
1004 size_t packet_size)
1005{
1006 u8 checksum = elants_i2c_calculate_checksum(buf);
1007
1008 if (unlikely(buf[FW_POS_CHECKSUM] != checksum))
1009 dev_warn(&ts->client->dev,
1010 "%s: invalid checksum for packet %02x: %02x vs. %02x\n",
1011 __func__, buf[FW_POS_HEADER],
1012 checksum, buf[FW_POS_CHECKSUM]);
1013 else if (unlikely(buf[FW_POS_HEADER] != HEADER_REPORT_10_FINGER))
1014 dev_warn(&ts->client->dev,
1015 "%s: unknown packet type: %02x\n",
1016 __func__, buf[FW_POS_HEADER]);
1017 else
1018 elants_i2c_mt_event(ts, buf, packet_size);
1019}
1020
1021static irqreturn_t elants_i2c_irq(int irq, void *_dev)
1022{
1023 const u8 wait_packet[] = { 0x64, 0x64, 0x64, 0x64 };
1024 struct elants_data *ts = _dev;
1025 struct i2c_client *client = ts->client;
1026 int report_count, report_len;
1027 int i;
1028 int len;
1029
1030 len = i2c_master_recv_dmasafe(client, ts->buf, sizeof(ts->buf));
1031 if (len < 0) {
1032 dev_err(&client->dev, "%s: failed to read data: %d\n",
1033 __func__, len);
1034 goto out;
1035 }
1036
1037 dev_dbg(&client->dev, "%s: packet %*ph\n",
1038 __func__, HEADER_SIZE, ts->buf);
1039
1040 switch (ts->state) {
1041 case ELAN_WAIT_RECALIBRATION:
1042 if (ts->buf[FW_HDR_TYPE] == CMD_HEADER_REK) {
1043 memcpy(ts->cmd_resp, ts->buf, sizeof(ts->cmd_resp));
1044 complete(&ts->cmd_done);
1045 ts->state = ELAN_STATE_NORMAL;
1046 }
1047 break;
1048
1049 case ELAN_WAIT_QUEUE_HEADER:
1050 if (ts->buf[FW_HDR_TYPE] != QUEUE_HEADER_NORMAL)
1051 break;
1052
1053 ts->state = ELAN_STATE_NORMAL;
1054 fallthrough;
1055
1056 case ELAN_STATE_NORMAL:
1057
1058 switch (ts->buf[FW_HDR_TYPE]) {
1059 case CMD_HEADER_HELLO:
1060 case CMD_HEADER_RESP:
1061 break;
1062
1063 case QUEUE_HEADER_WAIT:
1064 if (memcmp(ts->buf, wait_packet, sizeof(wait_packet))) {
1065 dev_err(&client->dev,
1066 "invalid wait packet %*ph\n",
1067 HEADER_SIZE, ts->buf);
1068 } else {
1069 ts->state = ELAN_WAIT_QUEUE_HEADER;
1070 udelay(30);
1071 }
1072 break;
1073
1074 case QUEUE_HEADER_SINGLE:
1075 elants_i2c_event(ts, &ts->buf[HEADER_SIZE],
1076 ts->buf[FW_HDR_LENGTH]);
1077 break;
1078
1079 case QUEUE_HEADER_NORMAL2: /* CMD_HEADER_REK */
1080 /*
1081 * Depending on firmware version, eKTF3624 touchscreens
1082 * may utilize one of these opcodes for the touch events:
1083 * 0x63 (NORMAL) and 0x66 (NORMAL2). The 0x63 is used by
1084 * older firmware version and differs from 0x66 such that
1085 * touch pressure value needs to be adjusted. The 0x66
1086 * opcode of newer firmware is equal to 0x63 of eKTH3500.
1087 */
1088 if (ts->chip_id != EKTF3624)
1089 break;
1090
1091 fallthrough;
1092
1093 case QUEUE_HEADER_NORMAL:
1094 report_count = ts->buf[FW_HDR_COUNT];
1095 if (report_count == 0 || report_count > 3) {
1096 dev_err(&client->dev,
1097 "bad report count: %*ph\n",
1098 HEADER_SIZE, ts->buf);
1099 break;
1100 }
1101
1102 report_len = ts->buf[FW_HDR_LENGTH] / report_count;
1103
1104 if (report_len == PACKET_SIZE_OLD &&
1105 ts->chip_id == EKTF3624) {
1106 dev_dbg_once(&client->dev,
1107 "using old report format\n");
1108 } else if (report_len != PACKET_SIZE) {
1109 dev_err(&client->dev,
1110 "mismatching report length: %*ph\n",
1111 HEADER_SIZE, ts->buf);
1112 break;
1113 }
1114
1115 for (i = 0; i < report_count; i++) {
1116 u8 *buf = ts->buf + HEADER_SIZE +
1117 i * report_len;
1118 elants_i2c_event(ts, buf, report_len);
1119 }
1120 break;
1121
1122 default:
1123 dev_err(&client->dev, "unknown packet %*ph\n",
1124 HEADER_SIZE, ts->buf);
1125 break;
1126 }
1127 break;
1128 }
1129
1130out:
1131 return IRQ_HANDLED;
1132}
1133
1134/*
1135 * sysfs interface
1136 */
1137static ssize_t calibrate_store(struct device *dev,
1138 struct device_attribute *attr,
1139 const char *buf, size_t count)
1140{
1141 struct i2c_client *client = to_i2c_client(dev);
1142 struct elants_data *ts = i2c_get_clientdata(client);
1143 int error;
1144
1145 error = mutex_lock_interruptible(&ts->sysfs_mutex);
1146 if (error)
1147 return error;
1148
1149 error = elants_i2c_calibrate(ts);
1150
1151 mutex_unlock(&ts->sysfs_mutex);
1152 return error ?: count;
1153}
1154
1155static ssize_t write_update_fw(struct device *dev,
1156 struct device_attribute *attr,
1157 const char *buf, size_t count)
1158{
1159 struct i2c_client *client = to_i2c_client(dev);
1160 struct elants_data *ts = i2c_get_clientdata(client);
1161 int error;
1162
1163 error = mutex_lock_interruptible(&ts->sysfs_mutex);
1164 if (error)
1165 return error;
1166
1167 error = elants_i2c_fw_update(ts);
1168 dev_dbg(dev, "firmware update result: %d\n", error);
1169
1170 mutex_unlock(&ts->sysfs_mutex);
1171 return error ?: count;
1172}
1173
1174static ssize_t show_iap_mode(struct device *dev,
1175 struct device_attribute *attr, char *buf)
1176{
1177 struct i2c_client *client = to_i2c_client(dev);
1178 struct elants_data *ts = i2c_get_clientdata(client);
1179
1180 return sprintf(buf, "%s\n",
1181 ts->iap_mode == ELAN_IAP_OPERATIONAL ?
1182 "Normal" : "Recovery");
1183}
1184
1185static ssize_t show_calibration_count(struct device *dev,
1186 struct device_attribute *attr, char *buf)
1187{
1188 struct i2c_client *client = to_i2c_client(dev);
1189 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_REK, 0x00, 0x01 };
1190 u8 resp[HEADER_SIZE];
1191 u16 rek_count;
1192 int error;
1193
1194 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
1195 resp, sizeof(resp), 1,
1196 "read ReK status");
1197 if (error)
1198 return sprintf(buf, "%d\n", error);
1199
1200 rek_count = get_unaligned_be16(&resp[2]);
1201 return sprintf(buf, "0x%04x\n", rek_count);
1202}
1203
1204static DEVICE_ATTR_WO(calibrate);
1205static DEVICE_ATTR(iap_mode, S_IRUGO, show_iap_mode, NULL);
1206static DEVICE_ATTR(calibration_count, S_IRUGO, show_calibration_count, NULL);
1207static DEVICE_ATTR(update_fw, S_IWUSR, NULL, write_update_fw);
1208
1209struct elants_version_attribute {
1210 struct device_attribute dattr;
1211 size_t field_offset;
1212 size_t field_size;
1213};
1214
1215#define __ELANTS_FIELD_SIZE(_field) \
1216 sizeof(((struct elants_data *)NULL)->_field)
1217#define __ELANTS_VERIFY_SIZE(_field) \
1218 (BUILD_BUG_ON_ZERO(__ELANTS_FIELD_SIZE(_field) > 2) + \
1219 __ELANTS_FIELD_SIZE(_field))
1220#define ELANTS_VERSION_ATTR(_field) \
1221 struct elants_version_attribute elants_ver_attr_##_field = { \
1222 .dattr = __ATTR(_field, S_IRUGO, \
1223 elants_version_attribute_show, NULL), \
1224 .field_offset = offsetof(struct elants_data, _field), \
1225 .field_size = __ELANTS_VERIFY_SIZE(_field), \
1226 }
1227
1228static ssize_t elants_version_attribute_show(struct device *dev,
1229 struct device_attribute *dattr,
1230 char *buf)
1231{
1232 struct i2c_client *client = to_i2c_client(dev);
1233 struct elants_data *ts = i2c_get_clientdata(client);
1234 struct elants_version_attribute *attr =
1235 container_of(dattr, struct elants_version_attribute, dattr);
1236 u8 *field = (u8 *)((char *)ts + attr->field_offset);
1237 unsigned int fmt_size;
1238 unsigned int val;
1239
1240 if (attr->field_size == 1) {
1241 val = *field;
1242 fmt_size = 2; /* 2 HEX digits */
1243 } else {
1244 val = *(u16 *)field;
1245 fmt_size = 4; /* 4 HEX digits */
1246 }
1247
1248 return sprintf(buf, "%0*x\n", fmt_size, val);
1249}
1250
1251static ELANTS_VERSION_ATTR(fw_version);
1252static ELANTS_VERSION_ATTR(hw_version);
1253static ELANTS_VERSION_ATTR(test_version);
1254static ELANTS_VERSION_ATTR(solution_version);
1255static ELANTS_VERSION_ATTR(bc_version);
1256static ELANTS_VERSION_ATTR(iap_version);
1257
1258static struct attribute *elants_attributes[] = {
1259 &dev_attr_calibrate.attr,
1260 &dev_attr_update_fw.attr,
1261 &dev_attr_iap_mode.attr,
1262 &dev_attr_calibration_count.attr,
1263
1264 &elants_ver_attr_fw_version.dattr.attr,
1265 &elants_ver_attr_hw_version.dattr.attr,
1266 &elants_ver_attr_test_version.dattr.attr,
1267 &elants_ver_attr_solution_version.dattr.attr,
1268 &elants_ver_attr_bc_version.dattr.attr,
1269 &elants_ver_attr_iap_version.dattr.attr,
1270 NULL
1271};
1272
1273static const struct attribute_group elants_attribute_group = {
1274 .attrs = elants_attributes,
1275};
1276
1277static int elants_i2c_power_on(struct elants_data *ts)
1278{
1279 int error;
1280
1281 /*
1282 * If we do not have reset gpio assume platform firmware
1283 * controls regulators and does power them on for us.
1284 */
1285 if (IS_ERR_OR_NULL(ts->reset_gpio))
1286 return 0;
1287
1288 gpiod_set_value_cansleep(ts->reset_gpio, 1);
1289
1290 error = regulator_enable(ts->vcc33);
1291 if (error) {
1292 dev_err(&ts->client->dev,
1293 "failed to enable vcc33 regulator: %d\n",
1294 error);
1295 goto release_reset_gpio;
1296 }
1297
1298 error = regulator_enable(ts->vccio);
1299 if (error) {
1300 dev_err(&ts->client->dev,
1301 "failed to enable vccio regulator: %d\n",
1302 error);
1303 regulator_disable(ts->vcc33);
1304 goto release_reset_gpio;
1305 }
1306
1307 /*
1308 * We need to wait a bit after powering on controller before
1309 * we are allowed to release reset GPIO.
1310 */
1311 udelay(ELAN_POWERON_DELAY_USEC);
1312
1313release_reset_gpio:
1314 gpiod_set_value_cansleep(ts->reset_gpio, 0);
1315 if (error)
1316 return error;
1317
1318 msleep(ELAN_RESET_DELAY_MSEC);
1319
1320 return 0;
1321}
1322
1323static void elants_i2c_power_off(void *_data)
1324{
1325 struct elants_data *ts = _data;
1326
1327 if (!IS_ERR_OR_NULL(ts->reset_gpio)) {
1328 /*
1329 * Activate reset gpio to prevent leakage through the
1330 * pin once we shut off power to the controller.
1331 */
1332 gpiod_set_value_cansleep(ts->reset_gpio, 1);
1333 regulator_disable(ts->vccio);
1334 regulator_disable(ts->vcc33);
1335 }
1336}
1337
1338#ifdef CONFIG_ACPI
1339static const struct acpi_device_id i2c_hid_ids[] = {
1340 {"ACPI0C50", 0 },
1341 {"PNP0C50", 0 },
1342 { },
1343};
1344
1345static const guid_t i2c_hid_guid =
1346 GUID_INIT(0x3CDFF6F7, 0x4267, 0x4555,
1347 0xAD, 0x05, 0xB3, 0x0A, 0x3D, 0x89, 0x38, 0xDE);
1348
1349static bool elants_acpi_is_hid_device(struct device *dev)
1350{
1351 acpi_handle handle = ACPI_HANDLE(dev);
1352 union acpi_object *obj;
1353
1354 if (acpi_match_device_ids(ACPI_COMPANION(dev), i2c_hid_ids))
1355 return false;
1356
1357 obj = acpi_evaluate_dsm_typed(handle, &i2c_hid_guid, 1, 1, NULL, ACPI_TYPE_INTEGER);
1358 if (obj) {
1359 ACPI_FREE(obj);
1360 return true;
1361 }
1362
1363 return false;
1364}
1365#else
1366static bool elants_acpi_is_hid_device(struct device *dev)
1367{
1368 return false;
1369}
1370#endif
1371
1372static int elants_i2c_probe(struct i2c_client *client)
1373{
1374 union i2c_smbus_data dummy;
1375 struct elants_data *ts;
1376 unsigned long irqflags;
1377 int error;
1378
1379 /* Don't bind to i2c-hid compatible devices, these are handled by the i2c-hid drv. */
1380 if (elants_acpi_is_hid_device(&client->dev)) {
1381 dev_warn(&client->dev, "This device appears to be an I2C-HID device, not binding\n");
1382 return -ENODEV;
1383 }
1384
1385 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
1386 dev_err(&client->dev, "I2C check functionality error\n");
1387 return -ENXIO;
1388 }
1389
1390 ts = devm_kzalloc(&client->dev, sizeof(struct elants_data), GFP_KERNEL);
1391 if (!ts)
1392 return -ENOMEM;
1393
1394 mutex_init(&ts->sysfs_mutex);
1395 init_completion(&ts->cmd_done);
1396
1397 ts->client = client;
1398 ts->chip_id = (enum elants_chip_id)(uintptr_t)device_get_match_data(&client->dev);
1399 i2c_set_clientdata(client, ts);
1400
1401 ts->vcc33 = devm_regulator_get(&client->dev, "vcc33");
1402 if (IS_ERR(ts->vcc33)) {
1403 error = PTR_ERR(ts->vcc33);
1404 if (error != -EPROBE_DEFER)
1405 dev_err(&client->dev,
1406 "Failed to get 'vcc33' regulator: %d\n",
1407 error);
1408 return error;
1409 }
1410
1411 ts->vccio = devm_regulator_get(&client->dev, "vccio");
1412 if (IS_ERR(ts->vccio)) {
1413 error = PTR_ERR(ts->vccio);
1414 if (error != -EPROBE_DEFER)
1415 dev_err(&client->dev,
1416 "Failed to get 'vccio' regulator: %d\n",
1417 error);
1418 return error;
1419 }
1420
1421 ts->reset_gpio = devm_gpiod_get(&client->dev, "reset", GPIOD_OUT_LOW);
1422 if (IS_ERR(ts->reset_gpio)) {
1423 error = PTR_ERR(ts->reset_gpio);
1424
1425 if (error == -EPROBE_DEFER)
1426 return error;
1427
1428 if (error != -ENOENT && error != -ENOSYS) {
1429 dev_err(&client->dev,
1430 "failed to get reset gpio: %d\n",
1431 error);
1432 return error;
1433 }
1434
1435 ts->keep_power_in_suspend = true;
1436 }
1437
1438 error = elants_i2c_power_on(ts);
1439 if (error)
1440 return error;
1441
1442 error = devm_add_action(&client->dev, elants_i2c_power_off, ts);
1443 if (error) {
1444 dev_err(&client->dev,
1445 "failed to install power off action: %d\n", error);
1446 elants_i2c_power_off(ts);
1447 return error;
1448 }
1449
1450 /* Make sure there is something at this address */
1451 if (i2c_smbus_xfer(client->adapter, client->addr, 0,
1452 I2C_SMBUS_READ, 0, I2C_SMBUS_BYTE, &dummy) < 0) {
1453 dev_err(&client->dev, "nothing at this address\n");
1454 return -ENXIO;
1455 }
1456
1457 error = elants_i2c_initialize(ts);
1458 if (error) {
1459 dev_err(&client->dev, "failed to initialize: %d\n", error);
1460 return error;
1461 }
1462
1463 ts->input = devm_input_allocate_device(&client->dev);
1464 if (!ts->input) {
1465 dev_err(&client->dev, "Failed to allocate input device\n");
1466 return -ENOMEM;
1467 }
1468
1469 ts->input->name = "Elan Touchscreen";
1470 ts->input->id.bustype = BUS_I2C;
1471
1472 /* Multitouch input params setup */
1473
1474 input_set_abs_params(ts->input, ABS_MT_POSITION_X, 0, ts->x_max, 0, 0);
1475 input_set_abs_params(ts->input, ABS_MT_POSITION_Y, 0, ts->y_max, 0, 0);
1476 input_set_abs_params(ts->input, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0);
1477 input_set_abs_params(ts->input, ABS_MT_PRESSURE, 0, 255, 0, 0);
1478 input_set_abs_params(ts->input, ABS_MT_TOOL_TYPE,
1479 0, MT_TOOL_PALM, 0, 0);
1480
1481 touchscreen_parse_properties(ts->input, true, &ts->prop);
1482
1483 if (ts->chip_id == EKTF3624 && ts->phy_x && ts->phy_y) {
1484 /* calculate resolution from size */
1485 ts->x_res = DIV_ROUND_CLOSEST(ts->prop.max_x, ts->phy_x);
1486 ts->y_res = DIV_ROUND_CLOSEST(ts->prop.max_y, ts->phy_y);
1487 }
1488
1489 input_abs_set_res(ts->input, ABS_MT_POSITION_X, ts->x_res);
1490 input_abs_set_res(ts->input, ABS_MT_POSITION_Y, ts->y_res);
1491 input_abs_set_res(ts->input, ABS_MT_TOUCH_MAJOR, ts->major_res);
1492
1493 error = input_mt_init_slots(ts->input, MAX_CONTACT_NUM,
1494 INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED);
1495 if (error) {
1496 dev_err(&client->dev,
1497 "failed to initialize MT slots: %d\n", error);
1498 return error;
1499 }
1500
1501 error = input_register_device(ts->input);
1502 if (error) {
1503 dev_err(&client->dev,
1504 "unable to register input device: %d\n", error);
1505 return error;
1506 }
1507
1508 /*
1509 * Platform code (ACPI, DTS) should normally set up interrupt
1510 * for us, but in case it did not let's fall back to using falling
1511 * edge to be compatible with older Chromebooks.
1512 */
1513 irqflags = irq_get_trigger_type(client->irq);
1514 if (!irqflags)
1515 irqflags = IRQF_TRIGGER_FALLING;
1516
1517 error = devm_request_threaded_irq(&client->dev, client->irq,
1518 NULL, elants_i2c_irq,
1519 irqflags | IRQF_ONESHOT,
1520 client->name, ts);
1521 if (error) {
1522 dev_err(&client->dev, "Failed to register interrupt\n");
1523 return error;
1524 }
1525
1526 /*
1527 * Systems using device tree should set up wakeup via DTS,
1528 * the rest will configure device as wakeup source by default.
1529 */
1530 if (!client->dev.of_node)
1531 device_init_wakeup(&client->dev, true);
1532
1533 error = devm_device_add_group(&client->dev, &elants_attribute_group);
1534 if (error) {
1535 dev_err(&client->dev, "failed to create sysfs attributes: %d\n",
1536 error);
1537 return error;
1538 }
1539
1540 return 0;
1541}
1542
1543static int __maybe_unused elants_i2c_suspend(struct device *dev)
1544{
1545 struct i2c_client *client = to_i2c_client(dev);
1546 struct elants_data *ts = i2c_get_clientdata(client);
1547 const u8 set_sleep_cmd[] = {
1548 CMD_HEADER_WRITE, E_POWER_STATE_SLEEP, 0x00, 0x01
1549 };
1550 int retry_cnt;
1551 int error;
1552
1553 /* Command not support in IAP recovery mode */
1554 if (ts->iap_mode != ELAN_IAP_OPERATIONAL)
1555 return -EBUSY;
1556
1557 disable_irq(client->irq);
1558
1559 if (device_may_wakeup(dev)) {
1560 /*
1561 * The device will automatically enter idle mode
1562 * that has reduced power consumption.
1563 */
1564 ts->wake_irq_enabled = (enable_irq_wake(client->irq) == 0);
1565 } else if (ts->keep_power_in_suspend) {
1566 for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
1567 error = elants_i2c_send(client, set_sleep_cmd,
1568 sizeof(set_sleep_cmd));
1569 if (!error)
1570 break;
1571
1572 dev_err(&client->dev,
1573 "suspend command failed: %d\n", error);
1574 }
1575 } else {
1576 elants_i2c_power_off(ts);
1577 }
1578
1579 return 0;
1580}
1581
1582static int __maybe_unused elants_i2c_resume(struct device *dev)
1583{
1584 struct i2c_client *client = to_i2c_client(dev);
1585 struct elants_data *ts = i2c_get_clientdata(client);
1586 const u8 set_active_cmd[] = {
1587 CMD_HEADER_WRITE, E_POWER_STATE_RESUME, 0x00, 0x01
1588 };
1589 int retry_cnt;
1590 int error;
1591
1592 if (device_may_wakeup(dev)) {
1593 if (ts->wake_irq_enabled)
1594 disable_irq_wake(client->irq);
1595 elants_i2c_sw_reset(client);
1596 } else if (ts->keep_power_in_suspend) {
1597 for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
1598 error = elants_i2c_send(client, set_active_cmd,
1599 sizeof(set_active_cmd));
1600 if (!error)
1601 break;
1602
1603 dev_err(&client->dev,
1604 "resume command failed: %d\n", error);
1605 }
1606 } else {
1607 elants_i2c_power_on(ts);
1608 elants_i2c_initialize(ts);
1609 }
1610
1611 ts->state = ELAN_STATE_NORMAL;
1612 enable_irq(client->irq);
1613
1614 return 0;
1615}
1616
1617static SIMPLE_DEV_PM_OPS(elants_i2c_pm_ops,
1618 elants_i2c_suspend, elants_i2c_resume);
1619
1620static const struct i2c_device_id elants_i2c_id[] = {
1621 { DEVICE_NAME, EKTH3500 },
1622 { "ekth3500", EKTH3500 },
1623 { "ektf3624", EKTF3624 },
1624 { }
1625};
1626MODULE_DEVICE_TABLE(i2c, elants_i2c_id);
1627
1628#ifdef CONFIG_ACPI
1629static const struct acpi_device_id elants_acpi_id[] = {
1630 { "ELAN0001", EKTH3500 },
1631 { }
1632};
1633MODULE_DEVICE_TABLE(acpi, elants_acpi_id);
1634#endif
1635
1636#ifdef CONFIG_OF
1637static const struct of_device_id elants_of_match[] = {
1638 { .compatible = "elan,ekth3500", .data = (void *)EKTH3500 },
1639 { .compatible = "elan,ektf3624", .data = (void *)EKTF3624 },
1640 { /* sentinel */ }
1641};
1642MODULE_DEVICE_TABLE(of, elants_of_match);
1643#endif
1644
1645static struct i2c_driver elants_i2c_driver = {
1646 .probe_new = elants_i2c_probe,
1647 .id_table = elants_i2c_id,
1648 .driver = {
1649 .name = DEVICE_NAME,
1650 .pm = &elants_i2c_pm_ops,
1651 .acpi_match_table = ACPI_PTR(elants_acpi_id),
1652 .of_match_table = of_match_ptr(elants_of_match),
1653 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1654 },
1655};
1656module_i2c_driver(elants_i2c_driver);
1657
1658MODULE_AUTHOR("Scott Liu <scott.liu@emc.com.tw>");
1659MODULE_DESCRIPTION("Elan I2c Touchscreen driver");
1660MODULE_LICENSE("GPL");