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