Loading...
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/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/property.h>
28#include <linux/ratelimit.h>
29#include <linux/regulator/consumer.h>
30#include <linux/slab.h>
31#include <linux/uaccess.h>
32
33#include <asm/unaligned.h>
34
35#define WORK_REGISTER_THRESHOLD 0x00
36#define WORK_REGISTER_REPORT_RATE 0x08
37#define WORK_REGISTER_GAIN 0x30
38#define WORK_REGISTER_OFFSET 0x31
39#define WORK_REGISTER_NUM_X 0x33
40#define WORK_REGISTER_NUM_Y 0x34
41
42#define PMOD_REGISTER_ACTIVE 0x00
43#define PMOD_REGISTER_HIBERNATE 0x03
44
45#define M09_REGISTER_THRESHOLD 0x80
46#define M09_REGISTER_GAIN 0x92
47#define M09_REGISTER_OFFSET 0x93
48#define M09_REGISTER_NUM_X 0x94
49#define M09_REGISTER_NUM_Y 0x95
50
51#define M12_REGISTER_REPORT_RATE 0x88
52
53#define EV_REGISTER_THRESHOLD 0x40
54#define EV_REGISTER_GAIN 0x41
55#define EV_REGISTER_OFFSET_Y 0x45
56#define EV_REGISTER_OFFSET_X 0x46
57
58#define NO_REGISTER 0xff
59
60#define WORK_REGISTER_OPMODE 0x3c
61#define FACTORY_REGISTER_OPMODE 0x01
62#define PMOD_REGISTER_OPMODE 0xa5
63
64#define TOUCH_EVENT_DOWN 0x00
65#define TOUCH_EVENT_UP 0x01
66#define TOUCH_EVENT_ON 0x02
67#define TOUCH_EVENT_RESERVED 0x03
68
69#define EDT_NAME_LEN 23
70#define EDT_SWITCH_MODE_RETRIES 10
71#define EDT_SWITCH_MODE_DELAY 5 /* msec */
72#define EDT_RAW_DATA_RETRIES 100
73#define EDT_RAW_DATA_DELAY 1000 /* usec */
74
75#define EDT_DEFAULT_NUM_X 1024
76#define EDT_DEFAULT_NUM_Y 1024
77
78enum edt_pmode {
79 EDT_PMODE_NOT_SUPPORTED,
80 EDT_PMODE_HIBERNATE,
81 EDT_PMODE_POWEROFF,
82};
83
84enum edt_ver {
85 EDT_M06,
86 EDT_M09,
87 EDT_M12,
88 EV_FT,
89 GENERIC_FT,
90};
91
92struct edt_reg_addr {
93 int reg_threshold;
94 int reg_report_rate;
95 int reg_gain;
96 int reg_offset;
97 int reg_offset_x;
98 int reg_offset_y;
99 int reg_num_x;
100 int reg_num_y;
101};
102
103struct edt_ft5x06_ts_data {
104 struct i2c_client *client;
105 struct input_dev *input;
106 struct touchscreen_properties prop;
107 u16 num_x;
108 u16 num_y;
109 struct regulator *vcc;
110 struct regulator *iovcc;
111
112 struct gpio_desc *reset_gpio;
113 struct gpio_desc *wake_gpio;
114
115#if defined(CONFIG_DEBUG_FS)
116 struct dentry *debug_dir;
117 u8 *raw_buffer;
118 size_t raw_bufsize;
119#endif
120
121 struct mutex mutex;
122 bool factory_mode;
123 enum edt_pmode suspend_mode;
124 int threshold;
125 int gain;
126 int offset;
127 int offset_x;
128 int offset_y;
129 int report_rate;
130 int max_support_points;
131
132 char name[EDT_NAME_LEN];
133 char fw_version[EDT_NAME_LEN];
134
135 struct edt_reg_addr reg_addr;
136 enum edt_ver version;
137 unsigned int crc_errors;
138 unsigned int header_errors;
139};
140
141struct edt_i2c_chip_data {
142 int max_support_points;
143};
144
145static int edt_ft5x06_ts_readwrite(struct i2c_client *client,
146 u16 wr_len, u8 *wr_buf,
147 u16 rd_len, u8 *rd_buf)
148{
149 struct i2c_msg wrmsg[2];
150 int i = 0;
151 int ret;
152
153 if (wr_len) {
154 wrmsg[i].addr = client->addr;
155 wrmsg[i].flags = 0;
156 wrmsg[i].len = wr_len;
157 wrmsg[i].buf = wr_buf;
158 i++;
159 }
160 if (rd_len) {
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;
165 i++;
166 }
167
168 ret = i2c_transfer(client->adapter, wrmsg, i);
169 if (ret < 0)
170 return ret;
171 if (ret != i)
172 return -EIO;
173
174 return 0;
175}
176
177static bool edt_ft5x06_ts_check_crc(struct edt_ft5x06_ts_data *tsdata,
178 u8 *buf, int buflen)
179{
180 int i;
181 u8 crc = 0;
182
183 for (i = 0; i < buflen - 1; i++)
184 crc ^= buf[i];
185
186 if (crc != buf[buflen-1]) {
187 tsdata->crc_errors++;
188 dev_err_ratelimited(&tsdata->client->dev,
189 "crc error: 0x%02x expected, got 0x%02x\n",
190 crc, buf[buflen-1]);
191 return false;
192 }
193
194 return true;
195}
196
197static irqreturn_t edt_ft5x06_ts_isr(int irq, void *dev_id)
198{
199 struct edt_ft5x06_ts_data *tsdata = dev_id;
200 struct device *dev = &tsdata->client->dev;
201 u8 cmd;
202 u8 rdbuf[63];
203 int i, type, x, y, id;
204 int offset, tplen, datalen, crclen;
205 int error;
206
207 switch (tsdata->version) {
208 case EDT_M06:
209 cmd = 0xf9; /* tell the controller to send touch data */
210 offset = 5; /* where the actual touch data starts */
211 tplen = 4; /* data comes in so called frames */
212 crclen = 1; /* length of the crc data */
213 break;
214
215 case EDT_M09:
216 case EDT_M12:
217 case EV_FT:
218 case GENERIC_FT:
219 cmd = 0x0;
220 offset = 3;
221 tplen = 6;
222 crclen = 0;
223 break;
224
225 default:
226 goto out;
227 }
228
229 memset(rdbuf, 0, sizeof(rdbuf));
230 datalen = tplen * tsdata->max_support_points + offset + crclen;
231
232 error = edt_ft5x06_ts_readwrite(tsdata->client,
233 sizeof(cmd), &cmd,
234 datalen, rdbuf);
235 if (error) {
236 dev_err_ratelimited(dev, "Unable to fetch data, error: %d\n",
237 error);
238 goto out;
239 }
240
241 /* M09/M12 does not send header or CRC */
242 if (tsdata->version == EDT_M06) {
243 if (rdbuf[0] != 0xaa || rdbuf[1] != 0xaa ||
244 rdbuf[2] != datalen) {
245 tsdata->header_errors++;
246 dev_err_ratelimited(dev,
247 "Unexpected header: %02x%02x%02x!\n",
248 rdbuf[0], rdbuf[1], rdbuf[2]);
249 goto out;
250 }
251
252 if (!edt_ft5x06_ts_check_crc(tsdata, rdbuf, datalen))
253 goto out;
254 }
255
256 for (i = 0; i < tsdata->max_support_points; i++) {
257 u8 *buf = &rdbuf[i * tplen + offset];
258
259 type = buf[0] >> 6;
260 /* ignore Reserved events */
261 if (type == TOUCH_EVENT_RESERVED)
262 continue;
263
264 /* M06 sometimes sends bogus coordinates in TOUCH_DOWN */
265 if (tsdata->version == EDT_M06 && type == TOUCH_EVENT_DOWN)
266 continue;
267
268 x = get_unaligned_be16(buf) & 0x0fff;
269 y = get_unaligned_be16(buf + 2) & 0x0fff;
270 /* The FT5x26 send the y coordinate first */
271 if (tsdata->version == EV_FT)
272 swap(x, y);
273
274 id = (buf[2] >> 4) & 0x0f;
275
276 input_mt_slot(tsdata->input, id);
277 if (input_mt_report_slot_state(tsdata->input, MT_TOOL_FINGER,
278 type != TOUCH_EVENT_UP))
279 touchscreen_report_pos(tsdata->input, &tsdata->prop,
280 x, y, true);
281 }
282
283 input_mt_report_pointer_emulation(tsdata->input, true);
284 input_sync(tsdata->input);
285
286out:
287 return IRQ_HANDLED;
288}
289
290static int edt_ft5x06_register_write(struct edt_ft5x06_ts_data *tsdata,
291 u8 addr, u8 value)
292{
293 u8 wrbuf[4];
294
295 switch (tsdata->version) {
296 case EDT_M06:
297 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
298 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
299 wrbuf[2] = value;
300 wrbuf[3] = wrbuf[0] ^ wrbuf[1] ^ wrbuf[2];
301 return edt_ft5x06_ts_readwrite(tsdata->client, 4,
302 wrbuf, 0, NULL);
303
304 case EDT_M09:
305 case EDT_M12:
306 case EV_FT:
307 case GENERIC_FT:
308 wrbuf[0] = addr;
309 wrbuf[1] = value;
310
311 return edt_ft5x06_ts_readwrite(tsdata->client, 2,
312 wrbuf, 0, NULL);
313
314 default:
315 return -EINVAL;
316 }
317}
318
319static int edt_ft5x06_register_read(struct edt_ft5x06_ts_data *tsdata,
320 u8 addr)
321{
322 u8 wrbuf[2], rdbuf[2];
323 int error;
324
325 switch (tsdata->version) {
326 case EDT_M06:
327 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
328 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
329 wrbuf[1] |= tsdata->factory_mode ? 0x80 : 0x40;
330
331 error = edt_ft5x06_ts_readwrite(tsdata->client, 2, wrbuf, 2,
332 rdbuf);
333 if (error)
334 return error;
335
336 if ((wrbuf[0] ^ wrbuf[1] ^ rdbuf[0]) != rdbuf[1]) {
337 dev_err(&tsdata->client->dev,
338 "crc error: 0x%02x expected, got 0x%02x\n",
339 wrbuf[0] ^ wrbuf[1] ^ rdbuf[0],
340 rdbuf[1]);
341 return -EIO;
342 }
343 break;
344
345 case EDT_M09:
346 case EDT_M12:
347 case EV_FT:
348 case GENERIC_FT:
349 wrbuf[0] = addr;
350 error = edt_ft5x06_ts_readwrite(tsdata->client, 1,
351 wrbuf, 1, rdbuf);
352 if (error)
353 return error;
354 break;
355
356 default:
357 return -EINVAL;
358 }
359
360 return rdbuf[0];
361}
362
363struct edt_ft5x06_attribute {
364 struct device_attribute dattr;
365 size_t field_offset;
366 u8 limit_low;
367 u8 limit_high;
368 u8 addr_m06;
369 u8 addr_m09;
370 u8 addr_ev;
371};
372
373#define EDT_ATTR(_field, _mode, _addr_m06, _addr_m09, _addr_ev, \
374 _limit_low, _limit_high) \
375 struct edt_ft5x06_attribute edt_ft5x06_attr_##_field = { \
376 .dattr = __ATTR(_field, _mode, \
377 edt_ft5x06_setting_show, \
378 edt_ft5x06_setting_store), \
379 .field_offset = offsetof(struct edt_ft5x06_ts_data, _field), \
380 .addr_m06 = _addr_m06, \
381 .addr_m09 = _addr_m09, \
382 .addr_ev = _addr_ev, \
383 .limit_low = _limit_low, \
384 .limit_high = _limit_high, \
385 }
386
387static ssize_t edt_ft5x06_setting_show(struct device *dev,
388 struct device_attribute *dattr,
389 char *buf)
390{
391 struct i2c_client *client = to_i2c_client(dev);
392 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
393 struct edt_ft5x06_attribute *attr =
394 container_of(dattr, struct edt_ft5x06_attribute, dattr);
395 u8 *field = (u8 *)tsdata + attr->field_offset;
396 int val;
397 size_t count = 0;
398 int error = 0;
399 u8 addr;
400
401 mutex_lock(&tsdata->mutex);
402
403 if (tsdata->factory_mode) {
404 error = -EIO;
405 goto out;
406 }
407
408 switch (tsdata->version) {
409 case EDT_M06:
410 addr = attr->addr_m06;
411 break;
412
413 case EDT_M09:
414 case EDT_M12:
415 case GENERIC_FT:
416 addr = attr->addr_m09;
417 break;
418
419 case EV_FT:
420 addr = attr->addr_ev;
421 break;
422
423 default:
424 error = -ENODEV;
425 goto out;
426 }
427
428 if (addr != NO_REGISTER) {
429 val = edt_ft5x06_register_read(tsdata, addr);
430 if (val < 0) {
431 error = val;
432 dev_err(&tsdata->client->dev,
433 "Failed to fetch attribute %s, error %d\n",
434 dattr->attr.name, error);
435 goto out;
436 }
437 } else {
438 val = *field;
439 }
440
441 if (val != *field) {
442 dev_warn(&tsdata->client->dev,
443 "%s: read (%d) and stored value (%d) differ\n",
444 dattr->attr.name, val, *field);
445 *field = val;
446 }
447
448 count = scnprintf(buf, PAGE_SIZE, "%d\n", val);
449out:
450 mutex_unlock(&tsdata->mutex);
451 return error ?: count;
452}
453
454static ssize_t edt_ft5x06_setting_store(struct device *dev,
455 struct device_attribute *dattr,
456 const char *buf, size_t count)
457{
458 struct i2c_client *client = to_i2c_client(dev);
459 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
460 struct edt_ft5x06_attribute *attr =
461 container_of(dattr, struct edt_ft5x06_attribute, dattr);
462 u8 *field = (u8 *)tsdata + attr->field_offset;
463 unsigned int val;
464 int error;
465 u8 addr;
466
467 mutex_lock(&tsdata->mutex);
468
469 if (tsdata->factory_mode) {
470 error = -EIO;
471 goto out;
472 }
473
474 error = kstrtouint(buf, 0, &val);
475 if (error)
476 goto out;
477
478 if (val < attr->limit_low || val > attr->limit_high) {
479 error = -ERANGE;
480 goto out;
481 }
482
483 switch (tsdata->version) {
484 case EDT_M06:
485 addr = attr->addr_m06;
486 break;
487
488 case EDT_M09:
489 case EDT_M12:
490 case GENERIC_FT:
491 addr = attr->addr_m09;
492 break;
493
494 case EV_FT:
495 addr = attr->addr_ev;
496 break;
497
498 default:
499 error = -ENODEV;
500 goto out;
501 }
502
503 if (addr != NO_REGISTER) {
504 error = edt_ft5x06_register_write(tsdata, addr, val);
505 if (error) {
506 dev_err(&tsdata->client->dev,
507 "Failed to update attribute %s, error: %d\n",
508 dattr->attr.name, error);
509 goto out;
510 }
511 }
512 *field = val;
513
514out:
515 mutex_unlock(&tsdata->mutex);
516 return error ?: count;
517}
518
519/* m06, m09: range 0-31, m12: range 0-5 */
520static EDT_ATTR(gain, S_IWUSR | S_IRUGO, WORK_REGISTER_GAIN,
521 M09_REGISTER_GAIN, EV_REGISTER_GAIN, 0, 31);
522/* m06, m09: range 0-31, m12: range 0-16 */
523static EDT_ATTR(offset, S_IWUSR | S_IRUGO, WORK_REGISTER_OFFSET,
524 M09_REGISTER_OFFSET, NO_REGISTER, 0, 31);
525/* m06, m09, m12: no supported, ev_ft: range 0-80 */
526static EDT_ATTR(offset_x, S_IWUSR | S_IRUGO, NO_REGISTER, NO_REGISTER,
527 EV_REGISTER_OFFSET_X, 0, 80);
528/* m06, m09, m12: no supported, ev_ft: range 0-80 */
529static EDT_ATTR(offset_y, S_IWUSR | S_IRUGO, NO_REGISTER, NO_REGISTER,
530 EV_REGISTER_OFFSET_Y, 0, 80);
531/* m06: range 20 to 80, m09: range 0 to 30, m12: range 1 to 255... */
532static EDT_ATTR(threshold, S_IWUSR | S_IRUGO, WORK_REGISTER_THRESHOLD,
533 M09_REGISTER_THRESHOLD, EV_REGISTER_THRESHOLD, 0, 255);
534/* m06: range 3 to 14, m12: range 1 to 255 */
535static EDT_ATTR(report_rate, S_IWUSR | S_IRUGO, WORK_REGISTER_REPORT_RATE,
536 M12_REGISTER_REPORT_RATE, NO_REGISTER, 0, 255);
537
538static ssize_t model_show(struct device *dev, struct device_attribute *attr,
539 char *buf)
540{
541 struct i2c_client *client = to_i2c_client(dev);
542 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
543
544 return sysfs_emit(buf, "%s\n", tsdata->name);
545}
546
547static DEVICE_ATTR_RO(model);
548
549static ssize_t fw_version_show(struct device *dev,
550 struct device_attribute *attr, char *buf)
551{
552 struct i2c_client *client = to_i2c_client(dev);
553 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
554
555 return sysfs_emit(buf, "%s\n", tsdata->fw_version);
556}
557
558static DEVICE_ATTR_RO(fw_version);
559
560/* m06 only */
561static ssize_t header_errors_show(struct device *dev,
562 struct device_attribute *attr, char *buf)
563{
564 struct i2c_client *client = to_i2c_client(dev);
565 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
566
567 return sysfs_emit(buf, "%d\n", tsdata->header_errors);
568}
569
570static DEVICE_ATTR_RO(header_errors);
571
572/* m06 only */
573static ssize_t crc_errors_show(struct device *dev,
574 struct device_attribute *attr, char *buf)
575{
576 struct i2c_client *client = to_i2c_client(dev);
577 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
578
579 return sysfs_emit(buf, "%d\n", tsdata->crc_errors);
580}
581
582static DEVICE_ATTR_RO(crc_errors);
583
584static struct attribute *edt_ft5x06_attrs[] = {
585 &edt_ft5x06_attr_gain.dattr.attr,
586 &edt_ft5x06_attr_offset.dattr.attr,
587 &edt_ft5x06_attr_offset_x.dattr.attr,
588 &edt_ft5x06_attr_offset_y.dattr.attr,
589 &edt_ft5x06_attr_threshold.dattr.attr,
590 &edt_ft5x06_attr_report_rate.dattr.attr,
591 &dev_attr_model.attr,
592 &dev_attr_fw_version.attr,
593 &dev_attr_header_errors.attr,
594 &dev_attr_crc_errors.attr,
595 NULL
596};
597
598static const struct attribute_group edt_ft5x06_attr_group = {
599 .attrs = edt_ft5x06_attrs,
600};
601
602static void edt_ft5x06_restore_reg_parameters(struct edt_ft5x06_ts_data *tsdata)
603{
604 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
605
606 edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold,
607 tsdata->threshold);
608 edt_ft5x06_register_write(tsdata, reg_addr->reg_gain,
609 tsdata->gain);
610 if (reg_addr->reg_offset != NO_REGISTER)
611 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset,
612 tsdata->offset);
613 if (reg_addr->reg_offset_x != NO_REGISTER)
614 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_x,
615 tsdata->offset_x);
616 if (reg_addr->reg_offset_y != NO_REGISTER)
617 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset_y,
618 tsdata->offset_y);
619 if (reg_addr->reg_report_rate != NO_REGISTER)
620 edt_ft5x06_register_write(tsdata, reg_addr->reg_report_rate,
621 tsdata->report_rate);
622
623}
624
625#ifdef CONFIG_DEBUG_FS
626static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
627{
628 struct i2c_client *client = tsdata->client;
629 int retries = EDT_SWITCH_MODE_RETRIES;
630 int ret;
631 int error;
632
633 if (tsdata->version != EDT_M06) {
634 dev_err(&client->dev,
635 "No factory mode support for non-M06 devices\n");
636 return -EINVAL;
637 }
638
639 disable_irq(client->irq);
640
641 if (!tsdata->raw_buffer) {
642 tsdata->raw_bufsize = tsdata->num_x * tsdata->num_y *
643 sizeof(u16);
644 tsdata->raw_buffer = kzalloc(tsdata->raw_bufsize, GFP_KERNEL);
645 if (!tsdata->raw_buffer) {
646 error = -ENOMEM;
647 goto err_out;
648 }
649 }
650
651 /* mode register is 0x3c when in the work mode */
652 error = edt_ft5x06_register_write(tsdata, WORK_REGISTER_OPMODE, 0x03);
653 if (error) {
654 dev_err(&client->dev,
655 "failed to switch to factory mode, error %d\n", error);
656 goto err_out;
657 }
658
659 tsdata->factory_mode = true;
660 do {
661 mdelay(EDT_SWITCH_MODE_DELAY);
662 /* mode register is 0x01 when in factory mode */
663 ret = edt_ft5x06_register_read(tsdata, FACTORY_REGISTER_OPMODE);
664 if (ret == 0x03)
665 break;
666 } while (--retries > 0);
667
668 if (retries == 0) {
669 dev_err(&client->dev, "not in factory mode after %dms.\n",
670 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
671 error = -EIO;
672 goto err_out;
673 }
674
675 return 0;
676
677err_out:
678 kfree(tsdata->raw_buffer);
679 tsdata->raw_buffer = NULL;
680 tsdata->factory_mode = false;
681 enable_irq(client->irq);
682
683 return error;
684}
685
686static int edt_ft5x06_work_mode(struct edt_ft5x06_ts_data *tsdata)
687{
688 struct i2c_client *client = tsdata->client;
689 int retries = EDT_SWITCH_MODE_RETRIES;
690 int ret;
691 int error;
692
693 /* mode register is 0x01 when in the factory mode */
694 error = edt_ft5x06_register_write(tsdata, FACTORY_REGISTER_OPMODE, 0x1);
695 if (error) {
696 dev_err(&client->dev,
697 "failed to switch to work mode, error: %d\n", error);
698 return error;
699 }
700
701 tsdata->factory_mode = false;
702
703 do {
704 mdelay(EDT_SWITCH_MODE_DELAY);
705 /* mode register is 0x01 when in factory mode */
706 ret = edt_ft5x06_register_read(tsdata, WORK_REGISTER_OPMODE);
707 if (ret == 0x01)
708 break;
709 } while (--retries > 0);
710
711 if (retries == 0) {
712 dev_err(&client->dev, "not in work mode after %dms.\n",
713 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
714 tsdata->factory_mode = true;
715 return -EIO;
716 }
717
718 kfree(tsdata->raw_buffer);
719 tsdata->raw_buffer = NULL;
720
721 edt_ft5x06_restore_reg_parameters(tsdata);
722 enable_irq(client->irq);
723
724 return 0;
725}
726
727static int edt_ft5x06_debugfs_mode_get(void *data, u64 *mode)
728{
729 struct edt_ft5x06_ts_data *tsdata = data;
730
731 *mode = tsdata->factory_mode;
732
733 return 0;
734};
735
736static int edt_ft5x06_debugfs_mode_set(void *data, u64 mode)
737{
738 struct edt_ft5x06_ts_data *tsdata = data;
739 int retval = 0;
740
741 if (mode > 1)
742 return -ERANGE;
743
744 mutex_lock(&tsdata->mutex);
745
746 if (mode != tsdata->factory_mode) {
747 retval = mode ? edt_ft5x06_factory_mode(tsdata) :
748 edt_ft5x06_work_mode(tsdata);
749 }
750
751 mutex_unlock(&tsdata->mutex);
752
753 return retval;
754};
755
756DEFINE_SIMPLE_ATTRIBUTE(debugfs_mode_fops, edt_ft5x06_debugfs_mode_get,
757 edt_ft5x06_debugfs_mode_set, "%llu\n");
758
759static ssize_t edt_ft5x06_debugfs_raw_data_read(struct file *file,
760 char __user *buf, size_t count, loff_t *off)
761{
762 struct edt_ft5x06_ts_data *tsdata = file->private_data;
763 struct i2c_client *client = tsdata->client;
764 int retries = EDT_RAW_DATA_RETRIES;
765 int val, i, error;
766 size_t read = 0;
767 int colbytes;
768 char wrbuf[3];
769 u8 *rdbuf;
770
771 if (*off < 0 || *off >= tsdata->raw_bufsize)
772 return 0;
773
774 mutex_lock(&tsdata->mutex);
775
776 if (!tsdata->factory_mode || !tsdata->raw_buffer) {
777 error = -EIO;
778 goto out;
779 }
780
781 error = edt_ft5x06_register_write(tsdata, 0x08, 0x01);
782 if (error) {
783 dev_dbg(&client->dev,
784 "failed to write 0x08 register, error %d\n", error);
785 goto out;
786 }
787
788 do {
789 usleep_range(EDT_RAW_DATA_DELAY, EDT_RAW_DATA_DELAY + 100);
790 val = edt_ft5x06_register_read(tsdata, 0x08);
791 if (val < 1)
792 break;
793 } while (--retries > 0);
794
795 if (val < 0) {
796 error = val;
797 dev_dbg(&client->dev,
798 "failed to read 0x08 register, error %d\n", error);
799 goto out;
800 }
801
802 if (retries == 0) {
803 dev_dbg(&client->dev,
804 "timed out waiting for register to settle\n");
805 error = -ETIMEDOUT;
806 goto out;
807 }
808
809 rdbuf = tsdata->raw_buffer;
810 colbytes = tsdata->num_y * sizeof(u16);
811
812 wrbuf[0] = 0xf5;
813 wrbuf[1] = 0x0e;
814 for (i = 0; i < tsdata->num_x; i++) {
815 wrbuf[2] = i; /* column index */
816 error = edt_ft5x06_ts_readwrite(tsdata->client,
817 sizeof(wrbuf), wrbuf,
818 colbytes, rdbuf);
819 if (error)
820 goto out;
821
822 rdbuf += colbytes;
823 }
824
825 read = min_t(size_t, count, tsdata->raw_bufsize - *off);
826 if (copy_to_user(buf, tsdata->raw_buffer + *off, read)) {
827 error = -EFAULT;
828 goto out;
829 }
830
831 *off += read;
832out:
833 mutex_unlock(&tsdata->mutex);
834 return error ?: read;
835};
836
837static const struct file_operations debugfs_raw_data_fops = {
838 .open = simple_open,
839 .read = edt_ft5x06_debugfs_raw_data_read,
840};
841
842static void edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
843 const char *debugfs_name)
844{
845 tsdata->debug_dir = debugfs_create_dir(debugfs_name, NULL);
846
847 debugfs_create_u16("num_x", S_IRUSR, tsdata->debug_dir, &tsdata->num_x);
848 debugfs_create_u16("num_y", S_IRUSR, tsdata->debug_dir, &tsdata->num_y);
849
850 debugfs_create_file("mode", S_IRUSR | S_IWUSR,
851 tsdata->debug_dir, tsdata, &debugfs_mode_fops);
852 debugfs_create_file("raw_data", S_IRUSR,
853 tsdata->debug_dir, tsdata, &debugfs_raw_data_fops);
854}
855
856static void edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
857{
858 debugfs_remove_recursive(tsdata->debug_dir);
859 kfree(tsdata->raw_buffer);
860}
861
862#else
863
864static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
865{
866 return -ENOSYS;
867}
868
869static void edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
870 const char *debugfs_name)
871{
872}
873
874static void edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
875{
876}
877
878#endif /* CONFIG_DEBUGFS */
879
880static int edt_ft5x06_ts_identify(struct i2c_client *client,
881 struct edt_ft5x06_ts_data *tsdata)
882{
883 u8 rdbuf[EDT_NAME_LEN];
884 char *p;
885 int error;
886 char *model_name = tsdata->name;
887 char *fw_version = tsdata->fw_version;
888
889 /* see what we find if we assume it is a M06 *
890 * if we get less than EDT_NAME_LEN, we don't want
891 * to have garbage in there
892 */
893 memset(rdbuf, 0, sizeof(rdbuf));
894 error = edt_ft5x06_ts_readwrite(client, 1, "\xBB",
895 EDT_NAME_LEN - 1, rdbuf);
896 if (error)
897 return error;
898
899 /* Probe content for something consistent.
900 * M06 starts with a response byte, M12 gives the data directly.
901 * M09/Generic does not provide model number information.
902 */
903 if (!strncasecmp(rdbuf + 1, "EP0", 3)) {
904 tsdata->version = EDT_M06;
905
906 /* remove last '$' end marker */
907 rdbuf[EDT_NAME_LEN - 1] = '\0';
908 if (rdbuf[EDT_NAME_LEN - 2] == '$')
909 rdbuf[EDT_NAME_LEN - 2] = '\0';
910
911 /* look for Model/Version separator */
912 p = strchr(rdbuf, '*');
913 if (p)
914 *p++ = '\0';
915 strscpy(model_name, rdbuf + 1, EDT_NAME_LEN);
916 strscpy(fw_version, p ? p : "", EDT_NAME_LEN);
917 } else if (!strncasecmp(rdbuf, "EP0", 3)) {
918 tsdata->version = EDT_M12;
919
920 /* remove last '$' end marker */
921 rdbuf[EDT_NAME_LEN - 2] = '\0';
922 if (rdbuf[EDT_NAME_LEN - 3] == '$')
923 rdbuf[EDT_NAME_LEN - 3] = '\0';
924
925 /* look for Model/Version separator */
926 p = strchr(rdbuf, '*');
927 if (p)
928 *p++ = '\0';
929 strscpy(model_name, rdbuf, EDT_NAME_LEN);
930 strscpy(fw_version, p ? p : "", EDT_NAME_LEN);
931 } else {
932 /* If it is not an EDT M06/M12 touchscreen, then the model
933 * detection is a bit hairy. The different ft5x06
934 * firmares around don't reliably implement the
935 * identification registers. Well, we'll take a shot.
936 *
937 * The main difference between generic focaltec based
938 * touches and EDT M09 is that we know how to retrieve
939 * the max coordinates for the latter.
940 */
941 tsdata->version = GENERIC_FT;
942
943 error = edt_ft5x06_ts_readwrite(client, 1, "\xA6",
944 2, rdbuf);
945 if (error)
946 return error;
947
948 strscpy(fw_version, rdbuf, 2);
949
950 error = edt_ft5x06_ts_readwrite(client, 1, "\xA8",
951 1, rdbuf);
952 if (error)
953 return error;
954
955 /* This "model identification" is not exact. Unfortunately
956 * not all firmwares for the ft5x06 put useful values in
957 * the identification registers.
958 */
959 switch (rdbuf[0]) {
960 case 0x11: /* EDT EP0110M09 */
961 case 0x35: /* EDT EP0350M09 */
962 case 0x43: /* EDT EP0430M09 */
963 case 0x50: /* EDT EP0500M09 */
964 case 0x57: /* EDT EP0570M09 */
965 case 0x70: /* EDT EP0700M09 */
966 tsdata->version = EDT_M09;
967 snprintf(model_name, EDT_NAME_LEN, "EP0%i%i0M09",
968 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
969 break;
970 case 0xa1: /* EDT EP1010ML00 */
971 tsdata->version = EDT_M09;
972 snprintf(model_name, EDT_NAME_LEN, "EP%i%i0ML00",
973 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
974 break;
975 case 0x5a: /* Solomon Goldentek Display */
976 snprintf(model_name, EDT_NAME_LEN, "GKTW50SCED1R0");
977 break;
978 case 0x59: /* Evervision Display with FT5xx6 TS */
979 tsdata->version = EV_FT;
980 error = edt_ft5x06_ts_readwrite(client, 1, "\x53",
981 1, rdbuf);
982 if (error)
983 return error;
984 strscpy(fw_version, rdbuf, 1);
985 snprintf(model_name, EDT_NAME_LEN,
986 "EVERVISION-FT5726NEi");
987 break;
988 default:
989 snprintf(model_name, EDT_NAME_LEN,
990 "generic ft5x06 (%02x)",
991 rdbuf[0]);
992 break;
993 }
994 }
995
996 return 0;
997}
998
999static void edt_ft5x06_ts_get_defaults(struct device *dev,
1000 struct edt_ft5x06_ts_data *tsdata)
1001{
1002 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
1003 u32 val;
1004 int error;
1005
1006 error = device_property_read_u32(dev, "threshold", &val);
1007 if (!error) {
1008 edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold, val);
1009 tsdata->threshold = val;
1010 }
1011
1012 error = device_property_read_u32(dev, "gain", &val);
1013 if (!error) {
1014 edt_ft5x06_register_write(tsdata, reg_addr->reg_gain, val);
1015 tsdata->gain = val;
1016 }
1017
1018 error = device_property_read_u32(dev, "offset", &val);
1019 if (!error) {
1020 if (reg_addr->reg_offset != NO_REGISTER)
1021 edt_ft5x06_register_write(tsdata,
1022 reg_addr->reg_offset, val);
1023 tsdata->offset = val;
1024 }
1025
1026 error = device_property_read_u32(dev, "offset-x", &val);
1027 if (!error) {
1028 if (reg_addr->reg_offset_x != NO_REGISTER)
1029 edt_ft5x06_register_write(tsdata,
1030 reg_addr->reg_offset_x, val);
1031 tsdata->offset_x = val;
1032 }
1033
1034 error = device_property_read_u32(dev, "offset-y", &val);
1035 if (!error) {
1036 if (reg_addr->reg_offset_y != NO_REGISTER)
1037 edt_ft5x06_register_write(tsdata,
1038 reg_addr->reg_offset_y, val);
1039 tsdata->offset_y = val;
1040 }
1041}
1042
1043static void edt_ft5x06_ts_get_parameters(struct edt_ft5x06_ts_data *tsdata)
1044{
1045 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
1046
1047 tsdata->threshold = edt_ft5x06_register_read(tsdata,
1048 reg_addr->reg_threshold);
1049 tsdata->gain = edt_ft5x06_register_read(tsdata, reg_addr->reg_gain);
1050 if (reg_addr->reg_offset != NO_REGISTER)
1051 tsdata->offset =
1052 edt_ft5x06_register_read(tsdata, reg_addr->reg_offset);
1053 if (reg_addr->reg_offset_x != NO_REGISTER)
1054 tsdata->offset_x = edt_ft5x06_register_read(tsdata,
1055 reg_addr->reg_offset_x);
1056 if (reg_addr->reg_offset_y != NO_REGISTER)
1057 tsdata->offset_y = edt_ft5x06_register_read(tsdata,
1058 reg_addr->reg_offset_y);
1059 if (reg_addr->reg_report_rate != NO_REGISTER)
1060 tsdata->report_rate = edt_ft5x06_register_read(tsdata,
1061 reg_addr->reg_report_rate);
1062 tsdata->num_x = EDT_DEFAULT_NUM_X;
1063 if (reg_addr->reg_num_x != NO_REGISTER)
1064 tsdata->num_x = edt_ft5x06_register_read(tsdata,
1065 reg_addr->reg_num_x);
1066 tsdata->num_y = EDT_DEFAULT_NUM_Y;
1067 if (reg_addr->reg_num_y != NO_REGISTER)
1068 tsdata->num_y = edt_ft5x06_register_read(tsdata,
1069 reg_addr->reg_num_y);
1070}
1071
1072static void edt_ft5x06_ts_set_regs(struct edt_ft5x06_ts_data *tsdata)
1073{
1074 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
1075
1076 switch (tsdata->version) {
1077 case EDT_M06:
1078 reg_addr->reg_threshold = WORK_REGISTER_THRESHOLD;
1079 reg_addr->reg_report_rate = WORK_REGISTER_REPORT_RATE;
1080 reg_addr->reg_gain = WORK_REGISTER_GAIN;
1081 reg_addr->reg_offset = WORK_REGISTER_OFFSET;
1082 reg_addr->reg_offset_x = NO_REGISTER;
1083 reg_addr->reg_offset_y = NO_REGISTER;
1084 reg_addr->reg_num_x = WORK_REGISTER_NUM_X;
1085 reg_addr->reg_num_y = WORK_REGISTER_NUM_Y;
1086 break;
1087
1088 case EDT_M09:
1089 case EDT_M12:
1090 reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
1091 reg_addr->reg_report_rate = tsdata->version == EDT_M12 ?
1092 M12_REGISTER_REPORT_RATE : NO_REGISTER;
1093 reg_addr->reg_gain = M09_REGISTER_GAIN;
1094 reg_addr->reg_offset = M09_REGISTER_OFFSET;
1095 reg_addr->reg_offset_x = NO_REGISTER;
1096 reg_addr->reg_offset_y = NO_REGISTER;
1097 reg_addr->reg_num_x = M09_REGISTER_NUM_X;
1098 reg_addr->reg_num_y = M09_REGISTER_NUM_Y;
1099 break;
1100
1101 case EV_FT:
1102 reg_addr->reg_threshold = EV_REGISTER_THRESHOLD;
1103 reg_addr->reg_report_rate = NO_REGISTER;
1104 reg_addr->reg_gain = EV_REGISTER_GAIN;
1105 reg_addr->reg_offset = NO_REGISTER;
1106 reg_addr->reg_offset_x = EV_REGISTER_OFFSET_X;
1107 reg_addr->reg_offset_y = EV_REGISTER_OFFSET_Y;
1108 reg_addr->reg_num_x = NO_REGISTER;
1109 reg_addr->reg_num_y = NO_REGISTER;
1110 break;
1111
1112 case GENERIC_FT:
1113 /* this is a guesswork */
1114 reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
1115 reg_addr->reg_report_rate = NO_REGISTER;
1116 reg_addr->reg_gain = M09_REGISTER_GAIN;
1117 reg_addr->reg_offset = M09_REGISTER_OFFSET;
1118 reg_addr->reg_offset_x = NO_REGISTER;
1119 reg_addr->reg_offset_y = NO_REGISTER;
1120 reg_addr->reg_num_x = NO_REGISTER;
1121 reg_addr->reg_num_y = NO_REGISTER;
1122 break;
1123 }
1124}
1125
1126static void edt_ft5x06_disable_regulators(void *arg)
1127{
1128 struct edt_ft5x06_ts_data *data = arg;
1129
1130 regulator_disable(data->vcc);
1131 regulator_disable(data->iovcc);
1132}
1133
1134static int edt_ft5x06_ts_probe(struct i2c_client *client)
1135{
1136 const struct i2c_device_id *id = i2c_client_get_device_id(client);
1137 const struct edt_i2c_chip_data *chip_data;
1138 struct edt_ft5x06_ts_data *tsdata;
1139 u8 buf[2] = { 0xfc, 0x00 };
1140 struct input_dev *input;
1141 unsigned long irq_flags;
1142 int error;
1143 u32 report_rate;
1144
1145 dev_dbg(&client->dev, "probing for EDT FT5x06 I2C\n");
1146
1147 tsdata = devm_kzalloc(&client->dev, sizeof(*tsdata), GFP_KERNEL);
1148 if (!tsdata) {
1149 dev_err(&client->dev, "failed to allocate driver data.\n");
1150 return -ENOMEM;
1151 }
1152
1153 chip_data = device_get_match_data(&client->dev);
1154 if (!chip_data)
1155 chip_data = (const struct edt_i2c_chip_data *)id->driver_data;
1156 if (!chip_data || !chip_data->max_support_points) {
1157 dev_err(&client->dev, "invalid or missing chip data\n");
1158 return -EINVAL;
1159 }
1160
1161 tsdata->max_support_points = chip_data->max_support_points;
1162
1163 tsdata->vcc = devm_regulator_get(&client->dev, "vcc");
1164 if (IS_ERR(tsdata->vcc)) {
1165 error = PTR_ERR(tsdata->vcc);
1166 if (error != -EPROBE_DEFER)
1167 dev_err(&client->dev,
1168 "failed to request regulator: %d\n", error);
1169 return error;
1170 }
1171
1172 tsdata->iovcc = devm_regulator_get(&client->dev, "iovcc");
1173 if (IS_ERR(tsdata->iovcc)) {
1174 error = PTR_ERR(tsdata->iovcc);
1175 if (error != -EPROBE_DEFER)
1176 dev_err(&client->dev,
1177 "failed to request iovcc regulator: %d\n", error);
1178 return error;
1179 }
1180
1181 error = regulator_enable(tsdata->iovcc);
1182 if (error < 0) {
1183 dev_err(&client->dev, "failed to enable iovcc: %d\n", error);
1184 return error;
1185 }
1186
1187 /* Delay enabling VCC for > 10us (T_ivd) after IOVCC */
1188 usleep_range(10, 100);
1189
1190 error = regulator_enable(tsdata->vcc);
1191 if (error < 0) {
1192 dev_err(&client->dev, "failed to enable vcc: %d\n", error);
1193 regulator_disable(tsdata->iovcc);
1194 return error;
1195 }
1196
1197 error = devm_add_action_or_reset(&client->dev,
1198 edt_ft5x06_disable_regulators,
1199 tsdata);
1200 if (error)
1201 return error;
1202
1203 tsdata->reset_gpio = devm_gpiod_get_optional(&client->dev,
1204 "reset", GPIOD_OUT_HIGH);
1205 if (IS_ERR(tsdata->reset_gpio)) {
1206 error = PTR_ERR(tsdata->reset_gpio);
1207 dev_err(&client->dev,
1208 "Failed to request GPIO reset pin, error %d\n", error);
1209 return error;
1210 }
1211
1212 tsdata->wake_gpio = devm_gpiod_get_optional(&client->dev,
1213 "wake", GPIOD_OUT_LOW);
1214 if (IS_ERR(tsdata->wake_gpio)) {
1215 error = PTR_ERR(tsdata->wake_gpio);
1216 dev_err(&client->dev,
1217 "Failed to request GPIO wake pin, error %d\n", error);
1218 return error;
1219 }
1220
1221 /*
1222 * Check which sleep modes we can support. Power-off requieres the
1223 * reset-pin to ensure correct power-down/power-up behaviour. Start with
1224 * the EDT_PMODE_POWEROFF test since this is the deepest possible sleep
1225 * mode.
1226 */
1227 if (tsdata->reset_gpio)
1228 tsdata->suspend_mode = EDT_PMODE_POWEROFF;
1229 else if (tsdata->wake_gpio)
1230 tsdata->suspend_mode = EDT_PMODE_HIBERNATE;
1231 else
1232 tsdata->suspend_mode = EDT_PMODE_NOT_SUPPORTED;
1233
1234 if (tsdata->wake_gpio) {
1235 usleep_range(5000, 6000);
1236 gpiod_set_value_cansleep(tsdata->wake_gpio, 1);
1237 }
1238
1239 if (tsdata->reset_gpio) {
1240 usleep_range(5000, 6000);
1241 gpiod_set_value_cansleep(tsdata->reset_gpio, 0);
1242 msleep(300);
1243 }
1244
1245 input = devm_input_allocate_device(&client->dev);
1246 if (!input) {
1247 dev_err(&client->dev, "failed to allocate input device.\n");
1248 return -ENOMEM;
1249 }
1250
1251 mutex_init(&tsdata->mutex);
1252 tsdata->client = client;
1253 tsdata->input = input;
1254 tsdata->factory_mode = false;
1255
1256 error = edt_ft5x06_ts_identify(client, tsdata);
1257 if (error) {
1258 dev_err(&client->dev, "touchscreen probe failed\n");
1259 return error;
1260 }
1261
1262 /*
1263 * Dummy read access. EP0700MLP1 returns bogus data on the first
1264 * register read access and ignores writes.
1265 */
1266 edt_ft5x06_ts_readwrite(tsdata->client, 2, buf, 2, buf);
1267
1268 edt_ft5x06_ts_set_regs(tsdata);
1269 edt_ft5x06_ts_get_defaults(&client->dev, tsdata);
1270 edt_ft5x06_ts_get_parameters(tsdata);
1271
1272 if (tsdata->reg_addr.reg_report_rate != NO_REGISTER &&
1273 !device_property_read_u32(&client->dev,
1274 "report-rate-hz", &report_rate)) {
1275 if (tsdata->version == EDT_M06)
1276 tsdata->report_rate = clamp_val(report_rate, 30, 140);
1277 else
1278 tsdata->report_rate = clamp_val(report_rate, 1, 255);
1279
1280 if (report_rate != tsdata->report_rate)
1281 dev_warn(&client->dev,
1282 "report-rate %dHz is unsupported, use %dHz\n",
1283 report_rate, tsdata->report_rate);
1284
1285 if (tsdata->version == EDT_M06)
1286 tsdata->report_rate /= 10;
1287
1288 edt_ft5x06_register_write(tsdata,
1289 tsdata->reg_addr.reg_report_rate,
1290 tsdata->report_rate);
1291 }
1292
1293 dev_dbg(&client->dev,
1294 "Model \"%s\", Rev. \"%s\", %dx%d sensors\n",
1295 tsdata->name, tsdata->fw_version, tsdata->num_x, tsdata->num_y);
1296
1297 input->name = tsdata->name;
1298 input->id.bustype = BUS_I2C;
1299 input->dev.parent = &client->dev;
1300
1301 input_set_abs_params(input, ABS_MT_POSITION_X,
1302 0, tsdata->num_x * 64 - 1, 0, 0);
1303 input_set_abs_params(input, ABS_MT_POSITION_Y,
1304 0, tsdata->num_y * 64 - 1, 0, 0);
1305
1306 touchscreen_parse_properties(input, true, &tsdata->prop);
1307
1308 error = input_mt_init_slots(input, tsdata->max_support_points,
1309 INPUT_MT_DIRECT);
1310 if (error) {
1311 dev_err(&client->dev, "Unable to init MT slots.\n");
1312 return error;
1313 }
1314
1315 i2c_set_clientdata(client, tsdata);
1316
1317 irq_flags = irq_get_trigger_type(client->irq);
1318 if (irq_flags == IRQF_TRIGGER_NONE)
1319 irq_flags = IRQF_TRIGGER_FALLING;
1320 irq_flags |= IRQF_ONESHOT;
1321
1322 error = devm_request_threaded_irq(&client->dev, client->irq,
1323 NULL, edt_ft5x06_ts_isr, irq_flags,
1324 client->name, tsdata);
1325 if (error) {
1326 dev_err(&client->dev, "Unable to request touchscreen IRQ.\n");
1327 return error;
1328 }
1329
1330 error = devm_device_add_group(&client->dev, &edt_ft5x06_attr_group);
1331 if (error)
1332 return error;
1333
1334 error = input_register_device(input);
1335 if (error)
1336 return error;
1337
1338 edt_ft5x06_ts_prepare_debugfs(tsdata, dev_driver_string(&client->dev));
1339
1340 dev_dbg(&client->dev,
1341 "EDT FT5x06 initialized: IRQ %d, WAKE pin %d, Reset pin %d.\n",
1342 client->irq,
1343 tsdata->wake_gpio ? desc_to_gpio(tsdata->wake_gpio) : -1,
1344 tsdata->reset_gpio ? desc_to_gpio(tsdata->reset_gpio) : -1);
1345
1346 return 0;
1347}
1348
1349static void edt_ft5x06_ts_remove(struct i2c_client *client)
1350{
1351 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1352
1353 edt_ft5x06_ts_teardown_debugfs(tsdata);
1354}
1355
1356static int __maybe_unused edt_ft5x06_ts_suspend(struct device *dev)
1357{
1358 struct i2c_client *client = to_i2c_client(dev);
1359 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1360 struct gpio_desc *reset_gpio = tsdata->reset_gpio;
1361 int ret;
1362
1363 if (device_may_wakeup(dev))
1364 return 0;
1365
1366 if (tsdata->suspend_mode == EDT_PMODE_NOT_SUPPORTED)
1367 return 0;
1368
1369 /* Enter hibernate mode. */
1370 ret = edt_ft5x06_register_write(tsdata, PMOD_REGISTER_OPMODE,
1371 PMOD_REGISTER_HIBERNATE);
1372 if (ret)
1373 dev_warn(dev, "Failed to set hibernate mode\n");
1374
1375 if (tsdata->suspend_mode == EDT_PMODE_HIBERNATE)
1376 return 0;
1377
1378 /*
1379 * Power-off according the datasheet. Cut the power may leaf the irq
1380 * line in an undefined state depending on the host pull resistor
1381 * settings. Disable the irq to avoid adjusting each host till the
1382 * device is back in a full functional state.
1383 */
1384 disable_irq(tsdata->client->irq);
1385
1386 gpiod_set_value_cansleep(reset_gpio, 1);
1387 usleep_range(1000, 2000);
1388
1389 ret = regulator_disable(tsdata->vcc);
1390 if (ret)
1391 dev_warn(dev, "Failed to disable vcc\n");
1392 ret = regulator_disable(tsdata->iovcc);
1393 if (ret)
1394 dev_warn(dev, "Failed to disable iovcc\n");
1395
1396 return 0;
1397}
1398
1399static int __maybe_unused edt_ft5x06_ts_resume(struct device *dev)
1400{
1401 struct i2c_client *client = to_i2c_client(dev);
1402 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1403 int ret = 0;
1404
1405 if (device_may_wakeup(dev))
1406 return 0;
1407
1408 if (tsdata->suspend_mode == EDT_PMODE_NOT_SUPPORTED)
1409 return 0;
1410
1411 if (tsdata->suspend_mode == EDT_PMODE_POWEROFF) {
1412 struct gpio_desc *reset_gpio = tsdata->reset_gpio;
1413
1414 /*
1415 * We can't check if the regulator is a dummy or a real
1416 * regulator. So we need to specify the 5ms reset time (T_rst)
1417 * here instead of the 100us T_rtp time. We also need to wait
1418 * 300ms in case it was a real supply and the power was cutted
1419 * of. Toggle the reset pin is also a way to exit the hibernate
1420 * mode.
1421 */
1422 gpiod_set_value_cansleep(reset_gpio, 1);
1423 usleep_range(5000, 6000);
1424
1425 ret = regulator_enable(tsdata->iovcc);
1426 if (ret) {
1427 dev_err(dev, "Failed to enable iovcc\n");
1428 return ret;
1429 }
1430
1431 /* Delay enabling VCC for > 10us (T_ivd) after IOVCC */
1432 usleep_range(10, 100);
1433
1434 ret = regulator_enable(tsdata->vcc);
1435 if (ret) {
1436 dev_err(dev, "Failed to enable vcc\n");
1437 regulator_disable(tsdata->iovcc);
1438 return ret;
1439 }
1440
1441 usleep_range(1000, 2000);
1442 gpiod_set_value_cansleep(reset_gpio, 0);
1443 msleep(300);
1444
1445 edt_ft5x06_restore_reg_parameters(tsdata);
1446 enable_irq(tsdata->client->irq);
1447
1448 if (tsdata->factory_mode)
1449 ret = edt_ft5x06_factory_mode(tsdata);
1450 } else {
1451 struct gpio_desc *wake_gpio = tsdata->wake_gpio;
1452
1453 gpiod_set_value_cansleep(wake_gpio, 0);
1454 usleep_range(5000, 6000);
1455 gpiod_set_value_cansleep(wake_gpio, 1);
1456 }
1457
1458
1459 return ret;
1460}
1461
1462static SIMPLE_DEV_PM_OPS(edt_ft5x06_ts_pm_ops,
1463 edt_ft5x06_ts_suspend, edt_ft5x06_ts_resume);
1464
1465static const struct edt_i2c_chip_data edt_ft5x06_data = {
1466 .max_support_points = 5,
1467};
1468
1469static const struct edt_i2c_chip_data edt_ft5506_data = {
1470 .max_support_points = 10,
1471};
1472
1473static const struct edt_i2c_chip_data edt_ft6236_data = {
1474 .max_support_points = 2,
1475};
1476
1477static const struct i2c_device_id edt_ft5x06_ts_id[] = {
1478 { .name = "edt-ft5x06", .driver_data = (long)&edt_ft5x06_data },
1479 { .name = "edt-ft5506", .driver_data = (long)&edt_ft5506_data },
1480 { .name = "ev-ft5726", .driver_data = (long)&edt_ft5506_data },
1481 /* Note no edt- prefix for compatibility with the ft6236.c driver */
1482 { .name = "ft6236", .driver_data = (long)&edt_ft6236_data },
1483 { /* sentinel */ }
1484};
1485MODULE_DEVICE_TABLE(i2c, edt_ft5x06_ts_id);
1486
1487static const struct of_device_id edt_ft5x06_of_match[] = {
1488 { .compatible = "edt,edt-ft5206", .data = &edt_ft5x06_data },
1489 { .compatible = "edt,edt-ft5306", .data = &edt_ft5x06_data },
1490 { .compatible = "edt,edt-ft5406", .data = &edt_ft5x06_data },
1491 { .compatible = "edt,edt-ft5506", .data = &edt_ft5506_data },
1492 { .compatible = "evervision,ev-ft5726", .data = &edt_ft5506_data },
1493 /* Note focaltech vendor prefix for compatibility with ft6236.c */
1494 { .compatible = "focaltech,ft6236", .data = &edt_ft6236_data },
1495 { /* sentinel */ }
1496};
1497MODULE_DEVICE_TABLE(of, edt_ft5x06_of_match);
1498
1499static struct i2c_driver edt_ft5x06_ts_driver = {
1500 .driver = {
1501 .name = "edt_ft5x06",
1502 .of_match_table = edt_ft5x06_of_match,
1503 .pm = &edt_ft5x06_ts_pm_ops,
1504 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1505 },
1506 .id_table = edt_ft5x06_ts_id,
1507 .probe_new = edt_ft5x06_ts_probe,
1508 .remove = edt_ft5x06_ts_remove,
1509};
1510
1511module_i2c_driver(edt_ft5x06_ts_driver);
1512
1513MODULE_AUTHOR("Simon Budig <simon.budig@kernelconcepts.de>");
1514MODULE_DESCRIPTION("EDT FT5x06 I2C Touchscreen Driver");
1515MODULE_LICENSE("GPL v2");
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/irq.h>
31#include <linux/interrupt.h>
32#include <linux/input.h>
33#include <linux/i2c.h>
34#include <linux/uaccess.h>
35#include <linux/delay.h>
36#include <linux/debugfs.h>
37#include <linux/slab.h>
38#include <linux/gpio/consumer.h>
39#include <linux/input/mt.h>
40#include <linux/input/touchscreen.h>
41#include <linux/of_device.h>
42
43#define WORK_REGISTER_THRESHOLD 0x00
44#define WORK_REGISTER_REPORT_RATE 0x08
45#define WORK_REGISTER_GAIN 0x30
46#define WORK_REGISTER_OFFSET 0x31
47#define WORK_REGISTER_NUM_X 0x33
48#define WORK_REGISTER_NUM_Y 0x34
49
50#define M09_REGISTER_THRESHOLD 0x80
51#define M09_REGISTER_GAIN 0x92
52#define M09_REGISTER_OFFSET 0x93
53#define M09_REGISTER_NUM_X 0x94
54#define M09_REGISTER_NUM_Y 0x95
55
56#define NO_REGISTER 0xff
57
58#define WORK_REGISTER_OPMODE 0x3c
59#define FACTORY_REGISTER_OPMODE 0x01
60
61#define TOUCH_EVENT_DOWN 0x00
62#define TOUCH_EVENT_UP 0x01
63#define TOUCH_EVENT_ON 0x02
64#define TOUCH_EVENT_RESERVED 0x03
65
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 1 /* msec */
71
72enum edt_ver {
73 M06,
74 M09,
75};
76
77struct edt_reg_addr {
78 int reg_threshold;
79 int reg_report_rate;
80 int reg_gain;
81 int reg_offset;
82 int reg_num_x;
83 int reg_num_y;
84};
85
86struct edt_ft5x06_ts_data {
87 struct i2c_client *client;
88 struct input_dev *input;
89 struct touchscreen_properties prop;
90 u16 num_x;
91 u16 num_y;
92
93 struct gpio_desc *reset_gpio;
94 struct gpio_desc *wake_gpio;
95
96#if defined(CONFIG_DEBUG_FS)
97 struct dentry *debug_dir;
98 u8 *raw_buffer;
99 size_t raw_bufsize;
100#endif
101
102 struct mutex mutex;
103 bool factory_mode;
104 int threshold;
105 int gain;
106 int offset;
107 int report_rate;
108 int max_support_points;
109
110 char name[EDT_NAME_LEN];
111
112 struct edt_reg_addr reg_addr;
113 enum edt_ver version;
114};
115
116struct edt_i2c_chip_data {
117 int max_support_points;
118};
119
120static int edt_ft5x06_ts_readwrite(struct i2c_client *client,
121 u16 wr_len, u8 *wr_buf,
122 u16 rd_len, u8 *rd_buf)
123{
124 struct i2c_msg wrmsg[2];
125 int i = 0;
126 int ret;
127
128 if (wr_len) {
129 wrmsg[i].addr = client->addr;
130 wrmsg[i].flags = 0;
131 wrmsg[i].len = wr_len;
132 wrmsg[i].buf = wr_buf;
133 i++;
134 }
135 if (rd_len) {
136 wrmsg[i].addr = client->addr;
137 wrmsg[i].flags = I2C_M_RD;
138 wrmsg[i].len = rd_len;
139 wrmsg[i].buf = rd_buf;
140 i++;
141 }
142
143 ret = i2c_transfer(client->adapter, wrmsg, i);
144 if (ret < 0)
145 return ret;
146 if (ret != i)
147 return -EIO;
148
149 return 0;
150}
151
152static bool edt_ft5x06_ts_check_crc(struct edt_ft5x06_ts_data *tsdata,
153 u8 *buf, int buflen)
154{
155 int i;
156 u8 crc = 0;
157
158 for (i = 0; i < buflen - 1; i++)
159 crc ^= buf[i];
160
161 if (crc != buf[buflen-1]) {
162 dev_err_ratelimited(&tsdata->client->dev,
163 "crc error: 0x%02x expected, got 0x%02x\n",
164 crc, buf[buflen-1]);
165 return false;
166 }
167
168 return true;
169}
170
171static irqreturn_t edt_ft5x06_ts_isr(int irq, void *dev_id)
172{
173 struct edt_ft5x06_ts_data *tsdata = dev_id;
174 struct device *dev = &tsdata->client->dev;
175 u8 cmd;
176 u8 rdbuf[63];
177 int i, type, x, y, id;
178 int offset, tplen, datalen, crclen;
179 int error;
180
181 switch (tsdata->version) {
182 case M06:
183 cmd = 0xf9; /* tell the controller to send touch data */
184 offset = 5; /* where the actual touch data starts */
185 tplen = 4; /* data comes in so called frames */
186 crclen = 1; /* length of the crc data */
187 break;
188
189 case M09:
190 cmd = 0x0;
191 offset = 3;
192 tplen = 6;
193 crclen = 0;
194 break;
195
196 default:
197 goto out;
198 }
199
200 memset(rdbuf, 0, sizeof(rdbuf));
201 datalen = tplen * tsdata->max_support_points + offset + crclen;
202
203 error = edt_ft5x06_ts_readwrite(tsdata->client,
204 sizeof(cmd), &cmd,
205 datalen, rdbuf);
206 if (error) {
207 dev_err_ratelimited(dev, "Unable to fetch data, error: %d\n",
208 error);
209 goto out;
210 }
211
212 /* M09 does not send header or CRC */
213 if (tsdata->version == M06) {
214 if (rdbuf[0] != 0xaa || rdbuf[1] != 0xaa ||
215 rdbuf[2] != datalen) {
216 dev_err_ratelimited(dev,
217 "Unexpected header: %02x%02x%02x!\n",
218 rdbuf[0], rdbuf[1], rdbuf[2]);
219 goto out;
220 }
221
222 if (!edt_ft5x06_ts_check_crc(tsdata, rdbuf, datalen))
223 goto out;
224 }
225
226 for (i = 0; i < tsdata->max_support_points; i++) {
227 u8 *buf = &rdbuf[i * tplen + offset];
228 bool down;
229
230 type = buf[0] >> 6;
231 /* ignore Reserved events */
232 if (type == TOUCH_EVENT_RESERVED)
233 continue;
234
235 /* M06 sometimes sends bogus coordinates in TOUCH_DOWN */
236 if (tsdata->version == M06 && type == TOUCH_EVENT_DOWN)
237 continue;
238
239 x = ((buf[0] << 8) | buf[1]) & 0x0fff;
240 y = ((buf[2] << 8) | buf[3]) & 0x0fff;
241 id = (buf[2] >> 4) & 0x0f;
242 down = type != TOUCH_EVENT_UP;
243
244 input_mt_slot(tsdata->input, id);
245 input_mt_report_slot_state(tsdata->input, MT_TOOL_FINGER, down);
246
247 if (!down)
248 continue;
249
250 touchscreen_report_pos(tsdata->input, &tsdata->prop, x, y,
251 true);
252 }
253
254 input_mt_report_pointer_emulation(tsdata->input, true);
255 input_sync(tsdata->input);
256
257out:
258 return IRQ_HANDLED;
259}
260
261static int edt_ft5x06_register_write(struct edt_ft5x06_ts_data *tsdata,
262 u8 addr, u8 value)
263{
264 u8 wrbuf[4];
265
266 switch (tsdata->version) {
267 case M06:
268 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
269 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
270 wrbuf[2] = value;
271 wrbuf[3] = wrbuf[0] ^ wrbuf[1] ^ wrbuf[2];
272 return edt_ft5x06_ts_readwrite(tsdata->client, 4,
273 wrbuf, 0, NULL);
274 case M09:
275 wrbuf[0] = addr;
276 wrbuf[1] = value;
277
278 return edt_ft5x06_ts_readwrite(tsdata->client, 2,
279 wrbuf, 0, NULL);
280
281 default:
282 return -EINVAL;
283 }
284}
285
286static int edt_ft5x06_register_read(struct edt_ft5x06_ts_data *tsdata,
287 u8 addr)
288{
289 u8 wrbuf[2], rdbuf[2];
290 int error;
291
292 switch (tsdata->version) {
293 case M06:
294 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
295 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
296 wrbuf[1] |= tsdata->factory_mode ? 0x80 : 0x40;
297
298 error = edt_ft5x06_ts_readwrite(tsdata->client, 2, wrbuf, 2,
299 rdbuf);
300 if (error)
301 return error;
302
303 if ((wrbuf[0] ^ wrbuf[1] ^ rdbuf[0]) != rdbuf[1]) {
304 dev_err(&tsdata->client->dev,
305 "crc error: 0x%02x expected, got 0x%02x\n",
306 wrbuf[0] ^ wrbuf[1] ^ rdbuf[0],
307 rdbuf[1]);
308 return -EIO;
309 }
310 break;
311
312 case M09:
313 wrbuf[0] = addr;
314 error = edt_ft5x06_ts_readwrite(tsdata->client, 1,
315 wrbuf, 1, rdbuf);
316 if (error)
317 return error;
318 break;
319
320 default:
321 return -EINVAL;
322 }
323
324 return rdbuf[0];
325}
326
327struct edt_ft5x06_attribute {
328 struct device_attribute dattr;
329 size_t field_offset;
330 u8 limit_low;
331 u8 limit_high;
332 u8 addr_m06;
333 u8 addr_m09;
334};
335
336#define EDT_ATTR(_field, _mode, _addr_m06, _addr_m09, \
337 _limit_low, _limit_high) \
338 struct edt_ft5x06_attribute edt_ft5x06_attr_##_field = { \
339 .dattr = __ATTR(_field, _mode, \
340 edt_ft5x06_setting_show, \
341 edt_ft5x06_setting_store), \
342 .field_offset = offsetof(struct edt_ft5x06_ts_data, _field), \
343 .addr_m06 = _addr_m06, \
344 .addr_m09 = _addr_m09, \
345 .limit_low = _limit_low, \
346 .limit_high = _limit_high, \
347 }
348
349static ssize_t edt_ft5x06_setting_show(struct device *dev,
350 struct device_attribute *dattr,
351 char *buf)
352{
353 struct i2c_client *client = to_i2c_client(dev);
354 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
355 struct edt_ft5x06_attribute *attr =
356 container_of(dattr, struct edt_ft5x06_attribute, dattr);
357 u8 *field = (u8 *)tsdata + attr->field_offset;
358 int val;
359 size_t count = 0;
360 int error = 0;
361 u8 addr;
362
363 mutex_lock(&tsdata->mutex);
364
365 if (tsdata->factory_mode) {
366 error = -EIO;
367 goto out;
368 }
369
370 switch (tsdata->version) {
371 case M06:
372 addr = attr->addr_m06;
373 break;
374
375 case M09:
376 addr = attr->addr_m09;
377 break;
378
379 default:
380 error = -ENODEV;
381 goto out;
382 }
383
384 if (addr != NO_REGISTER) {
385 val = edt_ft5x06_register_read(tsdata, addr);
386 if (val < 0) {
387 error = val;
388 dev_err(&tsdata->client->dev,
389 "Failed to fetch attribute %s, error %d\n",
390 dattr->attr.name, error);
391 goto out;
392 }
393 } else {
394 val = *field;
395 }
396
397 if (val != *field) {
398 dev_warn(&tsdata->client->dev,
399 "%s: read (%d) and stored value (%d) differ\n",
400 dattr->attr.name, val, *field);
401 *field = val;
402 }
403
404 count = scnprintf(buf, PAGE_SIZE, "%d\n", val);
405out:
406 mutex_unlock(&tsdata->mutex);
407 return error ?: count;
408}
409
410static ssize_t edt_ft5x06_setting_store(struct device *dev,
411 struct device_attribute *dattr,
412 const char *buf, size_t count)
413{
414 struct i2c_client *client = to_i2c_client(dev);
415 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
416 struct edt_ft5x06_attribute *attr =
417 container_of(dattr, struct edt_ft5x06_attribute, dattr);
418 u8 *field = (u8 *)tsdata + attr->field_offset;
419 unsigned int val;
420 int error;
421 u8 addr;
422
423 mutex_lock(&tsdata->mutex);
424
425 if (tsdata->factory_mode) {
426 error = -EIO;
427 goto out;
428 }
429
430 error = kstrtouint(buf, 0, &val);
431 if (error)
432 goto out;
433
434 if (val < attr->limit_low || val > attr->limit_high) {
435 error = -ERANGE;
436 goto out;
437 }
438
439 switch (tsdata->version) {
440 case M06:
441 addr = attr->addr_m06;
442 break;
443
444 case M09:
445 addr = attr->addr_m09;
446 break;
447
448 default:
449 error = -ENODEV;
450 goto out;
451 }
452
453 if (addr != NO_REGISTER) {
454 error = edt_ft5x06_register_write(tsdata, addr, val);
455 if (error) {
456 dev_err(&tsdata->client->dev,
457 "Failed to update attribute %s, error: %d\n",
458 dattr->attr.name, error);
459 goto out;
460 }
461 }
462 *field = val;
463
464out:
465 mutex_unlock(&tsdata->mutex);
466 return error ?: count;
467}
468
469static EDT_ATTR(gain, S_IWUSR | S_IRUGO, WORK_REGISTER_GAIN,
470 M09_REGISTER_GAIN, 0, 31);
471static EDT_ATTR(offset, S_IWUSR | S_IRUGO, WORK_REGISTER_OFFSET,
472 M09_REGISTER_OFFSET, 0, 31);
473static EDT_ATTR(threshold, S_IWUSR | S_IRUGO, WORK_REGISTER_THRESHOLD,
474 M09_REGISTER_THRESHOLD, 20, 80);
475static EDT_ATTR(report_rate, S_IWUSR | S_IRUGO, WORK_REGISTER_REPORT_RATE,
476 NO_REGISTER, 3, 14);
477
478static struct attribute *edt_ft5x06_attrs[] = {
479 &edt_ft5x06_attr_gain.dattr.attr,
480 &edt_ft5x06_attr_offset.dattr.attr,
481 &edt_ft5x06_attr_threshold.dattr.attr,
482 &edt_ft5x06_attr_report_rate.dattr.attr,
483 NULL
484};
485
486static const struct attribute_group edt_ft5x06_attr_group = {
487 .attrs = edt_ft5x06_attrs,
488};
489
490#ifdef CONFIG_DEBUG_FS
491static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
492{
493 struct i2c_client *client = tsdata->client;
494 int retries = EDT_SWITCH_MODE_RETRIES;
495 int ret;
496 int error;
497
498 disable_irq(client->irq);
499
500 if (!tsdata->raw_buffer) {
501 tsdata->raw_bufsize = tsdata->num_x * tsdata->num_y *
502 sizeof(u16);
503 tsdata->raw_buffer = kzalloc(tsdata->raw_bufsize, GFP_KERNEL);
504 if (!tsdata->raw_buffer) {
505 error = -ENOMEM;
506 goto err_out;
507 }
508 }
509
510 /* mode register is 0x3c when in the work mode */
511 if (tsdata->version == M09)
512 goto m09_out;
513
514 error = edt_ft5x06_register_write(tsdata, WORK_REGISTER_OPMODE, 0x03);
515 if (error) {
516 dev_err(&client->dev,
517 "failed to switch to factory mode, error %d\n", error);
518 goto err_out;
519 }
520
521 tsdata->factory_mode = true;
522 do {
523 mdelay(EDT_SWITCH_MODE_DELAY);
524 /* mode register is 0x01 when in factory mode */
525 ret = edt_ft5x06_register_read(tsdata, FACTORY_REGISTER_OPMODE);
526 if (ret == 0x03)
527 break;
528 } while (--retries > 0);
529
530 if (retries == 0) {
531 dev_err(&client->dev, "not in factory mode after %dms.\n",
532 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
533 error = -EIO;
534 goto err_out;
535 }
536
537 return 0;
538
539err_out:
540 kfree(tsdata->raw_buffer);
541 tsdata->raw_buffer = NULL;
542 tsdata->factory_mode = false;
543 enable_irq(client->irq);
544
545 return error;
546
547m09_out:
548 dev_err(&client->dev, "No factory mode support for M09\n");
549 return -EINVAL;
550
551}
552
553static int edt_ft5x06_work_mode(struct edt_ft5x06_ts_data *tsdata)
554{
555 struct i2c_client *client = tsdata->client;
556 int retries = EDT_SWITCH_MODE_RETRIES;
557 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
558 int ret;
559 int error;
560
561 /* mode register is 0x01 when in the factory mode */
562 error = edt_ft5x06_register_write(tsdata, FACTORY_REGISTER_OPMODE, 0x1);
563 if (error) {
564 dev_err(&client->dev,
565 "failed to switch to work mode, error: %d\n", error);
566 return error;
567 }
568
569 tsdata->factory_mode = false;
570
571 do {
572 mdelay(EDT_SWITCH_MODE_DELAY);
573 /* mode register is 0x01 when in factory mode */
574 ret = edt_ft5x06_register_read(tsdata, WORK_REGISTER_OPMODE);
575 if (ret == 0x01)
576 break;
577 } while (--retries > 0);
578
579 if (retries == 0) {
580 dev_err(&client->dev, "not in work mode after %dms.\n",
581 EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
582 tsdata->factory_mode = true;
583 return -EIO;
584 }
585
586 kfree(tsdata->raw_buffer);
587 tsdata->raw_buffer = NULL;
588
589 /* restore parameters */
590 edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold,
591 tsdata->threshold);
592 edt_ft5x06_register_write(tsdata, reg_addr->reg_gain,
593 tsdata->gain);
594 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset,
595 tsdata->offset);
596 if (reg_addr->reg_report_rate)
597 edt_ft5x06_register_write(tsdata, reg_addr->reg_report_rate,
598 tsdata->report_rate);
599
600 enable_irq(client->irq);
601
602 return 0;
603}
604
605static int edt_ft5x06_debugfs_mode_get(void *data, u64 *mode)
606{
607 struct edt_ft5x06_ts_data *tsdata = data;
608
609 *mode = tsdata->factory_mode;
610
611 return 0;
612};
613
614static int edt_ft5x06_debugfs_mode_set(void *data, u64 mode)
615{
616 struct edt_ft5x06_ts_data *tsdata = data;
617 int retval = 0;
618
619 if (mode > 1)
620 return -ERANGE;
621
622 mutex_lock(&tsdata->mutex);
623
624 if (mode != tsdata->factory_mode) {
625 retval = mode ? edt_ft5x06_factory_mode(tsdata) :
626 edt_ft5x06_work_mode(tsdata);
627 }
628
629 mutex_unlock(&tsdata->mutex);
630
631 return retval;
632};
633
634DEFINE_SIMPLE_ATTRIBUTE(debugfs_mode_fops, edt_ft5x06_debugfs_mode_get,
635 edt_ft5x06_debugfs_mode_set, "%llu\n");
636
637static ssize_t edt_ft5x06_debugfs_raw_data_read(struct file *file,
638 char __user *buf, size_t count, loff_t *off)
639{
640 struct edt_ft5x06_ts_data *tsdata = file->private_data;
641 struct i2c_client *client = tsdata->client;
642 int retries = EDT_RAW_DATA_RETRIES;
643 int val, i, error;
644 size_t read = 0;
645 int colbytes;
646 char wrbuf[3];
647 u8 *rdbuf;
648
649 if (*off < 0 || *off >= tsdata->raw_bufsize)
650 return 0;
651
652 mutex_lock(&tsdata->mutex);
653
654 if (!tsdata->factory_mode || !tsdata->raw_buffer) {
655 error = -EIO;
656 goto out;
657 }
658
659 error = edt_ft5x06_register_write(tsdata, 0x08, 0x01);
660 if (error) {
661 dev_dbg(&client->dev,
662 "failed to write 0x08 register, error %d\n", error);
663 goto out;
664 }
665
666 do {
667 msleep(EDT_RAW_DATA_DELAY);
668 val = edt_ft5x06_register_read(tsdata, 0x08);
669 if (val < 1)
670 break;
671 } while (--retries > 0);
672
673 if (val < 0) {
674 error = val;
675 dev_dbg(&client->dev,
676 "failed to read 0x08 register, error %d\n", error);
677 goto out;
678 }
679
680 if (retries == 0) {
681 dev_dbg(&client->dev,
682 "timed out waiting for register to settle\n");
683 error = -ETIMEDOUT;
684 goto out;
685 }
686
687 rdbuf = tsdata->raw_buffer;
688 colbytes = tsdata->num_y * sizeof(u16);
689
690 wrbuf[0] = 0xf5;
691 wrbuf[1] = 0x0e;
692 for (i = 0; i < tsdata->num_x; i++) {
693 wrbuf[2] = i; /* column index */
694 error = edt_ft5x06_ts_readwrite(tsdata->client,
695 sizeof(wrbuf), wrbuf,
696 colbytes, rdbuf);
697 if (error)
698 goto out;
699
700 rdbuf += colbytes;
701 }
702
703 read = min_t(size_t, count, tsdata->raw_bufsize - *off);
704 if (copy_to_user(buf, tsdata->raw_buffer + *off, read)) {
705 error = -EFAULT;
706 goto out;
707 }
708
709 *off += read;
710out:
711 mutex_unlock(&tsdata->mutex);
712 return error ?: read;
713};
714
715static const struct file_operations debugfs_raw_data_fops = {
716 .open = simple_open,
717 .read = edt_ft5x06_debugfs_raw_data_read,
718};
719
720static void
721edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
722 const char *debugfs_name)
723{
724 tsdata->debug_dir = debugfs_create_dir(debugfs_name, NULL);
725 if (!tsdata->debug_dir)
726 return;
727
728 debugfs_create_u16("num_x", S_IRUSR, tsdata->debug_dir, &tsdata->num_x);
729 debugfs_create_u16("num_y", S_IRUSR, tsdata->debug_dir, &tsdata->num_y);
730
731 debugfs_create_file("mode", S_IRUSR | S_IWUSR,
732 tsdata->debug_dir, tsdata, &debugfs_mode_fops);
733 debugfs_create_file("raw_data", S_IRUSR,
734 tsdata->debug_dir, tsdata, &debugfs_raw_data_fops);
735}
736
737static void
738edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
739{
740 debugfs_remove_recursive(tsdata->debug_dir);
741 kfree(tsdata->raw_buffer);
742}
743
744#else
745
746static inline void
747edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
748 const char *debugfs_name)
749{
750}
751
752static inline void
753edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
754{
755}
756
757#endif /* CONFIG_DEBUGFS */
758
759static int edt_ft5x06_ts_identify(struct i2c_client *client,
760 struct edt_ft5x06_ts_data *tsdata,
761 char *fw_version)
762{
763 u8 rdbuf[EDT_NAME_LEN];
764 char *p;
765 int error;
766 char *model_name = tsdata->name;
767
768 /* see what we find if we assume it is a M06 *
769 * if we get less than EDT_NAME_LEN, we don't want
770 * to have garbage in there
771 */
772 memset(rdbuf, 0, sizeof(rdbuf));
773 error = edt_ft5x06_ts_readwrite(client, 1, "\xbb",
774 EDT_NAME_LEN - 1, rdbuf);
775 if (error)
776 return error;
777
778 /* if we find something consistent, stay with that assumption
779 * at least M09 won't send 3 bytes here
780 */
781 if (!(strncasecmp(rdbuf + 1, "EP0", 3))) {
782 tsdata->version = M06;
783
784 /* remove last '$' end marker */
785 rdbuf[EDT_NAME_LEN - 1] = '\0';
786 if (rdbuf[EDT_NAME_LEN - 2] == '$')
787 rdbuf[EDT_NAME_LEN - 2] = '\0';
788
789 /* look for Model/Version separator */
790 p = strchr(rdbuf, '*');
791 if (p)
792 *p++ = '\0';
793 strlcpy(model_name, rdbuf + 1, EDT_NAME_LEN);
794 strlcpy(fw_version, p ? p : "", EDT_NAME_LEN);
795 } else {
796 /* since there are only two versions around (M06, M09) */
797 tsdata->version = M09;
798
799 error = edt_ft5x06_ts_readwrite(client, 1, "\xA6",
800 2, rdbuf);
801 if (error)
802 return error;
803
804 strlcpy(fw_version, rdbuf, 2);
805
806 error = edt_ft5x06_ts_readwrite(client, 1, "\xA8",
807 1, rdbuf);
808 if (error)
809 return error;
810
811 snprintf(model_name, EDT_NAME_LEN, "EP0%i%i0M09",
812 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
813 }
814
815 return 0;
816}
817
818static void edt_ft5x06_ts_get_defaults(struct device *dev,
819 struct edt_ft5x06_ts_data *tsdata)
820{
821 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
822 u32 val;
823 int error;
824
825 error = device_property_read_u32(dev, "threshold", &val);
826 if (!error) {
827 edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold, val);
828 tsdata->threshold = val;
829 }
830
831 error = device_property_read_u32(dev, "gain", &val);
832 if (!error) {
833 edt_ft5x06_register_write(tsdata, reg_addr->reg_gain, val);
834 tsdata->gain = val;
835 }
836
837 error = device_property_read_u32(dev, "offset", &val);
838 if (!error) {
839 edt_ft5x06_register_write(tsdata, reg_addr->reg_offset, val);
840 tsdata->offset = val;
841 }
842}
843
844static void
845edt_ft5x06_ts_get_parameters(struct edt_ft5x06_ts_data *tsdata)
846{
847 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
848
849 tsdata->threshold = edt_ft5x06_register_read(tsdata,
850 reg_addr->reg_threshold);
851 tsdata->gain = edt_ft5x06_register_read(tsdata, reg_addr->reg_gain);
852 tsdata->offset = edt_ft5x06_register_read(tsdata, reg_addr->reg_offset);
853 if (reg_addr->reg_report_rate != NO_REGISTER)
854 tsdata->report_rate = edt_ft5x06_register_read(tsdata,
855 reg_addr->reg_report_rate);
856 tsdata->num_x = edt_ft5x06_register_read(tsdata, reg_addr->reg_num_x);
857 tsdata->num_y = edt_ft5x06_register_read(tsdata, reg_addr->reg_num_y);
858}
859
860static void
861edt_ft5x06_ts_set_regs(struct edt_ft5x06_ts_data *tsdata)
862{
863 struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
864
865 switch (tsdata->version) {
866 case M06:
867 reg_addr->reg_threshold = WORK_REGISTER_THRESHOLD;
868 reg_addr->reg_report_rate = WORK_REGISTER_REPORT_RATE;
869 reg_addr->reg_gain = WORK_REGISTER_GAIN;
870 reg_addr->reg_offset = WORK_REGISTER_OFFSET;
871 reg_addr->reg_num_x = WORK_REGISTER_NUM_X;
872 reg_addr->reg_num_y = WORK_REGISTER_NUM_Y;
873 break;
874
875 case M09:
876 reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
877 reg_addr->reg_gain = M09_REGISTER_GAIN;
878 reg_addr->reg_offset = M09_REGISTER_OFFSET;
879 reg_addr->reg_num_x = M09_REGISTER_NUM_X;
880 reg_addr->reg_num_y = M09_REGISTER_NUM_Y;
881 break;
882 }
883}
884
885static int edt_ft5x06_ts_probe(struct i2c_client *client,
886 const struct i2c_device_id *id)
887{
888 const struct edt_i2c_chip_data *chip_data;
889 struct edt_ft5x06_ts_data *tsdata;
890 struct input_dev *input;
891 unsigned long irq_flags;
892 int error;
893 char fw_version[EDT_NAME_LEN];
894
895 dev_dbg(&client->dev, "probing for EDT FT5x06 I2C\n");
896
897 tsdata = devm_kzalloc(&client->dev, sizeof(*tsdata), GFP_KERNEL);
898 if (!tsdata) {
899 dev_err(&client->dev, "failed to allocate driver data.\n");
900 return -ENOMEM;
901 }
902
903 chip_data = of_device_get_match_data(&client->dev);
904 if (!chip_data)
905 chip_data = (const struct edt_i2c_chip_data *)id->driver_data;
906 if (!chip_data || !chip_data->max_support_points) {
907 dev_err(&client->dev, "invalid or missing chip data\n");
908 return -EINVAL;
909 }
910
911 tsdata->max_support_points = chip_data->max_support_points;
912
913 tsdata->reset_gpio = devm_gpiod_get_optional(&client->dev,
914 "reset", GPIOD_OUT_HIGH);
915 if (IS_ERR(tsdata->reset_gpio)) {
916 error = PTR_ERR(tsdata->reset_gpio);
917 dev_err(&client->dev,
918 "Failed to request GPIO reset pin, error %d\n", error);
919 return error;
920 }
921
922 tsdata->wake_gpio = devm_gpiod_get_optional(&client->dev,
923 "wake", GPIOD_OUT_LOW);
924 if (IS_ERR(tsdata->wake_gpio)) {
925 error = PTR_ERR(tsdata->wake_gpio);
926 dev_err(&client->dev,
927 "Failed to request GPIO wake pin, error %d\n", error);
928 return error;
929 }
930
931 if (tsdata->wake_gpio) {
932 usleep_range(5000, 6000);
933 gpiod_set_value_cansleep(tsdata->wake_gpio, 1);
934 }
935
936 if (tsdata->reset_gpio) {
937 usleep_range(5000, 6000);
938 gpiod_set_value_cansleep(tsdata->reset_gpio, 0);
939 msleep(300);
940 }
941
942 input = devm_input_allocate_device(&client->dev);
943 if (!input) {
944 dev_err(&client->dev, "failed to allocate input device.\n");
945 return -ENOMEM;
946 }
947
948 mutex_init(&tsdata->mutex);
949 tsdata->client = client;
950 tsdata->input = input;
951 tsdata->factory_mode = false;
952
953 error = edt_ft5x06_ts_identify(client, tsdata, fw_version);
954 if (error) {
955 dev_err(&client->dev, "touchscreen probe failed\n");
956 return error;
957 }
958
959 edt_ft5x06_ts_set_regs(tsdata);
960 edt_ft5x06_ts_get_defaults(&client->dev, tsdata);
961 edt_ft5x06_ts_get_parameters(tsdata);
962
963 dev_dbg(&client->dev,
964 "Model \"%s\", Rev. \"%s\", %dx%d sensors\n",
965 tsdata->name, fw_version, tsdata->num_x, tsdata->num_y);
966
967 input->name = tsdata->name;
968 input->id.bustype = BUS_I2C;
969 input->dev.parent = &client->dev;
970
971 input_set_abs_params(input, ABS_MT_POSITION_X,
972 0, tsdata->num_x * 64 - 1, 0, 0);
973 input_set_abs_params(input, ABS_MT_POSITION_Y,
974 0, tsdata->num_y * 64 - 1, 0, 0);
975
976 touchscreen_parse_properties(input, true, &tsdata->prop);
977
978 error = input_mt_init_slots(input, tsdata->max_support_points,
979 INPUT_MT_DIRECT);
980 if (error) {
981 dev_err(&client->dev, "Unable to init MT slots.\n");
982 return error;
983 }
984
985 input_set_drvdata(input, tsdata);
986 i2c_set_clientdata(client, tsdata);
987
988 irq_flags = irq_get_trigger_type(client->irq);
989 if (irq_flags == IRQF_TRIGGER_NONE)
990 irq_flags = IRQF_TRIGGER_FALLING;
991 irq_flags |= IRQF_ONESHOT;
992
993 error = devm_request_threaded_irq(&client->dev, client->irq,
994 NULL, edt_ft5x06_ts_isr, irq_flags,
995 client->name, tsdata);
996 if (error) {
997 dev_err(&client->dev, "Unable to request touchscreen IRQ.\n");
998 return error;
999 }
1000
1001 error = sysfs_create_group(&client->dev.kobj, &edt_ft5x06_attr_group);
1002 if (error)
1003 return error;
1004
1005 error = input_register_device(input);
1006 if (error)
1007 goto err_remove_attrs;
1008
1009 edt_ft5x06_ts_prepare_debugfs(tsdata, dev_driver_string(&client->dev));
1010 device_init_wakeup(&client->dev, 1);
1011
1012 dev_dbg(&client->dev,
1013 "EDT FT5x06 initialized: IRQ %d, WAKE pin %d, Reset pin %d.\n",
1014 client->irq,
1015 tsdata->wake_gpio ? desc_to_gpio(tsdata->wake_gpio) : -1,
1016 tsdata->reset_gpio ? desc_to_gpio(tsdata->reset_gpio) : -1);
1017
1018 return 0;
1019
1020err_remove_attrs:
1021 sysfs_remove_group(&client->dev.kobj, &edt_ft5x06_attr_group);
1022 return error;
1023}
1024
1025static int edt_ft5x06_ts_remove(struct i2c_client *client)
1026{
1027 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1028
1029 edt_ft5x06_ts_teardown_debugfs(tsdata);
1030 sysfs_remove_group(&client->dev.kobj, &edt_ft5x06_attr_group);
1031
1032 return 0;
1033}
1034
1035static int __maybe_unused edt_ft5x06_ts_suspend(struct device *dev)
1036{
1037 struct i2c_client *client = to_i2c_client(dev);
1038
1039 if (device_may_wakeup(dev))
1040 enable_irq_wake(client->irq);
1041
1042 return 0;
1043}
1044
1045static int __maybe_unused edt_ft5x06_ts_resume(struct device *dev)
1046{
1047 struct i2c_client *client = to_i2c_client(dev);
1048
1049 if (device_may_wakeup(dev))
1050 disable_irq_wake(client->irq);
1051
1052 return 0;
1053}
1054
1055static SIMPLE_DEV_PM_OPS(edt_ft5x06_ts_pm_ops,
1056 edt_ft5x06_ts_suspend, edt_ft5x06_ts_resume);
1057
1058static const struct edt_i2c_chip_data edt_ft5x06_data = {
1059 .max_support_points = 5,
1060};
1061
1062static const struct edt_i2c_chip_data edt_ft5506_data = {
1063 .max_support_points = 10,
1064};
1065
1066static const struct edt_i2c_chip_data edt_ft6236_data = {
1067 .max_support_points = 2,
1068};
1069
1070static const struct i2c_device_id edt_ft5x06_ts_id[] = {
1071 { .name = "edt-ft5x06", .driver_data = (long)&edt_ft5x06_data },
1072 { .name = "edt-ft5506", .driver_data = (long)&edt_ft5506_data },
1073 /* Note no edt- prefix for compatibility with the ft6236.c driver */
1074 { .name = "ft6236", .driver_data = (long)&edt_ft6236_data },
1075 { /* sentinel */ }
1076};
1077MODULE_DEVICE_TABLE(i2c, edt_ft5x06_ts_id);
1078
1079#ifdef CONFIG_OF
1080static const struct of_device_id edt_ft5x06_of_match[] = {
1081 { .compatible = "edt,edt-ft5206", .data = &edt_ft5x06_data },
1082 { .compatible = "edt,edt-ft5306", .data = &edt_ft5x06_data },
1083 { .compatible = "edt,edt-ft5406", .data = &edt_ft5x06_data },
1084 { .compatible = "edt,edt-ft5506", .data = &edt_ft5506_data },
1085 /* Note focaltech vendor prefix for compatibility with ft6236.c */
1086 { .compatible = "focaltech,ft6236", .data = &edt_ft6236_data },
1087 { /* sentinel */ }
1088};
1089MODULE_DEVICE_TABLE(of, edt_ft5x06_of_match);
1090#endif
1091
1092static struct i2c_driver edt_ft5x06_ts_driver = {
1093 .driver = {
1094 .name = "edt_ft5x06",
1095 .of_match_table = of_match_ptr(edt_ft5x06_of_match),
1096 .pm = &edt_ft5x06_ts_pm_ops,
1097 },
1098 .id_table = edt_ft5x06_ts_id,
1099 .probe = edt_ft5x06_ts_probe,
1100 .remove = edt_ft5x06_ts_remove,
1101};
1102
1103module_i2c_driver(edt_ft5x06_ts_driver);
1104
1105MODULE_AUTHOR("Simon Budig <simon.budig@kernelconcepts.de>");
1106MODULE_DESCRIPTION("EDT FT5x06 I2C Touchscreen Driver");
1107MODULE_LICENSE("GPL");