drivers/input/mouse/elantech.c

   1 /*
   2  * Elantech Touchpad driver (v6)
   3  *
   4  * Copyright (C) 2007-2009 Arjan Opmeer <arjan@opmeer.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 as published
   8  * by the Free Software Foundation.
   9  *
  10  * Trademarks are the property of their respective owners.
  11  */
  12
  13 #include <linux/delay.h>
  14 #include <linux/dmi.h>
  15 #include <linux/slab.h>
  16 #include <linux/module.h>
  17 #include <linux/i2c.h>
  18 #include <linux/input.h>
  19 #include <linux/input/mt.h>
  20 #include <linux/platform_device.h>
  21 #include <linux/serio.h>
  22 #include <linux/libps2.h>
  23 #include <asm/unaligned.h>
  24 #include "psmouse.h"
  25 #include "elantech.h"
  26 #include "elan_i2c.h"
  27
  28 #define elantech_debug(fmt, ...)                                        \
  29         do {                                                            \
  30                 if (etd->info.debug)                                    \
  31                         psmouse_printk(KERN_DEBUG, psmouse,             \
  32                                         fmt, ##__VA_ARGS__);            \
  33         } while (0)
  34
  35 /*
  36  * Send a Synaptics style sliced query command
  37  */
  38 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c,
  39                                 unsigned char *param)
  40 {
  41         if (ps2_sliced_command(&psmouse->ps2dev, c) ||
  42             ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
  43                 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
  44                 return -1;
  45         }
  46
  47         return 0;
  48 }
  49
  50 /*
  51  * V3 and later support this fast command
  52  */
  53 static int elantech_send_cmd(struct psmouse *psmouse, unsigned char c,
  54                                 unsigned char *param)
  55 {
  56         struct ps2dev *ps2dev = &psmouse->ps2dev;
  57
  58         if (ps2_command(ps2dev, NULL, ETP_PS2_CUSTOM_COMMAND) ||
  59             ps2_command(ps2dev, NULL, c) ||
  60             ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
  61                 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
  62                 return -1;
  63         }
  64
  65         return 0;
  66 }
  67
  68 /*
  69  * A retrying version of ps2_command
  70  */
  71 static int elantech_ps2_command(struct psmouse *psmouse,
  72                                 unsigned char *param, int command)
  73 {
  74         struct ps2dev *ps2dev = &psmouse->ps2dev;
  75         struct elantech_data *etd = psmouse->private;
  76         int rc;
  77         int tries = ETP_PS2_COMMAND_TRIES;
  78
  79         do {
  80                 rc = ps2_command(ps2dev, param, command);
  81                 if (rc == 0)
  82                         break;
  83                 tries--;
  84                 elantech_debug("retrying ps2 command 0x%02x (%d).\n",
  85                                 command, tries);
  86                 msleep(ETP_PS2_COMMAND_DELAY);
  87         } while (tries > 0);
  88
  89         if (rc)
  90                 psmouse_err(psmouse, "ps2 command 0x%02x failed.\n", command);
  91
  92         return rc;
  93 }
  94
  95 /*
  96  * Send an Elantech style special command to read a value from a register
  97  */
  98 static int elantech_read_reg(struct psmouse *psmouse, unsigned char reg,
  99                                 unsigned char *val)
 100 {
 101         struct elantech_data *etd = psmouse->private;
 102         unsigned char param[3];
 103         int rc = 0;
 104
 105         if (reg < 0x07 || reg > 0x26)
 106                 return -1;
 107
 108         if (reg > 0x11 && reg < 0x20)
 109                 return -1;
 110
 111         switch (etd->info.hw_version) {
 112         case 1:
 113                 if (ps2_sliced_command(&psmouse->ps2dev, ETP_REGISTER_READ) ||
 114                     ps2_sliced_command(&psmouse->ps2dev, reg) ||
 115                     ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
 116                         rc = -1;
 117                 }
 118                 break;
 119
 120         case 2:
 121                 if (elantech_ps2_command(psmouse,  NULL, ETP_PS2_CUSTOM_COMMAND) ||
 122                     elantech_ps2_command(psmouse,  NULL, ETP_REGISTER_READ) ||
 123                     elantech_ps2_command(psmouse,  NULL, ETP_PS2_CUSTOM_COMMAND) ||
 124                     elantech_ps2_command(psmouse,  NULL, reg) ||
 125                     elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
 126                         rc = -1;
 127                 }
 128                 break;
 129
 130         case 3 ... 4:
 131                 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 132                     elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
 133                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 134                     elantech_ps2_command(psmouse, NULL, reg) ||
 135                     elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
 136                         rc = -1;
 137                 }
 138                 break;
 139         }
 140
 141         if (rc)
 142                 psmouse_err(psmouse, "failed to read register 0x%02x.\n", reg);
 143         else if (etd->info.hw_version != 4)
 144                 *val = param[0];
 145         else
 146                 *val = param[1];
 147
 148         return rc;
 149 }
 150
 151 /*
 152  * Send an Elantech style special command to write a register with a value
 153  */
 154 static int elantech_write_reg(struct psmouse *psmouse, unsigned char reg,
 155                                 unsigned char val)
 156 {
 157         struct elantech_data *etd = psmouse->private;
 158         int rc = 0;
 159
 160         if (reg < 0x07 || reg > 0x26)
 161                 return -1;
 162
 163         if (reg > 0x11 && reg < 0x20)
 164                 return -1;
 165
 166         switch (etd->info.hw_version) {
 167         case 1:
 168                 if (ps2_sliced_command(&psmouse->ps2dev, ETP_REGISTER_WRITE) ||
 169                     ps2_sliced_command(&psmouse->ps2dev, reg) ||
 170                     ps2_sliced_command(&psmouse->ps2dev, val) ||
 171                     ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11)) {
 172                         rc = -1;
 173                 }
 174                 break;
 175
 176         case 2:
 177                 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 178                     elantech_ps2_command(psmouse, NULL, ETP_REGISTER_WRITE) ||
 179                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 180                     elantech_ps2_command(psmouse, NULL, reg) ||
 181                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 182                     elantech_ps2_command(psmouse, NULL, val) ||
 183                     elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
 184                         rc = -1;
 185                 }
 186                 break;
 187
 188         case 3:
 189                 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 190                     elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
 191                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 192                     elantech_ps2_command(psmouse, NULL, reg) ||
 193                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 194                     elantech_ps2_command(psmouse, NULL, val) ||
 195                     elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
 196                         rc = -1;
 197                 }
 198                 break;
 199
 200         case 4:
 201                 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 202                     elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
 203                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 204                     elantech_ps2_command(psmouse, NULL, reg) ||
 205                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 206                     elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
 207                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 208                     elantech_ps2_command(psmouse, NULL, val) ||
 209                     elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
 210                         rc = -1;
 211                 }
 212                 break;
 213         }
 214
 215         if (rc)
 216                 psmouse_err(psmouse,
 217                             "failed to write register 0x%02x with value 0x%02x.\n",
 218                             reg, val);
 219
 220         return rc;
 221 }
 222
 223 /*
 224  * Dump a complete mouse movement packet to the syslog
 225  */
 226 static void elantech_packet_dump(struct psmouse *psmouse)
 227 {
 228         psmouse_printk(KERN_DEBUG, psmouse, "PS/2 packet [%*ph]\n",
 229                        psmouse->pktsize, psmouse->packet);
 230 }
 231
 232 /*
 233  * Interpret complete data packets and report absolute mode input events for
 234  * hardware version 1. (4 byte packets)
 235  */
 236 static void elantech_report_absolute_v1(struct psmouse *psmouse)
 237 {
 238         struct input_dev *dev = psmouse->dev;
 239         struct elantech_data *etd = psmouse->private;
 240         unsigned char *packet = psmouse->packet;
 241         int fingers;
 242
 243         if (etd->info.fw_version < 0x020000) {
 244                 /*
 245                  * byte 0:  D   U  p1  p2   1  p3   R   L
 246                  * byte 1:  f   0  th  tw  x9  x8  y9  y8
 247                  */
 248                 fingers = ((packet[1] & 0x80) >> 7) +
 249                                 ((packet[1] & 0x30) >> 4);
 250         } else {
 251                 /*
 252                  * byte 0: n1  n0  p2  p1   1  p3   R   L
 253                  * byte 1:  0   0   0   0  x9  x8  y9  y8
 254                  */
 255                 fingers = (packet[0] & 0xc0) >> 6;
 256         }
 257
 258         if (etd->info.jumpy_cursor) {
 259                 if (fingers != 1) {
 260                         etd->single_finger_reports = 0;
 261                 } else if (etd->single_finger_reports < 2) {
 262                         /* Discard first 2 reports of one finger, bogus */
 263                         etd->single_finger_reports++;
 264                         elantech_debug("discarding packet\n");
 265                         return;
 266                 }
 267         }
 268
 269         input_report_key(dev, BTN_TOUCH, fingers != 0);
 270
 271         /*
 272          * byte 2: x7  x6  x5  x4  x3  x2  x1  x0
 273          * byte 3: y7  y6  y5  y4  y3  y2  y1  y0
 274          */
 275         if (fingers) {
 276                 input_report_abs(dev, ABS_X,
 277                         ((packet[1] & 0x0c) << 6) | packet[2]);
 278                 input_report_abs(dev, ABS_Y,
 279                         etd->y_max - (((packet[1] & 0x03) << 8) | packet[3]));
 280         }
 281
 282         input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
 283         input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
 284         input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
 285
 286         psmouse_report_standard_buttons(dev, packet[0]);
 287
 288         if (etd->info.fw_version < 0x020000 &&
 289             (etd->info.capabilities[0] & ETP_CAP_HAS_ROCKER)) {
 290                 /* rocker up */
 291                 input_report_key(dev, BTN_FORWARD, packet[0] & 0x40);
 292                 /* rocker down */
 293                 input_report_key(dev, BTN_BACK, packet[0] & 0x80);
 294         }
 295
 296         input_sync(dev);
 297 }
 298
 299 static void elantech_set_slot(struct input_dev *dev, int slot, bool active,
 300                               unsigned int x, unsigned int y)
 301 {
 302         input_mt_slot(dev, slot);
 303         input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
 304         if (active) {
 305                 input_report_abs(dev, ABS_MT_POSITION_X, x);
 306                 input_report_abs(dev, ABS_MT_POSITION_Y, y);
 307         }
 308 }
 309
 310 /* x1 < x2 and y1 < y2 when two fingers, x = y = 0 when not pressed */
 311 static void elantech_report_semi_mt_data(struct input_dev *dev,
 312                                          unsigned int num_fingers,
 313                                          unsigned int x1, unsigned int y1,
 314                                          unsigned int x2, unsigned int y2)
 315 {
 316         elantech_set_slot(dev, 0, num_fingers != 0, x1, y1);
 317         elantech_set_slot(dev, 1, num_fingers >= 2, x2, y2);
 318 }
 319
 320 /*
 321  * Interpret complete data packets and report absolute mode input events for
 322  * hardware version 2. (6 byte packets)
 323  */
 324 static void elantech_report_absolute_v2(struct psmouse *psmouse)
 325 {
 326         struct elantech_data *etd = psmouse->private;
 327         struct input_dev *dev = psmouse->dev;
 328         unsigned char *packet = psmouse->packet;
 329         unsigned int fingers, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
 330         unsigned int width = 0, pres = 0;
 331
 332         /* byte 0: n1  n0   .   .   .   .   R   L */
 333         fingers = (packet[0] & 0xc0) >> 6;
 334
 335         switch (fingers) {
 336         case 3:
 337                 /*
 338                  * Same as one finger, except report of more than 3 fingers:
 339                  * byte 3:  n4  .   w1  w0   .   .   .   .
 340                  */
 341                 if (packet[3] & 0x80)
 342                         fingers = 4;
 343                 /* fall through */
 344         case 1:
 345                 /*
 346                  * byte 1:  .   .   .   .  x11 x10 x9  x8
 347                  * byte 2: x7  x6  x5  x4  x4  x2  x1  x0
 348                  */
 349                 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
 350                 /*
 351                  * byte 4:  .   .   .   .  y11 y10 y9  y8
 352                  * byte 5: y7  y6  y5  y4  y3  y2  y1  y0
 353                  */
 354                 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
 355
 356                 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
 357                 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
 358                 break;
 359
 360         case 2:
 361                 /*
 362                  * The coordinate of each finger is reported separately
 363                  * with a lower resolution for two finger touches:
 364                  * byte 0:  .   .  ay8 ax8  .   .   .   .
 365                  * byte 1: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
 366                  */
 367                 x1 = (((packet[0] & 0x10) << 4) | packet[1]) << 2;
 368                 /* byte 2: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0 */
 369                 y1 = etd->y_max -
 370                         ((((packet[0] & 0x20) << 3) | packet[2]) << 2);
 371                 /*
 372                  * byte 3:  .   .  by8 bx8  .   .   .   .
 373                  * byte 4: bx7 bx6 bx5 bx4 bx3 bx2 bx1 bx0
 374                  */
 375                 x2 = (((packet[3] & 0x10) << 4) | packet[4]) << 2;
 376                 /* byte 5: by7 by8 by5 by4 by3 by2 by1 by0 */
 377                 y2 = etd->y_max -
 378                         ((((packet[3] & 0x20) << 3) | packet[5]) << 2);
 379
 380                 /* Unknown so just report sensible values */
 381                 pres = 127;
 382                 width = 7;
 383                 break;
 384         }
 385
 386         input_report_key(dev, BTN_TOUCH, fingers != 0);
 387         if (fingers != 0) {
 388                 input_report_abs(dev, ABS_X, x1);
 389                 input_report_abs(dev, ABS_Y, y1);
 390         }
 391         elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
 392         input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
 393         input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
 394         input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
 395         input_report_key(dev, BTN_TOOL_QUADTAP, fingers == 4);
 396         psmouse_report_standard_buttons(dev, packet[0]);
 397         if (etd->info.reports_pressure) {
 398                 input_report_abs(dev, ABS_PRESSURE, pres);
 399                 input_report_abs(dev, ABS_TOOL_WIDTH, width);
 400         }
 401
 402         input_sync(dev);
 403 }
 404
 405 static void elantech_report_trackpoint(struct psmouse *psmouse,
 406                                        int packet_type)
 407 {
 408         /*
 409          * byte 0:  0   0  sx  sy   0   M   R   L
 410          * byte 1:~sx   0   0   0   0   0   0   0
 411          * byte 2:~sy   0   0   0   0   0   0   0
 412          * byte 3:  0   0 ~sy ~sx   0   1   1   0
 413          * byte 4: x7  x6  x5  x4  x3  x2  x1  x0
 414          * byte 5: y7  y6  y5  y4  y3  y2  y1  y0
 415          *
 416          * x and y are written in two's complement spread
 417          * over 9 bits with sx/sy the relative top bit and
 418          * x7..x0 and y7..y0 the lower bits.
 419          * The sign of y is opposite to what the input driver
 420          * expects for a relative movement
 421          */
 422
 423         struct elantech_data *etd = psmouse->private;
 424         struct input_dev *tp_dev = etd->tp_dev;
 425         unsigned char *packet = psmouse->packet;
 426         int x, y;
 427         u32 t;
 428
 429         t = get_unaligned_le32(&packet[0]);
 430
 431         switch (t & ~7U) {
 432         case 0x06000030U:
 433         case 0x16008020U:
 434         case 0x26800010U:
 435         case 0x36808000U:
 436
 437                 /*
 438                  * This firmware misreport coordinates for trackpoint
 439                  * occasionally. Discard packets outside of [-127, 127] range
 440                  * to prevent cursor jumps.
 441                  */
 442                 if (packet[4] == 0x80 || packet[5] == 0x80 ||
 443                     packet[1] >> 7 == packet[4] >> 7 ||
 444                     packet[2] >> 7 == packet[5] >> 7) {
 445                         elantech_debug("discarding packet [%6ph]\n", packet);
 446                         break;
 447
 448                 }
 449                 x = packet[4] - (int)((packet[1]^0x80) << 1);
 450                 y = (int)((packet[2]^0x80) << 1) - packet[5];
 451
 452                 psmouse_report_standard_buttons(tp_dev, packet[0]);
 453
 454                 input_report_rel(tp_dev, REL_X, x);
 455                 input_report_rel(tp_dev, REL_Y, y);
 456
 457                 input_sync(tp_dev);
 458
 459                 break;
 460
 461         default:
 462                 /* Dump unexpected packet sequences if debug=1 (default) */
 463                 if (etd->info.debug == 1)
 464                         elantech_packet_dump(psmouse);
 465
 466                 break;
 467         }
 468 }
 469
 470 /*
 471  * Interpret complete data packets and report absolute mode input events for
 472  * hardware version 3. (12 byte packets for two fingers)
 473  */
 474 static void elantech_report_absolute_v3(struct psmouse *psmouse,
 475                                         int packet_type)
 476 {
 477         struct input_dev *dev = psmouse->dev;
 478         struct elantech_data *etd = psmouse->private;
 479         unsigned char *packet = psmouse->packet;
 480         unsigned int fingers = 0, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
 481         unsigned int width = 0, pres = 0;
 482
 483         /* byte 0: n1  n0   .   .   .   .   R   L */
 484         fingers = (packet[0] & 0xc0) >> 6;
 485
 486         switch (fingers) {
 487         case 3:
 488         case 1:
 489                 /*
 490                  * byte 1:  .   .   .   .  x11 x10 x9  x8
 491                  * byte 2: x7  x6  x5  x4  x4  x2  x1  x0
 492                  */
 493                 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
 494                 /*
 495                  * byte 4:  .   .   .   .  y11 y10 y9  y8
 496                  * byte 5: y7  y6  y5  y4  y3  y2  y1  y0
 497                  */
 498                 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
 499                 break;
 500
 501         case 2:
 502                 if (packet_type == PACKET_V3_HEAD) {
 503                         /*
 504                          * byte 1:   .    .    .    .  ax11 ax10 ax9  ax8
 505                          * byte 2: ax7  ax6  ax5  ax4  ax3  ax2  ax1  ax0
 506                          */
 507                         etd->mt[0].x = ((packet[1] & 0x0f) << 8) | packet[2];
 508                         /*
 509                          * byte 4:   .    .    .    .  ay11 ay10 ay9  ay8
 510                          * byte 5: ay7  ay6  ay5  ay4  ay3  ay2  ay1  ay0
 511                          */
 512                         etd->mt[0].y = etd->y_max -
 513                                 (((packet[4] & 0x0f) << 8) | packet[5]);
 514                         /*
 515                          * wait for next packet
 516                          */
 517                         return;
 518                 }
 519
 520                 /* packet_type == PACKET_V3_TAIL */
 521                 x1 = etd->mt[0].x;
 522                 y1 = etd->mt[0].y;
 523                 x2 = ((packet[1] & 0x0f) << 8) | packet[2];
 524                 y2 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
 525                 break;
 526         }
 527
 528         pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
 529         width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
 530
 531         input_report_key(dev, BTN_TOUCH, fingers != 0);
 532         if (fingers != 0) {
 533                 input_report_abs(dev, ABS_X, x1);
 534                 input_report_abs(dev, ABS_Y, y1);
 535         }
 536         elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
 537         input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
 538         input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
 539         input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
 540
 541         /* For clickpads map both buttons to BTN_LEFT */
 542         if (etd->info.fw_version & 0x001000)
 543                 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
 544         else
 545                 psmouse_report_standard_buttons(dev, packet[0]);
 546
 547         input_report_abs(dev, ABS_PRESSURE, pres);
 548         input_report_abs(dev, ABS_TOOL_WIDTH, width);
 549
 550         input_sync(dev);
 551 }
 552
 553 static void elantech_input_sync_v4(struct psmouse *psmouse)
 554 {
 555         struct input_dev *dev = psmouse->dev;
 556         struct elantech_data *etd = psmouse->private;
 557         unsigned char *packet = psmouse->packet;
 558
 559         /* For clickpads map both buttons to BTN_LEFT */
 560         if (etd->info.fw_version & 0x001000)
 561                 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
 562         else
 563                 psmouse_report_standard_buttons(dev, packet[0]);
 564
 565         input_mt_report_pointer_emulation(dev, true);
 566         input_sync(dev);
 567 }
 568
 569 static void process_packet_status_v4(struct psmouse *psmouse)
 570 {
 571         struct input_dev *dev = psmouse->dev;
 572         unsigned char *packet = psmouse->packet;
 573         unsigned fingers;
 574         int i;
 575
 576         /* notify finger state change */
 577         fingers = packet[1] & 0x1f;
 578         for (i = 0; i < ETP_MAX_FINGERS; i++) {
 579                 if ((fingers & (1 << i)) == 0) {
 580                         input_mt_slot(dev, i);
 581                         input_mt_report_slot_state(dev, MT_TOOL_FINGER, false);
 582                 }
 583         }
 584
 585         elantech_input_sync_v4(psmouse);
 586 }
 587
 588 static void process_packet_head_v4(struct psmouse *psmouse)
 589 {
 590         struct input_dev *dev = psmouse->dev;
 591         struct elantech_data *etd = psmouse->private;
 592         unsigned char *packet = psmouse->packet;
 593         int id;
 594         int pres, traces;
 595
 596         id = ((packet[3] & 0xe0) >> 5) - 1;
 597         if (id < 0 || id >= ETP_MAX_FINGERS)
 598                 return;
 599
 600         etd->mt[id].x = ((packet[1] & 0x0f) << 8) | packet[2];
 601         etd->mt[id].y = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
 602         pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
 603         traces = (packet[0] & 0xf0) >> 4;
 604
 605         input_mt_slot(dev, id);
 606         input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
 607
 608         input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
 609         input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
 610         input_report_abs(dev, ABS_MT_PRESSURE, pres);
 611         input_report_abs(dev, ABS_MT_TOUCH_MAJOR, traces * etd->width);
 612         /* report this for backwards compatibility */
 613         input_report_abs(dev, ABS_TOOL_WIDTH, traces);
 614
 615         elantech_input_sync_v4(psmouse);
 616 }
 617
 618 static void process_packet_motion_v4(struct psmouse *psmouse)
 619 {
 620         struct input_dev *dev = psmouse->dev;
 621         struct elantech_data *etd = psmouse->private;
 622         unsigned char *packet = psmouse->packet;
 623         int weight, delta_x1 = 0, delta_y1 = 0, delta_x2 = 0, delta_y2 = 0;
 624         int id, sid;
 625
 626         id = ((packet[0] & 0xe0) >> 5) - 1;
 627         if (id < 0 || id >= ETP_MAX_FINGERS)
 628                 return;
 629
 630         sid = ((packet[3] & 0xe0) >> 5) - 1;
 631         weight = (packet[0] & 0x10) ? ETP_WEIGHT_VALUE : 1;
 632         /*
 633          * Motion packets give us the delta of x, y values of specific fingers,
 634          * but in two's complement. Let the compiler do the conversion for us.
 635          * Also _enlarge_ the numbers to int, in case of overflow.
 636          */
 637         delta_x1 = (signed char)packet[1];
 638         delta_y1 = (signed char)packet[2];
 639         delta_x2 = (signed char)packet[4];
 640         delta_y2 = (signed char)packet[5];
 641
 642         etd->mt[id].x += delta_x1 * weight;
 643         etd->mt[id].y -= delta_y1 * weight;
 644         input_mt_slot(dev, id);
 645         input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
 646         input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
 647
 648         if (sid >= 0 && sid < ETP_MAX_FINGERS) {
 649                 etd->mt[sid].x += delta_x2 * weight;
 650                 etd->mt[sid].y -= delta_y2 * weight;
 651                 input_mt_slot(dev, sid);
 652                 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[sid].x);
 653                 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[sid].y);
 654         }
 655
 656         elantech_input_sync_v4(psmouse);
 657 }
 658
 659 static void elantech_report_absolute_v4(struct psmouse *psmouse,
 660                                         int packet_type)
 661 {
 662         switch (packet_type) {
 663         case PACKET_V4_STATUS:
 664                 process_packet_status_v4(psmouse);
 665                 break;
 666
 667         case PACKET_V4_HEAD:
 668                 process_packet_head_v4(psmouse);
 669                 break;
 670
 671         case PACKET_V4_MOTION:
 672                 process_packet_motion_v4(psmouse);
 673                 break;
 674
 675         case PACKET_UNKNOWN:
 676         default:
 677                 /* impossible to get here */
 678                 break;
 679         }
 680 }
 681
 682 static int elantech_packet_check_v1(struct psmouse *psmouse)
 683 {
 684         struct elantech_data *etd = psmouse->private;
 685         unsigned char *packet = psmouse->packet;
 686         unsigned char p1, p2, p3;
 687
 688         /* Parity bits are placed differently */
 689         if (etd->info.fw_version < 0x020000) {
 690                 /* byte 0:  D   U  p1  p2   1  p3   R   L */
 691                 p1 = (packet[0] & 0x20) >> 5;
 692                 p2 = (packet[0] & 0x10) >> 4;
 693         } else {
 694                 /* byte 0: n1  n0  p2  p1   1  p3   R   L */
 695                 p1 = (packet[0] & 0x10) >> 4;
 696                 p2 = (packet[0] & 0x20) >> 5;
 697         }
 698
 699         p3 = (packet[0] & 0x04) >> 2;
 700
 701         return etd->parity[packet[1]] == p1 &&
 702                etd->parity[packet[2]] == p2 &&
 703                etd->parity[packet[3]] == p3;
 704 }
 705
 706 static int elantech_debounce_check_v2(struct psmouse *psmouse)
 707 {
 708         /*
 709          * When we encounter packet that matches this exactly, it means the
 710          * hardware is in debounce status. Just ignore the whole packet.
 711          */
 712         static const u8 debounce_packet[] = {
 713                 0x84, 0xff, 0xff, 0x02, 0xff, 0xff
 714         };
 715         unsigned char *packet = psmouse->packet;
 716
 717         return !memcmp(packet, debounce_packet, sizeof(debounce_packet));
 718 }
 719
 720 static int elantech_packet_check_v2(struct psmouse *psmouse)
 721 {
 722         struct elantech_data *etd = psmouse->private;
 723         unsigned char *packet = psmouse->packet;
 724
 725         /*
 726          * V2 hardware has two flavors. Older ones that do not report pressure,
 727          * and newer ones that reports pressure and width. With newer ones, all
 728          * packets (1, 2, 3 finger touch) have the same constant bits. With
 729          * older ones, 1/3 finger touch packets and 2 finger touch packets
 730          * have different constant bits.
 731          * With all three cases, if the constant bits are not exactly what I
 732          * expected, I consider them invalid.
 733          */
 734         if (etd->info.reports_pressure)
 735                 return (packet[0] & 0x0c) == 0x04 &&
 736                        (packet[3] & 0x0f) == 0x02;
 737
 738         if ((packet[0] & 0xc0) == 0x80)
 739                 return (packet[0] & 0x0c) == 0x0c &&
 740                        (packet[3] & 0x0e) == 0x08;
 741
 742         return (packet[0] & 0x3c) == 0x3c &&
 743                (packet[1] & 0xf0) == 0x00 &&
 744                (packet[3] & 0x3e) == 0x38 &&
 745                (packet[4] & 0xf0) == 0x00;
 746 }
 747
 748 /*
 749  * We check the constant bits to determine what packet type we get,
 750  * so packet checking is mandatory for v3 and later hardware.
 751  */
 752 static int elantech_packet_check_v3(struct psmouse *psmouse)
 753 {
 754         struct elantech_data *etd = psmouse->private;
 755         static const u8 debounce_packet[] = {
 756                 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff
 757         };
 758         unsigned char *packet = psmouse->packet;
 759
 760         /*
 761          * check debounce first, it has the same signature in byte 0
 762          * and byte 3 as PACKET_V3_HEAD.
 763          */
 764         if (!memcmp(packet, debounce_packet, sizeof(debounce_packet)))
 765                 return PACKET_DEBOUNCE;
 766
 767         /*
 768          * If the hardware flag 'crc_enabled' is set the packets have
 769          * different signatures.
 770          */
 771         if (etd->info.crc_enabled) {
 772                 if ((packet[3] & 0x09) == 0x08)
 773                         return PACKET_V3_HEAD;
 774
 775                 if ((packet[3] & 0x09) == 0x09)
 776                         return PACKET_V3_TAIL;
 777         } else {
 778                 if ((packet[0] & 0x0c) == 0x04 && (packet[3] & 0xcf) == 0x02)
 779                         return PACKET_V3_HEAD;
 780
 781                 if ((packet[0] & 0x0c) == 0x0c && (packet[3] & 0xce) == 0x0c)
 782                         return PACKET_V3_TAIL;
 783                 if ((packet[3] & 0x0f) == 0x06)
 784                         return PACKET_TRACKPOINT;
 785         }
 786
 787         return PACKET_UNKNOWN;
 788 }
 789
 790 static int elantech_packet_check_v4(struct psmouse *psmouse)
 791 {
 792         struct elantech_data *etd = psmouse->private;
 793         unsigned char *packet = psmouse->packet;
 794         unsigned char packet_type = packet[3] & 0x03;
 795         unsigned int ic_version;
 796         bool sanity_check;
 797
 798         if (etd->tp_dev && (packet[3] & 0x0f) == 0x06)
 799                 return PACKET_TRACKPOINT;
 800
 801         /* This represents the version of IC body. */
 802         ic_version = (etd->info.fw_version & 0x0f0000) >> 16;
 803
 804         /*
 805          * Sanity check based on the constant bits of a packet.
 806          * The constant bits change depending on the value of
 807          * the hardware flag 'crc_enabled' and the version of
 808          * the IC body, but are the same for every packet,
 809          * regardless of the type.
 810          */
 811         if (etd->info.crc_enabled)
 812                 sanity_check = ((packet[3] & 0x08) == 0x00);
 813         else if (ic_version == 7 && etd->info.samples[1] == 0x2A)
 814                 sanity_check = ((packet[3] & 0x1c) == 0x10);
 815         else
 816                 sanity_check = ((packet[0] & 0x08) == 0x00 &&
 817                                 (packet[3] & 0x1c) == 0x10);
 818
 819         if (!sanity_check)
 820                 return PACKET_UNKNOWN;
 821
 822         switch (packet_type) {
 823         case 0:
 824                 return PACKET_V4_STATUS;
 825
 826         case 1:
 827                 return PACKET_V4_HEAD;
 828
 829         case 2:
 830                 return PACKET_V4_MOTION;
 831         }
 832
 833         return PACKET_UNKNOWN;
 834 }
 835
 836 /*
 837  * Process byte stream from mouse and handle complete packets
 838  */
 839 static psmouse_ret_t elantech_process_byte(struct psmouse *psmouse)
 840 {
 841         struct elantech_data *etd = psmouse->private;
 842         int packet_type;
 843
 844         if (psmouse->pktcnt < psmouse->pktsize)
 845                 return PSMOUSE_GOOD_DATA;
 846
 847         if (etd->info.debug > 1)
 848                 elantech_packet_dump(psmouse);
 849
 850         switch (etd->info.hw_version) {
 851         case 1:
 852                 if (etd->info.paritycheck && !elantech_packet_check_v1(psmouse))
 853                         return PSMOUSE_BAD_DATA;
 854
 855                 elantech_report_absolute_v1(psmouse);
 856                 break;
 857
 858         case 2:
 859                 /* ignore debounce */
 860                 if (elantech_debounce_check_v2(psmouse))
 861                         return PSMOUSE_FULL_PACKET;
 862
 863                 if (etd->info.paritycheck && !elantech_packet_check_v2(psmouse))
 864                         return PSMOUSE_BAD_DATA;
 865
 866                 elantech_report_absolute_v2(psmouse);
 867                 break;
 868
 869         case 3:
 870                 packet_type = elantech_packet_check_v3(psmouse);
 871                 switch (packet_type) {
 872                 case PACKET_UNKNOWN:
 873                         return PSMOUSE_BAD_DATA;
 874
 875                 case PACKET_DEBOUNCE:
 876                         /* ignore debounce */
 877                         break;
 878
 879                 case PACKET_TRACKPOINT:
 880                         elantech_report_trackpoint(psmouse, packet_type);
 881                         break;
 882
 883                 default:
 884                         elantech_report_absolute_v3(psmouse, packet_type);
 885                         break;
 886                 }
 887
 888                 break;
 889
 890         case 4:
 891                 packet_type = elantech_packet_check_v4(psmouse);
 892                 switch (packet_type) {
 893                 case PACKET_UNKNOWN:
 894                         return PSMOUSE_BAD_DATA;
 895
 896                 case PACKET_TRACKPOINT:
 897                         elantech_report_trackpoint(psmouse, packet_type);
 898                         break;
 899
 900                 default:
 901                         elantech_report_absolute_v4(psmouse, packet_type);
 902                         break;
 903                 }
 904
 905                 break;
 906         }
 907
 908         return PSMOUSE_FULL_PACKET;
 909 }
 910
 911 /*
 912  * This writes the reg_07 value again to the hardware at the end of every
 913  * set_rate call because the register loses its value. reg_07 allows setting
 914  * absolute mode on v4 hardware
 915  */
 916 static void elantech_set_rate_restore_reg_07(struct psmouse *psmouse,
 917                 unsigned int rate)
 918 {
 919         struct elantech_data *etd = psmouse->private;
 920
 921         etd->original_set_rate(psmouse, rate);
 922         if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
 923                 psmouse_err(psmouse, "restoring reg_07 failed\n");
 924 }
 925
 926 /*
 927  * Put the touchpad into absolute mode
 928  */
 929 static int elantech_set_absolute_mode(struct psmouse *psmouse)
 930 {
 931         struct elantech_data *etd = psmouse->private;
 932         unsigned char val;
 933         int tries = ETP_READ_BACK_TRIES;
 934         int rc = 0;
 935
 936         switch (etd->info.hw_version) {
 937         case 1:
 938                 etd->reg_10 = 0x16;
 939                 etd->reg_11 = 0x8f;
 940                 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
 941                     elantech_write_reg(psmouse, 0x11, etd->reg_11)) {
 942                         rc = -1;
 943                 }
 944                 break;
 945
 946         case 2:
 947                                         /* Windows driver values */
 948                 etd->reg_10 = 0x54;
 949                 etd->reg_11 = 0x88;     /* 0x8a */
 950                 etd->reg_21 = 0x60;     /* 0x00 */
 951                 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
 952                     elantech_write_reg(psmouse, 0x11, etd->reg_11) ||
 953                     elantech_write_reg(psmouse, 0x21, etd->reg_21)) {
 954                         rc = -1;
 955                 }
 956                 break;
 957
 958         case 3:
 959                 if (etd->info.set_hw_resolution)
 960                         etd->reg_10 = 0x0b;
 961                 else
 962                         etd->reg_10 = 0x01;
 963
 964                 if (elantech_write_reg(psmouse, 0x10, etd->reg_10))
 965                         rc = -1;
 966
 967                 break;
 968
 969         case 4:
 970                 etd->reg_07 = 0x01;
 971                 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
 972                         rc = -1;
 973
 974                 goto skip_readback_reg_10; /* v4 has no reg 0x10 to read */
 975         }
 976
 977         if (rc == 0) {
 978                 /*
 979                  * Read back reg 0x10. For hardware version 1 we must make
 980                  * sure the absolute mode bit is set. For hardware version 2
 981                  * the touchpad is probably initializing and not ready until
 982                  * we read back the value we just wrote.
 983                  */
 984                 do {
 985                         rc = elantech_read_reg(psmouse, 0x10, &val);
 986                         if (rc == 0)
 987                                 break;
 988                         tries--;
 989                         elantech_debug("retrying read (%d).\n", tries);
 990                         msleep(ETP_READ_BACK_DELAY);
 991                 } while (tries > 0);
 992
 993                 if (rc) {
 994                         psmouse_err(psmouse,
 995                                     "failed to read back register 0x10.\n");
 996                 } else if (etd->info.hw_version == 1 &&
 997                            !(val & ETP_R10_ABSOLUTE_MODE)) {
 998                         psmouse_err(psmouse,
 999                                     "touchpad refuses to switch to absolute mode.\n");
1000                         rc = -1;
1001                 }
1002         }
1003
1004  skip_readback_reg_10:
1005         if (rc)
1006                 psmouse_err(psmouse, "failed to initialise registers.\n");
1007
1008         return rc;
1009 }
1010
1011 static int elantech_set_range(struct psmouse *psmouse,
1012                               unsigned int *x_min, unsigned int *y_min,
1013                               unsigned int *x_max, unsigned int *y_max,
1014                               unsigned int *width)
1015 {
1016         struct elantech_data *etd = psmouse->private;
1017         struct elantech_device_info *info = &etd->info;
1018         unsigned char param[3];
1019         unsigned char traces;
1020
1021         switch (info->hw_version) {
1022         case 1:
1023                 *x_min = ETP_XMIN_V1;
1024                 *y_min = ETP_YMIN_V1;
1025                 *x_max = ETP_XMAX_V1;
1026                 *y_max = ETP_YMAX_V1;
1027                 break;
1028
1029         case 2:
1030                 if (info->fw_version == 0x020800 ||
1031                     info->fw_version == 0x020b00 ||
1032                     info->fw_version == 0x020030) {
1033                         *x_min = ETP_XMIN_V2;
1034                         *y_min = ETP_YMIN_V2;
1035                         *x_max = ETP_XMAX_V2;
1036                         *y_max = ETP_YMAX_V2;
1037                 } else {
1038                         int i;
1039                         int fixed_dpi;
1040
1041                         i = (info->fw_version > 0x020800 &&
1042                              info->fw_version < 0x020900) ? 1 : 2;
1043
1044                         if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1045                                 return -1;
1046
1047                         fixed_dpi = param[1] & 0x10;
1048
1049                         if (((info->fw_version >> 16) == 0x14) && fixed_dpi) {
1050                                 if (info->send_cmd(psmouse, ETP_SAMPLE_QUERY, param))
1051                                         return -1;
1052
1053                                 *x_max = (info->capabilities[1] - i) * param[1] / 2;
1054                                 *y_max = (info->capabilities[2] - i) * param[2] / 2;
1055                         } else if (info->fw_version == 0x040216) {
1056                                 *x_max = 819;
1057                                 *y_max = 405;
1058                         } else if (info->fw_version == 0x040219 || info->fw_version == 0x040215) {
1059                                 *x_max = 900;
1060                                 *y_max = 500;
1061                         } else {
1062                                 *x_max = (info->capabilities[1] - i) * 64;
1063                                 *y_max = (info->capabilities[2] - i) * 64;
1064                         }
1065                 }
1066                 break;
1067
1068         case 3:
1069                 if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1070                         return -1;
1071
1072                 *x_max = (0x0f & param[0]) << 8 | param[1];
1073                 *y_max = (0xf0 & param[0]) << 4 | param[2];
1074                 break;
1075
1076         case 4:
1077                 if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1078                         return -1;
1079
1080                 *x_max = (0x0f & param[0]) << 8 | param[1];
1081                 *y_max = (0xf0 & param[0]) << 4 | param[2];
1082                 traces = info->capabilities[1];
1083                 if ((traces < 2) || (traces > *x_max))
1084                         return -1;
1085
1086                 *width = *x_max / (traces - 1);
1087                 break;
1088         }
1089
1090         return 0;
1091 }
1092
1093 /*
1094  * (value from firmware) * 10 + 790 = dpi
1095  * we also have to convert dpi to dots/mm (*10/254 to avoid floating point)
1096  */
1097 static unsigned int elantech_convert_res(unsigned int val)
1098 {
1099         return (val * 10 + 790) * 10 / 254;
1100 }
1101
1102 static int elantech_get_resolution_v4(struct psmouse *psmouse,
1103                                       unsigned int *x_res,
1104                                       unsigned int *y_res,
1105                                       unsigned int *bus)
1106 {
1107         unsigned char param[3];
1108
1109         if (elantech_send_cmd(psmouse, ETP_RESOLUTION_QUERY, param))
1110                 return -1;
1111
1112         *x_res = elantech_convert_res(param[1] & 0x0f);
1113         *y_res = elantech_convert_res((param[1] & 0xf0) >> 4);
1114         *bus = param[2];
1115
1116         return 0;
1117 }
1118
1119 /*
1120  * Advertise INPUT_PROP_BUTTONPAD for clickpads. The testing of bit 12 in
1121  * fw_version for this is based on the following fw_version & caps table:
1122  *
1123  * Laptop-model:           fw_version:     caps:           buttons:
1124  * Acer S3                 0x461f00        10, 13, 0e      clickpad
1125  * Acer S7-392             0x581f01        50, 17, 0d      clickpad
1126  * Acer V5-131             0x461f02        01, 16, 0c      clickpad
1127  * Acer V5-551             0x461f00        ?               clickpad
1128  * Asus K53SV              0x450f01        78, 15, 0c      2 hw buttons
1129  * Asus G46VW              0x460f02        00, 18, 0c      2 hw buttons
1130  * Asus G750JX             0x360f00        00, 16, 0c      2 hw buttons
1131  * Asus TP500LN            0x381f17        10, 14, 0e      clickpad
1132  * Asus X750JN             0x381f17        10, 14, 0e      clickpad
1133  * Asus UX31               0x361f00        20, 15, 0e      clickpad
1134  * Asus UX32VD             0x361f02        00, 15, 0e      clickpad
1135  * Avatar AVIU-145A2       0x361f00        ?               clickpad
1136  * Fujitsu CELSIUS H760    0x570f02        40, 14, 0c      3 hw buttons (**)
1137  * Fujitsu CELSIUS H780    0x5d0f02        41, 16, 0d      3 hw buttons (**)
1138  * Fujitsu LIFEBOOK E544   0x470f00        d0, 12, 09      2 hw buttons
1139  * Fujitsu LIFEBOOK E546   0x470f00        50, 12, 09      2 hw buttons
1140  * Fujitsu LIFEBOOK E547   0x470f00        50, 12, 09      2 hw buttons
1141  * Fujitsu LIFEBOOK E554   0x570f01        40, 14, 0c      2 hw buttons
1142  * Fujitsu LIFEBOOK E557   0x570f01        40, 14, 0c      2 hw buttons
1143  * Fujitsu T725            0x470f01        05, 12, 09      2 hw buttons
1144  * Fujitsu H730            0x570f00        c0, 14, 0c      3 hw buttons (**)
1145  * Gigabyte U2442          0x450f01        58, 17, 0c      2 hw buttons
1146  * Lenovo L430             0x350f02        b9, 15, 0c      2 hw buttons (*)
1147  * Lenovo L530             0x350f02        b9, 15, 0c      2 hw buttons (*)
1148  * Samsung NF210           0x150b00        78, 14, 0a      2 hw buttons
1149  * Samsung NP770Z5E        0x575f01        10, 15, 0f      clickpad
1150  * Samsung NP700Z5B        0x361f06        21, 15, 0f      clickpad
1151  * Samsung NP900X3E-A02    0x575f03        ?               clickpad
1152  * Samsung NP-QX410        0x851b00        19, 14, 0c      clickpad
1153  * Samsung RC512           0x450f00        08, 15, 0c      2 hw buttons
1154  * Samsung RF710           0x450f00        ?               2 hw buttons
1155  * System76 Pangolin       0x250f01        ?               2 hw buttons
1156  * (*) + 3 trackpoint buttons
1157  * (**) + 0 trackpoint buttons
1158  * Note: Lenovo L430 and Lenovo L530 have the same fw_version/caps
1159  */
1160 static void elantech_set_buttonpad_prop(struct psmouse *psmouse)
1161 {
1162         struct input_dev *dev = psmouse->dev;
1163         struct elantech_data *etd = psmouse->private;
1164
1165         if (etd->info.fw_version & 0x001000) {
1166                 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1167                 __clear_bit(BTN_RIGHT, dev->keybit);
1168         }
1169 }
1170
1171 /*
1172  * Some hw_version 4 models do have a middle button
1173  */
1174 static const struct dmi_system_id elantech_dmi_has_middle_button[] = {
1175 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1176         {
1177                 /* Fujitsu H730 has a middle button */
1178                 .matches = {
1179                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1180                         DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1181                 },
1182         },
1183         {
1184                 /* Fujitsu H760 also has a middle button */
1185                 .matches = {
1186                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1187                         DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1188                 },
1189         },
1190         {
1191                 /* Fujitsu H780 also has a middle button */
1192                 .matches = {
1193                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1194                         DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H780"),
1195                 },
1196         },
1197 #endif
1198         { }
1199 };
1200
1201 static const char * const middle_button_pnp_ids[] = {
1202         "LEN2131", /* ThinkPad P52 w/ NFC */
1203         "LEN2132", /* ThinkPad P52 */
1204         "LEN2133", /* ThinkPad P72 w/ NFC */
1205         "LEN2134", /* ThinkPad P72 */
1206         "LEN0407",
1207         "LEN0408",
1208         NULL
1209 };
1210
1211 /*
1212  * Set the appropriate event bits for the input subsystem
1213  */
1214 static int elantech_set_input_params(struct psmouse *psmouse)
1215 {
1216         struct input_dev *dev = psmouse->dev;
1217         struct elantech_data *etd = psmouse->private;
1218         struct elantech_device_info *info = &etd->info;
1219         unsigned int x_min = 0, y_min = 0, x_max = 0, y_max = 0, width = 0;
1220
1221         if (elantech_set_range(psmouse, &x_min, &y_min, &x_max, &y_max, &width))
1222                 return -1;
1223
1224         __set_bit(INPUT_PROP_POINTER, dev->propbit);
1225         __set_bit(EV_KEY, dev->evbit);
1226         __set_bit(EV_ABS, dev->evbit);
1227         __clear_bit(EV_REL, dev->evbit);
1228
1229         __set_bit(BTN_LEFT, dev->keybit);
1230         if (dmi_check_system(elantech_dmi_has_middle_button) ||
1231                         psmouse_matches_pnp_id(psmouse, middle_button_pnp_ids))
1232                 __set_bit(BTN_MIDDLE, dev->keybit);
1233         __set_bit(BTN_RIGHT, dev->keybit);
1234
1235         __set_bit(BTN_TOUCH, dev->keybit);
1236         __set_bit(BTN_TOOL_FINGER, dev->keybit);
1237         __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1238         __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1239
1240         switch (info->hw_version) {
1241         case 1:
1242                 /* Rocker button */
1243                 if (info->fw_version < 0x020000 &&
1244                     (info->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
1245                         __set_bit(BTN_FORWARD, dev->keybit);
1246                         __set_bit(BTN_BACK, dev->keybit);
1247                 }
1248                 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1249                 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1250                 break;
1251
1252         case 2:
1253                 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1254                 __set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
1255                 /* fall through */
1256         case 3:
1257                 if (info->hw_version == 3)
1258                         elantech_set_buttonpad_prop(psmouse);
1259                 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1260                 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1261                 if (info->reports_pressure) {
1262                         input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1263                                              ETP_PMAX_V2, 0, 0);
1264                         input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1265                                              ETP_WMAX_V2, 0, 0);
1266                 }
1267                 input_mt_init_slots(dev, 2, INPUT_MT_SEMI_MT);
1268                 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1269                 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1270                 break;
1271
1272         case 4:
1273                 elantech_set_buttonpad_prop(psmouse);
1274                 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1275                 /* For X to recognize me as touchpad. */
1276                 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1277                 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1278                 /*
1279                  * range of pressure and width is the same as v2,
1280                  * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
1281                  */
1282                 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1283                                      ETP_PMAX_V2, 0, 0);
1284                 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1285                                      ETP_WMAX_V2, 0, 0);
1286                 /* Multitouch capable pad, up to 5 fingers. */
1287                 input_mt_init_slots(dev, ETP_MAX_FINGERS, 0);
1288                 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1289                 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1290                 input_set_abs_params(dev, ABS_MT_PRESSURE, ETP_PMIN_V2,
1291                                      ETP_PMAX_V2, 0, 0);
1292                 /*
1293                  * The firmware reports how many trace lines the finger spans,
1294                  * convert to surface unit as Protocol-B requires.
1295                  */
1296                 input_set_abs_params(dev, ABS_MT_TOUCH_MAJOR, 0,
1297                                      ETP_WMAX_V2 * width, 0, 0);
1298                 break;
1299         }
1300
1301         input_abs_set_res(dev, ABS_X, info->x_res);
1302         input_abs_set_res(dev, ABS_Y, info->y_res);
1303         if (info->hw_version > 1) {
1304                 input_abs_set_res(dev, ABS_MT_POSITION_X, info->x_res);
1305                 input_abs_set_res(dev, ABS_MT_POSITION_Y, info->y_res);
1306         }
1307
1308         etd->y_max = y_max;
1309         etd->width = width;
1310
1311         return 0;
1312 }
1313
1314 struct elantech_attr_data {
1315         size_t          field_offset;
1316         unsigned char   reg;
1317 };
1318
1319 /*
1320  * Display a register value by reading a sysfs entry
1321  */
1322 static ssize_t elantech_show_int_attr(struct psmouse *psmouse, void *data,
1323                                         char *buf)
1324 {
1325         struct elantech_data *etd = psmouse->private;
1326         struct elantech_attr_data *attr = data;
1327         unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1328         int rc = 0;
1329
1330         if (attr->reg)
1331                 rc = elantech_read_reg(psmouse, attr->reg, reg);
1332
1333         return sprintf(buf, "0x%02x\n", (attr->reg && rc) ? -1 : *reg);
1334 }
1335
1336 /*
1337  * Write a register value by writing a sysfs entry
1338  */
1339 static ssize_t elantech_set_int_attr(struct psmouse *psmouse,
1340                                      void *data, const char *buf, size_t count)
1341 {
1342         struct elantech_data *etd = psmouse->private;
1343         struct elantech_attr_data *attr = data;
1344         unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1345         unsigned char value;
1346         int err;
1347
1348         err = kstrtou8(buf, 16, &value);
1349         if (err)
1350                 return err;
1351
1352         /* Do we need to preserve some bits for version 2 hardware too? */
1353         if (etd->info.hw_version == 1) {
1354                 if (attr->reg == 0x10)
1355                         /* Force absolute mode always on */
1356                         value |= ETP_R10_ABSOLUTE_MODE;
1357                 else if (attr->reg == 0x11)
1358                         /* Force 4 byte mode always on */
1359                         value |= ETP_R11_4_BYTE_MODE;
1360         }
1361
1362         if (!attr->reg || elantech_write_reg(psmouse, attr->reg, value) == 0)
1363                 *reg = value;
1364
1365         return count;
1366 }
1367
1368 #define ELANTECH_INT_ATTR(_name, _register)                             \
1369         static struct elantech_attr_data elantech_attr_##_name = {      \
1370                 .field_offset = offsetof(struct elantech_data, _name),  \
1371                 .reg = _register,                                       \
1372         };                                                              \
1373         PSMOUSE_DEFINE_ATTR(_name, 0644,                                \
1374                             &elantech_attr_##_name,                     \
1375                             elantech_show_int_attr,                     \
1376                             elantech_set_int_attr)
1377
1378 #define ELANTECH_INFO_ATTR(_name)                                              \
1379         static struct elantech_attr_data elantech_attr_##_name = {             \
1380                 .field_offset = offsetof(struct elantech_data, info) +         \
1381                                 offsetof(struct elantech_device_info, _name),  \
1382                 .reg = 0,                                                      \
1383         };                                                                     \
1384         PSMOUSE_DEFINE_ATTR(_name, 0644,                                       \
1385                             &elantech_attr_##_name,                            \
1386                             elantech_show_int_attr,                            \
1387                             elantech_set_int_attr)
1388
1389 ELANTECH_INT_ATTR(reg_07, 0x07);
1390 ELANTECH_INT_ATTR(reg_10, 0x10);
1391 ELANTECH_INT_ATTR(reg_11, 0x11);
1392 ELANTECH_INT_ATTR(reg_20, 0x20);
1393 ELANTECH_INT_ATTR(reg_21, 0x21);
1394 ELANTECH_INT_ATTR(reg_22, 0x22);
1395 ELANTECH_INT_ATTR(reg_23, 0x23);
1396 ELANTECH_INT_ATTR(reg_24, 0x24);
1397 ELANTECH_INT_ATTR(reg_25, 0x25);
1398 ELANTECH_INT_ATTR(reg_26, 0x26);
1399 ELANTECH_INFO_ATTR(debug);
1400 ELANTECH_INFO_ATTR(paritycheck);
1401 ELANTECH_INFO_ATTR(crc_enabled);
1402
1403 static struct attribute *elantech_attrs[] = {
1404         &psmouse_attr_reg_07.dattr.attr,
1405         &psmouse_attr_reg_10.dattr.attr,
1406         &psmouse_attr_reg_11.dattr.attr,
1407         &psmouse_attr_reg_20.dattr.attr,
1408         &psmouse_attr_reg_21.dattr.attr,
1409         &psmouse_attr_reg_22.dattr.attr,
1410         &psmouse_attr_reg_23.dattr.attr,
1411         &psmouse_attr_reg_24.dattr.attr,
1412         &psmouse_attr_reg_25.dattr.attr,
1413         &psmouse_attr_reg_26.dattr.attr,
1414         &psmouse_attr_debug.dattr.attr,
1415         &psmouse_attr_paritycheck.dattr.attr,
1416         &psmouse_attr_crc_enabled.dattr.attr,
1417         NULL
1418 };
1419
1420 static const struct attribute_group elantech_attr_group = {
1421         .attrs = elantech_attrs,
1422 };
1423
1424 static bool elantech_is_signature_valid(const unsigned char *param)
1425 {
1426         static const unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10 };
1427         int i;
1428
1429         if (param[0] == 0)
1430                 return false;
1431
1432         if (param[1] == 0)
1433                 return true;
1434
1435         /*
1436          * Some hw_version >= 4 models have a revision higher then 20. Meaning
1437          * that param[2] may be 10 or 20, skip the rates check for these.
1438          */
1439         if ((param[0] & 0x0f) >= 0x06 && (param[1] & 0xaf) == 0x0f &&
1440             param[2] < 40)
1441                 return true;
1442
1443         for (i = 0; i < ARRAY_SIZE(rates); i++)
1444                 if (param[2] == rates[i])
1445                         return false;
1446
1447         return true;
1448 }
1449
1450 /*
1451  * Use magic knock to detect Elantech touchpad
1452  */
1453 int elantech_detect(struct psmouse *psmouse, bool set_properties)
1454 {
1455         struct ps2dev *ps2dev = &psmouse->ps2dev;
1456         unsigned char param[3];
1457
1458         ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
1459
1460         if (ps2_command(ps2dev,  NULL, PSMOUSE_CMD_DISABLE) ||
1461             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
1462             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
1463             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
1464             ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
1465                 psmouse_dbg(psmouse, "sending Elantech magic knock failed.\n");
1466                 return -1;
1467         }
1468
1469         /*
1470          * Report this in case there are Elantech models that use a different
1471          * set of magic numbers
1472          */
1473         if (param[0] != 0x3c || param[1] != 0x03 ||
1474             (param[2] != 0xc8 && param[2] != 0x00)) {
1475                 psmouse_dbg(psmouse,
1476                             "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1477                             param[0], param[1], param[2]);
1478                 return -1;
1479         }
1480
1481         /*
1482          * Query touchpad's firmware version and see if it reports known
1483          * value to avoid mis-detection. Logitech mice are known to respond
1484          * to Elantech magic knock and there might be more.
1485          */
1486         if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1487                 psmouse_dbg(psmouse, "failed to query firmware version.\n");
1488                 return -1;
1489         }
1490
1491         psmouse_dbg(psmouse,
1492                     "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1493                     param[0], param[1], param[2]);
1494
1495         if (!elantech_is_signature_valid(param)) {
1496                 psmouse_dbg(psmouse,
1497                             "Probably not a real Elantech touchpad. Aborting.\n");
1498                 return -1;
1499         }
1500
1501         if (set_properties) {
1502                 psmouse->vendor = "Elantech";
1503                 psmouse->name = "Touchpad";
1504         }
1505
1506         return 0;
1507 }
1508
1509 /*
1510  * Clean up sysfs entries when disconnecting
1511  */
1512 static void elantech_disconnect(struct psmouse *psmouse)
1513 {
1514         struct elantech_data *etd = psmouse->private;
1515
1516         /*
1517          * We might have left a breadcrumb when trying to
1518          * set up SMbus companion.
1519          */
1520         psmouse_smbus_cleanup(psmouse);
1521
1522         if (etd->tp_dev)
1523                 input_unregister_device(etd->tp_dev);
1524         sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1525                            &elantech_attr_group);
1526         kfree(psmouse->private);
1527         psmouse->private = NULL;
1528 }
1529
1530 /*
1531  * Put the touchpad back into absolute mode when reconnecting
1532  */
1533 static int elantech_reconnect(struct psmouse *psmouse)
1534 {
1535         psmouse_reset(psmouse);
1536
1537         if (elantech_detect(psmouse, 0))
1538                 return -1;
1539
1540         if (elantech_set_absolute_mode(psmouse)) {
1541                 psmouse_err(psmouse,
1542                             "failed to put touchpad back into absolute mode.\n");
1543                 return -1;
1544         }
1545
1546         return 0;
1547 }
1548
1549 /*
1550  * Some hw_version 4 models do not work with crc_disabled
1551  */
1552 static const struct dmi_system_id elantech_dmi_force_crc_enabled[] = {
1553 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1554         {
1555                 /* Fujitsu H730 does not work with crc_enabled == 0 */
1556                 .matches = {
1557                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1558                         DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1559                 },
1560         },
1561         {
1562                 /* Fujitsu H760 does not work with crc_enabled == 0 */
1563                 .matches = {
1564                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1565                         DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1566                 },
1567         },
1568         {
1569                 /* Fujitsu LIFEBOOK E544  does not work with crc_enabled == 0 */
1570                 .matches = {
1571                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1572                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E544"),
1573                 },
1574         },
1575         {
1576                 /* Fujitsu LIFEBOOK E546  does not work with crc_enabled == 0 */
1577                 .matches = {
1578                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1579                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E546"),
1580                 },
1581         },
1582         {
1583                 /* Fujitsu LIFEBOOK E547 does not work with crc_enabled == 0 */
1584                 .matches = {
1585                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1586                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E547"),
1587                 },
1588         },
1589         {
1590                 /* Fujitsu LIFEBOOK E554  does not work with crc_enabled == 0 */
1591                 .matches = {
1592                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1593                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E554"),
1594                 },
1595         },
1596         {
1597                 /* Fujitsu LIFEBOOK E556 does not work with crc_enabled == 0 */
1598                 .matches = {
1599                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1600                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E556"),
1601                 },
1602         },
1603         {
1604                 /* Fujitsu LIFEBOOK E557 does not work with crc_enabled == 0 */
1605                 .matches = {
1606                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1607                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E557"),
1608                 },
1609         },
1610         {
1611                 /* Fujitsu LIFEBOOK U745 does not work with crc_enabled == 0 */
1612                 .matches = {
1613                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1614                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK U745"),
1615                 },
1616         },
1617 #endif
1618         { }
1619 };
1620
1621 /*
1622  * Some hw_version 3 models go into error state when we try to set
1623  * bit 3 and/or bit 1 of r10.
1624  */
1625 static const struct dmi_system_id no_hw_res_dmi_table[] = {
1626 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1627         {
1628                 /* Gigabyte U2442 */
1629                 .matches = {
1630                         DMI_MATCH(DMI_SYS_VENDOR, "GIGABYTE"),
1631                         DMI_MATCH(DMI_PRODUCT_NAME, "U2442"),
1632                 },
1633         },
1634 #endif
1635         { }
1636 };
1637
1638 /*
1639  * determine hardware version and set some properties according to it.
1640  */
1641 static int elantech_set_properties(struct elantech_device_info *info)
1642 {
1643         /* This represents the version of IC body. */
1644         int ver = (info->fw_version & 0x0f0000) >> 16;
1645
1646         /* Early version of Elan touchpads doesn't obey the rule. */
1647         if (info->fw_version < 0x020030 || info->fw_version == 0x020600)
1648                 info->hw_version = 1;
1649         else {
1650                 switch (ver) {
1651                 case 2:
1652                 case 4:
1653                         info->hw_version = 2;
1654                         break;
1655                 case 5:
1656                         info->hw_version = 3;
1657                         break;
1658                 case 6 ... 15:
1659                         info->hw_version = 4;
1660                         break;
1661                 default:
1662                         return -1;
1663                 }
1664         }
1665
1666         /* decide which send_cmd we're gonna use early */
1667         info->send_cmd = info->hw_version >= 3 ? elantech_send_cmd :
1668                                                  synaptics_send_cmd;
1669
1670         /* Turn on packet checking by default */
1671         info->paritycheck = 1;
1672
1673         /*
1674          * This firmware suffers from misreporting coordinates when
1675          * a touch action starts causing the mouse cursor or scrolled page
1676          * to jump. Enable a workaround.
1677          */
1678         info->jumpy_cursor =
1679                 (info->fw_version == 0x020022 || info->fw_version == 0x020600);
1680
1681         if (info->hw_version > 1) {
1682                 /* For now show extra debug information */
1683                 info->debug = 1;
1684
1685                 if (info->fw_version >= 0x020800)
1686                         info->reports_pressure = true;
1687         }
1688
1689         /*
1690          * The signatures of v3 and v4 packets change depending on the
1691          * value of this hardware flag.
1692          */
1693         info->crc_enabled = (info->fw_version & 0x4000) == 0x4000 ||
1694                              dmi_check_system(elantech_dmi_force_crc_enabled);
1695
1696         /* Enable real hardware resolution on hw_version 3 ? */
1697         info->set_hw_resolution = !dmi_check_system(no_hw_res_dmi_table);
1698
1699         return 0;
1700 }
1701
1702 static int elantech_query_info(struct psmouse *psmouse,
1703                                struct elantech_device_info *info)
1704 {
1705         unsigned char param[3];
1706
1707         memset(info, 0, sizeof(*info));
1708
1709         /*
1710          * Do the version query again so we can store the result
1711          */
1712         if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1713                 psmouse_err(psmouse, "failed to query firmware version.\n");
1714                 return -EINVAL;
1715         }
1716         info->fw_version = (param[0] << 16) | (param[1] << 8) | param[2];
1717
1718         if (elantech_set_properties(info)) {
1719                 psmouse_err(psmouse, "unknown hardware version, aborting...\n");
1720                 return -EINVAL;
1721         }
1722         psmouse_info(psmouse,
1723                      "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
1724                      info->hw_version, param[0], param[1], param[2]);
1725
1726         if (info->send_cmd(psmouse, ETP_CAPABILITIES_QUERY,
1727             info->capabilities)) {
1728                 psmouse_err(psmouse, "failed to query capabilities.\n");
1729                 return -EINVAL;
1730         }
1731         psmouse_info(psmouse,
1732                      "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
1733                      info->capabilities[0], info->capabilities[1],
1734                      info->capabilities[2]);
1735
1736         if (info->hw_version != 1) {
1737                 if (info->send_cmd(psmouse, ETP_SAMPLE_QUERY, info->samples)) {
1738                         psmouse_err(psmouse, "failed to query sample data\n");
1739                         return -EINVAL;
1740                 }
1741                 psmouse_info(psmouse,
1742                              "Elan sample query result %02x, %02x, %02x\n",
1743                              info->samples[0],
1744                              info->samples[1],
1745                              info->samples[2]);
1746         }
1747
1748         if (info->samples[1] == 0x74 && info->hw_version == 0x03) {
1749                 /*
1750                  * This module has a bug which makes absolute mode
1751                  * unusable, so let's abort so we'll be using standard
1752                  * PS/2 protocol.
1753                  */
1754                 psmouse_info(psmouse,
1755                              "absolute mode broken, forcing standard PS/2 protocol\n");
1756                 return -ENODEV;
1757         }
1758
1759         /* The MSB indicates the presence of the trackpoint */
1760         info->has_trackpoint = (info->capabilities[0] & 0x80) == 0x80;
1761
1762         info->x_res = 31;
1763         info->y_res = 31;
1764         if (info->hw_version == 4) {
1765                 if (elantech_get_resolution_v4(psmouse,
1766                                                &info->x_res,
1767                                                &info->y_res,
1768                                                &info->bus)) {
1769                         psmouse_warn(psmouse,
1770                                      "failed to query resolution data.\n");
1771                 }
1772         }
1773
1774         return 0;
1775 }
1776
1777 #if defined(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)
1778
1779 /*
1780  * The newest Elantech device can use a secondary bus (over SMBus) which
1781  * provides a better bandwidth and allow a better control of the touchpads.
1782  * This is used to decide if we need to use this bus or not.
1783  */
1784 enum {
1785         ELANTECH_SMBUS_NOT_SET = -1,
1786         ELANTECH_SMBUS_OFF,
1787         ELANTECH_SMBUS_ON,
1788 };
1789
1790 static int elantech_smbus = IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) ?
1791                 ELANTECH_SMBUS_NOT_SET : ELANTECH_SMBUS_OFF;
1792 module_param_named(elantech_smbus, elantech_smbus, int, 0644);
1793 MODULE_PARM_DESC(elantech_smbus, "Use a secondary bus for the Elantech device.");
1794
1795 static const char * const i2c_blacklist_pnp_ids[] = {
1796         /*
1797          * These are known to not be working properly as bits are missing
1798          * in elan_i2c.
1799          */
1800         "LEN2131", /* ThinkPad P52 w/ NFC */
1801         "LEN2132", /* ThinkPad P52 */
1802         "LEN2133", /* ThinkPad P72 w/ NFC */
1803         "LEN2134", /* ThinkPad P72 */
1804         NULL
1805 };
1806
1807 static int elantech_create_smbus(struct psmouse *psmouse,
1808                                  struct elantech_device_info *info,
1809                                  bool leave_breadcrumbs)
1810 {
1811         const struct property_entry i2c_properties[] = {
1812                 PROPERTY_ENTRY_BOOL("elan,trackpoint"),
1813                 { },
1814         };
1815         struct i2c_board_info smbus_board = {
1816                 I2C_BOARD_INFO("elan_i2c", 0x15),
1817                 .flags = I2C_CLIENT_HOST_NOTIFY,
1818         };
1819
1820         if (info->has_trackpoint)
1821                 smbus_board.properties = i2c_properties;
1822
1823         return psmouse_smbus_init(psmouse, &smbus_board, NULL, 0, false,
1824                                   leave_breadcrumbs);
1825 }
1826
1827 /**
1828  * elantech_setup_smbus - called once the PS/2 devices are enumerated
1829  * and decides to instantiate a SMBus InterTouch device.
1830  */
1831 static int elantech_setup_smbus(struct psmouse *psmouse,
1832                                 struct elantech_device_info *info,
1833                                 bool leave_breadcrumbs)
1834 {
1835         int error;
1836
1837         if (elantech_smbus == ELANTECH_SMBUS_OFF)
1838                 return -ENXIO;
1839
1840         if (elantech_smbus == ELANTECH_SMBUS_NOT_SET) {
1841                 /*
1842                  * New ICs are enabled by default, unless mentioned in
1843                  * i2c_blacklist_pnp_ids.
1844                  * Old ICs are up to the user to decide.
1845                  */
1846                 if (!ETP_NEW_IC_SMBUS_HOST_NOTIFY(info->fw_version) ||
1847                     psmouse_matches_pnp_id(psmouse, i2c_blacklist_pnp_ids))
1848                         return -ENXIO;
1849         }
1850
1851         psmouse_info(psmouse, "Trying to set up SMBus access\n");
1852
1853         error = elantech_create_smbus(psmouse, info, leave_breadcrumbs);
1854         if (error) {
1855                 if (error == -EAGAIN)
1856                         psmouse_info(psmouse, "SMbus companion is not ready yet\n");
1857                 else
1858                         psmouse_err(psmouse, "unable to create intertouch device\n");
1859
1860                 return error;
1861         }
1862
1863         return 0;
1864 }
1865
1866 static bool elantech_use_host_notify(struct psmouse *psmouse,
1867                                      struct elantech_device_info *info)
1868 {
1869         if (ETP_NEW_IC_SMBUS_HOST_NOTIFY(info->fw_version))
1870                 return true;
1871
1872         switch (info->bus) {
1873         case ETP_BUS_PS2_ONLY:
1874                 /* expected case */
1875                 break;
1876         case ETP_BUS_SMB_ALERT_ONLY:
1877                 /* fall-through  */
1878         case ETP_BUS_PS2_SMB_ALERT:
1879                 psmouse_dbg(psmouse, "Ignoring SMBus provider through alert protocol.\n");
1880                 break;
1881         case ETP_BUS_SMB_HST_NTFY_ONLY:
1882                 /* fall-through  */
1883         case ETP_BUS_PS2_SMB_HST_NTFY:
1884                 return true;
1885         default:
1886                 psmouse_dbg(psmouse,
1887                             "Ignoring SMBus bus provider %d.\n",
1888                             info->bus);
1889         }
1890
1891         return false;
1892 }
1893
1894 int elantech_init_smbus(struct psmouse *psmouse)
1895 {
1896         struct elantech_device_info info;
1897         int error = -EINVAL;
1898
1899         psmouse_reset(psmouse);
1900
1901         error = elantech_query_info(psmouse, &info);
1902         if (error)
1903                 goto init_fail;
1904
1905         if (info.hw_version < 4) {
1906                 error = -ENXIO;
1907                 goto init_fail;
1908         }
1909
1910         return elantech_create_smbus(psmouse, &info, false);
1911  init_fail:
1912         psmouse_reset(psmouse);
1913         return error;
1914 }
1915 #endif /* CONFIG_MOUSE_PS2_ELANTECH_SMBUS */
1916
1917 /*
1918  * Initialize the touchpad and create sysfs entries
1919  */
1920 static int elantech_setup_ps2(struct psmouse *psmouse,
1921                               struct elantech_device_info *info)
1922 {
1923         struct elantech_data *etd;
1924         int i;
1925         int error = -EINVAL;
1926         struct input_dev *tp_dev;
1927
1928         psmouse->private = etd = kzalloc(sizeof(*etd), GFP_KERNEL);
1929         if (!etd)
1930                 return -ENOMEM;
1931
1932         etd->info = *info;
1933
1934         etd->parity[0] = 1;
1935         for (i = 1; i < 256; i++)
1936                 etd->parity[i] = etd->parity[i & (i - 1)] ^ 1;
1937
1938         if (elantech_set_absolute_mode(psmouse)) {
1939                 psmouse_err(psmouse,
1940                             "failed to put touchpad into absolute mode.\n");
1941                 goto init_fail;
1942         }
1943
1944         if (info->fw_version == 0x381f17) {
1945                 etd->original_set_rate = psmouse->set_rate;
1946                 psmouse->set_rate = elantech_set_rate_restore_reg_07;
1947         }
1948
1949         if (elantech_set_input_params(psmouse)) {
1950                 psmouse_err(psmouse, "failed to query touchpad range.\n");
1951                 goto init_fail;
1952         }
1953
1954         error = sysfs_create_group(&psmouse->ps2dev.serio->dev.kobj,
1955                                    &elantech_attr_group);
1956         if (error) {
1957                 psmouse_err(psmouse,
1958                             "failed to create sysfs attributes, error: %d.\n",
1959                             error);
1960                 goto init_fail;
1961         }
1962
1963         if (info->has_trackpoint) {
1964                 tp_dev = input_allocate_device();
1965
1966                 if (!tp_dev) {
1967                         error = -ENOMEM;
1968                         goto init_fail_tp_alloc;
1969                 }
1970
1971                 etd->tp_dev = tp_dev;
1972                 snprintf(etd->tp_phys, sizeof(etd->tp_phys), "%s/input1",
1973                         psmouse->ps2dev.serio->phys);
1974                 tp_dev->phys = etd->tp_phys;
1975                 tp_dev->name = "ETPS/2 Elantech TrackPoint";
1976                 tp_dev->id.bustype = BUS_I8042;
1977                 tp_dev->id.vendor  = 0x0002;
1978                 tp_dev->id.product = PSMOUSE_ELANTECH;
1979                 tp_dev->id.version = 0x0000;
1980                 tp_dev->dev.parent = &psmouse->ps2dev.serio->dev;
1981                 tp_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
1982                 tp_dev->relbit[BIT_WORD(REL_X)] =
1983                         BIT_MASK(REL_X) | BIT_MASK(REL_Y);
1984                 tp_dev->keybit[BIT_WORD(BTN_LEFT)] =
1985                         BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_MIDDLE) |
1986                         BIT_MASK(BTN_RIGHT);
1987
1988                 __set_bit(INPUT_PROP_POINTER, tp_dev->propbit);
1989                 __set_bit(INPUT_PROP_POINTING_STICK, tp_dev->propbit);
1990
1991                 error = input_register_device(etd->tp_dev);
1992                 if (error < 0)
1993                         goto init_fail_tp_reg;
1994         }
1995
1996         psmouse->protocol_handler = elantech_process_byte;
1997         psmouse->disconnect = elantech_disconnect;
1998         psmouse->reconnect = elantech_reconnect;
1999         psmouse->fast_reconnect = NULL;
2000         psmouse->pktsize = info->hw_version > 1 ? 6 : 4;
2001
2002         return 0;
2003  init_fail_tp_reg:
2004         input_free_device(tp_dev);
2005  init_fail_tp_alloc:
2006         sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
2007                            &elantech_attr_group);
2008  init_fail:
2009         kfree(etd);
2010         return error;
2011 }
2012
2013 int elantech_init_ps2(struct psmouse *psmouse)
2014 {
2015         struct elantech_device_info info;
2016         int error = -EINVAL;
2017
2018         psmouse_reset(psmouse);
2019
2020         error = elantech_query_info(psmouse, &info);
2021         if (error)
2022                 goto init_fail;
2023
2024         error = elantech_setup_ps2(psmouse, &info);
2025         if (error)
2026                 goto init_fail;
2027
2028         return 0;
2029  init_fail:
2030         psmouse_reset(psmouse);
2031         return error;
2032 }
2033
2034 int elantech_init(struct psmouse *psmouse)
2035 {
2036         struct elantech_device_info info;
2037         int error = -EINVAL;
2038
2039         psmouse_reset(psmouse);
2040
2041         error = elantech_query_info(psmouse, &info);
2042         if (error)
2043                 goto init_fail;
2044
2045 #if defined(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)
2046
2047         if (elantech_use_host_notify(psmouse, &info)) {
2048                 if (!IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) ||
2049                     !IS_ENABLED(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)) {
2050                         psmouse_warn(psmouse,
2051                                      "The touchpad can support a better bus than the too old PS/2 protocol. "
2052                                      "Make sure MOUSE_PS2_ELANTECH_SMBUS and MOUSE_ELAN_I2C_SMBUS are enabled to get a better touchpad experience.\n");
2053                 }
2054                 error = elantech_setup_smbus(psmouse, &info, true);
2055                 if (!error)
2056                         return PSMOUSE_ELANTECH_SMBUS;
2057         }
2058
2059 #endif /* CONFIG_MOUSE_PS2_ELANTECH_SMBUS */
2060
2061         error = elantech_setup_ps2(psmouse, &info);
2062         if (error < 0) {
2063                 /*
2064                  * Not using any flavor of Elantech support, so clean up
2065                  * SMbus breadcrumbs, if any.
2066                  */
2067                 psmouse_smbus_cleanup(psmouse);
2068                 goto init_fail;
2069         }
2070
2071         return PSMOUSE_ELANTECH;
2072  init_fail:
2073         psmouse_reset(psmouse);
2074         return error;
2075 }