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,
 295                                                 2, wrbuf, 2, rdbuf);
 296                 return error;
 297
 298                 if ((wrbuf[0] ^ wrbuf[1] ^ rdbuf[0]) != rdbuf[1]) {
 299                         dev_err(&tsdata->client->dev,
 300                                 "crc error: 0x%02x expected, got 0x%02x\n",
 301                                 wrbuf[0] ^ wrbuf[1] ^ rdbuf[0],
 302                                 rdbuf[1]);
 303                         return -EIO;
 304                 }
 305                 break;
 306
 307         case M09:
 308                 wrbuf[0] = addr;
 309                 error = edt_ft5x06_ts_readwrite(tsdata->client, 1,
 310                                                 wrbuf, 1, rdbuf);
 311                 if (error)
 312                         return error;
 313                 break;
 314
 315         default:
 316                 return -EINVAL;
 317         }
 318
 319         return rdbuf[0];
 320 }
 321
 322 struct edt_ft5x06_attribute {
 323         struct device_attribute dattr;
 324         size_t field_offset;
 325         u8 limit_low;
 326         u8 limit_high;
 327         u8 addr_m06;
 328         u8 addr_m09;
 329 };
 330
 331 #define EDT_ATTR(_field, _mode, _addr_m06, _addr_m09,                   \
 332                 _limit_low, _limit_high)                                \
 333         struct edt_ft5x06_attribute edt_ft5x06_attr_##_field = {        \
 334                 .dattr = __ATTR(_field, _mode,                          \
 335                                 edt_ft5x06_setting_show,                \
 336                                 edt_ft5x06_setting_store),              \
 337                 .field_offset = offsetof(struct edt_ft5x06_ts_data, _field), \
 338                 .addr_m06 = _addr_m06,                                  \
 339                 .addr_m09 = _addr_m09,                                  \
 340                 .limit_low = _limit_low,                                \
 341                 .limit_high = _limit_high,                              \
 342         }
 343
 344 static ssize_t edt_ft5x06_setting_show(struct device *dev,
 345                                        struct device_attribute *dattr,
 346                                        char *buf)
 347 {
 348         struct i2c_client *client = to_i2c_client(dev);
 349         struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
 350         struct edt_ft5x06_attribute *attr =
 351                         container_of(dattr, struct edt_ft5x06_attribute, dattr);
 352         u8 *field = (u8 *)((char *)tsdata + attr->field_offset);
 353         int val;
 354         size_t count = 0;
 355         int error = 0;
 356         u8 addr;
 357
 358         mutex_lock(&tsdata->mutex);
 359
 360         if (tsdata->factory_mode) {
 361                 error = -EIO;
 362                 goto out;
 363         }
 364
 365         switch (tsdata->version) {
 366         case M06:
 367                 addr = attr->addr_m06;
 368                 break;
 369
 370         case M09:
 371                 addr = attr->addr_m09;
 372                 break;
 373
 374         default:
 375                 error = -ENODEV;
 376                 goto out;
 377         }
 378
 379         if (addr != NO_REGISTER) {
 380                 val = edt_ft5x06_register_read(tsdata, addr);
 381                 if (val < 0) {
 382                         error = val;
 383                         dev_err(&tsdata->client->dev,
 384                                 "Failed to fetch attribute %s, error %d\n",
 385                                 dattr->attr.name, error);
 386                         goto out;
 387                 }
 388         } else {
 389                 val = *field;
 390         }
 391
 392         if (val != *field) {
 393                 dev_warn(&tsdata->client->dev,
 394                          "%s: read (%d) and stored value (%d) differ\n",
 395                          dattr->attr.name, val, *field);
 396                 *field = val;
 397         }
 398
 399         count = scnprintf(buf, PAGE_SIZE, "%d\n", val);
 400 out:
 401         mutex_unlock(&tsdata->mutex);
 402         return error ?: count;
 403 }
 404
 405 static ssize_t edt_ft5x06_setting_store(struct device *dev,
 406                                         struct device_attribute *dattr,
 407                                         const char *buf, size_t count)
 408 {
 409         struct i2c_client *client = to_i2c_client(dev);
 410         struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
 411         struct edt_ft5x06_attribute *attr =
 412                         container_of(dattr, struct edt_ft5x06_attribute, dattr);
 413         u8 *field = (u8 *)((char *)tsdata + attr->field_offset);
 414         unsigned int val;
 415         int error;
 416         u8 addr;
 417
 418         mutex_lock(&tsdata->mutex);
 419
 420         if (tsdata->factory_mode) {
 421                 error = -EIO;
 422                 goto out;
 423         }
 424
 425         error = kstrtouint(buf, 0, &val);
 426         if (error)
 427                 goto out;
 428
 429         if (val < attr->limit_low || val > attr->limit_high) {
 430                 error = -ERANGE;
 431                 goto out;
 432         }
 433
 434         switch (tsdata->version) {
 435         case M06:
 436                 addr = attr->addr_m06;
 437                 break;
 438
 439         case M09:
 440                 addr = attr->addr_m09;
 441                 break;
 442
 443         default:
 444                 error = -ENODEV;
 445                 goto out;
 446         }
 447
 448         if (addr != NO_REGISTER) {
 449                 error = edt_ft5x06_register_write(tsdata, addr, val);
 450                 if (error) {
 451                         dev_err(&tsdata->client->dev,
 452                                 "Failed to update attribute %s, error: %d\n",
 453                                 dattr->attr.name, error);
 454                         goto out;
 455                 }
 456         }
 457         *field = val;
 458
 459 out:
 460         mutex_unlock(&tsdata->mutex);
 461         return error ?: count;
 462 }
 463
 464 static EDT_ATTR(gain, S_IWUSR | S_IRUGO, WORK_REGISTER_GAIN,
 465                 M09_REGISTER_GAIN, 0, 31);
 466 static EDT_ATTR(offset, S_IWUSR | S_IRUGO, WORK_REGISTER_OFFSET,
 467                 M09_REGISTER_OFFSET, 0, 31);
 468 static EDT_ATTR(threshold, S_IWUSR | S_IRUGO, WORK_REGISTER_THRESHOLD,
 469                 M09_REGISTER_THRESHOLD, 20, 80);
 470 static EDT_ATTR(report_rate, S_IWUSR | S_IRUGO, WORK_REGISTER_REPORT_RATE,
 471                 NO_REGISTER, 3, 14);
 472
 473 static struct attribute *edt_ft5x06_attrs[] = {
 474         &edt_ft5x06_attr_gain.dattr.attr,
 475         &edt_ft5x06_attr_offset.dattr.attr,
 476         &edt_ft5x06_attr_threshold.dattr.attr,
 477         &edt_ft5x06_attr_report_rate.dattr.attr,
 478         NULL
 479 };
 480
 481 static const struct attribute_group edt_ft5x06_attr_group = {
 482         .attrs = edt_ft5x06_attrs,
 483 };
 484
 485 #ifdef CONFIG_DEBUG_FS
 486 static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
 487 {
 488         struct i2c_client *client = tsdata->client;
 489         int retries = EDT_SWITCH_MODE_RETRIES;
 490         int ret;
 491         int error;
 492
 493         disable_irq(client->irq);
 494
 495         if (!tsdata->raw_buffer) {
 496                 tsdata->raw_bufsize = tsdata->num_x * tsdata->num_y *
 497                                       sizeof(u16);
 498                 tsdata->raw_buffer = kzalloc(tsdata->raw_bufsize, GFP_KERNEL);
 499                 if (!tsdata->raw_buffer) {
 500                         error = -ENOMEM;
 501                         goto err_out;
 502                 }
 503         }
 504
 505         /* mode register is 0x3c when in the work mode */
 506         if (tsdata->version == M09)
 507                 goto m09_out;
 508
 509         error = edt_ft5x06_register_write(tsdata, WORK_REGISTER_OPMODE, 0x03);
 510         if (error) {
 511                 dev_err(&client->dev,
 512                         "failed to switch to factory mode, error %d\n", error);
 513                 goto err_out;
 514         }
 515
 516         tsdata->factory_mode = true;
 517         do {
 518                 mdelay(EDT_SWITCH_MODE_DELAY);
 519                 /* mode register is 0x01 when in factory mode */
 520                 ret = edt_ft5x06_register_read(tsdata, FACTORY_REGISTER_OPMODE);
 521                 if (ret == 0x03)
 522                         break;
 523         } while (--retries > 0);
 524
 525         if (retries == 0) {
 526                 dev_err(&client->dev, "not in factory mode after %dms.\n",
 527                         EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
 528                 error = -EIO;
 529                 goto err_out;
 530         }
 531
 532         return 0;
 533
 534 err_out:
 535         kfree(tsdata->raw_buffer);
 536         tsdata->raw_buffer = NULL;
 537         tsdata->factory_mode = false;
 538         enable_irq(client->irq);
 539
 540         return error;
 541
 542 m09_out:
 543         dev_err(&client->dev, "No factory mode support for M09\n");
 544         return -EINVAL;
 545
 546 }
 547
 548 static int edt_ft5x06_work_mode(struct edt_ft5x06_ts_data *tsdata)
 549 {
 550         struct i2c_client *client = tsdata->client;
 551         int retries = EDT_SWITCH_MODE_RETRIES;
 552         struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
 553         int ret;
 554         int error;
 555
 556         /* mode register is 0x01 when in the factory mode */
 557         error = edt_ft5x06_register_write(tsdata, FACTORY_REGISTER_OPMODE, 0x1);
 558         if (error) {
 559                 dev_err(&client->dev,
 560                         "failed to switch to work mode, error: %d\n", error);
 561                 return error;
 562         }
 563
 564         tsdata->factory_mode = false;
 565
 566         do {
 567                 mdelay(EDT_SWITCH_MODE_DELAY);
 568                 /* mode register is 0x01 when in factory mode */
 569                 ret = edt_ft5x06_register_read(tsdata, WORK_REGISTER_OPMODE);
 570                 if (ret == 0x01)
 571                         break;
 572         } while (--retries > 0);
 573
 574         if (retries == 0) {
 575                 dev_err(&client->dev, "not in work mode after %dms.\n",
 576                         EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
 577                 tsdata->factory_mode = true;
 578                 return -EIO;
 579         }
 580
 581         kfree(tsdata->raw_buffer);
 582         tsdata->raw_buffer = NULL;
 583
 584         /* restore parameters */
 585         edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold,
 586                                   tsdata->threshold);
 587         edt_ft5x06_register_write(tsdata, reg_addr->reg_gain,
 588                                   tsdata->gain);
 589         edt_ft5x06_register_write(tsdata, reg_addr->reg_offset,
 590                                   tsdata->offset);
 591         if (reg_addr->reg_report_rate)
 592                 edt_ft5x06_register_write(tsdata, reg_addr->reg_report_rate,
 593                                   tsdata->report_rate);
 594
 595         enable_irq(client->irq);
 596
 597         return 0;
 598 }
 599
 600 static int edt_ft5x06_debugfs_mode_get(void *data, u64 *mode)
 601 {
 602         struct edt_ft5x06_ts_data *tsdata = data;
 603
 604         *mode = tsdata->factory_mode;
 605
 606         return 0;
 607 };
 608
 609 static int edt_ft5x06_debugfs_mode_set(void *data, u64 mode)
 610 {
 611         struct edt_ft5x06_ts_data *tsdata = data;
 612         int retval = 0;
 613
 614         if (mode > 1)
 615                 return -ERANGE;
 616
 617         mutex_lock(&tsdata->mutex);
 618
 619         if (mode != tsdata->factory_mode) {
 620                 retval = mode ? edt_ft5x06_factory_mode(tsdata) :
 621                                 edt_ft5x06_work_mode(tsdata);
 622         }
 623
 624         mutex_unlock(&tsdata->mutex);
 625
 626         return retval;
 627 };
 628
 629 DEFINE_SIMPLE_ATTRIBUTE(debugfs_mode_fops, edt_ft5x06_debugfs_mode_get,
 630                         edt_ft5x06_debugfs_mode_set, "%llu\n");
 631
 632 static ssize_t edt_ft5x06_debugfs_raw_data_read(struct file *file,
 633                                 char __user *buf, size_t count, loff_t *off)
 634 {
 635         struct edt_ft5x06_ts_data *tsdata = file->private_data;
 636         struct i2c_client *client = tsdata->client;
 637         int retries  = EDT_RAW_DATA_RETRIES;
 638         int val, i, error;
 639         size_t read = 0;
 640         int colbytes;
 641         char wrbuf[3];
 642         u8 *rdbuf;
 643
 644         if (*off < 0 || *off >= tsdata->raw_bufsize)
 645                 return 0;
 646
 647         mutex_lock(&tsdata->mutex);
 648
 649         if (!tsdata->factory_mode || !tsdata->raw_buffer) {
 650                 error = -EIO;
 651                 goto out;
 652         }
 653
 654         error = edt_ft5x06_register_write(tsdata, 0x08, 0x01);
 655         if (error) {
 656                 dev_dbg(&client->dev,
 657                         "failed to write 0x08 register, error %d\n", error);
 658                 goto out;
 659         }
 660
 661         do {
 662                 msleep(EDT_RAW_DATA_DELAY);
 663                 val = edt_ft5x06_register_read(tsdata, 0x08);
 664                 if (val < 1)
 665                         break;
 666         } while (--retries > 0);
 667
 668         if (val < 0) {
 669                 error = val;
 670                 dev_dbg(&client->dev,
 671                         "failed to read 0x08 register, error %d\n", error);
 672                 goto out;
 673         }
 674
 675         if (retries == 0) {
 676                 dev_dbg(&client->dev,
 677                         "timed out waiting for register to settle\n");
 678                 error = -ETIMEDOUT;
 679                 goto out;
 680         }
 681
 682         rdbuf = tsdata->raw_buffer;
 683         colbytes = tsdata->num_y * sizeof(u16);
 684
 685         wrbuf[0] = 0xf5;
 686         wrbuf[1] = 0x0e;
 687         for (i = 0; i < tsdata->num_x; i++) {
 688                 wrbuf[2] = i;  /* column index */
 689                 error = edt_ft5x06_ts_readwrite(tsdata->client,
 690                                                 sizeof(wrbuf), wrbuf,
 691                                                 colbytes, rdbuf);
 692                 if (error)
 693                         goto out;
 694
 695                 rdbuf += colbytes;
 696         }
 697
 698         read = min_t(size_t, count, tsdata->raw_bufsize - *off);
 699         if (copy_to_user(buf, tsdata->raw_buffer + *off, read)) {
 700                 error = -EFAULT;
 701                 goto out;
 702         }
 703
 704         *off += read;
 705 out:
 706         mutex_unlock(&tsdata->mutex);
 707         return error ?: read;
 708 };
 709
 710
 711 static const struct file_operations debugfs_raw_data_fops = {
 712         .open = simple_open,
 713         .read = edt_ft5x06_debugfs_raw_data_read,
 714 };
 715
 716 static void
 717 edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
 718                               const char *debugfs_name)
 719 {
 720         tsdata->debug_dir = debugfs_create_dir(debugfs_name, NULL);
 721         if (!tsdata->debug_dir)
 722                 return;
 723
 724         debugfs_create_u16("num_x", S_IRUSR, tsdata->debug_dir, &tsdata->num_x);
 725         debugfs_create_u16("num_y", S_IRUSR, tsdata->debug_dir, &tsdata->num_y);
 726
 727         debugfs_create_file("mode", S_IRUSR | S_IWUSR,
 728                             tsdata->debug_dir, tsdata, &debugfs_mode_fops);
 729         debugfs_create_file("raw_data", S_IRUSR,
 730                             tsdata->debug_dir, tsdata, &debugfs_raw_data_fops);
 731 }
 732
 733 static void
 734 edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
 735 {
 736         if (tsdata->debug_dir)
 737                 debugfs_remove_recursive(tsdata->debug_dir);
 738         kfree(tsdata->raw_buffer);
 739 }
 740
 741 #else
 742
 743 static inline void
 744 edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata,
 745                               const char *debugfs_name)
 746 {
 747 }
 748
 749 static inline void
 750 edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
 751 {
 752 }
 753
 754 #endif /* CONFIG_DEBUGFS */
 755
 756
 757
 758 static int edt_ft5x06_ts_reset(struct i2c_client *client,
 759                         struct edt_ft5x06_ts_data *tsdata)
 760 {
 761         int error;
 762
 763         if (gpio_is_valid(tsdata->wake_pin)) {
 764                 error = gpio_request_one(tsdata->wake_pin, GPIOF_OUT_INIT_LOW,
 765                                          "edt-ft5x06 wake");
 766                 if (error) {
 767                         dev_err(&client->dev,
 768                                 "Failed to request GPIO %d as wake pin, error %d\n",
 769                                 tsdata->wake_pin, error);
 770                         return error;
 771                 }
 772
 773                 mdelay(5);
 774                 gpio_set_value(tsdata->wake_pin, 1);
 775         }
 776         if (gpio_is_valid(tsdata->reset_pin)) {
 777                 /* this pulls reset down, enabling the low active reset */
 778                 error = gpio_request_one(tsdata->reset_pin, GPIOF_OUT_INIT_LOW,
 779                                          "edt-ft5x06 reset");
 780                 if (error) {
 781                         dev_err(&client->dev,
 782                                 "Failed to request GPIO %d as reset pin, error %d\n",
 783                                 tsdata->reset_pin, error);
 784                         return error;
 785                 }
 786
 787                 mdelay(5);
 788                 gpio_set_value(tsdata->reset_pin, 1);
 789                 mdelay(300);
 790         }
 791
 792         return 0;
 793 }
 794
 795 static int edt_ft5x06_ts_identify(struct i2c_client *client,
 796                                         struct edt_ft5x06_ts_data *tsdata,
 797                                         char *fw_version)
 798 {
 799         u8 rdbuf[EDT_NAME_LEN];
 800         char *p;
 801         int error;
 802         char *model_name = tsdata->name;
 803
 804         /* see what we find if we assume it is a M06 *
 805          * if we get less than EDT_NAME_LEN, we don't want
 806          * to have garbage in there
 807          */
 808         memset(rdbuf, 0, sizeof(rdbuf));
 809         error = edt_ft5x06_ts_readwrite(client, 1, "\xbb",
 810                                         EDT_NAME_LEN - 1, rdbuf);
 811         if (error)
 812                 return error;
 813
 814         /* if we find something consistent, stay with that assumption
 815          * at least M09 won't send 3 bytes here
 816          */
 817         if (!(strnicmp(rdbuf + 1, "EP0", 3))) {
 818                 tsdata->version = M06;
 819
 820                 /* remove last '$' end marker */
 821                 rdbuf[EDT_NAME_LEN - 1] = '\0';
 822                 if (rdbuf[EDT_NAME_LEN - 2] == '$')
 823                         rdbuf[EDT_NAME_LEN - 2] = '\0';
 824
 825                 /* look for Model/Version separator */
 826                 p = strchr(rdbuf, '*');
 827                 if (p)
 828                         *p++ = '\0';
 829                 strlcpy(model_name, rdbuf + 1, EDT_NAME_LEN);
 830                 strlcpy(fw_version, p ? p : "", EDT_NAME_LEN);
 831         } else {
 832                 /* since there are only two versions around (M06, M09) */
 833                 tsdata->version = M09;
 834
 835                 error = edt_ft5x06_ts_readwrite(client, 1, "\xA6",
 836                                                 2, rdbuf);
 837                 if (error)
 838                         return error;
 839
 840                 strlcpy(fw_version, rdbuf, 2);
 841
 842                 error = edt_ft5x06_ts_readwrite(client, 1, "\xA8",
 843                                                 1, rdbuf);
 844                 if (error)
 845                         return error;
 846
 847                 snprintf(model_name, EDT_NAME_LEN, "EP0%i%i0M09",
 848                         rdbuf[0] >> 4, rdbuf[0] & 0x0F);
 849         }
 850
 851         return 0;
 852 }
 853
 854 #define EDT_ATTR_CHECKSET(name, reg) \
 855         if (pdata->name >= edt_ft5x06_attr_##name.limit_low &&          \
 856             pdata->name <= edt_ft5x06_attr_##name.limit_high)           \
 857                 edt_ft5x06_register_write(tsdata, reg, pdata->name)
 858
 859 #define EDT_GET_PROP(name, reg) {                                       \
 860         const u32 *prop = of_get_property(np, #name, NULL);             \
 861         if (prop)                                                       \
 862                 edt_ft5x06_register_write(tsdata, reg, be32_to_cpu(*prop)); \
 863 }
 864
 865 static void edt_ft5x06_ts_get_dt_defaults(struct device_node *np,
 866                                         struct edt_ft5x06_ts_data *tsdata)
 867 {
 868         struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
 869
 870         EDT_GET_PROP(threshold, reg_addr->reg_threshold);
 871         EDT_GET_PROP(gain, reg_addr->reg_gain);
 872         EDT_GET_PROP(offset, reg_addr->reg_offset);
 873 }
 874
 875 static void
 876 edt_ft5x06_ts_get_defaults(struct edt_ft5x06_ts_data *tsdata,
 877                            const struct edt_ft5x06_platform_data *pdata)
 878 {
 879         struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
 880
 881         if (!pdata->use_parameters)
 882                 return;
 883
 884         /* pick up defaults from the platform data */
 885         EDT_ATTR_CHECKSET(threshold, reg_addr->reg_threshold);
 886         EDT_ATTR_CHECKSET(gain, reg_addr->reg_gain);
 887         EDT_ATTR_CHECKSET(offset, reg_addr->reg_offset);
 888         if (reg_addr->reg_report_rate != NO_REGISTER)
 889                 EDT_ATTR_CHECKSET(report_rate, reg_addr->reg_report_rate);
 890 }
 891
 892 static void
 893 edt_ft5x06_ts_get_parameters(struct edt_ft5x06_ts_data *tsdata)
 894 {
 895         struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
 896
 897         tsdata->threshold = edt_ft5x06_register_read(tsdata,
 898                                                      reg_addr->reg_threshold);
 899         tsdata->gain = edt_ft5x06_register_read(tsdata, reg_addr->reg_gain);
 900         tsdata->offset = edt_ft5x06_register_read(tsdata, reg_addr->reg_offset);
 901         if (reg_addr->reg_report_rate != NO_REGISTER)
 902                 tsdata->report_rate = edt_ft5x06_register_read(tsdata,
 903                                                 reg_addr->reg_report_rate);
 904         tsdata->num_x = edt_ft5x06_register_read(tsdata, reg_addr->reg_num_x);
 905         tsdata->num_y = edt_ft5x06_register_read(tsdata, reg_addr->reg_num_y);
 906 }
 907
 908 static void
 909 edt_ft5x06_ts_set_regs(struct edt_ft5x06_ts_data *tsdata)
 910 {
 911         struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
 912
 913         switch (tsdata->version) {
 914         case M06:
 915                 reg_addr->reg_threshold = WORK_REGISTER_THRESHOLD;
 916                 reg_addr->reg_report_rate = WORK_REGISTER_REPORT_RATE;
 917                 reg_addr->reg_gain = WORK_REGISTER_GAIN;
 918                 reg_addr->reg_offset = WORK_REGISTER_OFFSET;
 919                 reg_addr->reg_num_x = WORK_REGISTER_NUM_X;
 920                 reg_addr->reg_num_y = WORK_REGISTER_NUM_Y;
 921                 break;
 922
 923         case M09:
 924                 reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
 925                 reg_addr->reg_gain = M09_REGISTER_GAIN;
 926                 reg_addr->reg_offset = M09_REGISTER_OFFSET;
 927                 reg_addr->reg_num_x = M09_REGISTER_NUM_X;
 928                 reg_addr->reg_num_y = M09_REGISTER_NUM_Y;
 929                 break;
 930         }
 931 }
 932
 933 #ifdef CONFIG_OF
 934 static int edt_ft5x06_i2c_ts_probe_dt(struct device *dev,
 935                                 struct edt_ft5x06_ts_data *tsdata)
 936 {
 937         int ret;
 938         struct device_node *np = dev->of_node;
 939         enum of_gpio_flags gpio_flags;
 940
 941         if (!np)
 942                 return -ENODEV;
 943
 944         /*
 945          * irq_pin is not needed for DT setup.
 946          * irq is associated via 'interrupts' property in DT
 947          */
 948         tsdata->irq_pin = -EINVAL;
 949
 950         ret = of_get_named_gpio_flags(np, "reset-gpios", 0, &gpio_flags);
 951         tsdata->reset_pin = ret;
 952
 953         ret = of_get_named_gpio_flags(np, "wake-gpios", 0, &gpio_flags);
 954         tsdata->wake_pin = ret;
 955
 956         return 0;
 957 }
 958 #else
 959 static inline int edt_ft5x06_i2c_ts_probe_dt(struct device *dev,
 960                                         struct edt_ft5x06_i2c_ts_data *tsdata)
 961 {
 962         return -ENODEV;
 963 }
 964 #endif
 965
 966 static int edt_ft5x06_ts_probe(struct i2c_client *client,
 967                                          const struct i2c_device_id *id)
 968 {
 969         const struct edt_ft5x06_platform_data *pdata =
 970                                                 client->dev.platform_data;
 971         struct edt_ft5x06_ts_data *tsdata;
 972         struct input_dev *input;
 973         int error;
 974         char fw_version[EDT_NAME_LEN];
 975
 976         dev_dbg(&client->dev, "probing for EDT FT5x06 I2C\n");
 977
 978         tsdata = devm_kzalloc(&client->dev, sizeof(*tsdata), GFP_KERNEL);
 979         if (!tsdata) {
 980                 dev_err(&client->dev, "failed to allocate driver data.\n");
 981                 return -ENOMEM;
 982         }
 983
 984         if (!pdata) {
 985                 error = edt_ft5x06_i2c_ts_probe_dt(&client->dev, tsdata);
 986                 if (error) {
 987                         dev_err(&client->dev,
 988                                 "DT probe failed and no platform data present\n");
 989                         return error;
 990                 }
 991         } else {
 992                 tsdata->reset_pin = pdata->reset_pin;
 993                 tsdata->irq_pin = pdata->irq_pin;
 994                 tsdata->wake_pin = -EINVAL;
 995         }
 996
 997         error = edt_ft5x06_ts_reset(client, tsdata);
 998         if (error)
 999                 return error;
1000
1001         if (gpio_is_valid(tsdata->irq_pin)) {
1002                 error = gpio_request_one(tsdata->irq_pin,
1003                                          GPIOF_IN, "edt-ft5x06 irq");
1004                 if (error) {
1005                         dev_err(&client->dev,
1006                                 "Failed to request GPIO %d, error %d\n",
1007                                 tsdata->irq_pin, error);
1008                         return error;
1009                 }
1010         }
1011
1012         input = input_allocate_device();
1013         if (!input) {
1014                 dev_err(&client->dev, "failed to allocate input device.\n");
1015                 error = -ENOMEM;
1016                 goto err_free_mem;
1017         }
1018
1019         mutex_init(&tsdata->mutex);
1020         tsdata->client = client;
1021         tsdata->input = input;
1022         tsdata->factory_mode = false;
1023
1024         error = edt_ft5x06_ts_identify(client, tsdata, fw_version);
1025         if (error) {
1026                 dev_err(&client->dev, "touchscreen probe failed\n");
1027                 goto err_free_mem;
1028         }
1029
1030         edt_ft5x06_ts_set_regs(tsdata);
1031
1032         if (!pdata)
1033                 edt_ft5x06_ts_get_dt_defaults(client->dev.of_node, tsdata);
1034         else
1035                 edt_ft5x06_ts_get_defaults(tsdata, pdata);
1036
1037         edt_ft5x06_ts_get_parameters(tsdata);
1038
1039         dev_dbg(&client->dev,
1040                 "Model \"%s\", Rev. \"%s\", %dx%d sensors\n",
1041                 tsdata->name, fw_version, tsdata->num_x, tsdata->num_y);
1042
1043         input->name = tsdata->name;
1044         input->id.bustype = BUS_I2C;
1045         input->dev.parent = &client->dev;
1046
1047         __set_bit(EV_SYN, input->evbit);
1048         __set_bit(EV_KEY, input->evbit);
1049         __set_bit(EV_ABS, input->evbit);
1050         __set_bit(BTN_TOUCH, input->keybit);
1051         input_set_abs_params(input, ABS_X, 0, tsdata->num_x * 64 - 1, 0, 0);
1052         input_set_abs_params(input, ABS_Y, 0, tsdata->num_y * 64 - 1, 0, 0);
1053         input_set_abs_params(input, ABS_MT_POSITION_X,
1054                              0, tsdata->num_x * 64 - 1, 0, 0);
1055         input_set_abs_params(input, ABS_MT_POSITION_Y,
1056                              0, tsdata->num_y * 64 - 1, 0, 0);
1057         error = input_mt_init_slots(input, MAX_SUPPORT_POINTS, 0);
1058         if (error) {
1059                 dev_err(&client->dev, "Unable to init MT slots.\n");
1060                 goto err_free_mem;
1061         }
1062
1063         input_set_drvdata(input, tsdata);
1064         i2c_set_clientdata(client, tsdata);
1065
1066         error = request_threaded_irq(client->irq, NULL, edt_ft5x06_ts_isr,
1067                                      IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
1068                                      client->name, tsdata);
1069         if (error) {
1070                 dev_err(&client->dev, "Unable to request touchscreen IRQ.\n");
1071                 goto err_free_mem;
1072         }
1073
1074         error = sysfs_create_group(&client->dev.kobj, &edt_ft5x06_attr_group);
1075         if (error)
1076                 goto err_free_irq;
1077
1078         error = input_register_device(input);
1079         if (error)
1080                 goto err_remove_attrs;
1081
1082         edt_ft5x06_ts_prepare_debugfs(tsdata, dev_driver_string(&client->dev));
1083         device_init_wakeup(&client->dev, 1);
1084
1085         dev_dbg(&client->dev,
1086                 "EDT FT5x06 initialized: IRQ %d, WAKE pin %d, Reset pin %d.\n",
1087                 client->irq, tsdata->wake_pin, tsdata->reset_pin);
1088
1089         return 0;
1090
1091 err_remove_attrs:
1092         sysfs_remove_group(&client->dev.kobj, &edt_ft5x06_attr_group);
1093 err_free_irq:
1094         free_irq(client->irq, tsdata);
1095 err_free_mem:
1096         input_free_device(input);
1097         if (gpio_is_valid(tsdata->irq_pin))
1098                 gpio_free(tsdata->irq_pin);
1099         if (gpio_is_valid(tsdata->reset_pin))
1100                 gpio_free(tsdata->reset_pin);
1101         if (gpio_is_valid(tsdata->wake_pin))
1102                 gpio_free(tsdata->wake_pin);
1103
1104         return error;
1105 }
1106
1107 static int edt_ft5x06_ts_remove(struct i2c_client *client)
1108 {
1109         struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1110
1111         edt_ft5x06_ts_teardown_debugfs(tsdata);
1112         sysfs_remove_group(&client->dev.kobj, &edt_ft5x06_attr_group);
1113
1114         free_irq(client->irq, tsdata);
1115         input_unregister_device(tsdata->input);
1116
1117         if (gpio_is_valid(tsdata->irq_pin))
1118                 gpio_free(tsdata->irq_pin);
1119         if (gpio_is_valid(tsdata->reset_pin))
1120                 gpio_free(tsdata->reset_pin);
1121         if (gpio_is_valid(tsdata->wake_pin))
1122                 gpio_free(tsdata->wake_pin);
1123
1124         return 0;
1125 }
1126
1127 #ifdef CONFIG_PM_SLEEP
1128 static int edt_ft5x06_ts_suspend(struct device *dev)
1129 {
1130         struct i2c_client *client = to_i2c_client(dev);
1131
1132         if (device_may_wakeup(dev))
1133                 enable_irq_wake(client->irq);
1134
1135         return 0;
1136 }
1137
1138 static int edt_ft5x06_ts_resume(struct device *dev)
1139 {
1140         struct i2c_client *client = to_i2c_client(dev);
1141
1142         if (device_may_wakeup(dev))
1143                 disable_irq_wake(client->irq);
1144
1145         return 0;
1146 }
1147 #endif
1148
1149 static SIMPLE_DEV_PM_OPS(edt_ft5x06_ts_pm_ops,
1150                          edt_ft5x06_ts_suspend, edt_ft5x06_ts_resume);
1151
1152 static const struct i2c_device_id edt_ft5x06_ts_id[] = {
1153         { "edt-ft5x06", 0, },
1154         { /* sentinel */ }
1155 };
1156 MODULE_DEVICE_TABLE(i2c, edt_ft5x06_ts_id);
1157
1158 static const struct of_device_id edt_ft5x06_of_match[] = {
1159         { .compatible = "edt,edt-ft5x06", },
1160         { /* sentinel */ }
1161 };
1162 MODULE_DEVICE_TABLE(of, edt_ft5x06_of_match);
1163
1164 static struct i2c_driver edt_ft5x06_ts_driver = {
1165         .driver = {
1166                 .owner = THIS_MODULE,
1167                 .name = "edt_ft5x06",
1168                 .of_match_table = edt_ft5x06_of_match,
1169                 .pm = &edt_ft5x06_ts_pm_ops,
1170         },
1171         .id_table = edt_ft5x06_ts_id,
1172         .probe    = edt_ft5x06_ts_probe,
1173         .remove   = edt_ft5x06_ts_remove,
1174 };
1175
1176 module_i2c_driver(edt_ft5x06_ts_driver);
1177
1178 MODULE_AUTHOR("Simon Budig <simon.budig@kernelconcepts.de>");
1179 MODULE_DESCRIPTION("EDT FT5x06 I2C Touchscreen Driver");
1180 MODULE_LICENSE("GPL");
1181 MODULE_ALIAS("platform:edt-ft5x06");