2 * Elan Microelectronics touch panels with I2C interface
4 * Copyright (C) 2014 Elan Microelectronics Corporation.
5 * Scott Liu <scott.liu@emc.com.tw>
7 * This code is partly based on hid-multitouch.c:
9 * Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
10 * Copyright (c) 2010-2012 Benjamin Tissoires <benjamin.tissoires@gmail.com>
11 * Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
14 * This code is partly based on i2c-hid.c:
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
22 * This software is licensed under the terms of the GNU General Public
23 * License version 2, as published by the Free Software Foundation, and
24 * may be copied, distributed, and modified under those terms.
27 #include <linux/module.h>
28 #include <linux/input.h>
29 #include <linux/interrupt.h>
30 #include <linux/platform_device.h>
31 #include <linux/async.h>
32 #include <linux/i2c.h>
33 #include <linux/delay.h>
34 #include <linux/uaccess.h>
35 #include <linux/buffer_head.h>
36 #include <linux/slab.h>
37 #include <linux/firmware.h>
38 #include <linux/input/mt.h>
39 #include <linux/acpi.h>
41 #include <asm/unaligned.h>
43 /* Device, Driver information */
44 #define DEVICE_NAME "elants_i2c"
45 #define DRV_VERSION "1.0.9"
47 /* Convert from rows or columns into resolution */
48 #define ELAN_TS_RESOLUTION(n, m) (((n) - 1) * (m))
53 #define FW_HDR_COUNT 1
54 #define FW_HDR_LENGTH 2
56 /* Buffer mode Queue Header information */
57 #define QUEUE_HEADER_SINGLE 0x62
58 #define QUEUE_HEADER_NORMAL 0X63
59 #define QUEUE_HEADER_WAIT 0x64
61 /* Command header definition */
62 #define CMD_HEADER_WRITE 0x54
63 #define CMD_HEADER_READ 0x53
64 #define CMD_HEADER_6B_READ 0x5B
65 #define CMD_HEADER_RESP 0x52
66 #define CMD_HEADER_6B_RESP 0x9B
67 #define CMD_HEADER_HELLO 0x55
68 #define CMD_HEADER_REK 0x66
70 /* FW position data */
71 #define PACKET_SIZE 55
72 #define MAX_CONTACT_NUM 10
73 #define FW_POS_HEADER 0
74 #define FW_POS_STATE 1
75 #define FW_POS_TOTAL 2
77 #define FW_POS_CHECKSUM 34
78 #define FW_POS_WIDTH 35
79 #define FW_POS_PRESSURE 45
81 #define HEADER_REPORT_10_FINGER 0x62
83 /* Header (4 bytes) plus 3 fill 10-finger packets */
84 #define MAX_PACKET_SIZE 169
86 #define BOOT_TIME_DELAY_MS 50
88 /* FW read command, 0x53 0x?? 0x0, 0x01 */
89 #define E_ELAN_INFO_FW_VER 0x00
90 #define E_ELAN_INFO_BC_VER 0x10
91 #define E_ELAN_INFO_TEST_VER 0xE0
92 #define E_ELAN_INFO_FW_ID 0xF0
93 #define E_INFO_OSR 0xD6
94 #define E_INFO_PHY_SCAN 0xD7
95 #define E_INFO_PHY_DRIVER 0xD8
98 #define MAX_FW_UPDATE_RETRIES 30
100 #define ELAN_FW_PAGESIZE 132
102 /* calibration timeout definition */
103 #define ELAN_CALI_TIMEOUT_MSEC 10000
107 ELAN_WAIT_QUEUE_HEADER,
108 ELAN_WAIT_RECALIBRATION,
111 enum elants_iap_mode {
112 ELAN_IAP_OPERATIONAL,
116 /* struct elants_data - represents state of Elan touchscreen device */
118 struct i2c_client *client;
119 struct input_dev *input;
127 unsigned int x_res; /* resolution in units/mm */
132 enum elants_state state;
133 enum elants_iap_mode iap_mode;
135 /* Guards against concurrent access to the device via sysfs */
136 struct mutex sysfs_mutex;
138 u8 cmd_resp[HEADER_SIZE];
139 struct completion cmd_done;
141 u8 buf[MAX_PACKET_SIZE];
143 bool wake_irq_enabled;
146 static int elants_i2c_send(struct i2c_client *client,
147 const void *data, size_t size)
151 ret = i2c_master_send(client, data, size);
158 dev_err(&client->dev, "%s failed (%*ph): %d\n",
159 __func__, (int)size, data, ret);
164 static int elants_i2c_read(struct i2c_client *client, void *data, size_t size)
168 ret = i2c_master_recv(client, data, size);
175 dev_err(&client->dev, "%s failed: %d\n", __func__, ret);
180 static int elants_i2c_execute_command(struct i2c_client *client,
181 const u8 *cmd, size_t cmd_size,
182 u8 *resp, size_t resp_size)
184 struct i2c_msg msgs[2];
186 u8 expected_response;
189 case CMD_HEADER_READ:
190 expected_response = CMD_HEADER_RESP;
193 case CMD_HEADER_6B_READ:
194 expected_response = CMD_HEADER_6B_RESP;
198 dev_err(&client->dev, "%s: invalid command %*ph\n",
199 __func__, (int)cmd_size, cmd);
203 msgs[0].addr = client->addr;
204 msgs[0].flags = client->flags & I2C_M_TEN;
205 msgs[0].len = cmd_size;
206 msgs[0].buf = (u8 *)cmd;
208 msgs[1].addr = client->addr;
209 msgs[1].flags = client->flags & I2C_M_TEN;
210 msgs[1].flags |= I2C_M_RD;
211 msgs[1].len = resp_size;
214 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
218 if (ret != ARRAY_SIZE(msgs) || resp[FW_HDR_TYPE] != expected_response)
224 static int elants_i2c_calibrate(struct elants_data *ts)
226 struct i2c_client *client = ts->client;
228 static const u8 w_flashkey[] = { 0x54, 0xC0, 0xE1, 0x5A };
229 static const u8 rek[] = { 0x54, 0x29, 0x00, 0x01 };
230 static const u8 rek_resp[] = { CMD_HEADER_REK, 0x66, 0x66, 0x66 };
232 disable_irq(client->irq);
234 ts->state = ELAN_WAIT_RECALIBRATION;
235 reinit_completion(&ts->cmd_done);
237 elants_i2c_send(client, w_flashkey, sizeof(w_flashkey));
238 elants_i2c_send(client, rek, sizeof(rek));
240 enable_irq(client->irq);
242 ret = wait_for_completion_interruptible_timeout(&ts->cmd_done,
243 msecs_to_jiffies(ELAN_CALI_TIMEOUT_MSEC));
245 ts->state = ELAN_STATE_NORMAL;
248 error = ret < 0 ? ret : -ETIMEDOUT;
249 dev_err(&client->dev,
250 "error while waiting for calibration to complete: %d\n",
255 if (memcmp(rek_resp, ts->cmd_resp, sizeof(rek_resp))) {
256 dev_err(&client->dev,
257 "unexpected calibration response: %*ph\n",
258 (int)sizeof(ts->cmd_resp), ts->cmd_resp);
265 static int elants_i2c_sw_reset(struct i2c_client *client)
267 const u8 soft_rst_cmd[] = { 0x77, 0x77, 0x77, 0x77 };
270 error = elants_i2c_send(client, soft_rst_cmd,
271 sizeof(soft_rst_cmd));
273 dev_err(&client->dev, "software reset failed: %d\n", error);
278 * We should wait at least 10 msec (but no more than 40) before
279 * sending fastboot or IAP command to the device.
286 static u16 elants_i2c_parse_version(u8 *buf)
288 return get_unaligned_be32(buf) >> 4;
291 static int elants_i2c_query_fw_id(struct elants_data *ts)
293 struct i2c_client *client = ts->client;
294 int error, retry_cnt;
295 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_FW_ID, 0x00, 0x01 };
296 u8 resp[HEADER_SIZE];
298 for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
299 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
302 ts->hw_version = elants_i2c_parse_version(resp);
303 if (ts->hw_version != 0xffff)
307 dev_dbg(&client->dev, "read fw id error=%d, buf=%*phC\n",
308 error, (int)sizeof(resp), resp);
311 dev_err(&client->dev,
312 "Failed to read fw id or fw id is invalid\n");
317 static int elants_i2c_query_fw_version(struct elants_data *ts)
319 struct i2c_client *client = ts->client;
320 int error, retry_cnt;
321 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_FW_VER, 0x00, 0x01 };
322 u8 resp[HEADER_SIZE];
324 for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
325 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
328 ts->fw_version = elants_i2c_parse_version(resp);
329 if (ts->fw_version != 0x0000 &&
330 ts->fw_version != 0xffff)
334 dev_dbg(&client->dev, "read fw version error=%d, buf=%*phC\n",
335 error, (int)sizeof(resp), resp);
338 dev_err(&client->dev,
339 "Failed to read fw version or fw version is invalid\n");
344 static int elants_i2c_query_test_version(struct elants_data *ts)
346 struct i2c_client *client = ts->client;
347 int error, retry_cnt;
349 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_TEST_VER, 0x00, 0x01 };
350 u8 resp[HEADER_SIZE];
352 for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
353 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
356 version = elants_i2c_parse_version(resp);
357 ts->test_version = version >> 8;
358 ts->solution_version = version & 0xff;
363 dev_dbg(&client->dev,
364 "read test version error rc=%d, buf=%*phC\n",
365 error, (int)sizeof(resp), resp);
368 dev_err(&client->dev, "Failed to read test version\n");
373 static int elants_i2c_query_bc_version(struct elants_data *ts)
375 struct i2c_client *client = ts->client;
376 const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_BC_VER, 0x00, 0x01 };
377 u8 resp[HEADER_SIZE];
381 error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
384 dev_err(&client->dev,
385 "read BC version error=%d, buf=%*phC\n",
386 error, (int)sizeof(resp), resp);
390 version = elants_i2c_parse_version(resp);
391 ts->bc_version = version >> 8;
392 ts->iap_version = version & 0xff;
397 static int elants_i2c_query_ts_info(struct elants_data *ts)
399 struct i2c_client *client = ts->client;
402 u16 phy_x, phy_y, rows, cols, osr;
403 const u8 get_resolution_cmd[] = {
404 CMD_HEADER_6B_READ, 0x00, 0x00, 0x00, 0x00, 0x00
406 const u8 get_osr_cmd[] = {
407 CMD_HEADER_READ, E_INFO_OSR, 0x00, 0x01
409 const u8 get_physical_scan_cmd[] = {
410 CMD_HEADER_READ, E_INFO_PHY_SCAN, 0x00, 0x01
412 const u8 get_physical_drive_cmd[] = {
413 CMD_HEADER_READ, E_INFO_PHY_DRIVER, 0x00, 0x01
416 /* Get trace number */
417 error = elants_i2c_execute_command(client,
419 sizeof(get_resolution_cmd),
422 dev_err(&client->dev, "get resolution command failed: %d\n",
427 rows = resp[2] + resp[6] + resp[10];
428 cols = resp[3] + resp[7] + resp[11];
430 /* Process mm_to_pixel information */
431 error = elants_i2c_execute_command(client,
432 get_osr_cmd, sizeof(get_osr_cmd),
435 dev_err(&client->dev, "get osr command failed: %d\n",
442 error = elants_i2c_execute_command(client,
443 get_physical_scan_cmd,
444 sizeof(get_physical_scan_cmd),
447 dev_err(&client->dev, "get physical scan command failed: %d\n",
452 phy_x = get_unaligned_be16(&resp[2]);
454 error = elants_i2c_execute_command(client,
455 get_physical_drive_cmd,
456 sizeof(get_physical_drive_cmd),
459 dev_err(&client->dev, "get physical drive command failed: %d\n",
464 phy_y = get_unaligned_be16(&resp[2]);
466 dev_dbg(&client->dev, "phy_x=%d, phy_y=%d\n", phy_x, phy_y);
468 if (rows == 0 || cols == 0 || osr == 0) {
469 dev_warn(&client->dev,
470 "invalid trace number data: %d, %d, %d\n",
473 /* translate trace number to TS resolution */
474 ts->x_max = ELAN_TS_RESOLUTION(rows, osr);
475 ts->x_res = DIV_ROUND_CLOSEST(ts->x_max, phy_x);
476 ts->y_max = ELAN_TS_RESOLUTION(cols, osr);
477 ts->y_res = DIV_ROUND_CLOSEST(ts->y_max, phy_y);
483 static int elants_i2c_fastboot(struct i2c_client *client)
485 const u8 boot_cmd[] = { 0x4D, 0x61, 0x69, 0x6E };
488 error = elants_i2c_send(client, boot_cmd, sizeof(boot_cmd));
490 dev_err(&client->dev, "boot failed: %d\n", error);
494 dev_dbg(&client->dev, "boot success -- 0x%x\n", client->addr);
498 static int elants_i2c_initialize(struct elants_data *ts)
500 struct i2c_client *client = ts->client;
501 int error, retry_cnt;
502 const u8 hello_packet[] = { 0x55, 0x55, 0x55, 0x55 };
503 const u8 recov_packet[] = { 0x55, 0x55, 0x80, 0x80 };
506 for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
507 error = elants_i2c_sw_reset(client);
509 /* Continue initializing if it's the last try */
510 if (retry_cnt < MAX_RETRIES - 1)
514 error = elants_i2c_fastboot(client);
516 /* Continue initializing if it's the last try */
517 if (retry_cnt < MAX_RETRIES - 1)
521 /* Wait for Hello packet */
522 msleep(BOOT_TIME_DELAY_MS);
524 error = elants_i2c_read(client, buf, sizeof(buf));
526 dev_err(&client->dev,
527 "failed to read 'hello' packet: %d\n", error);
528 } else if (!memcmp(buf, hello_packet, sizeof(hello_packet))) {
529 ts->iap_mode = ELAN_IAP_OPERATIONAL;
531 } else if (!memcmp(buf, recov_packet, sizeof(recov_packet))) {
533 * Setting error code will mark device
534 * in recovery mode below.
540 dev_err(&client->dev,
541 "invalid 'hello' packet: %*ph\n",
542 (int)sizeof(buf), buf);
547 error = elants_i2c_query_fw_id(ts);
549 error = elants_i2c_query_fw_version(ts);
552 ts->iap_mode = ELAN_IAP_RECOVERY;
554 elants_i2c_query_test_version(ts);
555 elants_i2c_query_bc_version(ts);
556 elants_i2c_query_ts_info(ts);
563 * Firmware update interface.
566 static int elants_i2c_fw_write_page(struct i2c_client *client,
569 const u8 ack_ok[] = { 0xaa, 0xaa };
574 for (retry = 0; retry < MAX_FW_UPDATE_RETRIES; retry++) {
575 error = elants_i2c_send(client, page, ELAN_FW_PAGESIZE);
577 dev_err(&client->dev,
578 "IAP Write Page failed: %d\n", error);
582 error = elants_i2c_read(client, buf, 2);
584 dev_err(&client->dev,
585 "IAP Ack read failed: %d\n", error);
589 if (!memcmp(buf, ack_ok, sizeof(ack_ok)))
593 dev_err(&client->dev,
594 "IAP Get Ack Error [%02x:%02x]\n",
601 static int elants_i2c_do_update_firmware(struct i2c_client *client,
602 const struct firmware *fw,
605 const u8 enter_iap[] = { 0x45, 0x49, 0x41, 0x50 };
606 const u8 enter_iap2[] = { 0x54, 0x00, 0x12, 0x34 };
607 const u8 iap_ack[] = { 0x55, 0xaa, 0x33, 0xcc };
608 const u8 close_idle[] = {0x54, 0x2c, 0x01, 0x01};
611 int page, n_fw_pages;
614 /* Recovery mode detection! */
616 dev_dbg(&client->dev, "Recovery mode procedure\n");
617 error = elants_i2c_send(client, enter_iap2, sizeof(enter_iap2));
619 /* Start IAP Procedure */
620 dev_dbg(&client->dev, "Normal IAP procedure\n");
621 /* Close idle mode */
622 error = elants_i2c_send(client, close_idle, sizeof(close_idle));
624 dev_err(&client->dev, "Failed close idle: %d\n", error);
626 elants_i2c_sw_reset(client);
628 error = elants_i2c_send(client, enter_iap, sizeof(enter_iap));
632 dev_err(&client->dev, "failed to enter IAP mode: %d\n", error);
638 /* check IAP state */
639 error = elants_i2c_read(client, buf, 4);
641 dev_err(&client->dev,
642 "failed to read IAP acknowledgement: %d\n",
647 if (memcmp(buf, iap_ack, sizeof(iap_ack))) {
648 dev_err(&client->dev,
649 "failed to enter IAP: %*ph (expected %*ph)\n",
650 (int)sizeof(buf), buf, (int)sizeof(iap_ack), iap_ack);
654 dev_info(&client->dev, "successfully entered IAP mode");
656 send_id = client->addr;
657 error = elants_i2c_send(client, &send_id, 1);
659 dev_err(&client->dev, "sending dummy byte failed: %d\n",
664 /* Clear the last page of Master */
665 error = elants_i2c_send(client, fw->data, ELAN_FW_PAGESIZE);
667 dev_err(&client->dev, "clearing of the last page failed: %d\n",
672 error = elants_i2c_read(client, buf, 2);
674 dev_err(&client->dev,
675 "failed to read ACK for clearing the last page: %d\n",
680 n_fw_pages = fw->size / ELAN_FW_PAGESIZE;
681 dev_dbg(&client->dev, "IAP Pages = %d\n", n_fw_pages);
683 for (page = 0; page < n_fw_pages; page++) {
684 error = elants_i2c_fw_write_page(client,
685 fw->data + page * ELAN_FW_PAGESIZE);
687 dev_err(&client->dev,
688 "failed to write FW page %d: %d\n",
694 /* Old iap needs to wait 200ms for WDT and rest is for hello packets */
697 dev_info(&client->dev, "firmware update completed\n");
701 static int elants_i2c_fw_update(struct elants_data *ts)
703 struct i2c_client *client = ts->client;
704 const struct firmware *fw;
708 fw_name = kasprintf(GFP_KERNEL, "elants_i2c_%04x.bin", ts->hw_version);
712 dev_info(&client->dev, "requesting fw name = %s\n", fw_name);
713 error = request_firmware(&fw, fw_name, &client->dev);
716 dev_err(&client->dev, "failed to request firmware: %d\n",
721 if (fw->size % ELAN_FW_PAGESIZE) {
722 dev_err(&client->dev, "invalid firmware length: %zu\n",
728 disable_irq(client->irq);
730 error = elants_i2c_do_update_firmware(client, fw,
731 ts->iap_mode == ELAN_IAP_RECOVERY);
733 dev_err(&client->dev, "firmware update failed: %d\n", error);
734 ts->iap_mode = ELAN_IAP_RECOVERY;
738 error = elants_i2c_initialize(ts);
740 dev_err(&client->dev,
741 "failed to initialize device after firmware update: %d\n",
743 ts->iap_mode = ELAN_IAP_RECOVERY;
747 ts->iap_mode = ELAN_IAP_OPERATIONAL;
750 ts->state = ELAN_STATE_NORMAL;
751 enable_irq(client->irq);
755 elants_i2c_calibrate(ts);
757 release_firmware(fw);
765 static void elants_i2c_mt_event(struct elants_data *ts, u8 *buf)
767 struct input_dev *input = ts->input;
768 unsigned int n_fingers;
772 n_fingers = buf[FW_POS_STATE + 1] & 0x0f;
773 finger_state = ((buf[FW_POS_STATE + 1] & 0x30) << 4) |
776 dev_dbg(&ts->client->dev,
777 "n_fingers: %u, state: %04x\n", n_fingers, finger_state);
779 for (i = 0; i < MAX_CONTACT_NUM && n_fingers; i++) {
780 if (finger_state & 1) {
781 unsigned int x, y, p, w;
784 pos = &buf[FW_POS_XY + i * 3];
785 x = (((u16)pos[0] & 0xf0) << 4) | pos[1];
786 y = (((u16)pos[0] & 0x0f) << 8) | pos[2];
787 p = buf[FW_POS_PRESSURE + i];
788 w = buf[FW_POS_WIDTH + i];
790 dev_dbg(&ts->client->dev, "i=%d x=%d y=%d p=%d w=%d\n",
793 input_mt_slot(input, i);
794 input_mt_report_slot_state(input, MT_TOOL_FINGER, true);
795 input_event(input, EV_ABS, ABS_MT_POSITION_X, x);
796 input_event(input, EV_ABS, ABS_MT_POSITION_Y, y);
797 input_event(input, EV_ABS, ABS_MT_PRESSURE, p);
798 input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, w);
806 input_mt_sync_frame(input);
810 static u8 elants_i2c_calculate_checksum(u8 *buf)
815 for (i = 0; i < FW_POS_CHECKSUM; i++)
821 static void elants_i2c_event(struct elants_data *ts, u8 *buf)
823 u8 checksum = elants_i2c_calculate_checksum(buf);
825 if (unlikely(buf[FW_POS_CHECKSUM] != checksum))
826 dev_warn(&ts->client->dev,
827 "%s: invalid checksum for packet %02x: %02x vs. %02x\n",
828 __func__, buf[FW_POS_HEADER],
829 checksum, buf[FW_POS_CHECKSUM]);
830 else if (unlikely(buf[FW_POS_HEADER] != HEADER_REPORT_10_FINGER))
831 dev_warn(&ts->client->dev,
832 "%s: unknown packet type: %02x\n",
833 __func__, buf[FW_POS_HEADER]);
835 elants_i2c_mt_event(ts, buf);
838 static irqreturn_t elants_i2c_irq(int irq, void *_dev)
840 const u8 wait_packet[] = { 0x64, 0x64, 0x64, 0x64 };
841 struct elants_data *ts = _dev;
842 struct i2c_client *client = ts->client;
843 int report_count, report_len;
847 len = i2c_master_recv(client, ts->buf, sizeof(ts->buf));
849 dev_err(&client->dev, "%s: failed to read data: %d\n",
854 dev_dbg(&client->dev, "%s: packet %*ph\n",
855 __func__, HEADER_SIZE, ts->buf);
858 case ELAN_WAIT_RECALIBRATION:
859 if (ts->buf[FW_HDR_TYPE] == CMD_HEADER_REK) {
860 memcpy(ts->cmd_resp, ts->buf, sizeof(ts->cmd_resp));
861 complete(&ts->cmd_done);
862 ts->state = ELAN_STATE_NORMAL;
866 case ELAN_WAIT_QUEUE_HEADER:
867 if (ts->buf[FW_HDR_TYPE] != QUEUE_HEADER_NORMAL)
870 ts->state = ELAN_STATE_NORMAL;
873 case ELAN_STATE_NORMAL:
875 switch (ts->buf[FW_HDR_TYPE]) {
876 case CMD_HEADER_HELLO:
877 case CMD_HEADER_RESP:
881 case QUEUE_HEADER_WAIT:
882 if (memcmp(ts->buf, wait_packet, sizeof(wait_packet))) {
883 dev_err(&client->dev,
884 "invalid wait packet %*ph\n",
885 HEADER_SIZE, ts->buf);
887 ts->state = ELAN_WAIT_QUEUE_HEADER;
892 case QUEUE_HEADER_SINGLE:
893 elants_i2c_event(ts, &ts->buf[HEADER_SIZE]);
896 case QUEUE_HEADER_NORMAL:
897 report_count = ts->buf[FW_HDR_COUNT];
898 if (report_count > 3) {
899 dev_err(&client->dev,
900 "too large report count: %*ph\n",
901 HEADER_SIZE, ts->buf);
905 report_len = ts->buf[FW_HDR_LENGTH] / report_count;
906 if (report_len != PACKET_SIZE) {
907 dev_err(&client->dev,
908 "mismatching report length: %*ph\n",
909 HEADER_SIZE, ts->buf);
913 for (i = 0; i < report_count; i++) {
914 u8 *buf = ts->buf + HEADER_SIZE +
916 elants_i2c_event(ts, buf);
921 dev_err(&client->dev, "unknown packet %*ph\n",
922 HEADER_SIZE, ts->buf);
935 static ssize_t calibrate_store(struct device *dev,
936 struct device_attribute *attr,
937 const char *buf, size_t count)
939 struct i2c_client *client = to_i2c_client(dev);
940 struct elants_data *ts = i2c_get_clientdata(client);
943 error = mutex_lock_interruptible(&ts->sysfs_mutex);
947 error = elants_i2c_calibrate(ts);
949 mutex_unlock(&ts->sysfs_mutex);
950 return error ?: count;
953 static ssize_t write_update_fw(struct device *dev,
954 struct device_attribute *attr,
955 const char *buf, size_t count)
957 struct i2c_client *client = to_i2c_client(dev);
958 struct elants_data *ts = i2c_get_clientdata(client);
961 error = mutex_lock_interruptible(&ts->sysfs_mutex);
965 error = elants_i2c_fw_update(ts);
966 dev_dbg(dev, "firmware update result: %d\n", error);
968 mutex_unlock(&ts->sysfs_mutex);
969 return error ?: count;
972 static ssize_t show_iap_mode(struct device *dev,
973 struct device_attribute *attr, char *buf)
975 struct i2c_client *client = to_i2c_client(dev);
976 struct elants_data *ts = i2c_get_clientdata(client);
978 return sprintf(buf, "%s\n",
979 ts->iap_mode == ELAN_IAP_OPERATIONAL ?
980 "Normal" : "Recovery");
983 static DEVICE_ATTR(calibrate, S_IWUSR, NULL, calibrate_store);
984 static DEVICE_ATTR(iap_mode, S_IRUGO, show_iap_mode, NULL);
985 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, write_update_fw);
987 struct elants_version_attribute {
988 struct device_attribute dattr;
993 #define __ELANTS_FIELD_SIZE(_field) \
994 sizeof(((struct elants_data *)NULL)->_field)
995 #define __ELANTS_VERIFY_SIZE(_field) \
996 (BUILD_BUG_ON_ZERO(__ELANTS_FIELD_SIZE(_field) > 2) + \
997 __ELANTS_FIELD_SIZE(_field))
998 #define ELANTS_VERSION_ATTR(_field) \
999 struct elants_version_attribute elants_ver_attr_##_field = { \
1000 .dattr = __ATTR(_field, S_IRUGO, \
1001 elants_version_attribute_show, NULL), \
1002 .field_offset = offsetof(struct elants_data, _field), \
1003 .field_size = __ELANTS_VERIFY_SIZE(_field), \
1006 static ssize_t elants_version_attribute_show(struct device *dev,
1007 struct device_attribute *dattr,
1010 struct i2c_client *client = to_i2c_client(dev);
1011 struct elants_data *ts = i2c_get_clientdata(client);
1012 struct elants_version_attribute *attr =
1013 container_of(dattr, struct elants_version_attribute, dattr);
1014 u8 *field = (u8 *)((char *)ts + attr->field_offset);
1015 unsigned int fmt_size;
1018 if (attr->field_size == 1) {
1020 fmt_size = 2; /* 2 HEX digits */
1022 val = *(u16 *)field;
1023 fmt_size = 4; /* 4 HEX digits */
1026 return sprintf(buf, "%0*x\n", fmt_size, val);
1029 static ELANTS_VERSION_ATTR(fw_version);
1030 static ELANTS_VERSION_ATTR(hw_version);
1031 static ELANTS_VERSION_ATTR(test_version);
1032 static ELANTS_VERSION_ATTR(solution_version);
1033 static ELANTS_VERSION_ATTR(bc_version);
1034 static ELANTS_VERSION_ATTR(iap_version);
1036 static struct attribute *elants_attributes[] = {
1037 &dev_attr_calibrate.attr,
1038 &dev_attr_update_fw.attr,
1039 &dev_attr_iap_mode.attr,
1041 &elants_ver_attr_fw_version.dattr.attr,
1042 &elants_ver_attr_hw_version.dattr.attr,
1043 &elants_ver_attr_test_version.dattr.attr,
1044 &elants_ver_attr_solution_version.dattr.attr,
1045 &elants_ver_attr_bc_version.dattr.attr,
1046 &elants_ver_attr_iap_version.dattr.attr,
1050 static struct attribute_group elants_attribute_group = {
1051 .attrs = elants_attributes,
1054 static void elants_i2c_remove_sysfs_group(void *_data)
1056 struct elants_data *ts = _data;
1058 sysfs_remove_group(&ts->client->dev.kobj, &elants_attribute_group);
1061 static int elants_i2c_probe(struct i2c_client *client,
1062 const struct i2c_device_id *id)
1064 union i2c_smbus_data dummy;
1065 struct elants_data *ts;
1066 unsigned long irqflags;
1069 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
1070 dev_err(&client->dev,
1071 "%s: i2c check functionality error\n", DEVICE_NAME);
1075 /* Make sure there is something at this address */
1076 if (i2c_smbus_xfer(client->adapter, client->addr, 0,
1077 I2C_SMBUS_READ, 0, I2C_SMBUS_BYTE, &dummy) < 0) {
1078 dev_err(&client->dev, "nothing at this address\n");
1082 ts = devm_kzalloc(&client->dev, sizeof(struct elants_data), GFP_KERNEL);
1086 mutex_init(&ts->sysfs_mutex);
1087 init_completion(&ts->cmd_done);
1089 ts->client = client;
1090 i2c_set_clientdata(client, ts);
1092 error = elants_i2c_initialize(ts);
1094 dev_err(&client->dev, "failed to initialize: %d\n", error);
1098 ts->input = devm_input_allocate_device(&client->dev);
1100 dev_err(&client->dev, "Failed to allocate input device\n");
1104 ts->input->name = "Elan Touchscreen";
1105 ts->input->id.bustype = BUS_I2C;
1107 __set_bit(BTN_TOUCH, ts->input->keybit);
1108 __set_bit(EV_ABS, ts->input->evbit);
1109 __set_bit(EV_KEY, ts->input->evbit);
1111 /* Single touch input params setup */
1112 input_set_abs_params(ts->input, ABS_X, 0, ts->x_max, 0, 0);
1113 input_set_abs_params(ts->input, ABS_Y, 0, ts->y_max, 0, 0);
1114 input_set_abs_params(ts->input, ABS_PRESSURE, 0, 255, 0, 0);
1115 input_abs_set_res(ts->input, ABS_X, ts->x_res);
1116 input_abs_set_res(ts->input, ABS_Y, ts->y_res);
1118 /* Multitouch input params setup */
1119 error = input_mt_init_slots(ts->input, MAX_CONTACT_NUM,
1120 INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED);
1122 dev_err(&client->dev,
1123 "failed to initialize MT slots: %d\n", error);
1127 input_set_abs_params(ts->input, ABS_MT_POSITION_X, 0, ts->x_max, 0, 0);
1128 input_set_abs_params(ts->input, ABS_MT_POSITION_Y, 0, ts->y_max, 0, 0);
1129 input_set_abs_params(ts->input, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0);
1130 input_set_abs_params(ts->input, ABS_MT_PRESSURE, 0, 255, 0, 0);
1131 input_abs_set_res(ts->input, ABS_MT_POSITION_X, ts->x_res);
1132 input_abs_set_res(ts->input, ABS_MT_POSITION_Y, ts->y_res);
1134 input_set_drvdata(ts->input, ts);
1136 error = input_register_device(ts->input);
1138 dev_err(&client->dev,
1139 "unable to register input device: %d\n", error);
1144 * Systems using device tree should set up interrupt via DTS,
1145 * the rest will use the default falling edge interrupts.
1147 irqflags = client->dev.of_node ? 0 : IRQF_TRIGGER_FALLING;
1149 error = devm_request_threaded_irq(&client->dev, client->irq,
1150 NULL, elants_i2c_irq,
1151 irqflags | IRQF_ONESHOT,
1154 dev_err(&client->dev, "Failed to register interrupt\n");
1159 * Systems using device tree should set up wakeup via DTS,
1160 * the rest will configure device as wakeup source by default.
1162 if (!client->dev.of_node)
1163 device_init_wakeup(&client->dev, true);
1165 error = sysfs_create_group(&client->dev.kobj, &elants_attribute_group);
1167 dev_err(&client->dev, "failed to create sysfs attributes: %d\n",
1172 error = devm_add_action(&client->dev,
1173 elants_i2c_remove_sysfs_group, ts);
1175 elants_i2c_remove_sysfs_group(ts);
1176 dev_err(&client->dev,
1177 "Failed to add sysfs cleanup action: %d\n",
1185 static int __maybe_unused elants_i2c_suspend(struct device *dev)
1187 struct i2c_client *client = to_i2c_client(dev);
1188 struct elants_data *ts = i2c_get_clientdata(client);
1189 const u8 set_sleep_cmd[] = { 0x54, 0x50, 0x00, 0x01 };
1193 /* Command not support in IAP recovery mode */
1194 if (ts->iap_mode != ELAN_IAP_OPERATIONAL)
1197 disable_irq(client->irq);
1199 for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
1200 error = elants_i2c_send(client, set_sleep_cmd,
1201 sizeof(set_sleep_cmd));
1205 dev_err(&client->dev, "suspend command failed: %d\n", error);
1208 if (device_may_wakeup(dev))
1209 ts->wake_irq_enabled = (enable_irq_wake(client->irq) == 0);
1214 static int __maybe_unused elants_i2c_resume(struct device *dev)
1216 struct i2c_client *client = to_i2c_client(dev);
1217 struct elants_data *ts = i2c_get_clientdata(client);
1218 const u8 set_active_cmd[] = { 0x54, 0x58, 0x00, 0x01 };
1222 if (device_may_wakeup(dev) && ts->wake_irq_enabled)
1223 disable_irq_wake(client->irq);
1225 for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
1226 error = elants_i2c_send(client, set_active_cmd,
1227 sizeof(set_active_cmd));
1231 dev_err(&client->dev, "resume command failed: %d\n", error);
1234 ts->state = ELAN_STATE_NORMAL;
1235 enable_irq(client->irq);
1240 static SIMPLE_DEV_PM_OPS(elants_i2c_pm_ops,
1241 elants_i2c_suspend, elants_i2c_resume);
1243 static const struct i2c_device_id elants_i2c_id[] = {
1247 MODULE_DEVICE_TABLE(i2c, elants_i2c_id);
1250 static const struct acpi_device_id elants_acpi_id[] = {
1254 MODULE_DEVICE_TABLE(acpi, elants_acpi_id);
1258 static const struct of_device_id elants_of_match[] = {
1259 { .compatible = "elan,ekth3500" },
1262 MODULE_DEVICE_TABLE(of, elants_of_match);
1265 static struct i2c_driver elants_i2c_driver = {
1266 .probe = elants_i2c_probe,
1267 .id_table = elants_i2c_id,
1269 .name = DEVICE_NAME,
1270 .pm = &elants_i2c_pm_ops,
1271 .acpi_match_table = ACPI_PTR(elants_acpi_id),
1272 .of_match_table = of_match_ptr(elants_of_match),
1275 module_i2c_driver(elants_i2c_driver);
1277 MODULE_AUTHOR("Scott Liu <scott.liu@emc.com.tw>");
1278 MODULE_DESCRIPTION("Elan I2c Touchscreen driver");
1279 MODULE_VERSION(DRV_VERSION);
1280 MODULE_LICENSE("GPL");