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 M09_REGISTER_THRESHOLD 0x80
42 #define M09_REGISTER_GAIN 0x92
43 #define M09_REGISTER_OFFSET 0x93
44 #define M09_REGISTER_NUM_X 0x94
45 #define M09_REGISTER_NUM_Y 0x95
47 #define EV_REGISTER_THRESHOLD 0x40
48 #define EV_REGISTER_GAIN 0x41
49 #define EV_REGISTER_OFFSET_Y 0x45
50 #define EV_REGISTER_OFFSET_X 0x46
52 #define NO_REGISTER 0xff
54 #define WORK_REGISTER_OPMODE 0x3c
55 #define FACTORY_REGISTER_OPMODE 0x01
57 #define TOUCH_EVENT_DOWN 0x00
58 #define TOUCH_EVENT_UP 0x01
59 #define TOUCH_EVENT_ON 0x02
60 #define TOUCH_EVENT_RESERVED 0x03
62 #define EDT_NAME_LEN 23
63 #define EDT_SWITCH_MODE_RETRIES 10
64 #define EDT_SWITCH_MODE_DELAY 5 /* msec */
65 #define EDT_RAW_DATA_RETRIES 100
66 #define EDT_RAW_DATA_DELAY 1000 /* usec */
87 struct edt_ft5x06_ts_data {
88 struct i2c_client *client;
89 struct input_dev *input;
90 struct touchscreen_properties prop;
93 struct regulator *vcc;
95 struct gpio_desc *reset_gpio;
96 struct gpio_desc *wake_gpio;
98 #if defined(CONFIG_DEBUG_FS)
99 struct dentry *debug_dir;
112 int max_support_points;
114 char name[EDT_NAME_LEN];
116 struct edt_reg_addr reg_addr;
117 enum edt_ver version;
120 struct edt_i2c_chip_data {
121 int max_support_points;
124 static int edt_ft5x06_ts_readwrite(struct i2c_client *client,
125 u16 wr_len, u8 *wr_buf,
126 u16 rd_len, u8 *rd_buf)
128 struct i2c_msg wrmsg[2];
133 wrmsg[i].addr = client->addr;
135 wrmsg[i].len = wr_len;
136 wrmsg[i].buf = wr_buf;
140 wrmsg[i].addr = client->addr;
141 wrmsg[i].flags = I2C_M_RD;
142 wrmsg[i].len = rd_len;
143 wrmsg[i].buf = rd_buf;
147 ret = i2c_transfer(client->adapter, wrmsg, i);
156 static bool edt_ft5x06_ts_check_crc(struct edt_ft5x06_ts_data *tsdata,
162 for (i = 0; i < buflen - 1; i++)
165 if (crc != buf[buflen-1]) {
166 dev_err_ratelimited(&tsdata->client->dev,
167 "crc error: 0x%02x expected, got 0x%02x\n",
175 static irqreturn_t edt_ft5x06_ts_isr(int irq, void *dev_id)
177 struct edt_ft5x06_ts_data *tsdata = dev_id;
178 struct device *dev = &tsdata->client->dev;
181 int i, type, x, y, id;
182 int offset, tplen, datalen, crclen;
185 switch (tsdata->version) {
187 cmd = 0xf9; /* tell the controller to send touch data */
188 offset = 5; /* where the actual touch data starts */
189 tplen = 4; /* data comes in so called frames */
190 crclen = 1; /* length of the crc data */
207 memset(rdbuf, 0, sizeof(rdbuf));
208 datalen = tplen * tsdata->max_support_points + offset + crclen;
210 error = edt_ft5x06_ts_readwrite(tsdata->client,
214 dev_err_ratelimited(dev, "Unable to fetch data, error: %d\n",
219 /* M09/M12 does not send header or CRC */
220 if (tsdata->version == EDT_M06) {
221 if (rdbuf[0] != 0xaa || rdbuf[1] != 0xaa ||
222 rdbuf[2] != datalen) {
223 dev_err_ratelimited(dev,
224 "Unexpected header: %02x%02x%02x!\n",
225 rdbuf[0], rdbuf[1], rdbuf[2]);
229 if (!edt_ft5x06_ts_check_crc(tsdata, rdbuf, datalen))
233 for (i = 0; i < tsdata->max_support_points; i++) {
234 u8 *buf = &rdbuf[i * tplen + offset];
237 /* ignore Reserved events */
238 if (type == TOUCH_EVENT_RESERVED)
241 /* M06 sometimes sends bogus coordinates in TOUCH_DOWN */
242 if (tsdata->version == EDT_M06 && type == TOUCH_EVENT_DOWN)
245 x = get_unaligned_be16(buf) & 0x0fff;
246 y = get_unaligned_be16(buf + 2) & 0x0fff;
247 /* The FT5x26 send the y coordinate first */
248 if (tsdata->version == EV_FT)
251 id = (buf[2] >> 4) & 0x0f;
253 input_mt_slot(tsdata->input, id);
254 if (input_mt_report_slot_state(tsdata->input, MT_TOOL_FINGER,
255 type != TOUCH_EVENT_UP))
256 touchscreen_report_pos(tsdata->input, &tsdata->prop,
260 input_mt_report_pointer_emulation(tsdata->input, true);
261 input_sync(tsdata->input);
267 static int edt_ft5x06_register_write(struct edt_ft5x06_ts_data *tsdata,
272 switch (tsdata->version) {
274 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
275 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
277 wrbuf[3] = wrbuf[0] ^ wrbuf[1] ^ wrbuf[2];
278 return edt_ft5x06_ts_readwrite(tsdata->client, 4,
288 return edt_ft5x06_ts_readwrite(tsdata->client, 2,
296 static int edt_ft5x06_register_read(struct edt_ft5x06_ts_data *tsdata,
299 u8 wrbuf[2], rdbuf[2];
302 switch (tsdata->version) {
304 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
305 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
306 wrbuf[1] |= tsdata->factory_mode ? 0x80 : 0x40;
308 error = edt_ft5x06_ts_readwrite(tsdata->client, 2, wrbuf, 2,
313 if ((wrbuf[0] ^ wrbuf[1] ^ rdbuf[0]) != rdbuf[1]) {
314 dev_err(&tsdata->client->dev,
315 "crc error: 0x%02x expected, got 0x%02x\n",
316 wrbuf[0] ^ wrbuf[1] ^ rdbuf[0],
328 error = edt_ft5x06_ts_readwrite(tsdata->client, 1,
341 struct edt_ft5x06_attribute {
342 struct device_attribute dattr;
351 #define EDT_ATTR(_field, _mode, _addr_m06, _addr_m09, _addr_ev, \
352 _limit_low, _limit_high) \
353 struct edt_ft5x06_attribute edt_ft5x06_attr_##_field = { \
354 .dattr = __ATTR(_field, _mode, \
355 edt_ft5x06_setting_show, \
356 edt_ft5x06_setting_store), \
357 .field_offset = offsetof(struct edt_ft5x06_ts_data, _field), \
358 .addr_m06 = _addr_m06, \
359 .addr_m09 = _addr_m09, \
360 .addr_ev = _addr_ev, \
361 .limit_low = _limit_low, \
362 .limit_high = _limit_high, \
365 static ssize_t edt_ft5x06_setting_show(struct device *dev,
366 struct device_attribute *dattr,
369 struct i2c_client *client = to_i2c_client(dev);
370 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
371 struct edt_ft5x06_attribute *attr =
372 container_of(dattr, struct edt_ft5x06_attribute, dattr);
373 u8 *field = (u8 *)tsdata + attr->field_offset;
379 mutex_lock(&tsdata->mutex);
381 if (tsdata->factory_mode) {
386 switch (tsdata->version) {
388 addr = attr->addr_m06;
394 addr = attr->addr_m09;
398 addr = attr->addr_ev;
406 if (addr != NO_REGISTER) {
407 val = edt_ft5x06_register_read(tsdata, addr);
410 dev_err(&tsdata->client->dev,
411 "Failed to fetch attribute %s, error %d\n",
412 dattr->attr.name, error);
420 dev_warn(&tsdata->client->dev,
421 "%s: read (%d) and stored value (%d) differ\n",
422 dattr->attr.name, val, *field);
426 count = scnprintf(buf, PAGE_SIZE, "%d\n", val);
428 mutex_unlock(&tsdata->mutex);
429 return error ?: count;
432 static ssize_t edt_ft5x06_setting_store(struct device *dev,
433 struct device_attribute *dattr,
434 const char *buf, size_t count)
436 struct i2c_client *client = to_i2c_client(dev);
437 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
438 struct edt_ft5x06_attribute *attr =
439 container_of(dattr, struct edt_ft5x06_attribute, dattr);
440 u8 *field = (u8 *)tsdata + attr->field_offset;
445 mutex_lock(&tsdata->mutex);
447 if (tsdata->factory_mode) {
452 error = kstrtouint(buf, 0, &val);
456 if (val < attr->limit_low || val > attr->limit_high) {
461 switch (tsdata->version) {
463 addr = attr->addr_m06;
469 addr = attr->addr_m09;
473 addr = attr->addr_ev;
481 if (addr != NO_REGISTER) {
482 error = edt_ft5x06_register_write(tsdata, addr, val);
484 dev_err(&tsdata->client->dev,
485 "Failed to update attribute %s, error: %d\n",
486 dattr->attr.name, error);
493 mutex_unlock(&tsdata->mutex);
494 return error ?: count;
497 /* m06, m09: range 0-31, m12: range 0-5 */
498 static EDT_ATTR(gain, S_IWUSR | S_IRUGO, WORK_REGISTER_GAIN,
499 M09_REGISTER_GAIN, EV_REGISTER_GAIN, 0, 31);
500 /* m06, m09: range 0-31, m12: range 0-16 */
501 static EDT_ATTR(offset, S_IWUSR | S_IRUGO, WORK_REGISTER_OFFSET,
502 M09_REGISTER_OFFSET, NO_REGISTER, 0, 31);
503 /* m06, m09, m12: no supported, ev_ft: range 0-80 */
504 static EDT_ATTR(offset_x, S_IWUSR | S_IRUGO, NO_REGISTER, NO_REGISTER,
505 EV_REGISTER_OFFSET_X, 0, 80);
506 /* m06, m09, m12: no supported, ev_ft: range 0-80 */
507 static EDT_ATTR(offset_y, S_IWUSR | S_IRUGO, NO_REGISTER, NO_REGISTER,
508 EV_REGISTER_OFFSET_Y, 0, 80);
509 /* m06: range 20 to 80, m09: range 0 to 30, m12: range 1 to 255... */
510 static EDT_ATTR(threshold, S_IWUSR | S_IRUGO, WORK_REGISTER_THRESHOLD,
511 M09_REGISTER_THRESHOLD, EV_REGISTER_THRESHOLD, 0, 255);
512 /* m06: range 3 to 14, m12: (0x64: 100Hz) */
513 static EDT_ATTR(report_rate, S_IWUSR | S_IRUGO, WORK_REGISTER_REPORT_RATE,
514 NO_REGISTER, NO_REGISTER, 0, 255);
516 static struct attribute *edt_ft5x06_attrs[] = {
517 &edt_ft5x06_attr_gain.dattr.attr,
518 &edt_ft5x06_attr_offset.dattr.attr,
519 &edt_ft5x06_attr_offset_x.dattr.attr,
520 &edt_ft5x06_attr_offset_y.dattr.attr,
521 &edt_ft5x06_attr_threshold.dattr.attr,
522 &edt_ft5x06_attr_report_rate.dattr.attr,
526 static const struct attribute_group edt_ft5x06_attr_group = {
527 .attrs = edt_ft5x06_attrs,
530 #ifdef CONFIG_DEBUG_FS
531 static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
533 struct i2c_client *client = tsdata->client;
534 int retries = EDT_SWITCH_MODE_RETRIES;
538 if (tsdata->version != EDT_M06) {
539 dev_err(&client->dev,
540 "No factory mode support for non-M06 devices\n");
544 disable_irq(client->irq);
546 if (!tsdata->raw_buffer) {
547 tsdata->raw_bufsize = tsdata->num_x * tsdata->num_y *
549 tsdata->raw_buffer = kzalloc(tsdata->raw_bufsize, GFP_KERNEL);
550 if (!tsdata->raw_buffer) {
556 /* mode register is 0x3c when in the work mode */
557 error = edt_ft5x06_register_write(tsdata, WORK_REGISTER_OPMODE, 0x03);
559 dev_err(&client->dev,
560 "failed to switch to factory mode, error %d\n", error);
564 tsdata->factory_mode = true;
566 mdelay(EDT_SWITCH_MODE_DELAY);
567 /* mode register is 0x01 when in factory mode */
568 ret = edt_ft5x06_register_read(tsdata, FACTORY_REGISTER_OPMODE);
571 } while (--retries > 0);
574 dev_err(&client->dev, "not in factory mode after %dms.\n",
575 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
583 kfree(tsdata->raw_buffer);
584 tsdata->raw_buffer = NULL;
585 tsdata->factory_mode = false;
586 enable_irq(client->irq);
591 static int edt_ft5x06_work_mode(struct edt_ft5x06_ts_data *tsdata)
593 struct i2c_client *client = tsdata->client;
594 int retries = EDT_SWITCH_MODE_RETRIES;
595 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
599 /* mode register is 0x01 when in the factory mode */
600 error = edt_ft5x06_register_write(tsdata, FACTORY_REGISTER_OPMODE, 0x1);
602 dev_err(&client->dev,
603 "failed to switch to work mode, error: %d\n", error);
607 tsdata->factory_mode = false;
610 mdelay(EDT_SWITCH_MODE_DELAY);
611 /* mode register is 0x01 when in factory mode */
612 ret = edt_ft5x06_register_read(tsdata, WORK_REGISTER_OPMODE);
615 } while (--retries > 0);
618 dev_err(&client->dev, "not in work mode after %dms.\n",
619 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
620 tsdata->factory_mode = true;
624 kfree(tsdata->raw_buffer);
625 tsdata->raw_buffer = NULL;
627 /* restore parameters */
628 edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold,
630 edt_ft5x06_register_write(tsdata, reg_addr->reg_gain,
632 if (reg_addr->reg_offset != NO_REGISTER)
633 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset,
635 if (reg_addr->reg_offset_x != NO_REGISTER)
636 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_x,
638 if (reg_addr->reg_offset_y != NO_REGISTER)
639 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_y,
641 if (reg_addr->reg_report_rate != NO_REGISTER)
642 edt_ft5x06_register_write(tsdata, reg_addr->reg_report_rate,
643 tsdata->report_rate);
645 enable_irq(client->irq);
650 static int edt_ft5x06_debugfs_mode_get(void *data, u64 *mode)
652 struct edt_ft5x06_ts_data *tsdata = data;
654 *mode = tsdata->factory_mode;
659 static int edt_ft5x06_debugfs_mode_set(void *data, u64 mode)
661 struct edt_ft5x06_ts_data *tsdata = data;
667 mutex_lock(&tsdata->mutex);
669 if (mode != tsdata->factory_mode) {
670 retval = mode ? edt_ft5x06_factory_mode(tsdata) :
671 edt_ft5x06_work_mode(tsdata);
674 mutex_unlock(&tsdata->mutex);
679 DEFINE_SIMPLE_ATTRIBUTE(debugfs_mode_fops, edt_ft5x06_debugfs_mode_get,
680 edt_ft5x06_debugfs_mode_set, "%llu\n");
682 static ssize_t edt_ft5x06_debugfs_raw_data_read(struct file *file,
683 char __user *buf, size_t count, loff_t *off)
685 struct edt_ft5x06_ts_data *tsdata = file->private_data;
686 struct i2c_client *client = tsdata->client;
687 int retries = EDT_RAW_DATA_RETRIES;
694 if (*off < 0 || *off >= tsdata->raw_bufsize)
697 mutex_lock(&tsdata->mutex);
699 if (!tsdata->factory_mode || !tsdata->raw_buffer) {
704 error = edt_ft5x06_register_write(tsdata, 0x08, 0x01);
706 dev_dbg(&client->dev,
707 "failed to write 0x08 register, error %d\n", error);
712 usleep_range(EDT_RAW_DATA_DELAY, EDT_RAW_DATA_DELAY + 100);
713 val = edt_ft5x06_register_read(tsdata, 0x08);
716 } while (--retries > 0);
720 dev_dbg(&client->dev,
721 "failed to read 0x08 register, error %d\n", error);
726 dev_dbg(&client->dev,
727 "timed out waiting for register to settle\n");
732 rdbuf = tsdata->raw_buffer;
733 colbytes = tsdata->num_y * sizeof(u16);
737 for (i = 0; i < tsdata->num_x; i++) {
738 wrbuf[2] = i; /* column index */
739 error = edt_ft5x06_ts_readwrite(tsdata->client,
740 sizeof(wrbuf), wrbuf,
748 read = min_t(size_t, count, tsdata->raw_bufsize - *off);
749 if (copy_to_user(buf, tsdata->raw_buffer + *off, read)) {
756 mutex_unlock(&tsdata->mutex);
757 return error ?: read;
760 static const struct file_operations debugfs_raw_data_fops = {
762 .read = edt_ft5x06_debugfs_raw_data_read,
766 edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
767 const char *debugfs_name)
769 tsdata->debug_dir = debugfs_create_dir(debugfs_name, NULL);
771 debugfs_create_u16("num_x", S_IRUSR, tsdata->debug_dir, &tsdata->num_x);
772 debugfs_create_u16("num_y", S_IRUSR, tsdata->debug_dir, &tsdata->num_y);
774 debugfs_create_file("mode", S_IRUSR | S_IWUSR,
775 tsdata->debug_dir, tsdata, &debugfs_mode_fops);
776 debugfs_create_file("raw_data", S_IRUSR,
777 tsdata->debug_dir, tsdata, &debugfs_raw_data_fops);
781 edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
783 debugfs_remove_recursive(tsdata->debug_dir);
784 kfree(tsdata->raw_buffer);
790 edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
791 const char *debugfs_name)
796 edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
800 #endif /* CONFIG_DEBUGFS */
802 static int edt_ft5x06_ts_identify(struct i2c_client *client,
803 struct edt_ft5x06_ts_data *tsdata,
806 u8 rdbuf[EDT_NAME_LEN];
809 char *model_name = tsdata->name;
811 /* see what we find if we assume it is a M06 *
812 * if we get less than EDT_NAME_LEN, we don't want
813 * to have garbage in there
815 memset(rdbuf, 0, sizeof(rdbuf));
816 error = edt_ft5x06_ts_readwrite(client, 1, "\xBB",
817 EDT_NAME_LEN - 1, rdbuf);
821 /* Probe content for something consistent.
822 * M06 starts with a response byte, M12 gives the data directly.
823 * M09/Generic does not provide model number information.
825 if (!strncasecmp(rdbuf + 1, "EP0", 3)) {
826 tsdata->version = EDT_M06;
828 /* remove last '$' end marker */
829 rdbuf[EDT_NAME_LEN - 1] = '\0';
830 if (rdbuf[EDT_NAME_LEN - 2] == '$')
831 rdbuf[EDT_NAME_LEN - 2] = '\0';
833 /* look for Model/Version separator */
834 p = strchr(rdbuf, '*');
837 strlcpy(model_name, rdbuf + 1, EDT_NAME_LEN);
838 strlcpy(fw_version, p ? p : "", EDT_NAME_LEN);
839 } else if (!strncasecmp(rdbuf, "EP0", 3)) {
840 tsdata->version = EDT_M12;
842 /* remove last '$' end marker */
843 rdbuf[EDT_NAME_LEN - 2] = '\0';
844 if (rdbuf[EDT_NAME_LEN - 3] == '$')
845 rdbuf[EDT_NAME_LEN - 3] = '\0';
847 /* look for Model/Version separator */
848 p = strchr(rdbuf, '*');
851 strlcpy(model_name, rdbuf, EDT_NAME_LEN);
852 strlcpy(fw_version, p ? p : "", EDT_NAME_LEN);
854 /* If it is not an EDT M06/M12 touchscreen, then the model
855 * detection is a bit hairy. The different ft5x06
856 * firmares around don't reliably implement the
857 * identification registers. Well, we'll take a shot.
859 * The main difference between generic focaltec based
860 * touches and EDT M09 is that we know how to retrieve
861 * the max coordinates for the latter.
863 tsdata->version = GENERIC_FT;
865 error = edt_ft5x06_ts_readwrite(client, 1, "\xA6",
870 strlcpy(fw_version, rdbuf, 2);
872 error = edt_ft5x06_ts_readwrite(client, 1, "\xA8",
877 /* This "model identification" is not exact. Unfortunately
878 * not all firmwares for the ft5x06 put useful values in
879 * the identification registers.
882 case 0x35: /* EDT EP0350M09 */
883 case 0x43: /* EDT EP0430M09 */
884 case 0x50: /* EDT EP0500M09 */
885 case 0x57: /* EDT EP0570M09 */
886 case 0x70: /* EDT EP0700M09 */
887 tsdata->version = EDT_M09;
888 snprintf(model_name, EDT_NAME_LEN, "EP0%i%i0M09",
889 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
891 case 0xa1: /* EDT EP1010ML00 */
892 tsdata->version = EDT_M09;
893 snprintf(model_name, EDT_NAME_LEN, "EP%i%i0ML00",
894 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
896 case 0x5a: /* Solomon Goldentek Display */
897 snprintf(model_name, EDT_NAME_LEN, "GKTW50SCED1R0");
899 case 0x59: /* Evervision Display with FT5xx6 TS */
900 tsdata->version = EV_FT;
901 error = edt_ft5x06_ts_readwrite(client, 1, "\x53",
905 strlcpy(fw_version, rdbuf, 1);
906 snprintf(model_name, EDT_NAME_LEN,
907 "EVERVISION-FT5726NEi");
910 snprintf(model_name, EDT_NAME_LEN,
911 "generic ft5x06 (%02x)",
920 static void edt_ft5x06_ts_get_defaults(struct device *dev,
921 struct edt_ft5x06_ts_data *tsdata)
923 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
927 error = device_property_read_u32(dev, "threshold", &val);
929 edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold, val);
930 tsdata->threshold = val;
933 error = device_property_read_u32(dev, "gain", &val);
935 edt_ft5x06_register_write(tsdata, reg_addr->reg_gain, val);
939 error = device_property_read_u32(dev, "offset", &val);
941 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset, val);
942 tsdata->offset = val;
945 error = device_property_read_u32(dev, "offset-x", &val);
947 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_x, val);
948 tsdata->offset_x = val;
951 error = device_property_read_u32(dev, "offset-y", &val);
953 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_y, val);
954 tsdata->offset_y = val;
959 edt_ft5x06_ts_get_parameters(struct edt_ft5x06_ts_data *tsdata)
961 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
963 tsdata->threshold = edt_ft5x06_register_read(tsdata,
964 reg_addr->reg_threshold);
965 tsdata->gain = edt_ft5x06_register_read(tsdata, reg_addr->reg_gain);
966 if (reg_addr->reg_offset != NO_REGISTER)
968 edt_ft5x06_register_read(tsdata, reg_addr->reg_offset);
969 if (reg_addr->reg_offset_x != NO_REGISTER)
970 tsdata->offset_x = edt_ft5x06_register_read(tsdata,
971 reg_addr->reg_offset_x);
972 if (reg_addr->reg_offset_y != NO_REGISTER)
973 tsdata->offset_y = edt_ft5x06_register_read(tsdata,
974 reg_addr->reg_offset_y);
975 if (reg_addr->reg_report_rate != NO_REGISTER)
976 tsdata->report_rate = edt_ft5x06_register_read(tsdata,
977 reg_addr->reg_report_rate);
978 if (tsdata->version == EDT_M06 ||
979 tsdata->version == EDT_M09 ||
980 tsdata->version == EDT_M12) {
981 tsdata->num_x = edt_ft5x06_register_read(tsdata,
982 reg_addr->reg_num_x);
983 tsdata->num_y = edt_ft5x06_register_read(tsdata,
984 reg_addr->reg_num_y);
992 edt_ft5x06_ts_set_regs(struct edt_ft5x06_ts_data *tsdata)
994 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
996 switch (tsdata->version) {
998 reg_addr->reg_threshold = WORK_REGISTER_THRESHOLD;
999 reg_addr->reg_report_rate = WORK_REGISTER_REPORT_RATE;
1000 reg_addr->reg_gain = WORK_REGISTER_GAIN;
1001 reg_addr->reg_offset = WORK_REGISTER_OFFSET;
1002 reg_addr->reg_offset_x = NO_REGISTER;
1003 reg_addr->reg_offset_y = NO_REGISTER;
1004 reg_addr->reg_num_x = WORK_REGISTER_NUM_X;
1005 reg_addr->reg_num_y = WORK_REGISTER_NUM_Y;
1010 reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
1011 reg_addr->reg_report_rate = NO_REGISTER;
1012 reg_addr->reg_gain = M09_REGISTER_GAIN;
1013 reg_addr->reg_offset = M09_REGISTER_OFFSET;
1014 reg_addr->reg_offset_x = NO_REGISTER;
1015 reg_addr->reg_offset_y = NO_REGISTER;
1016 reg_addr->reg_num_x = M09_REGISTER_NUM_X;
1017 reg_addr->reg_num_y = M09_REGISTER_NUM_Y;
1021 reg_addr->reg_threshold = EV_REGISTER_THRESHOLD;
1022 reg_addr->reg_gain = EV_REGISTER_GAIN;
1023 reg_addr->reg_offset = NO_REGISTER;
1024 reg_addr->reg_offset_x = EV_REGISTER_OFFSET_X;
1025 reg_addr->reg_offset_y = EV_REGISTER_OFFSET_Y;
1026 reg_addr->reg_num_x = NO_REGISTER;
1027 reg_addr->reg_num_y = NO_REGISTER;
1028 reg_addr->reg_report_rate = NO_REGISTER;
1032 /* this is a guesswork */
1033 reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
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;
1042 static void edt_ft5x06_disable_regulator(void *arg)
1044 struct edt_ft5x06_ts_data *data = arg;
1046 regulator_disable(data->vcc);
1049 static int edt_ft5x06_ts_probe(struct i2c_client *client,
1050 const struct i2c_device_id *id)
1052 const struct edt_i2c_chip_data *chip_data;
1053 struct edt_ft5x06_ts_data *tsdata;
1054 u8 buf[2] = { 0xfc, 0x00 };
1055 struct input_dev *input;
1056 unsigned long irq_flags;
1058 char fw_version[EDT_NAME_LEN];
1060 dev_dbg(&client->dev, "probing for EDT FT5x06 I2C\n");
1062 tsdata = devm_kzalloc(&client->dev, sizeof(*tsdata), GFP_KERNEL);
1064 dev_err(&client->dev, "failed to allocate driver data.\n");
1068 chip_data = device_get_match_data(&client->dev);
1070 chip_data = (const struct edt_i2c_chip_data *)id->driver_data;
1071 if (!chip_data || !chip_data->max_support_points) {
1072 dev_err(&client->dev, "invalid or missing chip data\n");
1076 tsdata->max_support_points = chip_data->max_support_points;
1078 tsdata->vcc = devm_regulator_get(&client->dev, "vcc");
1079 if (IS_ERR(tsdata->vcc)) {
1080 error = PTR_ERR(tsdata->vcc);
1081 if (error != -EPROBE_DEFER)
1082 dev_err(&client->dev,
1083 "failed to request regulator: %d\n", error);
1087 error = regulator_enable(tsdata->vcc);
1089 dev_err(&client->dev, "failed to enable vcc: %d\n", error);
1093 error = devm_add_action_or_reset(&client->dev,
1094 edt_ft5x06_disable_regulator,
1099 tsdata->reset_gpio = devm_gpiod_get_optional(&client->dev,
1100 "reset", GPIOD_OUT_HIGH);
1101 if (IS_ERR(tsdata->reset_gpio)) {
1102 error = PTR_ERR(tsdata->reset_gpio);
1103 dev_err(&client->dev,
1104 "Failed to request GPIO reset pin, error %d\n", error);
1108 tsdata->wake_gpio = devm_gpiod_get_optional(&client->dev,
1109 "wake", GPIOD_OUT_LOW);
1110 if (IS_ERR(tsdata->wake_gpio)) {
1111 error = PTR_ERR(tsdata->wake_gpio);
1112 dev_err(&client->dev,
1113 "Failed to request GPIO wake pin, error %d\n", error);
1117 if (tsdata->wake_gpio) {
1118 usleep_range(5000, 6000);
1119 gpiod_set_value_cansleep(tsdata->wake_gpio, 1);
1122 if (tsdata->reset_gpio) {
1123 usleep_range(5000, 6000);
1124 gpiod_set_value_cansleep(tsdata->reset_gpio, 0);
1128 input = devm_input_allocate_device(&client->dev);
1130 dev_err(&client->dev, "failed to allocate input device.\n");
1134 mutex_init(&tsdata->mutex);
1135 tsdata->client = client;
1136 tsdata->input = input;
1137 tsdata->factory_mode = false;
1139 error = edt_ft5x06_ts_identify(client, tsdata, fw_version);
1141 dev_err(&client->dev, "touchscreen probe failed\n");
1146 * Dummy read access. EP0700MLP1 returns bogus data on the first
1147 * register read access and ignores writes.
1149 edt_ft5x06_ts_readwrite(tsdata->client, 2, buf, 2, buf);
1151 edt_ft5x06_ts_set_regs(tsdata);
1152 edt_ft5x06_ts_get_defaults(&client->dev, tsdata);
1153 edt_ft5x06_ts_get_parameters(tsdata);
1155 dev_dbg(&client->dev,
1156 "Model \"%s\", Rev. \"%s\", %dx%d sensors\n",
1157 tsdata->name, fw_version, tsdata->num_x, tsdata->num_y);
1159 input->name = tsdata->name;
1160 input->id.bustype = BUS_I2C;
1161 input->dev.parent = &client->dev;
1163 if (tsdata->version == EDT_M06 ||
1164 tsdata->version == EDT_M09 ||
1165 tsdata->version == EDT_M12) {
1166 input_set_abs_params(input, ABS_MT_POSITION_X,
1167 0, tsdata->num_x * 64 - 1, 0, 0);
1168 input_set_abs_params(input, ABS_MT_POSITION_Y,
1169 0, tsdata->num_y * 64 - 1, 0, 0);
1171 /* Unknown maximum values. Specify via devicetree */
1172 input_set_abs_params(input, ABS_MT_POSITION_X,
1174 input_set_abs_params(input, ABS_MT_POSITION_Y,
1178 touchscreen_parse_properties(input, true, &tsdata->prop);
1180 error = input_mt_init_slots(input, tsdata->max_support_points,
1183 dev_err(&client->dev, "Unable to init MT slots.\n");
1187 i2c_set_clientdata(client, tsdata);
1189 irq_flags = irq_get_trigger_type(client->irq);
1190 if (irq_flags == IRQF_TRIGGER_NONE)
1191 irq_flags = IRQF_TRIGGER_FALLING;
1192 irq_flags |= IRQF_ONESHOT;
1194 error = devm_request_threaded_irq(&client->dev, client->irq,
1195 NULL, edt_ft5x06_ts_isr, irq_flags,
1196 client->name, tsdata);
1198 dev_err(&client->dev, "Unable to request touchscreen IRQ.\n");
1202 error = devm_device_add_group(&client->dev, &edt_ft5x06_attr_group);
1206 error = input_register_device(input);
1210 edt_ft5x06_ts_prepare_debugfs(tsdata, dev_driver_string(&client->dev));
1212 dev_dbg(&client->dev,
1213 "EDT FT5x06 initialized: IRQ %d, WAKE pin %d, Reset pin %d.\n",
1215 tsdata->wake_gpio ? desc_to_gpio(tsdata->wake_gpio) : -1,
1216 tsdata->reset_gpio ? desc_to_gpio(tsdata->reset_gpio) : -1);
1221 static int edt_ft5x06_ts_remove(struct i2c_client *client)
1223 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1225 edt_ft5x06_ts_teardown_debugfs(tsdata);
1230 static const struct edt_i2c_chip_data edt_ft5x06_data = {
1231 .max_support_points = 5,
1234 static const struct edt_i2c_chip_data edt_ft5506_data = {
1235 .max_support_points = 10,
1238 static const struct edt_i2c_chip_data edt_ft6236_data = {
1239 .max_support_points = 2,
1242 static const struct i2c_device_id edt_ft5x06_ts_id[] = {
1243 { .name = "edt-ft5x06", .driver_data = (long)&edt_ft5x06_data },
1244 { .name = "edt-ft5506", .driver_data = (long)&edt_ft5506_data },
1245 { .name = "ev-ft5726", .driver_data = (long)&edt_ft5506_data },
1246 /* Note no edt- prefix for compatibility with the ft6236.c driver */
1247 { .name = "ft6236", .driver_data = (long)&edt_ft6236_data },
1250 MODULE_DEVICE_TABLE(i2c, edt_ft5x06_ts_id);
1252 static const struct of_device_id edt_ft5x06_of_match[] = {
1253 { .compatible = "edt,edt-ft5206", .data = &edt_ft5x06_data },
1254 { .compatible = "edt,edt-ft5306", .data = &edt_ft5x06_data },
1255 { .compatible = "edt,edt-ft5406", .data = &edt_ft5x06_data },
1256 { .compatible = "edt,edt-ft5506", .data = &edt_ft5506_data },
1257 { .compatible = "evervision,ev-ft5726", .data = &edt_ft5506_data },
1258 /* Note focaltech vendor prefix for compatibility with ft6236.c */
1259 { .compatible = "focaltech,ft6236", .data = &edt_ft6236_data },
1262 MODULE_DEVICE_TABLE(of, edt_ft5x06_of_match);
1264 static struct i2c_driver edt_ft5x06_ts_driver = {
1266 .name = "edt_ft5x06",
1267 .of_match_table = edt_ft5x06_of_match,
1269 .id_table = edt_ft5x06_ts_id,
1270 .probe = edt_ft5x06_ts_probe,
1271 .remove = edt_ft5x06_ts_remove,
1274 module_i2c_driver(edt_ft5x06_ts_driver);
1276 MODULE_AUTHOR("Simon Budig <simon.budig@kernelconcepts.de>");
1277 MODULE_DESCRIPTION("EDT FT5x06 I2C Touchscreen Driver");
1278 MODULE_LICENSE("GPL v2");