drivers/input/mouse/elan_i2c_core.c

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