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 = ((packet[3] & 0xe0) >> 5) - 1;
 594         int pres, traces;
 595
 596         if (id < 0)
 597                 return;
 598
 599         etd->mt[id].x = ((packet[1] & 0x0f) << 8) | packet[2];
 600         etd->mt[id].y = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
 601         pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
 602         traces = (packet[0] & 0xf0) >> 4;
 603
 604         input_mt_slot(dev, id);
 605         input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
 606
 607         input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
 608         input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
 609         input_report_abs(dev, ABS_MT_PRESSURE, pres);
 610         input_report_abs(dev, ABS_MT_TOUCH_MAJOR, traces * etd->width);
 611         /* report this for backwards compatibility */
 612         input_report_abs(dev, ABS_TOOL_WIDTH, traces);
 613
 614         elantech_input_sync_v4(psmouse);
 615 }
 616
 617 static void process_packet_motion_v4(struct psmouse *psmouse)
 618 {
 619         struct input_dev *dev = psmouse->dev;
 620         struct elantech_data *etd = psmouse->private;
 621         unsigned char *packet = psmouse->packet;
 622         int weight, delta_x1 = 0, delta_y1 = 0, delta_x2 = 0, delta_y2 = 0;
 623         int id, sid;
 624
 625         id = ((packet[0] & 0xe0) >> 5) - 1;
 626         if (id < 0)
 627                 return;
 628
 629         sid = ((packet[3] & 0xe0) >> 5) - 1;
 630         weight = (packet[0] & 0x10) ? ETP_WEIGHT_VALUE : 1;
 631         /*
 632          * Motion packets give us the delta of x, y values of specific fingers,
 633          * but in two's complement. Let the compiler do the conversion for us.
 634          * Also _enlarge_ the numbers to int, in case of overflow.
 635          */
 636         delta_x1 = (signed char)packet[1];
 637         delta_y1 = (signed char)packet[2];
 638         delta_x2 = (signed char)packet[4];
 639         delta_y2 = (signed char)packet[5];
 640
 641         etd->mt[id].x += delta_x1 * weight;
 642         etd->mt[id].y -= delta_y1 * weight;
 643         input_mt_slot(dev, id);
 644         input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
 645         input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
 646
 647         if (sid >= 0) {
 648                 etd->mt[sid].x += delta_x2 * weight;
 649                 etd->mt[sid].y -= delta_y2 * weight;
 650                 input_mt_slot(dev, sid);
 651                 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[sid].x);
 652                 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[sid].y);
 653         }
 654
 655         elantech_input_sync_v4(psmouse);
 656 }
 657
 658 static void elantech_report_absolute_v4(struct psmouse *psmouse,
 659                                         int packet_type)
 660 {
 661         switch (packet_type) {
 662         case PACKET_V4_STATUS:
 663                 process_packet_status_v4(psmouse);
 664                 break;
 665
 666         case PACKET_V4_HEAD:
 667                 process_packet_head_v4(psmouse);
 668                 break;
 669
 670         case PACKET_V4_MOTION:
 671                 process_packet_motion_v4(psmouse);
 672                 break;
 673
 674         case PACKET_UNKNOWN:
 675         default:
 676                 /* impossible to get here */
 677                 break;
 678         }
 679 }
 680
 681 static int elantech_packet_check_v1(struct psmouse *psmouse)
 682 {
 683         struct elantech_data *etd = psmouse->private;
 684         unsigned char *packet = psmouse->packet;
 685         unsigned char p1, p2, p3;
 686
 687         /* Parity bits are placed differently */
 688         if (etd->info.fw_version < 0x020000) {
 689                 /* byte 0:  D   U  p1  p2   1  p3   R   L */
 690                 p1 = (packet[0] & 0x20) >> 5;
 691                 p2 = (packet[0] & 0x10) >> 4;
 692         } else {
 693                 /* byte 0: n1  n0  p2  p1   1  p3   R   L */
 694                 p1 = (packet[0] & 0x10) >> 4;
 695                 p2 = (packet[0] & 0x20) >> 5;
 696         }
 697
 698         p3 = (packet[0] & 0x04) >> 2;
 699
 700         return etd->parity[packet[1]] == p1 &&
 701                etd->parity[packet[2]] == p2 &&
 702                etd->parity[packet[3]] == p3;
 703 }
 704
 705 static int elantech_debounce_check_v2(struct psmouse *psmouse)
 706 {
 707         /*
 708          * When we encounter packet that matches this exactly, it means the
 709          * hardware is in debounce status. Just ignore the whole packet.
 710          */
 711         static const u8 debounce_packet[] = {
 712                 0x84, 0xff, 0xff, 0x02, 0xff, 0xff
 713         };
 714         unsigned char *packet = psmouse->packet;
 715
 716         return !memcmp(packet, debounce_packet, sizeof(debounce_packet));
 717 }
 718
 719 static int elantech_packet_check_v2(struct psmouse *psmouse)
 720 {
 721         struct elantech_data *etd = psmouse->private;
 722         unsigned char *packet = psmouse->packet;
 723
 724         /*
 725          * V2 hardware has two flavors. Older ones that do not report pressure,
 726          * and newer ones that reports pressure and width. With newer ones, all
 727          * packets (1, 2, 3 finger touch) have the same constant bits. With
 728          * older ones, 1/3 finger touch packets and 2 finger touch packets
 729          * have different constant bits.
 730          * With all three cases, if the constant bits are not exactly what I
 731          * expected, I consider them invalid.
 732          */
 733         if (etd->info.reports_pressure)
 734                 return (packet[0] & 0x0c) == 0x04 &&
 735                        (packet[3] & 0x0f) == 0x02;
 736
 737         if ((packet[0] & 0xc0) == 0x80)
 738                 return (packet[0] & 0x0c) == 0x0c &&
 739                        (packet[3] & 0x0e) == 0x08;
 740
 741         return (packet[0] & 0x3c) == 0x3c &&
 742                (packet[1] & 0xf0) == 0x00 &&
 743                (packet[3] & 0x3e) == 0x38 &&
 744                (packet[4] & 0xf0) == 0x00;
 745 }
 746
 747 /*
 748  * We check the constant bits to determine what packet type we get,
 749  * so packet checking is mandatory for v3 and later hardware.
 750  */
 751 static int elantech_packet_check_v3(struct psmouse *psmouse)
 752 {
 753         struct elantech_data *etd = psmouse->private;
 754         static const u8 debounce_packet[] = {
 755                 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff
 756         };
 757         unsigned char *packet = psmouse->packet;
 758
 759         /*
 760          * check debounce first, it has the same signature in byte 0
 761          * and byte 3 as PACKET_V3_HEAD.
 762          */
 763         if (!memcmp(packet, debounce_packet, sizeof(debounce_packet)))
 764                 return PACKET_DEBOUNCE;
 765
 766         /*
 767          * If the hardware flag 'crc_enabled' is set the packets have
 768          * different signatures.
 769          */
 770         if (etd->info.crc_enabled) {
 771                 if ((packet[3] & 0x09) == 0x08)
 772                         return PACKET_V3_HEAD;
 773
 774                 if ((packet[3] & 0x09) == 0x09)
 775                         return PACKET_V3_TAIL;
 776         } else {
 777                 if ((packet[0] & 0x0c) == 0x04 && (packet[3] & 0xcf) == 0x02)
 778                         return PACKET_V3_HEAD;
 779
 780                 if ((packet[0] & 0x0c) == 0x0c && (packet[3] & 0xce) == 0x0c)
 781                         return PACKET_V3_TAIL;
 782                 if ((packet[3] & 0x0f) == 0x06)
 783                         return PACKET_TRACKPOINT;
 784         }
 785
 786         return PACKET_UNKNOWN;
 787 }
 788
 789 static int elantech_packet_check_v4(struct psmouse *psmouse)
 790 {
 791         struct elantech_data *etd = psmouse->private;
 792         unsigned char *packet = psmouse->packet;
 793         unsigned char packet_type = packet[3] & 0x03;
 794         unsigned int ic_version;
 795         bool sanity_check;
 796
 797         if (etd->tp_dev && (packet[3] & 0x0f) == 0x06)
 798                 return PACKET_TRACKPOINT;
 799
 800         /* This represents the version of IC body. */
 801         ic_version = (etd->info.fw_version & 0x0f0000) >> 16;
 802
 803         /*
 804          * Sanity check based on the constant bits of a packet.
 805          * The constant bits change depending on the value of
 806          * the hardware flag 'crc_enabled' and the version of
 807          * the IC body, but are the same for every packet,
 808          * regardless of the type.
 809          */
 810         if (etd->info.crc_enabled)
 811                 sanity_check = ((packet[3] & 0x08) == 0x00);
 812         else if (ic_version == 7 && etd->info.samples[1] == 0x2A)
 813                 sanity_check = ((packet[3] & 0x1c) == 0x10);
 814         else
 815                 sanity_check = ((packet[0] & 0x08) == 0x00 &&
 816                                 (packet[3] & 0x1c) == 0x10);
 817
 818         if (!sanity_check)
 819                 return PACKET_UNKNOWN;
 820
 821         switch (packet_type) {
 822         case 0:
 823                 return PACKET_V4_STATUS;
 824
 825         case 1:
 826                 return PACKET_V4_HEAD;
 827
 828         case 2:
 829                 return PACKET_V4_MOTION;
 830         }
 831
 832         return PACKET_UNKNOWN;
 833 }
 834
 835 /*
 836  * Process byte stream from mouse and handle complete packets
 837  */
 838 static psmouse_ret_t elantech_process_byte(struct psmouse *psmouse)
 839 {
 840         struct elantech_data *etd = psmouse->private;
 841         int packet_type;
 842
 843         if (psmouse->pktcnt < psmouse->pktsize)
 844                 return PSMOUSE_GOOD_DATA;
 845
 846         if (etd->info.debug > 1)
 847                 elantech_packet_dump(psmouse);
 848
 849         switch (etd->info.hw_version) {
 850         case 1:
 851                 if (etd->info.paritycheck && !elantech_packet_check_v1(psmouse))
 852                         return PSMOUSE_BAD_DATA;
 853
 854                 elantech_report_absolute_v1(psmouse);
 855                 break;
 856
 857         case 2:
 858                 /* ignore debounce */
 859                 if (elantech_debounce_check_v2(psmouse))
 860                         return PSMOUSE_FULL_PACKET;
 861
 862                 if (etd->info.paritycheck && !elantech_packet_check_v2(psmouse))
 863                         return PSMOUSE_BAD_DATA;
 864
 865                 elantech_report_absolute_v2(psmouse);
 866                 break;
 867
 868         case 3:
 869                 packet_type = elantech_packet_check_v3(psmouse);
 870                 switch (packet_type) {
 871                 case PACKET_UNKNOWN:
 872                         return PSMOUSE_BAD_DATA;
 873
 874                 case PACKET_DEBOUNCE:
 875                         /* ignore debounce */
 876                         break;
 877
 878                 case PACKET_TRACKPOINT:
 879                         elantech_report_trackpoint(psmouse, packet_type);
 880                         break;
 881
 882                 default:
 883                         elantech_report_absolute_v3(psmouse, packet_type);
 884                         break;
 885                 }
 886
 887                 break;
 888
 889         case 4:
 890                 packet_type = elantech_packet_check_v4(psmouse);
 891                 switch (packet_type) {
 892                 case PACKET_UNKNOWN:
 893                         return PSMOUSE_BAD_DATA;
 894
 895                 case PACKET_TRACKPOINT:
 896                         elantech_report_trackpoint(psmouse, packet_type);
 897                         break;
 898
 899                 default:
 900                         elantech_report_absolute_v4(psmouse, packet_type);
 901                         break;
 902                 }
 903
 904                 break;
 905         }
 906
 907         return PSMOUSE_FULL_PACKET;
 908 }
 909
 910 /*
 911  * This writes the reg_07 value again to the hardware at the end of every
 912  * set_rate call because the register loses its value. reg_07 allows setting
 913  * absolute mode on v4 hardware
 914  */
 915 static void elantech_set_rate_restore_reg_07(struct psmouse *psmouse,
 916                 unsigned int rate)
 917 {
 918         struct elantech_data *etd = psmouse->private;
 919
 920         etd->original_set_rate(psmouse, rate);
 921         if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
 922                 psmouse_err(psmouse, "restoring reg_07 failed\n");
 923 }
 924
 925 /*
 926  * Put the touchpad into absolute mode
 927  */
 928 static int elantech_set_absolute_mode(struct psmouse *psmouse)
 929 {
 930         struct elantech_data *etd = psmouse->private;
 931         unsigned char val;
 932         int tries = ETP_READ_BACK_TRIES;
 933         int rc = 0;
 934
 935         switch (etd->info.hw_version) {
 936         case 1:
 937                 etd->reg_10 = 0x16;
 938                 etd->reg_11 = 0x8f;
 939                 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
 940                     elantech_write_reg(psmouse, 0x11, etd->reg_11)) {
 941                         rc = -1;
 942                 }
 943                 break;
 944
 945         case 2:
 946                                         /* Windows driver values */
 947                 etd->reg_10 = 0x54;
 948                 etd->reg_11 = 0x88;     /* 0x8a */
 949                 etd->reg_21 = 0x60;     /* 0x00 */
 950                 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
 951                     elantech_write_reg(psmouse, 0x11, etd->reg_11) ||
 952                     elantech_write_reg(psmouse, 0x21, etd->reg_21)) {
 953                         rc = -1;
 954                 }
 955                 break;
 956
 957         case 3:
 958                 if (etd->info.set_hw_resolution)
 959                         etd->reg_10 = 0x0b;
 960                 else
 961                         etd->reg_10 = 0x01;
 962
 963                 if (elantech_write_reg(psmouse, 0x10, etd->reg_10))
 964                         rc = -1;
 965
 966                 break;
 967
 968         case 4:
 969                 etd->reg_07 = 0x01;
 970                 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
 971                         rc = -1;
 972
 973                 goto skip_readback_reg_10; /* v4 has no reg 0x10 to read */
 974         }
 975
 976         if (rc == 0) {
 977                 /*
 978                  * Read back reg 0x10. For hardware version 1 we must make
 979                  * sure the absolute mode bit is set. For hardware version 2
 980                  * the touchpad is probably initializing and not ready until
 981                  * we read back the value we just wrote.
 982                  */
 983                 do {
 984                         rc = elantech_read_reg(psmouse, 0x10, &val);
 985                         if (rc == 0)
 986                                 break;
 987                         tries--;
 988                         elantech_debug("retrying read (%d).\n", tries);
 989                         msleep(ETP_READ_BACK_DELAY);
 990                 } while (tries > 0);
 991
 992                 if (rc) {
 993                         psmouse_err(psmouse,
 994                                     "failed to read back register 0x10.\n");
 995                 } else if (etd->info.hw_version == 1 &&
 996                            !(val & ETP_R10_ABSOLUTE_MODE)) {
 997                         psmouse_err(psmouse,
 998                                     "touchpad refuses to switch to absolute mode.\n");
 999                         rc = -1;
1000                 }
1001         }
1002
1003  skip_readback_reg_10:
1004         if (rc)
1005                 psmouse_err(psmouse, "failed to initialise registers.\n");
1006
1007         return rc;
1008 }
1009
1010 static int elantech_set_range(struct psmouse *psmouse,
1011                               unsigned int *x_min, unsigned int *y_min,
1012                               unsigned int *x_max, unsigned int *y_max,
1013                               unsigned int *width)
1014 {
1015         struct elantech_data *etd = psmouse->private;
1016         struct elantech_device_info *info = &etd->info;
1017         unsigned char param[3];
1018         unsigned char traces;
1019
1020         switch (info->hw_version) {
1021         case 1:
1022                 *x_min = ETP_XMIN_V1;
1023                 *y_min = ETP_YMIN_V1;
1024                 *x_max = ETP_XMAX_V1;
1025                 *y_max = ETP_YMAX_V1;
1026                 break;
1027
1028         case 2:
1029                 if (info->fw_version == 0x020800 ||
1030                     info->fw_version == 0x020b00 ||
1031                     info->fw_version == 0x020030) {
1032                         *x_min = ETP_XMIN_V2;
1033                         *y_min = ETP_YMIN_V2;
1034                         *x_max = ETP_XMAX_V2;
1035                         *y_max = ETP_YMAX_V2;
1036                 } else {
1037                         int i;
1038                         int fixed_dpi;
1039
1040                         i = (info->fw_version > 0x020800 &&
1041                              info->fw_version < 0x020900) ? 1 : 2;
1042
1043                         if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1044                                 return -1;
1045
1046                         fixed_dpi = param[1] & 0x10;
1047
1048                         if (((info->fw_version >> 16) == 0x14) && fixed_dpi) {
1049                                 if (info->send_cmd(psmouse, ETP_SAMPLE_QUERY, param))
1050                                         return -1;
1051
1052                                 *x_max = (info->capabilities[1] - i) * param[1] / 2;
1053                                 *y_max = (info->capabilities[2] - i) * param[2] / 2;
1054                         } else if (info->fw_version == 0x040216) {
1055                                 *x_max = 819;
1056                                 *y_max = 405;
1057                         } else if (info->fw_version == 0x040219 || info->fw_version == 0x040215) {
1058                                 *x_max = 900;
1059                                 *y_max = 500;
1060                         } else {
1061                                 *x_max = (info->capabilities[1] - i) * 64;
1062                                 *y_max = (info->capabilities[2] - i) * 64;
1063                         }
1064                 }
1065                 break;
1066
1067         case 3:
1068                 if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1069                         return -1;
1070
1071                 *x_max = (0x0f & param[0]) << 8 | param[1];
1072                 *y_max = (0xf0 & param[0]) << 4 | param[2];
1073                 break;
1074
1075         case 4:
1076                 if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1077                         return -1;
1078
1079                 *x_max = (0x0f & param[0]) << 8 | param[1];
1080                 *y_max = (0xf0 & param[0]) << 4 | param[2];
1081                 traces = info->capabilities[1];
1082                 if ((traces < 2) || (traces > *x_max))
1083                         return -1;
1084
1085                 *width = *x_max / (traces - 1);
1086                 break;
1087         }
1088
1089         return 0;
1090 }
1091
1092 /*
1093  * (value from firmware) * 10 + 790 = dpi
1094  * we also have to convert dpi to dots/mm (*10/254 to avoid floating point)
1095  */
1096 static unsigned int elantech_convert_res(unsigned int val)
1097 {
1098         return (val * 10 + 790) * 10 / 254;
1099 }
1100
1101 static int elantech_get_resolution_v4(struct psmouse *psmouse,
1102                                       unsigned int *x_res,
1103                                       unsigned int *y_res,
1104                                       unsigned int *bus)
1105 {
1106         unsigned char param[3];
1107
1108         if (elantech_send_cmd(psmouse, ETP_RESOLUTION_QUERY, param))
1109                 return -1;
1110
1111         *x_res = elantech_convert_res(param[1] & 0x0f);
1112         *y_res = elantech_convert_res((param[1] & 0xf0) >> 4);
1113         *bus = param[2];
1114
1115         return 0;
1116 }
1117
1118 /*
1119  * Advertise INPUT_PROP_BUTTONPAD for clickpads. The testing of bit 12 in
1120  * fw_version for this is based on the following fw_version & caps table:
1121  *
1122  * Laptop-model:           fw_version:     caps:           buttons:
1123  * Acer S3                 0x461f00        10, 13, 0e      clickpad
1124  * Acer S7-392             0x581f01        50, 17, 0d      clickpad
1125  * Acer V5-131             0x461f02        01, 16, 0c      clickpad
1126  * Acer V5-551             0x461f00        ?               clickpad
1127  * Asus K53SV              0x450f01        78, 15, 0c      2 hw buttons
1128  * Asus G46VW              0x460f02        00, 18, 0c      2 hw buttons
1129  * Asus G750JX             0x360f00        00, 16, 0c      2 hw buttons
1130  * Asus TP500LN            0x381f17        10, 14, 0e      clickpad
1131  * Asus X750JN             0x381f17        10, 14, 0e      clickpad
1132  * Asus UX31               0x361f00        20, 15, 0e      clickpad
1133  * Asus UX32VD             0x361f02        00, 15, 0e      clickpad
1134  * Avatar AVIU-145A2       0x361f00        ?               clickpad
1135  * Fujitsu CELSIUS H760    0x570f02        40, 14, 0c      3 hw buttons (**)
1136  * Fujitsu CELSIUS H780    0x5d0f02        41, 16, 0d      3 hw buttons (**)
1137  * Fujitsu LIFEBOOK E544   0x470f00        d0, 12, 09      2 hw buttons
1138  * Fujitsu LIFEBOOK E546   0x470f00        50, 12, 09      2 hw buttons
1139  * Fujitsu LIFEBOOK E547   0x470f00        50, 12, 09      2 hw buttons
1140  * Fujitsu LIFEBOOK E554   0x570f01        40, 14, 0c      2 hw buttons
1141  * Fujitsu LIFEBOOK E557   0x570f01        40, 14, 0c      2 hw buttons
1142  * Fujitsu T725            0x470f01        05, 12, 09      2 hw buttons
1143  * Fujitsu H730            0x570f00        c0, 14, 0c      3 hw buttons (**)
1144  * Gigabyte U2442          0x450f01        58, 17, 0c      2 hw buttons
1145  * Lenovo L430             0x350f02        b9, 15, 0c      2 hw buttons (*)
1146  * Lenovo L530             0x350f02        b9, 15, 0c      2 hw buttons (*)
1147  * Samsung NF210           0x150b00        78, 14, 0a      2 hw buttons
1148  * Samsung NP770Z5E        0x575f01        10, 15, 0f      clickpad
1149  * Samsung NP700Z5B        0x361f06        21, 15, 0f      clickpad
1150  * Samsung NP900X3E-A02    0x575f03        ?               clickpad
1151  * Samsung NP-QX410        0x851b00        19, 14, 0c      clickpad
1152  * Samsung RC512           0x450f00        08, 15, 0c      2 hw buttons
1153  * Samsung RF710           0x450f00        ?               2 hw buttons
1154  * System76 Pangolin       0x250f01        ?               2 hw buttons
1155  * (*) + 3 trackpoint buttons
1156  * (**) + 0 trackpoint buttons
1157  * Note: Lenovo L430 and Lenovo L530 have the same fw_version/caps
1158  */
1159 static void elantech_set_buttonpad_prop(struct psmouse *psmouse)
1160 {
1161         struct input_dev *dev = psmouse->dev;
1162         struct elantech_data *etd = psmouse->private;
1163
1164         if (etd->info.fw_version & 0x001000) {
1165                 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1166                 __clear_bit(BTN_RIGHT, dev->keybit);
1167         }
1168 }
1169
1170 /*
1171  * Some hw_version 4 models do have a middle button
1172  */
1173 static const struct dmi_system_id elantech_dmi_has_middle_button[] = {
1174 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1175         {
1176                 /* Fujitsu H730 has a middle button */
1177                 .matches = {
1178                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1179                         DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1180                 },
1181         },
1182         {
1183                 /* Fujitsu H760 also has a middle button */
1184                 .matches = {
1185                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1186                         DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1187                 },
1188         },
1189         {
1190                 /* Fujitsu H780 also has a middle button */
1191                 .matches = {
1192                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1193                         DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H780"),
1194                 },
1195         },
1196 #endif
1197         { }
1198 };
1199
1200 static const char * const middle_button_pnp_ids[] = {
1201         "LEN2131", /* ThinkPad P52 w/ NFC */
1202         "LEN2132", /* ThinkPad P52 */
1203         "LEN2133", /* ThinkPad P72 w/ NFC */
1204         "LEN2134", /* ThinkPad P72 */
1205         "LEN0407",
1206         "LEN0408",
1207         NULL
1208 };
1209
1210 /*
1211  * Set the appropriate event bits for the input subsystem
1212  */
1213 static int elantech_set_input_params(struct psmouse *psmouse)
1214 {
1215         struct input_dev *dev = psmouse->dev;
1216         struct elantech_data *etd = psmouse->private;
1217         struct elantech_device_info *info = &etd->info;
1218         unsigned int x_min = 0, y_min = 0, x_max = 0, y_max = 0, width = 0;
1219
1220         if (elantech_set_range(psmouse, &x_min, &y_min, &x_max, &y_max, &width))
1221                 return -1;
1222
1223         __set_bit(INPUT_PROP_POINTER, dev->propbit);
1224         __set_bit(EV_KEY, dev->evbit);
1225         __set_bit(EV_ABS, dev->evbit);
1226         __clear_bit(EV_REL, dev->evbit);
1227
1228         __set_bit(BTN_LEFT, dev->keybit);
1229         if (dmi_check_system(elantech_dmi_has_middle_button) ||
1230                         psmouse_matches_pnp_id(psmouse, middle_button_pnp_ids))
1231                 __set_bit(BTN_MIDDLE, dev->keybit);
1232         __set_bit(BTN_RIGHT, dev->keybit);
1233
1234         __set_bit(BTN_TOUCH, dev->keybit);
1235         __set_bit(BTN_TOOL_FINGER, dev->keybit);
1236         __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1237         __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1238
1239         switch (info->hw_version) {
1240         case 1:
1241                 /* Rocker button */
1242                 if (info->fw_version < 0x020000 &&
1243                     (info->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
1244                         __set_bit(BTN_FORWARD, dev->keybit);
1245                         __set_bit(BTN_BACK, dev->keybit);
1246                 }
1247                 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1248                 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1249                 break;
1250
1251         case 2:
1252                 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1253                 __set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
1254                 /* fall through */
1255         case 3:
1256                 if (info->hw_version == 3)
1257                         elantech_set_buttonpad_prop(psmouse);
1258                 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1259                 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1260                 if (info->reports_pressure) {
1261                         input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1262                                              ETP_PMAX_V2, 0, 0);
1263                         input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1264                                              ETP_WMAX_V2, 0, 0);
1265                 }
1266                 input_mt_init_slots(dev, 2, INPUT_MT_SEMI_MT);
1267                 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1268                 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1269                 break;
1270
1271         case 4:
1272                 elantech_set_buttonpad_prop(psmouse);
1273                 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1274                 /* For X to recognize me as touchpad. */
1275                 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1276                 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1277                 /*
1278                  * range of pressure and width is the same as v2,
1279                  * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
1280                  */
1281                 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1282                                      ETP_PMAX_V2, 0, 0);
1283                 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1284                                      ETP_WMAX_V2, 0, 0);
1285                 /* Multitouch capable pad, up to 5 fingers. */
1286                 input_mt_init_slots(dev, ETP_MAX_FINGERS, 0);
1287                 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1288                 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1289                 input_set_abs_params(dev, ABS_MT_PRESSURE, ETP_PMIN_V2,
1290                                      ETP_PMAX_V2, 0, 0);
1291                 /*
1292                  * The firmware reports how many trace lines the finger spans,
1293                  * convert to surface unit as Protocol-B requires.
1294                  */
1295                 input_set_abs_params(dev, ABS_MT_TOUCH_MAJOR, 0,
1296                                      ETP_WMAX_V2 * width, 0, 0);
1297                 break;
1298         }
1299
1300         input_abs_set_res(dev, ABS_X, info->x_res);
1301         input_abs_set_res(dev, ABS_Y, info->y_res);
1302         if (info->hw_version > 1) {
1303                 input_abs_set_res(dev, ABS_MT_POSITION_X, info->x_res);
1304                 input_abs_set_res(dev, ABS_MT_POSITION_Y, info->y_res);
1305         }
1306
1307         etd->y_max = y_max;
1308         etd->width = width;
1309
1310         return 0;
1311 }
1312
1313 struct elantech_attr_data {
1314         size_t          field_offset;
1315         unsigned char   reg;
1316 };
1317
1318 /*
1319  * Display a register value by reading a sysfs entry
1320  */
1321 static ssize_t elantech_show_int_attr(struct psmouse *psmouse, void *data,
1322                                         char *buf)
1323 {
1324         struct elantech_data *etd = psmouse->private;
1325         struct elantech_attr_data *attr = data;
1326         unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1327         int rc = 0;
1328
1329         if (attr->reg)
1330                 rc = elantech_read_reg(psmouse, attr->reg, reg);
1331
1332         return sprintf(buf, "0x%02x\n", (attr->reg && rc) ? -1 : *reg);
1333 }
1334
1335 /*
1336  * Write a register value by writing a sysfs entry
1337  */
1338 static ssize_t elantech_set_int_attr(struct psmouse *psmouse,
1339                                      void *data, const char *buf, size_t count)
1340 {
1341         struct elantech_data *etd = psmouse->private;
1342         struct elantech_attr_data *attr = data;
1343         unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1344         unsigned char value;
1345         int err;
1346
1347         err = kstrtou8(buf, 16, &value);
1348         if (err)
1349                 return err;
1350
1351         /* Do we need to preserve some bits for version 2 hardware too? */
1352         if (etd->info.hw_version == 1) {
1353                 if (attr->reg == 0x10)
1354                         /* Force absolute mode always on */
1355                         value |= ETP_R10_ABSOLUTE_MODE;
1356                 else if (attr->reg == 0x11)
1357                         /* Force 4 byte mode always on */
1358                         value |= ETP_R11_4_BYTE_MODE;
1359         }
1360
1361         if (!attr->reg || elantech_write_reg(psmouse, attr->reg, value) == 0)
1362                 *reg = value;
1363
1364         return count;
1365 }
1366
1367 #define ELANTECH_INT_ATTR(_name, _register)                             \
1368         static struct elantech_attr_data elantech_attr_##_name = {      \
1369                 .field_offset = offsetof(struct elantech_data, _name),  \
1370                 .reg = _register,                                       \
1371         };                                                              \
1372         PSMOUSE_DEFINE_ATTR(_name, 0644,                                \
1373                             &elantech_attr_##_name,                     \
1374                             elantech_show_int_attr,                     \
1375                             elantech_set_int_attr)
1376
1377 #define ELANTECH_INFO_ATTR(_name)                                              \
1378         static struct elantech_attr_data elantech_attr_##_name = {             \
1379                 .field_offset = offsetof(struct elantech_data, info) +         \
1380                                 offsetof(struct elantech_device_info, _name),  \
1381                 .reg = 0,                                                      \
1382         };                                                                     \
1383         PSMOUSE_DEFINE_ATTR(_name, 0644,                                       \
1384                             &elantech_attr_##_name,                            \
1385                             elantech_show_int_attr,                            \
1386                             elantech_set_int_attr)
1387
1388 ELANTECH_INT_ATTR(reg_07, 0x07);
1389 ELANTECH_INT_ATTR(reg_10, 0x10);
1390 ELANTECH_INT_ATTR(reg_11, 0x11);
1391 ELANTECH_INT_ATTR(reg_20, 0x20);
1392 ELANTECH_INT_ATTR(reg_21, 0x21);
1393 ELANTECH_INT_ATTR(reg_22, 0x22);
1394 ELANTECH_INT_ATTR(reg_23, 0x23);
1395 ELANTECH_INT_ATTR(reg_24, 0x24);
1396 ELANTECH_INT_ATTR(reg_25, 0x25);
1397 ELANTECH_INT_ATTR(reg_26, 0x26);
1398 ELANTECH_INFO_ATTR(debug);
1399 ELANTECH_INFO_ATTR(paritycheck);
1400 ELANTECH_INFO_ATTR(crc_enabled);
1401
1402 static struct attribute *elantech_attrs[] = {
1403         &psmouse_attr_reg_07.dattr.attr,
1404         &psmouse_attr_reg_10.dattr.attr,
1405         &psmouse_attr_reg_11.dattr.attr,
1406         &psmouse_attr_reg_20.dattr.attr,
1407         &psmouse_attr_reg_21.dattr.attr,
1408         &psmouse_attr_reg_22.dattr.attr,
1409         &psmouse_attr_reg_23.dattr.attr,
1410         &psmouse_attr_reg_24.dattr.attr,
1411         &psmouse_attr_reg_25.dattr.attr,
1412         &psmouse_attr_reg_26.dattr.attr,
1413         &psmouse_attr_debug.dattr.attr,
1414         &psmouse_attr_paritycheck.dattr.attr,
1415         &psmouse_attr_crc_enabled.dattr.attr,
1416         NULL
1417 };
1418
1419 static const struct attribute_group elantech_attr_group = {
1420         .attrs = elantech_attrs,
1421 };
1422
1423 static bool elantech_is_signature_valid(const unsigned char *param)
1424 {
1425         static const unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10 };
1426         int i;
1427
1428         if (param[0] == 0)
1429                 return false;
1430
1431         if (param[1] == 0)
1432                 return true;
1433
1434         /*
1435          * Some hw_version >= 4 models have a revision higher then 20. Meaning
1436          * that param[2] may be 10 or 20, skip the rates check for these.
1437          */
1438         if ((param[0] & 0x0f) >= 0x06 && (param[1] & 0xaf) == 0x0f &&
1439             param[2] < 40)
1440                 return true;
1441
1442         for (i = 0; i < ARRAY_SIZE(rates); i++)
1443                 if (param[2] == rates[i])
1444                         return false;
1445
1446         return true;
1447 }
1448
1449 /*
1450  * Use magic knock to detect Elantech touchpad
1451  */
1452 int elantech_detect(struct psmouse *psmouse, bool set_properties)
1453 {
1454         struct ps2dev *ps2dev = &psmouse->ps2dev;
1455         unsigned char param[3];
1456
1457         ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
1458
1459         if (ps2_command(ps2dev,  NULL, PSMOUSE_CMD_DISABLE) ||
1460             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
1461             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
1462             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
1463             ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
1464                 psmouse_dbg(psmouse, "sending Elantech magic knock failed.\n");
1465                 return -1;
1466         }
1467
1468         /*
1469          * Report this in case there are Elantech models that use a different
1470          * set of magic numbers
1471          */
1472         if (param[0] != 0x3c || param[1] != 0x03 ||
1473             (param[2] != 0xc8 && param[2] != 0x00)) {
1474                 psmouse_dbg(psmouse,
1475                             "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1476                             param[0], param[1], param[2]);
1477                 return -1;
1478         }
1479
1480         /*
1481          * Query touchpad's firmware version and see if it reports known
1482          * value to avoid mis-detection. Logitech mice are known to respond
1483          * to Elantech magic knock and there might be more.
1484          */
1485         if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1486                 psmouse_dbg(psmouse, "failed to query firmware version.\n");
1487                 return -1;
1488         }
1489
1490         psmouse_dbg(psmouse,
1491                     "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1492                     param[0], param[1], param[2]);
1493
1494         if (!elantech_is_signature_valid(param)) {
1495                 psmouse_dbg(psmouse,
1496                             "Probably not a real Elantech touchpad. Aborting.\n");
1497                 return -1;
1498         }
1499
1500         if (set_properties) {
1501                 psmouse->vendor = "Elantech";
1502                 psmouse->name = "Touchpad";
1503         }
1504
1505         return 0;
1506 }
1507
1508 /*
1509  * Clean up sysfs entries when disconnecting
1510  */
1511 static void elantech_disconnect(struct psmouse *psmouse)
1512 {
1513         struct elantech_data *etd = psmouse->private;
1514
1515         /*
1516          * We might have left a breadcrumb when trying to
1517          * set up SMbus companion.
1518          */
1519         psmouse_smbus_cleanup(psmouse);
1520
1521         if (etd->tp_dev)
1522                 input_unregister_device(etd->tp_dev);
1523         sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1524                            &elantech_attr_group);
1525         kfree(psmouse->private);
1526         psmouse->private = NULL;
1527 }
1528
1529 /*
1530  * Put the touchpad back into absolute mode when reconnecting
1531  */
1532 static int elantech_reconnect(struct psmouse *psmouse)
1533 {
1534         psmouse_reset(psmouse);
1535
1536         if (elantech_detect(psmouse, 0))
1537                 return -1;
1538
1539         if (elantech_set_absolute_mode(psmouse)) {
1540                 psmouse_err(psmouse,
1541                             "failed to put touchpad back into absolute mode.\n");
1542                 return -1;
1543         }
1544
1545         return 0;
1546 }
1547
1548 /*
1549  * Some hw_version 4 models do not work with crc_disabled
1550  */
1551 static const struct dmi_system_id elantech_dmi_force_crc_enabled[] = {
1552 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1553         {
1554                 /* Fujitsu H730 does not work with crc_enabled == 0 */
1555                 .matches = {
1556                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1557                         DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1558                 },
1559         },
1560         {
1561                 /* Fujitsu H760 does not work with crc_enabled == 0 */
1562                 .matches = {
1563                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1564                         DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1565                 },
1566         },
1567         {
1568                 /* Fujitsu LIFEBOOK E544  does not work with crc_enabled == 0 */
1569                 .matches = {
1570                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1571                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E544"),
1572                 },
1573         },
1574         {
1575                 /* Fujitsu LIFEBOOK E546  does not work with crc_enabled == 0 */
1576                 .matches = {
1577                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1578                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E546"),
1579                 },
1580         },
1581         {
1582                 /* Fujitsu LIFEBOOK E547 does not work with crc_enabled == 0 */
1583                 .matches = {
1584                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1585                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E547"),
1586                 },
1587         },
1588         {
1589                 /* Fujitsu LIFEBOOK E554  does not work with crc_enabled == 0 */
1590                 .matches = {
1591                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1592                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E554"),
1593                 },
1594         },
1595         {
1596                 /* Fujitsu LIFEBOOK E556 does not work with crc_enabled == 0 */
1597                 .matches = {
1598                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1599                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E556"),
1600                 },
1601         },
1602         {
1603                 /* Fujitsu LIFEBOOK E557 does not work with crc_enabled == 0 */
1604                 .matches = {
1605                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1606                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E557"),
1607                 },
1608         },
1609         {
1610                 /* Fujitsu LIFEBOOK U745 does not work with crc_enabled == 0 */
1611                 .matches = {
1612                         DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1613                         DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK U745"),
1614                 },
1615         },
1616 #endif
1617         { }
1618 };
1619
1620 /*
1621  * Some hw_version 3 models go into error state when we try to set
1622  * bit 3 and/or bit 1 of r10.
1623  */
1624 static const struct dmi_system_id no_hw_res_dmi_table[] = {
1625 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1626         {
1627                 /* Gigabyte U2442 */
1628                 .matches = {
1629                         DMI_MATCH(DMI_SYS_VENDOR, "GIGABYTE"),
1630                         DMI_MATCH(DMI_PRODUCT_NAME, "U2442"),
1631                 },
1632         },
1633 #endif
1634         { }
1635 };
1636
1637 /*
1638  * determine hardware version and set some properties according to it.
1639  */
1640 static int elantech_set_properties(struct elantech_device_info *info)
1641 {
1642         /* This represents the version of IC body. */
1643         int ver = (info->fw_version & 0x0f0000) >> 16;
1644
1645         /* Early version of Elan touchpads doesn't obey the rule. */
1646         if (info->fw_version < 0x020030 || info->fw_version == 0x020600)
1647                 info->hw_version = 1;
1648         else {
1649                 switch (ver) {
1650                 case 2:
1651                 case 4:
1652                         info->hw_version = 2;
1653                         break;
1654                 case 5:
1655                         info->hw_version = 3;
1656                         break;
1657                 case 6 ... 15:
1658                         info->hw_version = 4;
1659                         break;
1660                 default:
1661                         return -1;
1662                 }
1663         }
1664
1665         /* decide which send_cmd we're gonna use early */
1666         info->send_cmd = info->hw_version >= 3 ? elantech_send_cmd :
1667                                                  synaptics_send_cmd;
1668
1669         /* Turn on packet checking by default */
1670         info->paritycheck = 1;
1671
1672         /*
1673          * This firmware suffers from misreporting coordinates when
1674          * a touch action starts causing the mouse cursor or scrolled page
1675          * to jump. Enable a workaround.
1676          */
1677         info->jumpy_cursor =
1678                 (info->fw_version == 0x020022 || info->fw_version == 0x020600);
1679
1680         if (info->hw_version > 1) {
1681                 /* For now show extra debug information */
1682                 info->debug = 1;
1683
1684                 if (info->fw_version >= 0x020800)
1685                         info->reports_pressure = true;
1686         }
1687
1688         /*
1689          * The signatures of v3 and v4 packets change depending on the
1690          * value of this hardware flag.
1691          */
1692         info->crc_enabled = (info->fw_version & 0x4000) == 0x4000 ||
1693                              dmi_check_system(elantech_dmi_force_crc_enabled);
1694
1695         /* Enable real hardware resolution on hw_version 3 ? */
1696         info->set_hw_resolution = !dmi_check_system(no_hw_res_dmi_table);
1697
1698         return 0;
1699 }
1700
1701 static int elantech_query_info(struct psmouse *psmouse,
1702                                struct elantech_device_info *info)
1703 {
1704         unsigned char param[3];
1705
1706         memset(info, 0, sizeof(*info));
1707
1708         /*
1709          * Do the version query again so we can store the result
1710          */
1711         if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1712                 psmouse_err(psmouse, "failed to query firmware version.\n");
1713                 return -EINVAL;
1714         }
1715         info->fw_version = (param[0] << 16) | (param[1] << 8) | param[2];
1716
1717         if (elantech_set_properties(info)) {
1718                 psmouse_err(psmouse, "unknown hardware version, aborting...\n");
1719                 return -EINVAL;
1720         }
1721         psmouse_info(psmouse,
1722                      "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
1723                      info->hw_version, param[0], param[1], param[2]);
1724
1725         if (info->send_cmd(psmouse, ETP_CAPABILITIES_QUERY,
1726             info->capabilities)) {
1727                 psmouse_err(psmouse, "failed to query capabilities.\n");
1728                 return -EINVAL;
1729         }
1730         psmouse_info(psmouse,
1731                      "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
1732                      info->capabilities[0], info->capabilities[1],
1733                      info->capabilities[2]);
1734
1735         if (info->hw_version != 1) {
1736                 if (info->send_cmd(psmouse, ETP_SAMPLE_QUERY, info->samples)) {
1737                         psmouse_err(psmouse, "failed to query sample data\n");
1738                         return -EINVAL;
1739                 }
1740                 psmouse_info(psmouse,
1741                              "Elan sample query result %02x, %02x, %02x\n",
1742                              info->samples[0],
1743                              info->samples[1],
1744                              info->samples[2]);
1745         }
1746
1747         if (info->samples[1] == 0x74 && info->hw_version == 0x03) {
1748                 /*
1749                  * This module has a bug which makes absolute mode
1750                  * unusable, so let's abort so we'll be using standard
1751                  * PS/2 protocol.
1752                  */
1753                 psmouse_info(psmouse,
1754                              "absolute mode broken, forcing standard PS/2 protocol\n");
1755                 return -ENODEV;
1756         }
1757
1758         /* The MSB indicates the presence of the trackpoint */
1759         info->has_trackpoint = (info->capabilities[0] & 0x80) == 0x80;
1760
1761         info->x_res = 31;
1762         info->y_res = 31;
1763         if (info->hw_version == 4) {
1764                 if (elantech_get_resolution_v4(psmouse,
1765                                                &info->x_res,
1766                                                &info->y_res,
1767                                                &info->bus)) {
1768                         psmouse_warn(psmouse,
1769                                      "failed to query resolution data.\n");
1770                 }
1771         }
1772
1773         return 0;
1774 }
1775
1776 #if defined(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)
1777
1778 /*
1779  * The newest Elantech device can use a secondary bus (over SMBus) which
1780  * provides a better bandwidth and allow a better control of the touchpads.
1781  * This is used to decide if we need to use this bus or not.
1782  */
1783 enum {
1784         ELANTECH_SMBUS_NOT_SET = -1,
1785         ELANTECH_SMBUS_OFF,
1786         ELANTECH_SMBUS_ON,
1787 };
1788
1789 static int elantech_smbus = IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) ?
1790                 ELANTECH_SMBUS_NOT_SET : ELANTECH_SMBUS_OFF;
1791 module_param_named(elantech_smbus, elantech_smbus, int, 0644);
1792 MODULE_PARM_DESC(elantech_smbus, "Use a secondary bus for the Elantech device.");
1793
1794 static const char * const i2c_blacklist_pnp_ids[] = {
1795         /*
1796          * These are known to not be working properly as bits are missing
1797          * in elan_i2c.
1798          */
1799         "LEN2131", /* ThinkPad P52 w/ NFC */
1800         "LEN2132", /* ThinkPad P52 */
1801         "LEN2133", /* ThinkPad P72 w/ NFC */
1802         "LEN2134", /* ThinkPad P72 */
1803         NULL
1804 };
1805
1806 static int elantech_create_smbus(struct psmouse *psmouse,
1807                                  struct elantech_device_info *info,
1808                                  bool leave_breadcrumbs)
1809 {
1810         const struct property_entry i2c_properties[] = {
1811                 PROPERTY_ENTRY_BOOL("elan,trackpoint"),
1812                 { },
1813         };
1814         struct i2c_board_info smbus_board = {
1815                 I2C_BOARD_INFO("elan_i2c", 0x15),
1816                 .flags = I2C_CLIENT_HOST_NOTIFY,
1817         };
1818
1819         if (info->has_trackpoint)
1820                 smbus_board.properties = i2c_properties;
1821
1822         return psmouse_smbus_init(psmouse, &smbus_board, NULL, 0, false,
1823                                   leave_breadcrumbs);
1824 }
1825
1826 /**
1827  * elantech_setup_smbus - called once the PS/2 devices are enumerated
1828  * and decides to instantiate a SMBus InterTouch device.
1829  */
1830 static int elantech_setup_smbus(struct psmouse *psmouse,
1831                                 struct elantech_device_info *info,
1832                                 bool leave_breadcrumbs)
1833 {
1834         int error;
1835
1836         if (elantech_smbus == ELANTECH_SMBUS_OFF)
1837                 return -ENXIO;
1838
1839         if (elantech_smbus == ELANTECH_SMBUS_NOT_SET) {
1840                 /*
1841                  * New ICs are enabled by default, unless mentioned in
1842                  * i2c_blacklist_pnp_ids.
1843                  * Old ICs are up to the user to decide.
1844                  */
1845                 if (!ETP_NEW_IC_SMBUS_HOST_NOTIFY(info->fw_version) ||
1846                     psmouse_matches_pnp_id(psmouse, i2c_blacklist_pnp_ids))
1847                         return -ENXIO;
1848         }
1849
1850         psmouse_info(psmouse, "Trying to set up SMBus access\n");
1851
1852         error = elantech_create_smbus(psmouse, info, leave_breadcrumbs);
1853         if (error) {
1854                 if (error == -EAGAIN)
1855                         psmouse_info(psmouse, "SMbus companion is not ready yet\n");
1856                 else
1857                         psmouse_err(psmouse, "unable to create intertouch device\n");
1858
1859                 return error;
1860         }
1861
1862         return 0;
1863 }
1864
1865 static bool elantech_use_host_notify(struct psmouse *psmouse,
1866                                      struct elantech_device_info *info)
1867 {
1868         if (ETP_NEW_IC_SMBUS_HOST_NOTIFY(info->fw_version))
1869                 return true;
1870
1871         switch (info->bus) {
1872         case ETP_BUS_PS2_ONLY:
1873                 /* expected case */
1874                 break;
1875         case ETP_BUS_SMB_ALERT_ONLY:
1876                 /* fall-through  */
1877         case ETP_BUS_PS2_SMB_ALERT:
1878                 psmouse_dbg(psmouse, "Ignoring SMBus provider through alert protocol.\n");
1879                 break;
1880         case ETP_BUS_SMB_HST_NTFY_ONLY:
1881                 /* fall-through  */
1882         case ETP_BUS_PS2_SMB_HST_NTFY:
1883                 return true;
1884         default:
1885                 psmouse_dbg(psmouse,
1886                             "Ignoring SMBus bus provider %d.\n",
1887                             info->bus);
1888         }
1889
1890         return false;
1891 }
1892
1893 int elantech_init_smbus(struct psmouse *psmouse)
1894 {
1895         struct elantech_device_info info;
1896         int error = -EINVAL;
1897
1898         psmouse_reset(psmouse);
1899
1900         error = elantech_query_info(psmouse, &info);
1901         if (error)
1902                 goto init_fail;
1903
1904         if (info.hw_version < 4) {
1905                 error = -ENXIO;
1906                 goto init_fail;
1907         }
1908
1909         return elantech_create_smbus(psmouse, &info, false);
1910  init_fail:
1911         psmouse_reset(psmouse);
1912         return error;
1913 }
1914 #endif /* CONFIG_MOUSE_PS2_ELANTECH_SMBUS */
1915
1916 /*
1917  * Initialize the touchpad and create sysfs entries
1918  */
1919 static int elantech_setup_ps2(struct psmouse *psmouse,
1920                               struct elantech_device_info *info)
1921 {
1922         struct elantech_data *etd;
1923         int i;
1924         int error = -EINVAL;
1925         struct input_dev *tp_dev;
1926
1927         psmouse->private = etd = kzalloc(sizeof(*etd), GFP_KERNEL);
1928         if (!etd)
1929                 return -ENOMEM;
1930
1931         etd->info = *info;
1932
1933         etd->parity[0] = 1;
1934         for (i = 1; i < 256; i++)
1935                 etd->parity[i] = etd->parity[i & (i - 1)] ^ 1;
1936
1937         if (elantech_set_absolute_mode(psmouse)) {
1938                 psmouse_err(psmouse,
1939                             "failed to put touchpad into absolute mode.\n");
1940                 goto init_fail;
1941         }
1942
1943         if (info->fw_version == 0x381f17) {
1944                 etd->original_set_rate = psmouse->set_rate;
1945                 psmouse->set_rate = elantech_set_rate_restore_reg_07;
1946         }
1947
1948         if (elantech_set_input_params(psmouse)) {
1949                 psmouse_err(psmouse, "failed to query touchpad range.\n");
1950                 goto init_fail;
1951         }
1952
1953         error = sysfs_create_group(&psmouse->ps2dev.serio->dev.kobj,
1954                                    &elantech_attr_group);
1955         if (error) {
1956                 psmouse_err(psmouse,
1957                             "failed to create sysfs attributes, error: %d.\n",
1958                             error);
1959                 goto init_fail;
1960         }
1961
1962         if (info->has_trackpoint) {
1963                 tp_dev = input_allocate_device();
1964
1965                 if (!tp_dev) {
1966                         error = -ENOMEM;
1967                         goto init_fail_tp_alloc;
1968                 }
1969
1970                 etd->tp_dev = tp_dev;
1971                 snprintf(etd->tp_phys, sizeof(etd->tp_phys), "%s/input1",
1972                         psmouse->ps2dev.serio->phys);
1973                 tp_dev->phys = etd->tp_phys;
1974                 tp_dev->name = "ETPS/2 Elantech TrackPoint";
1975                 tp_dev->id.bustype = BUS_I8042;
1976                 tp_dev->id.vendor  = 0x0002;
1977                 tp_dev->id.product = PSMOUSE_ELANTECH;
1978                 tp_dev->id.version = 0x0000;
1979                 tp_dev->dev.parent = &psmouse->ps2dev.serio->dev;
1980                 tp_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
1981                 tp_dev->relbit[BIT_WORD(REL_X)] =
1982                         BIT_MASK(REL_X) | BIT_MASK(REL_Y);
1983                 tp_dev->keybit[BIT_WORD(BTN_LEFT)] =
1984                         BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_MIDDLE) |
1985                         BIT_MASK(BTN_RIGHT);
1986
1987                 __set_bit(INPUT_PROP_POINTER, tp_dev->propbit);
1988                 __set_bit(INPUT_PROP_POINTING_STICK, tp_dev->propbit);
1989
1990                 error = input_register_device(etd->tp_dev);
1991                 if (error < 0)
1992                         goto init_fail_tp_reg;
1993         }
1994
1995         psmouse->protocol_handler = elantech_process_byte;
1996         psmouse->disconnect = elantech_disconnect;
1997         psmouse->reconnect = elantech_reconnect;
1998         psmouse->pktsize = info->hw_version > 1 ? 6 : 4;
1999
2000         return 0;
2001  init_fail_tp_reg:
2002         input_free_device(tp_dev);
2003  init_fail_tp_alloc:
2004         sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
2005                            &elantech_attr_group);
2006  init_fail:
2007         kfree(etd);
2008         return error;
2009 }
2010
2011 int elantech_init_ps2(struct psmouse *psmouse)
2012 {
2013         struct elantech_device_info info;
2014         int error = -EINVAL;
2015
2016         psmouse_reset(psmouse);
2017
2018         error = elantech_query_info(psmouse, &info);
2019         if (error)
2020                 goto init_fail;
2021
2022         error = elantech_setup_ps2(psmouse, &info);
2023         if (error)
2024                 goto init_fail;
2025
2026         return 0;
2027  init_fail:
2028         psmouse_reset(psmouse);
2029         return error;
2030 }
2031
2032 int elantech_init(struct psmouse *psmouse)
2033 {
2034         struct elantech_device_info info;
2035         int error = -EINVAL;
2036
2037         psmouse_reset(psmouse);
2038
2039         error = elantech_query_info(psmouse, &info);
2040         if (error)
2041                 goto init_fail;
2042
2043 #if defined(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)
2044
2045         if (elantech_use_host_notify(psmouse, &info)) {
2046                 if (!IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) ||
2047                     !IS_ENABLED(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)) {
2048                         psmouse_warn(psmouse,
2049                                      "The touchpad can support a better bus than the too old PS/2 protocol. "
2050                                      "Make sure MOUSE_PS2_ELANTECH_SMBUS and MOUSE_ELAN_I2C_SMBUS are enabled to get a better touchpad experience.\n");
2051                 }
2052                 error = elantech_setup_smbus(psmouse, &info, true);
2053                 if (!error)
2054                         return PSMOUSE_ELANTECH_SMBUS;
2055         }
2056
2057 #endif /* CONFIG_MOUSE_PS2_ELANTECH_SMBUS */
2058
2059         error = elantech_setup_ps2(psmouse, &info);
2060         if (error < 0) {
2061                 /*
2062                  * Not using any flavor of Elantech support, so clean up
2063                  * SMbus breadcrumbs, if any.
2064                  */
2065                 psmouse_smbus_cleanup(psmouse);
2066                 goto init_fail;
2067         }
2068
2069         return PSMOUSE_ELANTECH;
2070  init_fail:
2071         psmouse_reset(psmouse);
2072         return error;
2073 }