Loading...
1/*
2 * Copyright (C) 2012 Simon Budig, <simon.budig@kernelconcepts.de>
3 * Daniel Wagener <daniel.wagener@kernelconcepts.de> (M09 firmware support)
4 * Lothar Waßmann <LW@KARO-electronics.de> (DT support)
5 *
6 * This software is licensed under the terms of the GNU General Public
7 * License version 2, as published by the Free Software Foundation, and
8 * may be copied, distributed, and modified under those terms.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
19
20/*
21 * This is a driver for the EDT "Polytouch" family of touch controllers
22 * based on the FocalTech FT5x06 line of chips.
23 *
24 * Development of this driver has been sponsored by Glyn:
25 * http://www.glyn.com/Products/Displays
26 */
27
28#include <linux/module.h>
29#include <linux/ratelimit.h>
30#include <linux/interrupt.h>
31#include <linux/input.h>
32#include <linux/i2c.h>
33#include <linux/uaccess.h>
34#include <linux/delay.h>
35#include <linux/debugfs.h>
36#include <linux/slab.h>
37#include <linux/gpio.h>
38#include <linux/of_gpio.h>
39#include <linux/input/mt.h>
40#include <linux/input/edt-ft5x06.h>
41
42#define MAX_SUPPORT_POINTS 5
43
44#define WORK_REGISTER_THRESHOLD 0x00
45#define WORK_REGISTER_REPORT_RATE 0x08
46#define WORK_REGISTER_GAIN 0x30
47#define WORK_REGISTER_OFFSET 0x31
48#define WORK_REGISTER_NUM_X 0x33
49#define WORK_REGISTER_NUM_Y 0x34
50
51#define M09_REGISTER_THRESHOLD 0x80
52#define M09_REGISTER_GAIN 0x92
53#define M09_REGISTER_OFFSET 0x93
54#define M09_REGISTER_NUM_X 0x94
55#define M09_REGISTER_NUM_Y 0x95
56
57#define NO_REGISTER 0xff
58
59#define WORK_REGISTER_OPMODE 0x3c
60#define FACTORY_REGISTER_OPMODE 0x01
61
62#define TOUCH_EVENT_DOWN 0x00
63#define TOUCH_EVENT_UP 0x01
64#define TOUCH_EVENT_ON 0x02
65#define TOUCH_EVENT_RESERVED 0x03
66
67#define EDT_NAME_LEN 23
68#define EDT_SWITCH_MODE_RETRIES 10
69#define EDT_SWITCH_MODE_DELAY 5 /* msec */
70#define EDT_RAW_DATA_RETRIES 100
71#define EDT_RAW_DATA_DELAY 1 /* msec */
72
73enum edt_ver {
74 M06,
75 M09,
76};
77
78struct edt_reg_addr {
79 int reg_threshold;
80 int reg_report_rate;
81 int reg_gain;
82 int reg_offset;
83 int reg_num_x;
84 int reg_num_y;
85};
86
87struct edt_ft5x06_ts_data {
88 struct i2c_client *client;
89 struct input_dev *input;
90 u16 num_x;
91 u16 num_y;
92
93 int reset_pin;
94 int irq_pin;
95 int wake_pin;
96
97#if defined(CONFIG_DEBUG_FS)
98 struct dentry *debug_dir;
99 u8 *raw_buffer;
100 size_t raw_bufsize;
101#endif
102
103 struct mutex mutex;
104 bool factory_mode;
105 int threshold;
106 int gain;
107 int offset;
108 int report_rate;
109
110 char name[EDT_NAME_LEN];
111
112 struct edt_reg_addr reg_addr;
113 enum edt_ver version;
114};
115
116static int edt_ft5x06_ts_readwrite(struct i2c_client *client,
117 u16 wr_len, u8 *wr_buf,
118 u16 rd_len, u8 *rd_buf)
119{
120 struct i2c_msg wrmsg[2];
121 int i = 0;
122 int ret;
123
124 if (wr_len) {
125 wrmsg[i].addr = client->addr;
126 wrmsg[i].flags = 0;
127 wrmsg[i].len = wr_len;
128 wrmsg[i].buf = wr_buf;
129 i++;
130 }
131 if (rd_len) {
132 wrmsg[i].addr = client->addr;
133 wrmsg[i].flags = I2C_M_RD;
134 wrmsg[i].len = rd_len;
135 wrmsg[i].buf = rd_buf;
136 i++;
137 }
138
139 ret = i2c_transfer(client->adapter, wrmsg, i);
140 if (ret < 0)
141 return ret;
142 if (ret != i)
143 return -EIO;
144
145 return 0;
146}
147
148static bool edt_ft5x06_ts_check_crc(struct edt_ft5x06_ts_data *tsdata,
149 u8 *buf, int buflen)
150{
151 int i;
152 u8 crc = 0;
153
154 for (i = 0; i < buflen - 1; i++)
155 crc ^= buf[i];
156
157 if (crc != buf[buflen-1]) {
158 dev_err_ratelimited(&tsdata->client->dev,
159 "crc error: 0x%02x expected, got 0x%02x\n",
160 crc, buf[buflen-1]);
161 return false;
162 }
163
164 return true;
165}
166
167static irqreturn_t edt_ft5x06_ts_isr(int irq, void *dev_id)
168{
169 struct edt_ft5x06_ts_data *tsdata = dev_id;
170 struct device *dev = &tsdata->client->dev;
171 u8 cmd;
172 u8 rdbuf[29];
173 int i, type, x, y, id;
174 int offset, tplen, datalen;
175 int error;
176
177 switch (tsdata->version) {
178 case M06:
179 cmd = 0xf9; /* tell the controller to send touch data */
180 offset = 5; /* where the actual touch data starts */
181 tplen = 4; /* data comes in so called frames */
182 datalen = 26; /* how much bytes to listen for */
183 break;
184
185 case M09:
186 cmd = 0x02;
187 offset = 1;
188 tplen = 6;
189 datalen = 29;
190 break;
191
192 default:
193 goto out;
194 }
195
196 memset(rdbuf, 0, sizeof(rdbuf));
197
198 error = edt_ft5x06_ts_readwrite(tsdata->client,
199 sizeof(cmd), &cmd,
200 datalen, rdbuf);
201 if (error) {
202 dev_err_ratelimited(dev, "Unable to fetch data, error: %d\n",
203 error);
204 goto out;
205 }
206
207 /* M09 does not send header or CRC */
208 if (tsdata->version == M06) {
209 if (rdbuf[0] != 0xaa || rdbuf[1] != 0xaa ||
210 rdbuf[2] != datalen) {
211 dev_err_ratelimited(dev,
212 "Unexpected header: %02x%02x%02x!\n",
213 rdbuf[0], rdbuf[1], rdbuf[2]);
214 goto out;
215 }
216
217 if (!edt_ft5x06_ts_check_crc(tsdata, rdbuf, datalen))
218 goto out;
219 }
220
221 for (i = 0; i < MAX_SUPPORT_POINTS; i++) {
222 u8 *buf = &rdbuf[i * tplen + offset];
223 bool down;
224
225 type = buf[0] >> 6;
226 /* ignore Reserved events */
227 if (type == TOUCH_EVENT_RESERVED)
228 continue;
229
230 /* M06 sometimes sends bogus coordinates in TOUCH_DOWN */
231 if (tsdata->version == M06 && type == TOUCH_EVENT_DOWN)
232 continue;
233
234 x = ((buf[0] << 8) | buf[1]) & 0x0fff;
235 y = ((buf[2] << 8) | buf[3]) & 0x0fff;
236 id = (buf[2] >> 4) & 0x0f;
237 down = type != TOUCH_EVENT_UP;
238
239 input_mt_slot(tsdata->input, id);
240 input_mt_report_slot_state(tsdata->input, MT_TOOL_FINGER, down);
241
242 if (!down)
243 continue;
244
245 input_report_abs(tsdata->input, ABS_MT_POSITION_X, x);
246 input_report_abs(tsdata->input, ABS_MT_POSITION_Y, y);
247 }
248
249 input_mt_report_pointer_emulation(tsdata->input, true);
250 input_sync(tsdata->input);
251
252out:
253 return IRQ_HANDLED;
254}
255
256static int edt_ft5x06_register_write(struct edt_ft5x06_ts_data *tsdata,
257 u8 addr, u8 value)
258{
259 u8 wrbuf[4];
260
261 switch (tsdata->version) {
262 case M06:
263 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
264 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
265 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
266 wrbuf[2] = value;
267 wrbuf[3] = wrbuf[0] ^ wrbuf[1] ^ wrbuf[2];
268 return edt_ft5x06_ts_readwrite(tsdata->client, 4,
269 wrbuf, 0, NULL);
270 case M09:
271 wrbuf[0] = addr;
272 wrbuf[1] = value;
273
274 return edt_ft5x06_ts_readwrite(tsdata->client, 3,
275 wrbuf, 0, NULL);
276
277 default:
278 return -EINVAL;
279 }
280}
281
282static int edt_ft5x06_register_read(struct edt_ft5x06_ts_data *tsdata,
283 u8 addr)
284{
285 u8 wrbuf[2], rdbuf[2];
286 int error;
287
288 switch (tsdata->version) {
289 case M06:
290 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
291 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
292 wrbuf[1] |= tsdata->factory_mode ? 0x80 : 0x40;
293
294 error = edt_ft5x06_ts_readwrite(tsdata->client, 2, wrbuf, 2,
295 rdbuf);
296 if (error)
297 return error;
298
299 if ((wrbuf[0] ^ wrbuf[1] ^ rdbuf[0]) != rdbuf[1]) {
300 dev_err(&tsdata->client->dev,
301 "crc error: 0x%02x expected, got 0x%02x\n",
302 wrbuf[0] ^ wrbuf[1] ^ rdbuf[0],
303 rdbuf[1]);
304 return -EIO;
305 }
306 break;
307
308 case M09:
309 wrbuf[0] = addr;
310 error = edt_ft5x06_ts_readwrite(tsdata->client, 1,
311 wrbuf, 1, rdbuf);
312 if (error)
313 return error;
314 break;
315
316 default:
317 return -EINVAL;
318 }
319
320 return rdbuf[0];
321}
322
323struct edt_ft5x06_attribute {
324 struct device_attribute dattr;
325 size_t field_offset;
326 u8 limit_low;
327 u8 limit_high;
328 u8 addr_m06;
329 u8 addr_m09;
330};
331
332#define EDT_ATTR(_field, _mode, _addr_m06, _addr_m09, \
333 _limit_low, _limit_high) \
334 struct edt_ft5x06_attribute edt_ft5x06_attr_##_field = { \
335 .dattr = __ATTR(_field, _mode, \
336 edt_ft5x06_setting_show, \
337 edt_ft5x06_setting_store), \
338 .field_offset = offsetof(struct edt_ft5x06_ts_data, _field), \
339 .addr_m06 = _addr_m06, \
340 .addr_m09 = _addr_m09, \
341 .limit_low = _limit_low, \
342 .limit_high = _limit_high, \
343 }
344
345static ssize_t edt_ft5x06_setting_show(struct device *dev,
346 struct device_attribute *dattr,
347 char *buf)
348{
349 struct i2c_client *client = to_i2c_client(dev);
350 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
351 struct edt_ft5x06_attribute *attr =
352 container_of(dattr, struct edt_ft5x06_attribute, dattr);
353 u8 *field = (u8 *)tsdata + attr->field_offset;
354 int val;
355 size_t count = 0;
356 int error = 0;
357 u8 addr;
358
359 mutex_lock(&tsdata->mutex);
360
361 if (tsdata->factory_mode) {
362 error = -EIO;
363 goto out;
364 }
365
366 switch (tsdata->version) {
367 case M06:
368 addr = attr->addr_m06;
369 break;
370
371 case M09:
372 addr = attr->addr_m09;
373 break;
374
375 default:
376 error = -ENODEV;
377 goto out;
378 }
379
380 if (addr != NO_REGISTER) {
381 val = edt_ft5x06_register_read(tsdata, addr);
382 if (val < 0) {
383 error = val;
384 dev_err(&tsdata->client->dev,
385 "Failed to fetch attribute %s, error %d\n",
386 dattr->attr.name, error);
387 goto out;
388 }
389 } else {
390 val = *field;
391 }
392
393 if (val != *field) {
394 dev_warn(&tsdata->client->dev,
395 "%s: read (%d) and stored value (%d) differ\n",
396 dattr->attr.name, val, *field);
397 *field = val;
398 }
399
400 count = scnprintf(buf, PAGE_SIZE, "%d\n", val);
401out:
402 mutex_unlock(&tsdata->mutex);
403 return error ?: count;
404}
405
406static ssize_t edt_ft5x06_setting_store(struct device *dev,
407 struct device_attribute *dattr,
408 const char *buf, size_t count)
409{
410 struct i2c_client *client = to_i2c_client(dev);
411 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
412 struct edt_ft5x06_attribute *attr =
413 container_of(dattr, struct edt_ft5x06_attribute, dattr);
414 u8 *field = (u8 *)tsdata + attr->field_offset;
415 unsigned int val;
416 int error;
417 u8 addr;
418
419 mutex_lock(&tsdata->mutex);
420
421 if (tsdata->factory_mode) {
422 error = -EIO;
423 goto out;
424 }
425
426 error = kstrtouint(buf, 0, &val);
427 if (error)
428 goto out;
429
430 if (val < attr->limit_low || val > attr->limit_high) {
431 error = -ERANGE;
432 goto out;
433 }
434
435 switch (tsdata->version) {
436 case M06:
437 addr = attr->addr_m06;
438 break;
439
440 case M09:
441 addr = attr->addr_m09;
442 break;
443
444 default:
445 error = -ENODEV;
446 goto out;
447 }
448
449 if (addr != NO_REGISTER) {
450 error = edt_ft5x06_register_write(tsdata, addr, val);
451 if (error) {
452 dev_err(&tsdata->client->dev,
453 "Failed to update attribute %s, error: %d\n",
454 dattr->attr.name, error);
455 goto out;
456 }
457 }
458 *field = val;
459
460out:
461 mutex_unlock(&tsdata->mutex);
462 return error ?: count;
463}
464
465static EDT_ATTR(gain, S_IWUSR | S_IRUGO, WORK_REGISTER_GAIN,
466 M09_REGISTER_GAIN, 0, 31);
467static EDT_ATTR(offset, S_IWUSR | S_IRUGO, WORK_REGISTER_OFFSET,
468 M09_REGISTER_OFFSET, 0, 31);
469static EDT_ATTR(threshold, S_IWUSR | S_IRUGO, WORK_REGISTER_THRESHOLD,
470 M09_REGISTER_THRESHOLD, 20, 80);
471static EDT_ATTR(report_rate, S_IWUSR | S_IRUGO, WORK_REGISTER_REPORT_RATE,
472 NO_REGISTER, 3, 14);
473
474static struct attribute *edt_ft5x06_attrs[] = {
475 &edt_ft5x06_attr_gain.dattr.attr,
476 &edt_ft5x06_attr_offset.dattr.attr,
477 &edt_ft5x06_attr_threshold.dattr.attr,
478 &edt_ft5x06_attr_report_rate.dattr.attr,
479 NULL
480};
481
482static const struct attribute_group edt_ft5x06_attr_group = {
483 .attrs = edt_ft5x06_attrs,
484};
485
486#ifdef CONFIG_DEBUG_FS
487static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
488{
489 struct i2c_client *client = tsdata->client;
490 int retries = EDT_SWITCH_MODE_RETRIES;
491 int ret;
492 int error;
493
494 disable_irq(client->irq);
495
496 if (!tsdata->raw_buffer) {
497 tsdata->raw_bufsize = tsdata->num_x * tsdata->num_y *
498 sizeof(u16);
499 tsdata->raw_buffer = kzalloc(tsdata->raw_bufsize, GFP_KERNEL);
500 if (!tsdata->raw_buffer) {
501 error = -ENOMEM;
502 goto err_out;
503 }
504 }
505
506 /* mode register is 0x3c when in the work mode */
507 if (tsdata->version == M09)
508 goto m09_out;
509
510 error = edt_ft5x06_register_write(tsdata, WORK_REGISTER_OPMODE, 0x03);
511 if (error) {
512 dev_err(&client->dev,
513 "failed to switch to factory mode, error %d\n", error);
514 goto err_out;
515 }
516
517 tsdata->factory_mode = true;
518 do {
519 mdelay(EDT_SWITCH_MODE_DELAY);
520 /* mode register is 0x01 when in factory mode */
521 ret = edt_ft5x06_register_read(tsdata, FACTORY_REGISTER_OPMODE);
522 if (ret == 0x03)
523 break;
524 } while (--retries > 0);
525
526 if (retries == 0) {
527 dev_err(&client->dev, "not in factory mode after %dms.\n",
528 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
529 error = -EIO;
530 goto err_out;
531 }
532
533 return 0;
534
535err_out:
536 kfree(tsdata->raw_buffer);
537 tsdata->raw_buffer = NULL;
538 tsdata->factory_mode = false;
539 enable_irq(client->irq);
540
541 return error;
542
543m09_out:
544 dev_err(&client->dev, "No factory mode support for M09\n");
545 return -EINVAL;
546
547}
548
549static int edt_ft5x06_work_mode(struct edt_ft5x06_ts_data *tsdata)
550{
551 struct i2c_client *client = tsdata->client;
552 int retries = EDT_SWITCH_MODE_RETRIES;
553 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
554 int ret;
555 int error;
556
557 /* mode register is 0x01 when in the factory mode */
558 error = edt_ft5x06_register_write(tsdata, FACTORY_REGISTER_OPMODE, 0x1);
559 if (error) {
560 dev_err(&client->dev,
561 "failed to switch to work mode, error: %d\n", error);
562 return error;
563 }
564
565 tsdata->factory_mode = false;
566
567 do {
568 mdelay(EDT_SWITCH_MODE_DELAY);
569 /* mode register is 0x01 when in factory mode */
570 ret = edt_ft5x06_register_read(tsdata, WORK_REGISTER_OPMODE);
571 if (ret == 0x01)
572 break;
573 } while (--retries > 0);
574
575 if (retries == 0) {
576 dev_err(&client->dev, "not in work mode after %dms.\n",
577 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
578 tsdata->factory_mode = true;
579 return -EIO;
580 }
581
582 kfree(tsdata->raw_buffer);
583 tsdata->raw_buffer = NULL;
584
585 /* restore parameters */
586 edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold,
587 tsdata->threshold);
588 edt_ft5x06_register_write(tsdata, reg_addr->reg_gain,
589 tsdata->gain);
590 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset,
591 tsdata->offset);
592 if (reg_addr->reg_report_rate)
593 edt_ft5x06_register_write(tsdata, reg_addr->reg_report_rate,
594 tsdata->report_rate);
595
596 enable_irq(client->irq);
597
598 return 0;
599}
600
601static int edt_ft5x06_debugfs_mode_get(void *data, u64 *mode)
602{
603 struct edt_ft5x06_ts_data *tsdata = data;
604
605 *mode = tsdata->factory_mode;
606
607 return 0;
608};
609
610static int edt_ft5x06_debugfs_mode_set(void *data, u64 mode)
611{
612 struct edt_ft5x06_ts_data *tsdata = data;
613 int retval = 0;
614
615 if (mode > 1)
616 return -ERANGE;
617
618 mutex_lock(&tsdata->mutex);
619
620 if (mode != tsdata->factory_mode) {
621 retval = mode ? edt_ft5x06_factory_mode(tsdata) :
622 edt_ft5x06_work_mode(tsdata);
623 }
624
625 mutex_unlock(&tsdata->mutex);
626
627 return retval;
628};
629
630DEFINE_SIMPLE_ATTRIBUTE(debugfs_mode_fops, edt_ft5x06_debugfs_mode_get,
631 edt_ft5x06_debugfs_mode_set, "%llu\n");
632
633static ssize_t edt_ft5x06_debugfs_raw_data_read(struct file *file,
634 char __user *buf, size_t count, loff_t *off)
635{
636 struct edt_ft5x06_ts_data *tsdata = file->private_data;
637 struct i2c_client *client = tsdata->client;
638 int retries = EDT_RAW_DATA_RETRIES;
639 int val, i, error;
640 size_t read = 0;
641 int colbytes;
642 char wrbuf[3];
643 u8 *rdbuf;
644
645 if (*off < 0 || *off >= tsdata->raw_bufsize)
646 return 0;
647
648 mutex_lock(&tsdata->mutex);
649
650 if (!tsdata->factory_mode || !tsdata->raw_buffer) {
651 error = -EIO;
652 goto out;
653 }
654
655 error = edt_ft5x06_register_write(tsdata, 0x08, 0x01);
656 if (error) {
657 dev_dbg(&client->dev,
658 "failed to write 0x08 register, error %d\n", error);
659 goto out;
660 }
661
662 do {
663 msleep(EDT_RAW_DATA_DELAY);
664 val = edt_ft5x06_register_read(tsdata, 0x08);
665 if (val < 1)
666 break;
667 } while (--retries > 0);
668
669 if (val < 0) {
670 error = val;
671 dev_dbg(&client->dev,
672 "failed to read 0x08 register, error %d\n", error);
673 goto out;
674 }
675
676 if (retries == 0) {
677 dev_dbg(&client->dev,
678 "timed out waiting for register to settle\n");
679 error = -ETIMEDOUT;
680 goto out;
681 }
682
683 rdbuf = tsdata->raw_buffer;
684 colbytes = tsdata->num_y * sizeof(u16);
685
686 wrbuf[0] = 0xf5;
687 wrbuf[1] = 0x0e;
688 for (i = 0; i < tsdata->num_x; i++) {
689 wrbuf[2] = i; /* column index */
690 error = edt_ft5x06_ts_readwrite(tsdata->client,
691 sizeof(wrbuf), wrbuf,
692 colbytes, rdbuf);
693 if (error)
694 goto out;
695
696 rdbuf += colbytes;
697 }
698
699 read = min_t(size_t, count, tsdata->raw_bufsize - *off);
700 if (copy_to_user(buf, tsdata->raw_buffer + *off, read)) {
701 error = -EFAULT;
702 goto out;
703 }
704
705 *off += read;
706out:
707 mutex_unlock(&tsdata->mutex);
708 return error ?: read;
709};
710
711static const struct file_operations debugfs_raw_data_fops = {
712 .open = simple_open,
713 .read = edt_ft5x06_debugfs_raw_data_read,
714};
715
716static void
717edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
718 const char *debugfs_name)
719{
720 tsdata->debug_dir = debugfs_create_dir(debugfs_name, NULL);
721 if (!tsdata->debug_dir)
722 return;
723
724 debugfs_create_u16("num_x", S_IRUSR, tsdata->debug_dir, &tsdata->num_x);
725 debugfs_create_u16("num_y", S_IRUSR, tsdata->debug_dir, &tsdata->num_y);
726
727 debugfs_create_file("mode", S_IRUSR | S_IWUSR,
728 tsdata->debug_dir, tsdata, &debugfs_mode_fops);
729 debugfs_create_file("raw_data", S_IRUSR,
730 tsdata->debug_dir, tsdata, &debugfs_raw_data_fops);
731}
732
733static void
734edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
735{
736 if (tsdata->debug_dir)
737 debugfs_remove_recursive(tsdata->debug_dir);
738 kfree(tsdata->raw_buffer);
739}
740
741#else
742
743static inline void
744edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
745 const char *debugfs_name)
746{
747}
748
749static inline void
750edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
751{
752}
753
754#endif /* CONFIG_DEBUGFS */
755
756static int edt_ft5x06_ts_reset(struct i2c_client *client,
757 struct edt_ft5x06_ts_data *tsdata)
758{
759 int error;
760
761 if (gpio_is_valid(tsdata->wake_pin)) {
762 error = devm_gpio_request_one(&client->dev,
763 tsdata->wake_pin, GPIOF_OUT_INIT_LOW,
764 "edt-ft5x06 wake");
765 if (error) {
766 dev_err(&client->dev,
767 "Failed to request GPIO %d as wake pin, error %d\n",
768 tsdata->wake_pin, error);
769 return error;
770 }
771
772 msleep(5);
773 gpio_set_value(tsdata->wake_pin, 1);
774 }
775 if (gpio_is_valid(tsdata->reset_pin)) {
776 /* this pulls reset down, enabling the low active reset */
777 error = devm_gpio_request_one(&client->dev,
778 tsdata->reset_pin, GPIOF_OUT_INIT_LOW,
779 "edt-ft5x06 reset");
780 if (error) {
781 dev_err(&client->dev,
782 "Failed to request GPIO %d as reset pin, error %d\n",
783 tsdata->reset_pin, error);
784 return error;
785 }
786
787 msleep(5);
788 gpio_set_value(tsdata->reset_pin, 1);
789 msleep(300);
790 }
791
792 return 0;
793}
794
795static int edt_ft5x06_ts_identify(struct i2c_client *client,
796 struct edt_ft5x06_ts_data *tsdata,
797 char *fw_version)
798{
799 u8 rdbuf[EDT_NAME_LEN];
800 char *p;
801 int error;
802 char *model_name = tsdata->name;
803
804 /* see what we find if we assume it is a M06 *
805 * if we get less than EDT_NAME_LEN, we don't want
806 * to have garbage in there
807 */
808 memset(rdbuf, 0, sizeof(rdbuf));
809 error = edt_ft5x06_ts_readwrite(client, 1, "\xbb",
810 EDT_NAME_LEN - 1, rdbuf);
811 if (error)
812 return error;
813
814 /* if we find something consistent, stay with that assumption
815 * at least M09 won't send 3 bytes here
816 */
817 if (!(strnicmp(rdbuf + 1, "EP0", 3))) {
818 tsdata->version = M06;
819
820 /* remove last '$' end marker */
821 rdbuf[EDT_NAME_LEN - 1] = '\0';
822 if (rdbuf[EDT_NAME_LEN - 2] == '$')
823 rdbuf[EDT_NAME_LEN - 2] = '\0';
824
825 /* look for Model/Version separator */
826 p = strchr(rdbuf, '*');
827 if (p)
828 *p++ = '\0';
829 strlcpy(model_name, rdbuf + 1, EDT_NAME_LEN);
830 strlcpy(fw_version, p ? p : "", EDT_NAME_LEN);
831 } else {
832 /* since there are only two versions around (M06, M09) */
833 tsdata->version = M09;
834
835 error = edt_ft5x06_ts_readwrite(client, 1, "\xA6",
836 2, rdbuf);
837 if (error)
838 return error;
839
840 strlcpy(fw_version, rdbuf, 2);
841
842 error = edt_ft5x06_ts_readwrite(client, 1, "\xA8",
843 1, rdbuf);
844 if (error)
845 return error;
846
847 snprintf(model_name, EDT_NAME_LEN, "EP0%i%i0M09",
848 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
849 }
850
851 return 0;
852}
853
854#define EDT_ATTR_CHECKSET(name, reg) \
855 if (pdata->name >= edt_ft5x06_attr_##name.limit_low && \
856 pdata->name <= edt_ft5x06_attr_##name.limit_high) \
857 edt_ft5x06_register_write(tsdata, reg, pdata->name)
858
859#define EDT_GET_PROP(name, reg) { \
860 u32 val; \
861 if (of_property_read_u32(np, #name, &val) == 0) \
862 edt_ft5x06_register_write(tsdata, reg, val); \
863}
864
865static void edt_ft5x06_ts_get_dt_defaults(struct device_node *np,
866 struct edt_ft5x06_ts_data *tsdata)
867{
868 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
869
870 EDT_GET_PROP(threshold, reg_addr->reg_threshold);
871 EDT_GET_PROP(gain, reg_addr->reg_gain);
872 EDT_GET_PROP(offset, reg_addr->reg_offset);
873}
874
875static void
876edt_ft5x06_ts_get_defaults(struct edt_ft5x06_ts_data *tsdata,
877 const struct edt_ft5x06_platform_data *pdata)
878{
879 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
880
881 if (!pdata->use_parameters)
882 return;
883
884 /* pick up defaults from the platform data */
885 EDT_ATTR_CHECKSET(threshold, reg_addr->reg_threshold);
886 EDT_ATTR_CHECKSET(gain, reg_addr->reg_gain);
887 EDT_ATTR_CHECKSET(offset, reg_addr->reg_offset);
888 if (reg_addr->reg_report_rate != NO_REGISTER)
889 EDT_ATTR_CHECKSET(report_rate, reg_addr->reg_report_rate);
890}
891
892static void
893edt_ft5x06_ts_get_parameters(struct edt_ft5x06_ts_data *tsdata)
894{
895 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
896
897 tsdata->threshold = edt_ft5x06_register_read(tsdata,
898 reg_addr->reg_threshold);
899 tsdata->gain = edt_ft5x06_register_read(tsdata, reg_addr->reg_gain);
900 tsdata->offset = edt_ft5x06_register_read(tsdata, reg_addr->reg_offset);
901 if (reg_addr->reg_report_rate != NO_REGISTER)
902 tsdata->report_rate = edt_ft5x06_register_read(tsdata,
903 reg_addr->reg_report_rate);
904 tsdata->num_x = edt_ft5x06_register_read(tsdata, reg_addr->reg_num_x);
905 tsdata->num_y = edt_ft5x06_register_read(tsdata, reg_addr->reg_num_y);
906}
907
908static void
909edt_ft5x06_ts_set_regs(struct edt_ft5x06_ts_data *tsdata)
910{
911 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
912
913 switch (tsdata->version) {
914 case M06:
915 reg_addr->reg_threshold = WORK_REGISTER_THRESHOLD;
916 reg_addr->reg_report_rate = WORK_REGISTER_REPORT_RATE;
917 reg_addr->reg_gain = WORK_REGISTER_GAIN;
918 reg_addr->reg_offset = WORK_REGISTER_OFFSET;
919 reg_addr->reg_num_x = WORK_REGISTER_NUM_X;
920 reg_addr->reg_num_y = WORK_REGISTER_NUM_Y;
921 break;
922
923 case M09:
924 reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
925 reg_addr->reg_gain = M09_REGISTER_GAIN;
926 reg_addr->reg_offset = M09_REGISTER_OFFSET;
927 reg_addr->reg_num_x = M09_REGISTER_NUM_X;
928 reg_addr->reg_num_y = M09_REGISTER_NUM_Y;
929 break;
930 }
931}
932
933#ifdef CONFIG_OF
934static int edt_ft5x06_i2c_ts_probe_dt(struct device *dev,
935 struct edt_ft5x06_ts_data *tsdata)
936{
937 struct device_node *np = dev->of_node;
938
939 /*
940 * irq_pin is not needed for DT setup.
941 * irq is associated via 'interrupts' property in DT
942 */
943 tsdata->irq_pin = -EINVAL;
944 tsdata->reset_pin = of_get_named_gpio(np, "reset-gpios", 0);
945 tsdata->wake_pin = of_get_named_gpio(np, "wake-gpios", 0);
946
947 return 0;
948}
949#else
950static inline int edt_ft5x06_i2c_ts_probe_dt(struct device *dev,
951 struct edt_ft5x06_ts_data *tsdata)
952{
953 return -ENODEV;
954}
955#endif
956
957static int edt_ft5x06_ts_probe(struct i2c_client *client,
958 const struct i2c_device_id *id)
959{
960 const struct edt_ft5x06_platform_data *pdata =
961 dev_get_platdata(&client->dev);
962 struct edt_ft5x06_ts_data *tsdata;
963 struct input_dev *input;
964 int error;
965 char fw_version[EDT_NAME_LEN];
966
967 dev_dbg(&client->dev, "probing for EDT FT5x06 I2C\n");
968
969 tsdata = devm_kzalloc(&client->dev, sizeof(*tsdata), GFP_KERNEL);
970 if (!tsdata) {
971 dev_err(&client->dev, "failed to allocate driver data.\n");
972 return -ENOMEM;
973 }
974
975 if (!pdata) {
976 error = edt_ft5x06_i2c_ts_probe_dt(&client->dev, tsdata);
977 if (error) {
978 dev_err(&client->dev,
979 "DT probe failed and no platform data present\n");
980 return error;
981 }
982 } else {
983 tsdata->reset_pin = pdata->reset_pin;
984 tsdata->irq_pin = pdata->irq_pin;
985 tsdata->wake_pin = -EINVAL;
986 }
987
988 error = edt_ft5x06_ts_reset(client, tsdata);
989 if (error)
990 return error;
991
992 if (gpio_is_valid(tsdata->irq_pin)) {
993 error = devm_gpio_request_one(&client->dev, tsdata->irq_pin,
994 GPIOF_IN, "edt-ft5x06 irq");
995 if (error) {
996 dev_err(&client->dev,
997 "Failed to request GPIO %d, error %d\n",
998 tsdata->irq_pin, error);
999 return error;
1000 }
1001 }
1002
1003 input = devm_input_allocate_device(&client->dev);
1004 if (!input) {
1005 dev_err(&client->dev, "failed to allocate input device.\n");
1006 return -ENOMEM;
1007 }
1008
1009 mutex_init(&tsdata->mutex);
1010 tsdata->client = client;
1011 tsdata->input = input;
1012 tsdata->factory_mode = false;
1013
1014 error = edt_ft5x06_ts_identify(client, tsdata, fw_version);
1015 if (error) {
1016 dev_err(&client->dev, "touchscreen probe failed\n");
1017 return error;
1018 }
1019
1020 edt_ft5x06_ts_set_regs(tsdata);
1021
1022 if (!pdata)
1023 edt_ft5x06_ts_get_dt_defaults(client->dev.of_node, tsdata);
1024 else
1025 edt_ft5x06_ts_get_defaults(tsdata, pdata);
1026
1027 edt_ft5x06_ts_get_parameters(tsdata);
1028
1029 dev_dbg(&client->dev,
1030 "Model \"%s\", Rev. \"%s\", %dx%d sensors\n",
1031 tsdata->name, fw_version, tsdata->num_x, tsdata->num_y);
1032
1033 input->name = tsdata->name;
1034 input->id.bustype = BUS_I2C;
1035 input->dev.parent = &client->dev;
1036
1037 __set_bit(EV_SYN, input->evbit);
1038 __set_bit(EV_KEY, input->evbit);
1039 __set_bit(EV_ABS, input->evbit);
1040 __set_bit(BTN_TOUCH, input->keybit);
1041 input_set_abs_params(input, ABS_X, 0, tsdata->num_x * 64 - 1, 0, 0);
1042 input_set_abs_params(input, ABS_Y, 0, tsdata->num_y * 64 - 1, 0, 0);
1043 input_set_abs_params(input, ABS_MT_POSITION_X,
1044 0, tsdata->num_x * 64 - 1, 0, 0);
1045 input_set_abs_params(input, ABS_MT_POSITION_Y,
1046 0, tsdata->num_y * 64 - 1, 0, 0);
1047 error = input_mt_init_slots(input, MAX_SUPPORT_POINTS, 0);
1048 if (error) {
1049 dev_err(&client->dev, "Unable to init MT slots.\n");
1050 return error;
1051 }
1052
1053 input_set_drvdata(input, tsdata);
1054 i2c_set_clientdata(client, tsdata);
1055
1056 error = devm_request_threaded_irq(&client->dev, client->irq, NULL,
1057 edt_ft5x06_ts_isr,
1058 IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
1059 client->name, tsdata);
1060 if (error) {
1061 dev_err(&client->dev, "Unable to request touchscreen IRQ.\n");
1062 return error;
1063 }
1064
1065 error = sysfs_create_group(&client->dev.kobj, &edt_ft5x06_attr_group);
1066 if (error)
1067 return error;
1068
1069 error = input_register_device(input);
1070 if (error)
1071 goto err_remove_attrs;
1072
1073 edt_ft5x06_ts_prepare_debugfs(tsdata, dev_driver_string(&client->dev));
1074 device_init_wakeup(&client->dev, 1);
1075
1076 dev_dbg(&client->dev,
1077 "EDT FT5x06 initialized: IRQ %d, WAKE pin %d, Reset pin %d.\n",
1078 client->irq, tsdata->wake_pin, tsdata->reset_pin);
1079
1080 return 0;
1081
1082err_remove_attrs:
1083 sysfs_remove_group(&client->dev.kobj, &edt_ft5x06_attr_group);
1084 return error;
1085}
1086
1087static int edt_ft5x06_ts_remove(struct i2c_client *client)
1088{
1089 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1090
1091 edt_ft5x06_ts_teardown_debugfs(tsdata);
1092 sysfs_remove_group(&client->dev.kobj, &edt_ft5x06_attr_group);
1093
1094 return 0;
1095}
1096
1097#ifdef CONFIG_PM_SLEEP
1098static int edt_ft5x06_ts_suspend(struct device *dev)
1099{
1100 struct i2c_client *client = to_i2c_client(dev);
1101
1102 if (device_may_wakeup(dev))
1103 enable_irq_wake(client->irq);
1104
1105 return 0;
1106}
1107
1108static int edt_ft5x06_ts_resume(struct device *dev)
1109{
1110 struct i2c_client *client = to_i2c_client(dev);
1111
1112 if (device_may_wakeup(dev))
1113 disable_irq_wake(client->irq);
1114
1115 return 0;
1116}
1117#endif
1118
1119static SIMPLE_DEV_PM_OPS(edt_ft5x06_ts_pm_ops,
1120 edt_ft5x06_ts_suspend, edt_ft5x06_ts_resume);
1121
1122static const struct i2c_device_id edt_ft5x06_ts_id[] = {
1123 { "edt-ft5x06", 0, },
1124 { /* sentinel */ }
1125};
1126MODULE_DEVICE_TABLE(i2c, edt_ft5x06_ts_id);
1127
1128#ifdef CONFIG_OF
1129static const struct of_device_id edt_ft5x06_of_match[] = {
1130 { .compatible = "edt,edt-ft5206", },
1131 { .compatible = "edt,edt-ft5306", },
1132 { .compatible = "edt,edt-ft5406", },
1133 { /* sentinel */ }
1134};
1135MODULE_DEVICE_TABLE(of, edt_ft5x06_of_match);
1136#endif
1137
1138static struct i2c_driver edt_ft5x06_ts_driver = {
1139 .driver = {
1140 .owner = THIS_MODULE,
1141 .name = "edt_ft5x06",
1142 .of_match_table = of_match_ptr(edt_ft5x06_of_match),
1143 .pm = &edt_ft5x06_ts_pm_ops,
1144 },
1145 .id_table = edt_ft5x06_ts_id,
1146 .probe = edt_ft5x06_ts_probe,
1147 .remove = edt_ft5x06_ts_remove,
1148};
1149
1150module_i2c_driver(edt_ft5x06_ts_driver);
1151
1152MODULE_AUTHOR("Simon Budig <simon.budig@kernelconcepts.de>");
1153MODULE_DESCRIPTION("EDT FT5x06 I2C Touchscreen Driver");
1154MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0
2/*
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)
6 */
7
8/*
9 * This is a driver for the EDT "Polytouch" family of touch controllers
10 * based on the FocalTech FT5x06 line of chips.
11 *
12 * Development of this driver has been sponsored by Glyn:
13 * http://www.glyn.com/Products/Displays
14 */
15
16#include <linux/module.h>
17#include <linux/ratelimit.h>
18#include <linux/irq.h>
19#include <linux/interrupt.h>
20#include <linux/input.h>
21#include <linux/i2c.h>
22#include <linux/kernel.h>
23#include <linux/uaccess.h>
24#include <linux/delay.h>
25#include <linux/debugfs.h>
26#include <linux/slab.h>
27#include <linux/gpio/consumer.h>
28#include <linux/input/mt.h>
29#include <linux/input/touchscreen.h>
30#include <asm/unaligned.h>
31
32#define WORK_REGISTER_THRESHOLD 0x00
33#define WORK_REGISTER_REPORT_RATE 0x08
34#define WORK_REGISTER_GAIN 0x30
35#define WORK_REGISTER_OFFSET 0x31
36#define WORK_REGISTER_NUM_X 0x33
37#define WORK_REGISTER_NUM_Y 0x34
38
39#define M09_REGISTER_THRESHOLD 0x80
40#define M09_REGISTER_GAIN 0x92
41#define M09_REGISTER_OFFSET 0x93
42#define M09_REGISTER_NUM_X 0x94
43#define M09_REGISTER_NUM_Y 0x95
44
45#define EV_REGISTER_THRESHOLD 0x40
46#define EV_REGISTER_GAIN 0x41
47#define EV_REGISTER_OFFSET_Y 0x45
48#define EV_REGISTER_OFFSET_X 0x46
49
50#define NO_REGISTER 0xff
51
52#define WORK_REGISTER_OPMODE 0x3c
53#define FACTORY_REGISTER_OPMODE 0x01
54
55#define TOUCH_EVENT_DOWN 0x00
56#define TOUCH_EVENT_UP 0x01
57#define TOUCH_EVENT_ON 0x02
58#define TOUCH_EVENT_RESERVED 0x03
59
60#define EDT_NAME_LEN 23
61#define EDT_SWITCH_MODE_RETRIES 10
62#define EDT_SWITCH_MODE_DELAY 5 /* msec */
63#define EDT_RAW_DATA_RETRIES 100
64#define EDT_RAW_DATA_DELAY 1000 /* usec */
65
66enum edt_ver {
67 EDT_M06,
68 EDT_M09,
69 EDT_M12,
70 EV_FT,
71 GENERIC_FT,
72};
73
74struct edt_reg_addr {
75 int reg_threshold;
76 int reg_report_rate;
77 int reg_gain;
78 int reg_offset;
79 int reg_offset_x;
80 int reg_offset_y;
81 int reg_num_x;
82 int reg_num_y;
83};
84
85struct edt_ft5x06_ts_data {
86 struct i2c_client *client;
87 struct input_dev *input;
88 struct touchscreen_properties prop;
89 u16 num_x;
90 u16 num_y;
91
92 struct gpio_desc *reset_gpio;
93 struct gpio_desc *wake_gpio;
94
95#if defined(CONFIG_DEBUG_FS)
96 struct dentry *debug_dir;
97 u8 *raw_buffer;
98 size_t raw_bufsize;
99#endif
100
101 struct mutex mutex;
102 bool factory_mode;
103 int threshold;
104 int gain;
105 int offset;
106 int offset_x;
107 int offset_y;
108 int report_rate;
109 int max_support_points;
110
111 char name[EDT_NAME_LEN];
112
113 struct edt_reg_addr reg_addr;
114 enum edt_ver version;
115};
116
117struct edt_i2c_chip_data {
118 int max_support_points;
119};
120
121static int edt_ft5x06_ts_readwrite(struct i2c_client *client,
122 u16 wr_len, u8 *wr_buf,
123 u16 rd_len, u8 *rd_buf)
124{
125 struct i2c_msg wrmsg[2];
126 int i = 0;
127 int ret;
128
129 if (wr_len) {
130 wrmsg[i].addr = client->addr;
131 wrmsg[i].flags = 0;
132 wrmsg[i].len = wr_len;
133 wrmsg[i].buf = wr_buf;
134 i++;
135 }
136 if (rd_len) {
137 wrmsg[i].addr = client->addr;
138 wrmsg[i].flags = I2C_M_RD;
139 wrmsg[i].len = rd_len;
140 wrmsg[i].buf = rd_buf;
141 i++;
142 }
143
144 ret = i2c_transfer(client->adapter, wrmsg, i);
145 if (ret < 0)
146 return ret;
147 if (ret != i)
148 return -EIO;
149
150 return 0;
151}
152
153static bool edt_ft5x06_ts_check_crc(struct edt_ft5x06_ts_data *tsdata,
154 u8 *buf, int buflen)
155{
156 int i;
157 u8 crc = 0;
158
159 for (i = 0; i < buflen - 1; i++)
160 crc ^= buf[i];
161
162 if (crc != buf[buflen-1]) {
163 dev_err_ratelimited(&tsdata->client->dev,
164 "crc error: 0x%02x expected, got 0x%02x\n",
165 crc, buf[buflen-1]);
166 return false;
167 }
168
169 return true;
170}
171
172static irqreturn_t edt_ft5x06_ts_isr(int irq, void *dev_id)
173{
174 struct edt_ft5x06_ts_data *tsdata = dev_id;
175 struct device *dev = &tsdata->client->dev;
176 u8 cmd;
177 u8 rdbuf[63];
178 int i, type, x, y, id;
179 int offset, tplen, datalen, crclen;
180 int error;
181
182 switch (tsdata->version) {
183 case EDT_M06:
184 cmd = 0xf9; /* tell the controller to send touch data */
185 offset = 5; /* where the actual touch data starts */
186 tplen = 4; /* data comes in so called frames */
187 crclen = 1; /* length of the crc data */
188 break;
189
190 case EDT_M09:
191 case EDT_M12:
192 case EV_FT:
193 case GENERIC_FT:
194 cmd = 0x0;
195 offset = 3;
196 tplen = 6;
197 crclen = 0;
198 break;
199
200 default:
201 goto out;
202 }
203
204 memset(rdbuf, 0, sizeof(rdbuf));
205 datalen = tplen * tsdata->max_support_points + offset + crclen;
206
207 error = edt_ft5x06_ts_readwrite(tsdata->client,
208 sizeof(cmd), &cmd,
209 datalen, rdbuf);
210 if (error) {
211 dev_err_ratelimited(dev, "Unable to fetch data, error: %d\n",
212 error);
213 goto out;
214 }
215
216 /* M09/M12 does not send header or CRC */
217 if (tsdata->version == EDT_M06) {
218 if (rdbuf[0] != 0xaa || rdbuf[1] != 0xaa ||
219 rdbuf[2] != datalen) {
220 dev_err_ratelimited(dev,
221 "Unexpected header: %02x%02x%02x!\n",
222 rdbuf[0], rdbuf[1], rdbuf[2]);
223 goto out;
224 }
225
226 if (!edt_ft5x06_ts_check_crc(tsdata, rdbuf, datalen))
227 goto out;
228 }
229
230 for (i = 0; i < tsdata->max_support_points; i++) {
231 u8 *buf = &rdbuf[i * tplen + offset];
232
233 type = buf[0] >> 6;
234 /* ignore Reserved events */
235 if (type == TOUCH_EVENT_RESERVED)
236 continue;
237
238 /* M06 sometimes sends bogus coordinates in TOUCH_DOWN */
239 if (tsdata->version == EDT_M06 && type == TOUCH_EVENT_DOWN)
240 continue;
241
242 x = get_unaligned_be16(buf) & 0x0fff;
243 y = get_unaligned_be16(buf + 2) & 0x0fff;
244 /* The FT5x26 send the y coordinate first */
245 if (tsdata->version == EV_FT)
246 swap(x, y);
247
248 id = (buf[2] >> 4) & 0x0f;
249
250 input_mt_slot(tsdata->input, id);
251 if (input_mt_report_slot_state(tsdata->input, MT_TOOL_FINGER,
252 type != TOUCH_EVENT_UP))
253 touchscreen_report_pos(tsdata->input, &tsdata->prop,
254 x, y, true);
255 }
256
257 input_mt_report_pointer_emulation(tsdata->input, true);
258 input_sync(tsdata->input);
259
260out:
261 return IRQ_HANDLED;
262}
263
264static int edt_ft5x06_register_write(struct edt_ft5x06_ts_data *tsdata,
265 u8 addr, u8 value)
266{
267 u8 wrbuf[4];
268
269 switch (tsdata->version) {
270 case EDT_M06:
271 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
272 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
273 wrbuf[2] = value;
274 wrbuf[3] = wrbuf[0] ^ wrbuf[1] ^ wrbuf[2];
275 return edt_ft5x06_ts_readwrite(tsdata->client, 4,
276 wrbuf, 0, NULL);
277 /* fallthrough */
278 case EDT_M09:
279 case EDT_M12:
280 case EV_FT:
281 case GENERIC_FT:
282 wrbuf[0] = addr;
283 wrbuf[1] = value;
284
285 return edt_ft5x06_ts_readwrite(tsdata->client, 2,
286 wrbuf, 0, NULL);
287
288 default:
289 return -EINVAL;
290 }
291}
292
293static int edt_ft5x06_register_read(struct edt_ft5x06_ts_data *tsdata,
294 u8 addr)
295{
296 u8 wrbuf[2], rdbuf[2];
297 int error;
298
299 switch (tsdata->version) {
300 case EDT_M06:
301 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
302 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
303 wrbuf[1] |= tsdata->factory_mode ? 0x80 : 0x40;
304
305 error = edt_ft5x06_ts_readwrite(tsdata->client, 2, wrbuf, 2,
306 rdbuf);
307 if (error)
308 return error;
309
310 if ((wrbuf[0] ^ wrbuf[1] ^ rdbuf[0]) != rdbuf[1]) {
311 dev_err(&tsdata->client->dev,
312 "crc error: 0x%02x expected, got 0x%02x\n",
313 wrbuf[0] ^ wrbuf[1] ^ rdbuf[0],
314 rdbuf[1]);
315 return -EIO;
316 }
317 break;
318
319 /* fallthrough */
320 case EDT_M09:
321 case EDT_M12:
322 case EV_FT:
323 case GENERIC_FT:
324 wrbuf[0] = addr;
325 error = edt_ft5x06_ts_readwrite(tsdata->client, 1,
326 wrbuf, 1, rdbuf);
327 if (error)
328 return error;
329 break;
330
331 default:
332 return -EINVAL;
333 }
334
335 return rdbuf[0];
336}
337
338struct edt_ft5x06_attribute {
339 struct device_attribute dattr;
340 size_t field_offset;
341 u8 limit_low;
342 u8 limit_high;
343 u8 addr_m06;
344 u8 addr_m09;
345 u8 addr_ev;
346};
347
348#define EDT_ATTR(_field, _mode, _addr_m06, _addr_m09, _addr_ev, \
349 _limit_low, _limit_high) \
350 struct edt_ft5x06_attribute edt_ft5x06_attr_##_field = { \
351 .dattr = __ATTR(_field, _mode, \
352 edt_ft5x06_setting_show, \
353 edt_ft5x06_setting_store), \
354 .field_offset = offsetof(struct edt_ft5x06_ts_data, _field), \
355 .addr_m06 = _addr_m06, \
356 .addr_m09 = _addr_m09, \
357 .addr_ev = _addr_ev, \
358 .limit_low = _limit_low, \
359 .limit_high = _limit_high, \
360 }
361
362static ssize_t edt_ft5x06_setting_show(struct device *dev,
363 struct device_attribute *dattr,
364 char *buf)
365{
366 struct i2c_client *client = to_i2c_client(dev);
367 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
368 struct edt_ft5x06_attribute *attr =
369 container_of(dattr, struct edt_ft5x06_attribute, dattr);
370 u8 *field = (u8 *)tsdata + attr->field_offset;
371 int val;
372 size_t count = 0;
373 int error = 0;
374 u8 addr;
375
376 mutex_lock(&tsdata->mutex);
377
378 if (tsdata->factory_mode) {
379 error = -EIO;
380 goto out;
381 }
382
383 switch (tsdata->version) {
384 case EDT_M06:
385 addr = attr->addr_m06;
386 break;
387
388 case EDT_M09:
389 case EDT_M12:
390 case GENERIC_FT:
391 addr = attr->addr_m09;
392 break;
393
394 case EV_FT:
395 addr = attr->addr_ev;
396 break;
397
398 default:
399 error = -ENODEV;
400 goto out;
401 }
402
403 if (addr != NO_REGISTER) {
404 val = edt_ft5x06_register_read(tsdata, addr);
405 if (val < 0) {
406 error = val;
407 dev_err(&tsdata->client->dev,
408 "Failed to fetch attribute %s, error %d\n",
409 dattr->attr.name, error);
410 goto out;
411 }
412 } else {
413 val = *field;
414 }
415
416 if (val != *field) {
417 dev_warn(&tsdata->client->dev,
418 "%s: read (%d) and stored value (%d) differ\n",
419 dattr->attr.name, val, *field);
420 *field = val;
421 }
422
423 count = scnprintf(buf, PAGE_SIZE, "%d\n", val);
424out:
425 mutex_unlock(&tsdata->mutex);
426 return error ?: count;
427}
428
429static ssize_t edt_ft5x06_setting_store(struct device *dev,
430 struct device_attribute *dattr,
431 const char *buf, size_t count)
432{
433 struct i2c_client *client = to_i2c_client(dev);
434 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
435 struct edt_ft5x06_attribute *attr =
436 container_of(dattr, struct edt_ft5x06_attribute, dattr);
437 u8 *field = (u8 *)tsdata + attr->field_offset;
438 unsigned int val;
439 int error;
440 u8 addr;
441
442 mutex_lock(&tsdata->mutex);
443
444 if (tsdata->factory_mode) {
445 error = -EIO;
446 goto out;
447 }
448
449 error = kstrtouint(buf, 0, &val);
450 if (error)
451 goto out;
452
453 if (val < attr->limit_low || val > attr->limit_high) {
454 error = -ERANGE;
455 goto out;
456 }
457
458 switch (tsdata->version) {
459 case EDT_M06:
460 addr = attr->addr_m06;
461 break;
462
463 case EDT_M09:
464 case EDT_M12:
465 case GENERIC_FT:
466 addr = attr->addr_m09;
467 break;
468
469 case EV_FT:
470 addr = attr->addr_ev;
471 break;
472
473 default:
474 error = -ENODEV;
475 goto out;
476 }
477
478 if (addr != NO_REGISTER) {
479 error = edt_ft5x06_register_write(tsdata, addr, val);
480 if (error) {
481 dev_err(&tsdata->client->dev,
482 "Failed to update attribute %s, error: %d\n",
483 dattr->attr.name, error);
484 goto out;
485 }
486 }
487 *field = val;
488
489out:
490 mutex_unlock(&tsdata->mutex);
491 return error ?: count;
492}
493
494/* m06, m09: range 0-31, m12: range 0-5 */
495static EDT_ATTR(gain, S_IWUSR | S_IRUGO, WORK_REGISTER_GAIN,
496 M09_REGISTER_GAIN, EV_REGISTER_GAIN, 0, 31);
497/* m06, m09: range 0-31, m12: range 0-16 */
498static EDT_ATTR(offset, S_IWUSR | S_IRUGO, WORK_REGISTER_OFFSET,
499 M09_REGISTER_OFFSET, NO_REGISTER, 0, 31);
500/* m06, m09, m12: no supported, ev_ft: range 0-80 */
501static EDT_ATTR(offset_x, S_IWUSR | S_IRUGO, NO_REGISTER, NO_REGISTER,
502 EV_REGISTER_OFFSET_X, 0, 80);
503/* m06, m09, m12: no supported, ev_ft: range 0-80 */
504static EDT_ATTR(offset_y, S_IWUSR | S_IRUGO, NO_REGISTER, NO_REGISTER,
505 EV_REGISTER_OFFSET_Y, 0, 80);
506/* m06: range 20 to 80, m09: range 0 to 30, m12: range 1 to 255... */
507static EDT_ATTR(threshold, S_IWUSR | S_IRUGO, WORK_REGISTER_THRESHOLD,
508 M09_REGISTER_THRESHOLD, EV_REGISTER_THRESHOLD, 0, 255);
509/* m06: range 3 to 14, m12: (0x64: 100Hz) */
510static EDT_ATTR(report_rate, S_IWUSR | S_IRUGO, WORK_REGISTER_REPORT_RATE,
511 NO_REGISTER, NO_REGISTER, 0, 255);
512
513static struct attribute *edt_ft5x06_attrs[] = {
514 &edt_ft5x06_attr_gain.dattr.attr,
515 &edt_ft5x06_attr_offset.dattr.attr,
516 &edt_ft5x06_attr_offset_x.dattr.attr,
517 &edt_ft5x06_attr_offset_y.dattr.attr,
518 &edt_ft5x06_attr_threshold.dattr.attr,
519 &edt_ft5x06_attr_report_rate.dattr.attr,
520 NULL
521};
522
523static const struct attribute_group edt_ft5x06_attr_group = {
524 .attrs = edt_ft5x06_attrs,
525};
526
527#ifdef CONFIG_DEBUG_FS
528static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
529{
530 struct i2c_client *client = tsdata->client;
531 int retries = EDT_SWITCH_MODE_RETRIES;
532 int ret;
533 int error;
534
535 if (tsdata->version != EDT_M06) {
536 dev_err(&client->dev,
537 "No factory mode support for non-M06 devices\n");
538 return -EINVAL;
539 }
540
541 disable_irq(client->irq);
542
543 if (!tsdata->raw_buffer) {
544 tsdata->raw_bufsize = tsdata->num_x * tsdata->num_y *
545 sizeof(u16);
546 tsdata->raw_buffer = kzalloc(tsdata->raw_bufsize, GFP_KERNEL);
547 if (!tsdata->raw_buffer) {
548 error = -ENOMEM;
549 goto err_out;
550 }
551 }
552
553 /* mode register is 0x3c when in the work mode */
554 error = edt_ft5x06_register_write(tsdata, WORK_REGISTER_OPMODE, 0x03);
555 if (error) {
556 dev_err(&client->dev,
557 "failed to switch to factory mode, error %d\n", error);
558 goto err_out;
559 }
560
561 tsdata->factory_mode = true;
562 do {
563 mdelay(EDT_SWITCH_MODE_DELAY);
564 /* mode register is 0x01 when in factory mode */
565 ret = edt_ft5x06_register_read(tsdata, FACTORY_REGISTER_OPMODE);
566 if (ret == 0x03)
567 break;
568 } while (--retries > 0);
569
570 if (retries == 0) {
571 dev_err(&client->dev, "not in factory mode after %dms.\n",
572 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
573 error = -EIO;
574 goto err_out;
575 }
576
577 return 0;
578
579err_out:
580 kfree(tsdata->raw_buffer);
581 tsdata->raw_buffer = NULL;
582 tsdata->factory_mode = false;
583 enable_irq(client->irq);
584
585 return error;
586}
587
588static int edt_ft5x06_work_mode(struct edt_ft5x06_ts_data *tsdata)
589{
590 struct i2c_client *client = tsdata->client;
591 int retries = EDT_SWITCH_MODE_RETRIES;
592 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
593 int ret;
594 int error;
595
596 /* mode register is 0x01 when in the factory mode */
597 error = edt_ft5x06_register_write(tsdata, FACTORY_REGISTER_OPMODE, 0x1);
598 if (error) {
599 dev_err(&client->dev,
600 "failed to switch to work mode, error: %d\n", error);
601 return error;
602 }
603
604 tsdata->factory_mode = false;
605
606 do {
607 mdelay(EDT_SWITCH_MODE_DELAY);
608 /* mode register is 0x01 when in factory mode */
609 ret = edt_ft5x06_register_read(tsdata, WORK_REGISTER_OPMODE);
610 if (ret == 0x01)
611 break;
612 } while (--retries > 0);
613
614 if (retries == 0) {
615 dev_err(&client->dev, "not in work mode after %dms.\n",
616 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
617 tsdata->factory_mode = true;
618 return -EIO;
619 }
620
621 kfree(tsdata->raw_buffer);
622 tsdata->raw_buffer = NULL;
623
624 /* restore parameters */
625 edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold,
626 tsdata->threshold);
627 edt_ft5x06_register_write(tsdata, reg_addr->reg_gain,
628 tsdata->gain);
629 if (reg_addr->reg_offset != NO_REGISTER)
630 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset,
631 tsdata->offset);
632 if (reg_addr->reg_offset_x != NO_REGISTER)
633 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_x,
634 tsdata->offset_x);
635 if (reg_addr->reg_offset_y != NO_REGISTER)
636 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_y,
637 tsdata->offset_y);
638 if (reg_addr->reg_report_rate != NO_REGISTER)
639 edt_ft5x06_register_write(tsdata, reg_addr->reg_report_rate,
640 tsdata->report_rate);
641
642 enable_irq(client->irq);
643
644 return 0;
645}
646
647static int edt_ft5x06_debugfs_mode_get(void *data, u64 *mode)
648{
649 struct edt_ft5x06_ts_data *tsdata = data;
650
651 *mode = tsdata->factory_mode;
652
653 return 0;
654};
655
656static int edt_ft5x06_debugfs_mode_set(void *data, u64 mode)
657{
658 struct edt_ft5x06_ts_data *tsdata = data;
659 int retval = 0;
660
661 if (mode > 1)
662 return -ERANGE;
663
664 mutex_lock(&tsdata->mutex);
665
666 if (mode != tsdata->factory_mode) {
667 retval = mode ? edt_ft5x06_factory_mode(tsdata) :
668 edt_ft5x06_work_mode(tsdata);
669 }
670
671 mutex_unlock(&tsdata->mutex);
672
673 return retval;
674};
675
676DEFINE_SIMPLE_ATTRIBUTE(debugfs_mode_fops, edt_ft5x06_debugfs_mode_get,
677 edt_ft5x06_debugfs_mode_set, "%llu\n");
678
679static ssize_t edt_ft5x06_debugfs_raw_data_read(struct file *file,
680 char __user *buf, size_t count, loff_t *off)
681{
682 struct edt_ft5x06_ts_data *tsdata = file->private_data;
683 struct i2c_client *client = tsdata->client;
684 int retries = EDT_RAW_DATA_RETRIES;
685 int val, i, error;
686 size_t read = 0;
687 int colbytes;
688 char wrbuf[3];
689 u8 *rdbuf;
690
691 if (*off < 0 || *off >= tsdata->raw_bufsize)
692 return 0;
693
694 mutex_lock(&tsdata->mutex);
695
696 if (!tsdata->factory_mode || !tsdata->raw_buffer) {
697 error = -EIO;
698 goto out;
699 }
700
701 error = edt_ft5x06_register_write(tsdata, 0x08, 0x01);
702 if (error) {
703 dev_dbg(&client->dev,
704 "failed to write 0x08 register, error %d\n", error);
705 goto out;
706 }
707
708 do {
709 usleep_range(EDT_RAW_DATA_DELAY, EDT_RAW_DATA_DELAY + 100);
710 val = edt_ft5x06_register_read(tsdata, 0x08);
711 if (val < 1)
712 break;
713 } while (--retries > 0);
714
715 if (val < 0) {
716 error = val;
717 dev_dbg(&client->dev,
718 "failed to read 0x08 register, error %d\n", error);
719 goto out;
720 }
721
722 if (retries == 0) {
723 dev_dbg(&client->dev,
724 "timed out waiting for register to settle\n");
725 error = -ETIMEDOUT;
726 goto out;
727 }
728
729 rdbuf = tsdata->raw_buffer;
730 colbytes = tsdata->num_y * sizeof(u16);
731
732 wrbuf[0] = 0xf5;
733 wrbuf[1] = 0x0e;
734 for (i = 0; i < tsdata->num_x; i++) {
735 wrbuf[2] = i; /* column index */
736 error = edt_ft5x06_ts_readwrite(tsdata->client,
737 sizeof(wrbuf), wrbuf,
738 colbytes, rdbuf);
739 if (error)
740 goto out;
741
742 rdbuf += colbytes;
743 }
744
745 read = min_t(size_t, count, tsdata->raw_bufsize - *off);
746 if (copy_to_user(buf, tsdata->raw_buffer + *off, read)) {
747 error = -EFAULT;
748 goto out;
749 }
750
751 *off += read;
752out:
753 mutex_unlock(&tsdata->mutex);
754 return error ?: read;
755};
756
757static const struct file_operations debugfs_raw_data_fops = {
758 .open = simple_open,
759 .read = edt_ft5x06_debugfs_raw_data_read,
760};
761
762static void
763edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
764 const char *debugfs_name)
765{
766 tsdata->debug_dir = debugfs_create_dir(debugfs_name, NULL);
767
768 debugfs_create_u16("num_x", S_IRUSR, tsdata->debug_dir, &tsdata->num_x);
769 debugfs_create_u16("num_y", S_IRUSR, tsdata->debug_dir, &tsdata->num_y);
770
771 debugfs_create_file("mode", S_IRUSR | S_IWUSR,
772 tsdata->debug_dir, tsdata, &debugfs_mode_fops);
773 debugfs_create_file("raw_data", S_IRUSR,
774 tsdata->debug_dir, tsdata, &debugfs_raw_data_fops);
775}
776
777static void
778edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
779{
780 debugfs_remove_recursive(tsdata->debug_dir);
781 kfree(tsdata->raw_buffer);
782}
783
784#else
785
786static inline void
787edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
788 const char *debugfs_name)
789{
790}
791
792static inline void
793edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
794{
795}
796
797#endif /* CONFIG_DEBUGFS */
798
799static int edt_ft5x06_ts_identify(struct i2c_client *client,
800 struct edt_ft5x06_ts_data *tsdata,
801 char *fw_version)
802{
803 u8 rdbuf[EDT_NAME_LEN];
804 char *p;
805 int error;
806 char *model_name = tsdata->name;
807
808 /* see what we find if we assume it is a M06 *
809 * if we get less than EDT_NAME_LEN, we don't want
810 * to have garbage in there
811 */
812 memset(rdbuf, 0, sizeof(rdbuf));
813 error = edt_ft5x06_ts_readwrite(client, 1, "\xBB",
814 EDT_NAME_LEN - 1, rdbuf);
815 if (error)
816 return error;
817
818 /* Probe content for something consistent.
819 * M06 starts with a response byte, M12 gives the data directly.
820 * M09/Generic does not provide model number information.
821 */
822 if (!strncasecmp(rdbuf + 1, "EP0", 3)) {
823 tsdata->version = EDT_M06;
824
825 /* remove last '$' end marker */
826 rdbuf[EDT_NAME_LEN - 1] = '\0';
827 if (rdbuf[EDT_NAME_LEN - 2] == '$')
828 rdbuf[EDT_NAME_LEN - 2] = '\0';
829
830 /* look for Model/Version separator */
831 p = strchr(rdbuf, '*');
832 if (p)
833 *p++ = '\0';
834 strlcpy(model_name, rdbuf + 1, EDT_NAME_LEN);
835 strlcpy(fw_version, p ? p : "", EDT_NAME_LEN);
836 } else if (!strncasecmp(rdbuf, "EP0", 3)) {
837 tsdata->version = EDT_M12;
838
839 /* remove last '$' end marker */
840 rdbuf[EDT_NAME_LEN - 2] = '\0';
841 if (rdbuf[EDT_NAME_LEN - 3] == '$')
842 rdbuf[EDT_NAME_LEN - 3] = '\0';
843
844 /* look for Model/Version separator */
845 p = strchr(rdbuf, '*');
846 if (p)
847 *p++ = '\0';
848 strlcpy(model_name, rdbuf, EDT_NAME_LEN);
849 strlcpy(fw_version, p ? p : "", EDT_NAME_LEN);
850 } else {
851 /* If it is not an EDT M06/M12 touchscreen, then the model
852 * detection is a bit hairy. The different ft5x06
853 * firmares around don't reliably implement the
854 * identification registers. Well, we'll take a shot.
855 *
856 * The main difference between generic focaltec based
857 * touches and EDT M09 is that we know how to retrieve
858 * the max coordinates for the latter.
859 */
860 tsdata->version = GENERIC_FT;
861
862 error = edt_ft5x06_ts_readwrite(client, 1, "\xA6",
863 2, rdbuf);
864 if (error)
865 return error;
866
867 strlcpy(fw_version, rdbuf, 2);
868
869 error = edt_ft5x06_ts_readwrite(client, 1, "\xA8",
870 1, rdbuf);
871 if (error)
872 return error;
873
874 /* This "model identification" is not exact. Unfortunately
875 * not all firmwares for the ft5x06 put useful values in
876 * the identification registers.
877 */
878 switch (rdbuf[0]) {
879 case 0x35: /* EDT EP0350M09 */
880 case 0x43: /* EDT EP0430M09 */
881 case 0x50: /* EDT EP0500M09 */
882 case 0x57: /* EDT EP0570M09 */
883 case 0x70: /* EDT EP0700M09 */
884 tsdata->version = EDT_M09;
885 snprintf(model_name, EDT_NAME_LEN, "EP0%i%i0M09",
886 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
887 break;
888 case 0xa1: /* EDT EP1010ML00 */
889 tsdata->version = EDT_M09;
890 snprintf(model_name, EDT_NAME_LEN, "EP%i%i0ML00",
891 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
892 break;
893 case 0x5a: /* Solomon Goldentek Display */
894 snprintf(model_name, EDT_NAME_LEN, "GKTW50SCED1R0");
895 break;
896 case 0x59: /* Evervision Display with FT5xx6 TS */
897 tsdata->version = EV_FT;
898 error = edt_ft5x06_ts_readwrite(client, 1, "\x53",
899 1, rdbuf);
900 if (error)
901 return error;
902 strlcpy(fw_version, rdbuf, 1);
903 snprintf(model_name, EDT_NAME_LEN,
904 "EVERVISION-FT5726NEi");
905 break;
906 default:
907 snprintf(model_name, EDT_NAME_LEN,
908 "generic ft5x06 (%02x)",
909 rdbuf[0]);
910 break;
911 }
912 }
913
914 return 0;
915}
916
917static void edt_ft5x06_ts_get_defaults(struct device *dev,
918 struct edt_ft5x06_ts_data *tsdata)
919{
920 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
921 u32 val;
922 int error;
923
924 error = device_property_read_u32(dev, "threshold", &val);
925 if (!error) {
926 edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold, val);
927 tsdata->threshold = val;
928 }
929
930 error = device_property_read_u32(dev, "gain", &val);
931 if (!error) {
932 edt_ft5x06_register_write(tsdata, reg_addr->reg_gain, val);
933 tsdata->gain = val;
934 }
935
936 error = device_property_read_u32(dev, "offset", &val);
937 if (!error) {
938 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset, val);
939 tsdata->offset = val;
940 }
941
942 error = device_property_read_u32(dev, "offset-x", &val);
943 if (!error) {
944 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_x, val);
945 tsdata->offset_x = val;
946 }
947
948 error = device_property_read_u32(dev, "offset-y", &val);
949 if (!error) {
950 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_y, val);
951 tsdata->offset_y = val;
952 }
953}
954
955static void
956edt_ft5x06_ts_get_parameters(struct edt_ft5x06_ts_data *tsdata)
957{
958 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
959
960 tsdata->threshold = edt_ft5x06_register_read(tsdata,
961 reg_addr->reg_threshold);
962 tsdata->gain = edt_ft5x06_register_read(tsdata, reg_addr->reg_gain);
963 if (reg_addr->reg_offset != NO_REGISTER)
964 tsdata->offset =
965 edt_ft5x06_register_read(tsdata, reg_addr->reg_offset);
966 if (reg_addr->reg_offset_x != NO_REGISTER)
967 tsdata->offset_x = edt_ft5x06_register_read(tsdata,
968 reg_addr->reg_offset_x);
969 if (reg_addr->reg_offset_y != NO_REGISTER)
970 tsdata->offset_y = edt_ft5x06_register_read(tsdata,
971 reg_addr->reg_offset_y);
972 if (reg_addr->reg_report_rate != NO_REGISTER)
973 tsdata->report_rate = edt_ft5x06_register_read(tsdata,
974 reg_addr->reg_report_rate);
975 if (tsdata->version == EDT_M06 ||
976 tsdata->version == EDT_M09 ||
977 tsdata->version == EDT_M12) {
978 tsdata->num_x = edt_ft5x06_register_read(tsdata,
979 reg_addr->reg_num_x);
980 tsdata->num_y = edt_ft5x06_register_read(tsdata,
981 reg_addr->reg_num_y);
982 } else {
983 tsdata->num_x = -1;
984 tsdata->num_y = -1;
985 }
986}
987
988static void
989edt_ft5x06_ts_set_regs(struct edt_ft5x06_ts_data *tsdata)
990{
991 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
992
993 switch (tsdata->version) {
994 case EDT_M06:
995 reg_addr->reg_threshold = WORK_REGISTER_THRESHOLD;
996 reg_addr->reg_report_rate = WORK_REGISTER_REPORT_RATE;
997 reg_addr->reg_gain = WORK_REGISTER_GAIN;
998 reg_addr->reg_offset = WORK_REGISTER_OFFSET;
999 reg_addr->reg_offset_x = NO_REGISTER;
1000 reg_addr->reg_offset_y = NO_REGISTER;
1001 reg_addr->reg_num_x = WORK_REGISTER_NUM_X;
1002 reg_addr->reg_num_y = WORK_REGISTER_NUM_Y;
1003 break;
1004
1005 case EDT_M09:
1006 case EDT_M12:
1007 reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
1008 reg_addr->reg_report_rate = NO_REGISTER;
1009 reg_addr->reg_gain = M09_REGISTER_GAIN;
1010 reg_addr->reg_offset = M09_REGISTER_OFFSET;
1011 reg_addr->reg_offset_x = NO_REGISTER;
1012 reg_addr->reg_offset_y = NO_REGISTER;
1013 reg_addr->reg_num_x = M09_REGISTER_NUM_X;
1014 reg_addr->reg_num_y = M09_REGISTER_NUM_Y;
1015 break;
1016
1017 case EV_FT:
1018 reg_addr->reg_threshold = EV_REGISTER_THRESHOLD;
1019 reg_addr->reg_gain = EV_REGISTER_GAIN;
1020 reg_addr->reg_offset = NO_REGISTER;
1021 reg_addr->reg_offset_x = EV_REGISTER_OFFSET_X;
1022 reg_addr->reg_offset_y = EV_REGISTER_OFFSET_Y;
1023 reg_addr->reg_num_x = NO_REGISTER;
1024 reg_addr->reg_num_y = NO_REGISTER;
1025 reg_addr->reg_report_rate = NO_REGISTER;
1026 break;
1027
1028 case GENERIC_FT:
1029 /* this is a guesswork */
1030 reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
1031 reg_addr->reg_gain = M09_REGISTER_GAIN;
1032 reg_addr->reg_offset = M09_REGISTER_OFFSET;
1033 reg_addr->reg_offset_x = NO_REGISTER;
1034 reg_addr->reg_offset_y = NO_REGISTER;
1035 break;
1036 }
1037}
1038
1039static int edt_ft5x06_ts_probe(struct i2c_client *client,
1040 const struct i2c_device_id *id)
1041{
1042 const struct edt_i2c_chip_data *chip_data;
1043 struct edt_ft5x06_ts_data *tsdata;
1044 struct input_dev *input;
1045 unsigned long irq_flags;
1046 int error;
1047 char fw_version[EDT_NAME_LEN];
1048
1049 dev_dbg(&client->dev, "probing for EDT FT5x06 I2C\n");
1050
1051 tsdata = devm_kzalloc(&client->dev, sizeof(*tsdata), GFP_KERNEL);
1052 if (!tsdata) {
1053 dev_err(&client->dev, "failed to allocate driver data.\n");
1054 return -ENOMEM;
1055 }
1056
1057 chip_data = device_get_match_data(&client->dev);
1058 if (!chip_data)
1059 chip_data = (const struct edt_i2c_chip_data *)id->driver_data;
1060 if (!chip_data || !chip_data->max_support_points) {
1061 dev_err(&client->dev, "invalid or missing chip data\n");
1062 return -EINVAL;
1063 }
1064
1065 tsdata->max_support_points = chip_data->max_support_points;
1066
1067 tsdata->reset_gpio = devm_gpiod_get_optional(&client->dev,
1068 "reset", GPIOD_OUT_HIGH);
1069 if (IS_ERR(tsdata->reset_gpio)) {
1070 error = PTR_ERR(tsdata->reset_gpio);
1071 dev_err(&client->dev,
1072 "Failed to request GPIO reset pin, error %d\n", error);
1073 return error;
1074 }
1075
1076 tsdata->wake_gpio = devm_gpiod_get_optional(&client->dev,
1077 "wake", GPIOD_OUT_LOW);
1078 if (IS_ERR(tsdata->wake_gpio)) {
1079 error = PTR_ERR(tsdata->wake_gpio);
1080 dev_err(&client->dev,
1081 "Failed to request GPIO wake pin, error %d\n", error);
1082 return error;
1083 }
1084
1085 if (tsdata->wake_gpio) {
1086 usleep_range(5000, 6000);
1087 gpiod_set_value_cansleep(tsdata->wake_gpio, 1);
1088 }
1089
1090 if (tsdata->reset_gpio) {
1091 usleep_range(5000, 6000);
1092 gpiod_set_value_cansleep(tsdata->reset_gpio, 0);
1093 msleep(300);
1094 }
1095
1096 input = devm_input_allocate_device(&client->dev);
1097 if (!input) {
1098 dev_err(&client->dev, "failed to allocate input device.\n");
1099 return -ENOMEM;
1100 }
1101
1102 mutex_init(&tsdata->mutex);
1103 tsdata->client = client;
1104 tsdata->input = input;
1105 tsdata->factory_mode = false;
1106
1107 error = edt_ft5x06_ts_identify(client, tsdata, fw_version);
1108 if (error) {
1109 dev_err(&client->dev, "touchscreen probe failed\n");
1110 return error;
1111 }
1112
1113 edt_ft5x06_ts_set_regs(tsdata);
1114 edt_ft5x06_ts_get_defaults(&client->dev, tsdata);
1115 edt_ft5x06_ts_get_parameters(tsdata);
1116
1117 dev_dbg(&client->dev,
1118 "Model \"%s\", Rev. \"%s\", %dx%d sensors\n",
1119 tsdata->name, fw_version, tsdata->num_x, tsdata->num_y);
1120
1121 input->name = tsdata->name;
1122 input->id.bustype = BUS_I2C;
1123 input->dev.parent = &client->dev;
1124
1125 if (tsdata->version == EDT_M06 ||
1126 tsdata->version == EDT_M09 ||
1127 tsdata->version == EDT_M12) {
1128 input_set_abs_params(input, ABS_MT_POSITION_X,
1129 0, tsdata->num_x * 64 - 1, 0, 0);
1130 input_set_abs_params(input, ABS_MT_POSITION_Y,
1131 0, tsdata->num_y * 64 - 1, 0, 0);
1132 } else {
1133 /* Unknown maximum values. Specify via devicetree */
1134 input_set_abs_params(input, ABS_MT_POSITION_X,
1135 0, 65535, 0, 0);
1136 input_set_abs_params(input, ABS_MT_POSITION_Y,
1137 0, 65535, 0, 0);
1138 }
1139
1140 touchscreen_parse_properties(input, true, &tsdata->prop);
1141
1142 error = input_mt_init_slots(input, tsdata->max_support_points,
1143 INPUT_MT_DIRECT);
1144 if (error) {
1145 dev_err(&client->dev, "Unable to init MT slots.\n");
1146 return error;
1147 }
1148
1149 i2c_set_clientdata(client, tsdata);
1150
1151 irq_flags = irq_get_trigger_type(client->irq);
1152 if (irq_flags == IRQF_TRIGGER_NONE)
1153 irq_flags = IRQF_TRIGGER_FALLING;
1154 irq_flags |= IRQF_ONESHOT;
1155
1156 error = devm_request_threaded_irq(&client->dev, client->irq,
1157 NULL, edt_ft5x06_ts_isr, irq_flags,
1158 client->name, tsdata);
1159 if (error) {
1160 dev_err(&client->dev, "Unable to request touchscreen IRQ.\n");
1161 return error;
1162 }
1163
1164 error = devm_device_add_group(&client->dev, &edt_ft5x06_attr_group);
1165 if (error)
1166 return error;
1167
1168 error = input_register_device(input);
1169 if (error)
1170 return error;
1171
1172 edt_ft5x06_ts_prepare_debugfs(tsdata, dev_driver_string(&client->dev));
1173 device_init_wakeup(&client->dev, 1);
1174
1175 dev_dbg(&client->dev,
1176 "EDT FT5x06 initialized: IRQ %d, WAKE pin %d, Reset pin %d.\n",
1177 client->irq,
1178 tsdata->wake_gpio ? desc_to_gpio(tsdata->wake_gpio) : -1,
1179 tsdata->reset_gpio ? desc_to_gpio(tsdata->reset_gpio) : -1);
1180
1181 return 0;
1182}
1183
1184static int edt_ft5x06_ts_remove(struct i2c_client *client)
1185{
1186 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1187
1188 edt_ft5x06_ts_teardown_debugfs(tsdata);
1189
1190 return 0;
1191}
1192
1193static int __maybe_unused edt_ft5x06_ts_suspend(struct device *dev)
1194{
1195 struct i2c_client *client = to_i2c_client(dev);
1196
1197 if (device_may_wakeup(dev))
1198 enable_irq_wake(client->irq);
1199
1200 return 0;
1201}
1202
1203static int __maybe_unused edt_ft5x06_ts_resume(struct device *dev)
1204{
1205 struct i2c_client *client = to_i2c_client(dev);
1206
1207 if (device_may_wakeup(dev))
1208 disable_irq_wake(client->irq);
1209
1210 return 0;
1211}
1212
1213static SIMPLE_DEV_PM_OPS(edt_ft5x06_ts_pm_ops,
1214 edt_ft5x06_ts_suspend, edt_ft5x06_ts_resume);
1215
1216static const struct edt_i2c_chip_data edt_ft5x06_data = {
1217 .max_support_points = 5,
1218};
1219
1220static const struct edt_i2c_chip_data edt_ft5506_data = {
1221 .max_support_points = 10,
1222};
1223
1224static const struct edt_i2c_chip_data edt_ft6236_data = {
1225 .max_support_points = 2,
1226};
1227
1228static const struct i2c_device_id edt_ft5x06_ts_id[] = {
1229 { .name = "edt-ft5x06", .driver_data = (long)&edt_ft5x06_data },
1230 { .name = "edt-ft5506", .driver_data = (long)&edt_ft5506_data },
1231 { .name = "ev-ft5726", .driver_data = (long)&edt_ft5506_data },
1232 /* Note no edt- prefix for compatibility with the ft6236.c driver */
1233 { .name = "ft6236", .driver_data = (long)&edt_ft6236_data },
1234 { /* sentinel */ }
1235};
1236MODULE_DEVICE_TABLE(i2c, edt_ft5x06_ts_id);
1237
1238static const struct of_device_id edt_ft5x06_of_match[] = {
1239 { .compatible = "edt,edt-ft5206", .data = &edt_ft5x06_data },
1240 { .compatible = "edt,edt-ft5306", .data = &edt_ft5x06_data },
1241 { .compatible = "edt,edt-ft5406", .data = &edt_ft5x06_data },
1242 { .compatible = "edt,edt-ft5506", .data = &edt_ft5506_data },
1243 { .compatible = "evervision,ev-ft5726", .data = &edt_ft5506_data },
1244 /* Note focaltech vendor prefix for compatibility with ft6236.c */
1245 { .compatible = "focaltech,ft6236", .data = &edt_ft6236_data },
1246 { /* sentinel */ }
1247};
1248MODULE_DEVICE_TABLE(of, edt_ft5x06_of_match);
1249
1250static struct i2c_driver edt_ft5x06_ts_driver = {
1251 .driver = {
1252 .name = "edt_ft5x06",
1253 .of_match_table = edt_ft5x06_of_match,
1254 .pm = &edt_ft5x06_ts_pm_ops,
1255 },
1256 .id_table = edt_ft5x06_ts_id,
1257 .probe = edt_ft5x06_ts_probe,
1258 .remove = edt_ft5x06_ts_remove,
1259};
1260
1261module_i2c_driver(edt_ft5x06_ts_driver);
1262
1263MODULE_AUTHOR("Simon Budig <simon.budig@kernelconcepts.de>");
1264MODULE_DESCRIPTION("EDT FT5x06 I2C Touchscreen Driver");
1265MODULE_LICENSE("GPL v2");