1 // SPDX-License-Identifier: GPL-2.0
3 * ILITEK Touch IC driver for 23XX, 25XX and Lego series
5 * Copyright (C) 2011 ILI Technology Corporation.
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/input.h>
13 #include <linux/input/mt.h>
14 #include <linux/i2c.h>
15 #include <linux/slab.h>
16 #include <linux/delay.h>
17 #include <linux/interrupt.h>
18 #include <linux/gpio.h>
19 #include <linux/gpio/consumer.h>
20 #include <linux/errno.h>
21 #include <linux/acpi.h>
22 #include <linux/input/touchscreen.h>
23 #include <asm/unaligned.h>
26 #define ILITEK_TS_NAME "ilitek_ts"
31 #define ILITEK_TP_CMD_GET_TP_RES 0x20
32 #define ILITEK_TP_CMD_GET_SCRN_RES 0x21
33 #define ILITEK_TP_CMD_SET_IC_SLEEP 0x30
34 #define ILITEK_TP_CMD_SET_IC_WAKE 0x31
35 #define ILITEK_TP_CMD_GET_FW_VER 0x40
36 #define ILITEK_TP_CMD_GET_PRL_VER 0x42
37 #define ILITEK_TP_CMD_GET_MCU_VER 0x61
38 #define ILITEK_TP_CMD_GET_IC_MODE 0xC0
40 #define REPORT_COUNT_ADDRESS 61
41 #define ILITEK_SUPPORT_MAX_POINT 40
43 struct ilitek_protocol_info {
48 struct ilitek_ts_data {
49 struct i2c_client *client;
50 struct gpio_desc *reset_gpio;
51 struct input_dev *input_dev;
52 struct touchscreen_properties prop;
54 const struct ilitek_protocol_map *ptl_cb_func;
55 struct ilitek_protocol_info ptl;
70 struct ilitek_protocol_map {
73 int (*func)(struct ilitek_ts_data *ts, u16 cmd, u8 *inbuf, u8 *outbuf);
87 /* ALWAYS keep at the end */
91 /* ILITEK I2C R/W APIs */
92 static int ilitek_i2c_write_and_read(struct ilitek_ts_data *ts,
93 u8 *cmd, int write_len, int delay,
94 u8 *data, int read_len)
97 struct i2c_client *client = ts->client;
98 struct i2c_msg msgs[] = {
100 .addr = client->addr,
106 .addr = client->addr,
113 if (delay == 0 && write_len > 0 && read_len > 0) {
114 error = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
119 error = i2c_transfer(client->adapter, msgs, 1);
127 error = i2c_transfer(client->adapter, msgs + 1, 1);
136 /* ILITEK ISR APIs */
137 static void ilitek_touch_down(struct ilitek_ts_data *ts, unsigned int id,
138 unsigned int x, unsigned int y)
140 struct input_dev *input = ts->input_dev;
142 input_mt_slot(input, id);
143 input_mt_report_slot_state(input, MT_TOOL_FINGER, true);
145 touchscreen_report_pos(input, &ts->prop, x, y, true);
148 static int ilitek_process_and_report_v6(struct ilitek_ts_data *ts)
153 int packet_max_point = 10;
154 int report_max_point;
156 struct input_dev *input = ts->input_dev;
157 struct device *dev = &ts->client->dev;
158 unsigned int x, y, status, id;
160 error = ilitek_i2c_write_and_read(ts, NULL, 0, 0, buf, 64);
162 dev_err(dev, "get touch info failed, err:%d\n", error);
166 report_max_point = buf[REPORT_COUNT_ADDRESS];
167 if (report_max_point > ts->max_tp) {
168 dev_err(dev, "FW report max point:%d > panel info. max:%d\n",
169 report_max_point, ts->max_tp);
174 count = DIV_ROUND_UP(report_max_point, packet_max_point);
175 for (i = 1; i < count; i++) {
176 error = ilitek_i2c_write_and_read(ts, NULL, 0, 0,
179 dev_err(dev, "get touch info. failed, cnt:%d, err:%d\n",
185 for (i = 0; i < report_max_point; i++) {
186 status = buf[i * packet_len + 1] & 0x40;
190 id = buf[i * packet_len + 1] & 0x3F;
192 x = get_unaligned_le16(buf + i * packet_len + 2);
193 y = get_unaligned_le16(buf + i * packet_len + 4);
195 if (x > ts->screen_max_x || x < ts->screen_min_x ||
196 y > ts->screen_max_y || y < ts->screen_min_y) {
197 dev_warn(dev, "invalid position, X[%d,%u,%d], Y[%d,%u,%d]\n",
198 ts->screen_min_x, x, ts->screen_max_x,
199 ts->screen_min_y, y, ts->screen_max_y);
203 ilitek_touch_down(ts, id, x, y);
207 input_mt_sync_frame(input);
212 /* APIs of cmds for ILITEK Touch IC */
213 static int api_protocol_set_cmd(struct ilitek_ts_data *ts,
214 u16 idx, u8 *inbuf, u8 *outbuf)
219 if (idx >= MAX_CMD_CNT)
222 cmd = ts->ptl_cb_func[idx].cmd;
223 error = ts->ptl_cb_func[idx].func(ts, cmd, inbuf, outbuf);
230 static int api_protocol_get_ptl_ver(struct ilitek_ts_data *ts,
231 u16 cmd, u8 *inbuf, u8 *outbuf)
237 error = ilitek_i2c_write_and_read(ts, buf, 1, 5, outbuf, 3);
241 ts->ptl.ver = get_unaligned_be16(outbuf);
242 ts->ptl.ver_major = outbuf[0];
247 static int api_protocol_get_mcu_ver(struct ilitek_ts_data *ts,
248 u16 cmd, u8 *inbuf, u8 *outbuf)
254 error = ilitek_i2c_write_and_read(ts, buf, 1, 5, outbuf, 32);
258 ts->mcu_ver = get_unaligned_le16(outbuf);
259 memset(ts->product_id, 0, sizeof(ts->product_id));
260 memcpy(ts->product_id, outbuf + 6, 26);
265 static int api_protocol_get_fw_ver(struct ilitek_ts_data *ts,
266 u16 cmd, u8 *inbuf, u8 *outbuf)
272 error = ilitek_i2c_write_and_read(ts, buf, 1, 5, outbuf, 8);
276 memcpy(ts->firmware_ver, outbuf, 8);
281 static int api_protocol_get_scrn_res(struct ilitek_ts_data *ts,
282 u16 cmd, u8 *inbuf, u8 *outbuf)
288 error = ilitek_i2c_write_and_read(ts, buf, 1, 5, outbuf, 8);
292 ts->screen_min_x = get_unaligned_le16(outbuf);
293 ts->screen_min_y = get_unaligned_le16(outbuf + 2);
294 ts->screen_max_x = get_unaligned_le16(outbuf + 4);
295 ts->screen_max_y = get_unaligned_le16(outbuf + 6);
300 static int api_protocol_get_tp_res(struct ilitek_ts_data *ts,
301 u16 cmd, u8 *inbuf, u8 *outbuf)
307 error = ilitek_i2c_write_and_read(ts, buf, 1, 5, outbuf, 15);
311 ts->max_tp = outbuf[8];
312 if (ts->max_tp > ILITEK_SUPPORT_MAX_POINT) {
313 dev_err(&ts->client->dev, "Invalid MAX_TP:%d from FW\n",
321 static int api_protocol_get_ic_mode(struct ilitek_ts_data *ts,
322 u16 cmd, u8 *inbuf, u8 *outbuf)
328 error = ilitek_i2c_write_and_read(ts, buf, 1, 5, outbuf, 2);
332 ts->ic_mode = outbuf[0];
336 static int api_protocol_set_ic_sleep(struct ilitek_ts_data *ts,
337 u16 cmd, u8 *inbuf, u8 *outbuf)
342 return ilitek_i2c_write_and_read(ts, buf, 1, 0, NULL, 0);
345 static int api_protocol_set_ic_wake(struct ilitek_ts_data *ts,
346 u16 cmd, u8 *inbuf, u8 *outbuf)
351 return ilitek_i2c_write_and_read(ts, buf, 1, 0, NULL, 0);
354 static const struct ilitek_protocol_map ptl_func_map[] = {
357 ILITEK_TP_CMD_GET_PRL_VER, "GET_PTL_VER",
358 api_protocol_get_ptl_ver
361 ILITEK_TP_CMD_GET_FW_VER, "GET_FW_VER",
362 api_protocol_get_fw_ver
365 ILITEK_TP_CMD_GET_SCRN_RES, "GET_SCRN_RES",
366 api_protocol_get_scrn_res
369 ILITEK_TP_CMD_GET_TP_RES, "GET_TP_RES",
370 api_protocol_get_tp_res
373 ILITEK_TP_CMD_GET_IC_MODE, "GET_IC_MODE",
374 api_protocol_get_ic_mode
377 ILITEK_TP_CMD_GET_MCU_VER, "GET_MOD_VER",
378 api_protocol_get_mcu_ver
381 ILITEK_TP_CMD_SET_IC_SLEEP, "SET_IC_SLEEP",
382 api_protocol_set_ic_sleep
385 ILITEK_TP_CMD_SET_IC_WAKE, "SET_IC_WAKE",
386 api_protocol_set_ic_wake
391 static void ilitek_reset(struct ilitek_ts_data *ts, int delay)
393 if (ts->reset_gpio) {
394 gpiod_set_value(ts->reset_gpio, 1);
396 gpiod_set_value(ts->reset_gpio, 0);
401 static int ilitek_protocol_init(struct ilitek_ts_data *ts)
406 ts->ptl_cb_func = ptl_func_map;
407 ts->reset_time = 600;
409 error = api_protocol_set_cmd(ts, GET_PTL_VER, NULL, outbuf);
413 /* Protocol v3 is not support currently */
414 if (ts->ptl.ver_major == 0x3 ||
415 ts->ptl.ver == BL_V1_6 ||
416 ts->ptl.ver == BL_V1_7)
422 static int ilitek_read_tp_info(struct ilitek_ts_data *ts, bool boot)
427 error = api_protocol_set_cmd(ts, GET_PTL_VER, NULL, outbuf);
431 error = api_protocol_set_cmd(ts, GET_MCU_VER, NULL, outbuf);
435 error = api_protocol_set_cmd(ts, GET_FW_VER, NULL, outbuf);
440 error = api_protocol_set_cmd(ts, GET_SCRN_RES, NULL,
446 error = api_protocol_set_cmd(ts, GET_TP_RES, NULL, outbuf);
450 error = api_protocol_set_cmd(ts, GET_IC_MODE, NULL, outbuf);
457 static int ilitek_input_dev_init(struct device *dev, struct ilitek_ts_data *ts)
460 struct input_dev *input;
462 input = devm_input_allocate_device(dev);
466 ts->input_dev = input;
467 input->name = ILITEK_TS_NAME;
468 input->id.bustype = BUS_I2C;
470 __set_bit(INPUT_PROP_DIRECT, input->propbit);
472 input_set_abs_params(input, ABS_MT_POSITION_X,
473 ts->screen_min_x, ts->screen_max_x, 0, 0);
474 input_set_abs_params(input, ABS_MT_POSITION_Y,
475 ts->screen_min_y, ts->screen_max_y, 0, 0);
477 touchscreen_parse_properties(input, true, &ts->prop);
479 error = input_mt_init_slots(input, ts->max_tp,
480 INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED);
482 dev_err(dev, "initialize MT slots failed, err:%d\n", error);
486 error = input_register_device(input);
488 dev_err(dev, "register input device failed, err:%d\n", error);
495 static irqreturn_t ilitek_i2c_isr(int irq, void *dev_id)
497 struct ilitek_ts_data *ts = dev_id;
500 error = ilitek_process_and_report_v6(ts);
502 dev_err(&ts->client->dev, "[%s] err:%d\n", __func__, error);
509 static ssize_t firmware_version_show(struct device *dev,
510 struct device_attribute *attr, char *buf)
512 struct i2c_client *client = to_i2c_client(dev);
513 struct ilitek_ts_data *ts = i2c_get_clientdata(client);
515 return scnprintf(buf, PAGE_SIZE,
516 "fw version: [%02X%02X.%02X%02X.%02X%02X.%02X%02X]\n",
517 ts->firmware_ver[0], ts->firmware_ver[1],
518 ts->firmware_ver[2], ts->firmware_ver[3],
519 ts->firmware_ver[4], ts->firmware_ver[5],
520 ts->firmware_ver[6], ts->firmware_ver[7]);
522 static DEVICE_ATTR_RO(firmware_version);
524 static ssize_t product_id_show(struct device *dev,
525 struct device_attribute *attr, char *buf)
527 struct i2c_client *client = to_i2c_client(dev);
528 struct ilitek_ts_data *ts = i2c_get_clientdata(client);
530 return scnprintf(buf, PAGE_SIZE, "product id: [%04X], module: [%s]\n",
531 ts->mcu_ver, ts->product_id);
533 static DEVICE_ATTR_RO(product_id);
535 static struct attribute *ilitek_sysfs_attrs[] = {
536 &dev_attr_firmware_version.attr,
537 &dev_attr_product_id.attr,
541 static struct attribute_group ilitek_attrs_group = {
542 .attrs = ilitek_sysfs_attrs,
545 static int ilitek_ts_i2c_probe(struct i2c_client *client,
546 const struct i2c_device_id *id)
548 struct ilitek_ts_data *ts;
549 struct device *dev = &client->dev;
552 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
553 dev_err(dev, "i2c check functionality failed\n");
557 ts = devm_kzalloc(dev, sizeof(*ts), GFP_KERNEL);
562 i2c_set_clientdata(client, ts);
564 ts->reset_gpio = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_LOW);
565 if (IS_ERR(ts->reset_gpio)) {
566 error = PTR_ERR(ts->reset_gpio);
567 dev_err(dev, "request gpiod failed: %d", error);
571 ilitek_reset(ts, 1000);
573 error = ilitek_protocol_init(ts);
575 dev_err(dev, "protocol init failed: %d", error);
579 error = ilitek_read_tp_info(ts, true);
581 dev_err(dev, "read tp info failed: %d", error);
585 error = ilitek_input_dev_init(dev, ts);
587 dev_err(dev, "input dev init failed: %d", error);
591 error = devm_request_threaded_irq(dev, ts->client->irq,
592 NULL, ilitek_i2c_isr, IRQF_ONESHOT,
593 "ilitek_touch_irq", ts);
595 dev_err(dev, "request threaded irq failed: %d\n", error);
599 error = devm_device_add_group(dev, &ilitek_attrs_group);
601 dev_err(dev, "sysfs create group failed: %d\n", error);
608 static int __maybe_unused ilitek_suspend(struct device *dev)
610 struct i2c_client *client = to_i2c_client(dev);
611 struct ilitek_ts_data *ts = i2c_get_clientdata(client);
614 disable_irq(client->irq);
616 if (!device_may_wakeup(dev)) {
617 error = api_protocol_set_cmd(ts, SET_IC_SLEEP, NULL, NULL);
625 static int __maybe_unused ilitek_resume(struct device *dev)
627 struct i2c_client *client = to_i2c_client(dev);
628 struct ilitek_ts_data *ts = i2c_get_clientdata(client);
631 if (!device_may_wakeup(dev)) {
632 error = api_protocol_set_cmd(ts, SET_IC_WAKE, NULL, NULL);
636 ilitek_reset(ts, ts->reset_time);
639 enable_irq(client->irq);
644 static SIMPLE_DEV_PM_OPS(ilitek_pm_ops, ilitek_suspend, ilitek_resume);
646 static const struct i2c_device_id ilitek_ts_i2c_id[] = {
647 { ILITEK_TS_NAME, 0 },
650 MODULE_DEVICE_TABLE(i2c, ilitek_ts_i2c_id);
653 static const struct acpi_device_id ilitekts_acpi_id[] = {
657 MODULE_DEVICE_TABLE(acpi, ilitekts_acpi_id);
661 static const struct of_device_id ilitek_ts_i2c_match[] = {
662 {.compatible = "ilitek,ili2130",},
663 {.compatible = "ilitek,ili2131",},
664 {.compatible = "ilitek,ili2132",},
665 {.compatible = "ilitek,ili2316",},
666 {.compatible = "ilitek,ili2322",},
667 {.compatible = "ilitek,ili2323",},
668 {.compatible = "ilitek,ili2326",},
669 {.compatible = "ilitek,ili2520",},
670 {.compatible = "ilitek,ili2521",},
673 MODULE_DEVICE_TABLE(of, ilitek_ts_i2c_match);
676 static struct i2c_driver ilitek_ts_i2c_driver = {
678 .name = ILITEK_TS_NAME,
679 .pm = &ilitek_pm_ops,
680 .of_match_table = of_match_ptr(ilitek_ts_i2c_match),
681 .acpi_match_table = ACPI_PTR(ilitekts_acpi_id),
683 .probe = ilitek_ts_i2c_probe,
684 .id_table = ilitek_ts_i2c_id,
686 module_i2c_driver(ilitek_ts_i2c_driver);
688 MODULE_AUTHOR("ILITEK");
689 MODULE_DESCRIPTION("ILITEK I2C Touchscreen Driver");
690 MODULE_LICENSE("GPL");