2 * Synaptics TouchPad PS/2 mouse driver
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.
8 * 2003 Peter Osterlund <petero2@telia.com>
9 * Ported to 2.5 input device infrastructure.
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)
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)
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.
23 * Trademarks are the property of their respective owners.
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>
34 #include "synaptics.h"
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
47 #define XMIN_NOMINAL 1472
48 #define XMAX_NOMINAL 5472
49 #define YMIN_NOMINAL 1408
50 #define YMAX_NOMINAL 4448
52 /* Size in bits of absolute position values reported by the hardware */
53 #define ABS_POS_BITS 13
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.
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.
67 #define X_MAX_POSITIVE 8176
68 #define Y_MAX_POSITIVE 8176
70 /*****************************************************************************
71 * Stuff we need even when we do not want native Synaptics support
72 ****************************************************************************/
75 * Set the synaptics touchpad mode byte by special commands
77 static int synaptics_mode_cmd(struct psmouse *psmouse, unsigned char mode)
79 unsigned char param[1];
81 if (psmouse_sliced_command(psmouse, mode))
83 param[0] = SYN_PS_SET_MODE2;
84 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_SETRATE))
89 int synaptics_detect(struct psmouse *psmouse, bool set_properties)
91 struct ps2dev *ps2dev = &psmouse->ps2dev;
92 unsigned char param[4];
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);
102 if (param[1] != 0x47)
105 if (set_properties) {
106 psmouse->vendor = "Synaptics";
107 psmouse->name = "TouchPad";
113 void synaptics_reset(struct psmouse *psmouse)
115 /* reset touchpad back to relative mode, gestures enabled */
116 synaptics_mode_cmd(psmouse, 0);
119 #ifdef CONFIG_MOUSE_PS2_SYNAPTICS
121 static bool cr48_profile_sensor;
123 struct min_max_quirk {
124 const char * const *pnp_ids;
125 int x_min, x_max, y_min, y_max;
128 static const struct min_max_quirk min_max_pnpid_table[] = {
130 (const char * const []){"LEN0033", NULL},
131 1024, 5052, 2258, 4832
134 (const char * const []){"LEN0035", "LEN0042", NULL},
135 1232, 5710, 1156, 4696
138 (const char * const []){"LEN0034", "LEN0036", "LEN0039",
139 "LEN2002", "LEN2004", NULL},
140 1024, 5112, 2024, 4832
143 (const char * const []){"LEN2001", NULL},
144 1024, 5022, 2508, 4832
147 (const char * const []){"LEN2006", NULL},
148 1264, 5675, 1171, 4688
153 /* This list has been kindly provided by Synaptics. */
154 static const char * const topbuttonpad_pnp_ids[] = {
164 "LEN0033", /* Helix */
165 "LEN0034", /* T431s, L440, L540, T540, W540, X1 Carbon 2nd */
166 "LEN0035", /* X240 */
167 "LEN0036", /* T440 */
170 "LEN0039", /* T440s */
172 "LEN0042", /* Yoga */
179 "LEN2001", /* Edge E431 */
180 "LEN2002", /* Edge E531 */
182 "LEN2004", /* L440 */
193 /*****************************************************************************
194 * Synaptics communications functions
195 ****************************************************************************/
198 * Synaptics touchpads report the y coordinate from bottom to top, which is
199 * opposite from what userspace expects.
200 * This function is used to invert y before reporting.
202 static int synaptics_invert_y(int y)
204 return YMAX_NOMINAL + YMIN_NOMINAL - y;
208 * Send a command to the synpatics touchpad by special commands
210 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c, unsigned char *param)
212 if (psmouse_sliced_command(psmouse, c))
214 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO))
220 * Read the model-id bytes from the touchpad
221 * see also SYN_MODEL_* macros
223 static int synaptics_model_id(struct psmouse *psmouse)
225 struct synaptics_data *priv = psmouse->private;
228 if (synaptics_send_cmd(psmouse, SYN_QUE_MODEL, mi))
230 priv->model_id = (mi[0]<<16) | (mi[1]<<8) | mi[2];
235 * Read the board id from the touchpad
236 * The board id is encoded in the "QUERY MODES" response
238 static int synaptics_board_id(struct psmouse *psmouse)
240 struct synaptics_data *priv = psmouse->private;
241 unsigned char bid[3];
243 if (synaptics_send_cmd(psmouse, SYN_QUE_MODES, bid))
245 priv->board_id = ((bid[0] & 0xfc) << 6) | bid[1];
250 * Read the firmware id from the touchpad
252 static int synaptics_firmware_id(struct psmouse *psmouse)
254 struct synaptics_data *priv = psmouse->private;
255 unsigned char fwid[3];
257 if (synaptics_send_cmd(psmouse, SYN_QUE_FIRMWARE_ID, fwid))
259 priv->firmware_id = (fwid[0] << 16) | (fwid[1] << 8) | fwid[2];
264 * Read the capability-bits from the touchpad
265 * see also the SYN_CAP_* macros
267 static int synaptics_capability(struct psmouse *psmouse)
269 struct synaptics_data *priv = psmouse->private;
270 unsigned char cap[3];
272 if (synaptics_send_cmd(psmouse, SYN_QUE_CAPABILITIES, cap))
274 priv->capabilities = (cap[0] << 16) | (cap[1] << 8) | cap[2];
275 priv->ext_cap = priv->ext_cap_0c = 0;
278 * Older firmwares had submodel ID fixed to 0x47
280 if (SYN_ID_FULL(priv->identity) < 0x705 &&
281 SYN_CAP_SUBMODEL_ID(priv->capabilities) != 0x47) {
286 * Unless capExtended is set the rest of the flags should be ignored
288 if (!SYN_CAP_EXTENDED(priv->capabilities))
289 priv->capabilities = 0;
291 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 1) {
292 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB, cap)) {
293 psmouse_warn(psmouse,
294 "device claims to have extended capabilities, but I'm not able to read them.\n");
296 priv->ext_cap = (cap[0] << 16) | (cap[1] << 8) | cap[2];
299 * if nExtBtn is greater than 8 it should be considered
300 * invalid and treated as 0
302 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) > 8)
303 priv->ext_cap &= 0xff0fff;
307 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 4) {
308 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB_0C, cap)) {
309 psmouse_warn(psmouse,
310 "device claims to have extended capability 0x0c, but I'm not able to read it.\n");
312 priv->ext_cap_0c = (cap[0] << 16) | (cap[1] << 8) | cap[2];
321 * See also the SYN_ID_* macros
323 static int synaptics_identify(struct psmouse *psmouse)
325 struct synaptics_data *priv = psmouse->private;
328 if (synaptics_send_cmd(psmouse, SYN_QUE_IDENTIFY, id))
330 priv->identity = (id[0]<<16) | (id[1]<<8) | id[2];
331 if (SYN_ID_IS_SYNAPTICS(priv->identity))
337 * Read touchpad resolution and maximum reported coordinates
338 * Resolution is left zero if touchpad does not support the query
341 static int synaptics_resolution(struct psmouse *psmouse)
343 struct synaptics_data *priv = psmouse->private;
344 unsigned char resp[3];
347 if (SYN_ID_MAJOR(priv->identity) < 4)
350 if (synaptics_send_cmd(psmouse, SYN_QUE_RESOLUTION, resp) == 0) {
351 if (resp[0] != 0 && (resp[1] & 0x80) && resp[2] != 0) {
352 priv->x_res = resp[0]; /* x resolution in units/mm */
353 priv->y_res = resp[2]; /* y resolution in units/mm */
357 for (i = 0; min_max_pnpid_table[i].pnp_ids; i++) {
358 if (psmouse_matches_pnp_id(psmouse,
359 min_max_pnpid_table[i].pnp_ids)) {
360 priv->x_min = min_max_pnpid_table[i].x_min;
361 priv->x_max = min_max_pnpid_table[i].x_max;
362 priv->y_min = min_max_pnpid_table[i].y_min;
363 priv->y_max = min_max_pnpid_table[i].y_max;
368 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 5 &&
369 SYN_CAP_MAX_DIMENSIONS(priv->ext_cap_0c)) {
370 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MAX_COORDS, resp)) {
371 psmouse_warn(psmouse,
372 "device claims to have max coordinates query, but I'm not able to read it.\n");
374 priv->x_max = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
375 priv->y_max = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
379 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 7 &&
380 SYN_CAP_MIN_DIMENSIONS(priv->ext_cap_0c)) {
381 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MIN_COORDS, resp)) {
382 psmouse_warn(psmouse,
383 "device claims to have min coordinates query, but I'm not able to read it.\n");
385 priv->x_min = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
386 priv->y_min = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
393 static int synaptics_query_hardware(struct psmouse *psmouse)
395 if (synaptics_identify(psmouse))
397 if (synaptics_model_id(psmouse))
399 if (synaptics_firmware_id(psmouse))
401 if (synaptics_board_id(psmouse))
403 if (synaptics_capability(psmouse))
405 if (synaptics_resolution(psmouse))
411 static int synaptics_set_advanced_gesture_mode(struct psmouse *psmouse)
413 static unsigned char param = 0xc8;
414 struct synaptics_data *priv = psmouse->private;
416 if (!(SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
417 SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)))
420 if (psmouse_sliced_command(psmouse, SYN_QUE_MODEL))
423 if (ps2_command(&psmouse->ps2dev, ¶m, PSMOUSE_CMD_SETRATE))
426 /* Advanced gesture mode also sends multi finger data */
427 priv->capabilities |= BIT(1);
432 static int synaptics_set_mode(struct psmouse *psmouse)
434 struct synaptics_data *priv = psmouse->private;
437 if (priv->absolute_mode)
438 priv->mode |= SYN_BIT_ABSOLUTE_MODE;
439 if (priv->disable_gesture)
440 priv->mode |= SYN_BIT_DISABLE_GESTURE;
441 if (psmouse->rate >= 80)
442 priv->mode |= SYN_BIT_HIGH_RATE;
443 if (SYN_CAP_EXTENDED(priv->capabilities))
444 priv->mode |= SYN_BIT_W_MODE;
446 if (synaptics_mode_cmd(psmouse, priv->mode))
449 if (priv->absolute_mode &&
450 synaptics_set_advanced_gesture_mode(psmouse)) {
451 psmouse_err(psmouse, "Advanced gesture mode init failed.\n");
458 static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate)
460 struct synaptics_data *priv = psmouse->private;
463 priv->mode |= SYN_BIT_HIGH_RATE;
466 priv->mode &= ~SYN_BIT_HIGH_RATE;
470 synaptics_mode_cmd(psmouse, priv->mode);
473 /*****************************************************************************
474 * Synaptics pass-through PS/2 port support
475 ****************************************************************************/
476 static int synaptics_pt_write(struct serio *serio, unsigned char c)
478 struct psmouse *parent = serio_get_drvdata(serio->parent);
479 char rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */
481 if (psmouse_sliced_command(parent, c))
483 if (ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE))
488 static int synaptics_pt_start(struct serio *serio)
490 struct psmouse *parent = serio_get_drvdata(serio->parent);
491 struct synaptics_data *priv = parent->private;
493 serio_pause_rx(parent->ps2dev.serio);
494 priv->pt_port = serio;
495 serio_continue_rx(parent->ps2dev.serio);
500 static void synaptics_pt_stop(struct serio *serio)
502 struct psmouse *parent = serio_get_drvdata(serio->parent);
503 struct synaptics_data *priv = parent->private;
505 serio_pause_rx(parent->ps2dev.serio);
506 priv->pt_port = NULL;
507 serio_continue_rx(parent->ps2dev.serio);
510 static int synaptics_is_pt_packet(unsigned char *buf)
512 return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4;
515 static void synaptics_pass_pt_packet(struct serio *ptport, unsigned char *packet)
517 struct psmouse *child = serio_get_drvdata(ptport);
519 if (child && child->state == PSMOUSE_ACTIVATED) {
520 serio_interrupt(ptport, packet[1], 0);
521 serio_interrupt(ptport, packet[4], 0);
522 serio_interrupt(ptport, packet[5], 0);
523 if (child->pktsize == 4)
524 serio_interrupt(ptport, packet[2], 0);
526 serio_interrupt(ptport, packet[1], 0);
529 static void synaptics_pt_activate(struct psmouse *psmouse)
531 struct synaptics_data *priv = psmouse->private;
532 struct psmouse *child = serio_get_drvdata(priv->pt_port);
534 /* adjust the touchpad to child's choice of protocol */
536 if (child->pktsize == 4)
537 priv->mode |= SYN_BIT_FOUR_BYTE_CLIENT;
539 priv->mode &= ~SYN_BIT_FOUR_BYTE_CLIENT;
541 if (synaptics_mode_cmd(psmouse, priv->mode))
542 psmouse_warn(psmouse,
543 "failed to switch guest protocol\n");
547 static void synaptics_pt_create(struct psmouse *psmouse)
551 serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
554 "not enough memory for pass-through port\n");
558 serio->id.type = SERIO_PS_PSTHRU;
559 strlcpy(serio->name, "Synaptics pass-through", sizeof(serio->name));
560 strlcpy(serio->phys, "synaptics-pt/serio0", sizeof(serio->name));
561 serio->write = synaptics_pt_write;
562 serio->start = synaptics_pt_start;
563 serio->stop = synaptics_pt_stop;
564 serio->parent = psmouse->ps2dev.serio;
566 psmouse->pt_activate = synaptics_pt_activate;
568 psmouse_info(psmouse, "serio: %s port at %s\n",
569 serio->name, psmouse->phys);
570 serio_register_port(serio);
573 /*****************************************************************************
574 * Functions to interpret the absolute mode packets
575 ****************************************************************************/
577 static void synaptics_parse_agm(const unsigned char buf[],
578 struct synaptics_data *priv,
579 struct synaptics_hw_state *hw)
581 struct synaptics_hw_state *agm = &priv->agm;
584 agm_packet_type = (buf[5] & 0x30) >> 4;
585 switch (agm_packet_type) {
587 /* Gesture packet: (x, y, z) half resolution */
589 agm->x = (((buf[4] & 0x0f) << 8) | buf[1]) << 1;
590 agm->y = (((buf[4] & 0xf0) << 4) | buf[2]) << 1;
591 agm->z = ((buf[3] & 0x30) | (buf[5] & 0x0f)) << 1;
595 /* AGM-CONTACT packet: we are only interested in the count */
596 priv->agm_count = buf[1];
604 static bool is_forcepad;
606 static int synaptics_parse_hw_state(const unsigned char buf[],
607 struct synaptics_data *priv,
608 struct synaptics_hw_state *hw)
610 memset(hw, 0, sizeof(struct synaptics_hw_state));
612 if (SYN_MODEL_NEWABS(priv->model_id)) {
613 hw->w = (((buf[0] & 0x30) >> 2) |
614 ((buf[0] & 0x04) >> 1) |
615 ((buf[3] & 0x04) >> 2));
617 if ((SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
618 SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) &&
620 synaptics_parse_agm(buf, priv, hw);
624 hw->x = (((buf[3] & 0x10) << 8) |
625 ((buf[1] & 0x0f) << 8) |
627 hw->y = (((buf[3] & 0x20) << 7) |
628 ((buf[1] & 0xf0) << 4) |
632 hw->left = (buf[0] & 0x01) ? 1 : 0;
633 hw->right = (buf[0] & 0x02) ? 1 : 0;
637 * ForcePads, like Clickpads, use middle button
638 * bits to report primary button clicks.
639 * Unfortunately they report primary button not
640 * only when user presses on the pad above certain
641 * threshold, but also when there are more than one
642 * finger on the touchpad, which interferes with
643 * out multi-finger gestures.
647 priv->press = priv->report_press = false;
648 } else if (hw->w >= 4 && ((buf[0] ^ buf[3]) & 0x01)) {
650 * Single-finger touch with pressure above
651 * the threshold. If pressure stays long
652 * enough, we'll start reporting primary
653 * button. We rely on the device continuing
654 * sending data even if finger does not
658 priv->press_start = jiffies;
660 } else if (time_after(jiffies,
662 msecs_to_jiffies(50))) {
663 priv->report_press = true;
669 hw->left = priv->report_press;
671 } else if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
673 * Clickpad's button is transmitted as middle button,
674 * however, since it is primary button, we will report
677 hw->left = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
679 } else if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
680 hw->middle = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
682 hw->scroll = (signed char)(buf[1]);
685 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
686 hw->up = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
687 hw->down = ((buf[0] ^ buf[3]) & 0x02) ? 1 : 0;
690 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) &&
691 ((buf[0] ^ buf[3]) & 0x02)) {
692 switch (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) & ~0x01) {
695 * if nExtBtn is greater than 8 it should be
696 * considered invalid and treated as 0
700 hw->ext_buttons |= ((buf[5] & 0x08)) ? 0x80 : 0;
701 hw->ext_buttons |= ((buf[4] & 0x08)) ? 0x40 : 0;
703 hw->ext_buttons |= ((buf[5] & 0x04)) ? 0x20 : 0;
704 hw->ext_buttons |= ((buf[4] & 0x04)) ? 0x10 : 0;
706 hw->ext_buttons |= ((buf[5] & 0x02)) ? 0x08 : 0;
707 hw->ext_buttons |= ((buf[4] & 0x02)) ? 0x04 : 0;
709 hw->ext_buttons |= ((buf[5] & 0x01)) ? 0x02 : 0;
710 hw->ext_buttons |= ((buf[4] & 0x01)) ? 0x01 : 0;
714 hw->x = (((buf[1] & 0x1f) << 8) | buf[2]);
715 hw->y = (((buf[4] & 0x1f) << 8) | buf[5]);
717 hw->z = (((buf[0] & 0x30) << 2) | (buf[3] & 0x3F));
718 hw->w = (((buf[1] & 0x80) >> 4) | ((buf[0] & 0x04) >> 1));
720 hw->left = (buf[0] & 0x01) ? 1 : 0;
721 hw->right = (buf[0] & 0x02) ? 1 : 0;
725 * Convert wrap-around values to negative. (X|Y)_MAX_POSITIVE
726 * is used by some firmware to indicate a finger at the edge of
727 * the touchpad whose precise position cannot be determined, so
728 * convert these values to the maximum axis value.
730 if (hw->x > X_MAX_POSITIVE)
731 hw->x -= 1 << ABS_POS_BITS;
732 else if (hw->x == X_MAX_POSITIVE)
735 if (hw->y > Y_MAX_POSITIVE)
736 hw->y -= 1 << ABS_POS_BITS;
737 else if (hw->y == Y_MAX_POSITIVE)
743 static void synaptics_report_semi_mt_slot(struct input_dev *dev, int slot,
744 bool active, int x, int y)
746 input_mt_slot(dev, slot);
747 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
749 input_report_abs(dev, ABS_MT_POSITION_X, x);
750 input_report_abs(dev, ABS_MT_POSITION_Y, synaptics_invert_y(y));
754 static void synaptics_report_semi_mt_data(struct input_dev *dev,
755 const struct synaptics_hw_state *a,
756 const struct synaptics_hw_state *b,
759 if (num_fingers >= 2) {
760 synaptics_report_semi_mt_slot(dev, 0, true, min(a->x, b->x),
762 synaptics_report_semi_mt_slot(dev, 1, true, max(a->x, b->x),
764 } else if (num_fingers == 1) {
765 synaptics_report_semi_mt_slot(dev, 0, true, a->x, a->y);
766 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
768 synaptics_report_semi_mt_slot(dev, 0, false, 0, 0);
769 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
773 static void synaptics_report_buttons(struct psmouse *psmouse,
774 const struct synaptics_hw_state *hw)
776 struct input_dev *dev = psmouse->dev;
777 struct synaptics_data *priv = psmouse->private;
780 input_report_key(dev, BTN_LEFT, hw->left);
781 input_report_key(dev, BTN_RIGHT, hw->right);
783 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
784 input_report_key(dev, BTN_MIDDLE, hw->middle);
786 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
787 input_report_key(dev, BTN_FORWARD, hw->up);
788 input_report_key(dev, BTN_BACK, hw->down);
791 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
792 input_report_key(dev, BTN_0 + i, hw->ext_buttons & (1 << i));
795 static void synaptics_report_mt_data(struct psmouse *psmouse,
796 const struct synaptics_hw_state *sgm,
799 struct input_dev *dev = psmouse->dev;
800 struct synaptics_data *priv = psmouse->private;
801 const struct synaptics_hw_state *hw[2] = { sgm, &priv->agm };
802 struct input_mt_pos pos[2];
803 int slot[2], nsemi, i;
805 nsemi = clamp_val(num_fingers, 0, 2);
807 for (i = 0; i < nsemi; i++) {
809 pos[i].y = synaptics_invert_y(hw[i]->y);
812 input_mt_assign_slots(dev, slot, pos, nsemi);
814 for (i = 0; i < nsemi; i++) {
815 input_mt_slot(dev, slot[i]);
816 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
817 input_report_abs(dev, ABS_MT_POSITION_X, pos[i].x);
818 input_report_abs(dev, ABS_MT_POSITION_Y, pos[i].y);
819 input_report_abs(dev, ABS_MT_PRESSURE, hw[i]->z);
822 input_mt_drop_unused(dev);
824 /* Don't use active slot count to generate BTN_TOOL events. */
825 input_mt_report_pointer_emulation(dev, false);
827 /* Send the number of fingers reported by touchpad itself. */
828 input_mt_report_finger_count(dev, num_fingers);
830 synaptics_report_buttons(psmouse, sgm);
835 static void synaptics_image_sensor_process(struct psmouse *psmouse,
836 struct synaptics_hw_state *sgm)
838 struct synaptics_data *priv = psmouse->private;
842 * Update mt_state using the new finger count and current mt_state.
846 else if (sgm->w >= 4)
848 else if (sgm->w == 0)
850 else if (sgm->w == 1)
851 num_fingers = priv->agm_count ? priv->agm_count : 3;
855 /* Send resulting input events to user space */
856 synaptics_report_mt_data(psmouse, sgm, num_fingers);
860 * called for each full received packet from the touchpad
862 static void synaptics_process_packet(struct psmouse *psmouse)
864 struct input_dev *dev = psmouse->dev;
865 struct synaptics_data *priv = psmouse->private;
866 struct synaptics_hw_state hw;
870 if (synaptics_parse_hw_state(psmouse->packet, priv, &hw))
873 if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
874 synaptics_image_sensor_process(psmouse, &hw);
879 priv->scroll += hw.scroll;
881 while (priv->scroll >= 4) {
882 input_report_key(dev, BTN_BACK, !hw.down);
884 input_report_key(dev, BTN_BACK, hw.down);
888 while (priv->scroll <= -4) {
889 input_report_key(dev, BTN_FORWARD, !hw.up);
891 input_report_key(dev, BTN_FORWARD, hw.up);
898 if (hw.z > 0 && hw.x > 1) {
901 if (SYN_CAP_EXTENDED(priv->capabilities)) {
904 if (SYN_CAP_MULTIFINGER(priv->capabilities))
905 num_fingers = hw.w + 2;
908 if (SYN_MODEL_PEN(priv->model_id))
909 ; /* Nothing, treat a pen as a single finger */
912 if (SYN_CAP_PALMDETECT(priv->capabilities))
922 if (cr48_profile_sensor) {
923 synaptics_report_mt_data(psmouse, &hw, num_fingers);
927 if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c))
928 synaptics_report_semi_mt_data(dev, &hw, &priv->agm,
932 * BTN_TOUCH has to be first as mousedev relies on it when doing
933 * absolute -> relative conversion
935 if (hw.z > 30) input_report_key(dev, BTN_TOUCH, 1);
936 if (hw.z < 25) input_report_key(dev, BTN_TOUCH, 0);
938 if (num_fingers > 0) {
939 input_report_abs(dev, ABS_X, hw.x);
940 input_report_abs(dev, ABS_Y, synaptics_invert_y(hw.y));
942 input_report_abs(dev, ABS_PRESSURE, hw.z);
944 if (SYN_CAP_PALMDETECT(priv->capabilities))
945 input_report_abs(dev, ABS_TOOL_WIDTH, finger_width);
947 input_report_key(dev, BTN_TOOL_FINGER, num_fingers == 1);
948 if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
949 input_report_key(dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
950 input_report_key(dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
953 synaptics_report_buttons(psmouse, &hw);
958 static int synaptics_validate_byte(struct psmouse *psmouse,
959 int idx, unsigned char pkt_type)
961 static const unsigned char newabs_mask[] = { 0xC8, 0x00, 0x00, 0xC8, 0x00 };
962 static const unsigned char newabs_rel_mask[] = { 0xC0, 0x00, 0x00, 0xC0, 0x00 };
963 static const unsigned char newabs_rslt[] = { 0x80, 0x00, 0x00, 0xC0, 0x00 };
964 static const unsigned char oldabs_mask[] = { 0xC0, 0x60, 0x00, 0xC0, 0x60 };
965 static const unsigned char oldabs_rslt[] = { 0xC0, 0x00, 0x00, 0x80, 0x00 };
966 const char *packet = psmouse->packet;
968 if (idx < 0 || idx > 4)
974 case SYN_NEWABS_RELAXED:
975 return (packet[idx] & newabs_rel_mask[idx]) == newabs_rslt[idx];
977 case SYN_NEWABS_STRICT:
978 return (packet[idx] & newabs_mask[idx]) == newabs_rslt[idx];
981 return (packet[idx] & oldabs_mask[idx]) == oldabs_rslt[idx];
984 psmouse_err(psmouse, "unknown packet type %d\n", pkt_type);
989 static unsigned char synaptics_detect_pkt_type(struct psmouse *psmouse)
993 for (i = 0; i < 5; i++)
994 if (!synaptics_validate_byte(psmouse, i, SYN_NEWABS_STRICT)) {
995 psmouse_info(psmouse, "using relaxed packet validation\n");
996 return SYN_NEWABS_RELAXED;
999 return SYN_NEWABS_STRICT;
1002 static psmouse_ret_t synaptics_process_byte(struct psmouse *psmouse)
1004 struct synaptics_data *priv = psmouse->private;
1006 if (psmouse->pktcnt >= 6) { /* Full packet received */
1007 if (unlikely(priv->pkt_type == SYN_NEWABS))
1008 priv->pkt_type = synaptics_detect_pkt_type(psmouse);
1010 if (SYN_CAP_PASS_THROUGH(priv->capabilities) &&
1011 synaptics_is_pt_packet(psmouse->packet)) {
1013 synaptics_pass_pt_packet(priv->pt_port, psmouse->packet);
1015 synaptics_process_packet(psmouse);
1017 return PSMOUSE_FULL_PACKET;
1020 return synaptics_validate_byte(psmouse, psmouse->pktcnt - 1, priv->pkt_type) ?
1021 PSMOUSE_GOOD_DATA : PSMOUSE_BAD_DATA;
1024 /*****************************************************************************
1025 * Driver initialization/cleanup functions
1026 ****************************************************************************/
1027 static void set_abs_position_params(struct input_dev *dev,
1028 struct synaptics_data *priv, int x_code,
1031 int x_min = priv->x_min ?: XMIN_NOMINAL;
1032 int x_max = priv->x_max ?: XMAX_NOMINAL;
1033 int y_min = priv->y_min ?: YMIN_NOMINAL;
1034 int y_max = priv->y_max ?: YMAX_NOMINAL;
1035 int fuzz = SYN_CAP_REDUCED_FILTERING(priv->ext_cap_0c) ?
1036 SYN_REDUCED_FILTER_FUZZ : 0;
1038 input_set_abs_params(dev, x_code, x_min, x_max, fuzz, 0);
1039 input_set_abs_params(dev, y_code, y_min, y_max, fuzz, 0);
1040 input_abs_set_res(dev, x_code, priv->x_res);
1041 input_abs_set_res(dev, y_code, priv->y_res);
1044 static void set_input_params(struct psmouse *psmouse,
1045 struct synaptics_data *priv)
1047 struct input_dev *dev = psmouse->dev;
1050 /* Things that apply to both modes */
1051 __set_bit(INPUT_PROP_POINTER, dev->propbit);
1052 __set_bit(EV_KEY, dev->evbit);
1053 __set_bit(BTN_LEFT, dev->keybit);
1054 __set_bit(BTN_RIGHT, dev->keybit);
1056 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
1057 __set_bit(BTN_MIDDLE, dev->keybit);
1059 if (!priv->absolute_mode) {
1061 __set_bit(EV_REL, dev->evbit);
1062 __set_bit(REL_X, dev->relbit);
1063 __set_bit(REL_Y, dev->relbit);
1068 __set_bit(EV_ABS, dev->evbit);
1069 set_abs_position_params(dev, priv, ABS_X, ABS_Y);
1070 input_set_abs_params(dev, ABS_PRESSURE, 0, 255, 0, 0);
1072 if (cr48_profile_sensor)
1073 input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1075 if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
1076 set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1078 /* Image sensors can report per-contact pressure */
1079 input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1080 input_mt_init_slots(dev, 2, INPUT_MT_POINTER | INPUT_MT_TRACK);
1082 /* Image sensors can signal 4 and 5 finger clicks */
1083 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1084 __set_bit(BTN_TOOL_QUINTTAP, dev->keybit);
1085 } else if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c)) {
1086 set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1089 * Profile sensor in CR-48 tracks contacts reasonably well,
1090 * other non-image sensors with AGM use semi-mt.
1092 input_mt_init_slots(dev, 2,
1094 (cr48_profile_sensor ?
1095 INPUT_MT_TRACK : INPUT_MT_SEMI_MT));
1098 if (SYN_CAP_PALMDETECT(priv->capabilities))
1099 input_set_abs_params(dev, ABS_TOOL_WIDTH, 0, 15, 0, 0);
1101 __set_bit(BTN_TOUCH, dev->keybit);
1102 __set_bit(BTN_TOOL_FINGER, dev->keybit);
1104 if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
1105 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1106 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1109 if (SYN_CAP_FOUR_BUTTON(priv->capabilities) ||
1110 SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
1111 __set_bit(BTN_FORWARD, dev->keybit);
1112 __set_bit(BTN_BACK, dev->keybit);
1115 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
1116 __set_bit(BTN_0 + i, dev->keybit);
1118 __clear_bit(EV_REL, dev->evbit);
1119 __clear_bit(REL_X, dev->relbit);
1120 __clear_bit(REL_Y, dev->relbit);
1122 if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
1123 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1124 if (psmouse_matches_pnp_id(psmouse, topbuttonpad_pnp_ids))
1125 __set_bit(INPUT_PROP_TOPBUTTONPAD, dev->propbit);
1126 /* Clickpads report only left button */
1127 __clear_bit(BTN_RIGHT, dev->keybit);
1128 __clear_bit(BTN_MIDDLE, dev->keybit);
1132 static ssize_t synaptics_show_disable_gesture(struct psmouse *psmouse,
1133 void *data, char *buf)
1135 struct synaptics_data *priv = psmouse->private;
1137 return sprintf(buf, "%c\n", priv->disable_gesture ? '1' : '0');
1140 static ssize_t synaptics_set_disable_gesture(struct psmouse *psmouse,
1141 void *data, const char *buf,
1144 struct synaptics_data *priv = psmouse->private;
1148 err = kstrtouint(buf, 10, &value);
1155 if (value == priv->disable_gesture)
1158 priv->disable_gesture = value;
1160 priv->mode |= SYN_BIT_DISABLE_GESTURE;
1162 priv->mode &= ~SYN_BIT_DISABLE_GESTURE;
1164 if (synaptics_mode_cmd(psmouse, priv->mode))
1170 PSMOUSE_DEFINE_ATTR(disable_gesture, S_IWUSR | S_IRUGO, NULL,
1171 synaptics_show_disable_gesture,
1172 synaptics_set_disable_gesture);
1174 static void synaptics_disconnect(struct psmouse *psmouse)
1176 struct synaptics_data *priv = psmouse->private;
1178 if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(priv->identity))
1179 device_remove_file(&psmouse->ps2dev.serio->dev,
1180 &psmouse_attr_disable_gesture.dattr);
1182 synaptics_reset(psmouse);
1184 psmouse->private = NULL;
1187 static int synaptics_reconnect(struct psmouse *psmouse)
1189 struct synaptics_data *priv = psmouse->private;
1190 struct synaptics_data old_priv = *priv;
1191 unsigned char param[2];
1196 psmouse_reset(psmouse);
1199 * On some boxes, right after resuming, the touchpad
1200 * needs some time to finish initializing (I assume
1201 * it needs time to calibrate) and start responding
1202 * to Synaptics-specific queries, so let's wait a
1207 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETID);
1208 error = synaptics_detect(psmouse, 0);
1209 } while (error && ++retry < 3);
1215 psmouse_dbg(psmouse, "reconnected after %d tries\n", retry);
1217 if (synaptics_query_hardware(psmouse)) {
1218 psmouse_err(psmouse, "Unable to query device.\n");
1222 if (synaptics_set_mode(psmouse)) {
1223 psmouse_err(psmouse, "Unable to initialize device.\n");
1227 if (old_priv.identity != priv->identity ||
1228 old_priv.model_id != priv->model_id ||
1229 old_priv.capabilities != priv->capabilities ||
1230 old_priv.ext_cap != priv->ext_cap) {
1231 psmouse_err(psmouse,
1232 "hardware appears to be different: id(%ld-%ld), model(%ld-%ld), caps(%lx-%lx), ext(%lx-%lx).\n",
1233 old_priv.identity, priv->identity,
1234 old_priv.model_id, priv->model_id,
1235 old_priv.capabilities, priv->capabilities,
1236 old_priv.ext_cap, priv->ext_cap);
1243 static bool impaired_toshiba_kbc;
1245 static const struct dmi_system_id toshiba_dmi_table[] __initconst = {
1246 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1248 /* Toshiba Satellite */
1250 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1251 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
1255 /* Toshiba Dynabook */
1257 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1258 DMI_MATCH(DMI_PRODUCT_NAME, "dynabook"),
1262 /* Toshiba Portege M300 */
1264 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1265 DMI_MATCH(DMI_PRODUCT_NAME, "PORTEGE M300"),
1270 /* Toshiba Portege M300 */
1272 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1273 DMI_MATCH(DMI_PRODUCT_NAME, "Portable PC"),
1274 DMI_MATCH(DMI_PRODUCT_VERSION, "Version 1.0"),
1282 static bool broken_olpc_ec;
1284 static const struct dmi_system_id olpc_dmi_table[] __initconst = {
1285 #if defined(CONFIG_DMI) && defined(CONFIG_OLPC)
1287 /* OLPC XO-1 or XO-1.5 */
1289 DMI_MATCH(DMI_SYS_VENDOR, "OLPC"),
1290 DMI_MATCH(DMI_PRODUCT_NAME, "XO"),
1297 static const struct dmi_system_id __initconst cr48_dmi_table[] = {
1298 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1300 /* Cr-48 Chromebook (Codename Mario) */
1302 DMI_MATCH(DMI_SYS_VENDOR, "IEC"),
1303 DMI_MATCH(DMI_PRODUCT_NAME, "Mario"),
1310 static const struct dmi_system_id forcepad_dmi_table[] __initconst = {
1311 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1314 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1315 DMI_MATCH(DMI_PRODUCT_NAME, "HP EliteBook Folio 1040 G1"),
1322 void __init synaptics_module_init(void)
1324 impaired_toshiba_kbc = dmi_check_system(toshiba_dmi_table);
1325 broken_olpc_ec = dmi_check_system(olpc_dmi_table);
1326 cr48_profile_sensor = dmi_check_system(cr48_dmi_table);
1329 * Unfortunately ForcePad capability is not exported over PS/2,
1330 * so we have to resort to checking DMI.
1332 is_forcepad = dmi_check_system(forcepad_dmi_table);
1335 static int __synaptics_init(struct psmouse *psmouse, bool absolute_mode)
1337 struct synaptics_data *priv;
1341 * The OLPC XO has issues with Synaptics' absolute mode; the constant
1342 * packet spew overloads the EC such that key presses on the keyboard
1343 * are missed. Given that, don't even attempt to use Absolute mode.
1344 * Relative mode seems to work just fine.
1346 if (absolute_mode && broken_olpc_ec) {
1347 psmouse_info(psmouse,
1348 "OLPC XO detected, not enabling Synaptics protocol.\n");
1352 psmouse->private = priv = kzalloc(sizeof(struct synaptics_data), GFP_KERNEL);
1356 psmouse_reset(psmouse);
1358 if (synaptics_query_hardware(psmouse)) {
1359 psmouse_err(psmouse, "Unable to query device.\n");
1363 priv->absolute_mode = absolute_mode;
1364 if (SYN_ID_DISGEST_SUPPORTED(priv->identity))
1365 priv->disable_gesture = true;
1367 if (synaptics_set_mode(psmouse)) {
1368 psmouse_err(psmouse, "Unable to initialize device.\n");
1372 priv->pkt_type = SYN_MODEL_NEWABS(priv->model_id) ? SYN_NEWABS : SYN_OLDABS;
1374 psmouse_info(psmouse,
1375 "Touchpad model: %ld, fw: %ld.%ld, id: %#lx, caps: %#lx/%#lx/%#lx, board id: %lu, fw id: %lu\n",
1376 SYN_ID_MODEL(priv->identity),
1377 SYN_ID_MAJOR(priv->identity), SYN_ID_MINOR(priv->identity),
1379 priv->capabilities, priv->ext_cap, priv->ext_cap_0c,
1380 priv->board_id, priv->firmware_id);
1382 set_input_params(psmouse, priv);
1385 * Encode touchpad model so that it can be used to set
1386 * input device->id.version and be visible to userspace.
1387 * Because version is __u16 we have to drop something.
1388 * Hardware info bits seem to be good candidates as they
1389 * are documented to be for Synaptics corp. internal use.
1391 psmouse->model = ((priv->model_id & 0x00ff0000) >> 8) |
1392 (priv->model_id & 0x000000ff);
1394 if (absolute_mode) {
1395 psmouse->protocol_handler = synaptics_process_byte;
1396 psmouse->pktsize = 6;
1398 /* Relative mode follows standard PS/2 mouse protocol */
1399 psmouse->protocol_handler = psmouse_process_byte;
1400 psmouse->pktsize = 3;
1403 psmouse->set_rate = synaptics_set_rate;
1404 psmouse->disconnect = synaptics_disconnect;
1405 psmouse->reconnect = synaptics_reconnect;
1406 psmouse->cleanup = synaptics_reset;
1407 /* Synaptics can usually stay in sync without extra help */
1408 psmouse->resync_time = 0;
1410 if (SYN_CAP_PASS_THROUGH(priv->capabilities))
1411 synaptics_pt_create(psmouse);
1414 * Toshiba's KBC seems to have trouble handling data from
1415 * Synaptics at full rate. Switch to a lower rate (roughly
1416 * the same rate as a standard PS/2 mouse).
1418 if (psmouse->rate >= 80 && impaired_toshiba_kbc) {
1419 psmouse_info(psmouse,
1420 "Toshiba %s detected, limiting rate to 40pps.\n",
1421 dmi_get_system_info(DMI_PRODUCT_NAME));
1425 if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(priv->identity)) {
1426 err = device_create_file(&psmouse->ps2dev.serio->dev,
1427 &psmouse_attr_disable_gesture.dattr);
1429 psmouse_err(psmouse,
1430 "Failed to create disable_gesture attribute (%d)",
1443 int synaptics_init(struct psmouse *psmouse)
1445 return __synaptics_init(psmouse, true);
1448 int synaptics_init_relative(struct psmouse *psmouse)
1450 return __synaptics_init(psmouse, false);
1453 bool synaptics_supported(void)
1458 #else /* CONFIG_MOUSE_PS2_SYNAPTICS */
1460 void __init synaptics_module_init(void)
1464 int synaptics_init(struct psmouse *psmouse)
1469 bool synaptics_supported(void)
1474 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS */