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/touchscreen.h> 41#include <linux/input/edt-ft5x06.h> 42 43#define MAX_SUPPORT_POINTS 5 44 45#define WORK_REGISTER_THRESHOLD 0x00 46#define WORK_REGISTER_REPORT_RATE 0x08 47#define WORK_REGISTER_GAIN 0x30 48#define WORK_REGISTER_OFFSET 0x31 49#define WORK_REGISTER_NUM_X 0x33 50#define WORK_REGISTER_NUM_Y 0x34 51 52#define M09_REGISTER_THRESHOLD 0x80 53#define M09_REGISTER_GAIN 0x92 54#define M09_REGISTER_OFFSET 0x93 55#define M09_REGISTER_NUM_X 0x94 56#define M09_REGISTER_NUM_Y 0x95 57 58#define NO_REGISTER 0xff 59 60#define WORK_REGISTER_OPMODE 0x3c 61#define FACTORY_REGISTER_OPMODE 0x01 62 63#define TOUCH_EVENT_DOWN 0x00 64#define TOUCH_EVENT_UP 0x01 65#define TOUCH_EVENT_ON 0x02 66#define TOUCH_EVENT_RESERVED 0x03 67 68#define EDT_NAME_LEN 23 69#define EDT_SWITCH_MODE_RETRIES 10 70#define EDT_SWITCH_MODE_DELAY 5 /* msec */ 71#define EDT_RAW_DATA_RETRIES 100 72#define EDT_RAW_DATA_DELAY 1 /* msec */ 73 74enum edt_ver { 75 M06, 76 M09, 77}; 78 79struct edt_reg_addr { 80 int reg_threshold; 81 int reg_report_rate; 82 int reg_gain; 83 int reg_offset; 84 int reg_num_x; 85 int reg_num_y; 86}; 87 88struct edt_ft5x06_ts_data { 89 struct i2c_client *client; 90 struct input_dev *input; 91 u16 num_x; 92 u16 num_y; 93 94 int reset_pin; 95 int irq_pin; 96 int wake_pin; 97 98#if defined(CONFIG_DEBUG_FS) 99 struct dentry *debug_dir; 100 u8 *raw_buffer; 101 size_t raw_bufsize; 102#endif 103 104 struct mutex mutex; 105 bool factory_mode; 106 int threshold; 107 int gain; 108 int offset; 109 int report_rate; 110 111 char name[EDT_NAME_LEN]; 112 113 struct edt_reg_addr reg_addr; 114 enum edt_ver version; 115}; 116 117static int edt_ft5x06_ts_readwrite(struct i2c_client *client, 118 u16 wr_len, u8 *wr_buf, 119 u16 rd_len, u8 *rd_buf) 120{ 121 struct i2c_msg wrmsg[2]; 122 int i = 0; 123 int ret; 124 125 if (wr_len) { 126 wrmsg[i].addr = client->addr; 127 wrmsg[i].flags = 0; 128 wrmsg[i].len = wr_len; 129 wrmsg[i].buf = wr_buf; 130 i++; 131 } 132 if (rd_len) { 133 wrmsg[i].addr = client->addr; 134 wrmsg[i].flags = I2C_M_RD; 135 wrmsg[i].len = rd_len; 136 wrmsg[i].buf = rd_buf; 137 i++; 138 } 139 140 ret = i2c_transfer(client->adapter, wrmsg, i); 141 if (ret < 0) 142 return ret; 143 if (ret != i) 144 return -EIO; 145 146 return 0; 147} 148 149static bool edt_ft5x06_ts_check_crc(struct edt_ft5x06_ts_data *tsdata, 150 u8 *buf, int buflen) 151{ 152 int i; 153 u8 crc = 0; 154 155 for (i = 0; i < buflen - 1; i++) 156 crc ^= buf[i]; 157 158 if (crc != buf[buflen-1]) { 159 dev_err_ratelimited(&tsdata->client->dev, 160 "crc error: 0x%02x expected, got 0x%02x\n", 161 crc, buf[buflen-1]); 162 return false; 163 } 164 165 return true; 166} 167 168static irqreturn_t edt_ft5x06_ts_isr(int irq, void *dev_id) 169{ 170 struct edt_ft5x06_ts_data *tsdata = dev_id; 171 struct device *dev = &tsdata->client->dev; 172 u8 cmd; 173 u8 rdbuf[29]; 174 int i, type, x, y, id; 175 int offset, tplen, datalen; 176 int error; 177 178 switch (tsdata->version) { 179 case M06: 180 cmd = 0xf9; /* tell the controller to send touch data */ 181 offset = 5; /* where the actual touch data starts */ 182 tplen = 4; /* data comes in so called frames */ 183 datalen = 26; /* how much bytes to listen for */ 184 break; 185 186 case M09: 187 cmd = 0x02; 188 offset = 1; 189 tplen = 6; 190 datalen = 29; 191 break; 192 193 default: 194 goto out; 195 } 196 197 memset(rdbuf, 0, sizeof(rdbuf)); 198 199 error = edt_ft5x06_ts_readwrite(tsdata->client, 200 sizeof(cmd), &cmd, 201 datalen, rdbuf); 202 if (error) { 203 dev_err_ratelimited(dev, "Unable to fetch data, error: %d\n", 204 error); 205 goto out; 206 } 207 208 /* M09 does not send header or CRC */ 209 if (tsdata->version == M06) { 210 if (rdbuf[0] != 0xaa || rdbuf[1] != 0xaa || 211 rdbuf[2] != datalen) { 212 dev_err_ratelimited(dev, 213 "Unexpected header: %02x%02x%02x!\n", 214 rdbuf[0], rdbuf[1], rdbuf[2]); 215 goto out; 216 } 217 218 if (!edt_ft5x06_ts_check_crc(tsdata, rdbuf, datalen)) 219 goto out; 220 } 221 222 for (i = 0; i < MAX_SUPPORT_POINTS; i++) { 223 u8 *buf = &rdbuf[i * tplen + offset]; 224 bool down; 225 226 type = buf[0] >> 6; 227 /* ignore Reserved events */ 228 if (type == TOUCH_EVENT_RESERVED) 229 continue; 230 231 /* M06 sometimes sends bogus coordinates in TOUCH_DOWN */ 232 if (tsdata->version == M06 && type == TOUCH_EVENT_DOWN) 233 continue; 234 235 x = ((buf[0] << 8) | buf[1]) & 0x0fff; 236 y = ((buf[2] << 8) | buf[3]) & 0x0fff; 237 id = (buf[2] >> 4) & 0x0f; 238 down = type != TOUCH_EVENT_UP; 239 240 input_mt_slot(tsdata->input, id); 241 input_mt_report_slot_state(tsdata->input, MT_TOOL_FINGER, down); 242 243 if (!down) 244 continue; 245 246 input_report_abs(tsdata->input, ABS_MT_POSITION_X, x); 247 input_report_abs(tsdata->input, ABS_MT_POSITION_Y, y); 248 } 249 250 input_mt_report_pointer_emulation(tsdata->input, true); 251 input_sync(tsdata->input); 252 253out: 254 return IRQ_HANDLED; 255} 256 257static 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[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, 2, 275 wrbuf, 0, NULL); 276 277 default: 278 return -EINVAL; 279 } 280} 281 282static 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 323struct 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 345static 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 *)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); 401out: 402 mutex_unlock(&tsdata->mutex); 403 return error ?: count; 404} 405 406static 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 *)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 460out: 461 mutex_unlock(&tsdata->mutex); 462 return error ?: count; 463} 464 465static EDT_ATTR(gain, S_IWUSR | S_IRUGO, WORK_REGISTER_GAIN, 466 M09_REGISTER_GAIN, 0, 31); 467static EDT_ATTR(offset, S_IWUSR | S_IRUGO, WORK_REGISTER_OFFSET, 468 M09_REGISTER_OFFSET, 0, 31); 469static EDT_ATTR(threshold, S_IWUSR | S_IRUGO, WORK_REGISTER_THRESHOLD, 470 M09_REGISTER_THRESHOLD, 20, 80); 471static EDT_ATTR(report_rate, S_IWUSR | S_IRUGO, WORK_REGISTER_REPORT_RATE, 472 NO_REGISTER, 3, 14); 473 474static 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 482static const struct attribute_group edt_ft5x06_attr_group = { 483 .attrs = edt_ft5x06_attrs, 484}; 485 486#ifdef CONFIG_DEBUG_FS 487static 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 535err_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 543m09_out: 544 dev_err(&client->dev, "No factory mode support for M09\n"); 545 return -EINVAL; 546 547} 548 549static 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 601static 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 610static 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 630DEFINE_SIMPLE_ATTRIBUTE(debugfs_mode_fops, edt_ft5x06_debugfs_mode_get, 631 edt_ft5x06_debugfs_mode_set, "%llu\n"); 632 633static 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; 706out: 707 mutex_unlock(&tsdata->mutex); 708 return error ?: read; 709}; 710 711static const struct file_operations debugfs_raw_data_fops = { 712 .open = simple_open, 713 .read = edt_ft5x06_debugfs_raw_data_read, 714}; 715 716static void 717edt_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 733static void 734edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata) 735{ 736 debugfs_remove_recursive(tsdata->debug_dir); 737 kfree(tsdata->raw_buffer); 738} 739 740#else 741 742static inline void 743edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata, 744 const char *debugfs_name) 745{ 746} 747 748static inline void 749edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata) 750{ 751} 752 753#endif /* CONFIG_DEBUGFS */ 754 755static int edt_ft5x06_ts_reset(struct i2c_client *client, 756 struct edt_ft5x06_ts_data *tsdata) 757{ 758 int error; 759 760 if (gpio_is_valid(tsdata->wake_pin)) { 761 error = devm_gpio_request_one(&client->dev, 762 tsdata->wake_pin, GPIOF_OUT_INIT_LOW, 763 "edt-ft5x06 wake"); 764 if (error) { 765 dev_err(&client->dev, 766 "Failed to request GPIO %d as wake pin, error %d\n", 767 tsdata->wake_pin, error); 768 return error; 769 } 770 771 msleep(5); 772 gpio_set_value(tsdata->wake_pin, 1); 773 } 774 if (gpio_is_valid(tsdata->reset_pin)) { 775 /* this pulls reset down, enabling the low active reset */ 776 error = devm_gpio_request_one(&client->dev, 777 tsdata->reset_pin, GPIOF_OUT_INIT_LOW, 778 "edt-ft5x06 reset"); 779 if (error) { 780 dev_err(&client->dev, 781 "Failed to request GPIO %d as reset pin, error %d\n", 782 tsdata->reset_pin, error); 783 return error; 784 } 785 786 msleep(5); 787 gpio_set_value(tsdata->reset_pin, 1); 788 msleep(300); 789 } 790 791 return 0; 792} 793 794static int edt_ft5x06_ts_identify(struct i2c_client *client, 795 struct edt_ft5x06_ts_data *tsdata, 796 char *fw_version) 797{ 798 u8 rdbuf[EDT_NAME_LEN]; 799 char *p; 800 int error; 801 char *model_name = tsdata->name; 802 803 /* see what we find if we assume it is a M06 * 804 * if we get less than EDT_NAME_LEN, we don't want 805 * to have garbage in there 806 */ 807 memset(rdbuf, 0, sizeof(rdbuf)); 808 error = edt_ft5x06_ts_readwrite(client, 1, "\xbb", 809 EDT_NAME_LEN - 1, rdbuf); 810 if (error) 811 return error; 812 813 /* if we find something consistent, stay with that assumption 814 * at least M09 won't send 3 bytes here 815 */ 816 if (!(strncasecmp(rdbuf + 1, "EP0", 3))) { 817 tsdata->version = M06; 818 819 /* remove last '$' end marker */ 820 rdbuf[EDT_NAME_LEN - 1] = '\0'; 821 if (rdbuf[EDT_NAME_LEN - 2] == '$') 822 rdbuf[EDT_NAME_LEN - 2] = '\0'; 823 824 /* look for Model/Version separator */ 825 p = strchr(rdbuf, '*'); 826 if (p) 827 *p++ = '\0'; 828 strlcpy(model_name, rdbuf + 1, EDT_NAME_LEN); 829 strlcpy(fw_version, p ? p : "", EDT_NAME_LEN); 830 } else { 831 /* since there are only two versions around (M06, M09) */ 832 tsdata->version = M09; 833 834 error = edt_ft5x06_ts_readwrite(client, 1, "\xA6", 835 2, rdbuf); 836 if (error) 837 return error; 838 839 strlcpy(fw_version, rdbuf, 2); 840 841 error = edt_ft5x06_ts_readwrite(client, 1, "\xA8", 842 1, rdbuf); 843 if (error) 844 return error; 845 846 snprintf(model_name, EDT_NAME_LEN, "EP0%i%i0M09", 847 rdbuf[0] >> 4, rdbuf[0] & 0x0F); 848 } 849 850 return 0; 851} 852 853#define EDT_ATTR_CHECKSET(name, reg) \ 854do { \ 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} while (0) 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 866static 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 876static void 877edt_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 893static void 894edt_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 909static void 910edt_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 935static 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 951static 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 958static 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_KEY, input->evbit); 1039 __set_bit(EV_ABS, input->evbit); 1040 __set_bit(BTN_TOUCH, input->keybit); 1041 input_set_abs_params(input, ABS_X, 0, tsdata->num_x * 64 - 1, 0, 0); 1042 input_set_abs_params(input, ABS_Y, 0, tsdata->num_y * 64 - 1, 0, 0); 1043 input_set_abs_params(input, ABS_MT_POSITION_X, 1044 0, tsdata->num_x * 64 - 1, 0, 0); 1045 input_set_abs_params(input, ABS_MT_POSITION_Y, 1046 0, tsdata->num_y * 64 - 1, 0, 0); 1047 1048 if (!pdata) 1049 touchscreen_parse_of_params(input); 1050 1051 error = input_mt_init_slots(input, MAX_SUPPORT_POINTS, 0); 1052 if (error) { 1053 dev_err(&client->dev, "Unable to init MT slots.\n"); 1054 return error; 1055 } 1056 1057 input_set_drvdata(input, tsdata); 1058 i2c_set_clientdata(client, tsdata); 1059 1060 error = devm_request_threaded_irq(&client->dev, client->irq, NULL, 1061 edt_ft5x06_ts_isr, 1062 IRQF_TRIGGER_FALLING | IRQF_ONESHOT, 1063 client->name, tsdata); 1064 if (error) { 1065 dev_err(&client->dev, "Unable to request touchscreen IRQ.\n"); 1066 return error; 1067 } 1068 1069 error = sysfs_create_group(&client->dev.kobj, &edt_ft5x06_attr_group); 1070 if (error) 1071 return error; 1072 1073 error = input_register_device(input); 1074 if (error) 1075 goto err_remove_attrs; 1076 1077 edt_ft5x06_ts_prepare_debugfs(tsdata, dev_driver_string(&client->dev)); 1078 device_init_wakeup(&client->dev, 1); 1079 1080 dev_dbg(&client->dev, 1081 "EDT FT5x06 initialized: IRQ %d, WAKE pin %d, Reset pin %d.\n", 1082 client->irq, tsdata->wake_pin, tsdata->reset_pin); 1083 1084 return 0; 1085 1086err_remove_attrs: 1087 sysfs_remove_group(&client->dev.kobj, &edt_ft5x06_attr_group); 1088 return error; 1089} 1090 1091static int edt_ft5x06_ts_remove(struct i2c_client *client) 1092{ 1093 struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client); 1094 1095 edt_ft5x06_ts_teardown_debugfs(tsdata); 1096 sysfs_remove_group(&client->dev.kobj, &edt_ft5x06_attr_group); 1097 1098 return 0; 1099} 1100 1101static int __maybe_unused edt_ft5x06_ts_suspend(struct device *dev) 1102{ 1103 struct i2c_client *client = to_i2c_client(dev); 1104 1105 if (device_may_wakeup(dev)) 1106 enable_irq_wake(client->irq); 1107 1108 return 0; 1109} 1110 1111static int __maybe_unused edt_ft5x06_ts_resume(struct device *dev) 1112{ 1113 struct i2c_client *client = to_i2c_client(dev); 1114 1115 if (device_may_wakeup(dev)) 1116 disable_irq_wake(client->irq); 1117 1118 return 0; 1119} 1120 1121static SIMPLE_DEV_PM_OPS(edt_ft5x06_ts_pm_ops, 1122 edt_ft5x06_ts_suspend, edt_ft5x06_ts_resume); 1123 1124static const struct i2c_device_id edt_ft5x06_ts_id[] = { 1125 { "edt-ft5x06", 0, }, 1126 { /* sentinel */ } 1127}; 1128MODULE_DEVICE_TABLE(i2c, edt_ft5x06_ts_id); 1129 1130#ifdef CONFIG_OF 1131static const struct of_device_id edt_ft5x06_of_match[] = { 1132 { .compatible = "edt,edt-ft5206", }, 1133 { .compatible = "edt,edt-ft5306", }, 1134 { .compatible = "edt,edt-ft5406", }, 1135 { /* sentinel */ } 1136}; 1137MODULE_DEVICE_TABLE(of, edt_ft5x06_of_match); 1138#endif 1139 1140static struct i2c_driver edt_ft5x06_ts_driver = { 1141 .driver = { 1142 .owner = THIS_MODULE, 1143 .name = "edt_ft5x06", 1144 .of_match_table = of_match_ptr(edt_ft5x06_of_match), 1145 .pm = &edt_ft5x06_ts_pm_ops, 1146 }, 1147 .id_table = edt_ft5x06_ts_id, 1148 .probe = edt_ft5x06_ts_probe, 1149 .remove = edt_ft5x06_ts_remove, 1150}; 1151 1152module_i2c_driver(edt_ft5x06_ts_driver); 1153 1154MODULE_AUTHOR("Simon Budig <simon.budig@kernelconcepts.de>"); 1155MODULE_DESCRIPTION("EDT FT5x06 I2C Touchscreen Driver"); 1156MODULE_LICENSE("GPL"); 1157