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                 input_report_abs(tsdata->input, ABS_MT_PRESSURE, down);
 248         }
 249
 250         input_mt_report_pointer_emulation(tsdata->input, true);
 251         input_sync(tsdata->input);
 252
 253 out:
 254         return IRQ_HANDLED;
 255 }
 256
 257 static int edt_ft5x06_register_write(struct edt_ft5x06_ts_data *tsdata,
 258                                      u8 addr, u8 value)
 259 {
 260         u8 wrbuf[4];
 261
 262         switch (tsdata->version) {
 263         case M06:
 264                 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
 265                 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
 266                 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
 267                 wrbuf[2] = value;
 268                 wrbuf[3] = wrbuf[0] ^ wrbuf[1] ^ wrbuf[2];
 269                 return edt_ft5x06_ts_readwrite(tsdata->client, 4,
 270                                         wrbuf, 0, NULL);
 271         case M09:
 272                 wrbuf[0] = addr;
 273                 wrbuf[1] = value;
 274
 275                 return edt_ft5x06_ts_readwrite(tsdata->client, 2,
 276                                         wrbuf, 0, NULL);
 277
 278         default:
 279                 return -EINVAL;
 280         }
 281 }
 282
 283 static int edt_ft5x06_register_read(struct edt_ft5x06_ts_data *tsdata,
 284                                     u8 addr)
 285 {
 286         u8 wrbuf[2], rdbuf[2];
 287         int error;
 288
 289         switch (tsdata->version) {
 290         case M06:
 291                 wrbuf[0] = tsdata->factory_mode ? 0xf3 : 0xfc;
 292                 wrbuf[1] = tsdata->factory_mode ? addr & 0x7f : addr & 0x3f;
 293                 wrbuf[1] |= tsdata->factory_mode ? 0x80 : 0x40;
 294
 295                 error = edt_ft5x06_ts_readwrite(tsdata->client, 2, wrbuf, 2,
 296                                                 rdbuf);
 297                 if (error)
 298                         return error;
 299
 300                 if ((wrbuf[0] ^ wrbuf[1] ^ rdbuf[0]) != rdbuf[1]) {
 301                         dev_err(&tsdata->client->dev,
 302                                 "crc error: 0x%02x expected, got 0x%02x\n",
 303                                 wrbuf[0] ^ wrbuf[1] ^ rdbuf[0],
 304                                 rdbuf[1]);
 305                         return -EIO;
 306                 }
 307                 break;
 308
 309         case M09:
 310                 wrbuf[0] = addr;
 311                 error = edt_ft5x06_ts_readwrite(tsdata->client, 1,
 312                                                 wrbuf, 1, rdbuf);
 313                 if (error)
 314                         return error;
 315                 break;
 316
 317         default:
 318                 return -EINVAL;
 319         }
 320
 321         return rdbuf[0];
 322 }
 323
 324 struct edt_ft5x06_attribute {
 325         struct device_attribute dattr;
 326         size_t field_offset;
 327         u8 limit_low;
 328         u8 limit_high;
 329         u8 addr_m06;
 330         u8 addr_m09;
 331 };
 332
 333 #define EDT_ATTR(_field, _mode, _addr_m06, _addr_m09,                   \
 334                 _limit_low, _limit_high)                                \
 335         struct edt_ft5x06_attribute edt_ft5x06_attr_##_field = {        \
 336                 .dattr = __ATTR(_field, _mode,                          \
 337                                 edt_ft5x06_setting_show,                \
 338                                 edt_ft5x06_setting_store),              \
 339                 .field_offset = offsetof(struct edt_ft5x06_ts_data, _field), \
 340                 .addr_m06 = _addr_m06,                                  \
 341                 .addr_m09 = _addr_m09,                                  \
 342                 .limit_low = _limit_low,                                \
 343                 .limit_high = _limit_high,                              \
 344         }
 345
 346 static ssize_t edt_ft5x06_setting_show(struct device *dev,
 347                                        struct device_attribute *dattr,
 348                                        char *buf)
 349 {
 350         struct i2c_client *client = to_i2c_client(dev);
 351         struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
 352         struct edt_ft5x06_attribute *attr =
 353                         container_of(dattr, struct edt_ft5x06_attribute, dattr);
 354         u8 *field = (u8 *)tsdata + attr->field_offset;
 355         int val;
 356         size_t count = 0;
 357         int error = 0;
 358         u8 addr;
 359
 360         mutex_lock(&tsdata->mutex);
 361
 362         if (tsdata->factory_mode) {
 363                 error = -EIO;
 364                 goto out;
 365         }
 366
 367         switch (tsdata->version) {
 368         case M06:
 369                 addr = attr->addr_m06;
 370                 break;
 371
 372         case M09:
 373                 addr = attr->addr_m09;
 374                 break;
 375
 376         default:
 377                 error = -ENODEV;
 378                 goto out;
 379         }
 380
 381         if (addr != NO_REGISTER) {
 382                 val = edt_ft5x06_register_read(tsdata, addr);
 383                 if (val < 0) {
 384                         error = val;
 385                         dev_err(&tsdata->client->dev,
 386                                 "Failed to fetch attribute %s, error %d\n",
 387                                 dattr->attr.name, error);
 388                         goto out;
 389                 }
 390         } else {
 391                 val = *field;
 392         }
 393
 394         if (val != *field) {
 395                 dev_warn(&tsdata->client->dev,
 396                          "%s: read (%d) and stored value (%d) differ\n",
 397                          dattr->attr.name, val, *field);
 398                 *field = val;
 399         }
 400
 401         count = scnprintf(buf, PAGE_SIZE, "%d\n", val);
 402 out:
 403         mutex_unlock(&tsdata->mutex);
 404         return error ?: count;
 405 }
 406
 407 static ssize_t edt_ft5x06_setting_store(struct device *dev,
 408                                         struct device_attribute *dattr,
 409                                         const char *buf, size_t count)
 410 {
 411         struct i2c_client *client = to_i2c_client(dev);
 412         struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
 413         struct edt_ft5x06_attribute *attr =
 414                         container_of(dattr, struct edt_ft5x06_attribute, dattr);
 415         u8 *field = (u8 *)tsdata + attr->field_offset;
 416         unsigned int val;
 417         int error;
 418         u8 addr;
 419
 420         mutex_lock(&tsdata->mutex);
 421
 422         if (tsdata->factory_mode) {
 423                 error = -EIO;
 424                 goto out;
 425         }
 426
 427         error = kstrtouint(buf, 0, &val);
 428         if (error)
 429                 goto out;
 430
 431         if (val < attr->limit_low || val > attr->limit_high) {
 432                 error = -ERANGE;
 433                 goto out;
 434         }
 435
 436         switch (tsdata->version) {
 437         case M06:
 438                 addr = attr->addr_m06;
 439                 break;
 440
 441         case M09:
 442                 addr = attr->addr_m09;
 443                 break;
 444
 445         default:
 446                 error = -ENODEV;
 447                 goto out;
 448         }
 449
 450         if (addr != NO_REGISTER) {
 451                 error = edt_ft5x06_register_write(tsdata, addr, val);
 452                 if (error) {
 453                         dev_err(&tsdata->client->dev,
 454                                 "Failed to update attribute %s, error: %d\n",
 455                                 dattr->attr.name, error);
 456                         goto out;
 457                 }
 458         }
 459         *field = val;
 460
 461 out:
 462         mutex_unlock(&tsdata->mutex);
 463         return error ?: count;
 464 }
 465
 466 static EDT_ATTR(gain, S_IWUSR | S_IRUGO, WORK_REGISTER_GAIN,
 467                 M09_REGISTER_GAIN, 0, 31);
 468 static EDT_ATTR(offset, S_IWUSR | S_IRUGO, WORK_REGISTER_OFFSET,
 469                 M09_REGISTER_OFFSET, 0, 31);
 470 static EDT_ATTR(threshold, S_IWUSR | S_IRUGO, WORK_REGISTER_THRESHOLD,
 471                 M09_REGISTER_THRESHOLD, 20, 80);
 472 static EDT_ATTR(report_rate, S_IWUSR | S_IRUGO, WORK_REGISTER_REPORT_RATE,
 473                 NO_REGISTER, 3, 14);
 474
 475 static struct attribute *edt_ft5x06_attrs[] = {
 476         &edt_ft5x06_attr_gain.dattr.attr,
 477         &edt_ft5x06_attr_offset.dattr.attr,
 478         &edt_ft5x06_attr_threshold.dattr.attr,
 479         &edt_ft5x06_attr_report_rate.dattr.attr,
 480         NULL
 481 };
 482
 483 static const struct attribute_group edt_ft5x06_attr_group = {
 484         .attrs = edt_ft5x06_attrs,
 485 };
 486
 487 #ifdef CONFIG_DEBUG_FS
 488 static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
 489 {
 490         struct i2c_client *client = tsdata->client;
 491         int retries = EDT_SWITCH_MODE_RETRIES;
 492         int ret;
 493         int error;
 494
 495         disable_irq(client->irq);
 496
 497         if (!tsdata->raw_buffer) {
 498                 tsdata->raw_bufsize = tsdata->num_x * tsdata->num_y *
 499                                       sizeof(u16);
 500                 tsdata->raw_buffer = kzalloc(tsdata->raw_bufsize, GFP_KERNEL);
 501                 if (!tsdata->raw_buffer) {
 502                         error = -ENOMEM;
 503                         goto err_out;
 504                 }
 505         }
 506
 507         /* mode register is 0x3c when in the work mode */
 508         if (tsdata->version == M09)
 509                 goto m09_out;
 510
 511         error = edt_ft5x06_register_write(tsdata, WORK_REGISTER_OPMODE, 0x03);
 512         if (error) {
 513                 dev_err(&client->dev,
 514                         "failed to switch to factory mode, error %d\n", error);
 515                 goto err_out;
 516         }
 517
 518         tsdata->factory_mode = true;
 519         do {
 520                 mdelay(EDT_SWITCH_MODE_DELAY);
 521                 /* mode register is 0x01 when in factory mode */
 522                 ret = edt_ft5x06_register_read(tsdata, FACTORY_REGISTER_OPMODE);
 523                 if (ret == 0x03)
 524                         break;
 525         } while (--retries > 0);
 526
 527         if (retries == 0) {
 528                 dev_err(&client->dev, "not in factory mode after %dms.\n",
 529                         EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
 530                 error = -EIO;
 531                 goto err_out;
 532         }
 533
 534         return 0;
 535
 536 err_out:
 537         kfree(tsdata->raw_buffer);
 538         tsdata->raw_buffer = NULL;
 539         tsdata->factory_mode = false;
 540         enable_irq(client->irq);
 541
 542         return error;
 543
 544 m09_out:
 545         dev_err(&client->dev, "No factory mode support for M09\n");
 546         return -EINVAL;
 547
 548 }
 549
 550 static int edt_ft5x06_work_mode(struct edt_ft5x06_ts_data *tsdata)
 551 {
 552         struct i2c_client *client = tsdata->client;
 553         int retries = EDT_SWITCH_MODE_RETRIES;
 554         struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
 555         int ret;
 556         int error;
 557
 558         /* mode register is 0x01 when in the factory mode */
 559         error = edt_ft5x06_register_write(tsdata, FACTORY_REGISTER_OPMODE, 0x1);
 560         if (error) {
 561                 dev_err(&client->dev,
 562                         "failed to switch to work mode, error: %d\n", error);
 563                 return error;
 564         }
 565
 566         tsdata->factory_mode = false;
 567
 568         do {
 569                 mdelay(EDT_SWITCH_MODE_DELAY);
 570                 /* mode register is 0x01 when in factory mode */
 571                 ret = edt_ft5x06_register_read(tsdata, WORK_REGISTER_OPMODE);
 572                 if (ret == 0x01)
 573                         break;
 574         } while (--retries > 0);
 575
 576         if (retries == 0) {
 577                 dev_err(&client->dev, "not in work mode after %dms.\n",
 578                         EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
 579                 tsdata->factory_mode = true;
 580                 return -EIO;
 581         }
 582
 583         kfree(tsdata->raw_buffer);
 584         tsdata->raw_buffer = NULL;
 585
 586         /* restore parameters */
 587         edt_ft5x06_register_write(tsdata, reg_addr->reg_threshold,
 588                                   tsdata->threshold);
 589         edt_ft5x06_register_write(tsdata, reg_addr->reg_gain,
 590                                   tsdata->gain);
 591         edt_ft5x06_register_write(tsdata, reg_addr->reg_offset,
 592                                   tsdata->offset);
 593         if (reg_addr->reg_report_rate)
 594                 edt_ft5x06_register_write(tsdata, reg_addr->reg_report_rate,
 595                                   tsdata->report_rate);
 596
 597         enable_irq(client->irq);
 598
 599         return 0;
 600 }
 601
 602 static int edt_ft5x06_debugfs_mode_get(void *data, u64 *mode)
 603 {
 604         struct edt_ft5x06_ts_data *tsdata = data;
 605
 606         *mode = tsdata->factory_mode;
 607
 608         return 0;
 609 };
 610
 611 static int edt_ft5x06_debugfs_mode_set(void *data, u64 mode)
 612 {
 613         struct edt_ft5x06_ts_data *tsdata = data;
 614         int retval = 0;
 615
 616         if (mode > 1)
 617                 return -ERANGE;
 618
 619         mutex_lock(&tsdata->mutex);
 620
 621         if (mode != tsdata->factory_mode) {
 622                 retval = mode ? edt_ft5x06_factory_mode(tsdata) :
 623                                 edt_ft5x06_work_mode(tsdata);
 624         }
 625
 626         mutex_unlock(&tsdata->mutex);
 627
 628         return retval;
 629 };
 630
 631 DEFINE_SIMPLE_ATTRIBUTE(debugfs_mode_fops, edt_ft5x06_debugfs_mode_get,
 632                         edt_ft5x06_debugfs_mode_set, "%llu\n");
 633
 634 static ssize_t edt_ft5x06_debugfs_raw_data_read(struct file *file,
 635                                 char __user *buf, size_t count, loff_t *off)
 636 {
 637         struct edt_ft5x06_ts_data *tsdata = file->private_data;
 638         struct i2c_client *client = tsdata->client;
 639         int retries  = EDT_RAW_DATA_RETRIES;
 640         int val, i, error;
 641         size_t read = 0;
 642         int colbytes;
 643         char wrbuf[3];
 644         u8 *rdbuf;
 645
 646         if (*off < 0 || *off >= tsdata->raw_bufsize)
 647                 return 0;
 648
 649         mutex_lock(&tsdata->mutex);
 650
 651         if (!tsdata->factory_mode || !tsdata->raw_buffer) {
 652                 error = -EIO;
 653                 goto out;
 654         }
 655
 656         error = edt_ft5x06_register_write(tsdata, 0x08, 0x01);
 657         if (error) {
 658                 dev_dbg(&client->dev,
 659                         "failed to write 0x08 register, error %d\n", error);
 660                 goto out;
 661         }
 662
 663         do {
 664                 msleep(EDT_RAW_DATA_DELAY);
 665                 val = edt_ft5x06_register_read(tsdata, 0x08);
 666                 if (val < 1)
 667                         break;
 668         } while (--retries > 0);
 669
 670         if (val < 0) {
 671                 error = val;
 672                 dev_dbg(&client->dev,
 673                         "failed to read 0x08 register, error %d\n", error);
 674                 goto out;
 675         }
 676
 677         if (retries == 0) {
 678                 dev_dbg(&client->dev,
 679                         "timed out waiting for register to settle\n");
 680                 error = -ETIMEDOUT;
 681                 goto out;
 682         }
 683
 684         rdbuf = tsdata->raw_buffer;
 685         colbytes = tsdata->num_y * sizeof(u16);
 686
 687         wrbuf[0] = 0xf5;
 688         wrbuf[1] = 0x0e;
 689         for (i = 0; i < tsdata->num_x; i++) {
 690                 wrbuf[2] = i;  /* column index */
 691                 error = edt_ft5x06_ts_readwrite(tsdata->client,
 692                                                 sizeof(wrbuf), wrbuf,
 693                                                 colbytes, rdbuf);
 694                 if (error)
 695                         goto out;
 696
 697                 rdbuf += colbytes;
 698         }
 699
 700         read = min_t(size_t, count, tsdata->raw_bufsize - *off);
 701         if (copy_to_user(buf, tsdata->raw_buffer + *off, read)) {
 702                 error = -EFAULT;
 703                 goto out;
 704         }
 705
 706         *off += read;
 707 out:
 708         mutex_unlock(&tsdata->mutex);
 709         return error ?: read;
 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 static int edt_ft5x06_ts_reset(struct i2c_client *client,
 758                         struct edt_ft5x06_ts_data *tsdata)
 759 {
 760         int error;
 761
 762         if (gpio_is_valid(tsdata->wake_pin)) {
 763                 error = devm_gpio_request_one(&client->dev,
 764                                         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                 msleep(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 = devm_gpio_request_one(&client->dev,
 779                                         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                 msleep(5);
 789                 gpio_set_value(tsdata->reset_pin, 1);
 790                 msleep(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         u32 val;                                                \
 862         if (of_property_read_u32(np, #name, &val) == 0)         \
 863                 edt_ft5x06_register_write(tsdata, reg, val);    \
 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         struct device_node *np = dev->of_node;
 939
 940         /*
 941          * irq_pin is not needed for DT setup.
 942          * irq is associated via 'interrupts' property in DT
 943          */
 944         tsdata->irq_pin = -EINVAL;
 945         tsdata->reset_pin = of_get_named_gpio(np, "reset-gpios", 0);
 946         tsdata->wake_pin = of_get_named_gpio(np, "wake-gpios", 0);
 947
 948         return 0;
 949 }
 950 #else
 951 static inline int edt_ft5x06_i2c_ts_probe_dt(struct device *dev,
 952                                         struct edt_ft5x06_ts_data *tsdata)
 953 {
 954         return -ENODEV;
 955 }
 956 #endif
 957
 958 static int edt_ft5x06_ts_probe(struct i2c_client *client,
 959                                          const struct i2c_device_id *id)
 960 {
 961         const struct edt_ft5x06_platform_data *pdata =
 962                                                 dev_get_platdata(&client->dev);
 963         struct edt_ft5x06_ts_data *tsdata;
 964         struct input_dev *input;
 965         int error;
 966         char fw_version[EDT_NAME_LEN];
 967
 968         dev_dbg(&client->dev, "probing for EDT FT5x06 I2C\n");
 969
 970         tsdata = devm_kzalloc(&client->dev, sizeof(*tsdata), GFP_KERNEL);
 971         if (!tsdata) {
 972                 dev_err(&client->dev, "failed to allocate driver data.\n");
 973                 return -ENOMEM;
 974         }
 975
 976         if (!pdata) {
 977                 error = edt_ft5x06_i2c_ts_probe_dt(&client->dev, tsdata);
 978                 if (error) {
 979                         dev_err(&client->dev,
 980                                 "DT probe failed and no platform data present\n");
 981                         return error;
 982                 }
 983         } else {
 984                 tsdata->reset_pin = pdata->reset_pin;
 985                 tsdata->irq_pin = pdata->irq_pin;
 986                 tsdata->wake_pin = -EINVAL;
 987         }
 988
 989         error = edt_ft5x06_ts_reset(client, tsdata);
 990         if (error)
 991                 return error;
 992
 993         if (gpio_is_valid(tsdata->irq_pin)) {
 994                 error = devm_gpio_request_one(&client->dev, tsdata->irq_pin,
 995                                         GPIOF_IN, "edt-ft5x06 irq");
 996                 if (error) {
 997                         dev_err(&client->dev,
 998                                 "Failed to request GPIO %d, error %d\n",
 999                                 tsdata->irq_pin, error);
1000                         return error;
1001                 }
1002         }
1003
1004         input = devm_input_allocate_device(&client->dev);
1005         if (!input) {
1006                 dev_err(&client->dev, "failed to allocate input device.\n");
1007                 return -ENOMEM;
1008         }
1009
1010         mutex_init(&tsdata->mutex);
1011         tsdata->client = client;
1012         tsdata->input = input;
1013         tsdata->factory_mode = false;
1014
1015         error = edt_ft5x06_ts_identify(client, tsdata, fw_version);
1016         if (error) {
1017                 dev_err(&client->dev, "touchscreen probe failed\n");
1018                 return error;
1019         }
1020
1021         edt_ft5x06_ts_set_regs(tsdata);
1022
1023         if (!pdata)
1024                 edt_ft5x06_ts_get_dt_defaults(client->dev.of_node, tsdata);
1025         else
1026                 edt_ft5x06_ts_get_defaults(tsdata, pdata);
1027
1028         edt_ft5x06_ts_get_parameters(tsdata);
1029
1030         dev_dbg(&client->dev,
1031                 "Model \"%s\", Rev. \"%s\", %dx%d sensors\n",
1032                 tsdata->name, fw_version, tsdata->num_x, tsdata->num_y);
1033
1034         input->name = tsdata->name;
1035         input->id.bustype = BUS_I2C;
1036         input->dev.parent = &client->dev;
1037
1038         __set_bit(EV_SYN, input->evbit);
1039         __set_bit(EV_KEY, input->evbit);
1040         __set_bit(EV_ABS, input->evbit);
1041         __set_bit(BTN_TOUCH, input->keybit);
1042         input_set_abs_params(input, ABS_X, 0, tsdata->num_x * 64 - 1, 0, 0);
1043         input_set_abs_params(input, ABS_Y, 0, tsdata->num_y * 64 - 1, 0, 0);
1044         input_set_abs_params(input, ABS_MT_POSITION_X,
1045                              0, tsdata->num_x * 64 - 1, 0, 0);
1046         input_set_abs_params(input, ABS_MT_POSITION_Y,
1047                              0, tsdata->num_y * 64 - 1, 0, 0);
1048         error = input_mt_init_slots(input, MAX_SUPPORT_POINTS, 0);
1049         if (error) {
1050                 dev_err(&client->dev, "Unable to init MT slots.\n");
1051                 return error;
1052         }
1053
1054         input_set_drvdata(input, tsdata);
1055         i2c_set_clientdata(client, tsdata);
1056
1057         error = devm_request_threaded_irq(&client->dev, client->irq, NULL,
1058                                         edt_ft5x06_ts_isr,
1059                                         IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
1060                                         client->name, tsdata);
1061         if (error) {
1062                 dev_err(&client->dev, "Unable to request touchscreen IRQ.\n");
1063                 return error;
1064         }
1065
1066         error = sysfs_create_group(&client->dev.kobj, &edt_ft5x06_attr_group);
1067         if (error)
1068                 return error;
1069
1070         error = input_register_device(input);
1071         if (error)
1072                 goto err_remove_attrs;
1073
1074         edt_ft5x06_ts_prepare_debugfs(tsdata, dev_driver_string(&client->dev));
1075         device_init_wakeup(&client->dev, 1);
1076
1077         dev_dbg(&client->dev,
1078                 "EDT FT5x06 initialized: IRQ %d, WAKE pin %d, Reset pin %d.\n",
1079                 client->irq, tsdata->wake_pin, tsdata->reset_pin);
1080
1081         return 0;
1082
1083 err_remove_attrs:
1084         sysfs_remove_group(&client->dev.kobj, &edt_ft5x06_attr_group);
1085         return error;
1086 }
1087
1088 static int edt_ft5x06_ts_remove(struct i2c_client *client)
1089 {
1090         struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1091
1092         edt_ft5x06_ts_teardown_debugfs(tsdata);
1093         sysfs_remove_group(&client->dev.kobj, &edt_ft5x06_attr_group);
1094
1095         return 0;
1096 }
1097
1098 #ifdef CONFIG_PM_SLEEP
1099 static int edt_ft5x06_ts_suspend(struct device *dev)
1100 {
1101         struct i2c_client *client = to_i2c_client(dev);
1102
1103         if (device_may_wakeup(dev))
1104                 enable_irq_wake(client->irq);
1105
1106         return 0;
1107 }
1108
1109 static int edt_ft5x06_ts_resume(struct device *dev)
1110 {
1111         struct i2c_client *client = to_i2c_client(dev);
1112
1113         if (device_may_wakeup(dev))
1114                 disable_irq_wake(client->irq);
1115
1116         return 0;
1117 }
1118 #endif
1119
1120 static SIMPLE_DEV_PM_OPS(edt_ft5x06_ts_pm_ops,
1121                          edt_ft5x06_ts_suspend, edt_ft5x06_ts_resume);
1122
1123 static const struct i2c_device_id edt_ft5x06_ts_id[] = {
1124         { "edt-ft5x06", 0, },
1125         { /* sentinel */ }
1126 };
1127 MODULE_DEVICE_TABLE(i2c, edt_ft5x06_ts_id);
1128
1129 #ifdef CONFIG_OF
1130 static const struct of_device_id edt_ft5x06_of_match[] = {
1131         { .compatible = "edt,edt-ft5206", },
1132         { .compatible = "edt,edt-ft5306", },
1133         { .compatible = "edt,edt-ft5406", },
1134         { /* sentinel */ }
1135 };
1136 MODULE_DEVICE_TABLE(of, edt_ft5x06_of_match);
1137 #endif
1138
1139 static struct i2c_driver edt_ft5x06_ts_driver = {
1140         .driver = {
1141                 .owner = THIS_MODULE,
1142                 .name = "edt_ft5x06",
1143                 .of_match_table = of_match_ptr(edt_ft5x06_of_match),
1144                 .pm = &edt_ft5x06_ts_pm_ops,
1145         },
1146         .id_table = edt_ft5x06_ts_id,
1147         .probe    = edt_ft5x06_ts_probe,
1148         .remove   = edt_ft5x06_ts_remove,
1149 };
1150
1151 module_i2c_driver(edt_ft5x06_ts_driver);
1152
1153 MODULE_AUTHOR("Simon Budig <simon.budig@kernelconcepts.de>");
1154 MODULE_DESCRIPTION("EDT FT5x06 I2C Touchscreen Driver");
1155 MODULE_LICENSE("GPL");