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