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", "LEN2002",
140 1024, 5112, 2024, 4832
143 (const char * const []){"LEN2001", NULL},
144 1024, 5022, 2508, 4832
149 /* This list has been kindly provided by Synaptics. */
150 static const char * const topbuttonpad_pnp_ids[] = {
160 "LEN0033", /* Helix */
161 "LEN0034", /* T431s, L440, L540, T540, W540, X1 Carbon 2nd */
162 "LEN0035", /* X240 */
163 "LEN0036", /* T440 */
167 "LEN0042", /* Yoga */
174 "LEN2001", /* Edge E431 */
175 "LEN2002", /* Edge E531 */
177 "LEN2004", /* L440 */
188 /*****************************************************************************
189 * Synaptics communications functions
190 ****************************************************************************/
193 * Synaptics touchpads report the y coordinate from bottom to top, which is
194 * opposite from what userspace expects.
195 * This function is used to invert y before reporting.
197 static int synaptics_invert_y(int y)
199 return YMAX_NOMINAL + YMIN_NOMINAL - y;
203 * Send a command to the synpatics touchpad by special commands
205 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c, unsigned char *param)
207 if (psmouse_sliced_command(psmouse, c))
209 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO))
215 * Read the model-id bytes from the touchpad
216 * see also SYN_MODEL_* macros
218 static int synaptics_model_id(struct psmouse *psmouse)
220 struct synaptics_data *priv = psmouse->private;
223 if (synaptics_send_cmd(psmouse, SYN_QUE_MODEL, mi))
225 priv->model_id = (mi[0]<<16) | (mi[1]<<8) | mi[2];
230 * Read the board id from the touchpad
231 * The board id is encoded in the "QUERY MODES" response
233 static int synaptics_board_id(struct psmouse *psmouse)
235 struct synaptics_data *priv = psmouse->private;
236 unsigned char bid[3];
238 if (synaptics_send_cmd(psmouse, SYN_QUE_MODES, bid))
240 priv->board_id = ((bid[0] & 0xfc) << 6) | bid[1];
245 * Read the firmware id from the touchpad
247 static int synaptics_firmware_id(struct psmouse *psmouse)
249 struct synaptics_data *priv = psmouse->private;
250 unsigned char fwid[3];
252 if (synaptics_send_cmd(psmouse, SYN_QUE_FIRMWARE_ID, fwid))
254 priv->firmware_id = (fwid[0] << 16) | (fwid[1] << 8) | fwid[2];
259 * Read the capability-bits from the touchpad
260 * see also the SYN_CAP_* macros
262 static int synaptics_capability(struct psmouse *psmouse)
264 struct synaptics_data *priv = psmouse->private;
265 unsigned char cap[3];
267 if (synaptics_send_cmd(psmouse, SYN_QUE_CAPABILITIES, cap))
269 priv->capabilities = (cap[0] << 16) | (cap[1] << 8) | cap[2];
270 priv->ext_cap = priv->ext_cap_0c = 0;
273 * Older firmwares had submodel ID fixed to 0x47
275 if (SYN_ID_FULL(priv->identity) < 0x705 &&
276 SYN_CAP_SUBMODEL_ID(priv->capabilities) != 0x47) {
281 * Unless capExtended is set the rest of the flags should be ignored
283 if (!SYN_CAP_EXTENDED(priv->capabilities))
284 priv->capabilities = 0;
286 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 1) {
287 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB, cap)) {
288 psmouse_warn(psmouse,
289 "device claims to have extended capabilities, but I'm not able to read them.\n");
291 priv->ext_cap = (cap[0] << 16) | (cap[1] << 8) | cap[2];
294 * if nExtBtn is greater than 8 it should be considered
295 * invalid and treated as 0
297 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) > 8)
298 priv->ext_cap &= 0xff0fff;
302 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 4) {
303 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB_0C, cap)) {
304 psmouse_warn(psmouse,
305 "device claims to have extended capability 0x0c, but I'm not able to read it.\n");
307 priv->ext_cap_0c = (cap[0] << 16) | (cap[1] << 8) | cap[2];
316 * See also the SYN_ID_* macros
318 static int synaptics_identify(struct psmouse *psmouse)
320 struct synaptics_data *priv = psmouse->private;
323 if (synaptics_send_cmd(psmouse, SYN_QUE_IDENTIFY, id))
325 priv->identity = (id[0]<<16) | (id[1]<<8) | id[2];
326 if (SYN_ID_IS_SYNAPTICS(priv->identity))
332 * Read touchpad resolution and maximum reported coordinates
333 * Resolution is left zero if touchpad does not support the query
336 static int synaptics_resolution(struct psmouse *psmouse)
338 struct synaptics_data *priv = psmouse->private;
339 unsigned char resp[3];
342 if (SYN_ID_MAJOR(priv->identity) < 4)
345 if (synaptics_send_cmd(psmouse, SYN_QUE_RESOLUTION, resp) == 0) {
346 if (resp[0] != 0 && (resp[1] & 0x80) && resp[2] != 0) {
347 priv->x_res = resp[0]; /* x resolution in units/mm */
348 priv->y_res = resp[2]; /* y resolution in units/mm */
352 for (i = 0; min_max_pnpid_table[i].pnp_ids; i++) {
353 if (psmouse_matches_pnp_id(psmouse,
354 min_max_pnpid_table[i].pnp_ids)) {
355 priv->x_min = min_max_pnpid_table[i].x_min;
356 priv->x_max = min_max_pnpid_table[i].x_max;
357 priv->y_min = min_max_pnpid_table[i].y_min;
358 priv->y_max = min_max_pnpid_table[i].y_max;
363 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 5 &&
364 SYN_CAP_MAX_DIMENSIONS(priv->ext_cap_0c)) {
365 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MAX_COORDS, resp)) {
366 psmouse_warn(psmouse,
367 "device claims to have max coordinates query, but I'm not able to read it.\n");
369 priv->x_max = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
370 priv->y_max = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
374 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 7 &&
375 SYN_CAP_MIN_DIMENSIONS(priv->ext_cap_0c)) {
376 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MIN_COORDS, resp)) {
377 psmouse_warn(psmouse,
378 "device claims to have min coordinates query, but I'm not able to read it.\n");
380 priv->x_min = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
381 priv->y_min = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
388 static int synaptics_query_hardware(struct psmouse *psmouse)
390 if (synaptics_identify(psmouse))
392 if (synaptics_model_id(psmouse))
394 if (synaptics_firmware_id(psmouse))
396 if (synaptics_board_id(psmouse))
398 if (synaptics_capability(psmouse))
400 if (synaptics_resolution(psmouse))
406 static int synaptics_set_advanced_gesture_mode(struct psmouse *psmouse)
408 static unsigned char param = 0xc8;
409 struct synaptics_data *priv = psmouse->private;
411 if (!(SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
412 SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)))
415 if (psmouse_sliced_command(psmouse, SYN_QUE_MODEL))
418 if (ps2_command(&psmouse->ps2dev, ¶m, PSMOUSE_CMD_SETRATE))
421 /* Advanced gesture mode also sends multi finger data */
422 priv->capabilities |= BIT(1);
427 static int synaptics_set_mode(struct psmouse *psmouse)
429 struct synaptics_data *priv = psmouse->private;
432 if (priv->absolute_mode)
433 priv->mode |= SYN_BIT_ABSOLUTE_MODE;
434 if (priv->disable_gesture)
435 priv->mode |= SYN_BIT_DISABLE_GESTURE;
436 if (psmouse->rate >= 80)
437 priv->mode |= SYN_BIT_HIGH_RATE;
438 if (SYN_CAP_EXTENDED(priv->capabilities))
439 priv->mode |= SYN_BIT_W_MODE;
441 if (synaptics_mode_cmd(psmouse, priv->mode))
444 if (priv->absolute_mode &&
445 synaptics_set_advanced_gesture_mode(psmouse)) {
446 psmouse_err(psmouse, "Advanced gesture mode init failed.\n");
453 static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate)
455 struct synaptics_data *priv = psmouse->private;
458 priv->mode |= SYN_BIT_HIGH_RATE;
461 priv->mode &= ~SYN_BIT_HIGH_RATE;
465 synaptics_mode_cmd(psmouse, priv->mode);
468 /*****************************************************************************
469 * Synaptics pass-through PS/2 port support
470 ****************************************************************************/
471 static int synaptics_pt_write(struct serio *serio, unsigned char c)
473 struct psmouse *parent = serio_get_drvdata(serio->parent);
474 char rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */
476 if (psmouse_sliced_command(parent, c))
478 if (ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE))
483 static int synaptics_pt_start(struct serio *serio)
485 struct psmouse *parent = serio_get_drvdata(serio->parent);
486 struct synaptics_data *priv = parent->private;
488 serio_pause_rx(parent->ps2dev.serio);
489 priv->pt_port = serio;
490 serio_continue_rx(parent->ps2dev.serio);
495 static void synaptics_pt_stop(struct serio *serio)
497 struct psmouse *parent = serio_get_drvdata(serio->parent);
498 struct synaptics_data *priv = parent->private;
500 serio_pause_rx(parent->ps2dev.serio);
501 priv->pt_port = NULL;
502 serio_continue_rx(parent->ps2dev.serio);
505 static int synaptics_is_pt_packet(unsigned char *buf)
507 return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4;
510 static void synaptics_pass_pt_packet(struct serio *ptport, unsigned char *packet)
512 struct psmouse *child = serio_get_drvdata(ptport);
514 if (child && child->state == PSMOUSE_ACTIVATED) {
515 serio_interrupt(ptport, packet[1], 0);
516 serio_interrupt(ptport, packet[4], 0);
517 serio_interrupt(ptport, packet[5], 0);
518 if (child->pktsize == 4)
519 serio_interrupt(ptport, packet[2], 0);
521 serio_interrupt(ptport, packet[1], 0);
524 static void synaptics_pt_activate(struct psmouse *psmouse)
526 struct synaptics_data *priv = psmouse->private;
527 struct psmouse *child = serio_get_drvdata(priv->pt_port);
529 /* adjust the touchpad to child's choice of protocol */
531 if (child->pktsize == 4)
532 priv->mode |= SYN_BIT_FOUR_BYTE_CLIENT;
534 priv->mode &= ~SYN_BIT_FOUR_BYTE_CLIENT;
536 if (synaptics_mode_cmd(psmouse, priv->mode))
537 psmouse_warn(psmouse,
538 "failed to switch guest protocol\n");
542 static void synaptics_pt_create(struct psmouse *psmouse)
546 serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
549 "not enough memory for pass-through port\n");
553 serio->id.type = SERIO_PS_PSTHRU;
554 strlcpy(serio->name, "Synaptics pass-through", sizeof(serio->name));
555 strlcpy(serio->phys, "synaptics-pt/serio0", sizeof(serio->name));
556 serio->write = synaptics_pt_write;
557 serio->start = synaptics_pt_start;
558 serio->stop = synaptics_pt_stop;
559 serio->parent = psmouse->ps2dev.serio;
561 psmouse->pt_activate = synaptics_pt_activate;
563 psmouse_info(psmouse, "serio: %s port at %s\n",
564 serio->name, psmouse->phys);
565 serio_register_port(serio);
568 /*****************************************************************************
569 * Functions to interpret the absolute mode packets
570 ****************************************************************************/
572 static void synaptics_parse_agm(const unsigned char buf[],
573 struct synaptics_data *priv,
574 struct synaptics_hw_state *hw)
576 struct synaptics_hw_state *agm = &priv->agm;
579 agm_packet_type = (buf[5] & 0x30) >> 4;
580 switch (agm_packet_type) {
582 /* Gesture packet: (x, y, z) half resolution */
584 agm->x = (((buf[4] & 0x0f) << 8) | buf[1]) << 1;
585 agm->y = (((buf[4] & 0xf0) << 4) | buf[2]) << 1;
586 agm->z = ((buf[3] & 0x30) | (buf[5] & 0x0f)) << 1;
590 /* AGM-CONTACT packet: we are only interested in the count */
591 priv->agm_count = buf[1];
599 static bool is_forcepad;
601 static int synaptics_parse_hw_state(const unsigned char buf[],
602 struct synaptics_data *priv,
603 struct synaptics_hw_state *hw)
605 memset(hw, 0, sizeof(struct synaptics_hw_state));
607 if (SYN_MODEL_NEWABS(priv->model_id)) {
608 hw->w = (((buf[0] & 0x30) >> 2) |
609 ((buf[0] & 0x04) >> 1) |
610 ((buf[3] & 0x04) >> 2));
612 if ((SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
613 SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) &&
615 synaptics_parse_agm(buf, priv, hw);
619 hw->x = (((buf[3] & 0x10) << 8) |
620 ((buf[1] & 0x0f) << 8) |
622 hw->y = (((buf[3] & 0x20) << 7) |
623 ((buf[1] & 0xf0) << 4) |
627 hw->left = (buf[0] & 0x01) ? 1 : 0;
628 hw->right = (buf[0] & 0x02) ? 1 : 0;
632 * ForcePads, like Clickpads, use middle button
633 * bits to report primary button clicks.
634 * Unfortunately they report primary button not
635 * only when user presses on the pad above certain
636 * threshold, but also when there are more than one
637 * finger on the touchpad, which interferes with
638 * out multi-finger gestures.
642 priv->press = priv->report_press = false;
643 } else if (hw->w >= 4 && ((buf[0] ^ buf[3]) & 0x01)) {
645 * Single-finger touch with pressure above
646 * the threshold. If pressure stays long
647 * enough, we'll start reporting primary
648 * button. We rely on the device continuing
649 * sending data even if finger does not
653 priv->press_start = jiffies;
655 } else if (time_after(jiffies,
657 msecs_to_jiffies(50))) {
658 priv->report_press = true;
664 hw->left = priv->report_press;
666 } else if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
668 * Clickpad's button is transmitted as middle button,
669 * however, since it is primary button, we will report
672 hw->left = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
674 } else if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
675 hw->middle = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
677 hw->scroll = (signed char)(buf[1]);
680 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
681 hw->up = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
682 hw->down = ((buf[0] ^ buf[3]) & 0x02) ? 1 : 0;
685 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) &&
686 ((buf[0] ^ buf[3]) & 0x02)) {
687 switch (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) & ~0x01) {
690 * if nExtBtn is greater than 8 it should be
691 * considered invalid and treated as 0
695 hw->ext_buttons |= ((buf[5] & 0x08)) ? 0x80 : 0;
696 hw->ext_buttons |= ((buf[4] & 0x08)) ? 0x40 : 0;
698 hw->ext_buttons |= ((buf[5] & 0x04)) ? 0x20 : 0;
699 hw->ext_buttons |= ((buf[4] & 0x04)) ? 0x10 : 0;
701 hw->ext_buttons |= ((buf[5] & 0x02)) ? 0x08 : 0;
702 hw->ext_buttons |= ((buf[4] & 0x02)) ? 0x04 : 0;
704 hw->ext_buttons |= ((buf[5] & 0x01)) ? 0x02 : 0;
705 hw->ext_buttons |= ((buf[4] & 0x01)) ? 0x01 : 0;
709 hw->x = (((buf[1] & 0x1f) << 8) | buf[2]);
710 hw->y = (((buf[4] & 0x1f) << 8) | buf[5]);
712 hw->z = (((buf[0] & 0x30) << 2) | (buf[3] & 0x3F));
713 hw->w = (((buf[1] & 0x80) >> 4) | ((buf[0] & 0x04) >> 1));
715 hw->left = (buf[0] & 0x01) ? 1 : 0;
716 hw->right = (buf[0] & 0x02) ? 1 : 0;
720 * Convert wrap-around values to negative. (X|Y)_MAX_POSITIVE
721 * is used by some firmware to indicate a finger at the edge of
722 * the touchpad whose precise position cannot be determined, so
723 * convert these values to the maximum axis value.
725 if (hw->x > X_MAX_POSITIVE)
726 hw->x -= 1 << ABS_POS_BITS;
727 else if (hw->x == X_MAX_POSITIVE)
730 if (hw->y > Y_MAX_POSITIVE)
731 hw->y -= 1 << ABS_POS_BITS;
732 else if (hw->y == Y_MAX_POSITIVE)
738 static void synaptics_report_semi_mt_slot(struct input_dev *dev, int slot,
739 bool active, int x, int y)
741 input_mt_slot(dev, slot);
742 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
744 input_report_abs(dev, ABS_MT_POSITION_X, x);
745 input_report_abs(dev, ABS_MT_POSITION_Y, synaptics_invert_y(y));
749 static void synaptics_report_semi_mt_data(struct input_dev *dev,
750 const struct synaptics_hw_state *a,
751 const struct synaptics_hw_state *b,
754 if (num_fingers >= 2) {
755 synaptics_report_semi_mt_slot(dev, 0, true, min(a->x, b->x),
757 synaptics_report_semi_mt_slot(dev, 1, true, max(a->x, b->x),
759 } else if (num_fingers == 1) {
760 synaptics_report_semi_mt_slot(dev, 0, true, a->x, a->y);
761 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
763 synaptics_report_semi_mt_slot(dev, 0, false, 0, 0);
764 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
768 static void synaptics_report_buttons(struct psmouse *psmouse,
769 const struct synaptics_hw_state *hw)
771 struct input_dev *dev = psmouse->dev;
772 struct synaptics_data *priv = psmouse->private;
775 input_report_key(dev, BTN_LEFT, hw->left);
776 input_report_key(dev, BTN_RIGHT, hw->right);
778 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
779 input_report_key(dev, BTN_MIDDLE, hw->middle);
781 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
782 input_report_key(dev, BTN_FORWARD, hw->up);
783 input_report_key(dev, BTN_BACK, hw->down);
786 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
787 input_report_key(dev, BTN_0 + i, hw->ext_buttons & (1 << i));
790 static void synaptics_report_mt_data(struct psmouse *psmouse,
791 const struct synaptics_hw_state *sgm,
794 struct input_dev *dev = psmouse->dev;
795 struct synaptics_data *priv = psmouse->private;
796 const struct synaptics_hw_state *hw[2] = { sgm, &priv->agm };
797 struct input_mt_pos pos[2];
798 int slot[2], nsemi, i;
800 nsemi = clamp_val(num_fingers, 0, 2);
802 for (i = 0; i < nsemi; i++) {
804 pos[i].y = synaptics_invert_y(hw[i]->y);
807 input_mt_assign_slots(dev, slot, pos, nsemi);
809 for (i = 0; i < nsemi; i++) {
810 input_mt_slot(dev, slot[i]);
811 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
812 input_report_abs(dev, ABS_MT_POSITION_X, pos[i].x);
813 input_report_abs(dev, ABS_MT_POSITION_Y, pos[i].y);
814 input_report_abs(dev, ABS_MT_PRESSURE, hw[i]->z);
817 input_mt_drop_unused(dev);
819 /* Don't use active slot count to generate BTN_TOOL events. */
820 input_mt_report_pointer_emulation(dev, false);
822 /* Send the number of fingers reported by touchpad itself. */
823 input_mt_report_finger_count(dev, num_fingers);
825 synaptics_report_buttons(psmouse, sgm);
830 static void synaptics_image_sensor_process(struct psmouse *psmouse,
831 struct synaptics_hw_state *sgm)
833 struct synaptics_data *priv = psmouse->private;
837 * Update mt_state using the new finger count and current mt_state.
841 else if (sgm->w >= 4)
843 else if (sgm->w == 0)
845 else if (sgm->w == 1)
846 num_fingers = priv->agm_count ? priv->agm_count : 3;
850 /* Send resulting input events to user space */
851 synaptics_report_mt_data(psmouse, sgm, num_fingers);
854 static void synaptics_profile_sensor_process(struct psmouse *psmouse,
855 struct synaptics_hw_state *sgm,
858 struct input_dev *dev = psmouse->dev;
859 struct synaptics_data *priv = psmouse->private;
860 struct synaptics_hw_state *hw[2] = { sgm, &priv->agm };
861 struct input_mt_pos pos[2];
862 int slot[2], nsemi, i;
864 nsemi = clamp_val(num_fingers, 0, 2);
866 for (i = 0; i < nsemi; i++) {
868 pos[i].y = synaptics_invert_y(hw[i]->y);
871 input_mt_assign_slots(dev, slot, pos, nsemi);
873 for (i = 0; i < nsemi; i++) {
874 input_mt_slot(dev, slot[i]);
875 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
876 input_report_abs(dev, ABS_MT_POSITION_X, pos[i].x);
877 input_report_abs(dev, ABS_MT_POSITION_Y, pos[i].y);
878 input_report_abs(dev, ABS_MT_PRESSURE, hw[i]->z);
881 input_mt_drop_unused(dev);
882 input_mt_report_pointer_emulation(dev, false);
883 input_mt_report_finger_count(dev, num_fingers);
885 synaptics_report_buttons(psmouse, sgm);
891 * called for each full received packet from the touchpad
893 static void synaptics_process_packet(struct psmouse *psmouse)
895 struct input_dev *dev = psmouse->dev;
896 struct synaptics_data *priv = psmouse->private;
897 struct synaptics_hw_state hw;
901 if (synaptics_parse_hw_state(psmouse->packet, priv, &hw))
904 if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
905 synaptics_image_sensor_process(psmouse, &hw);
910 priv->scroll += hw.scroll;
912 while (priv->scroll >= 4) {
913 input_report_key(dev, BTN_BACK, !hw.down);
915 input_report_key(dev, BTN_BACK, hw.down);
919 while (priv->scroll <= -4) {
920 input_report_key(dev, BTN_FORWARD, !hw.up);
922 input_report_key(dev, BTN_FORWARD, hw.up);
929 if (hw.z > 0 && hw.x > 1) {
932 if (SYN_CAP_EXTENDED(priv->capabilities)) {
935 if (SYN_CAP_MULTIFINGER(priv->capabilities))
936 num_fingers = hw.w + 2;
939 if (SYN_MODEL_PEN(priv->model_id))
940 ; /* Nothing, treat a pen as a single finger */
943 if (SYN_CAP_PALMDETECT(priv->capabilities))
953 if (cr48_profile_sensor) {
954 synaptics_profile_sensor_process(psmouse, &hw, num_fingers);
958 if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c))
959 synaptics_report_semi_mt_data(dev, &hw, &priv->agm,
963 * BTN_TOUCH has to be first as mousedev relies on it when doing
964 * absolute -> relative conversion
966 if (hw.z > 30) input_report_key(dev, BTN_TOUCH, 1);
967 if (hw.z < 25) input_report_key(dev, BTN_TOUCH, 0);
969 if (num_fingers > 0) {
970 input_report_abs(dev, ABS_X, hw.x);
971 input_report_abs(dev, ABS_Y, synaptics_invert_y(hw.y));
973 input_report_abs(dev, ABS_PRESSURE, hw.z);
975 if (SYN_CAP_PALMDETECT(priv->capabilities))
976 input_report_abs(dev, ABS_TOOL_WIDTH, finger_width);
978 input_report_key(dev, BTN_TOOL_FINGER, num_fingers == 1);
979 if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
980 input_report_key(dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
981 input_report_key(dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
984 synaptics_report_buttons(psmouse, &hw);
989 static int synaptics_validate_byte(struct psmouse *psmouse,
990 int idx, unsigned char pkt_type)
992 static const unsigned char newabs_mask[] = { 0xC8, 0x00, 0x00, 0xC8, 0x00 };
993 static const unsigned char newabs_rel_mask[] = { 0xC0, 0x00, 0x00, 0xC0, 0x00 };
994 static const unsigned char newabs_rslt[] = { 0x80, 0x00, 0x00, 0xC0, 0x00 };
995 static const unsigned char oldabs_mask[] = { 0xC0, 0x60, 0x00, 0xC0, 0x60 };
996 static const unsigned char oldabs_rslt[] = { 0xC0, 0x00, 0x00, 0x80, 0x00 };
997 const char *packet = psmouse->packet;
999 if (idx < 0 || idx > 4)
1005 case SYN_NEWABS_RELAXED:
1006 return (packet[idx] & newabs_rel_mask[idx]) == newabs_rslt[idx];
1008 case SYN_NEWABS_STRICT:
1009 return (packet[idx] & newabs_mask[idx]) == newabs_rslt[idx];
1012 return (packet[idx] & oldabs_mask[idx]) == oldabs_rslt[idx];
1015 psmouse_err(psmouse, "unknown packet type %d\n", pkt_type);
1020 static unsigned char synaptics_detect_pkt_type(struct psmouse *psmouse)
1024 for (i = 0; i < 5; i++)
1025 if (!synaptics_validate_byte(psmouse, i, SYN_NEWABS_STRICT)) {
1026 psmouse_info(psmouse, "using relaxed packet validation\n");
1027 return SYN_NEWABS_RELAXED;
1030 return SYN_NEWABS_STRICT;
1033 static psmouse_ret_t synaptics_process_byte(struct psmouse *psmouse)
1035 struct synaptics_data *priv = psmouse->private;
1037 if (psmouse->pktcnt >= 6) { /* Full packet received */
1038 if (unlikely(priv->pkt_type == SYN_NEWABS))
1039 priv->pkt_type = synaptics_detect_pkt_type(psmouse);
1041 if (SYN_CAP_PASS_THROUGH(priv->capabilities) &&
1042 synaptics_is_pt_packet(psmouse->packet)) {
1044 synaptics_pass_pt_packet(priv->pt_port, psmouse->packet);
1046 synaptics_process_packet(psmouse);
1048 return PSMOUSE_FULL_PACKET;
1051 return synaptics_validate_byte(psmouse, psmouse->pktcnt - 1, priv->pkt_type) ?
1052 PSMOUSE_GOOD_DATA : PSMOUSE_BAD_DATA;
1055 /*****************************************************************************
1056 * Driver initialization/cleanup functions
1057 ****************************************************************************/
1058 static void set_abs_position_params(struct input_dev *dev,
1059 struct synaptics_data *priv, int x_code,
1062 int x_min = priv->x_min ?: XMIN_NOMINAL;
1063 int x_max = priv->x_max ?: XMAX_NOMINAL;
1064 int y_min = priv->y_min ?: YMIN_NOMINAL;
1065 int y_max = priv->y_max ?: YMAX_NOMINAL;
1066 int fuzz = SYN_CAP_REDUCED_FILTERING(priv->ext_cap_0c) ?
1067 SYN_REDUCED_FILTER_FUZZ : 0;
1069 input_set_abs_params(dev, x_code, x_min, x_max, fuzz, 0);
1070 input_set_abs_params(dev, y_code, y_min, y_max, fuzz, 0);
1071 input_abs_set_res(dev, x_code, priv->x_res);
1072 input_abs_set_res(dev, y_code, priv->y_res);
1075 static void set_input_params(struct psmouse *psmouse,
1076 struct synaptics_data *priv)
1078 struct input_dev *dev = psmouse->dev;
1081 /* Things that apply to both modes */
1082 __set_bit(INPUT_PROP_POINTER, dev->propbit);
1083 __set_bit(EV_KEY, dev->evbit);
1084 __set_bit(BTN_LEFT, dev->keybit);
1085 __set_bit(BTN_RIGHT, dev->keybit);
1087 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
1088 __set_bit(BTN_MIDDLE, dev->keybit);
1090 if (!priv->absolute_mode) {
1092 __set_bit(EV_REL, dev->evbit);
1093 __set_bit(REL_X, dev->relbit);
1094 __set_bit(REL_Y, dev->relbit);
1099 __set_bit(EV_ABS, dev->evbit);
1100 set_abs_position_params(dev, priv, ABS_X, ABS_Y);
1101 input_set_abs_params(dev, ABS_PRESSURE, 0, 255, 0, 0);
1103 if (cr48_profile_sensor)
1104 input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1106 if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
1107 set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1109 /* Image sensors can report per-contact pressure */
1110 input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1111 input_mt_init_slots(dev, 2, INPUT_MT_POINTER | INPUT_MT_TRACK);
1113 /* Image sensors can signal 4 and 5 finger clicks */
1114 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1115 __set_bit(BTN_TOOL_QUINTTAP, dev->keybit);
1116 } else if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c)) {
1117 set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1120 * Profile sensor in CR-48 tracks contacts reasonably well,
1121 * other non-image sensors with AGM use semi-mt.
1123 input_mt_init_slots(dev, 2,
1125 (cr48_profile_sensor ?
1126 INPUT_MT_TRACK : INPUT_MT_SEMI_MT));
1129 if (SYN_CAP_PALMDETECT(priv->capabilities))
1130 input_set_abs_params(dev, ABS_TOOL_WIDTH, 0, 15, 0, 0);
1132 __set_bit(BTN_TOUCH, dev->keybit);
1133 __set_bit(BTN_TOOL_FINGER, dev->keybit);
1135 if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
1136 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1137 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1140 if (SYN_CAP_FOUR_BUTTON(priv->capabilities) ||
1141 SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
1142 __set_bit(BTN_FORWARD, dev->keybit);
1143 __set_bit(BTN_BACK, dev->keybit);
1146 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
1147 __set_bit(BTN_0 + i, dev->keybit);
1149 __clear_bit(EV_REL, dev->evbit);
1150 __clear_bit(REL_X, dev->relbit);
1151 __clear_bit(REL_Y, dev->relbit);
1153 if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
1154 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1155 if (psmouse_matches_pnp_id(psmouse, topbuttonpad_pnp_ids))
1156 __set_bit(INPUT_PROP_TOPBUTTONPAD, dev->propbit);
1157 /* Clickpads report only left button */
1158 __clear_bit(BTN_RIGHT, dev->keybit);
1159 __clear_bit(BTN_MIDDLE, dev->keybit);
1163 static ssize_t synaptics_show_disable_gesture(struct psmouse *psmouse,
1164 void *data, char *buf)
1166 struct synaptics_data *priv = psmouse->private;
1168 return sprintf(buf, "%c\n", priv->disable_gesture ? '1' : '0');
1171 static ssize_t synaptics_set_disable_gesture(struct psmouse *psmouse,
1172 void *data, const char *buf,
1175 struct synaptics_data *priv = psmouse->private;
1179 err = kstrtouint(buf, 10, &value);
1186 if (value == priv->disable_gesture)
1189 priv->disable_gesture = value;
1191 priv->mode |= SYN_BIT_DISABLE_GESTURE;
1193 priv->mode &= ~SYN_BIT_DISABLE_GESTURE;
1195 if (synaptics_mode_cmd(psmouse, priv->mode))
1201 PSMOUSE_DEFINE_ATTR(disable_gesture, S_IWUSR | S_IRUGO, NULL,
1202 synaptics_show_disable_gesture,
1203 synaptics_set_disable_gesture);
1205 static void synaptics_disconnect(struct psmouse *psmouse)
1207 struct synaptics_data *priv = psmouse->private;
1209 if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(priv->identity))
1210 device_remove_file(&psmouse->ps2dev.serio->dev,
1211 &psmouse_attr_disable_gesture.dattr);
1213 synaptics_reset(psmouse);
1215 psmouse->private = NULL;
1218 static int synaptics_reconnect(struct psmouse *psmouse)
1220 struct synaptics_data *priv = psmouse->private;
1221 struct synaptics_data old_priv = *priv;
1222 unsigned char param[2];
1227 psmouse_reset(psmouse);
1230 * On some boxes, right after resuming, the touchpad
1231 * needs some time to finish initializing (I assume
1232 * it needs time to calibrate) and start responding
1233 * to Synaptics-specific queries, so let's wait a
1238 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETID);
1239 error = synaptics_detect(psmouse, 0);
1240 } while (error && ++retry < 3);
1246 psmouse_dbg(psmouse, "reconnected after %d tries\n", retry);
1248 if (synaptics_query_hardware(psmouse)) {
1249 psmouse_err(psmouse, "Unable to query device.\n");
1253 if (synaptics_set_mode(psmouse)) {
1254 psmouse_err(psmouse, "Unable to initialize device.\n");
1258 if (old_priv.identity != priv->identity ||
1259 old_priv.model_id != priv->model_id ||
1260 old_priv.capabilities != priv->capabilities ||
1261 old_priv.ext_cap != priv->ext_cap) {
1262 psmouse_err(psmouse,
1263 "hardware appears to be different: id(%ld-%ld), model(%ld-%ld), caps(%lx-%lx), ext(%lx-%lx).\n",
1264 old_priv.identity, priv->identity,
1265 old_priv.model_id, priv->model_id,
1266 old_priv.capabilities, priv->capabilities,
1267 old_priv.ext_cap, priv->ext_cap);
1274 static bool impaired_toshiba_kbc;
1276 static const struct dmi_system_id toshiba_dmi_table[] __initconst = {
1277 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1279 /* Toshiba Satellite */
1281 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1282 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
1286 /* Toshiba Dynabook */
1288 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1289 DMI_MATCH(DMI_PRODUCT_NAME, "dynabook"),
1293 /* Toshiba Portege M300 */
1295 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1296 DMI_MATCH(DMI_PRODUCT_NAME, "PORTEGE M300"),
1301 /* Toshiba Portege M300 */
1303 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1304 DMI_MATCH(DMI_PRODUCT_NAME, "Portable PC"),
1305 DMI_MATCH(DMI_PRODUCT_VERSION, "Version 1.0"),
1313 static bool broken_olpc_ec;
1315 static const struct dmi_system_id olpc_dmi_table[] __initconst = {
1316 #if defined(CONFIG_DMI) && defined(CONFIG_OLPC)
1318 /* OLPC XO-1 or XO-1.5 */
1320 DMI_MATCH(DMI_SYS_VENDOR, "OLPC"),
1321 DMI_MATCH(DMI_PRODUCT_NAME, "XO"),
1328 static const struct dmi_system_id __initconst cr48_dmi_table[] = {
1329 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1331 /* Cr-48 Chromebook (Codename Mario) */
1333 DMI_MATCH(DMI_SYS_VENDOR, "IEC"),
1334 DMI_MATCH(DMI_PRODUCT_NAME, "Mario"),
1341 static const struct dmi_system_id forcepad_dmi_table[] __initconst = {
1342 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1345 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1346 DMI_MATCH(DMI_PRODUCT_NAME, "HP EliteBook Folio 1040 G1"),
1353 void __init synaptics_module_init(void)
1355 impaired_toshiba_kbc = dmi_check_system(toshiba_dmi_table);
1356 broken_olpc_ec = dmi_check_system(olpc_dmi_table);
1357 cr48_profile_sensor = dmi_check_system(cr48_dmi_table);
1360 * Unfortunately ForcePad capability is not exported over PS/2,
1361 * so we have to resort to checking DMI.
1363 is_forcepad = dmi_check_system(forcepad_dmi_table);
1366 static int __synaptics_init(struct psmouse *psmouse, bool absolute_mode)
1368 struct synaptics_data *priv;
1372 * The OLPC XO has issues with Synaptics' absolute mode; the constant
1373 * packet spew overloads the EC such that key presses on the keyboard
1374 * are missed. Given that, don't even attempt to use Absolute mode.
1375 * Relative mode seems to work just fine.
1377 if (absolute_mode && broken_olpc_ec) {
1378 psmouse_info(psmouse,
1379 "OLPC XO detected, not enabling Synaptics protocol.\n");
1383 psmouse->private = priv = kzalloc(sizeof(struct synaptics_data), GFP_KERNEL);
1387 psmouse_reset(psmouse);
1389 if (synaptics_query_hardware(psmouse)) {
1390 psmouse_err(psmouse, "Unable to query device.\n");
1394 priv->absolute_mode = absolute_mode;
1395 if (SYN_ID_DISGEST_SUPPORTED(priv->identity))
1396 priv->disable_gesture = true;
1398 if (synaptics_set_mode(psmouse)) {
1399 psmouse_err(psmouse, "Unable to initialize device.\n");
1403 priv->pkt_type = SYN_MODEL_NEWABS(priv->model_id) ? SYN_NEWABS : SYN_OLDABS;
1405 psmouse_info(psmouse,
1406 "Touchpad model: %ld, fw: %ld.%ld, id: %#lx, caps: %#lx/%#lx/%#lx, board id: %lu, fw id: %lu\n",
1407 SYN_ID_MODEL(priv->identity),
1408 SYN_ID_MAJOR(priv->identity), SYN_ID_MINOR(priv->identity),
1410 priv->capabilities, priv->ext_cap, priv->ext_cap_0c,
1411 priv->board_id, priv->firmware_id);
1413 set_input_params(psmouse, priv);
1416 * Encode touchpad model so that it can be used to set
1417 * input device->id.version and be visible to userspace.
1418 * Because version is __u16 we have to drop something.
1419 * Hardware info bits seem to be good candidates as they
1420 * are documented to be for Synaptics corp. internal use.
1422 psmouse->model = ((priv->model_id & 0x00ff0000) >> 8) |
1423 (priv->model_id & 0x000000ff);
1425 if (absolute_mode) {
1426 psmouse->protocol_handler = synaptics_process_byte;
1427 psmouse->pktsize = 6;
1429 /* Relative mode follows standard PS/2 mouse protocol */
1430 psmouse->protocol_handler = psmouse_process_byte;
1431 psmouse->pktsize = 3;
1434 psmouse->set_rate = synaptics_set_rate;
1435 psmouse->disconnect = synaptics_disconnect;
1436 psmouse->reconnect = synaptics_reconnect;
1437 psmouse->cleanup = synaptics_reset;
1438 /* Synaptics can usually stay in sync without extra help */
1439 psmouse->resync_time = 0;
1441 if (SYN_CAP_PASS_THROUGH(priv->capabilities))
1442 synaptics_pt_create(psmouse);
1445 * Toshiba's KBC seems to have trouble handling data from
1446 * Synaptics at full rate. Switch to a lower rate (roughly
1447 * the same rate as a standard PS/2 mouse).
1449 if (psmouse->rate >= 80 && impaired_toshiba_kbc) {
1450 psmouse_info(psmouse,
1451 "Toshiba %s detected, limiting rate to 40pps.\n",
1452 dmi_get_system_info(DMI_PRODUCT_NAME));
1456 if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(priv->identity)) {
1457 err = device_create_file(&psmouse->ps2dev.serio->dev,
1458 &psmouse_attr_disable_gesture.dattr);
1460 psmouse_err(psmouse,
1461 "Failed to create disable_gesture attribute (%d)",
1474 int synaptics_init(struct psmouse *psmouse)
1476 return __synaptics_init(psmouse, true);
1479 int synaptics_init_relative(struct psmouse *psmouse)
1481 return __synaptics_init(psmouse, false);
1484 bool synaptics_supported(void)
1489 #else /* CONFIG_MOUSE_PS2_SYNAPTICS */
1491 void __init synaptics_module_init(void)
1495 int synaptics_init(struct psmouse *psmouse)
1500 bool synaptics_supported(void)
1505 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS */