1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * Elan I2C/SMBus Touchpad driver 4 * 5 * Copyright (c) 2013 ELAN Microelectronics Corp. 6 * 7 * Author: 林政維 (Duson Lin) <dusonlin@emc.com.tw> 8 * Author: KT Liao <kt.liao@emc.com.tw> 9 * Version: 1.6.3 10 * 11 * Based on cyapa driver: 12 * copyright (c) 2011-2012 Cypress Semiconductor, Inc. 13 * copyright (c) 2011-2012 Google, Inc. 14 * 15 * Trademarks are the property of their respective owners. 16 */ 17 18 #include <linux/acpi.h> 19 #include <linux/delay.h> 20 #include <linux/device.h> 21 #include <linux/firmware.h> 22 #include <linux/i2c.h> 23 #include <linux/init.h> 24 #include <linux/input/mt.h> 25 #include <linux/interrupt.h> 26 #include <linux/irq.h> 27 #include <linux/module.h> 28 #include <linux/slab.h> 29 #include <linux/kernel.h> 30 #include <linux/sched.h> 31 #include <linux/input.h> 32 #include <linux/uaccess.h> 33 #include <linux/jiffies.h> 34 #include <linux/completion.h> 35 #include <linux/of.h> 36 #include <linux/property.h> 37 #include <linux/regulator/consumer.h> 38 #include <asm/unaligned.h> 39 40 #include "elan_i2c.h" 41 42 #define DRIVER_NAME "elan_i2c" 43 #define ELAN_VENDOR_ID 0x04f3 44 #define ETP_MAX_PRESSURE 255 45 #define ETP_FWIDTH_REDUCE 90 46 #define ETP_FINGER_WIDTH 15 47 #define ETP_RETRY_COUNT 3 48 49 #define ETP_MAX_FINGERS 5 50 #define ETP_FINGER_DATA_LEN 5 51 #define ETP_REPORT_ID 0x5D 52 #define ETP_TP_REPORT_ID 0x5E 53 #define ETP_REPORT_ID_OFFSET 2 54 #define ETP_TOUCH_INFO_OFFSET 3 55 #define ETP_FINGER_DATA_OFFSET 4 56 #define ETP_HOVER_INFO_OFFSET 30 57 #define ETP_MAX_REPORT_LEN 34 58 59 /* The main device structure */ 60 struct elan_tp_data { 61 struct i2c_client *client; 62 struct input_dev *input; 63 struct input_dev *tp_input; /* trackpoint input node */ 64 struct regulator *vcc; 65 66 const struct elan_transport_ops *ops; 67 68 /* for fw update */ 69 struct completion fw_completion; 70 bool in_fw_update; 71 72 struct mutex sysfs_mutex; 73 74 unsigned int max_x; 75 unsigned int max_y; 76 unsigned int width_x; 77 unsigned int width_y; 78 unsigned int x_res; 79 unsigned int y_res; 80 81 u8 pattern; 82 u16 product_id; 83 u8 fw_version; 84 u8 sm_version; 85 u8 iap_version; 86 u16 fw_checksum; 87 int pressure_adjustment; 88 u8 mode; 89 u16 ic_type; 90 u16 fw_validpage_count; 91 u16 fw_signature_address; 92 93 bool irq_wake; 94 95 u8 min_baseline; 96 u8 max_baseline; 97 bool baseline_ready; 98 u8 clickpad; 99 }; 100 101 static int elan_get_fwinfo(u16 ic_type, u16 *validpage_count, 102 u16 *signature_address) 103 { 104 switch (ic_type) { 105 case 0x00: 106 case 0x06: 107 case 0x08: 108 *validpage_count = 512; 109 break; 110 case 0x03: 111 case 0x07: 112 case 0x09: 113 case 0x0A: 114 case 0x0B: 115 case 0x0C: 116 *validpage_count = 768; 117 break; 118 case 0x0D: 119 *validpage_count = 896; 120 break; 121 case 0x0E: 122 *validpage_count = 640; 123 break; 124 case 0x10: 125 *validpage_count = 1024; 126 break; 127 default: 128 /* unknown ic type clear value */ 129 *validpage_count = 0; 130 *signature_address = 0; 131 return -ENXIO; 132 } 133 134 *signature_address = 135 (*validpage_count * ETP_FW_PAGE_SIZE) - ETP_FW_SIGNATURE_SIZE; 136 137 return 0; 138 } 139 140 static int elan_enable_power(struct elan_tp_data *data) 141 { 142 int repeat = ETP_RETRY_COUNT; 143 int error; 144 145 error = regulator_enable(data->vcc); 146 if (error) { 147 dev_err(&data->client->dev, 148 "failed to enable regulator: %d\n", error); 149 return error; 150 } 151 152 do { 153 error = data->ops->power_control(data->client, true); 154 if (error >= 0) 155 return 0; 156 157 msleep(30); 158 } while (--repeat > 0); 159 160 dev_err(&data->client->dev, "failed to enable power: %d\n", error); 161 return error; 162 } 163 164 static int elan_disable_power(struct elan_tp_data *data) 165 { 166 int repeat = ETP_RETRY_COUNT; 167 int error; 168 169 do { 170 error = data->ops->power_control(data->client, false); 171 if (!error) { 172 error = regulator_disable(data->vcc); 173 if (error) { 174 dev_err(&data->client->dev, 175 "failed to disable regulator: %d\n", 176 error); 177 /* Attempt to power the chip back up */ 178 data->ops->power_control(data->client, true); 179 break; 180 } 181 182 return 0; 183 } 184 185 msleep(30); 186 } while (--repeat > 0); 187 188 dev_err(&data->client->dev, "failed to disable power: %d\n", error); 189 return error; 190 } 191 192 static int elan_sleep(struct elan_tp_data *data) 193 { 194 int repeat = ETP_RETRY_COUNT; 195 int error; 196 197 do { 198 error = data->ops->sleep_control(data->client, true); 199 if (!error) 200 return 0; 201 202 msleep(30); 203 } while (--repeat > 0); 204 205 return error; 206 } 207 208 static int elan_query_product(struct elan_tp_data *data) 209 { 210 int error; 211 212 error = data->ops->get_product_id(data->client, &data->product_id); 213 if (error) 214 return error; 215 216 error = data->ops->get_sm_version(data->client, &data->ic_type, 217 &data->sm_version, &data->clickpad); 218 if (error) 219 return error; 220 221 return 0; 222 } 223 224 static int elan_check_ASUS_special_fw(struct elan_tp_data *data) 225 { 226 if (data->ic_type == 0x0E) { 227 switch (data->product_id) { 228 case 0x05 ... 0x07: 229 case 0x09: 230 case 0x13: 231 return true; 232 } 233 } else if (data->ic_type == 0x08 && data->product_id == 0x26) { 234 /* ASUS EeeBook X205TA */ 235 return true; 236 } 237 238 return false; 239 } 240 241 static int __elan_initialize(struct elan_tp_data *data) 242 { 243 struct i2c_client *client = data->client; 244 bool woken_up = false; 245 int error; 246 247 error = data->ops->initialize(client); 248 if (error) { 249 dev_err(&client->dev, "device initialize failed: %d\n", error); 250 return error; 251 } 252 253 error = elan_query_product(data); 254 if (error) 255 return error; 256 257 /* 258 * Some ASUS devices were shipped with firmware that requires 259 * touchpads to be woken up first, before attempting to switch 260 * them into absolute reporting mode. 261 */ 262 if (elan_check_ASUS_special_fw(data)) { 263 error = data->ops->sleep_control(client, false); 264 if (error) { 265 dev_err(&client->dev, 266 "failed to wake device up: %d\n", error); 267 return error; 268 } 269 270 msleep(200); 271 woken_up = true; 272 } 273 274 data->mode |= ETP_ENABLE_ABS; 275 error = data->ops->set_mode(client, data->mode); 276 if (error) { 277 dev_err(&client->dev, 278 "failed to switch to absolute mode: %d\n", error); 279 return error; 280 } 281 282 if (!woken_up) { 283 error = data->ops->sleep_control(client, false); 284 if (error) { 285 dev_err(&client->dev, 286 "failed to wake device up: %d\n", error); 287 return error; 288 } 289 } 290 291 return 0; 292 } 293 294 static int elan_initialize(struct elan_tp_data *data) 295 { 296 int repeat = ETP_RETRY_COUNT; 297 int error; 298 299 do { 300 error = __elan_initialize(data); 301 if (!error) 302 return 0; 303 304 msleep(30); 305 } while (--repeat > 0); 306 307 return error; 308 } 309 310 static int elan_query_device_info(struct elan_tp_data *data) 311 { 312 int error; 313 u16 ic_type; 314 315 error = data->ops->get_version(data->client, false, &data->fw_version); 316 if (error) 317 return error; 318 319 error = data->ops->get_checksum(data->client, false, 320 &data->fw_checksum); 321 if (error) 322 return error; 323 324 error = data->ops->get_version(data->client, true, &data->iap_version); 325 if (error) 326 return error; 327 328 error = data->ops->get_pressure_adjustment(data->client, 329 &data->pressure_adjustment); 330 if (error) 331 return error; 332 333 error = data->ops->get_pattern(data->client, &data->pattern); 334 if (error) 335 return error; 336 337 if (data->pattern == 0x01) 338 ic_type = data->ic_type; 339 else 340 ic_type = data->iap_version; 341 342 error = elan_get_fwinfo(ic_type, &data->fw_validpage_count, 343 &data->fw_signature_address); 344 if (error) 345 dev_warn(&data->client->dev, 346 "unexpected iap version %#04x (ic type: %#04x), firmware update will not work\n", 347 data->iap_version, data->ic_type); 348 349 return 0; 350 } 351 352 static unsigned int elan_convert_resolution(u8 val) 353 { 354 /* 355 * (value from firmware) * 10 + 790 = dpi 356 * 357 * We also have to convert dpi to dots/mm (*10/254 to avoid floating 358 * point). 359 */ 360 361 return ((int)(char)val * 10 + 790) * 10 / 254; 362 } 363 364 static int elan_query_device_parameters(struct elan_tp_data *data) 365 { 366 unsigned int x_traces, y_traces; 367 u8 hw_x_res, hw_y_res; 368 int error; 369 370 error = data->ops->get_max(data->client, &data->max_x, &data->max_y); 371 if (error) 372 return error; 373 374 error = data->ops->get_num_traces(data->client, &x_traces, &y_traces); 375 if (error) 376 return error; 377 378 data->width_x = data->max_x / x_traces; 379 data->width_y = data->max_y / y_traces; 380 381 error = data->ops->get_resolution(data->client, &hw_x_res, &hw_y_res); 382 if (error) 383 return error; 384 385 data->x_res = elan_convert_resolution(hw_x_res); 386 data->y_res = elan_convert_resolution(hw_y_res); 387 388 return 0; 389 } 390 391 /* 392 ********************************************************** 393 * IAP firmware updater related routines 394 ********************************************************** 395 */ 396 static int elan_write_fw_block(struct elan_tp_data *data, 397 const u8 *page, u16 checksum, int idx) 398 { 399 int retry = ETP_RETRY_COUNT; 400 int error; 401 402 do { 403 error = data->ops->write_fw_block(data->client, 404 page, checksum, idx); 405 if (!error) 406 return 0; 407 408 dev_dbg(&data->client->dev, 409 "IAP retrying page %d (error: %d)\n", idx, error); 410 } while (--retry > 0); 411 412 return error; 413 } 414 415 static int __elan_update_firmware(struct elan_tp_data *data, 416 const struct firmware *fw) 417 { 418 struct i2c_client *client = data->client; 419 struct device *dev = &client->dev; 420 int i, j; 421 int error; 422 u16 iap_start_addr; 423 u16 boot_page_count; 424 u16 sw_checksum = 0, fw_checksum = 0; 425 426 error = data->ops->prepare_fw_update(client); 427 if (error) 428 return error; 429 430 iap_start_addr = get_unaligned_le16(&fw->data[ETP_IAP_START_ADDR * 2]); 431 432 boot_page_count = (iap_start_addr * 2) / ETP_FW_PAGE_SIZE; 433 for (i = boot_page_count; i < data->fw_validpage_count; i++) { 434 u16 checksum = 0; 435 const u8 *page = &fw->data[i * ETP_FW_PAGE_SIZE]; 436 437 for (j = 0; j < ETP_FW_PAGE_SIZE; j += 2) 438 checksum += ((page[j + 1] << 8) | page[j]); 439 440 error = elan_write_fw_block(data, page, checksum, i); 441 if (error) { 442 dev_err(dev, "write page %d fail: %d\n", i, error); 443 return error; 444 } 445 446 sw_checksum += checksum; 447 } 448 449 /* Wait WDT reset and power on reset */ 450 msleep(600); 451 452 error = data->ops->finish_fw_update(client, &data->fw_completion); 453 if (error) 454 return error; 455 456 error = data->ops->get_checksum(client, true, &fw_checksum); 457 if (error) 458 return error; 459 460 if (sw_checksum != fw_checksum) { 461 dev_err(dev, "checksum diff sw=[%04X], fw=[%04X]\n", 462 sw_checksum, fw_checksum); 463 return -EIO; 464 } 465 466 return 0; 467 } 468 469 static int elan_update_firmware(struct elan_tp_data *data, 470 const struct firmware *fw) 471 { 472 struct i2c_client *client = data->client; 473 int retval; 474 475 dev_dbg(&client->dev, "Starting firmware update....\n"); 476 477 disable_irq(client->irq); 478 data->in_fw_update = true; 479 480 retval = __elan_update_firmware(data, fw); 481 if (retval) { 482 dev_err(&client->dev, "firmware update failed: %d\n", retval); 483 data->ops->iap_reset(client); 484 } else { 485 /* Reinitialize TP after fw is updated */ 486 elan_initialize(data); 487 elan_query_device_info(data); 488 } 489 490 data->in_fw_update = false; 491 enable_irq(client->irq); 492 493 return retval; 494 } 495 496 /* 497 ******************************************************************* 498 * SYSFS attributes 499 ******************************************************************* 500 */ 501 static ssize_t elan_sysfs_read_fw_checksum(struct device *dev, 502 struct device_attribute *attr, 503 char *buf) 504 { 505 struct i2c_client *client = to_i2c_client(dev); 506 struct elan_tp_data *data = i2c_get_clientdata(client); 507 508 return sprintf(buf, "0x%04x\n", data->fw_checksum); 509 } 510 511 static ssize_t elan_sysfs_read_product_id(struct device *dev, 512 struct device_attribute *attr, 513 char *buf) 514 { 515 struct i2c_client *client = to_i2c_client(dev); 516 struct elan_tp_data *data = i2c_get_clientdata(client); 517 518 return sprintf(buf, ETP_PRODUCT_ID_FORMAT_STRING "\n", 519 data->product_id); 520 } 521 522 static ssize_t elan_sysfs_read_fw_ver(struct device *dev, 523 struct device_attribute *attr, 524 char *buf) 525 { 526 struct i2c_client *client = to_i2c_client(dev); 527 struct elan_tp_data *data = i2c_get_clientdata(client); 528 529 return sprintf(buf, "%d.0\n", data->fw_version); 530 } 531 532 static ssize_t elan_sysfs_read_sm_ver(struct device *dev, 533 struct device_attribute *attr, 534 char *buf) 535 { 536 struct i2c_client *client = to_i2c_client(dev); 537 struct elan_tp_data *data = i2c_get_clientdata(client); 538 539 return sprintf(buf, "%d.0\n", data->sm_version); 540 } 541 542 static ssize_t elan_sysfs_read_iap_ver(struct device *dev, 543 struct device_attribute *attr, 544 char *buf) 545 { 546 struct i2c_client *client = to_i2c_client(dev); 547 struct elan_tp_data *data = i2c_get_clientdata(client); 548 549 return sprintf(buf, "%d.0\n", data->iap_version); 550 } 551 552 static ssize_t elan_sysfs_update_fw(struct device *dev, 553 struct device_attribute *attr, 554 const char *buf, size_t count) 555 { 556 struct elan_tp_data *data = dev_get_drvdata(dev); 557 const struct firmware *fw; 558 char *fw_name; 559 int error; 560 const u8 *fw_signature; 561 static const u8 signature[] = {0xAA, 0x55, 0xCC, 0x33, 0xFF, 0xFF}; 562 563 if (data->fw_validpage_count == 0) 564 return -EINVAL; 565 566 /* Look for a firmware with the product id appended. */ 567 fw_name = kasprintf(GFP_KERNEL, ETP_FW_NAME, data->product_id); 568 if (!fw_name) { 569 dev_err(dev, "failed to allocate memory for firmware name\n"); 570 return -ENOMEM; 571 } 572 573 dev_info(dev, "requesting fw '%s'\n", fw_name); 574 error = request_firmware(&fw, fw_name, dev); 575 kfree(fw_name); 576 if (error) { 577 dev_err(dev, "failed to request firmware: %d\n", error); 578 return error; 579 } 580 581 /* Firmware file must match signature data */ 582 fw_signature = &fw->data[data->fw_signature_address]; 583 if (memcmp(fw_signature, signature, sizeof(signature)) != 0) { 584 dev_err(dev, "signature mismatch (expected %*ph, got %*ph)\n", 585 (int)sizeof(signature), signature, 586 (int)sizeof(signature), fw_signature); 587 error = -EBADF; 588 goto out_release_fw; 589 } 590 591 error = mutex_lock_interruptible(&data->sysfs_mutex); 592 if (error) 593 goto out_release_fw; 594 595 error = elan_update_firmware(data, fw); 596 597 mutex_unlock(&data->sysfs_mutex); 598 599 out_release_fw: 600 release_firmware(fw); 601 return error ?: count; 602 } 603 604 static ssize_t calibrate_store(struct device *dev, 605 struct device_attribute *attr, 606 const char *buf, size_t count) 607 { 608 struct i2c_client *client = to_i2c_client(dev); 609 struct elan_tp_data *data = i2c_get_clientdata(client); 610 int tries = 20; 611 int retval; 612 int error; 613 u8 val[ETP_CALIBRATE_MAX_LEN]; 614 615 retval = mutex_lock_interruptible(&data->sysfs_mutex); 616 if (retval) 617 return retval; 618 619 disable_irq(client->irq); 620 621 data->mode |= ETP_ENABLE_CALIBRATE; 622 retval = data->ops->set_mode(client, data->mode); 623 if (retval) { 624 dev_err(dev, "failed to enable calibration mode: %d\n", 625 retval); 626 goto out; 627 } 628 629 retval = data->ops->calibrate(client); 630 if (retval) { 631 dev_err(dev, "failed to start calibration: %d\n", 632 retval); 633 goto out_disable_calibrate; 634 } 635 636 val[0] = 0xff; 637 do { 638 /* Wait 250ms before checking if calibration has completed. */ 639 msleep(250); 640 641 retval = data->ops->calibrate_result(client, val); 642 if (retval) 643 dev_err(dev, "failed to check calibration result: %d\n", 644 retval); 645 else if (val[0] == 0) 646 break; /* calibration done */ 647 648 } while (--tries); 649 650 if (tries == 0) { 651 dev_err(dev, "failed to calibrate. Timeout.\n"); 652 retval = -ETIMEDOUT; 653 } 654 655 out_disable_calibrate: 656 data->mode &= ~ETP_ENABLE_CALIBRATE; 657 error = data->ops->set_mode(data->client, data->mode); 658 if (error) { 659 dev_err(dev, "failed to disable calibration mode: %d\n", 660 error); 661 if (!retval) 662 retval = error; 663 } 664 out: 665 enable_irq(client->irq); 666 mutex_unlock(&data->sysfs_mutex); 667 return retval ?: count; 668 } 669 670 static ssize_t elan_sysfs_read_mode(struct device *dev, 671 struct device_attribute *attr, 672 char *buf) 673 { 674 struct i2c_client *client = to_i2c_client(dev); 675 struct elan_tp_data *data = i2c_get_clientdata(client); 676 int error; 677 enum tp_mode mode; 678 679 error = mutex_lock_interruptible(&data->sysfs_mutex); 680 if (error) 681 return error; 682 683 error = data->ops->iap_get_mode(data->client, &mode); 684 685 mutex_unlock(&data->sysfs_mutex); 686 687 if (error) 688 return error; 689 690 return sprintf(buf, "%d\n", (int)mode); 691 } 692 693 static DEVICE_ATTR(product_id, S_IRUGO, elan_sysfs_read_product_id, NULL); 694 static DEVICE_ATTR(firmware_version, S_IRUGO, elan_sysfs_read_fw_ver, NULL); 695 static DEVICE_ATTR(sample_version, S_IRUGO, elan_sysfs_read_sm_ver, NULL); 696 static DEVICE_ATTR(iap_version, S_IRUGO, elan_sysfs_read_iap_ver, NULL); 697 static DEVICE_ATTR(fw_checksum, S_IRUGO, elan_sysfs_read_fw_checksum, NULL); 698 static DEVICE_ATTR(mode, S_IRUGO, elan_sysfs_read_mode, NULL); 699 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, elan_sysfs_update_fw); 700 701 static DEVICE_ATTR_WO(calibrate); 702 703 static struct attribute *elan_sysfs_entries[] = { 704 &dev_attr_product_id.attr, 705 &dev_attr_firmware_version.attr, 706 &dev_attr_sample_version.attr, 707 &dev_attr_iap_version.attr, 708 &dev_attr_fw_checksum.attr, 709 &dev_attr_calibrate.attr, 710 &dev_attr_mode.attr, 711 &dev_attr_update_fw.attr, 712 NULL, 713 }; 714 715 static const struct attribute_group elan_sysfs_group = { 716 .attrs = elan_sysfs_entries, 717 }; 718 719 static ssize_t acquire_store(struct device *dev, struct device_attribute *attr, 720 const char *buf, size_t count) 721 { 722 struct i2c_client *client = to_i2c_client(dev); 723 struct elan_tp_data *data = i2c_get_clientdata(client); 724 int error; 725 int retval; 726 727 retval = mutex_lock_interruptible(&data->sysfs_mutex); 728 if (retval) 729 return retval; 730 731 disable_irq(client->irq); 732 733 data->baseline_ready = false; 734 735 data->mode |= ETP_ENABLE_CALIBRATE; 736 retval = data->ops->set_mode(data->client, data->mode); 737 if (retval) { 738 dev_err(dev, "Failed to enable calibration mode to get baseline: %d\n", 739 retval); 740 goto out; 741 } 742 743 msleep(250); 744 745 retval = data->ops->get_baseline_data(data->client, true, 746 &data->max_baseline); 747 if (retval) { 748 dev_err(dev, "Failed to read max baseline form device: %d\n", 749 retval); 750 goto out_disable_calibrate; 751 } 752 753 retval = data->ops->get_baseline_data(data->client, false, 754 &data->min_baseline); 755 if (retval) { 756 dev_err(dev, "Failed to read min baseline form device: %d\n", 757 retval); 758 goto out_disable_calibrate; 759 } 760 761 data->baseline_ready = true; 762 763 out_disable_calibrate: 764 data->mode &= ~ETP_ENABLE_CALIBRATE; 765 error = data->ops->set_mode(data->client, data->mode); 766 if (error) { 767 dev_err(dev, "Failed to disable calibration mode after acquiring baseline: %d\n", 768 error); 769 if (!retval) 770 retval = error; 771 } 772 out: 773 enable_irq(client->irq); 774 mutex_unlock(&data->sysfs_mutex); 775 return retval ?: count; 776 } 777 778 static ssize_t min_show(struct device *dev, 779 struct device_attribute *attr, char *buf) 780 { 781 struct i2c_client *client = to_i2c_client(dev); 782 struct elan_tp_data *data = i2c_get_clientdata(client); 783 int retval; 784 785 retval = mutex_lock_interruptible(&data->sysfs_mutex); 786 if (retval) 787 return retval; 788 789 if (!data->baseline_ready) { 790 retval = -ENODATA; 791 goto out; 792 } 793 794 retval = snprintf(buf, PAGE_SIZE, "%d", data->min_baseline); 795 796 out: 797 mutex_unlock(&data->sysfs_mutex); 798 return retval; 799 } 800 801 static ssize_t max_show(struct device *dev, 802 struct device_attribute *attr, char *buf) 803 { 804 struct i2c_client *client = to_i2c_client(dev); 805 struct elan_tp_data *data = i2c_get_clientdata(client); 806 int retval; 807 808 retval = mutex_lock_interruptible(&data->sysfs_mutex); 809 if (retval) 810 return retval; 811 812 if (!data->baseline_ready) { 813 retval = -ENODATA; 814 goto out; 815 } 816 817 retval = snprintf(buf, PAGE_SIZE, "%d", data->max_baseline); 818 819 out: 820 mutex_unlock(&data->sysfs_mutex); 821 return retval; 822 } 823 824 825 static DEVICE_ATTR_WO(acquire); 826 static DEVICE_ATTR_RO(min); 827 static DEVICE_ATTR_RO(max); 828 829 static struct attribute *elan_baseline_sysfs_entries[] = { 830 &dev_attr_acquire.attr, 831 &dev_attr_min.attr, 832 &dev_attr_max.attr, 833 NULL, 834 }; 835 836 static const struct attribute_group elan_baseline_sysfs_group = { 837 .name = "baseline", 838 .attrs = elan_baseline_sysfs_entries, 839 }; 840 841 static const struct attribute_group *elan_sysfs_groups[] = { 842 &elan_sysfs_group, 843 &elan_baseline_sysfs_group, 844 NULL 845 }; 846 847 /* 848 ****************************************************************** 849 * Elan isr functions 850 ****************************************************************** 851 */ 852 static void elan_report_contact(struct elan_tp_data *data, 853 int contact_num, bool contact_valid, 854 u8 *finger_data) 855 { 856 struct input_dev *input = data->input; 857 unsigned int pos_x, pos_y; 858 unsigned int pressure, mk_x, mk_y; 859 unsigned int area_x, area_y, major, minor; 860 unsigned int scaled_pressure; 861 862 if (contact_valid) { 863 pos_x = ((finger_data[0] & 0xf0) << 4) | 864 finger_data[1]; 865 pos_y = ((finger_data[0] & 0x0f) << 8) | 866 finger_data[2]; 867 mk_x = (finger_data[3] & 0x0f); 868 mk_y = (finger_data[3] >> 4); 869 pressure = finger_data[4]; 870 871 if (pos_x > data->max_x || pos_y > data->max_y) { 872 dev_dbg(input->dev.parent, 873 "[%d] x=%d y=%d over max (%d, %d)", 874 contact_num, pos_x, pos_y, 875 data->max_x, data->max_y); 876 return; 877 } 878 879 /* 880 * To avoid treating large finger as palm, let's reduce the 881 * width x and y per trace. 882 */ 883 area_x = mk_x * (data->width_x - ETP_FWIDTH_REDUCE); 884 area_y = mk_y * (data->width_y - ETP_FWIDTH_REDUCE); 885 886 major = max(area_x, area_y); 887 minor = min(area_x, area_y); 888 889 scaled_pressure = pressure + data->pressure_adjustment; 890 891 if (scaled_pressure > ETP_MAX_PRESSURE) 892 scaled_pressure = ETP_MAX_PRESSURE; 893 894 input_mt_slot(input, contact_num); 895 input_mt_report_slot_state(input, MT_TOOL_FINGER, true); 896 input_report_abs(input, ABS_MT_POSITION_X, pos_x); 897 input_report_abs(input, ABS_MT_POSITION_Y, data->max_y - pos_y); 898 input_report_abs(input, ABS_MT_PRESSURE, scaled_pressure); 899 input_report_abs(input, ABS_TOOL_WIDTH, mk_x); 900 input_report_abs(input, ABS_MT_TOUCH_MAJOR, major); 901 input_report_abs(input, ABS_MT_TOUCH_MINOR, minor); 902 } else { 903 input_mt_slot(input, contact_num); 904 input_mt_report_slot_state(input, MT_TOOL_FINGER, false); 905 } 906 } 907 908 static void elan_report_absolute(struct elan_tp_data *data, u8 *packet) 909 { 910 struct input_dev *input = data->input; 911 u8 *finger_data = &packet[ETP_FINGER_DATA_OFFSET]; 912 int i; 913 u8 tp_info = packet[ETP_TOUCH_INFO_OFFSET]; 914 u8 hover_info = packet[ETP_HOVER_INFO_OFFSET]; 915 bool contact_valid, hover_event; 916 917 hover_event = hover_info & 0x40; 918 for (i = 0; i < ETP_MAX_FINGERS; i++) { 919 contact_valid = tp_info & (1U << (3 + i)); 920 elan_report_contact(data, i, contact_valid, finger_data); 921 922 if (contact_valid) 923 finger_data += ETP_FINGER_DATA_LEN; 924 } 925 926 input_report_key(input, BTN_LEFT, tp_info & 0x01); 927 input_report_key(input, BTN_RIGHT, tp_info & 0x02); 928 input_report_abs(input, ABS_DISTANCE, hover_event != 0); 929 input_mt_report_pointer_emulation(input, true); 930 input_sync(input); 931 } 932 933 static void elan_report_trackpoint(struct elan_tp_data *data, u8 *report) 934 { 935 struct input_dev *input = data->tp_input; 936 u8 *packet = &report[ETP_REPORT_ID_OFFSET + 1]; 937 int x, y; 938 939 if (!data->tp_input) { 940 dev_warn_once(&data->client->dev, 941 "received a trackpoint report while no trackpoint device has been created. Please report upstream.\n"); 942 return; 943 } 944 945 input_report_key(input, BTN_LEFT, packet[0] & 0x01); 946 input_report_key(input, BTN_RIGHT, packet[0] & 0x02); 947 input_report_key(input, BTN_MIDDLE, packet[0] & 0x04); 948 949 if ((packet[3] & 0x0F) == 0x06) { 950 x = packet[4] - (int)((packet[1] ^ 0x80) << 1); 951 y = (int)((packet[2] ^ 0x80) << 1) - packet[5]; 952 953 input_report_rel(input, REL_X, x); 954 input_report_rel(input, REL_Y, y); 955 } 956 957 input_sync(input); 958 } 959 960 static irqreturn_t elan_isr(int irq, void *dev_id) 961 { 962 struct elan_tp_data *data = dev_id; 963 struct device *dev = &data->client->dev; 964 int error; 965 u8 report[ETP_MAX_REPORT_LEN]; 966 967 /* 968 * When device is connected to i2c bus, when all IAP page writes 969 * complete, the driver will receive interrupt and must read 970 * 0000 to confirm that IAP is finished. 971 */ 972 if (data->in_fw_update) { 973 complete(&data->fw_completion); 974 goto out; 975 } 976 977 error = data->ops->get_report(data->client, report); 978 if (error) 979 goto out; 980 981 pm_wakeup_event(dev, 0); 982 983 switch (report[ETP_REPORT_ID_OFFSET]) { 984 case ETP_REPORT_ID: 985 elan_report_absolute(data, report); 986 break; 987 case ETP_TP_REPORT_ID: 988 elan_report_trackpoint(data, report); 989 break; 990 default: 991 dev_err(dev, "invalid report id data (%x)\n", 992 report[ETP_REPORT_ID_OFFSET]); 993 } 994 995 out: 996 return IRQ_HANDLED; 997 } 998 999 /* 1000 ****************************************************************** 1001 * Elan initialization functions 1002 ****************************************************************** 1003 */ 1004 1005 static int elan_setup_trackpoint_input_device(struct elan_tp_data *data) 1006 { 1007 struct device *dev = &data->client->dev; 1008 struct input_dev *input; 1009 1010 input = devm_input_allocate_device(dev); 1011 if (!input) 1012 return -ENOMEM; 1013 1014 input->name = "Elan TrackPoint"; 1015 input->id.bustype = BUS_I2C; 1016 input->id.vendor = ELAN_VENDOR_ID; 1017 input->id.product = data->product_id; 1018 input_set_drvdata(input, data); 1019 1020 input_set_capability(input, EV_REL, REL_X); 1021 input_set_capability(input, EV_REL, REL_Y); 1022 input_set_capability(input, EV_KEY, BTN_LEFT); 1023 input_set_capability(input, EV_KEY, BTN_RIGHT); 1024 input_set_capability(input, EV_KEY, BTN_MIDDLE); 1025 1026 __set_bit(INPUT_PROP_POINTER, input->propbit); 1027 __set_bit(INPUT_PROP_POINTING_STICK, input->propbit); 1028 1029 data->tp_input = input; 1030 1031 return 0; 1032 } 1033 1034 static int elan_setup_input_device(struct elan_tp_data *data) 1035 { 1036 struct device *dev = &data->client->dev; 1037 struct input_dev *input; 1038 unsigned int max_width = max(data->width_x, data->width_y); 1039 unsigned int min_width = min(data->width_x, data->width_y); 1040 int error; 1041 1042 input = devm_input_allocate_device(dev); 1043 if (!input) 1044 return -ENOMEM; 1045 1046 input->name = "Elan Touchpad"; 1047 input->id.bustype = BUS_I2C; 1048 input->id.vendor = ELAN_VENDOR_ID; 1049 input->id.product = data->product_id; 1050 input_set_drvdata(input, data); 1051 1052 error = input_mt_init_slots(input, ETP_MAX_FINGERS, 1053 INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED); 1054 if (error) { 1055 dev_err(dev, "failed to initialize MT slots: %d\n", error); 1056 return error; 1057 } 1058 1059 __set_bit(EV_ABS, input->evbit); 1060 __set_bit(INPUT_PROP_POINTER, input->propbit); 1061 if (data->clickpad) 1062 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit); 1063 else 1064 __set_bit(BTN_RIGHT, input->keybit); 1065 __set_bit(BTN_LEFT, input->keybit); 1066 1067 /* Set up ST parameters */ 1068 input_set_abs_params(input, ABS_X, 0, data->max_x, 0, 0); 1069 input_set_abs_params(input, ABS_Y, 0, data->max_y, 0, 0); 1070 input_abs_set_res(input, ABS_X, data->x_res); 1071 input_abs_set_res(input, ABS_Y, data->y_res); 1072 input_set_abs_params(input, ABS_PRESSURE, 0, ETP_MAX_PRESSURE, 0, 0); 1073 input_set_abs_params(input, ABS_TOOL_WIDTH, 0, ETP_FINGER_WIDTH, 0, 0); 1074 input_set_abs_params(input, ABS_DISTANCE, 0, 1, 0, 0); 1075 1076 /* And MT parameters */ 1077 input_set_abs_params(input, ABS_MT_POSITION_X, 0, data->max_x, 0, 0); 1078 input_set_abs_params(input, ABS_MT_POSITION_Y, 0, data->max_y, 0, 0); 1079 input_abs_set_res(input, ABS_MT_POSITION_X, data->x_res); 1080 input_abs_set_res(input, ABS_MT_POSITION_Y, data->y_res); 1081 input_set_abs_params(input, ABS_MT_PRESSURE, 0, 1082 ETP_MAX_PRESSURE, 0, 0); 1083 input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, 1084 ETP_FINGER_WIDTH * max_width, 0, 0); 1085 input_set_abs_params(input, ABS_MT_TOUCH_MINOR, 0, 1086 ETP_FINGER_WIDTH * min_width, 0, 0); 1087 1088 data->input = input; 1089 1090 return 0; 1091 } 1092 1093 static void elan_disable_regulator(void *_data) 1094 { 1095 struct elan_tp_data *data = _data; 1096 1097 regulator_disable(data->vcc); 1098 } 1099 1100 static void elan_remove_sysfs_groups(void *_data) 1101 { 1102 struct elan_tp_data *data = _data; 1103 1104 sysfs_remove_groups(&data->client->dev.kobj, elan_sysfs_groups); 1105 } 1106 1107 static int elan_probe(struct i2c_client *client, 1108 const struct i2c_device_id *dev_id) 1109 { 1110 const struct elan_transport_ops *transport_ops; 1111 struct device *dev = &client->dev; 1112 struct elan_tp_data *data; 1113 unsigned long irqflags; 1114 int error; 1115 1116 if (IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_I2C) && 1117 i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) { 1118 transport_ops = &elan_i2c_ops; 1119 } else if (IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) && 1120 i2c_check_functionality(client->adapter, 1121 I2C_FUNC_SMBUS_BYTE_DATA | 1122 I2C_FUNC_SMBUS_BLOCK_DATA | 1123 I2C_FUNC_SMBUS_I2C_BLOCK)) { 1124 transport_ops = &elan_smbus_ops; 1125 } else { 1126 dev_err(dev, "not a supported I2C/SMBus adapter\n"); 1127 return -EIO; 1128 } 1129 1130 data = devm_kzalloc(dev, sizeof(struct elan_tp_data), GFP_KERNEL); 1131 if (!data) 1132 return -ENOMEM; 1133 1134 i2c_set_clientdata(client, data); 1135 1136 data->ops = transport_ops; 1137 data->client = client; 1138 init_completion(&data->fw_completion); 1139 mutex_init(&data->sysfs_mutex); 1140 1141 data->vcc = devm_regulator_get(dev, "vcc"); 1142 if (IS_ERR(data->vcc)) { 1143 error = PTR_ERR(data->vcc); 1144 if (error != -EPROBE_DEFER) 1145 dev_err(dev, "Failed to get 'vcc' regulator: %d\n", 1146 error); 1147 return error; 1148 } 1149 1150 error = regulator_enable(data->vcc); 1151 if (error) { 1152 dev_err(dev, "Failed to enable regulator: %d\n", error); 1153 return error; 1154 } 1155 1156 error = devm_add_action(dev, elan_disable_regulator, data); 1157 if (error) { 1158 regulator_disable(data->vcc); 1159 dev_err(dev, "Failed to add disable regulator action: %d\n", 1160 error); 1161 return error; 1162 } 1163 1164 /* Make sure there is something at this address */ 1165 error = i2c_smbus_read_byte(client); 1166 if (error < 0) { 1167 dev_dbg(&client->dev, "nothing at this address: %d\n", error); 1168 return -ENXIO; 1169 } 1170 1171 /* Initialize the touchpad. */ 1172 error = elan_initialize(data); 1173 if (error) 1174 return error; 1175 1176 error = elan_query_device_info(data); 1177 if (error) 1178 return error; 1179 1180 error = elan_query_device_parameters(data); 1181 if (error) 1182 return error; 1183 1184 dev_info(dev, 1185 "Elan Touchpad: Module ID: 0x%04x, Firmware: 0x%04x, Sample: 0x%04x, IAP: 0x%04x\n", 1186 data->product_id, 1187 data->fw_version, 1188 data->sm_version, 1189 data->iap_version); 1190 1191 dev_dbg(dev, 1192 "Elan Touchpad Extra Information:\n" 1193 " Max ABS X,Y: %d,%d\n" 1194 " Width X,Y: %d,%d\n" 1195 " Resolution X,Y: %d,%d (dots/mm)\n" 1196 " ic type: 0x%x\n" 1197 " info pattern: 0x%x\n", 1198 data->max_x, data->max_y, 1199 data->width_x, data->width_y, 1200 data->x_res, data->y_res, 1201 data->ic_type, data->pattern); 1202 1203 /* Set up input device properties based on queried parameters. */ 1204 error = elan_setup_input_device(data); 1205 if (error) 1206 return error; 1207 1208 if (device_property_read_bool(&client->dev, "elan,trackpoint")) { 1209 error = elan_setup_trackpoint_input_device(data); 1210 if (error) 1211 return error; 1212 } 1213 1214 /* 1215 * Platform code (ACPI, DTS) should normally set up interrupt 1216 * for us, but in case it did not let's fall back to using falling 1217 * edge to be compatible with older Chromebooks. 1218 */ 1219 irqflags = irq_get_trigger_type(client->irq); 1220 if (!irqflags) 1221 irqflags = IRQF_TRIGGER_FALLING; 1222 1223 error = devm_request_threaded_irq(dev, client->irq, NULL, elan_isr, 1224 irqflags | IRQF_ONESHOT, 1225 client->name, data); 1226 if (error) { 1227 dev_err(dev, "cannot register irq=%d\n", client->irq); 1228 return error; 1229 } 1230 1231 error = sysfs_create_groups(&dev->kobj, elan_sysfs_groups); 1232 if (error) { 1233 dev_err(dev, "failed to create sysfs attributes: %d\n", error); 1234 return error; 1235 } 1236 1237 error = devm_add_action(dev, elan_remove_sysfs_groups, data); 1238 if (error) { 1239 elan_remove_sysfs_groups(data); 1240 dev_err(dev, "Failed to add sysfs cleanup action: %d\n", 1241 error); 1242 return error; 1243 } 1244 1245 error = input_register_device(data->input); 1246 if (error) { 1247 dev_err(dev, "failed to register input device: %d\n", error); 1248 return error; 1249 } 1250 1251 if (data->tp_input) { 1252 error = input_register_device(data->tp_input); 1253 if (error) { 1254 dev_err(&client->dev, 1255 "failed to register TrackPoint input device: %d\n", 1256 error); 1257 return error; 1258 } 1259 } 1260 1261 /* 1262 * Systems using device tree should set up wakeup via DTS, 1263 * the rest will configure device as wakeup source by default. 1264 */ 1265 if (!dev->of_node) 1266 device_init_wakeup(dev, true); 1267 1268 return 0; 1269 } 1270 1271 static int __maybe_unused elan_suspend(struct device *dev) 1272 { 1273 struct i2c_client *client = to_i2c_client(dev); 1274 struct elan_tp_data *data = i2c_get_clientdata(client); 1275 int ret; 1276 1277 /* 1278 * We are taking the mutex to make sure sysfs operations are 1279 * complete before we attempt to bring the device into low[er] 1280 * power mode. 1281 */ 1282 ret = mutex_lock_interruptible(&data->sysfs_mutex); 1283 if (ret) 1284 return ret; 1285 1286 disable_irq(client->irq); 1287 1288 if (device_may_wakeup(dev)) { 1289 ret = elan_sleep(data); 1290 /* Enable wake from IRQ */ 1291 data->irq_wake = (enable_irq_wake(client->irq) == 0); 1292 } else { 1293 ret = elan_disable_power(data); 1294 } 1295 1296 mutex_unlock(&data->sysfs_mutex); 1297 return ret; 1298 } 1299 1300 static int __maybe_unused elan_resume(struct device *dev) 1301 { 1302 struct i2c_client *client = to_i2c_client(dev); 1303 struct elan_tp_data *data = i2c_get_clientdata(client); 1304 int error; 1305 1306 if (device_may_wakeup(dev) && data->irq_wake) { 1307 disable_irq_wake(client->irq); 1308 data->irq_wake = false; 1309 } 1310 1311 error = elan_enable_power(data); 1312 if (error) { 1313 dev_err(dev, "power up when resuming failed: %d\n", error); 1314 goto err; 1315 } 1316 1317 error = elan_initialize(data); 1318 if (error) 1319 dev_err(dev, "initialize when resuming failed: %d\n", error); 1320 1321 err: 1322 enable_irq(data->client->irq); 1323 return error; 1324 } 1325 1326 static SIMPLE_DEV_PM_OPS(elan_pm_ops, elan_suspend, elan_resume); 1327 1328 static const struct i2c_device_id elan_id[] = { 1329 { DRIVER_NAME, 0 }, 1330 { }, 1331 }; 1332 MODULE_DEVICE_TABLE(i2c, elan_id); 1333 1334 #ifdef CONFIG_ACPI 1335 static const struct acpi_device_id elan_acpi_id[] = { 1336 { "ELAN0000", 0 }, 1337 { "ELAN0100", 0 }, 1338 { "ELAN0600", 0 }, 1339 { "ELAN0601", 0 }, 1340 { "ELAN0602", 0 }, 1341 { "ELAN0603", 0 }, 1342 { "ELAN0604", 0 }, 1343 { "ELAN0605", 0 }, 1344 { "ELAN0606", 0 }, 1345 { "ELAN0607", 0 }, 1346 { "ELAN0608", 0 }, 1347 { "ELAN0609", 0 }, 1348 { "ELAN060B", 0 }, 1349 { "ELAN060C", 0 }, 1350 { "ELAN060F", 0 }, 1351 { "ELAN0610", 0 }, 1352 { "ELAN0611", 0 }, 1353 { "ELAN0612", 0 }, 1354 { "ELAN0615", 0 }, 1355 { "ELAN0616", 0 }, 1356 { "ELAN0617", 0 }, 1357 { "ELAN0618", 0 }, 1358 { "ELAN0619", 0 }, 1359 { "ELAN061A", 0 }, 1360 { "ELAN061B", 0 }, 1361 { "ELAN061C", 0 }, 1362 { "ELAN061D", 0 }, 1363 { "ELAN061E", 0 }, 1364 { "ELAN061F", 0 }, 1365 { "ELAN0620", 0 }, 1366 { "ELAN0621", 0 }, 1367 { "ELAN0622", 0 }, 1368 { "ELAN0623", 0 }, 1369 { "ELAN0624", 0 }, 1370 { "ELAN0625", 0 }, 1371 { "ELAN0626", 0 }, 1372 { "ELAN0627", 0 }, 1373 { "ELAN0628", 0 }, 1374 { "ELAN0629", 0 }, 1375 { "ELAN062A", 0 }, 1376 { "ELAN062B", 0 }, 1377 { "ELAN062C", 0 }, 1378 { "ELAN062D", 0 }, 1379 { "ELAN0631", 0 }, 1380 { "ELAN0632", 0 }, 1381 { "ELAN1000", 0 }, 1382 { } 1383 }; 1384 MODULE_DEVICE_TABLE(acpi, elan_acpi_id); 1385 #endif 1386 1387 #ifdef CONFIG_OF 1388 static const struct of_device_id elan_of_match[] = { 1389 { .compatible = "elan,ekth3000" }, 1390 { /* sentinel */ } 1391 }; 1392 MODULE_DEVICE_TABLE(of, elan_of_match); 1393 #endif 1394 1395 static struct i2c_driver elan_driver = { 1396 .driver = { 1397 .name = DRIVER_NAME, 1398 .pm = &elan_pm_ops, 1399 .acpi_match_table = ACPI_PTR(elan_acpi_id), 1400 .of_match_table = of_match_ptr(elan_of_match), 1401 .probe_type = PROBE_PREFER_ASYNCHRONOUS, 1402 }, 1403 .probe = elan_probe, 1404 .id_table = elan_id, 1405 }; 1406 1407 module_i2c_driver(elan_driver); 1408 1409 MODULE_AUTHOR("Duson Lin <dusonlin@emc.com.tw>"); 1410 MODULE_DESCRIPTION("Elan I2C/SMBus Touchpad driver"); 1411 MODULE_LICENSE("GPL"); 1412