drivers/input/mouse/synaptics.c

   1 /*
   2  * Synaptics TouchPad PS/2 mouse driver
   3  *
   4  *   2003 Dmitry Torokhov <dtor@mail.ru>
   5  *     Added support for pass-through port. Special thanks to Peter Berg Larsen
   6  *     for explaining various Synaptics quirks.
   7  *
   8  *   2003 Peter Osterlund <petero2@telia.com>
   9  *     Ported to 2.5 input device infrastructure.
  10  *
  11  *   Copyright (C) 2001 Stefan Gmeiner <riddlebox@freesurf.ch>
  12  *     start merging tpconfig and gpm code to a xfree-input module
  13  *     adding some changes and extensions (ex. 3rd and 4th button)
  14  *
  15  *   Copyright (c) 1997 C. Scott Ananian <cananian@alumni.priceton.edu>
  16  *   Copyright (c) 1998-2000 Bruce Kalk <kall@compass.com>
  17  *     code for the special synaptics commands (from the tpconfig-source)
  18  *
  19  * This program is free software; you can redistribute it and/or modify it
  20  * under the terms of the GNU General Public License version 2 as published by
  21  * the Free Software Foundation.
  22  *
  23  * Trademarks are the property of their respective owners.
  24  */
  25
  26 #include <linux/module.h>
  27 #include <linux/delay.h>
  28 #include <linux/dmi.h>
  29 #include <linux/input/mt.h>
  30 #include <linux/serio.h>
  31 #include <linux/libps2.h>
  32 #include <linux/slab.h>
  33 #include "psmouse.h"
  34 #include "synaptics.h"
  35
  36 /*
  37  * The x/y limits are taken from the Synaptics TouchPad interfacing Guide,
  38  * section 2.3.2, which says that they should be valid regardless of the
  39  * actual size of the sensor.
  40  * Note that newer firmware allows querying device for maximum useable
  41  * coordinates.
  42  */
  43 #define XMIN 0
  44 #define XMAX 6143
  45 #define YMIN 0
  46 #define YMAX 6143
  47 #define XMIN_NOMINAL 1472
  48 #define XMAX_NOMINAL 5472
  49 #define YMIN_NOMINAL 1408
  50 #define YMAX_NOMINAL 4448
  51
  52 /* Size in bits of absolute position values reported by the hardware */
  53 #define ABS_POS_BITS 13
  54
  55 /*
  56  * These values should represent the absolute maximum value that will
  57  * be reported for a positive position value. Some Synaptics firmware
  58  * uses this value to indicate a finger near the edge of the touchpad
  59  * whose precise position cannot be determined.
  60  *
  61  * At least one touchpad is known to report positions in excess of this
  62  * value which are actually negative values truncated to the 13-bit
  63  * reporting range. These values have never been observed to be lower
  64  * than 8184 (i.e. -8), so we treat all values greater than 8176 as
  65  * negative and any other value as positive.
  66  */
  67 #define X_MAX_POSITIVE 8176
  68 #define Y_MAX_POSITIVE 8176
  69
  70 /*****************************************************************************
  71  *      Stuff we need even when we do not want native Synaptics support
  72  ****************************************************************************/
  73
  74 /*
  75  * Set the synaptics touchpad mode byte by special commands
  76  */
  77 static int synaptics_mode_cmd(struct psmouse *psmouse, unsigned char mode)
  78 {
  79         unsigned char param[1];
  80
  81         if (psmouse_sliced_command(psmouse, mode))
  82                 return -1;
  83         param[0] = SYN_PS_SET_MODE2;
  84         if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_SETRATE))
  85                 return -1;
  86         return 0;
  87 }
  88
  89 int synaptics_detect(struct psmouse *psmouse, bool set_properties)
  90 {
  91         struct ps2dev *ps2dev = &psmouse->ps2dev;
  92         unsigned char param[4];
  93
  94         param[0] = 0;
  95
  96         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
  97         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
  98         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
  99         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
 100         ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
 101
 102         if (param[1] != 0x47)
 103                 return -ENODEV;
 104
 105         if (set_properties) {
 106                 psmouse->vendor = "Synaptics";
 107                 psmouse->name = "TouchPad";
 108         }
 109
 110         return 0;
 111 }
 112
 113 void synaptics_reset(struct psmouse *psmouse)
 114 {
 115         /* reset touchpad back to relative mode, gestures enabled */
 116         synaptics_mode_cmd(psmouse, 0);
 117 }
 118
 119 #ifdef CONFIG_MOUSE_PS2_SYNAPTICS
 120 struct min_max_quirk {
 121         const char * const *pnp_ids;
 122         int x_min, x_max, y_min, y_max;
 123 };
 124
 125 static const struct min_max_quirk min_max_pnpid_table[] = {
 126         {
 127                 (const char * const []){"LEN0033", NULL},
 128                 1024, 5052, 2258, 4832
 129         },
 130         {
 131                 (const char * const []){"LEN0035", "LEN0042", NULL},
 132                 1232, 5710, 1156, 4696
 133         },
 134         {
 135                 (const char * const []){"LEN0034", "LEN0036", "LEN0039",
 136                                         "LEN2002", "LEN2004", NULL},
 137                 1024, 5112, 2024, 4832
 138         },
 139         {
 140                 (const char * const []){"LEN2001", NULL},
 141                 1024, 5022, 2508, 4832
 142         },
 143         { }
 144 };
 145
 146 /* This list has been kindly provided by Synaptics. */
 147 static const char * const topbuttonpad_pnp_ids[] = {
 148         "LEN0017",
 149         "LEN0018",
 150         "LEN0019",
 151         "LEN0023",
 152         "LEN002A",
 153         "LEN002B",
 154         "LEN002C",
 155         "LEN002D",
 156         "LEN002E",
 157         "LEN0033", /* Helix */
 158         "LEN0034", /* T431s, L440, L540, T540, W540, X1 Carbon 2nd */
 159         "LEN0035", /* X240 */
 160         "LEN0036", /* T440 */
 161         "LEN0037",
 162         "LEN0038",
 163         "LEN0039", /* T440s */
 164         "LEN0041",
 165         "LEN0042", /* Yoga */
 166         "LEN0045",
 167         "LEN0046",
 168         "LEN0047",
 169         "LEN0048",
 170         "LEN0049",
 171         "LEN2000",
 172         "LEN2001", /* Edge E431 */
 173         "LEN2002", /* Edge E531 */
 174         "LEN2003",
 175         "LEN2004", /* L440 */
 176         "LEN2005",
 177         "LEN2006",
 178         "LEN2007",
 179         "LEN2008",
 180         "LEN2009",
 181         "LEN200A",
 182         "LEN200B",
 183         NULL
 184 };
 185
 186 static bool matches_pnp_id(struct psmouse *psmouse, const char * const ids[])
 187 {
 188         int i;
 189
 190         if (!strncmp(psmouse->ps2dev.serio->firmware_id, "PNP:", 4))
 191                 for (i = 0; ids[i]; i++)
 192                         if (strstr(psmouse->ps2dev.serio->firmware_id, ids[i]))
 193                                 return true;
 194
 195         return false;
 196 }
 197
 198 /*****************************************************************************
 199  *      Synaptics communications functions
 200  ****************************************************************************/
 201
 202 /*
 203  * Synaptics touchpads report the y coordinate from bottom to top, which is
 204  * opposite from what userspace expects.
 205  * This function is used to invert y before reporting.
 206  */
 207 static int synaptics_invert_y(int y)
 208 {
 209         return YMAX_NOMINAL + YMIN_NOMINAL - y;
 210 }
 211
 212 /*
 213  * Send a command to the synpatics touchpad by special commands
 214  */
 215 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c, unsigned char *param)
 216 {
 217         if (psmouse_sliced_command(psmouse, c))
 218                 return -1;
 219         if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO))
 220                 return -1;
 221         return 0;
 222 }
 223
 224 /*
 225  * Read the model-id bytes from the touchpad
 226  * see also SYN_MODEL_* macros
 227  */
 228 static int synaptics_model_id(struct psmouse *psmouse)
 229 {
 230         struct synaptics_data *priv = psmouse->private;
 231         unsigned char mi[3];
 232
 233         if (synaptics_send_cmd(psmouse, SYN_QUE_MODEL, mi))
 234                 return -1;
 235         priv->model_id = (mi[0]<<16) | (mi[1]<<8) | mi[2];
 236         return 0;
 237 }
 238
 239 /*
 240  * Read the board id from the touchpad
 241  * The board id is encoded in the "QUERY MODES" response
 242  */
 243 static int synaptics_board_id(struct psmouse *psmouse)
 244 {
 245         struct synaptics_data *priv = psmouse->private;
 246         unsigned char bid[3];
 247
 248         if (synaptics_send_cmd(psmouse, SYN_QUE_MODES, bid))
 249                 return -1;
 250         priv->board_id = ((bid[0] & 0xfc) << 6) | bid[1];
 251         return 0;
 252 }
 253
 254 /*
 255  * Read the firmware id from the touchpad
 256  */
 257 static int synaptics_firmware_id(struct psmouse *psmouse)
 258 {
 259         struct synaptics_data *priv = psmouse->private;
 260         unsigned char fwid[3];
 261
 262         if (synaptics_send_cmd(psmouse, SYN_QUE_FIRMWARE_ID, fwid))
 263                 return -1;
 264         priv->firmware_id = (fwid[0] << 16) | (fwid[1] << 8) | fwid[2];
 265         return 0;
 266 }
 267
 268 /*
 269  * Read the capability-bits from the touchpad
 270  * see also the SYN_CAP_* macros
 271  */
 272 static int synaptics_capability(struct psmouse *psmouse)
 273 {
 274         struct synaptics_data *priv = psmouse->private;
 275         unsigned char cap[3];
 276
 277         if (synaptics_send_cmd(psmouse, SYN_QUE_CAPABILITIES, cap))
 278                 return -1;
 279         priv->capabilities = (cap[0] << 16) | (cap[1] << 8) | cap[2];
 280         priv->ext_cap = priv->ext_cap_0c = 0;
 281
 282         /*
 283          * Older firmwares had submodel ID fixed to 0x47
 284          */
 285         if (SYN_ID_FULL(priv->identity) < 0x705 &&
 286             SYN_CAP_SUBMODEL_ID(priv->capabilities) != 0x47) {
 287                 return -1;
 288         }
 289
 290         /*
 291          * Unless capExtended is set the rest of the flags should be ignored
 292          */
 293         if (!SYN_CAP_EXTENDED(priv->capabilities))
 294                 priv->capabilities = 0;
 295
 296         if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 1) {
 297                 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB, cap)) {
 298                         psmouse_warn(psmouse,
 299                                      "device claims to have extended capabilities, but I'm not able to read them.\n");
 300                 } else {
 301                         priv->ext_cap = (cap[0] << 16) | (cap[1] << 8) | cap[2];
 302
 303                         /*
 304                          * if nExtBtn is greater than 8 it should be considered
 305                          * invalid and treated as 0
 306                          */
 307                         if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) > 8)
 308                                 priv->ext_cap &= 0xff0fff;
 309                 }
 310         }
 311
 312         if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 4) {
 313                 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB_0C, cap)) {
 314                         psmouse_warn(psmouse,
 315                                      "device claims to have extended capability 0x0c, but I'm not able to read it.\n");
 316                 } else {
 317                         priv->ext_cap_0c = (cap[0] << 16) | (cap[1] << 8) | cap[2];
 318                 }
 319         }
 320
 321         return 0;
 322 }
 323
 324 /*
 325  * Identify Touchpad
 326  * See also the SYN_ID_* macros
 327  */
 328 static int synaptics_identify(struct psmouse *psmouse)
 329 {
 330         struct synaptics_data *priv = psmouse->private;
 331         unsigned char id[3];
 332
 333         if (synaptics_send_cmd(psmouse, SYN_QUE_IDENTIFY, id))
 334                 return -1;
 335         priv->identity = (id[0]<<16) | (id[1]<<8) | id[2];
 336         if (SYN_ID_IS_SYNAPTICS(priv->identity))
 337                 return 0;
 338         return -1;
 339 }
 340
 341 /*
 342  * Read touchpad resolution and maximum reported coordinates
 343  * Resolution is left zero if touchpad does not support the query
 344  */
 345
 346 static int synaptics_resolution(struct psmouse *psmouse)
 347 {
 348         struct synaptics_data *priv = psmouse->private;
 349         unsigned char resp[3];
 350         int i;
 351
 352         if (SYN_ID_MAJOR(priv->identity) < 4)
 353                 return 0;
 354
 355         if (synaptics_send_cmd(psmouse, SYN_QUE_RESOLUTION, resp) == 0) {
 356                 if (resp[0] != 0 && (resp[1] & 0x80) && resp[2] != 0) {
 357                         priv->x_res = resp[0]; /* x resolution in units/mm */
 358                         priv->y_res = resp[2]; /* y resolution in units/mm */
 359                 }
 360         }
 361
 362         for (i = 0; min_max_pnpid_table[i].pnp_ids; i++) {
 363                 if (matches_pnp_id(psmouse, min_max_pnpid_table[i].pnp_ids)) {
 364                         priv->x_min = min_max_pnpid_table[i].x_min;
 365                         priv->x_max = min_max_pnpid_table[i].x_max;
 366                         priv->y_min = min_max_pnpid_table[i].y_min;
 367                         priv->y_max = min_max_pnpid_table[i].y_max;
 368                         return 0;
 369                 }
 370         }
 371
 372         if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 5 &&
 373             SYN_CAP_MAX_DIMENSIONS(priv->ext_cap_0c)) {
 374                 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MAX_COORDS, resp)) {
 375                         psmouse_warn(psmouse,
 376                                      "device claims to have max coordinates query, but I'm not able to read it.\n");
 377                 } else {
 378                         priv->x_max = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
 379                         priv->y_max = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
 380                 }
 381         }
 382
 383         if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 7 &&
 384             SYN_CAP_MIN_DIMENSIONS(priv->ext_cap_0c)) {
 385                 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MIN_COORDS, resp)) {
 386                         psmouse_warn(psmouse,
 387                                      "device claims to have min coordinates query, but I'm not able to read it.\n");
 388                 } else {
 389                         priv->x_min = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
 390                         priv->y_min = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
 391                 }
 392         }
 393
 394         return 0;
 395 }
 396
 397 static int synaptics_query_hardware(struct psmouse *psmouse)
 398 {
 399         if (synaptics_identify(psmouse))
 400                 return -1;
 401         if (synaptics_model_id(psmouse))
 402                 return -1;
 403         if (synaptics_firmware_id(psmouse))
 404                 return -1;
 405         if (synaptics_board_id(psmouse))
 406                 return -1;
 407         if (synaptics_capability(psmouse))
 408                 return -1;
 409         if (synaptics_resolution(psmouse))
 410                 return -1;
 411
 412         return 0;
 413 }
 414
 415 static int synaptics_set_advanced_gesture_mode(struct psmouse *psmouse)
 416 {
 417         static unsigned char param = 0xc8;
 418         struct synaptics_data *priv = psmouse->private;
 419
 420         if (!(SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
 421               SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)))
 422                 return 0;
 423
 424         if (psmouse_sliced_command(psmouse, SYN_QUE_MODEL))
 425                 return -1;
 426
 427         if (ps2_command(&psmouse->ps2dev, &param, PSMOUSE_CMD_SETRATE))
 428                 return -1;
 429
 430         /* Advanced gesture mode also sends multi finger data */
 431         priv->capabilities |= BIT(1);
 432
 433         return 0;
 434 }
 435
 436 static int synaptics_set_mode(struct psmouse *psmouse)
 437 {
 438         struct synaptics_data *priv = psmouse->private;
 439
 440         priv->mode = 0;
 441         if (priv->absolute_mode)
 442                 priv->mode |= SYN_BIT_ABSOLUTE_MODE;
 443         if (priv->disable_gesture)
 444                 priv->mode |= SYN_BIT_DISABLE_GESTURE;
 445         if (psmouse->rate >= 80)
 446                 priv->mode |= SYN_BIT_HIGH_RATE;
 447         if (SYN_CAP_EXTENDED(priv->capabilities))
 448                 priv->mode |= SYN_BIT_W_MODE;
 449
 450         if (synaptics_mode_cmd(psmouse, priv->mode))
 451                 return -1;
 452
 453         if (priv->absolute_mode &&
 454             synaptics_set_advanced_gesture_mode(psmouse)) {
 455                 psmouse_err(psmouse, "Advanced gesture mode init failed.\n");
 456                 return -1;
 457         }
 458
 459         return 0;
 460 }
 461
 462 static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate)
 463 {
 464         struct synaptics_data *priv = psmouse->private;
 465
 466         if (rate >= 80) {
 467                 priv->mode |= SYN_BIT_HIGH_RATE;
 468                 psmouse->rate = 80;
 469         } else {
 470                 priv->mode &= ~SYN_BIT_HIGH_RATE;
 471                 psmouse->rate = 40;
 472         }
 473
 474         synaptics_mode_cmd(psmouse, priv->mode);
 475 }
 476
 477 /*****************************************************************************
 478  *      Synaptics pass-through PS/2 port support
 479  ****************************************************************************/
 480 static int synaptics_pt_write(struct serio *serio, unsigned char c)
 481 {
 482         struct psmouse *parent = serio_get_drvdata(serio->parent);
 483         char rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */
 484
 485         if (psmouse_sliced_command(parent, c))
 486                 return -1;
 487         if (ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE))
 488                 return -1;
 489         return 0;
 490 }
 491
 492 static int synaptics_pt_start(struct serio *serio)
 493 {
 494         struct psmouse *parent = serio_get_drvdata(serio->parent);
 495         struct synaptics_data *priv = parent->private;
 496
 497         serio_pause_rx(parent->ps2dev.serio);
 498         priv->pt_port = serio;
 499         serio_continue_rx(parent->ps2dev.serio);
 500
 501         return 0;
 502 }
 503
 504 static void synaptics_pt_stop(struct serio *serio)
 505 {
 506         struct psmouse *parent = serio_get_drvdata(serio->parent);
 507         struct synaptics_data *priv = parent->private;
 508
 509         serio_pause_rx(parent->ps2dev.serio);
 510         priv->pt_port = NULL;
 511         serio_continue_rx(parent->ps2dev.serio);
 512 }
 513
 514 static int synaptics_is_pt_packet(unsigned char *buf)
 515 {
 516         return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4;
 517 }
 518
 519 static void synaptics_pass_pt_packet(struct serio *ptport, unsigned char *packet)
 520 {
 521         struct psmouse *child = serio_get_drvdata(ptport);
 522
 523         if (child && child->state == PSMOUSE_ACTIVATED) {
 524                 serio_interrupt(ptport, packet[1], 0);
 525                 serio_interrupt(ptport, packet[4], 0);
 526                 serio_interrupt(ptport, packet[5], 0);
 527                 if (child->pktsize == 4)
 528                         serio_interrupt(ptport, packet[2], 0);
 529         } else
 530                 serio_interrupt(ptport, packet[1], 0);
 531 }
 532
 533 static void synaptics_pt_activate(struct psmouse *psmouse)
 534 {
 535         struct synaptics_data *priv = psmouse->private;
 536         struct psmouse *child = serio_get_drvdata(priv->pt_port);
 537
 538         /* adjust the touchpad to child's choice of protocol */
 539         if (child) {
 540                 if (child->pktsize == 4)
 541                         priv->mode |= SYN_BIT_FOUR_BYTE_CLIENT;
 542                 else
 543                         priv->mode &= ~SYN_BIT_FOUR_BYTE_CLIENT;
 544
 545                 if (synaptics_mode_cmd(psmouse, priv->mode))
 546                         psmouse_warn(psmouse,
 547                                      "failed to switch guest protocol\n");
 548         }
 549 }
 550
 551 static void synaptics_pt_create(struct psmouse *psmouse)
 552 {
 553         struct serio *serio;
 554
 555         serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
 556         if (!serio) {
 557                 psmouse_err(psmouse,
 558                             "not enough memory for pass-through port\n");
 559                 return;
 560         }
 561
 562         serio->id.type = SERIO_PS_PSTHRU;
 563         strlcpy(serio->name, "Synaptics pass-through", sizeof(serio->name));
 564         strlcpy(serio->phys, "synaptics-pt/serio0", sizeof(serio->name));
 565         serio->write = synaptics_pt_write;
 566         serio->start = synaptics_pt_start;
 567         serio->stop = synaptics_pt_stop;
 568         serio->parent = psmouse->ps2dev.serio;
 569
 570         psmouse->pt_activate = synaptics_pt_activate;
 571
 572         psmouse_info(psmouse, "serio: %s port at %s\n",
 573                      serio->name, psmouse->phys);
 574         serio_register_port(serio);
 575 }
 576
 577 /*****************************************************************************
 578  *      Functions to interpret the absolute mode packets
 579  ****************************************************************************/
 580
 581 static void synaptics_mt_state_set(struct synaptics_mt_state *state, int count,
 582                                    int sgm, int agm)
 583 {
 584         state->count = count;
 585         state->sgm = sgm;
 586         state->agm = agm;
 587 }
 588
 589 static void synaptics_parse_agm(const unsigned char buf[],
 590                                 struct synaptics_data *priv,
 591                                 struct synaptics_hw_state *hw)
 592 {
 593         struct synaptics_hw_state *agm = &priv->agm;
 594         int agm_packet_type;
 595
 596         agm_packet_type = (buf[5] & 0x30) >> 4;
 597         switch (agm_packet_type) {
 598         case 1:
 599                 /* Gesture packet: (x, y, z) half resolution */
 600                 agm->w = hw->w;
 601                 agm->x = (((buf[4] & 0x0f) << 8) | buf[1]) << 1;
 602                 agm->y = (((buf[4] & 0xf0) << 4) | buf[2]) << 1;
 603                 agm->z = ((buf[3] & 0x30) | (buf[5] & 0x0f)) << 1;
 604                 break;
 605
 606         case 2:
 607                 /* AGM-CONTACT packet: (count, sgm, agm) */
 608                 synaptics_mt_state_set(&agm->mt_state, buf[1], buf[2], buf[4]);
 609                 break;
 610
 611         default:
 612                 break;
 613         }
 614
 615         /* Record that at least one AGM has been received since last SGM */
 616         priv->agm_pending = true;
 617 }
 618
 619 static int synaptics_parse_hw_state(const unsigned char buf[],
 620                                     struct synaptics_data *priv,
 621                                     struct synaptics_hw_state *hw)
 622 {
 623         memset(hw, 0, sizeof(struct synaptics_hw_state));
 624
 625         if (SYN_MODEL_NEWABS(priv->model_id)) {
 626                 hw->w = (((buf[0] & 0x30) >> 2) |
 627                          ((buf[0] & 0x04) >> 1) |
 628                          ((buf[3] & 0x04) >> 2));
 629
 630                 if ((SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
 631                         SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) &&
 632                     hw->w == 2) {
 633                         synaptics_parse_agm(buf, priv, hw);
 634                         return 1;
 635                 }
 636
 637                 hw->x = (((buf[3] & 0x10) << 8) |
 638                          ((buf[1] & 0x0f) << 8) |
 639                          buf[4]);
 640                 hw->y = (((buf[3] & 0x20) << 7) |
 641                          ((buf[1] & 0xf0) << 4) |
 642                          buf[5]);
 643                 hw->z = buf[2];
 644
 645                 hw->left  = (buf[0] & 0x01) ? 1 : 0;
 646                 hw->right = (buf[0] & 0x02) ? 1 : 0;
 647
 648                 if (SYN_CAP_FORCEPAD(priv->ext_cap_0c)) {
 649                         /*
 650                          * ForcePads, like Clickpads, use middle button
 651                          * bits to report primary button clicks.
 652                          * Unfortunately they report primary button not
 653                          * only when user presses on the pad above certain
 654                          * threshold, but also when there are more than one
 655                          * finger on the touchpad, which interferes with
 656                          * out multi-finger gestures.
 657                          */
 658                         if (hw->z == 0) {
 659                                 /* No contacts */
 660                                 priv->press = priv->report_press = false;
 661                         } else if (hw->w >= 4 && ((buf[0] ^ buf[3]) & 0x01)) {
 662                                 /*
 663                                  * Single-finger touch with pressure above
 664                                  * the threshold. If pressure stays long
 665                                  * enough, we'll start reporting primary
 666                                  * button. We rely on the device continuing
 667                                  * sending data even if finger does not
 668                                  * move.
 669                                  */
 670                                 if  (!priv->press) {
 671                                         priv->press_start = jiffies;
 672                                         priv->press = true;
 673                                 } else if (time_after(jiffies,
 674                                                 priv->press_start +
 675                                                         msecs_to_jiffies(50))) {
 676                                         priv->report_press = true;
 677                                 }
 678                         } else {
 679                                 priv->press = false;
 680                         }
 681
 682                         hw->left = priv->report_press;
 683
 684                 } else if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
 685                         /*
 686                          * Clickpad's button is transmitted as middle button,
 687                          * however, since it is primary button, we will report
 688                          * it as BTN_LEFT.
 689                          */
 690                         hw->left = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
 691
 692                 } else if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
 693                         hw->middle = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
 694                         if (hw->w == 2)
 695                                 hw->scroll = (signed char)(buf[1]);
 696                 }
 697
 698                 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
 699                         hw->up   = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
 700                         hw->down = ((buf[0] ^ buf[3]) & 0x02) ? 1 : 0;
 701                 }
 702
 703                 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) &&
 704                     ((buf[0] ^ buf[3]) & 0x02)) {
 705                         switch (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) & ~0x01) {
 706                         default:
 707                                 /*
 708                                  * if nExtBtn is greater than 8 it should be
 709                                  * considered invalid and treated as 0
 710                                  */
 711                                 break;
 712                         case 8:
 713                                 hw->ext_buttons |= ((buf[5] & 0x08)) ? 0x80 : 0;
 714                                 hw->ext_buttons |= ((buf[4] & 0x08)) ? 0x40 : 0;
 715                         case 6:
 716                                 hw->ext_buttons |= ((buf[5] & 0x04)) ? 0x20 : 0;
 717                                 hw->ext_buttons |= ((buf[4] & 0x04)) ? 0x10 : 0;
 718                         case 4:
 719                                 hw->ext_buttons |= ((buf[5] & 0x02)) ? 0x08 : 0;
 720                                 hw->ext_buttons |= ((buf[4] & 0x02)) ? 0x04 : 0;
 721                         case 2:
 722                                 hw->ext_buttons |= ((buf[5] & 0x01)) ? 0x02 : 0;
 723                                 hw->ext_buttons |= ((buf[4] & 0x01)) ? 0x01 : 0;
 724                         }
 725                 }
 726         } else {
 727                 hw->x = (((buf[1] & 0x1f) << 8) | buf[2]);
 728                 hw->y = (((buf[4] & 0x1f) << 8) | buf[5]);
 729
 730                 hw->z = (((buf[0] & 0x30) << 2) | (buf[3] & 0x3F));
 731                 hw->w = (((buf[1] & 0x80) >> 4) | ((buf[0] & 0x04) >> 1));
 732
 733                 hw->left  = (buf[0] & 0x01) ? 1 : 0;
 734                 hw->right = (buf[0] & 0x02) ? 1 : 0;
 735         }
 736
 737         /*
 738          * Convert wrap-around values to negative. (X|Y)_MAX_POSITIVE
 739          * is used by some firmware to indicate a finger at the edge of
 740          * the touchpad whose precise position cannot be determined, so
 741          * convert these values to the maximum axis value.
 742          */
 743         if (hw->x > X_MAX_POSITIVE)
 744                 hw->x -= 1 << ABS_POS_BITS;
 745         else if (hw->x == X_MAX_POSITIVE)
 746                 hw->x = XMAX;
 747
 748         if (hw->y > Y_MAX_POSITIVE)
 749                 hw->y -= 1 << ABS_POS_BITS;
 750         else if (hw->y == Y_MAX_POSITIVE)
 751                 hw->y = YMAX;
 752
 753         return 0;
 754 }
 755
 756 static void synaptics_report_semi_mt_slot(struct input_dev *dev, int slot,
 757                                           bool active, int x, int y)
 758 {
 759         input_mt_slot(dev, slot);
 760         input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
 761         if (active) {
 762                 input_report_abs(dev, ABS_MT_POSITION_X, x);
 763                 input_report_abs(dev, ABS_MT_POSITION_Y, synaptics_invert_y(y));
 764         }
 765 }
 766
 767 static void synaptics_report_semi_mt_data(struct input_dev *dev,
 768                                           const struct synaptics_hw_state *a,
 769                                           const struct synaptics_hw_state *b,
 770                                           int num_fingers)
 771 {
 772         if (num_fingers >= 2) {
 773                 synaptics_report_semi_mt_slot(dev, 0, true, min(a->x, b->x),
 774                                               min(a->y, b->y));
 775                 synaptics_report_semi_mt_slot(dev, 1, true, max(a->x, b->x),
 776                                               max(a->y, b->y));
 777         } else if (num_fingers == 1) {
 778                 synaptics_report_semi_mt_slot(dev, 0, true, a->x, a->y);
 779                 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
 780         } else {
 781                 synaptics_report_semi_mt_slot(dev, 0, false, 0, 0);
 782                 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
 783         }
 784 }
 785
 786 static void synaptics_report_buttons(struct psmouse *psmouse,
 787                                      const struct synaptics_hw_state *hw)
 788 {
 789         struct input_dev *dev = psmouse->dev;
 790         struct synaptics_data *priv = psmouse->private;
 791         int i;
 792
 793         input_report_key(dev, BTN_LEFT, hw->left);
 794         input_report_key(dev, BTN_RIGHT, hw->right);
 795
 796         if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
 797                 input_report_key(dev, BTN_MIDDLE, hw->middle);
 798
 799         if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
 800                 input_report_key(dev, BTN_FORWARD, hw->up);
 801                 input_report_key(dev, BTN_BACK, hw->down);
 802         }
 803
 804         for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
 805                 input_report_key(dev, BTN_0 + i, hw->ext_buttons & (1 << i));
 806 }
 807
 808 static void synaptics_report_slot(struct input_dev *dev, int slot,
 809                                   const struct synaptics_hw_state *hw)
 810 {
 811         input_mt_slot(dev, slot);
 812         input_mt_report_slot_state(dev, MT_TOOL_FINGER, (hw != NULL));
 813         if (!hw)
 814                 return;
 815
 816         input_report_abs(dev, ABS_MT_POSITION_X, hw->x);
 817         input_report_abs(dev, ABS_MT_POSITION_Y, synaptics_invert_y(hw->y));
 818         input_report_abs(dev, ABS_MT_PRESSURE, hw->z);
 819 }
 820
 821 static void synaptics_report_mt_data(struct psmouse *psmouse,
 822                                      struct synaptics_mt_state *mt_state,
 823                                      const struct synaptics_hw_state *sgm)
 824 {
 825         struct input_dev *dev = psmouse->dev;
 826         struct synaptics_data *priv = psmouse->private;
 827         struct synaptics_hw_state *agm = &priv->agm;
 828         struct synaptics_mt_state *old = &priv->mt_state;
 829
 830         switch (mt_state->count) {
 831         case 0:
 832                 synaptics_report_slot(dev, 0, NULL);
 833                 synaptics_report_slot(dev, 1, NULL);
 834                 break;
 835         case 1:
 836                 if (mt_state->sgm == -1) {
 837                         synaptics_report_slot(dev, 0, NULL);
 838                         synaptics_report_slot(dev, 1, NULL);
 839                 } else if (mt_state->sgm == 0) {
 840                         synaptics_report_slot(dev, 0, sgm);
 841                         synaptics_report_slot(dev, 1, NULL);
 842                 } else {
 843                         synaptics_report_slot(dev, 0, NULL);
 844                         synaptics_report_slot(dev, 1, sgm);
 845                 }
 846                 break;
 847         default:
 848                 /*
 849                  * If the finger slot contained in SGM is valid, and either
 850                  * hasn't changed, or is new, or the old SGM has now moved to
 851                  * AGM, then report SGM in MTB slot 0.
 852                  * Otherwise, empty MTB slot 0.
 853                  */
 854                 if (mt_state->sgm != -1 &&
 855                     (mt_state->sgm == old->sgm ||
 856                      old->sgm == -1 || mt_state->agm == old->sgm))
 857                         synaptics_report_slot(dev, 0, sgm);
 858                 else
 859                         synaptics_report_slot(dev, 0, NULL);
 860
 861                 /*
 862                  * If the finger slot contained in AGM is valid, and either
 863                  * hasn't changed, or is new, then report AGM in MTB slot 1.
 864                  * Otherwise, empty MTB slot 1.
 865                  *
 866                  * However, in the case where the AGM is new, make sure that
 867                  * that it is either the same as the old SGM, or there was no
 868                  * SGM.
 869                  *
 870                  * Otherwise, if the SGM was just 1, and the new AGM is 2, then
 871                  * the new AGM will keep the old SGM's tracking ID, which can
 872                  * cause apparent drumroll.  This happens if in the following
 873                  * valid finger sequence:
 874                  *
 875                  *  Action                 SGM  AGM (MTB slot:Contact)
 876                  *  1. Touch contact 0    (0:0)
 877                  *  2. Touch contact 1    (0:0, 1:1)
 878                  *  3. Lift  contact 0    (1:1)
 879                  *  4. Touch contacts 2,3 (0:2, 1:3)
 880                  *
 881                  * In step 4, contact 3, in AGM must not be given the same
 882                  * tracking ID as contact 1 had in step 3.  To avoid this,
 883                  * the first agm with contact 3 is dropped and slot 1 is
 884                  * invalidated (tracking ID = -1).
 885                  */
 886                 if (mt_state->agm != -1 &&
 887                     (mt_state->agm == old->agm ||
 888                      (old->agm == -1 &&
 889                       (old->sgm == -1 || mt_state->agm == old->sgm))))
 890                         synaptics_report_slot(dev, 1, agm);
 891                 else
 892                         synaptics_report_slot(dev, 1, NULL);
 893                 break;
 894         }
 895
 896         /* Don't use active slot count to generate BTN_TOOL events. */
 897         input_mt_report_pointer_emulation(dev, false);
 898
 899         /* Send the number of fingers reported by touchpad itself. */
 900         input_mt_report_finger_count(dev, mt_state->count);
 901
 902         synaptics_report_buttons(psmouse, sgm);
 903
 904         input_sync(dev);
 905 }
 906
 907 /* Handle case where mt_state->count = 0 */
 908 static void synaptics_image_sensor_0f(struct synaptics_data *priv,
 909                                       struct synaptics_mt_state *mt_state)
 910 {
 911         synaptics_mt_state_set(mt_state, 0, -1, -1);
 912         priv->mt_state_lost = false;
 913 }
 914
 915 /* Handle case where mt_state->count = 1 */
 916 static void synaptics_image_sensor_1f(struct synaptics_data *priv,
 917                                       struct synaptics_mt_state *mt_state)
 918 {
 919         struct synaptics_hw_state *agm = &priv->agm;
 920         struct synaptics_mt_state *old = &priv->mt_state;
 921
 922         /*
 923          * If the last AGM was (0,0,0), and there is only one finger left,
 924          * then we absolutely know that SGM contains slot 0, and all other
 925          * fingers have been removed.
 926          */
 927         if (priv->agm_pending && agm->z == 0) {
 928                 synaptics_mt_state_set(mt_state, 1, 0, -1);
 929                 priv->mt_state_lost = false;
 930                 return;
 931         }
 932
 933         switch (old->count) {
 934         case 0:
 935                 synaptics_mt_state_set(mt_state, 1, 0, -1);
 936                 break;
 937         case 1:
 938                 /*
 939                  * If mt_state_lost, then the previous transition was 3->1,
 940                  * and SGM now contains either slot 0 or 1, but we don't know
 941                  * which.  So, we just assume that the SGM now contains slot 1.
 942                  *
 943                  * If pending AGM and either:
 944                  *   (a) the previous SGM slot contains slot 0, or
 945                  *   (b) there was no SGM slot
 946                  * then, the SGM now contains slot 1
 947                  *
 948                  * Case (a) happens with very rapid "drum roll" gestures, where
 949                  * slot 0 finger is lifted and a new slot 1 finger touches
 950                  * within one reporting interval.
 951                  *
 952                  * Case (b) happens if initially two or more fingers tap
 953                  * briefly, and all but one lift before the end of the first
 954                  * reporting interval.
 955                  *
 956                  * (In both these cases, slot 0 will becomes empty, so SGM
 957                  * contains slot 1 with the new finger)
 958                  *
 959                  * Else, if there was no previous SGM, it now contains slot 0.
 960                  *
 961                  * Otherwise, SGM still contains the same slot.
 962                  */
 963                 if (priv->mt_state_lost ||
 964                     (priv->agm_pending && old->sgm <= 0))
 965                         synaptics_mt_state_set(mt_state, 1, 1, -1);
 966                 else if (old->sgm == -1)
 967                         synaptics_mt_state_set(mt_state, 1, 0, -1);
 968                 break;
 969         case 2:
 970                 /*
 971                  * If mt_state_lost, we don't know which finger SGM contains.
 972                  *
 973                  * So, report 1 finger, but with both slots empty.
 974                  * We will use slot 1 on subsequent 1->1
 975                  */
 976                 if (priv->mt_state_lost) {
 977                         synaptics_mt_state_set(mt_state, 1, -1, -1);
 978                         break;
 979                 }
 980                 /*
 981                  * Since the last AGM was NOT (0,0,0), it was the finger in
 982                  * slot 0 that has been removed.
 983                  * So, SGM now contains previous AGM's slot, and AGM is now
 984                  * empty.
 985                  */
 986                 synaptics_mt_state_set(mt_state, 1, old->agm, -1);
 987                 break;
 988         case 3:
 989                 /*
 990                  * Since last AGM was not (0,0,0), we don't know which finger
 991                  * is left.
 992                  *
 993                  * So, report 1 finger, but with both slots empty.
 994                  * We will use slot 1 on subsequent 1->1
 995                  */
 996                 synaptics_mt_state_set(mt_state, 1, -1, -1);
 997                 priv->mt_state_lost = true;
 998                 break;
 999         case 4:
1000         case 5:
1001                 /* mt_state was updated by AGM-CONTACT packet */
1002                 break;
1003         }
1004 }
1005
1006 /* Handle case where mt_state->count = 2 */
1007 static void synaptics_image_sensor_2f(struct synaptics_data *priv,
1008                                       struct synaptics_mt_state *mt_state)
1009 {
1010         struct synaptics_mt_state *old = &priv->mt_state;
1011
1012         switch (old->count) {
1013         case 0:
1014                 synaptics_mt_state_set(mt_state, 2, 0, 1);
1015                 break;
1016         case 1:
1017                 /*
1018                  * If previous SGM contained slot 1 or higher, SGM now contains
1019                  * slot 0 (the newly touching finger) and AGM contains SGM's
1020                  * previous slot.
1021                  *
1022                  * Otherwise, SGM still contains slot 0 and AGM now contains
1023                  * slot 1.
1024                  */
1025                 if (old->sgm >= 1)
1026                         synaptics_mt_state_set(mt_state, 2, 0, old->sgm);
1027                 else
1028                         synaptics_mt_state_set(mt_state, 2, 0, 1);
1029                 break;
1030         case 2:
1031                 /*
1032                  * If mt_state_lost, SGM now contains either finger 1 or 2, but
1033                  * we don't know which.
1034                  * So, we just assume that the SGM contains slot 0 and AGM 1.
1035                  */
1036                 if (priv->mt_state_lost)
1037                         synaptics_mt_state_set(mt_state, 2, 0, 1);
1038                 /*
1039                  * Otherwise, use the same mt_state, since it either hasn't
1040                  * changed, or was updated by a recently received AGM-CONTACT
1041                  * packet.
1042                  */
1043                 break;
1044         case 3:
1045                 /*
1046                  * 3->2 transitions have two unsolvable problems:
1047                  *  1) no indication is given which finger was removed
1048                  *  2) no way to tell if agm packet was for finger 3
1049                  *     before 3->2, or finger 2 after 3->2.
1050                  *
1051                  * So, report 2 fingers, but empty all slots.
1052                  * We will guess slots [0,1] on subsequent 2->2.
1053                  */
1054                 synaptics_mt_state_set(mt_state, 2, -1, -1);
1055                 priv->mt_state_lost = true;
1056                 break;
1057         case 4:
1058         case 5:
1059                 /* mt_state was updated by AGM-CONTACT packet */
1060                 break;
1061         }
1062 }
1063
1064 /* Handle case where mt_state->count = 3 */
1065 static void synaptics_image_sensor_3f(struct synaptics_data *priv,
1066                                       struct synaptics_mt_state *mt_state)
1067 {
1068         struct synaptics_mt_state *old = &priv->mt_state;
1069
1070         switch (old->count) {
1071         case 0:
1072                 synaptics_mt_state_set(mt_state, 3, 0, 2);
1073                 break;
1074         case 1:
1075                 /*
1076                  * If previous SGM contained slot 2 or higher, SGM now contains
1077                  * slot 0 (one of the newly touching fingers) and AGM contains
1078                  * SGM's previous slot.
1079                  *
1080                  * Otherwise, SGM now contains slot 0 and AGM contains slot 2.
1081                  */
1082                 if (old->sgm >= 2)
1083                         synaptics_mt_state_set(mt_state, 3, 0, old->sgm);
1084                 else
1085                         synaptics_mt_state_set(mt_state, 3, 0, 2);
1086                 break;
1087         case 2:
1088                 /*
1089                  * If the AGM previously contained slot 3 or higher, then the
1090                  * newly touching finger is in the lowest available slot.
1091                  *
1092                  * If SGM was previously 1 or higher, then the new SGM is
1093                  * now slot 0 (with a new finger), otherwise, the new finger
1094                  * is now in a hidden slot between 0 and AGM's slot.
1095                  *
1096                  * In all such cases, the SGM now contains slot 0, and the AGM
1097                  * continues to contain the same slot as before.
1098                  */
1099                 if (old->agm >= 3) {
1100                         synaptics_mt_state_set(mt_state, 3, 0, old->agm);
1101                         break;
1102                 }
1103
1104                 /*
1105                  * After some 3->1 and all 3->2 transitions, we lose track
1106                  * of which slot is reported by SGM and AGM.
1107                  *
1108                  * For 2->3 in this state, report 3 fingers, but empty all
1109                  * slots, and we will guess (0,2) on a subsequent 0->3.
1110                  *
1111                  * To userspace, the resulting transition will look like:
1112                  *    2:[0,1] -> 3:[-1,-1] -> 3:[0,2]
1113                  */
1114                 if (priv->mt_state_lost) {
1115                         synaptics_mt_state_set(mt_state, 3, -1, -1);
1116                         break;
1117                 }
1118
1119                 /*
1120                  * If the (SGM,AGM) really previously contained slots (0, 1),
1121                  * then we cannot know what slot was just reported by the AGM,
1122                  * because the 2->3 transition can occur either before or after
1123                  * the AGM packet. Thus, this most recent AGM could contain
1124                  * either the same old slot 1 or the new slot 2.
1125                  * Subsequent AGMs will be reporting slot 2.
1126                  *
1127                  * To userspace, the resulting transition will look like:
1128                  *    2:[0,1] -> 3:[0,-1] -> 3:[0,2]
1129                  */
1130                 synaptics_mt_state_set(mt_state, 3, 0, -1);
1131                 break;
1132         case 3:
1133                 /*
1134                  * If, for whatever reason, the previous agm was invalid,
1135                  * Assume SGM now contains slot 0, AGM now contains slot 2.
1136                  */
1137                 if (old->agm <= 2)
1138                         synaptics_mt_state_set(mt_state, 3, 0, 2);
1139                 /*
1140                  * mt_state either hasn't changed, or was updated by a recently
1141                  * received AGM-CONTACT packet.
1142                  */
1143                 break;
1144
1145         case 4:
1146         case 5:
1147                 /* mt_state was updated by AGM-CONTACT packet */
1148                 break;
1149         }
1150 }
1151
1152 /* Handle case where mt_state->count = 4, or = 5 */
1153 static void synaptics_image_sensor_45f(struct synaptics_data *priv,
1154                                        struct synaptics_mt_state *mt_state)
1155 {
1156         /* mt_state was updated correctly by AGM-CONTACT packet */
1157         priv->mt_state_lost = false;
1158 }
1159
1160 static void synaptics_image_sensor_process(struct psmouse *psmouse,
1161                                            struct synaptics_hw_state *sgm)
1162 {
1163         struct synaptics_data *priv = psmouse->private;
1164         struct synaptics_hw_state *agm = &priv->agm;
1165         struct synaptics_mt_state mt_state;
1166
1167         /* Initialize using current mt_state (as updated by last agm) */
1168         mt_state = agm->mt_state;
1169
1170         /*
1171          * Update mt_state using the new finger count and current mt_state.
1172          */
1173         if (sgm->z == 0)
1174                 synaptics_image_sensor_0f(priv, &mt_state);
1175         else if (sgm->w >= 4)
1176                 synaptics_image_sensor_1f(priv, &mt_state);
1177         else if (sgm->w == 0)
1178                 synaptics_image_sensor_2f(priv, &mt_state);
1179         else if (sgm->w == 1 && mt_state.count <= 3)
1180                 synaptics_image_sensor_3f(priv, &mt_state);
1181         else
1182                 synaptics_image_sensor_45f(priv, &mt_state);
1183
1184         /* Send resulting input events to user space */
1185         synaptics_report_mt_data(psmouse, &mt_state, sgm);
1186
1187         /* Store updated mt_state */
1188         priv->mt_state = agm->mt_state = mt_state;
1189         priv->agm_pending = false;
1190 }
1191
1192 /*
1193  *  called for each full received packet from the touchpad
1194  */
1195 static void synaptics_process_packet(struct psmouse *psmouse)
1196 {
1197         struct input_dev *dev = psmouse->dev;
1198         struct synaptics_data *priv = psmouse->private;
1199         struct synaptics_hw_state hw;
1200         int num_fingers;
1201         int finger_width;
1202
1203         if (synaptics_parse_hw_state(psmouse->packet, priv, &hw))
1204                 return;
1205
1206         if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
1207                 synaptics_image_sensor_process(psmouse, &hw);
1208                 return;
1209         }
1210
1211         if (hw.scroll) {
1212                 priv->scroll += hw.scroll;
1213
1214                 while (priv->scroll >= 4) {
1215                         input_report_key(dev, BTN_BACK, !hw.down);
1216                         input_sync(dev);
1217                         input_report_key(dev, BTN_BACK, hw.down);
1218                         input_sync(dev);
1219                         priv->scroll -= 4;
1220                 }
1221                 while (priv->scroll <= -4) {
1222                         input_report_key(dev, BTN_FORWARD, !hw.up);
1223                         input_sync(dev);
1224                         input_report_key(dev, BTN_FORWARD, hw.up);
1225                         input_sync(dev);
1226                         priv->scroll += 4;
1227                 }
1228                 return;
1229         }
1230
1231         if (hw.z > 0 && hw.x > 1) {
1232                 num_fingers = 1;
1233                 finger_width = 5;
1234                 if (SYN_CAP_EXTENDED(priv->capabilities)) {
1235                         switch (hw.w) {
1236                         case 0 ... 1:
1237                                 if (SYN_CAP_MULTIFINGER(priv->capabilities))
1238                                         num_fingers = hw.w + 2;
1239                                 break;
1240                         case 2:
1241                                 if (SYN_MODEL_PEN(priv->model_id))
1242                                         ;   /* Nothing, treat a pen as a single finger */
1243                                 break;
1244                         case 4 ... 15:
1245                                 if (SYN_CAP_PALMDETECT(priv->capabilities))
1246                                         finger_width = hw.w;
1247                                 break;
1248                         }
1249                 }
1250         } else {
1251                 num_fingers = 0;
1252                 finger_width = 0;
1253         }
1254
1255         if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c))
1256                 synaptics_report_semi_mt_data(dev, &hw, &priv->agm,
1257                                               num_fingers);
1258
1259         /* Post events
1260          * BTN_TOUCH has to be first as mousedev relies on it when doing
1261          * absolute -> relative conversion
1262          */
1263         if (hw.z > 30) input_report_key(dev, BTN_TOUCH, 1);
1264         if (hw.z < 25) input_report_key(dev, BTN_TOUCH, 0);
1265
1266         if (num_fingers > 0) {
1267                 input_report_abs(dev, ABS_X, hw.x);
1268                 input_report_abs(dev, ABS_Y, synaptics_invert_y(hw.y));
1269         }
1270         input_report_abs(dev, ABS_PRESSURE, hw.z);
1271
1272         if (SYN_CAP_PALMDETECT(priv->capabilities))
1273                 input_report_abs(dev, ABS_TOOL_WIDTH, finger_width);
1274
1275         input_report_key(dev, BTN_TOOL_FINGER, num_fingers == 1);
1276         if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
1277                 input_report_key(dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
1278                 input_report_key(dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
1279         }
1280
1281         synaptics_report_buttons(psmouse, &hw);
1282
1283         input_sync(dev);
1284 }
1285
1286 static int synaptics_validate_byte(struct psmouse *psmouse,
1287                                    int idx, unsigned char pkt_type)
1288 {
1289         static const unsigned char newabs_mask[]        = { 0xC8, 0x00, 0x00, 0xC8, 0x00 };
1290         static const unsigned char newabs_rel_mask[]    = { 0xC0, 0x00, 0x00, 0xC0, 0x00 };
1291         static const unsigned char newabs_rslt[]        = { 0x80, 0x00, 0x00, 0xC0, 0x00 };
1292         static const unsigned char oldabs_mask[]        = { 0xC0, 0x60, 0x00, 0xC0, 0x60 };
1293         static const unsigned char oldabs_rslt[]        = { 0xC0, 0x00, 0x00, 0x80, 0x00 };
1294         const char *packet = psmouse->packet;
1295
1296         if (idx < 0 || idx > 4)
1297                 return 0;
1298
1299         switch (pkt_type) {
1300
1301         case SYN_NEWABS:
1302         case SYN_NEWABS_RELAXED:
1303                 return (packet[idx] & newabs_rel_mask[idx]) == newabs_rslt[idx];
1304
1305         case SYN_NEWABS_STRICT:
1306                 return (packet[idx] & newabs_mask[idx]) == newabs_rslt[idx];
1307
1308         case SYN_OLDABS:
1309                 return (packet[idx] & oldabs_mask[idx]) == oldabs_rslt[idx];
1310
1311         default:
1312                 psmouse_err(psmouse, "unknown packet type %d\n", pkt_type);
1313                 return 0;
1314         }
1315 }
1316
1317 static unsigned char synaptics_detect_pkt_type(struct psmouse *psmouse)
1318 {
1319         int i;
1320
1321         for (i = 0; i < 5; i++)
1322                 if (!synaptics_validate_byte(psmouse, i, SYN_NEWABS_STRICT)) {
1323                         psmouse_info(psmouse, "using relaxed packet validation\n");
1324                         return SYN_NEWABS_RELAXED;
1325                 }
1326
1327         return SYN_NEWABS_STRICT;
1328 }
1329
1330 static psmouse_ret_t synaptics_process_byte(struct psmouse *psmouse)
1331 {
1332         struct synaptics_data *priv = psmouse->private;
1333
1334         if (psmouse->pktcnt >= 6) { /* Full packet received */
1335                 if (unlikely(priv->pkt_type == SYN_NEWABS))
1336                         priv->pkt_type = synaptics_detect_pkt_type(psmouse);
1337
1338                 if (SYN_CAP_PASS_THROUGH(priv->capabilities) &&
1339                     synaptics_is_pt_packet(psmouse->packet)) {
1340                         if (priv->pt_port)
1341                                 synaptics_pass_pt_packet(priv->pt_port, psmouse->packet);
1342                 } else
1343                         synaptics_process_packet(psmouse);
1344
1345                 return PSMOUSE_FULL_PACKET;
1346         }
1347
1348         return synaptics_validate_byte(psmouse, psmouse->pktcnt - 1, priv->pkt_type) ?
1349                 PSMOUSE_GOOD_DATA : PSMOUSE_BAD_DATA;
1350 }
1351
1352 /*****************************************************************************
1353  *      Driver initialization/cleanup functions
1354  ****************************************************************************/
1355 static void set_abs_position_params(struct input_dev *dev,
1356                                     struct synaptics_data *priv, int x_code,
1357                                     int y_code)
1358 {
1359         int x_min = priv->x_min ?: XMIN_NOMINAL;
1360         int x_max = priv->x_max ?: XMAX_NOMINAL;
1361         int y_min = priv->y_min ?: YMIN_NOMINAL;
1362         int y_max = priv->y_max ?: YMAX_NOMINAL;
1363         int fuzz = SYN_CAP_REDUCED_FILTERING(priv->ext_cap_0c) ?
1364                         SYN_REDUCED_FILTER_FUZZ : 0;
1365
1366         input_set_abs_params(dev, x_code, x_min, x_max, fuzz, 0);
1367         input_set_abs_params(dev, y_code, y_min, y_max, fuzz, 0);
1368         input_abs_set_res(dev, x_code, priv->x_res);
1369         input_abs_set_res(dev, y_code, priv->y_res);
1370 }
1371
1372 static void set_input_params(struct psmouse *psmouse,
1373                              struct synaptics_data *priv)
1374 {
1375         struct input_dev *dev = psmouse->dev;
1376         int i;
1377
1378         /* Things that apply to both modes */
1379         __set_bit(INPUT_PROP_POINTER, dev->propbit);
1380         __set_bit(EV_KEY, dev->evbit);
1381         __set_bit(BTN_LEFT, dev->keybit);
1382         __set_bit(BTN_RIGHT, dev->keybit);
1383
1384         if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
1385                 __set_bit(BTN_MIDDLE, dev->keybit);
1386
1387         if (!priv->absolute_mode) {
1388                 /* Relative mode */
1389                 __set_bit(EV_REL, dev->evbit);
1390                 __set_bit(REL_X, dev->relbit);
1391                 __set_bit(REL_Y, dev->relbit);
1392                 return;
1393         }
1394
1395         /* Absolute mode */
1396         __set_bit(EV_ABS, dev->evbit);
1397         set_abs_position_params(dev, priv, ABS_X, ABS_Y);
1398         input_set_abs_params(dev, ABS_PRESSURE, 0, 255, 0, 0);
1399
1400         if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
1401                 set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1402                                         ABS_MT_POSITION_Y);
1403                 /* Image sensors can report per-contact pressure */
1404                 input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1405                 input_mt_init_slots(dev, 2, INPUT_MT_POINTER);
1406
1407                 /* Image sensors can signal 4 and 5 finger clicks */
1408                 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1409                 __set_bit(BTN_TOOL_QUINTTAP, dev->keybit);
1410         } else if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c)) {
1411                 /* Non-image sensors with AGM use semi-mt */
1412                 __set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
1413                 input_mt_init_slots(dev, 2, 0);
1414                 set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1415                                         ABS_MT_POSITION_Y);
1416         }
1417
1418         if (SYN_CAP_PALMDETECT(priv->capabilities))
1419                 input_set_abs_params(dev, ABS_TOOL_WIDTH, 0, 15, 0, 0);
1420
1421         __set_bit(BTN_TOUCH, dev->keybit);
1422         __set_bit(BTN_TOOL_FINGER, dev->keybit);
1423
1424         if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
1425                 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1426                 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1427         }
1428
1429         if (SYN_CAP_FOUR_BUTTON(priv->capabilities) ||
1430             SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
1431                 __set_bit(BTN_FORWARD, dev->keybit);
1432                 __set_bit(BTN_BACK, dev->keybit);
1433         }
1434
1435         for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
1436                 __set_bit(BTN_0 + i, dev->keybit);
1437
1438         __clear_bit(EV_REL, dev->evbit);
1439         __clear_bit(REL_X, dev->relbit);
1440         __clear_bit(REL_Y, dev->relbit);
1441
1442         if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
1443                 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1444                 if (matches_pnp_id(psmouse, topbuttonpad_pnp_ids))
1445                         __set_bit(INPUT_PROP_TOPBUTTONPAD, dev->propbit);
1446                 /* Clickpads report only left button */
1447                 __clear_bit(BTN_RIGHT, dev->keybit);
1448                 __clear_bit(BTN_MIDDLE, dev->keybit);
1449         }
1450 }
1451
1452 static ssize_t synaptics_show_disable_gesture(struct psmouse *psmouse,
1453                                               void *data, char *buf)
1454 {
1455         struct synaptics_data *priv = psmouse->private;
1456
1457         return sprintf(buf, "%c\n", priv->disable_gesture ? '1' : '0');
1458 }
1459
1460 static ssize_t synaptics_set_disable_gesture(struct psmouse *psmouse,
1461                                              void *data, const char *buf,
1462                                              size_t len)
1463 {
1464         struct synaptics_data *priv = psmouse->private;
1465         unsigned int value;
1466         int err;
1467
1468         err = kstrtouint(buf, 10, &value);
1469         if (err)
1470                 return err;
1471
1472         if (value > 1)
1473                 return -EINVAL;
1474
1475         if (value == priv->disable_gesture)
1476                 return len;
1477
1478         priv->disable_gesture = value;
1479         if (value)
1480                 priv->mode |= SYN_BIT_DISABLE_GESTURE;
1481         else
1482                 priv->mode &= ~SYN_BIT_DISABLE_GESTURE;
1483
1484         if (synaptics_mode_cmd(psmouse, priv->mode))
1485                 return -EIO;
1486
1487         return len;
1488 }
1489
1490 PSMOUSE_DEFINE_ATTR(disable_gesture, S_IWUSR | S_IRUGO, NULL,
1491                     synaptics_show_disable_gesture,
1492                     synaptics_set_disable_gesture);
1493
1494 static void synaptics_disconnect(struct psmouse *psmouse)
1495 {
1496         struct synaptics_data *priv = psmouse->private;
1497
1498         if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(priv->identity))
1499                 device_remove_file(&psmouse->ps2dev.serio->dev,
1500                                    &psmouse_attr_disable_gesture.dattr);
1501
1502         synaptics_reset(psmouse);
1503         kfree(priv);
1504         psmouse->private = NULL;
1505 }
1506
1507 static int synaptics_reconnect(struct psmouse *psmouse)
1508 {
1509         struct synaptics_data *priv = psmouse->private;
1510         struct synaptics_data old_priv = *priv;
1511         unsigned char param[2];
1512         int retry = 0;
1513         int error;
1514
1515         do {
1516                 psmouse_reset(psmouse);
1517                 if (retry) {
1518                         /*
1519                          * On some boxes, right after resuming, the touchpad
1520                          * needs some time to finish initializing (I assume
1521                          * it needs time to calibrate) and start responding
1522                          * to Synaptics-specific queries, so let's wait a
1523                          * bit.
1524                          */
1525                         ssleep(1);
1526                 }
1527                 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETID);
1528                 error = synaptics_detect(psmouse, 0);
1529         } while (error && ++retry < 3);
1530
1531         if (error)
1532                 return -1;
1533
1534         if (retry > 1)
1535                 psmouse_dbg(psmouse, "reconnected after %d tries\n", retry);
1536
1537         if (synaptics_query_hardware(psmouse)) {
1538                 psmouse_err(psmouse, "Unable to query device.\n");
1539                 return -1;
1540         }
1541
1542         if (synaptics_set_mode(psmouse)) {
1543                 psmouse_err(psmouse, "Unable to initialize device.\n");
1544                 return -1;
1545         }
1546
1547         if (old_priv.identity != priv->identity ||
1548             old_priv.model_id != priv->model_id ||
1549             old_priv.capabilities != priv->capabilities ||
1550             old_priv.ext_cap != priv->ext_cap) {
1551                 psmouse_err(psmouse,
1552                             "hardware appears to be different: id(%ld-%ld), model(%ld-%ld), caps(%lx-%lx), ext(%lx-%lx).\n",
1553                             old_priv.identity, priv->identity,
1554                             old_priv.model_id, priv->model_id,
1555                             old_priv.capabilities, priv->capabilities,
1556                             old_priv.ext_cap, priv->ext_cap);
1557                 return -1;
1558         }
1559
1560         return 0;
1561 }
1562
1563 static bool impaired_toshiba_kbc;
1564
1565 static const struct dmi_system_id toshiba_dmi_table[] __initconst = {
1566 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1567         {
1568                 /* Toshiba Satellite */
1569                 .matches = {
1570                         DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1571                         DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
1572                 },
1573         },
1574         {
1575                 /* Toshiba Dynabook */
1576                 .matches = {
1577                         DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1578                         DMI_MATCH(DMI_PRODUCT_NAME, "dynabook"),
1579                 },
1580         },
1581         {
1582                 /* Toshiba Portege M300 */
1583                 .matches = {
1584                         DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1585                         DMI_MATCH(DMI_PRODUCT_NAME, "PORTEGE M300"),
1586                 },
1587
1588         },
1589         {
1590                 /* Toshiba Portege M300 */
1591                 .matches = {
1592                         DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1593                         DMI_MATCH(DMI_PRODUCT_NAME, "Portable PC"),
1594                         DMI_MATCH(DMI_PRODUCT_VERSION, "Version 1.0"),
1595                 },
1596
1597         },
1598 #endif
1599         { }
1600 };
1601
1602 static bool broken_olpc_ec;
1603
1604 static const struct dmi_system_id olpc_dmi_table[] __initconst = {
1605 #if defined(CONFIG_DMI) && defined(CONFIG_OLPC)
1606         {
1607                 /* OLPC XO-1 or XO-1.5 */
1608                 .matches = {
1609                         DMI_MATCH(DMI_SYS_VENDOR, "OLPC"),
1610                         DMI_MATCH(DMI_PRODUCT_NAME, "XO"),
1611                 },
1612         },
1613 #endif
1614         { }
1615 };
1616
1617 void __init synaptics_module_init(void)
1618 {
1619         impaired_toshiba_kbc = dmi_check_system(toshiba_dmi_table);
1620         broken_olpc_ec = dmi_check_system(olpc_dmi_table);
1621 }
1622
1623 static int __synaptics_init(struct psmouse *psmouse, bool absolute_mode)
1624 {
1625         struct synaptics_data *priv;
1626         int err = -1;
1627
1628         /*
1629          * The OLPC XO has issues with Synaptics' absolute mode; the constant
1630          * packet spew overloads the EC such that key presses on the keyboard
1631          * are missed.  Given that, don't even attempt to use Absolute mode.
1632          * Relative mode seems to work just fine.
1633          */
1634         if (absolute_mode && broken_olpc_ec) {
1635                 psmouse_info(psmouse,
1636                              "OLPC XO detected, not enabling Synaptics protocol.\n");
1637                 return -ENODEV;
1638         }
1639
1640         psmouse->private = priv = kzalloc(sizeof(struct synaptics_data), GFP_KERNEL);
1641         if (!priv)
1642                 return -ENOMEM;
1643
1644         psmouse_reset(psmouse);
1645
1646         if (synaptics_query_hardware(psmouse)) {
1647                 psmouse_err(psmouse, "Unable to query device.\n");
1648                 goto init_fail;
1649         }
1650
1651         priv->absolute_mode = absolute_mode;
1652         if (SYN_ID_DISGEST_SUPPORTED(priv->identity))
1653                 priv->disable_gesture = true;
1654
1655         if (synaptics_set_mode(psmouse)) {
1656                 psmouse_err(psmouse, "Unable to initialize device.\n");
1657                 goto init_fail;
1658         }
1659
1660         priv->pkt_type = SYN_MODEL_NEWABS(priv->model_id) ? SYN_NEWABS : SYN_OLDABS;
1661
1662         psmouse_info(psmouse,
1663                      "Touchpad model: %ld, fw: %ld.%ld, id: %#lx, caps: %#lx/%#lx/%#lx, board id: %lu, fw id: %lu\n",
1664                      SYN_ID_MODEL(priv->identity),
1665                      SYN_ID_MAJOR(priv->identity), SYN_ID_MINOR(priv->identity),
1666                      priv->model_id,
1667                      priv->capabilities, priv->ext_cap, priv->ext_cap_0c,
1668                      priv->board_id, priv->firmware_id);
1669
1670         set_input_params(psmouse, priv);
1671
1672         /*
1673          * Encode touchpad model so that it can be used to set
1674          * input device->id.version and be visible to userspace.
1675          * Because version is __u16 we have to drop something.
1676          * Hardware info bits seem to be good candidates as they
1677          * are documented to be for Synaptics corp. internal use.
1678          */
1679         psmouse->model = ((priv->model_id & 0x00ff0000) >> 8) |
1680                           (priv->model_id & 0x000000ff);
1681
1682         if (absolute_mode) {
1683                 psmouse->protocol_handler = synaptics_process_byte;
1684                 psmouse->pktsize = 6;
1685         } else {
1686                 /* Relative mode follows standard PS/2 mouse protocol */
1687                 psmouse->protocol_handler = psmouse_process_byte;
1688                 psmouse->pktsize = 3;
1689         }
1690
1691         psmouse->set_rate = synaptics_set_rate;
1692         psmouse->disconnect = synaptics_disconnect;
1693         psmouse->reconnect = synaptics_reconnect;
1694         psmouse->cleanup = synaptics_reset;
1695         /* Synaptics can usually stay in sync without extra help */
1696         psmouse->resync_time = 0;
1697
1698         if (SYN_CAP_PASS_THROUGH(priv->capabilities))
1699                 synaptics_pt_create(psmouse);
1700
1701         /*
1702          * Toshiba's KBC seems to have trouble handling data from
1703          * Synaptics at full rate.  Switch to a lower rate (roughly
1704          * the same rate as a standard PS/2 mouse).
1705          */
1706         if (psmouse->rate >= 80 && impaired_toshiba_kbc) {
1707                 psmouse_info(psmouse,
1708                              "Toshiba %s detected, limiting rate to 40pps.\n",
1709                              dmi_get_system_info(DMI_PRODUCT_NAME));
1710                 psmouse->rate = 40;
1711         }
1712
1713         if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(priv->identity)) {
1714                 err = device_create_file(&psmouse->ps2dev.serio->dev,
1715                                          &psmouse_attr_disable_gesture.dattr);
1716                 if (err) {
1717                         psmouse_err(psmouse,
1718                                     "Failed to create disable_gesture attribute (%d)",
1719                                     err);
1720                         goto init_fail;
1721                 }
1722         }
1723
1724         return 0;
1725
1726  init_fail:
1727         kfree(priv);
1728         return err;
1729 }
1730
1731 int synaptics_init(struct psmouse *psmouse)
1732 {
1733         return __synaptics_init(psmouse, true);
1734 }
1735
1736 int synaptics_init_relative(struct psmouse *psmouse)
1737 {
1738         return __synaptics_init(psmouse, false);
1739 }
1740
1741 bool synaptics_supported(void)
1742 {
1743         return true;
1744 }
1745
1746 #else /* CONFIG_MOUSE_PS2_SYNAPTICS */
1747
1748 void __init synaptics_module_init(void)
1749 {
1750 }
1751
1752 int synaptics_init(struct psmouse *psmouse)
1753 {
1754         return -ENOSYS;
1755 }
1756
1757 bool synaptics_supported(void)
1758 {
1759         return false;
1760 }
1761
1762 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS */