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/input.h>
  18 #include <linux/input/mt.h>
  19 #include <linux/serio.h>
  20 #include <linux/libps2.h>
  21 #include "psmouse.h"
  22 #include "elantech.h"
  23
  24 #define elantech_debug(fmt, ...)                                        \
  25         do {                                                            \
  26                 if (etd->debug)                                         \
  27                         psmouse_printk(KERN_DEBUG, psmouse,             \
  28                                         fmt, ##__VA_ARGS__);            \
  29         } while (0)
  30
  31 /*
  32  * Send a Synaptics style sliced query command
  33  */
  34 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c,
  35                                 unsigned char *param)
  36 {
  37         if (psmouse_sliced_command(psmouse, c) ||
  38             ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
  39                 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
  40                 return -1;
  41         }
  42
  43         return 0;
  44 }
  45
  46 /*
  47  * V3 and later support this fast command
  48  */
  49 static int elantech_send_cmd(struct psmouse *psmouse, unsigned char c,
  50                                 unsigned char *param)
  51 {
  52         struct ps2dev *ps2dev = &psmouse->ps2dev;
  53
  54         if (ps2_command(ps2dev, NULL, ETP_PS2_CUSTOM_COMMAND) ||
  55             ps2_command(ps2dev, NULL, c) ||
  56             ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
  57                 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
  58                 return -1;
  59         }
  60
  61         return 0;
  62 }
  63
  64 /*
  65  * A retrying version of ps2_command
  66  */
  67 static int elantech_ps2_command(struct psmouse *psmouse,
  68                                 unsigned char *param, int command)
  69 {
  70         struct ps2dev *ps2dev = &psmouse->ps2dev;
  71         struct elantech_data *etd = psmouse->private;
  72         int rc;
  73         int tries = ETP_PS2_COMMAND_TRIES;
  74
  75         do {
  76                 rc = ps2_command(ps2dev, param, command);
  77                 if (rc == 0)
  78                         break;
  79                 tries--;
  80                 elantech_debug("retrying ps2 command 0x%02x (%d).\n",
  81                                 command, tries);
  82                 msleep(ETP_PS2_COMMAND_DELAY);
  83         } while (tries > 0);
  84
  85         if (rc)
  86                 psmouse_err(psmouse, "ps2 command 0x%02x failed.\n", command);
  87
  88         return rc;
  89 }
  90
  91 /*
  92  * Send an Elantech style special command to read a value from a register
  93  */
  94 static int elantech_read_reg(struct psmouse *psmouse, unsigned char reg,
  95                                 unsigned char *val)
  96 {
  97         struct elantech_data *etd = psmouse->private;
  98         unsigned char param[3];
  99         int rc = 0;
 100
 101         if (reg < 0x07 || reg > 0x26)
 102                 return -1;
 103
 104         if (reg > 0x11 && reg < 0x20)
 105                 return -1;
 106
 107         switch (etd->hw_version) {
 108         case 1:
 109                 if (psmouse_sliced_command(psmouse, ETP_REGISTER_READ) ||
 110                     psmouse_sliced_command(psmouse, reg) ||
 111                     ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
 112                         rc = -1;
 113                 }
 114                 break;
 115
 116         case 2:
 117                 if (elantech_ps2_command(psmouse,  NULL, ETP_PS2_CUSTOM_COMMAND) ||
 118                     elantech_ps2_command(psmouse,  NULL, ETP_REGISTER_READ) ||
 119                     elantech_ps2_command(psmouse,  NULL, ETP_PS2_CUSTOM_COMMAND) ||
 120                     elantech_ps2_command(psmouse,  NULL, reg) ||
 121                     elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
 122                         rc = -1;
 123                 }
 124                 break;
 125
 126         case 3 ... 4:
 127                 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 128                     elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
 129                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 130                     elantech_ps2_command(psmouse, NULL, reg) ||
 131                     elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
 132                         rc = -1;
 133                 }
 134                 break;
 135         }
 136
 137         if (rc)
 138                 psmouse_err(psmouse, "failed to read register 0x%02x.\n", reg);
 139         else if (etd->hw_version != 4)
 140                 *val = param[0];
 141         else
 142                 *val = param[1];
 143
 144         return rc;
 145 }
 146
 147 /*
 148  * Send an Elantech style special command to write a register with a value
 149  */
 150 static int elantech_write_reg(struct psmouse *psmouse, unsigned char reg,
 151                                 unsigned char val)
 152 {
 153         struct elantech_data *etd = psmouse->private;
 154         int rc = 0;
 155
 156         if (reg < 0x07 || reg > 0x26)
 157                 return -1;
 158
 159         if (reg > 0x11 && reg < 0x20)
 160                 return -1;
 161
 162         switch (etd->hw_version) {
 163         case 1:
 164                 if (psmouse_sliced_command(psmouse, ETP_REGISTER_WRITE) ||
 165                     psmouse_sliced_command(psmouse, reg) ||
 166                     psmouse_sliced_command(psmouse, val) ||
 167                     ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11)) {
 168                         rc = -1;
 169                 }
 170                 break;
 171
 172         case 2:
 173                 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 174                     elantech_ps2_command(psmouse, NULL, ETP_REGISTER_WRITE) ||
 175                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 176                     elantech_ps2_command(psmouse, NULL, reg) ||
 177                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 178                     elantech_ps2_command(psmouse, NULL, val) ||
 179                     elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
 180                         rc = -1;
 181                 }
 182                 break;
 183
 184         case 3:
 185                 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 186                     elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
 187                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 188                     elantech_ps2_command(psmouse, NULL, reg) ||
 189                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 190                     elantech_ps2_command(psmouse, NULL, val) ||
 191                     elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
 192                         rc = -1;
 193                 }
 194                 break;
 195
 196         case 4:
 197                 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 198                     elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
 199                     elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
 200                     elantech_ps2_command(psmouse, NULL, reg) ||
 201                     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, val) ||
 205                     elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
 206                         rc = -1;
 207                 }
 208                 break;
 209         }
 210
 211         if (rc)
 212                 psmouse_err(psmouse,
 213                             "failed to write register 0x%02x with value 0x%02x.\n",
 214                             reg, val);
 215
 216         return rc;
 217 }
 218
 219 /*
 220  * Dump a complete mouse movement packet to the syslog
 221  */
 222 static void elantech_packet_dump(struct psmouse *psmouse)
 223 {
 224         int     i;
 225
 226         psmouse_printk(KERN_DEBUG, psmouse, "PS/2 packet [");
 227         for (i = 0; i < psmouse->pktsize; i++)
 228                 printk("%s0x%02x ", i ? ", " : " ", psmouse->packet[i]);
 229         printk("]\n");
 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->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->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         input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
 286         input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
 287
 288         if (etd->fw_version < 0x020000 &&
 289             (etd->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                 /* pass 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         input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
 397         input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
 398         if (etd->reports_pressure) {
 399                 input_report_abs(dev, ABS_PRESSURE, pres);
 400                 input_report_abs(dev, ABS_TOOL_WIDTH, width);
 401         }
 402
 403         input_sync(dev);
 404 }
 405
 406 /*
 407  * Interpret complete data packets and report absolute mode input events for
 408  * hardware version 3. (12 byte packets for two fingers)
 409  */
 410 static void elantech_report_absolute_v3(struct psmouse *psmouse,
 411                                         int packet_type)
 412 {
 413         struct input_dev *dev = psmouse->dev;
 414         struct elantech_data *etd = psmouse->private;
 415         unsigned char *packet = psmouse->packet;
 416         unsigned int fingers = 0, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
 417         unsigned int width = 0, pres = 0;
 418
 419         /* byte 0: n1  n0   .   .   .   .   R   L */
 420         fingers = (packet[0] & 0xc0) >> 6;
 421
 422         switch (fingers) {
 423         case 3:
 424         case 1:
 425                 /*
 426                  * byte 1:  .   .   .   .  x11 x10 x9  x8
 427                  * byte 2: x7  x6  x5  x4  x4  x2  x1  x0
 428                  */
 429                 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
 430                 /*
 431                  * byte 4:  .   .   .   .  y11 y10 y9  y8
 432                  * byte 5: y7  y6  y5  y4  y3  y2  y1  y0
 433                  */
 434                 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
 435                 break;
 436
 437         case 2:
 438                 if (packet_type == PACKET_V3_HEAD) {
 439                         /*
 440                          * byte 1:   .    .    .    .  ax11 ax10 ax9  ax8
 441                          * byte 2: ax7  ax6  ax5  ax4  ax3  ax2  ax1  ax0
 442                          */
 443                         etd->mt[0].x = ((packet[1] & 0x0f) << 8) | packet[2];
 444                         /*
 445                          * byte 4:   .    .    .    .  ay11 ay10 ay9  ay8
 446                          * byte 5: ay7  ay6  ay5  ay4  ay3  ay2  ay1  ay0
 447                          */
 448                         etd->mt[0].y = etd->y_max -
 449                                 (((packet[4] & 0x0f) << 8) | packet[5]);
 450                         /*
 451                          * wait for next packet
 452                          */
 453                         return;
 454                 }
 455
 456                 /* packet_type == PACKET_V3_TAIL */
 457                 x1 = etd->mt[0].x;
 458                 y1 = etd->mt[0].y;
 459                 x2 = ((packet[1] & 0x0f) << 8) | packet[2];
 460                 y2 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
 461                 break;
 462         }
 463
 464         pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
 465         width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
 466
 467         input_report_key(dev, BTN_TOUCH, fingers != 0);
 468         if (fingers != 0) {
 469                 input_report_abs(dev, ABS_X, x1);
 470                 input_report_abs(dev, ABS_Y, y1);
 471         }
 472         elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
 473         input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
 474         input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
 475         input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
 476
 477         /* For clickpads map both buttons to BTN_LEFT */
 478         if (etd->fw_version & 0x001000) {
 479                 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
 480         } else {
 481                 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
 482                 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
 483         }
 484
 485         input_report_abs(dev, ABS_PRESSURE, pres);
 486         input_report_abs(dev, ABS_TOOL_WIDTH, width);
 487
 488         input_sync(dev);
 489 }
 490
 491 static void elantech_input_sync_v4(struct psmouse *psmouse)
 492 {
 493         struct input_dev *dev = psmouse->dev;
 494         struct elantech_data *etd = psmouse->private;
 495         unsigned char *packet = psmouse->packet;
 496
 497         /* For clickpads map both buttons to BTN_LEFT */
 498         if (etd->fw_version & 0x001000) {
 499                 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
 500         } else {
 501                 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
 502                 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
 503         }
 504
 505         input_mt_report_pointer_emulation(dev, true);
 506         input_sync(dev);
 507 }
 508
 509 static void process_packet_status_v4(struct psmouse *psmouse)
 510 {
 511         struct input_dev *dev = psmouse->dev;
 512         unsigned char *packet = psmouse->packet;
 513         unsigned fingers;
 514         int i;
 515
 516         /* notify finger state change */
 517         fingers = packet[1] & 0x1f;
 518         for (i = 0; i < ETP_MAX_FINGERS; i++) {
 519                 if ((fingers & (1 << i)) == 0) {
 520                         input_mt_slot(dev, i);
 521                         input_mt_report_slot_state(dev, MT_TOOL_FINGER, false);
 522                 }
 523         }
 524
 525         elantech_input_sync_v4(psmouse);
 526 }
 527
 528 static void process_packet_head_v4(struct psmouse *psmouse)
 529 {
 530         struct input_dev *dev = psmouse->dev;
 531         struct elantech_data *etd = psmouse->private;
 532         unsigned char *packet = psmouse->packet;
 533         int id = ((packet[3] & 0xe0) >> 5) - 1;
 534         int pres, traces;
 535
 536         if (id < 0)
 537                 return;
 538
 539         etd->mt[id].x = ((packet[1] & 0x0f) << 8) | packet[2];
 540         etd->mt[id].y = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
 541         pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
 542         traces = (packet[0] & 0xf0) >> 4;
 543
 544         input_mt_slot(dev, id);
 545         input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
 546
 547         input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
 548         input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
 549         input_report_abs(dev, ABS_MT_PRESSURE, pres);
 550         input_report_abs(dev, ABS_MT_TOUCH_MAJOR, traces * etd->width);
 551         /* report this for backwards compatibility */
 552         input_report_abs(dev, ABS_TOOL_WIDTH, traces);
 553
 554         elantech_input_sync_v4(psmouse);
 555 }
 556
 557 static void process_packet_motion_v4(struct psmouse *psmouse)
 558 {
 559         struct input_dev *dev = psmouse->dev;
 560         struct elantech_data *etd = psmouse->private;
 561         unsigned char *packet = psmouse->packet;
 562         int weight, delta_x1 = 0, delta_y1 = 0, delta_x2 = 0, delta_y2 = 0;
 563         int id, sid;
 564
 565         id = ((packet[0] & 0xe0) >> 5) - 1;
 566         if (id < 0)
 567                 return;
 568
 569         sid = ((packet[3] & 0xe0) >> 5) - 1;
 570         weight = (packet[0] & 0x10) ? ETP_WEIGHT_VALUE : 1;
 571         /*
 572          * Motion packets give us the delta of x, y values of specific fingers,
 573          * but in two's complement. Let the compiler do the conversion for us.
 574          * Also _enlarge_ the numbers to int, in case of overflow.
 575          */
 576         delta_x1 = (signed char)packet[1];
 577         delta_y1 = (signed char)packet[2];
 578         delta_x2 = (signed char)packet[4];
 579         delta_y2 = (signed char)packet[5];
 580
 581         etd->mt[id].x += delta_x1 * weight;
 582         etd->mt[id].y -= delta_y1 * weight;
 583         input_mt_slot(dev, id);
 584         input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
 585         input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
 586
 587         if (sid >= 0) {
 588                 etd->mt[sid].x += delta_x2 * weight;
 589                 etd->mt[sid].y -= delta_y2 * weight;
 590                 input_mt_slot(dev, sid);
 591                 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[sid].x);
 592                 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[sid].y);
 593         }
 594
 595         elantech_input_sync_v4(psmouse);
 596 }
 597
 598 static void elantech_report_absolute_v4(struct psmouse *psmouse,
 599                                         int packet_type)
 600 {
 601         switch (packet_type) {
 602         case PACKET_V4_STATUS:
 603                 process_packet_status_v4(psmouse);
 604                 break;
 605
 606         case PACKET_V4_HEAD:
 607                 process_packet_head_v4(psmouse);
 608                 break;
 609
 610         case PACKET_V4_MOTION:
 611                 process_packet_motion_v4(psmouse);
 612                 break;
 613
 614         case PACKET_UNKNOWN:
 615         default:
 616                 /* impossible to get here */
 617                 break;
 618         }
 619 }
 620
 621 static int elantech_packet_check_v1(struct psmouse *psmouse)
 622 {
 623         struct elantech_data *etd = psmouse->private;
 624         unsigned char *packet = psmouse->packet;
 625         unsigned char p1, p2, p3;
 626
 627         /* Parity bits are placed differently */
 628         if (etd->fw_version < 0x020000) {
 629                 /* byte 0:  D   U  p1  p2   1  p3   R   L */
 630                 p1 = (packet[0] & 0x20) >> 5;
 631                 p2 = (packet[0] & 0x10) >> 4;
 632         } else {
 633                 /* byte 0: n1  n0  p2  p1   1  p3   R   L */
 634                 p1 = (packet[0] & 0x10) >> 4;
 635                 p2 = (packet[0] & 0x20) >> 5;
 636         }
 637
 638         p3 = (packet[0] & 0x04) >> 2;
 639
 640         return etd->parity[packet[1]] == p1 &&
 641                etd->parity[packet[2]] == p2 &&
 642                etd->parity[packet[3]] == p3;
 643 }
 644
 645 static int elantech_debounce_check_v2(struct psmouse *psmouse)
 646 {
 647         /*
 648          * When we encounter packet that matches this exactly, it means the
 649          * hardware is in debounce status. Just ignore the whole packet.
 650          */
 651         const u8 debounce_packet[] = { 0x84, 0xff, 0xff, 0x02, 0xff, 0xff };
 652         unsigned char *packet = psmouse->packet;
 653
 654         return !memcmp(packet, debounce_packet, sizeof(debounce_packet));
 655 }
 656
 657 static int elantech_packet_check_v2(struct psmouse *psmouse)
 658 {
 659         struct elantech_data *etd = psmouse->private;
 660         unsigned char *packet = psmouse->packet;
 661
 662         /*
 663          * V2 hardware has two flavors. Older ones that do not report pressure,
 664          * and newer ones that reports pressure and width. With newer ones, all
 665          * packets (1, 2, 3 finger touch) have the same constant bits. With
 666          * older ones, 1/3 finger touch packets and 2 finger touch packets
 667          * have different constant bits.
 668          * With all three cases, if the constant bits are not exactly what I
 669          * expected, I consider them invalid.
 670          */
 671         if (etd->reports_pressure)
 672                 return (packet[0] & 0x0c) == 0x04 &&
 673                        (packet[3] & 0x0f) == 0x02;
 674
 675         if ((packet[0] & 0xc0) == 0x80)
 676                 return (packet[0] & 0x0c) == 0x0c &&
 677                        (packet[3] & 0x0e) == 0x08;
 678
 679         return (packet[0] & 0x3c) == 0x3c &&
 680                (packet[1] & 0xf0) == 0x00 &&
 681                (packet[3] & 0x3e) == 0x38 &&
 682                (packet[4] & 0xf0) == 0x00;
 683 }
 684
 685 /*
 686  * We check the constant bits to determine what packet type we get,
 687  * so packet checking is mandatory for v3 and later hardware.
 688  */
 689 static int elantech_packet_check_v3(struct psmouse *psmouse)
 690 {
 691         const u8 debounce_packet[] = { 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff };
 692         unsigned char *packet = psmouse->packet;
 693
 694         /*
 695          * check debounce first, it has the same signature in byte 0
 696          * and byte 3 as PACKET_V3_HEAD.
 697          */
 698         if (!memcmp(packet, debounce_packet, sizeof(debounce_packet)))
 699                 return PACKET_DEBOUNCE;
 700
 701         if ((packet[0] & 0x0c) == 0x04 && (packet[3] & 0xcf) == 0x02)
 702                 return PACKET_V3_HEAD;
 703
 704         if ((packet[0] & 0x0c) == 0x0c && (packet[3] & 0xce) == 0x0c)
 705                 return PACKET_V3_TAIL;
 706
 707         return PACKET_UNKNOWN;
 708 }
 709
 710 static int elantech_packet_check_v4(struct psmouse *psmouse)
 711 {
 712         unsigned char *packet = psmouse->packet;
 713
 714         if ((packet[0] & 0x0c) == 0x04 &&
 715             (packet[3] & 0x1f) == 0x11)
 716                 return PACKET_V4_HEAD;
 717
 718         if ((packet[0] & 0x0c) == 0x04 &&
 719             (packet[3] & 0x1f) == 0x12)
 720                 return PACKET_V4_MOTION;
 721
 722         if ((packet[0] & 0x0c) == 0x04 &&
 723             (packet[3] & 0x1f) == 0x10)
 724                 return PACKET_V4_STATUS;
 725
 726         return PACKET_UNKNOWN;
 727 }
 728
 729 /*
 730  * Process byte stream from mouse and handle complete packets
 731  */
 732 static psmouse_ret_t elantech_process_byte(struct psmouse *psmouse)
 733 {
 734         struct elantech_data *etd = psmouse->private;
 735         int packet_type;
 736
 737         if (psmouse->pktcnt < psmouse->pktsize)
 738                 return PSMOUSE_GOOD_DATA;
 739
 740         if (etd->debug > 1)
 741                 elantech_packet_dump(psmouse);
 742
 743         switch (etd->hw_version) {
 744         case 1:
 745                 if (etd->paritycheck && !elantech_packet_check_v1(psmouse))
 746                         return PSMOUSE_BAD_DATA;
 747
 748                 elantech_report_absolute_v1(psmouse);
 749                 break;
 750
 751         case 2:
 752                 /* ignore debounce */
 753                 if (elantech_debounce_check_v2(psmouse))
 754                         return PSMOUSE_FULL_PACKET;
 755
 756                 if (etd->paritycheck && !elantech_packet_check_v2(psmouse))
 757                         return PSMOUSE_BAD_DATA;
 758
 759                 elantech_report_absolute_v2(psmouse);
 760                 break;
 761
 762         case 3:
 763                 packet_type = elantech_packet_check_v3(psmouse);
 764                 /* ignore debounce */
 765                 if (packet_type == PACKET_DEBOUNCE)
 766                         return PSMOUSE_FULL_PACKET;
 767
 768                 if (packet_type == PACKET_UNKNOWN)
 769                         return PSMOUSE_BAD_DATA;
 770
 771                 elantech_report_absolute_v3(psmouse, packet_type);
 772                 break;
 773
 774         case 4:
 775                 packet_type = elantech_packet_check_v4(psmouse);
 776                 if (packet_type == PACKET_UNKNOWN)
 777                         return PSMOUSE_BAD_DATA;
 778
 779                 elantech_report_absolute_v4(psmouse, packet_type);
 780                 break;
 781         }
 782
 783         return PSMOUSE_FULL_PACKET;
 784 }
 785
 786 /*
 787  * This writes the reg_07 value again to the hardware at the end of every
 788  * set_rate call because the register loses its value. reg_07 allows setting
 789  * absolute mode on v4 hardware
 790  */
 791 static void elantech_set_rate_restore_reg_07(struct psmouse *psmouse,
 792                 unsigned int rate)
 793 {
 794         struct elantech_data *etd = psmouse->private;
 795
 796         etd->original_set_rate(psmouse, rate);
 797         if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
 798                 psmouse_err(psmouse, "restoring reg_07 failed\n");
 799 }
 800
 801 /*
 802  * Put the touchpad into absolute mode
 803  */
 804 static int elantech_set_absolute_mode(struct psmouse *psmouse)
 805 {
 806         struct elantech_data *etd = psmouse->private;
 807         unsigned char val;
 808         int tries = ETP_READ_BACK_TRIES;
 809         int rc = 0;
 810
 811         switch (etd->hw_version) {
 812         case 1:
 813                 etd->reg_10 = 0x16;
 814                 etd->reg_11 = 0x8f;
 815                 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
 816                     elantech_write_reg(psmouse, 0x11, etd->reg_11)) {
 817                         rc = -1;
 818                 }
 819                 break;
 820
 821         case 2:
 822                                         /* Windows driver values */
 823                 etd->reg_10 = 0x54;
 824                 etd->reg_11 = 0x88;     /* 0x8a */
 825                 etd->reg_21 = 0x60;     /* 0x00 */
 826                 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
 827                     elantech_write_reg(psmouse, 0x11, etd->reg_11) ||
 828                     elantech_write_reg(psmouse, 0x21, etd->reg_21)) {
 829                         rc = -1;
 830                 }
 831                 break;
 832
 833         case 3:
 834                 if (etd->set_hw_resolution)
 835                         etd->reg_10 = 0x0b;
 836                 else
 837                         etd->reg_10 = 0x01;
 838
 839                 if (elantech_write_reg(psmouse, 0x10, etd->reg_10))
 840                         rc = -1;
 841
 842                 break;
 843
 844         case 4:
 845                 etd->reg_07 = 0x01;
 846                 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
 847                         rc = -1;
 848
 849                 goto skip_readback_reg_10; /* v4 has no reg 0x10 to read */
 850         }
 851
 852         if (rc == 0) {
 853                 /*
 854                  * Read back reg 0x10. For hardware version 1 we must make
 855                  * sure the absolute mode bit is set. For hardware version 2
 856                  * the touchpad is probably initializing and not ready until
 857                  * we read back the value we just wrote.
 858                  */
 859                 do {
 860                         rc = elantech_read_reg(psmouse, 0x10, &val);
 861                         if (rc == 0)
 862                                 break;
 863                         tries--;
 864                         elantech_debug("retrying read (%d).\n", tries);
 865                         msleep(ETP_READ_BACK_DELAY);
 866                 } while (tries > 0);
 867
 868                 if (rc) {
 869                         psmouse_err(psmouse,
 870                                     "failed to read back register 0x10.\n");
 871                 } else if (etd->hw_version == 1 &&
 872                            !(val & ETP_R10_ABSOLUTE_MODE)) {
 873                         psmouse_err(psmouse,
 874                                     "touchpad refuses to switch to absolute mode.\n");
 875                         rc = -1;
 876                 }
 877         }
 878
 879  skip_readback_reg_10:
 880         if (rc)
 881                 psmouse_err(psmouse, "failed to initialise registers.\n");
 882
 883         return rc;
 884 }
 885
 886 static int elantech_set_range(struct psmouse *psmouse,
 887                               unsigned int *x_min, unsigned int *y_min,
 888                               unsigned int *x_max, unsigned int *y_max,
 889                               unsigned int *width)
 890 {
 891         struct elantech_data *etd = psmouse->private;
 892         unsigned char param[3];
 893         unsigned char traces;
 894
 895         switch (etd->hw_version) {
 896         case 1:
 897                 *x_min = ETP_XMIN_V1;
 898                 *y_min = ETP_YMIN_V1;
 899                 *x_max = ETP_XMAX_V1;
 900                 *y_max = ETP_YMAX_V1;
 901                 break;
 902
 903         case 2:
 904                 if (etd->fw_version == 0x020800 ||
 905                     etd->fw_version == 0x020b00 ||
 906                     etd->fw_version == 0x020030) {
 907                         *x_min = ETP_XMIN_V2;
 908                         *y_min = ETP_YMIN_V2;
 909                         *x_max = ETP_XMAX_V2;
 910                         *y_max = ETP_YMAX_V2;
 911                 } else {
 912                         int i;
 913                         int fixed_dpi;
 914
 915                         i = (etd->fw_version > 0x020800 &&
 916                              etd->fw_version < 0x020900) ? 1 : 2;
 917
 918                         if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
 919                                 return -1;
 920
 921                         fixed_dpi = param[1] & 0x10;
 922
 923                         if (((etd->fw_version >> 16) == 0x14) && fixed_dpi) {
 924                                 if (etd->send_cmd(psmouse, ETP_SAMPLE_QUERY, param))
 925                                         return -1;
 926
 927                                 *x_max = (etd->capabilities[1] - i) * param[1] / 2;
 928                                 *y_max = (etd->capabilities[2] - i) * param[2] / 2;
 929                         } else if (etd->fw_version == 0x040216) {
 930                                 *x_max = 819;
 931                                 *y_max = 405;
 932                         } else if (etd->fw_version == 0x040219 || etd->fw_version == 0x040215) {
 933                                 *x_max = 900;
 934                                 *y_max = 500;
 935                         } else {
 936                                 *x_max = (etd->capabilities[1] - i) * 64;
 937                                 *y_max = (etd->capabilities[2] - i) * 64;
 938                         }
 939                 }
 940                 break;
 941
 942         case 3:
 943                 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
 944                         return -1;
 945
 946                 *x_max = (0x0f & param[0]) << 8 | param[1];
 947                 *y_max = (0xf0 & param[0]) << 4 | param[2];
 948                 break;
 949
 950         case 4:
 951                 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
 952                         return -1;
 953
 954                 *x_max = (0x0f & param[0]) << 8 | param[1];
 955                 *y_max = (0xf0 & param[0]) << 4 | param[2];
 956                 traces = etd->capabilities[1];
 957                 if ((traces < 2) || (traces > *x_max))
 958                         return -1;
 959
 960                 *width = *x_max / (traces - 1);
 961                 break;
 962         }
 963
 964         return 0;
 965 }
 966
 967 /*
 968  * (value from firmware) * 10 + 790 = dpi
 969  * we also have to convert dpi to dots/mm (*10/254 to avoid floating point)
 970  */
 971 static unsigned int elantech_convert_res(unsigned int val)
 972 {
 973         return (val * 10 + 790) * 10 / 254;
 974 }
 975
 976 static int elantech_get_resolution_v4(struct psmouse *psmouse,
 977                                       unsigned int *x_res,
 978                                       unsigned int *y_res)
 979 {
 980         unsigned char param[3];
 981
 982         if (elantech_send_cmd(psmouse, ETP_RESOLUTION_QUERY, param))
 983                 return -1;
 984
 985         *x_res = elantech_convert_res(param[1] & 0x0f);
 986         *y_res = elantech_convert_res((param[1] & 0xf0) >> 4);
 987
 988         return 0;
 989 }
 990
 991 /*
 992  * Advertise INPUT_PROP_BUTTONPAD for clickpads. The testing of bit 12 in
 993  * fw_version for this is based on the following fw_version & caps table:
 994  *
 995  * Laptop-model:           fw_version:     caps:           buttons:
 996  * Acer S3                 0x461f00        10, 13, 0e      clickpad
 997  * Acer S7-392             0x581f01        50, 17, 0d      clickpad
 998  * Acer V5-131             0x461f02        01, 16, 0c      clickpad
 999  * Acer V5-551             0x461f00        ?               clickpad
1000  * Asus K53SV              0x450f01        78, 15, 0c      2 hw buttons
1001  * Asus G46VW              0x460f02        00, 18, 0c      2 hw buttons
1002  * Asus G750JX             0x360f00        00, 16, 0c      2 hw buttons
1003  * Asus TP500LN            0x381f17        10, 14, 0e      clickpad
1004  * Asus X750JN             0x381f17        10, 14, 0e      clickpad
1005  * Asus UX31               0x361f00        20, 15, 0e      clickpad
1006  * Asus UX32VD             0x361f02        00, 15, 0e      clickpad
1007  * Avatar AVIU-145A2       0x361f00        ?               clickpad
1008  * Gigabyte U2442          0x450f01        58, 17, 0c      2 hw buttons
1009  * Lenovo L430             0x350f02        b9, 15, 0c      2 hw buttons (*)
1010  * Samsung NF210           0x150b00        78, 14, 0a      2 hw buttons
1011  * Samsung NP770Z5E        0x575f01        10, 15, 0f      clickpad
1012  * Samsung NP700Z5B        0x361f06        21, 15, 0f      clickpad
1013  * Samsung NP900X3E-A02    0x575f03        ?               clickpad
1014  * Samsung NP-QX410        0x851b00        19, 14, 0c      clickpad
1015  * Samsung RC512           0x450f00        08, 15, 0c      2 hw buttons
1016  * Samsung RF710           0x450f00        ?               2 hw buttons
1017  * System76 Pangolin       0x250f01        ?               2 hw buttons
1018  * (*) + 3 trackpoint buttons
1019  */
1020 static void elantech_set_buttonpad_prop(struct psmouse *psmouse)
1021 {
1022         struct input_dev *dev = psmouse->dev;
1023         struct elantech_data *etd = psmouse->private;
1024
1025         if (etd->fw_version & 0x001000) {
1026                 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1027                 __clear_bit(BTN_RIGHT, dev->keybit);
1028         }
1029 }
1030
1031 /*
1032  * Set the appropriate event bits for the input subsystem
1033  */
1034 static int elantech_set_input_params(struct psmouse *psmouse)
1035 {
1036         struct input_dev *dev = psmouse->dev;
1037         struct elantech_data *etd = psmouse->private;
1038         unsigned int x_min = 0, y_min = 0, x_max = 0, y_max = 0, width = 0;
1039         unsigned int x_res = 0, y_res = 0;
1040
1041         if (elantech_set_range(psmouse, &x_min, &y_min, &x_max, &y_max, &width))
1042                 return -1;
1043
1044         __set_bit(INPUT_PROP_POINTER, dev->propbit);
1045         __set_bit(EV_KEY, dev->evbit);
1046         __set_bit(EV_ABS, dev->evbit);
1047         __clear_bit(EV_REL, dev->evbit);
1048
1049         __set_bit(BTN_LEFT, dev->keybit);
1050         __set_bit(BTN_RIGHT, dev->keybit);
1051
1052         __set_bit(BTN_TOUCH, dev->keybit);
1053         __set_bit(BTN_TOOL_FINGER, dev->keybit);
1054         __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1055         __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1056
1057         switch (etd->hw_version) {
1058         case 1:
1059                 /* Rocker button */
1060                 if (etd->fw_version < 0x020000 &&
1061                     (etd->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
1062                         __set_bit(BTN_FORWARD, dev->keybit);
1063                         __set_bit(BTN_BACK, dev->keybit);
1064                 }
1065                 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1066                 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1067                 break;
1068
1069         case 2:
1070                 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1071                 __set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
1072                 /* fall through */
1073         case 3:
1074                 if (etd->hw_version == 3)
1075                         elantech_set_buttonpad_prop(psmouse);
1076                 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1077                 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1078                 if (etd->reports_pressure) {
1079                         input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1080                                              ETP_PMAX_V2, 0, 0);
1081                         input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1082                                              ETP_WMAX_V2, 0, 0);
1083                 }
1084                 input_mt_init_slots(dev, 2, 0);
1085                 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1086                 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1087                 break;
1088
1089         case 4:
1090                 if (elantech_get_resolution_v4(psmouse, &x_res, &y_res)) {
1091                         /*
1092                          * if query failed, print a warning and leave the values
1093                          * zero to resemble synaptics.c behavior.
1094                          */
1095                         psmouse_warn(psmouse, "couldn't query resolution data.\n");
1096                 }
1097                 elantech_set_buttonpad_prop(psmouse);
1098                 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1099                 /* For X to recognize me as touchpad. */
1100                 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1101                 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1102                 input_abs_set_res(dev, ABS_X, x_res);
1103                 input_abs_set_res(dev, ABS_Y, y_res);
1104                 /*
1105                  * range of pressure and width is the same as v2,
1106                  * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
1107                  */
1108                 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1109                                      ETP_PMAX_V2, 0, 0);
1110                 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1111                                      ETP_WMAX_V2, 0, 0);
1112                 /* Multitouch capable pad, up to 5 fingers. */
1113                 input_mt_init_slots(dev, ETP_MAX_FINGERS, 0);
1114                 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1115                 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1116                 input_abs_set_res(dev, ABS_MT_POSITION_X, x_res);
1117                 input_abs_set_res(dev, ABS_MT_POSITION_Y, y_res);
1118                 input_set_abs_params(dev, ABS_MT_PRESSURE, ETP_PMIN_V2,
1119                                      ETP_PMAX_V2, 0, 0);
1120                 /*
1121                  * The firmware reports how many trace lines the finger spans,
1122                  * convert to surface unit as Protocol-B requires.
1123                  */
1124                 input_set_abs_params(dev, ABS_MT_TOUCH_MAJOR, 0,
1125                                      ETP_WMAX_V2 * width, 0, 0);
1126                 break;
1127         }
1128
1129         etd->y_max = y_max;
1130         etd->width = width;
1131
1132         return 0;
1133 }
1134
1135 struct elantech_attr_data {
1136         size_t          field_offset;
1137         unsigned char   reg;
1138 };
1139
1140 /*
1141  * Display a register value by reading a sysfs entry
1142  */
1143 static ssize_t elantech_show_int_attr(struct psmouse *psmouse, void *data,
1144                                         char *buf)
1145 {
1146         struct elantech_data *etd = psmouse->private;
1147         struct elantech_attr_data *attr = data;
1148         unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1149         int rc = 0;
1150
1151         if (attr->reg)
1152                 rc = elantech_read_reg(psmouse, attr->reg, reg);
1153
1154         return sprintf(buf, "0x%02x\n", (attr->reg && rc) ? -1 : *reg);
1155 }
1156
1157 /*
1158  * Write a register value by writing a sysfs entry
1159  */
1160 static ssize_t elantech_set_int_attr(struct psmouse *psmouse,
1161                                      void *data, const char *buf, size_t count)
1162 {
1163         struct elantech_data *etd = psmouse->private;
1164         struct elantech_attr_data *attr = data;
1165         unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1166         unsigned char value;
1167         int err;
1168
1169         err = kstrtou8(buf, 16, &value);
1170         if (err)
1171                 return err;
1172
1173         /* Do we need to preserve some bits for version 2 hardware too? */
1174         if (etd->hw_version == 1) {
1175                 if (attr->reg == 0x10)
1176                         /* Force absolute mode always on */
1177                         value |= ETP_R10_ABSOLUTE_MODE;
1178                 else if (attr->reg == 0x11)
1179                         /* Force 4 byte mode always on */
1180                         value |= ETP_R11_4_BYTE_MODE;
1181         }
1182
1183         if (!attr->reg || elantech_write_reg(psmouse, attr->reg, value) == 0)
1184                 *reg = value;
1185
1186         return count;
1187 }
1188
1189 #define ELANTECH_INT_ATTR(_name, _register)                             \
1190         static struct elantech_attr_data elantech_attr_##_name = {      \
1191                 .field_offset = offsetof(struct elantech_data, _name),  \
1192                 .reg = _register,                                       \
1193         };                                                              \
1194         PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO,                   \
1195                             &elantech_attr_##_name,                     \
1196                             elantech_show_int_attr,                     \
1197                             elantech_set_int_attr)
1198
1199 ELANTECH_INT_ATTR(reg_07, 0x07);
1200 ELANTECH_INT_ATTR(reg_10, 0x10);
1201 ELANTECH_INT_ATTR(reg_11, 0x11);
1202 ELANTECH_INT_ATTR(reg_20, 0x20);
1203 ELANTECH_INT_ATTR(reg_21, 0x21);
1204 ELANTECH_INT_ATTR(reg_22, 0x22);
1205 ELANTECH_INT_ATTR(reg_23, 0x23);
1206 ELANTECH_INT_ATTR(reg_24, 0x24);
1207 ELANTECH_INT_ATTR(reg_25, 0x25);
1208 ELANTECH_INT_ATTR(reg_26, 0x26);
1209 ELANTECH_INT_ATTR(debug, 0);
1210 ELANTECH_INT_ATTR(paritycheck, 0);
1211
1212 static struct attribute *elantech_attrs[] = {
1213         &psmouse_attr_reg_07.dattr.attr,
1214         &psmouse_attr_reg_10.dattr.attr,
1215         &psmouse_attr_reg_11.dattr.attr,
1216         &psmouse_attr_reg_20.dattr.attr,
1217         &psmouse_attr_reg_21.dattr.attr,
1218         &psmouse_attr_reg_22.dattr.attr,
1219         &psmouse_attr_reg_23.dattr.attr,
1220         &psmouse_attr_reg_24.dattr.attr,
1221         &psmouse_attr_reg_25.dattr.attr,
1222         &psmouse_attr_reg_26.dattr.attr,
1223         &psmouse_attr_debug.dattr.attr,
1224         &psmouse_attr_paritycheck.dattr.attr,
1225         NULL
1226 };
1227
1228 static struct attribute_group elantech_attr_group = {
1229         .attrs = elantech_attrs,
1230 };
1231
1232 static bool elantech_is_signature_valid(const unsigned char *param)
1233 {
1234         static const unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10 };
1235         int i;
1236
1237         if (param[0] == 0)
1238                 return false;
1239
1240         if (param[1] == 0)
1241                 return true;
1242
1243         /*
1244          * Some models have a revision higher then 20. Meaning param[2] may
1245          * be 10 or 20, skip the rates check for these.
1246          */
1247         if (param[0] == 0x46 && (param[1] & 0xef) == 0x0f && param[2] < 40)
1248                 return true;
1249
1250         for (i = 0; i < ARRAY_SIZE(rates); i++)
1251                 if (param[2] == rates[i])
1252                         return false;
1253
1254         return true;
1255 }
1256
1257 /*
1258  * Use magic knock to detect Elantech touchpad
1259  */
1260 int elantech_detect(struct psmouse *psmouse, bool set_properties)
1261 {
1262         struct ps2dev *ps2dev = &psmouse->ps2dev;
1263         unsigned char param[3];
1264
1265         ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
1266
1267         if (ps2_command(ps2dev,  NULL, PSMOUSE_CMD_DISABLE) ||
1268             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
1269             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
1270             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
1271             ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
1272                 psmouse_dbg(psmouse, "sending Elantech magic knock failed.\n");
1273                 return -1;
1274         }
1275
1276         /*
1277          * Report this in case there are Elantech models that use a different
1278          * set of magic numbers
1279          */
1280         if (param[0] != 0x3c || param[1] != 0x03 ||
1281             (param[2] != 0xc8 && param[2] != 0x00)) {
1282                 psmouse_dbg(psmouse,
1283                             "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1284                             param[0], param[1], param[2]);
1285                 return -1;
1286         }
1287
1288         /*
1289          * Query touchpad's firmware version and see if it reports known
1290          * value to avoid mis-detection. Logitech mice are known to respond
1291          * to Elantech magic knock and there might be more.
1292          */
1293         if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1294                 psmouse_dbg(psmouse, "failed to query firmware version.\n");
1295                 return -1;
1296         }
1297
1298         psmouse_dbg(psmouse,
1299                     "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1300                     param[0], param[1], param[2]);
1301
1302         if (!elantech_is_signature_valid(param)) {
1303                 psmouse_dbg(psmouse,
1304                             "Probably not a real Elantech touchpad. Aborting.\n");
1305                 return -1;
1306         }
1307
1308         if (set_properties) {
1309                 psmouse->vendor = "Elantech";
1310                 psmouse->name = "Touchpad";
1311         }
1312
1313         return 0;
1314 }
1315
1316 /*
1317  * Clean up sysfs entries when disconnecting
1318  */
1319 static void elantech_disconnect(struct psmouse *psmouse)
1320 {
1321         sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1322                            &elantech_attr_group);
1323         kfree(psmouse->private);
1324         psmouse->private = NULL;
1325 }
1326
1327 /*
1328  * Put the touchpad back into absolute mode when reconnecting
1329  */
1330 static int elantech_reconnect(struct psmouse *psmouse)
1331 {
1332         psmouse_reset(psmouse);
1333
1334         if (elantech_detect(psmouse, 0))
1335                 return -1;
1336
1337         if (elantech_set_absolute_mode(psmouse)) {
1338                 psmouse_err(psmouse,
1339                             "failed to put touchpad back into absolute mode.\n");
1340                 return -1;
1341         }
1342
1343         return 0;
1344 }
1345
1346 /*
1347  * Some hw_version 3 models go into error state when we try to set
1348  * bit 3 and/or bit 1 of r10.
1349  */
1350 static const struct dmi_system_id no_hw_res_dmi_table[] = {
1351 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1352         {
1353                 /* Gigabyte U2442 */
1354                 .matches = {
1355                         DMI_MATCH(DMI_SYS_VENDOR, "GIGABYTE"),
1356                         DMI_MATCH(DMI_PRODUCT_NAME, "U2442"),
1357                 },
1358         },
1359 #endif
1360         { }
1361 };
1362
1363 /*
1364  * determine hardware version and set some properties according to it.
1365  */
1366 static int elantech_set_properties(struct elantech_data *etd)
1367 {
1368         /* This represents the version of IC body. */
1369         int ver = (etd->fw_version & 0x0f0000) >> 16;
1370
1371         /* Early version of Elan touchpads doesn't obey the rule. */
1372         if (etd->fw_version < 0x020030 || etd->fw_version == 0x020600)
1373                 etd->hw_version = 1;
1374         else {
1375                 switch (ver) {
1376                 case 2:
1377                 case 4:
1378                         etd->hw_version = 2;
1379                         break;
1380                 case 5:
1381                         etd->hw_version = 3;
1382                         break;
1383                 case 6:
1384                         etd->hw_version = 4;
1385                         break;
1386                 default:
1387                         return -1;
1388                 }
1389         }
1390
1391         /* decide which send_cmd we're gonna use early */
1392         etd->send_cmd = etd->hw_version >= 3 ? elantech_send_cmd :
1393                                                synaptics_send_cmd;
1394
1395         /* Turn on packet checking by default */
1396         etd->paritycheck = 1;
1397
1398         /*
1399          * This firmware suffers from misreporting coordinates when
1400          * a touch action starts causing the mouse cursor or scrolled page
1401          * to jump. Enable a workaround.
1402          */
1403         etd->jumpy_cursor =
1404                 (etd->fw_version == 0x020022 || etd->fw_version == 0x020600);
1405
1406         if (etd->hw_version > 1) {
1407                 /* For now show extra debug information */
1408                 etd->debug = 1;
1409
1410                 if (etd->fw_version >= 0x020800)
1411                         etd->reports_pressure = true;
1412         }
1413
1414         /* Enable real hardware resolution on hw_version 3 ? */
1415         etd->set_hw_resolution = !dmi_check_system(no_hw_res_dmi_table);
1416
1417         return 0;
1418 }
1419
1420 /*
1421  * Initialize the touchpad and create sysfs entries
1422  */
1423 int elantech_init(struct psmouse *psmouse)
1424 {
1425         struct elantech_data *etd;
1426         int i, error;
1427         unsigned char param[3];
1428
1429         psmouse->private = etd = kzalloc(sizeof(struct elantech_data), GFP_KERNEL);
1430         if (!etd)
1431                 return -ENOMEM;
1432
1433         psmouse_reset(psmouse);
1434
1435         etd->parity[0] = 1;
1436         for (i = 1; i < 256; i++)
1437                 etd->parity[i] = etd->parity[i & (i - 1)] ^ 1;
1438
1439         /*
1440          * Do the version query again so we can store the result
1441          */
1442         if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1443                 psmouse_err(psmouse, "failed to query firmware version.\n");
1444                 goto init_fail;
1445         }
1446         etd->fw_version = (param[0] << 16) | (param[1] << 8) | param[2];
1447
1448         if (elantech_set_properties(etd)) {
1449                 psmouse_err(psmouse, "unknown hardware version, aborting...\n");
1450                 goto init_fail;
1451         }
1452         psmouse_info(psmouse,
1453                      "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
1454                      etd->hw_version, param[0], param[1], param[2]);
1455
1456         if (etd->send_cmd(psmouse, ETP_CAPABILITIES_QUERY,
1457             etd->capabilities)) {
1458                 psmouse_err(psmouse, "failed to query capabilities.\n");
1459                 goto init_fail;
1460         }
1461         psmouse_info(psmouse,
1462                      "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
1463                      etd->capabilities[0], etd->capabilities[1],
1464                      etd->capabilities[2]);
1465
1466         if (elantech_set_absolute_mode(psmouse)) {
1467                 psmouse_err(psmouse,
1468                             "failed to put touchpad into absolute mode.\n");
1469                 goto init_fail;
1470         }
1471
1472         if (etd->fw_version == 0x381f17) {
1473                 etd->original_set_rate = psmouse->set_rate;
1474                 psmouse->set_rate = elantech_set_rate_restore_reg_07;
1475         }
1476
1477         if (elantech_set_input_params(psmouse)) {
1478                 psmouse_err(psmouse, "failed to query touchpad range.\n");
1479                 goto init_fail;
1480         }
1481
1482         error = sysfs_create_group(&psmouse->ps2dev.serio->dev.kobj,
1483                                    &elantech_attr_group);
1484         if (error) {
1485                 psmouse_err(psmouse,
1486                             "failed to create sysfs attributes, error: %d.\n",
1487                             error);
1488                 goto init_fail;
1489         }
1490
1491         psmouse->protocol_handler = elantech_process_byte;
1492         psmouse->disconnect = elantech_disconnect;
1493         psmouse->reconnect = elantech_reconnect;
1494         psmouse->pktsize = etd->hw_version > 1 ? 6 : 4;
1495
1496         return 0;
1497
1498  init_fail:
1499         kfree(etd);
1500         return -1;
1501 }