1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2012 Simon Budig, <simon.budig@kernelconcepts.de>
4 * Daniel Wagener <daniel.wagener@kernelconcepts.de> (M09 firmware support)
5 * Lothar Waßmann <LW@KARO-electronics.de> (DT support)
9 * This is a driver for the EDT "Polytouch" family of touch controllers
10 * based on the FocalTech FT5x06 line of chips.
12 * Development of this driver has been sponsored by Glyn:
13 * http://www.glyn.com/Products/Displays
16 #include <linux/debugfs.h>
17 #include <linux/delay.h>
18 #include <linux/gpio/consumer.h>
19 #include <linux/i2c.h>
20 #include <linux/interrupt.h>
21 #include <linux/input.h>
22 #include <linux/input/mt.h>
23 #include <linux/input/touchscreen.h>
24 #include <linux/irq.h>
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/ratelimit.h>
28 #include <linux/regulator/consumer.h>
29 #include <linux/slab.h>
30 #include <linux/uaccess.h>
32 #include <asm/unaligned.h>
34 #define WORK_REGISTER_THRESHOLD 0x00
35 #define WORK_REGISTER_REPORT_RATE 0x08
36 #define WORK_REGISTER_GAIN 0x30
37 #define WORK_REGISTER_OFFSET 0x31
38 #define WORK_REGISTER_NUM_X 0x33
39 #define WORK_REGISTER_NUM_Y 0x34
41 #define PMOD_REGISTER_ACTIVE 0x00
42 #define PMOD_REGISTER_HIBERNATE 0x03
44 #define M09_REGISTER_THRESHOLD 0x80
45 #define M09_REGISTER_GAIN 0x92
46 #define M09_REGISTER_OFFSET 0x93
47 #define M09_REGISTER_NUM_X 0x94
48 #define M09_REGISTER_NUM_Y 0x95
50 #define EV_REGISTER_THRESHOLD 0x40
51 #define EV_REGISTER_GAIN 0x41
52 #define EV_REGISTER_OFFSET_Y 0x45
53 #define EV_REGISTER_OFFSET_X 0x46
55 #define NO_REGISTER 0xff
57 #define WORK_REGISTER_OPMODE 0x3c
58 #define FACTORY_REGISTER_OPMODE 0x01
59 #define PMOD_REGISTER_OPMODE 0xa5
61 #define TOUCH_EVENT_DOWN 0x00
62 #define TOUCH_EVENT_UP 0x01
63 #define TOUCH_EVENT_ON 0x02
64 #define TOUCH_EVENT_RESERVED 0x03
66 #define EDT_NAME_LEN 23
67 #define EDT_SWITCH_MODE_RETRIES 10
68 #define EDT_SWITCH_MODE_DELAY 5 /* msec */
69 #define EDT_RAW_DATA_RETRIES 100
70 #define EDT_RAW_DATA_DELAY 1000 /* usec */
72 #define EDT_DEFAULT_NUM_X 1024
73 #define EDT_DEFAULT_NUM_Y 1024
76 EDT_PMODE_NOT_SUPPORTED,
100 struct edt_ft5x06_ts_data {
101 struct i2c_client *client;
102 struct input_dev *input;
103 struct touchscreen_properties prop;
106 struct regulator *vcc;
107 struct regulator *iovcc;
109 struct gpio_desc *reset_gpio;
110 struct gpio_desc *wake_gpio;
112 #if defined(CONFIG_DEBUG_FS)
113 struct dentry *debug_dir;
120 enum edt_pmode suspend_mode;
127 int max_support_points;
129 char name[EDT_NAME_LEN];
131 struct edt_reg_addr reg_addr;
132 enum edt_ver version;
135 struct edt_i2c_chip_data {
136 int max_support_points;
139 static int edt_ft5x06_ts_readwrite(struct i2c_client *client,
140 u16 wr_len, u8 *wr_buf,
141 u16 rd_len, u8 *rd_buf)
143 struct i2c_msg wrmsg[2];
148 wrmsg[i].addr = client->addr;
150 wrmsg[i].len = wr_len;
151 wrmsg[i].buf = wr_buf;
155 wrmsg[i].addr = client->addr;
156 wrmsg[i].flags = I2C_M_RD;
157 wrmsg[i].len = rd_len;
158 wrmsg[i].buf = rd_buf;
162 ret = i2c_transfer(client->adapter, wrmsg, i);
171 static bool edt_ft5x06_ts_check_crc(struct edt_ft5x06_ts_data *tsdata,
177 for (i = 0; i < buflen - 1; i++)
180 if (crc != buf[buflen-1]) {
181 dev_err_ratelimited(&tsdata->client->dev,
182 "crc error: 0x%02x expected, got 0x%02x\n",
190 static irqreturn_t edt_ft5x06_ts_isr(int irq, void *dev_id)
192 struct edt_ft5x06_ts_data *tsdata = dev_id;
193 struct device *dev = &tsdata->client->dev;
196 int i, type, x, y, id;
197 int offset, tplen, datalen, crclen;
200 switch (tsdata->version) {
202 cmd = 0xf9; /* tell the controller to send touch data */
203 offset = 5; /* where the actual touch data starts */
204 tplen = 4; /* data comes in so called frames */
205 crclen = 1; /* length of the crc data */
222 memset(rdbuf, 0, sizeof(rdbuf));
223 datalen = tplen * tsdata->max_support_points + offset + crclen;
225 error = edt_ft5x06_ts_readwrite(tsdata->client,
229 dev_err_ratelimited(dev, "Unable to fetch data, error: %d\n",
234 /* M09/M12 does not send header or CRC */
235 if (tsdata->version == EDT_M06) {
236 if (rdbuf[0] != 0xaa || rdbuf[1] != 0xaa ||
237 rdbuf[2] != datalen) {
238 dev_err_ratelimited(dev,
239 "Unexpected header: %02x%02x%02x!\n",
240 rdbuf[0], rdbuf[1], rdbuf[2]);
244 if (!edt_ft5x06_ts_check_crc(tsdata, rdbuf, datalen))
248 for (i = 0; i < tsdata->max_support_points; i++) {
249 u8 *buf = &rdbuf[i * tplen + offset];
252 /* ignore Reserved events */
253 if (type == TOUCH_EVENT_RESERVED)
256 /* M06 sometimes sends bogus coordinates in TOUCH_DOWN */
257 if (tsdata->version == EDT_M06 && type == TOUCH_EVENT_DOWN)
260 x = get_unaligned_be16(buf) & 0x0fff;
261 y = get_unaligned_be16(buf + 2) & 0x0fff;
262 /* The FT5x26 send the y coordinate first */
263 if (tsdata->version == EV_FT)
266 id = (buf[2] >> 4) & 0x0f;
268 input_mt_slot(tsdata->input, id);
269 if (input_mt_report_slot_state(tsdata->input, MT_TOOL_FINGER,
270 type != TOUCH_EVENT_UP))
271 touchscreen_report_pos(tsdata->input, &tsdata->prop,
275 input_mt_report_pointer_emulation(tsdata->input, true);
276 input_sync(tsdata->input);
282 static int edt_ft5x06_register_write(struct edt_ft5x06_ts_data *tsdata,
287 switch (tsdata->version) {
289 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
290 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
292 wrbuf[3] = wrbuf[0] ^ wrbuf[1] ^ wrbuf[2];
293 return edt_ft5x06_ts_readwrite(tsdata->client, 4,
303 return edt_ft5x06_ts_readwrite(tsdata->client, 2,
311 static int edt_ft5x06_register_read(struct edt_ft5x06_ts_data *tsdata,
314 u8 wrbuf[2], rdbuf[2];
317 switch (tsdata->version) {
319 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
320 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
321 wrbuf[1] |= tsdata->factory_mode ? 0x80 : 0x40;
323 error = edt_ft5x06_ts_readwrite(tsdata->client, 2, wrbuf, 2,
328 if ((wrbuf[0] ^ wrbuf[1] ^ rdbuf[0]) != rdbuf[1]) {
329 dev_err(&tsdata->client->dev,
330 "crc error: 0x%02x expected, got 0x%02x\n",
331 wrbuf[0] ^ wrbuf[1] ^ rdbuf[0],
342 error = edt_ft5x06_ts_readwrite(tsdata->client, 1,
355 struct edt_ft5x06_attribute {
356 struct device_attribute dattr;
365 #define EDT_ATTR(_field, _mode, _addr_m06, _addr_m09, _addr_ev, \
366 _limit_low, _limit_high) \
367 struct edt_ft5x06_attribute edt_ft5x06_attr_##_field = { \
368 .dattr = __ATTR(_field, _mode, \
369 edt_ft5x06_setting_show, \
370 edt_ft5x06_setting_store), \
371 .field_offset = offsetof(struct edt_ft5x06_ts_data, _field), \
372 .addr_m06 = _addr_m06, \
373 .addr_m09 = _addr_m09, \
374 .addr_ev = _addr_ev, \
375 .limit_low = _limit_low, \
376 .limit_high = _limit_high, \
379 static ssize_t edt_ft5x06_setting_show(struct device *dev,
380 struct device_attribute *dattr,
383 struct i2c_client *client = to_i2c_client(dev);
384 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
385 struct edt_ft5x06_attribute *attr =
386 container_of(dattr, struct edt_ft5x06_attribute, dattr);
387 u8 *field = (u8 *)tsdata + attr->field_offset;
393 mutex_lock(&tsdata->mutex);
395 if (tsdata->factory_mode) {
400 switch (tsdata->version) {
402 addr = attr->addr_m06;
408 addr = attr->addr_m09;
412 addr = attr->addr_ev;
420 if (addr != NO_REGISTER) {
421 val = edt_ft5x06_register_read(tsdata, addr);
424 dev_err(&tsdata->client->dev,
425 "Failed to fetch attribute %s, error %d\n",
426 dattr->attr.name, error);
434 dev_warn(&tsdata->client->dev,
435 "%s: read (%d) and stored value (%d) differ\n",
436 dattr->attr.name, val, *field);
440 count = scnprintf(buf, PAGE_SIZE, "%d\n", val);
442 mutex_unlock(&tsdata->mutex);
443 return error ?: count;
446 static ssize_t edt_ft5x06_setting_store(struct device *dev,
447 struct device_attribute *dattr,
448 const char *buf, size_t count)
450 struct i2c_client *client = to_i2c_client(dev);
451 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
452 struct edt_ft5x06_attribute *attr =
453 container_of(dattr, struct edt_ft5x06_attribute, dattr);
454 u8 *field = (u8 *)tsdata + attr->field_offset;
459 mutex_lock(&tsdata->mutex);
461 if (tsdata->factory_mode) {
466 error = kstrtouint(buf, 0, &val);
470 if (val < attr->limit_low || val > attr->limit_high) {
475 switch (tsdata->version) {
477 addr = attr->addr_m06;
483 addr = attr->addr_m09;
487 addr = attr->addr_ev;
495 if (addr != NO_REGISTER) {
496 error = edt_ft5x06_register_write(tsdata, addr, val);
498 dev_err(&tsdata->client->dev,
499 "Failed to update attribute %s, error: %d\n",
500 dattr->attr.name, error);
507 mutex_unlock(&tsdata->mutex);
508 return error ?: count;
511 /* m06, m09: range 0-31, m12: range 0-5 */
512 static EDT_ATTR(gain, S_IWUSR | S_IRUGO, WORK_REGISTER_GAIN,
513 M09_REGISTER_GAIN, EV_REGISTER_GAIN, 0, 31);
514 /* m06, m09: range 0-31, m12: range 0-16 */
515 static EDT_ATTR(offset, S_IWUSR | S_IRUGO, WORK_REGISTER_OFFSET,
516 M09_REGISTER_OFFSET, NO_REGISTER, 0, 31);
517 /* m06, m09, m12: no supported, ev_ft: range 0-80 */
518 static EDT_ATTR(offset_x, S_IWUSR | S_IRUGO, NO_REGISTER, NO_REGISTER,
519 EV_REGISTER_OFFSET_X, 0, 80);
520 /* m06, m09, m12: no supported, ev_ft: range 0-80 */
521 static EDT_ATTR(offset_y, S_IWUSR | S_IRUGO, NO_REGISTER, NO_REGISTER,
522 EV_REGISTER_OFFSET_Y, 0, 80);
523 /* m06: range 20 to 80, m09: range 0 to 30, m12: range 1 to 255... */
524 static EDT_ATTR(threshold, S_IWUSR | S_IRUGO, WORK_REGISTER_THRESHOLD,
525 M09_REGISTER_THRESHOLD, EV_REGISTER_THRESHOLD, 0, 255);
526 /* m06: range 3 to 14, m12: (0x64: 100Hz) */
527 static EDT_ATTR(report_rate, S_IWUSR | S_IRUGO, WORK_REGISTER_REPORT_RATE,
528 NO_REGISTER, NO_REGISTER, 0, 255);
530 static struct attribute *edt_ft5x06_attrs[] = {
531 &edt_ft5x06_attr_gain.dattr.attr,
532 &edt_ft5x06_attr_offset.dattr.attr,
533 &edt_ft5x06_attr_offset_x.dattr.attr,
534 &edt_ft5x06_attr_offset_y.dattr.attr,
535 &edt_ft5x06_attr_threshold.dattr.attr,
536 &edt_ft5x06_attr_report_rate.dattr.attr,
540 static const struct attribute_group edt_ft5x06_attr_group = {
541 .attrs = edt_ft5x06_attrs,
544 static void edt_ft5x06_restore_reg_parameters(struct edt_ft5x06_ts_data *tsdata)
546 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
548 edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold,
550 edt_ft5x06_register_write(tsdata, reg_addr->reg_gain,
552 if (reg_addr->reg_offset != NO_REGISTER)
553 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset,
555 if (reg_addr->reg_offset_x != NO_REGISTER)
556 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_x,
558 if (reg_addr->reg_offset_y != NO_REGISTER)
559 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_y,
561 if (reg_addr->reg_report_rate != NO_REGISTER)
562 edt_ft5x06_register_write(tsdata, reg_addr->reg_report_rate,
563 tsdata->report_rate);
567 #ifdef CONFIG_DEBUG_FS
568 static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
570 struct i2c_client *client = tsdata->client;
571 int retries = EDT_SWITCH_MODE_RETRIES;
575 if (tsdata->version != EDT_M06) {
576 dev_err(&client->dev,
577 "No factory mode support for non-M06 devices\n");
581 disable_irq(client->irq);
583 if (!tsdata->raw_buffer) {
584 tsdata->raw_bufsize = tsdata->num_x * tsdata->num_y *
586 tsdata->raw_buffer = kzalloc(tsdata->raw_bufsize, GFP_KERNEL);
587 if (!tsdata->raw_buffer) {
593 /* mode register is 0x3c when in the work mode */
594 error = edt_ft5x06_register_write(tsdata, WORK_REGISTER_OPMODE, 0x03);
596 dev_err(&client->dev,
597 "failed to switch to factory mode, error %d\n", error);
601 tsdata->factory_mode = true;
603 mdelay(EDT_SWITCH_MODE_DELAY);
604 /* mode register is 0x01 when in factory mode */
605 ret = edt_ft5x06_register_read(tsdata, FACTORY_REGISTER_OPMODE);
608 } while (--retries > 0);
611 dev_err(&client->dev, "not in factory mode after %dms.\n",
612 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
620 kfree(tsdata->raw_buffer);
621 tsdata->raw_buffer = NULL;
622 tsdata->factory_mode = false;
623 enable_irq(client->irq);
628 static int edt_ft5x06_work_mode(struct edt_ft5x06_ts_data *tsdata)
630 struct i2c_client *client = tsdata->client;
631 int retries = EDT_SWITCH_MODE_RETRIES;
635 /* mode register is 0x01 when in the factory mode */
636 error = edt_ft5x06_register_write(tsdata, FACTORY_REGISTER_OPMODE, 0x1);
638 dev_err(&client->dev,
639 "failed to switch to work mode, error: %d\n", error);
643 tsdata->factory_mode = false;
646 mdelay(EDT_SWITCH_MODE_DELAY);
647 /* mode register is 0x01 when in factory mode */
648 ret = edt_ft5x06_register_read(tsdata, WORK_REGISTER_OPMODE);
651 } while (--retries > 0);
654 dev_err(&client->dev, "not in work mode after %dms.\n",
655 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
656 tsdata->factory_mode = true;
660 kfree(tsdata->raw_buffer);
661 tsdata->raw_buffer = NULL;
663 edt_ft5x06_restore_reg_parameters(tsdata);
664 enable_irq(client->irq);
669 static int edt_ft5x06_debugfs_mode_get(void *data, u64 *mode)
671 struct edt_ft5x06_ts_data *tsdata = data;
673 *mode = tsdata->factory_mode;
678 static int edt_ft5x06_debugfs_mode_set(void *data, u64 mode)
680 struct edt_ft5x06_ts_data *tsdata = data;
686 mutex_lock(&tsdata->mutex);
688 if (mode != tsdata->factory_mode) {
689 retval = mode ? edt_ft5x06_factory_mode(tsdata) :
690 edt_ft5x06_work_mode(tsdata);
693 mutex_unlock(&tsdata->mutex);
698 DEFINE_SIMPLE_ATTRIBUTE(debugfs_mode_fops, edt_ft5x06_debugfs_mode_get,
699 edt_ft5x06_debugfs_mode_set, "%llu\n");
701 static ssize_t edt_ft5x06_debugfs_raw_data_read(struct file *file,
702 char __user *buf, size_t count, loff_t *off)
704 struct edt_ft5x06_ts_data *tsdata = file->private_data;
705 struct i2c_client *client = tsdata->client;
706 int retries = EDT_RAW_DATA_RETRIES;
713 if (*off < 0 || *off >= tsdata->raw_bufsize)
716 mutex_lock(&tsdata->mutex);
718 if (!tsdata->factory_mode || !tsdata->raw_buffer) {
723 error = edt_ft5x06_register_write(tsdata, 0x08, 0x01);
725 dev_dbg(&client->dev,
726 "failed to write 0x08 register, error %d\n", error);
731 usleep_range(EDT_RAW_DATA_DELAY, EDT_RAW_DATA_DELAY + 100);
732 val = edt_ft5x06_register_read(tsdata, 0x08);
735 } while (--retries > 0);
739 dev_dbg(&client->dev,
740 "failed to read 0x08 register, error %d\n", error);
745 dev_dbg(&client->dev,
746 "timed out waiting for register to settle\n");
751 rdbuf = tsdata->raw_buffer;
752 colbytes = tsdata->num_y * sizeof(u16);
756 for (i = 0; i < tsdata->num_x; i++) {
757 wrbuf[2] = i; /* column index */
758 error = edt_ft5x06_ts_readwrite(tsdata->client,
759 sizeof(wrbuf), wrbuf,
767 read = min_t(size_t, count, tsdata->raw_bufsize - *off);
768 if (copy_to_user(buf, tsdata->raw_buffer + *off, read)) {
775 mutex_unlock(&tsdata->mutex);
776 return error ?: read;
779 static const struct file_operations debugfs_raw_data_fops = {
781 .read = edt_ft5x06_debugfs_raw_data_read,
784 static void edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
785 const char *debugfs_name)
787 tsdata->debug_dir = debugfs_create_dir(debugfs_name, NULL);
789 debugfs_create_u16("num_x", S_IRUSR, tsdata->debug_dir, &tsdata->num_x);
790 debugfs_create_u16("num_y", S_IRUSR, tsdata->debug_dir, &tsdata->num_y);
792 debugfs_create_file("mode", S_IRUSR | S_IWUSR,
793 tsdata->debug_dir, tsdata, &debugfs_mode_fops);
794 debugfs_create_file("raw_data", S_IRUSR,
795 tsdata->debug_dir, tsdata, &debugfs_raw_data_fops);
798 static void edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
800 debugfs_remove_recursive(tsdata->debug_dir);
801 kfree(tsdata->raw_buffer);
806 static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
811 static void edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
812 const char *debugfs_name)
816 static void edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
820 #endif /* CONFIG_DEBUGFS */
822 static int edt_ft5x06_ts_identify(struct i2c_client *client,
823 struct edt_ft5x06_ts_data *tsdata,
826 u8 rdbuf[EDT_NAME_LEN];
829 char *model_name = tsdata->name;
831 /* see what we find if we assume it is a M06 *
832 * if we get less than EDT_NAME_LEN, we don't want
833 * to have garbage in there
835 memset(rdbuf, 0, sizeof(rdbuf));
836 error = edt_ft5x06_ts_readwrite(client, 1, "\xBB",
837 EDT_NAME_LEN - 1, rdbuf);
841 /* Probe content for something consistent.
842 * M06 starts with a response byte, M12 gives the data directly.
843 * M09/Generic does not provide model number information.
845 if (!strncasecmp(rdbuf + 1, "EP0", 3)) {
846 tsdata->version = EDT_M06;
848 /* remove last '$' end marker */
849 rdbuf[EDT_NAME_LEN - 1] = '\0';
850 if (rdbuf[EDT_NAME_LEN - 2] == '$')
851 rdbuf[EDT_NAME_LEN - 2] = '\0';
853 /* look for Model/Version separator */
854 p = strchr(rdbuf, '*');
857 strlcpy(model_name, rdbuf + 1, EDT_NAME_LEN);
858 strlcpy(fw_version, p ? p : "", EDT_NAME_LEN);
859 } else if (!strncasecmp(rdbuf, "EP0", 3)) {
860 tsdata->version = EDT_M12;
862 /* remove last '$' end marker */
863 rdbuf[EDT_NAME_LEN - 2] = '\0';
864 if (rdbuf[EDT_NAME_LEN - 3] == '$')
865 rdbuf[EDT_NAME_LEN - 3] = '\0';
867 /* look for Model/Version separator */
868 p = strchr(rdbuf, '*');
871 strlcpy(model_name, rdbuf, EDT_NAME_LEN);
872 strlcpy(fw_version, p ? p : "", EDT_NAME_LEN);
874 /* If it is not an EDT M06/M12 touchscreen, then the model
875 * detection is a bit hairy. The different ft5x06
876 * firmares around don't reliably implement the
877 * identification registers. Well, we'll take a shot.
879 * The main difference between generic focaltec based
880 * touches and EDT M09 is that we know how to retrieve
881 * the max coordinates for the latter.
883 tsdata->version = GENERIC_FT;
885 error = edt_ft5x06_ts_readwrite(client, 1, "\xA6",
890 strlcpy(fw_version, rdbuf, 2);
892 error = edt_ft5x06_ts_readwrite(client, 1, "\xA8",
897 /* This "model identification" is not exact. Unfortunately
898 * not all firmwares for the ft5x06 put useful values in
899 * the identification registers.
902 case 0x11: /* EDT EP0110M09 */
903 case 0x35: /* EDT EP0350M09 */
904 case 0x43: /* EDT EP0430M09 */
905 case 0x50: /* EDT EP0500M09 */
906 case 0x57: /* EDT EP0570M09 */
907 case 0x70: /* EDT EP0700M09 */
908 tsdata->version = EDT_M09;
909 snprintf(model_name, EDT_NAME_LEN, "EP0%i%i0M09",
910 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
912 case 0xa1: /* EDT EP1010ML00 */
913 tsdata->version = EDT_M09;
914 snprintf(model_name, EDT_NAME_LEN, "EP%i%i0ML00",
915 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
917 case 0x5a: /* Solomon Goldentek Display */
918 snprintf(model_name, EDT_NAME_LEN, "GKTW50SCED1R0");
920 case 0x59: /* Evervision Display with FT5xx6 TS */
921 tsdata->version = EV_FT;
922 error = edt_ft5x06_ts_readwrite(client, 1, "\x53",
926 strlcpy(fw_version, rdbuf, 1);
927 snprintf(model_name, EDT_NAME_LEN,
928 "EVERVISION-FT5726NEi");
931 snprintf(model_name, EDT_NAME_LEN,
932 "generic ft5x06 (%02x)",
941 static void edt_ft5x06_ts_get_defaults(struct device *dev,
942 struct edt_ft5x06_ts_data *tsdata)
944 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
948 error = device_property_read_u32(dev, "threshold", &val);
950 edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold, val);
951 tsdata->threshold = val;
954 error = device_property_read_u32(dev, "gain", &val);
956 edt_ft5x06_register_write(tsdata, reg_addr->reg_gain, val);
960 error = device_property_read_u32(dev, "offset", &val);
962 if (reg_addr->reg_offset != NO_REGISTER)
963 edt_ft5x06_register_write(tsdata,
964 reg_addr->reg_offset, val);
965 tsdata->offset = val;
968 error = device_property_read_u32(dev, "offset-x", &val);
970 if (reg_addr->reg_offset_x != NO_REGISTER)
971 edt_ft5x06_register_write(tsdata,
972 reg_addr->reg_offset_x, val);
973 tsdata->offset_x = val;
976 error = device_property_read_u32(dev, "offset-y", &val);
978 if (reg_addr->reg_offset_y != NO_REGISTER)
979 edt_ft5x06_register_write(tsdata,
980 reg_addr->reg_offset_y, val);
981 tsdata->offset_y = val;
985 static void edt_ft5x06_ts_get_parameters(struct edt_ft5x06_ts_data *tsdata)
987 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
989 tsdata->threshold = edt_ft5x06_register_read(tsdata,
990 reg_addr->reg_threshold);
991 tsdata->gain = edt_ft5x06_register_read(tsdata, reg_addr->reg_gain);
992 if (reg_addr->reg_offset != NO_REGISTER)
994 edt_ft5x06_register_read(tsdata, reg_addr->reg_offset);
995 if (reg_addr->reg_offset_x != NO_REGISTER)
996 tsdata->offset_x = edt_ft5x06_register_read(tsdata,
997 reg_addr->reg_offset_x);
998 if (reg_addr->reg_offset_y != NO_REGISTER)
999 tsdata->offset_y = edt_ft5x06_register_read(tsdata,
1000 reg_addr->reg_offset_y);
1001 if (reg_addr->reg_report_rate != NO_REGISTER)
1002 tsdata->report_rate = edt_ft5x06_register_read(tsdata,
1003 reg_addr->reg_report_rate);
1004 tsdata->num_x = EDT_DEFAULT_NUM_X;
1005 if (reg_addr->reg_num_x != NO_REGISTER)
1006 tsdata->num_x = edt_ft5x06_register_read(tsdata,
1007 reg_addr->reg_num_x);
1008 tsdata->num_y = EDT_DEFAULT_NUM_Y;
1009 if (reg_addr->reg_num_y != NO_REGISTER)
1010 tsdata->num_y = edt_ft5x06_register_read(tsdata,
1011 reg_addr->reg_num_y);
1014 static void edt_ft5x06_ts_set_regs(struct edt_ft5x06_ts_data *tsdata)
1016 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
1018 switch (tsdata->version) {
1020 reg_addr->reg_threshold = WORK_REGISTER_THRESHOLD;
1021 reg_addr->reg_report_rate = WORK_REGISTER_REPORT_RATE;
1022 reg_addr->reg_gain = WORK_REGISTER_GAIN;
1023 reg_addr->reg_offset = WORK_REGISTER_OFFSET;
1024 reg_addr->reg_offset_x = NO_REGISTER;
1025 reg_addr->reg_offset_y = NO_REGISTER;
1026 reg_addr->reg_num_x = WORK_REGISTER_NUM_X;
1027 reg_addr->reg_num_y = WORK_REGISTER_NUM_Y;
1032 reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
1033 reg_addr->reg_report_rate = NO_REGISTER;
1034 reg_addr->reg_gain = M09_REGISTER_GAIN;
1035 reg_addr->reg_offset = M09_REGISTER_OFFSET;
1036 reg_addr->reg_offset_x = NO_REGISTER;
1037 reg_addr->reg_offset_y = NO_REGISTER;
1038 reg_addr->reg_num_x = M09_REGISTER_NUM_X;
1039 reg_addr->reg_num_y = M09_REGISTER_NUM_Y;
1043 reg_addr->reg_threshold = EV_REGISTER_THRESHOLD;
1044 reg_addr->reg_report_rate = NO_REGISTER;
1045 reg_addr->reg_gain = EV_REGISTER_GAIN;
1046 reg_addr->reg_offset = NO_REGISTER;
1047 reg_addr->reg_offset_x = EV_REGISTER_OFFSET_X;
1048 reg_addr->reg_offset_y = EV_REGISTER_OFFSET_Y;
1049 reg_addr->reg_num_x = NO_REGISTER;
1050 reg_addr->reg_num_y = NO_REGISTER;
1054 /* this is a guesswork */
1055 reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
1056 reg_addr->reg_report_rate = NO_REGISTER;
1057 reg_addr->reg_gain = M09_REGISTER_GAIN;
1058 reg_addr->reg_offset = M09_REGISTER_OFFSET;
1059 reg_addr->reg_offset_x = NO_REGISTER;
1060 reg_addr->reg_offset_y = NO_REGISTER;
1061 reg_addr->reg_num_x = NO_REGISTER;
1062 reg_addr->reg_num_y = NO_REGISTER;
1067 static void edt_ft5x06_disable_regulators(void *arg)
1069 struct edt_ft5x06_ts_data *data = arg;
1071 regulator_disable(data->vcc);
1072 regulator_disable(data->iovcc);
1075 static int edt_ft5x06_ts_probe(struct i2c_client *client,
1076 const struct i2c_device_id *id)
1078 const struct edt_i2c_chip_data *chip_data;
1079 struct edt_ft5x06_ts_data *tsdata;
1080 u8 buf[2] = { 0xfc, 0x00 };
1081 struct input_dev *input;
1082 unsigned long irq_flags;
1084 char fw_version[EDT_NAME_LEN];
1086 dev_dbg(&client->dev, "probing for EDT FT5x06 I2C\n");
1088 tsdata = devm_kzalloc(&client->dev, sizeof(*tsdata), GFP_KERNEL);
1090 dev_err(&client->dev, "failed to allocate driver data.\n");
1094 chip_data = device_get_match_data(&client->dev);
1096 chip_data = (const struct edt_i2c_chip_data *)id->driver_data;
1097 if (!chip_data || !chip_data->max_support_points) {
1098 dev_err(&client->dev, "invalid or missing chip data\n");
1102 tsdata->max_support_points = chip_data->max_support_points;
1104 tsdata->vcc = devm_regulator_get(&client->dev, "vcc");
1105 if (IS_ERR(tsdata->vcc)) {
1106 error = PTR_ERR(tsdata->vcc);
1107 if (error != -EPROBE_DEFER)
1108 dev_err(&client->dev,
1109 "failed to request regulator: %d\n", error);
1113 tsdata->iovcc = devm_regulator_get(&client->dev, "iovcc");
1114 if (IS_ERR(tsdata->iovcc)) {
1115 error = PTR_ERR(tsdata->iovcc);
1116 if (error != -EPROBE_DEFER)
1117 dev_err(&client->dev,
1118 "failed to request iovcc regulator: %d\n", error);
1122 error = regulator_enable(tsdata->iovcc);
1124 dev_err(&client->dev, "failed to enable iovcc: %d\n", error);
1128 /* Delay enabling VCC for > 10us (T_ivd) after IOVCC */
1129 usleep_range(10, 100);
1131 error = regulator_enable(tsdata->vcc);
1133 dev_err(&client->dev, "failed to enable vcc: %d\n", error);
1134 regulator_disable(tsdata->iovcc);
1138 error = devm_add_action_or_reset(&client->dev,
1139 edt_ft5x06_disable_regulators,
1144 tsdata->reset_gpio = devm_gpiod_get_optional(&client->dev,
1145 "reset", GPIOD_OUT_HIGH);
1146 if (IS_ERR(tsdata->reset_gpio)) {
1147 error = PTR_ERR(tsdata->reset_gpio);
1148 dev_err(&client->dev,
1149 "Failed to request GPIO reset pin, error %d\n", error);
1153 tsdata->wake_gpio = devm_gpiod_get_optional(&client->dev,
1154 "wake", GPIOD_OUT_LOW);
1155 if (IS_ERR(tsdata->wake_gpio)) {
1156 error = PTR_ERR(tsdata->wake_gpio);
1157 dev_err(&client->dev,
1158 "Failed to request GPIO wake pin, error %d\n", error);
1163 * Check which sleep modes we can support. Power-off requieres the
1164 * reset-pin to ensure correct power-down/power-up behaviour. Start with
1165 * the EDT_PMODE_POWEROFF test since this is the deepest possible sleep
1168 if (tsdata->reset_gpio)
1169 tsdata->suspend_mode = EDT_PMODE_POWEROFF;
1170 else if (tsdata->wake_gpio)
1171 tsdata->suspend_mode = EDT_PMODE_HIBERNATE;
1173 tsdata->suspend_mode = EDT_PMODE_NOT_SUPPORTED;
1175 if (tsdata->wake_gpio) {
1176 usleep_range(5000, 6000);
1177 gpiod_set_value_cansleep(tsdata->wake_gpio, 1);
1180 if (tsdata->reset_gpio) {
1181 usleep_range(5000, 6000);
1182 gpiod_set_value_cansleep(tsdata->reset_gpio, 0);
1186 input = devm_input_allocate_device(&client->dev);
1188 dev_err(&client->dev, "failed to allocate input device.\n");
1192 mutex_init(&tsdata->mutex);
1193 tsdata->client = client;
1194 tsdata->input = input;
1195 tsdata->factory_mode = false;
1197 error = edt_ft5x06_ts_identify(client, tsdata, fw_version);
1199 dev_err(&client->dev, "touchscreen probe failed\n");
1204 * Dummy read access. EP0700MLP1 returns bogus data on the first
1205 * register read access and ignores writes.
1207 edt_ft5x06_ts_readwrite(tsdata->client, 2, buf, 2, buf);
1209 edt_ft5x06_ts_set_regs(tsdata);
1210 edt_ft5x06_ts_get_defaults(&client->dev, tsdata);
1211 edt_ft5x06_ts_get_parameters(tsdata);
1213 dev_dbg(&client->dev,
1214 "Model \"%s\", Rev. \"%s\", %dx%d sensors\n",
1215 tsdata->name, fw_version, tsdata->num_x, tsdata->num_y);
1217 input->name = tsdata->name;
1218 input->id.bustype = BUS_I2C;
1219 input->dev.parent = &client->dev;
1221 input_set_abs_params(input, ABS_MT_POSITION_X,
1222 0, tsdata->num_x * 64 - 1, 0, 0);
1223 input_set_abs_params(input, ABS_MT_POSITION_Y,
1224 0, tsdata->num_y * 64 - 1, 0, 0);
1226 touchscreen_parse_properties(input, true, &tsdata->prop);
1228 error = input_mt_init_slots(input, tsdata->max_support_points,
1231 dev_err(&client->dev, "Unable to init MT slots.\n");
1235 i2c_set_clientdata(client, tsdata);
1237 irq_flags = irq_get_trigger_type(client->irq);
1238 if (irq_flags == IRQF_TRIGGER_NONE)
1239 irq_flags = IRQF_TRIGGER_FALLING;
1240 irq_flags |= IRQF_ONESHOT;
1242 error = devm_request_threaded_irq(&client->dev, client->irq,
1243 NULL, edt_ft5x06_ts_isr, irq_flags,
1244 client->name, tsdata);
1246 dev_err(&client->dev, "Unable to request touchscreen IRQ.\n");
1250 error = devm_device_add_group(&client->dev, &edt_ft5x06_attr_group);
1254 error = input_register_device(input);
1258 edt_ft5x06_ts_prepare_debugfs(tsdata, dev_driver_string(&client->dev));
1260 dev_dbg(&client->dev,
1261 "EDT FT5x06 initialized: IRQ %d, WAKE pin %d, Reset pin %d.\n",
1263 tsdata->wake_gpio ? desc_to_gpio(tsdata->wake_gpio) : -1,
1264 tsdata->reset_gpio ? desc_to_gpio(tsdata->reset_gpio) : -1);
1269 static int edt_ft5x06_ts_remove(struct i2c_client *client)
1271 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1273 edt_ft5x06_ts_teardown_debugfs(tsdata);
1278 static int __maybe_unused edt_ft5x06_ts_suspend(struct device *dev)
1280 struct i2c_client *client = to_i2c_client(dev);
1281 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1282 struct gpio_desc *reset_gpio = tsdata->reset_gpio;
1285 if (device_may_wakeup(dev))
1288 if (tsdata->suspend_mode == EDT_PMODE_NOT_SUPPORTED)
1291 /* Enter hibernate mode. */
1292 ret = edt_ft5x06_register_write(tsdata, PMOD_REGISTER_OPMODE,
1293 PMOD_REGISTER_HIBERNATE);
1295 dev_warn(dev, "Failed to set hibernate mode\n");
1297 if (tsdata->suspend_mode == EDT_PMODE_HIBERNATE)
1301 * Power-off according the datasheet. Cut the power may leaf the irq
1302 * line in an undefined state depending on the host pull resistor
1303 * settings. Disable the irq to avoid adjusting each host till the
1304 * device is back in a full functional state.
1306 disable_irq(tsdata->client->irq);
1308 gpiod_set_value_cansleep(reset_gpio, 1);
1309 usleep_range(1000, 2000);
1311 ret = regulator_disable(tsdata->vcc);
1313 dev_warn(dev, "Failed to disable vcc\n");
1314 ret = regulator_disable(tsdata->iovcc);
1316 dev_warn(dev, "Failed to disable iovcc\n");
1321 static int __maybe_unused edt_ft5x06_ts_resume(struct device *dev)
1323 struct i2c_client *client = to_i2c_client(dev);
1324 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1327 if (device_may_wakeup(dev))
1330 if (tsdata->suspend_mode == EDT_PMODE_NOT_SUPPORTED)
1333 if (tsdata->suspend_mode == EDT_PMODE_POWEROFF) {
1334 struct gpio_desc *reset_gpio = tsdata->reset_gpio;
1337 * We can't check if the regulator is a dummy or a real
1338 * regulator. So we need to specify the 5ms reset time (T_rst)
1339 * here instead of the 100us T_rtp time. We also need to wait
1340 * 300ms in case it was a real supply and the power was cutted
1341 * of. Toggle the reset pin is also a way to exit the hibernate
1344 gpiod_set_value_cansleep(reset_gpio, 1);
1345 usleep_range(5000, 6000);
1347 ret = regulator_enable(tsdata->iovcc);
1349 dev_err(dev, "Failed to enable iovcc\n");
1353 /* Delay enabling VCC for > 10us (T_ivd) after IOVCC */
1354 usleep_range(10, 100);
1356 ret = regulator_enable(tsdata->vcc);
1358 dev_err(dev, "Failed to enable vcc\n");
1359 regulator_disable(tsdata->iovcc);
1363 usleep_range(1000, 2000);
1364 gpiod_set_value_cansleep(reset_gpio, 0);
1367 edt_ft5x06_restore_reg_parameters(tsdata);
1368 enable_irq(tsdata->client->irq);
1370 if (tsdata->factory_mode)
1371 ret = edt_ft5x06_factory_mode(tsdata);
1373 struct gpio_desc *wake_gpio = tsdata->wake_gpio;
1375 gpiod_set_value_cansleep(wake_gpio, 0);
1376 usleep_range(5000, 6000);
1377 gpiod_set_value_cansleep(wake_gpio, 1);
1384 static SIMPLE_DEV_PM_OPS(edt_ft5x06_ts_pm_ops,
1385 edt_ft5x06_ts_suspend, edt_ft5x06_ts_resume);
1387 static const struct edt_i2c_chip_data edt_ft5x06_data = {
1388 .max_support_points = 5,
1391 static const struct edt_i2c_chip_data edt_ft5506_data = {
1392 .max_support_points = 10,
1395 static const struct edt_i2c_chip_data edt_ft6236_data = {
1396 .max_support_points = 2,
1399 static const struct i2c_device_id edt_ft5x06_ts_id[] = {
1400 { .name = "edt-ft5x06", .driver_data = (long)&edt_ft5x06_data },
1401 { .name = "edt-ft5506", .driver_data = (long)&edt_ft5506_data },
1402 { .name = "ev-ft5726", .driver_data = (long)&edt_ft5506_data },
1403 /* Note no edt- prefix for compatibility with the ft6236.c driver */
1404 { .name = "ft6236", .driver_data = (long)&edt_ft6236_data },
1407 MODULE_DEVICE_TABLE(i2c, edt_ft5x06_ts_id);
1409 static const struct of_device_id edt_ft5x06_of_match[] = {
1410 { .compatible = "edt,edt-ft5206", .data = &edt_ft5x06_data },
1411 { .compatible = "edt,edt-ft5306", .data = &edt_ft5x06_data },
1412 { .compatible = "edt,edt-ft5406", .data = &edt_ft5x06_data },
1413 { .compatible = "edt,edt-ft5506", .data = &edt_ft5506_data },
1414 { .compatible = "evervision,ev-ft5726", .data = &edt_ft5506_data },
1415 /* Note focaltech vendor prefix for compatibility with ft6236.c */
1416 { .compatible = "focaltech,ft6236", .data = &edt_ft6236_data },
1419 MODULE_DEVICE_TABLE(of, edt_ft5x06_of_match);
1421 static struct i2c_driver edt_ft5x06_ts_driver = {
1423 .name = "edt_ft5x06",
1424 .of_match_table = edt_ft5x06_of_match,
1425 .pm = &edt_ft5x06_ts_pm_ops,
1426 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1428 .id_table = edt_ft5x06_ts_id,
1429 .probe = edt_ft5x06_ts_probe,
1430 .remove = edt_ft5x06_ts_remove,
1433 module_i2c_driver(edt_ft5x06_ts_driver);
1435 MODULE_AUTHOR("Simon Budig <simon.budig@kernelconcepts.de>");
1436 MODULE_DESCRIPTION("EDT FT5x06 I2C Touchscreen Driver");
1437 MODULE_LICENSE("GPL v2");