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
75 #define POLL_INTERVAL_MS 17 /* 17ms = 60fps */
78 EDT_PMODE_NOT_SUPPORTED,
102 struct edt_ft5x06_ts_data {
103 struct i2c_client *client;
104 struct input_dev *input;
105 struct touchscreen_properties prop;
108 struct regulator *vcc;
109 struct regulator *iovcc;
111 struct gpio_desc *reset_gpio;
112 struct gpio_desc *wake_gpio;
114 #if defined(CONFIG_DEBUG_FS)
115 struct dentry *debug_dir;
122 enum edt_pmode suspend_mode;
129 int max_support_points;
130 unsigned int known_ids;
132 char name[EDT_NAME_LEN];
134 struct edt_reg_addr reg_addr;
135 enum edt_ver version;
137 struct timer_list timer;
138 struct work_struct work_i2c_poll;
141 struct edt_i2c_chip_data {
142 int max_support_points;
145 static int edt_ft5x06_ts_readwrite(struct i2c_client *client,
146 u16 wr_len, u8 *wr_buf,
147 u16 rd_len, u8 *rd_buf)
149 struct i2c_msg wrmsg[2];
154 wrmsg[i].addr = client->addr;
156 wrmsg[i].len = wr_len;
157 wrmsg[i].buf = wr_buf;
161 wrmsg[i].addr = client->addr;
162 wrmsg[i].flags = I2C_M_RD;
163 wrmsg[i].len = rd_len;
164 wrmsg[i].buf = rd_buf;
168 ret = i2c_transfer(client->adapter, wrmsg, i);
177 static bool edt_ft5x06_ts_check_crc(struct edt_ft5x06_ts_data *tsdata,
183 for (i = 0; i < buflen - 1; i++)
186 if (crc != buf[buflen-1]) {
187 dev_err_ratelimited(&tsdata->client->dev,
188 "crc error: 0x%02x expected, got 0x%02x\n",
196 static irqreturn_t edt_ft5x06_ts_isr(int irq, void *dev_id)
198 struct edt_ft5x06_ts_data *tsdata = dev_id;
199 struct device *dev = &tsdata->client->dev;
202 int i, type, x, y, id;
203 int offset, tplen, datalen, crclen;
205 unsigned int active_ids = 0, known_ids = tsdata->known_ids;
208 unsigned int num_points;
210 switch (tsdata->version) {
212 cmd = 0xf9; /* tell the controller to send touch data */
213 offset = 5; /* where the actual touch data starts */
214 tplen = 4; /* data comes in so called frames */
215 crclen = 1; /* length of the crc data */
232 memset(rdbuf, 0, sizeof(rdbuf));
233 datalen = tplen * tsdata->max_support_points + offset + crclen;
235 error = edt_ft5x06_ts_readwrite(tsdata->client,
239 dev_err_ratelimited(dev, "Unable to fetch data, error: %d\n",
244 /* M09/M12 does not send header or CRC */
245 if (tsdata->version == EDT_M06) {
246 if (rdbuf[0] != 0xaa || rdbuf[1] != 0xaa ||
247 rdbuf[2] != datalen) {
248 dev_err_ratelimited(dev,
249 "Unexpected header: %02x%02x%02x!\n",
250 rdbuf[0], rdbuf[1], rdbuf[2]);
254 if (!edt_ft5x06_ts_check_crc(tsdata, rdbuf, datalen))
256 num_points = tsdata->max_support_points;
258 /* Register 2 is TD_STATUS, containing the number of touch
261 num_points = min(rdbuf[2] & 0xf, tsdata->max_support_points);
264 for (i = 0; i < num_points; i++) {
265 u8 *buf = &rdbuf[i * tplen + offset];
268 /* ignore Reserved events */
269 if (type == TOUCH_EVENT_RESERVED)
272 /* M06 sometimes sends bogus coordinates in TOUCH_DOWN */
273 if (tsdata->version == EDT_M06 && type == TOUCH_EVENT_DOWN)
276 x = get_unaligned_be16(buf) & 0x0fff;
277 y = get_unaligned_be16(buf + 2) & 0x0fff;
278 /* The FT5x26 send the y coordinate first */
279 if (tsdata->version == EV_FT)
282 id = (buf[2] >> 4) & 0x0f;
284 input_mt_slot(tsdata->input, id);
285 if (input_mt_report_slot_state(tsdata->input, MT_TOOL_FINGER,
286 type != TOUCH_EVENT_UP)) {
287 touchscreen_report_pos(tsdata->input, &tsdata->prop,
289 active_ids |= BIT(id);
291 known_ids &= ~BIT(id);
295 /* One issue with the device is the TOUCH_UP message is not always
296 * returned. Instead track which ids we know about and report when they
297 * are no longer updated
299 released_ids = known_ids & ~active_ids;
300 for_each_set_bit_from(b, &released_ids, tsdata->max_support_points) {
301 input_mt_slot(tsdata->input, b);
302 input_mt_report_slot_inactive(tsdata->input);
304 tsdata->known_ids = active_ids;
306 input_mt_report_pointer_emulation(tsdata->input, true);
307 input_sync(tsdata->input);
313 static void edt_ft5x06_ts_irq_poll_timer(struct timer_list *t)
315 struct edt_ft5x06_ts_data *tsdata = from_timer(tsdata, t, timer);
317 schedule_work(&tsdata->work_i2c_poll);
318 mod_timer(&tsdata->timer, jiffies + msecs_to_jiffies(POLL_INTERVAL_MS));
321 static void edt_ft5x06_ts_work_i2c_poll(struct work_struct *work)
323 struct edt_ft5x06_ts_data *tsdata = container_of(work,
324 struct edt_ft5x06_ts_data, work_i2c_poll);
326 edt_ft5x06_ts_isr(0, tsdata);
329 static int edt_ft5x06_register_write(struct edt_ft5x06_ts_data *tsdata,
334 switch (tsdata->version) {
336 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
337 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
339 wrbuf[3] = wrbuf[0] ^ wrbuf[1] ^ wrbuf[2];
340 return edt_ft5x06_ts_readwrite(tsdata->client, 4,
350 return edt_ft5x06_ts_readwrite(tsdata->client, 2,
358 static int edt_ft5x06_register_read(struct edt_ft5x06_ts_data *tsdata,
361 u8 wrbuf[2], rdbuf[2];
364 switch (tsdata->version) {
366 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
367 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
368 wrbuf[1] |= tsdata->factory_mode ? 0x80 : 0x40;
370 error = edt_ft5x06_ts_readwrite(tsdata->client, 2, wrbuf, 2,
375 if ((wrbuf[0] ^ wrbuf[1] ^ rdbuf[0]) != rdbuf[1]) {
376 dev_err(&tsdata->client->dev,
377 "crc error: 0x%02x expected, got 0x%02x\n",
378 wrbuf[0] ^ wrbuf[1] ^ rdbuf[0],
389 error = edt_ft5x06_ts_readwrite(tsdata->client, 1,
402 struct edt_ft5x06_attribute {
403 struct device_attribute dattr;
412 #define EDT_ATTR(_field, _mode, _addr_m06, _addr_m09, _addr_ev, \
413 _limit_low, _limit_high) \
414 struct edt_ft5x06_attribute edt_ft5x06_attr_##_field = { \
415 .dattr = __ATTR(_field, _mode, \
416 edt_ft5x06_setting_show, \
417 edt_ft5x06_setting_store), \
418 .field_offset = offsetof(struct edt_ft5x06_ts_data, _field), \
419 .addr_m06 = _addr_m06, \
420 .addr_m09 = _addr_m09, \
421 .addr_ev = _addr_ev, \
422 .limit_low = _limit_low, \
423 .limit_high = _limit_high, \
426 static ssize_t edt_ft5x06_setting_show(struct device *dev,
427 struct device_attribute *dattr,
430 struct i2c_client *client = to_i2c_client(dev);
431 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
432 struct edt_ft5x06_attribute *attr =
433 container_of(dattr, struct edt_ft5x06_attribute, dattr);
434 u8 *field = (u8 *)tsdata + attr->field_offset;
440 mutex_lock(&tsdata->mutex);
442 if (tsdata->factory_mode) {
447 switch (tsdata->version) {
449 addr = attr->addr_m06;
455 addr = attr->addr_m09;
459 addr = attr->addr_ev;
467 if (addr != NO_REGISTER) {
468 val = edt_ft5x06_register_read(tsdata, addr);
471 dev_err(&tsdata->client->dev,
472 "Failed to fetch attribute %s, error %d\n",
473 dattr->attr.name, error);
481 dev_warn(&tsdata->client->dev,
482 "%s: read (%d) and stored value (%d) differ\n",
483 dattr->attr.name, val, *field);
487 count = scnprintf(buf, PAGE_SIZE, "%d\n", val);
489 mutex_unlock(&tsdata->mutex);
490 return error ?: count;
493 static ssize_t edt_ft5x06_setting_store(struct device *dev,
494 struct device_attribute *dattr,
495 const char *buf, size_t count)
497 struct i2c_client *client = to_i2c_client(dev);
498 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
499 struct edt_ft5x06_attribute *attr =
500 container_of(dattr, struct edt_ft5x06_attribute, dattr);
501 u8 *field = (u8 *)tsdata + attr->field_offset;
506 mutex_lock(&tsdata->mutex);
508 if (tsdata->factory_mode) {
513 error = kstrtouint(buf, 0, &val);
517 if (val < attr->limit_low || val > attr->limit_high) {
522 switch (tsdata->version) {
524 addr = attr->addr_m06;
530 addr = attr->addr_m09;
534 addr = attr->addr_ev;
542 if (addr != NO_REGISTER) {
543 error = edt_ft5x06_register_write(tsdata, addr, val);
545 dev_err(&tsdata->client->dev,
546 "Failed to update attribute %s, error: %d\n",
547 dattr->attr.name, error);
554 mutex_unlock(&tsdata->mutex);
555 return error ?: count;
558 /* m06, m09: range 0-31, m12: range 0-5 */
559 static EDT_ATTR(gain, S_IWUSR | S_IRUGO, WORK_REGISTER_GAIN,
560 M09_REGISTER_GAIN, EV_REGISTER_GAIN, 0, 31);
561 /* m06, m09: range 0-31, m12: range 0-16 */
562 static EDT_ATTR(offset, S_IWUSR | S_IRUGO, WORK_REGISTER_OFFSET,
563 M09_REGISTER_OFFSET, NO_REGISTER, 0, 31);
564 /* m06, m09, m12: no supported, ev_ft: range 0-80 */
565 static EDT_ATTR(offset_x, S_IWUSR | S_IRUGO, NO_REGISTER, NO_REGISTER,
566 EV_REGISTER_OFFSET_X, 0, 80);
567 /* m06, m09, m12: no supported, ev_ft: range 0-80 */
568 static EDT_ATTR(offset_y, S_IWUSR | S_IRUGO, NO_REGISTER, NO_REGISTER,
569 EV_REGISTER_OFFSET_Y, 0, 80);
570 /* m06: range 20 to 80, m09: range 0 to 30, m12: range 1 to 255... */
571 static EDT_ATTR(threshold, S_IWUSR | S_IRUGO, WORK_REGISTER_THRESHOLD,
572 M09_REGISTER_THRESHOLD, EV_REGISTER_THRESHOLD, 0, 255);
573 /* m06: range 3 to 14, m12: (0x64: 100Hz) */
574 static EDT_ATTR(report_rate, S_IWUSR | S_IRUGO, WORK_REGISTER_REPORT_RATE,
575 NO_REGISTER, NO_REGISTER, 0, 255);
577 static struct attribute *edt_ft5x06_attrs[] = {
578 &edt_ft5x06_attr_gain.dattr.attr,
579 &edt_ft5x06_attr_offset.dattr.attr,
580 &edt_ft5x06_attr_offset_x.dattr.attr,
581 &edt_ft5x06_attr_offset_y.dattr.attr,
582 &edt_ft5x06_attr_threshold.dattr.attr,
583 &edt_ft5x06_attr_report_rate.dattr.attr,
587 static const struct attribute_group edt_ft5x06_attr_group = {
588 .attrs = edt_ft5x06_attrs,
591 static void edt_ft5x06_restore_reg_parameters(struct edt_ft5x06_ts_data *tsdata)
593 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
595 edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold,
597 edt_ft5x06_register_write(tsdata, reg_addr->reg_gain,
599 if (reg_addr->reg_offset != NO_REGISTER)
600 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset,
602 if (reg_addr->reg_offset_x != NO_REGISTER)
603 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_x,
605 if (reg_addr->reg_offset_y != NO_REGISTER)
606 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_y,
608 if (reg_addr->reg_report_rate != NO_REGISTER)
609 edt_ft5x06_register_write(tsdata, reg_addr->reg_report_rate,
610 tsdata->report_rate);
614 #ifdef CONFIG_DEBUG_FS
615 static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
617 struct i2c_client *client = tsdata->client;
618 int retries = EDT_SWITCH_MODE_RETRIES;
622 if (tsdata->version != EDT_M06) {
623 dev_err(&client->dev,
624 "No factory mode support for non-M06 devices\n");
628 disable_irq(client->irq);
630 if (!tsdata->raw_buffer) {
631 tsdata->raw_bufsize = tsdata->num_x * tsdata->num_y *
633 tsdata->raw_buffer = kzalloc(tsdata->raw_bufsize, GFP_KERNEL);
634 if (!tsdata->raw_buffer) {
640 /* mode register is 0x3c when in the work mode */
641 error = edt_ft5x06_register_write(tsdata, WORK_REGISTER_OPMODE, 0x03);
643 dev_err(&client->dev,
644 "failed to switch to factory mode, error %d\n", error);
648 tsdata->factory_mode = true;
650 mdelay(EDT_SWITCH_MODE_DELAY);
651 /* mode register is 0x01 when in factory mode */
652 ret = edt_ft5x06_register_read(tsdata, FACTORY_REGISTER_OPMODE);
655 } while (--retries > 0);
658 dev_err(&client->dev, "not in factory mode after %dms.\n",
659 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
667 kfree(tsdata->raw_buffer);
668 tsdata->raw_buffer = NULL;
669 tsdata->factory_mode = false;
670 enable_irq(client->irq);
675 static int edt_ft5x06_work_mode(struct edt_ft5x06_ts_data *tsdata)
677 struct i2c_client *client = tsdata->client;
678 int retries = EDT_SWITCH_MODE_RETRIES;
682 /* mode register is 0x01 when in the factory mode */
683 error = edt_ft5x06_register_write(tsdata, FACTORY_REGISTER_OPMODE, 0x1);
685 dev_err(&client->dev,
686 "failed to switch to work mode, error: %d\n", error);
690 tsdata->factory_mode = false;
693 mdelay(EDT_SWITCH_MODE_DELAY);
694 /* mode register is 0x01 when in factory mode */
695 ret = edt_ft5x06_register_read(tsdata, WORK_REGISTER_OPMODE);
698 } while (--retries > 0);
701 dev_err(&client->dev, "not in work mode after %dms.\n",
702 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
703 tsdata->factory_mode = true;
707 kfree(tsdata->raw_buffer);
708 tsdata->raw_buffer = NULL;
710 edt_ft5x06_restore_reg_parameters(tsdata);
711 enable_irq(client->irq);
716 static int edt_ft5x06_debugfs_mode_get(void *data, u64 *mode)
718 struct edt_ft5x06_ts_data *tsdata = data;
720 *mode = tsdata->factory_mode;
725 static int edt_ft5x06_debugfs_mode_set(void *data, u64 mode)
727 struct edt_ft5x06_ts_data *tsdata = data;
733 mutex_lock(&tsdata->mutex);
735 if (mode != tsdata->factory_mode) {
736 retval = mode ? edt_ft5x06_factory_mode(tsdata) :
737 edt_ft5x06_work_mode(tsdata);
740 mutex_unlock(&tsdata->mutex);
745 DEFINE_SIMPLE_ATTRIBUTE(debugfs_mode_fops, edt_ft5x06_debugfs_mode_get,
746 edt_ft5x06_debugfs_mode_set, "%llu\n");
748 static ssize_t edt_ft5x06_debugfs_raw_data_read(struct file *file,
749 char __user *buf, size_t count, loff_t *off)
751 struct edt_ft5x06_ts_data *tsdata = file->private_data;
752 struct i2c_client *client = tsdata->client;
753 int retries = EDT_RAW_DATA_RETRIES;
760 if (*off < 0 || *off >= tsdata->raw_bufsize)
763 mutex_lock(&tsdata->mutex);
765 if (!tsdata->factory_mode || !tsdata->raw_buffer) {
770 error = edt_ft5x06_register_write(tsdata, 0x08, 0x01);
772 dev_dbg(&client->dev,
773 "failed to write 0x08 register, error %d\n", error);
778 usleep_range(EDT_RAW_DATA_DELAY, EDT_RAW_DATA_DELAY + 100);
779 val = edt_ft5x06_register_read(tsdata, 0x08);
782 } while (--retries > 0);
786 dev_dbg(&client->dev,
787 "failed to read 0x08 register, error %d\n", error);
792 dev_dbg(&client->dev,
793 "timed out waiting for register to settle\n");
798 rdbuf = tsdata->raw_buffer;
799 colbytes = tsdata->num_y * sizeof(u16);
803 for (i = 0; i < tsdata->num_x; i++) {
804 wrbuf[2] = i; /* column index */
805 error = edt_ft5x06_ts_readwrite(tsdata->client,
806 sizeof(wrbuf), wrbuf,
814 read = min_t(size_t, count, tsdata->raw_bufsize - *off);
815 if (copy_to_user(buf, tsdata->raw_buffer + *off, read)) {
822 mutex_unlock(&tsdata->mutex);
823 return error ?: read;
826 static const struct file_operations debugfs_raw_data_fops = {
828 .read = edt_ft5x06_debugfs_raw_data_read,
831 static void edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
832 const char *debugfs_name)
834 tsdata->debug_dir = debugfs_create_dir(debugfs_name, NULL);
836 debugfs_create_u16("num_x", S_IRUSR, tsdata->debug_dir, &tsdata->num_x);
837 debugfs_create_u16("num_y", S_IRUSR, tsdata->debug_dir, &tsdata->num_y);
839 debugfs_create_file("mode", S_IRUSR | S_IWUSR,
840 tsdata->debug_dir, tsdata, &debugfs_mode_fops);
841 debugfs_create_file("raw_data", S_IRUSR,
842 tsdata->debug_dir, tsdata, &debugfs_raw_data_fops);
845 static void edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
847 debugfs_remove_recursive(tsdata->debug_dir);
848 kfree(tsdata->raw_buffer);
853 static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
858 static void edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
859 const char *debugfs_name)
863 static void edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
867 #endif /* CONFIG_DEBUGFS */
869 static int edt_ft5x06_ts_identify(struct i2c_client *client,
870 struct edt_ft5x06_ts_data *tsdata,
873 u8 rdbuf[EDT_NAME_LEN];
876 char *model_name = tsdata->name;
878 /* see what we find if we assume it is a M06 *
879 * if we get less than EDT_NAME_LEN, we don't want
880 * to have garbage in there
882 memset(rdbuf, 0, sizeof(rdbuf));
883 error = edt_ft5x06_ts_readwrite(client, 1, "\xBB",
884 EDT_NAME_LEN - 1, rdbuf);
888 /* Probe content for something consistent.
889 * M06 starts with a response byte, M12 gives the data directly.
890 * M09/Generic does not provide model number information.
892 if (!strncasecmp(rdbuf + 1, "EP0", 3)) {
893 tsdata->version = EDT_M06;
895 /* remove last '$' end marker */
896 rdbuf[EDT_NAME_LEN - 1] = '\0';
897 if (rdbuf[EDT_NAME_LEN - 2] == '$')
898 rdbuf[EDT_NAME_LEN - 2] = '\0';
900 /* look for Model/Version separator */
901 p = strchr(rdbuf, '*');
904 strlcpy(model_name, rdbuf + 1, EDT_NAME_LEN);
905 strlcpy(fw_version, p ? p : "", EDT_NAME_LEN);
906 } else if (!strncasecmp(rdbuf, "EP0", 3)) {
907 tsdata->version = EDT_M12;
909 /* remove last '$' end marker */
910 rdbuf[EDT_NAME_LEN - 2] = '\0';
911 if (rdbuf[EDT_NAME_LEN - 3] == '$')
912 rdbuf[EDT_NAME_LEN - 3] = '\0';
914 /* look for Model/Version separator */
915 p = strchr(rdbuf, '*');
918 strlcpy(model_name, rdbuf, EDT_NAME_LEN);
919 strlcpy(fw_version, p ? p : "", EDT_NAME_LEN);
921 /* If it is not an EDT M06/M12 touchscreen, then the model
922 * detection is a bit hairy. The different ft5x06
923 * firmares around don't reliably implement the
924 * identification registers. Well, we'll take a shot.
926 * The main difference between generic focaltec based
927 * touches and EDT M09 is that we know how to retrieve
928 * the max coordinates for the latter.
930 tsdata->version = GENERIC_FT;
932 error = edt_ft5x06_ts_readwrite(client, 1, "\xA6",
937 strlcpy(fw_version, rdbuf, 2);
939 error = edt_ft5x06_ts_readwrite(client, 1, "\xA8",
944 /* This "model identification" is not exact. Unfortunately
945 * not all firmwares for the ft5x06 put useful values in
946 * the identification registers.
949 case 0x11: /* EDT EP0110M09 */
950 case 0x35: /* EDT EP0350M09 */
951 case 0x43: /* EDT EP0430M09 */
952 case 0x50: /* EDT EP0500M09 */
953 case 0x57: /* EDT EP0570M09 */
954 case 0x70: /* EDT EP0700M09 */
955 tsdata->version = EDT_M09;
956 snprintf(model_name, EDT_NAME_LEN, "EP0%i%i0M09",
957 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
959 case 0xa1: /* EDT EP1010ML00 */
960 tsdata->version = EDT_M09;
961 snprintf(model_name, EDT_NAME_LEN, "EP%i%i0ML00",
962 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
964 case 0x5a: /* Solomon Goldentek Display */
965 snprintf(model_name, EDT_NAME_LEN, "GKTW50SCED1R0");
967 case 0x59: /* Evervision Display with FT5xx6 TS */
968 tsdata->version = EV_FT;
969 error = edt_ft5x06_ts_readwrite(client, 1, "\x53",
973 strlcpy(fw_version, rdbuf, 1);
974 snprintf(model_name, EDT_NAME_LEN,
975 "EVERVISION-FT5726NEi");
978 snprintf(model_name, EDT_NAME_LEN,
979 "generic ft5x06 (%02x)",
988 static void edt_ft5x06_ts_get_defaults(struct device *dev,
989 struct edt_ft5x06_ts_data *tsdata)
991 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
995 error = device_property_read_u32(dev, "threshold", &val);
997 edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold, val);
998 tsdata->threshold = val;
1001 error = device_property_read_u32(dev, "gain", &val);
1003 edt_ft5x06_register_write(tsdata, reg_addr->reg_gain, val);
1007 error = device_property_read_u32(dev, "offset", &val);
1009 if (reg_addr->reg_offset != NO_REGISTER)
1010 edt_ft5x06_register_write(tsdata,
1011 reg_addr->reg_offset, val);
1012 tsdata->offset = val;
1015 error = device_property_read_u32(dev, "offset-x", &val);
1017 if (reg_addr->reg_offset_x != NO_REGISTER)
1018 edt_ft5x06_register_write(tsdata,
1019 reg_addr->reg_offset_x, val);
1020 tsdata->offset_x = val;
1023 error = device_property_read_u32(dev, "offset-y", &val);
1025 if (reg_addr->reg_offset_y != NO_REGISTER)
1026 edt_ft5x06_register_write(tsdata,
1027 reg_addr->reg_offset_y, val);
1028 tsdata->offset_y = val;
1032 static void edt_ft5x06_ts_get_parameters(struct edt_ft5x06_ts_data *tsdata)
1034 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
1036 tsdata->threshold = edt_ft5x06_register_read(tsdata,
1037 reg_addr->reg_threshold);
1038 tsdata->gain = edt_ft5x06_register_read(tsdata, reg_addr->reg_gain);
1039 if (reg_addr->reg_offset != NO_REGISTER)
1041 edt_ft5x06_register_read(tsdata, reg_addr->reg_offset);
1042 if (reg_addr->reg_offset_x != NO_REGISTER)
1043 tsdata->offset_x = edt_ft5x06_register_read(tsdata,
1044 reg_addr->reg_offset_x);
1045 if (reg_addr->reg_offset_y != NO_REGISTER)
1046 tsdata->offset_y = edt_ft5x06_register_read(tsdata,
1047 reg_addr->reg_offset_y);
1048 if (reg_addr->reg_report_rate != NO_REGISTER)
1049 tsdata->report_rate = edt_ft5x06_register_read(tsdata,
1050 reg_addr->reg_report_rate);
1051 tsdata->num_x = EDT_DEFAULT_NUM_X;
1052 if (reg_addr->reg_num_x != NO_REGISTER)
1053 tsdata->num_x = edt_ft5x06_register_read(tsdata,
1054 reg_addr->reg_num_x);
1055 tsdata->num_y = EDT_DEFAULT_NUM_Y;
1056 if (reg_addr->reg_num_y != NO_REGISTER)
1057 tsdata->num_y = edt_ft5x06_register_read(tsdata,
1058 reg_addr->reg_num_y);
1061 static void edt_ft5x06_ts_set_regs(struct edt_ft5x06_ts_data *tsdata)
1063 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
1065 switch (tsdata->version) {
1067 reg_addr->reg_threshold = WORK_REGISTER_THRESHOLD;
1068 reg_addr->reg_report_rate = WORK_REGISTER_REPORT_RATE;
1069 reg_addr->reg_gain = WORK_REGISTER_GAIN;
1070 reg_addr->reg_offset = WORK_REGISTER_OFFSET;
1071 reg_addr->reg_offset_x = NO_REGISTER;
1072 reg_addr->reg_offset_y = NO_REGISTER;
1073 reg_addr->reg_num_x = WORK_REGISTER_NUM_X;
1074 reg_addr->reg_num_y = WORK_REGISTER_NUM_Y;
1079 reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
1080 reg_addr->reg_report_rate = NO_REGISTER;
1081 reg_addr->reg_gain = M09_REGISTER_GAIN;
1082 reg_addr->reg_offset = M09_REGISTER_OFFSET;
1083 reg_addr->reg_offset_x = NO_REGISTER;
1084 reg_addr->reg_offset_y = NO_REGISTER;
1085 reg_addr->reg_num_x = M09_REGISTER_NUM_X;
1086 reg_addr->reg_num_y = M09_REGISTER_NUM_Y;
1090 reg_addr->reg_threshold = EV_REGISTER_THRESHOLD;
1091 reg_addr->reg_report_rate = NO_REGISTER;
1092 reg_addr->reg_gain = EV_REGISTER_GAIN;
1093 reg_addr->reg_offset = NO_REGISTER;
1094 reg_addr->reg_offset_x = EV_REGISTER_OFFSET_X;
1095 reg_addr->reg_offset_y = EV_REGISTER_OFFSET_Y;
1096 reg_addr->reg_num_x = NO_REGISTER;
1097 reg_addr->reg_num_y = NO_REGISTER;
1101 /* this is a guesswork */
1102 reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
1103 reg_addr->reg_report_rate = NO_REGISTER;
1104 reg_addr->reg_gain = M09_REGISTER_GAIN;
1105 reg_addr->reg_offset = M09_REGISTER_OFFSET;
1106 reg_addr->reg_offset_x = NO_REGISTER;
1107 reg_addr->reg_offset_y = NO_REGISTER;
1108 reg_addr->reg_num_x = NO_REGISTER;
1109 reg_addr->reg_num_y = NO_REGISTER;
1114 static void edt_ft5x06_disable_regulators(void *arg)
1116 struct edt_ft5x06_ts_data *data = arg;
1118 regulator_disable(data->vcc);
1119 regulator_disable(data->iovcc);
1122 static int edt_ft5x06_ts_probe(struct i2c_client *client,
1123 const struct i2c_device_id *id)
1125 const struct edt_i2c_chip_data *chip_data;
1126 struct edt_ft5x06_ts_data *tsdata;
1127 u8 buf[2] = { 0xfc, 0x00 };
1128 struct input_dev *input;
1129 unsigned long irq_flags;
1131 char fw_version[EDT_NAME_LEN];
1133 dev_dbg(&client->dev, "probing for EDT FT5x06 I2C\n");
1135 tsdata = devm_kzalloc(&client->dev, sizeof(*tsdata), GFP_KERNEL);
1137 dev_err(&client->dev, "failed to allocate driver data.\n");
1141 chip_data = device_get_match_data(&client->dev);
1143 chip_data = (const struct edt_i2c_chip_data *)id->driver_data;
1144 if (!chip_data || !chip_data->max_support_points) {
1145 dev_err(&client->dev, "invalid or missing chip data\n");
1149 tsdata->max_support_points = chip_data->max_support_points;
1151 tsdata->vcc = devm_regulator_get(&client->dev, "vcc");
1152 if (IS_ERR(tsdata->vcc)) {
1153 error = PTR_ERR(tsdata->vcc);
1154 if (error != -EPROBE_DEFER)
1155 dev_err(&client->dev,
1156 "failed to request regulator: %d\n", error);
1160 tsdata->iovcc = devm_regulator_get(&client->dev, "iovcc");
1161 if (IS_ERR(tsdata->iovcc)) {
1162 error = PTR_ERR(tsdata->iovcc);
1163 if (error != -EPROBE_DEFER)
1164 dev_err(&client->dev,
1165 "failed to request iovcc regulator: %d\n", error);
1169 error = regulator_enable(tsdata->iovcc);
1171 dev_err(&client->dev, "failed to enable iovcc: %d\n", error);
1175 /* Delay enabling VCC for > 10us (T_ivd) after IOVCC */
1176 usleep_range(10, 100);
1178 error = regulator_enable(tsdata->vcc);
1180 dev_err(&client->dev, "failed to enable vcc: %d\n", error);
1181 regulator_disable(tsdata->iovcc);
1185 error = devm_add_action_or_reset(&client->dev,
1186 edt_ft5x06_disable_regulators,
1191 tsdata->reset_gpio = devm_gpiod_get_optional(&client->dev,
1192 "reset", GPIOD_OUT_HIGH);
1193 if (IS_ERR(tsdata->reset_gpio)) {
1194 error = PTR_ERR(tsdata->reset_gpio);
1195 dev_err(&client->dev,
1196 "Failed to request GPIO reset pin, error %d\n", error);
1200 tsdata->wake_gpio = devm_gpiod_get_optional(&client->dev,
1201 "wake", GPIOD_OUT_LOW);
1202 if (IS_ERR(tsdata->wake_gpio)) {
1203 error = PTR_ERR(tsdata->wake_gpio);
1204 dev_err(&client->dev,
1205 "Failed to request GPIO wake pin, error %d\n", error);
1210 * Check which sleep modes we can support. Power-off requieres the
1211 * reset-pin to ensure correct power-down/power-up behaviour. Start with
1212 * the EDT_PMODE_POWEROFF test since this is the deepest possible sleep
1215 if (tsdata->reset_gpio)
1216 tsdata->suspend_mode = EDT_PMODE_POWEROFF;
1217 else if (tsdata->wake_gpio)
1218 tsdata->suspend_mode = EDT_PMODE_HIBERNATE;
1220 tsdata->suspend_mode = EDT_PMODE_NOT_SUPPORTED;
1222 if (tsdata->wake_gpio) {
1223 usleep_range(5000, 6000);
1224 gpiod_set_value_cansleep(tsdata->wake_gpio, 1);
1227 if (tsdata->reset_gpio) {
1228 usleep_range(5000, 6000);
1229 gpiod_set_value_cansleep(tsdata->reset_gpio, 0);
1233 input = devm_input_allocate_device(&client->dev);
1235 dev_err(&client->dev, "failed to allocate input device.\n");
1239 mutex_init(&tsdata->mutex);
1240 tsdata->client = client;
1241 tsdata->input = input;
1242 tsdata->factory_mode = false;
1244 error = edt_ft5x06_ts_identify(client, tsdata, fw_version);
1246 dev_err(&client->dev, "touchscreen probe failed\n");
1251 * Dummy read access. EP0700MLP1 returns bogus data on the first
1252 * register read access and ignores writes.
1254 edt_ft5x06_ts_readwrite(tsdata->client, 2, buf, 2, buf);
1256 edt_ft5x06_ts_set_regs(tsdata);
1257 edt_ft5x06_ts_get_defaults(&client->dev, tsdata);
1258 edt_ft5x06_ts_get_parameters(tsdata);
1260 dev_dbg(&client->dev,
1261 "Model \"%s\", Rev. \"%s\", %dx%d sensors\n",
1262 tsdata->name, fw_version, tsdata->num_x, tsdata->num_y);
1264 input->name = tsdata->name;
1265 input->id.bustype = BUS_I2C;
1266 input->dev.parent = &client->dev;
1268 input_set_abs_params(input, ABS_MT_POSITION_X,
1269 0, tsdata->num_x * 64 - 1, 0, 0);
1270 input_set_abs_params(input, ABS_MT_POSITION_Y,
1271 0, tsdata->num_y * 64 - 1, 0, 0);
1273 touchscreen_parse_properties(input, true, &tsdata->prop);
1275 error = input_mt_init_slots(input, tsdata->max_support_points,
1278 dev_err(&client->dev, "Unable to init MT slots.\n");
1282 i2c_set_clientdata(client, tsdata);
1285 irq_flags = irq_get_trigger_type(client->irq);
1286 if (irq_flags == IRQF_TRIGGER_NONE)
1287 irq_flags = IRQF_TRIGGER_FALLING;
1288 irq_flags |= IRQF_ONESHOT;
1290 error = devm_request_threaded_irq(&client->dev, client->irq,
1291 NULL, edt_ft5x06_ts_isr,
1292 irq_flags, client->name,
1295 dev_err(&client->dev, "Unable to request touchscreen IRQ.\n");
1299 INIT_WORK(&tsdata->work_i2c_poll,
1300 edt_ft5x06_ts_work_i2c_poll);
1301 timer_setup(&tsdata->timer, edt_ft5x06_ts_irq_poll_timer, 0);
1302 tsdata->timer.expires = jiffies +
1303 msecs_to_jiffies(POLL_INTERVAL_MS);
1304 add_timer(&tsdata->timer);
1307 error = devm_device_add_group(&client->dev, &edt_ft5x06_attr_group);
1311 error = input_register_device(input);
1315 edt_ft5x06_ts_prepare_debugfs(tsdata, dev_driver_string(&client->dev));
1317 dev_dbg(&client->dev,
1318 "EDT FT5x06 initialized: IRQ %d, WAKE pin %d, Reset pin %d.\n",
1320 tsdata->wake_gpio ? desc_to_gpio(tsdata->wake_gpio) : -1,
1321 tsdata->reset_gpio ? desc_to_gpio(tsdata->reset_gpio) : -1);
1326 static int edt_ft5x06_ts_remove(struct i2c_client *client)
1328 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1331 del_timer(&tsdata->timer);
1332 cancel_work_sync(&tsdata->work_i2c_poll);
1334 edt_ft5x06_ts_teardown_debugfs(tsdata);
1339 static int __maybe_unused edt_ft5x06_ts_suspend(struct device *dev)
1341 struct i2c_client *client = to_i2c_client(dev);
1342 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1343 struct gpio_desc *reset_gpio = tsdata->reset_gpio;
1346 if (device_may_wakeup(dev))
1349 if (tsdata->suspend_mode == EDT_PMODE_NOT_SUPPORTED)
1352 /* Enter hibernate mode. */
1353 ret = edt_ft5x06_register_write(tsdata, PMOD_REGISTER_OPMODE,
1354 PMOD_REGISTER_HIBERNATE);
1356 dev_warn(dev, "Failed to set hibernate mode\n");
1358 if (tsdata->suspend_mode == EDT_PMODE_HIBERNATE)
1362 * Power-off according the datasheet. Cut the power may leaf the irq
1363 * line in an undefined state depending on the host pull resistor
1364 * settings. Disable the irq to avoid adjusting each host till the
1365 * device is back in a full functional state.
1367 disable_irq(tsdata->client->irq);
1369 gpiod_set_value_cansleep(reset_gpio, 1);
1370 usleep_range(1000, 2000);
1372 ret = regulator_disable(tsdata->vcc);
1374 dev_warn(dev, "Failed to disable vcc\n");
1375 ret = regulator_disable(tsdata->iovcc);
1377 dev_warn(dev, "Failed to disable iovcc\n");
1382 static int __maybe_unused edt_ft5x06_ts_resume(struct device *dev)
1384 struct i2c_client *client = to_i2c_client(dev);
1385 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1388 if (device_may_wakeup(dev))
1391 if (tsdata->suspend_mode == EDT_PMODE_NOT_SUPPORTED)
1394 if (tsdata->suspend_mode == EDT_PMODE_POWEROFF) {
1395 struct gpio_desc *reset_gpio = tsdata->reset_gpio;
1398 * We can't check if the regulator is a dummy or a real
1399 * regulator. So we need to specify the 5ms reset time (T_rst)
1400 * here instead of the 100us T_rtp time. We also need to wait
1401 * 300ms in case it was a real supply and the power was cutted
1402 * of. Toggle the reset pin is also a way to exit the hibernate
1405 gpiod_set_value_cansleep(reset_gpio, 1);
1406 usleep_range(5000, 6000);
1408 ret = regulator_enable(tsdata->iovcc);
1410 dev_err(dev, "Failed to enable iovcc\n");
1414 /* Delay enabling VCC for > 10us (T_ivd) after IOVCC */
1415 usleep_range(10, 100);
1417 ret = regulator_enable(tsdata->vcc);
1419 dev_err(dev, "Failed to enable vcc\n");
1420 regulator_disable(tsdata->iovcc);
1424 usleep_range(1000, 2000);
1425 gpiod_set_value_cansleep(reset_gpio, 0);
1428 edt_ft5x06_restore_reg_parameters(tsdata);
1429 enable_irq(tsdata->client->irq);
1431 if (tsdata->factory_mode)
1432 ret = edt_ft5x06_factory_mode(tsdata);
1434 struct gpio_desc *wake_gpio = tsdata->wake_gpio;
1436 gpiod_set_value_cansleep(wake_gpio, 0);
1437 usleep_range(5000, 6000);
1438 gpiod_set_value_cansleep(wake_gpio, 1);
1445 static SIMPLE_DEV_PM_OPS(edt_ft5x06_ts_pm_ops,
1446 edt_ft5x06_ts_suspend, edt_ft5x06_ts_resume);
1448 static const struct edt_i2c_chip_data edt_ft5x06_data = {
1449 .max_support_points = 5,
1452 static const struct edt_i2c_chip_data edt_ft5506_data = {
1453 .max_support_points = 10,
1456 static const struct edt_i2c_chip_data edt_ft6236_data = {
1457 .max_support_points = 2,
1460 static const struct i2c_device_id edt_ft5x06_ts_id[] = {
1461 { .name = "edt-ft5x06", .driver_data = (long)&edt_ft5x06_data },
1462 { .name = "edt-ft5506", .driver_data = (long)&edt_ft5506_data },
1463 { .name = "ev-ft5726", .driver_data = (long)&edt_ft5506_data },
1464 /* Note no edt- prefix for compatibility with the ft6236.c driver */
1465 { .name = "ft6236", .driver_data = (long)&edt_ft6236_data },
1468 MODULE_DEVICE_TABLE(i2c, edt_ft5x06_ts_id);
1470 static const struct of_device_id edt_ft5x06_of_match[] = {
1471 { .compatible = "edt,edt-ft5206", .data = &edt_ft5x06_data },
1472 { .compatible = "edt,edt-ft5306", .data = &edt_ft5x06_data },
1473 { .compatible = "edt,edt-ft5406", .data = &edt_ft5x06_data },
1474 { .compatible = "edt,edt-ft5506", .data = &edt_ft5506_data },
1475 { .compatible = "evervision,ev-ft5726", .data = &edt_ft5506_data },
1476 /* Note focaltech vendor prefix for compatibility with ft6236.c */
1477 { .compatible = "focaltech,ft6236", .data = &edt_ft6236_data },
1480 MODULE_DEVICE_TABLE(of, edt_ft5x06_of_match);
1482 static struct i2c_driver edt_ft5x06_ts_driver = {
1484 .name = "edt_ft5x06",
1485 .of_match_table = edt_ft5x06_of_match,
1486 .pm = &edt_ft5x06_ts_pm_ops,
1487 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1489 .id_table = edt_ft5x06_ts_id,
1490 .probe = edt_ft5x06_ts_probe,
1491 .remove = edt_ft5x06_ts_remove,
1494 module_i2c_driver(edt_ft5x06_ts_driver);
1496 MODULE_AUTHOR("Simon Budig <simon.budig@kernelconcepts.de>");
1497 MODULE_DESCRIPTION("EDT FT5x06 I2C Touchscreen Driver");
1498 MODULE_LICENSE("GPL v2");