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